Merge pull request #397 from alcaeus/driver-options-support

Support driver options in configuration

Author: malarzm

DependencyInjection/Configuration.php

@@ -303,6 +303,12 @@ private function addConnectionsSection(ArrayNodeDefinition $rootNode)
                                     })
                                 ->end()
                             ->end()
+                            ->arrayNode('driverOptions')
+                                ->performNoDeepMerging()
+                                ->children()
+                                    ->scalarNode('context')->defaultNull()->end()
+                                ->end()
+                            ->end()
                         ->end()
                     ->end()
                 ->end()

DependencyInjection/DoctrineMongoDBExtension.php

@@ -293,6 +293,7 @@ protected function loadConnections(array $connections, ContainerBuilder $contain
                 isset($connection['options']) ? $connection['options'] : [],
                 new Reference(sprintf('doctrine_mongodb.odm.%s_configuration', $name)),
                 new Reference($eventManagerId),
+                $this->normalizeDriverOptions($connection),
             ];
             $odmConnDef = new Definition('%doctrine_mongodb.odm.connection.class%', $odmConnArgs);
             $id = sprintf('doctrine_mongodb.odm.%s_connection', $name);
@@ -302,6 +303,26 @@ protected function loadConnections(array $connections, ContainerBuilder $contain
         $container->setParameter('doctrine_mongodb.odm.connections', $cons);
     }
 
+    /**
+     * Normalizes the driver options array
+     *
+     * @param array $connection
+     *
+     * @return array|null
+     */
+    private function normalizeDriverOptions(array $connection)
+    {
+        if (! isset($connection['driverOptions'])) {
+            return null;
+        }
+
+        if (isset($connection['driverOptions']['context'])) {
+            $connection['driverOptions']['context'] = new Reference($connection['driverOptions']['context']);
+        }
+
+        return $connection['driverOptions'];
+    }
+
     /**
      * Loads an ODM document managers bundle mapping information.
      *

Resources/config/schema/mongodb-1.0.xsd

@@ -49,6 +49,7 @@
   <xsd:complexType name="connection">
     <xsd:sequence>
       <xsd:element name="options" type="connection-options" minOccurs="0" maxOccurs="1" />
+      <xsd:element name="driverOptions" type="connection-driver-options" minOccurs="0" maxOccurs="1" />
     </xsd:sequence>
     <xsd:attribute name="id" type="xsd:string" use="required" />
     <xsd:attribute name="server" type="xsd:string" />
@@ -79,6 +80,10 @@
     <xsd:attribute name="wTimeout" type="xsd:integer" />
   </xsd:complexType>
 
+  <xsd:complexType name="connection-driver-options">
+    <xsd:attribute name="context" type="xsd:string" />
+  </xsd:complexType>
+
   <xsd:simpleType name="auth-mechanism">
     <xsd:restriction base="xsd:string">
       <xsd:enumeration value="SCRAM-SHA-1" />

Resources/doc/config.rst

@@ -431,6 +431,63 @@ Otherwise you will get a *auth failed* exception.
             </doctrine:mongodb>
         </container>
 
+Specifying a context service
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The MongoDB driver supports receiving a stream context to set SSL and logging
+options. This can be used to authenticate using SSL certificates. To do so, create a service that creates your logging context:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        services:
+            # ...
+
+            app.mongodb.context_service:
+                class: 'resource'
+                factory: 'stream_context_create'
+                arguments:
+                    - { ssl: { verify_expiry: true } }
+
+Note: the ``class`` option is not used when creating the service, but has to be
+provided for the service definition to be valid.
+
+You can then use this service in your configuration:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        doctrine_mongodb:
+            # ...
+            connections:
+                default:
+                    server: "mongodb://localhost:27017"
+                    driver_options:
+                        context: "app.mongodb.context_service"
+
+    .. code-block:: xml
+
+        <?xml version="1.0" ?>
+
+        <container xmlns="http://symfony.com/schema/dic/services"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xmlns:doctrine="http://symfony.com/schema/dic/doctrine/odm/mongodb"
+                   xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                                http://symfony.com/schema/dic/doctrine/odm/mongodb http://symfony.com/schema/dic/doctrine/odm/mongodb/mongodb-1.0.xsd">
+
+            <doctrine:mongodb>
+                <doctrine:connection id="default" server="mongodb://localhost:27017"/>
+                    <doctrine:driverOptions
+                            context="app.mongodb.context_service"
+                    >
+                    </doctrine:options>
+                </doctrine:connection>
+            </doctrine:mongodb>
+        </container>
+
+
 Retrying Connections and Queries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -501,6 +558,8 @@ Full Default Configuration
                         username:             ~
                         w:                    ~
                         wTimeoutMS:           ~
+                    driver_options:
+                        context:              ~ # stream context to use for connection
 
             proxy_namespace:      MongoDBODMProxies
             proxy_dir:            "%kernel.cache_dir%/doctrine/odm/mongodb/Proxies"

Tests/DependencyInjection/ConfigurationTest.php

@@ -107,6 +107,9 @@ public function testFullConfiguration($config)
                         'w'                 => 'majority',
                         'wTimeoutMS'        => 1000,
                     ],
+                    'driverOptions' => [
+                        'context' => 'conn1_context_service',
+                    ],
                 ],
                 'conn2' => [
                     'server'  => 'mongodb://otherhost',

Tests/DependencyInjection/Fixtures/config/xml/full.xml

@@ -58,6 +58,9 @@
                 </doctrine:readPreferenceTags>
                 <doctrine:readPreferenceTags />
             </doctrine:options>
+            <doctrine:driverOptions
+                context="conn1_context_service"
+            />
         </doctrine:connection>
 
         <doctrine:connection id="conn2" server="mongodb://otherhost" />

Tests/DependencyInjection/Fixtures/config/yml/full.yml

@@ -47,6 +47,8 @@ doctrine_mongodb:
                 username:         username_val
                 w:                majority
                 wTimeoutMS:       1000
+            driverOptions:
+                context:          conn1_context_service
         conn2:
             server: mongodb://otherhost
 

composer.json

@@ -12,6 +12,7 @@
     ],
     "require": {
         "php": "^5.6 || ^7.0",
+        "doctrine/mongodb": "^1.4",
         "doctrine/mongodb-odm": "^1.1",
         "psr/log": "^1.0",
         "symfony/options-resolver": "^2.7 || ^3.0",