updated module container to inject dependencies

Author: DavertMik

src/Codeception/Module/SOAP.php

@@ -32,18 +32,33 @@
  *
  */
 
+use Codeception\Exception\ModuleRequire;
+use Codeception\Lib\Framework;
+use Codeception\Lib\InnerBrowser;
 use Codeception\Util\Soap as SoapUtils;
 
 class SOAP extends \Codeception\Module
 {
 
+    protected $dependencyMessage = <<<EOF
+Example using PhpBrowser as backend for SOAP module.
+--
+modules:
+    enabled: [SOAP, ApiHelper]
+    depends:
+        SOAP: PhpBrowser
+--
+Framework modules can be used as well for functional testing of SOAP API.
+EOF;
+
+
     protected $config = ['schema' => "", 'schema_url' => 'http://schemas.xmlsoap.org/soap/envelope/'];
     protected $requiredFields = ['endpoint'];
     /**
      * @var \Symfony\Component\BrowserKit\Client
      */
     public $client = null;
-    public $is_functional = false;
+    public $isFunctional = false;
 
     /**
      * @var \DOMDocument
@@ -54,33 +69,40 @@ class SOAP extends \Codeception\Module
      */
     public $xmlResponse = null;
 
+    /**
+     * @var InnerBrowser
+     */
+    protected $connectionModule;
+
     public function _before(\Codeception\TestCase $test)
     {
-        if (!$this->client) {
-            if (!strpos($this->config['endpoint'], '://')) {
-                // not valid url
-                foreach ($this->getModules() as $module) {
-                    if ($module instanceof \Codeception\Lib\Framework) {
-                        $this->client = $module->client;
-                        $this->is_functional = true;
-                        break;
-                    }
-                }
-            } else {
-                if (!$this->hasModule('PhpBrowser')) {
-                    throw new \Codeception\Exception\ModuleConfig(__CLASS__, "For Soap testing via HTTP please enable PhpBrowser module");
-                }
-                $this->client = $this->getModule('PhpBrowser')->client;
-            }
-            if (!$this->client) {
-                throw new \Codeception\Exception\ModuleConfig(__CLASS__, "Client for SOAP requests not initialized.\nProvide either PhpBrowser module or Framework module which shares FrameworkInterface");
-            }
-        }
-
+        $this->client = &$this->connectionModule->client;
         $this->buildRequest();
         $this->xmlResponse = null;
     }
 
+    public function _depends()
+    {
+        return ['Codeception\Lib\InnerBrowser' => $this->dependencyMessage];
+    }
+
+    public function _inject(InnerBrowser $connectionModule)
+    {
+        $this->connectionModule = $connectionModule;
+        if ($connectionModule instanceof Framework) {
+            $this->isFunctional = true;
+        }
+    }
+    
+    private function getClient()
+    {
+        if (!$this->client) {
+            throw new ModuleRequire($this, "Connection client is not available.");
+        }
+        return $this->client;
+    }
+
+
     /**
      * Prepare SOAP header.
      * Receives header name and parameters as array.
@@ -162,7 +184,7 @@ public function sendSoapRequest($action, $body = "")
         $xmlBody->appendChild($call);
         $this->debugSection("Request", $req = $xml->C14N());
 
-        if ($this->is_functional) {
+        if ($this->isFunctional) {
             $response = $this->processInternalRequest($action, $req);
         } else {
             $response = $this->processExternalRequest($action, $req);
@@ -195,7 +217,7 @@ public function sendSoapRequest($action, $body = "")
     public function seeSoapResponseEquals($xml)
     {
         $xml = SoapUtils::toXml($xml);
-        \PHPUnit_Framework_Assert::assertEquals($this->xmlResponse->C14N(), $xml->C14N());
+        $this->assertEquals($this->xmlResponse->C14N(), $xml->C14N());
     }
 
     /**
@@ -221,7 +243,7 @@ public function seeSoapResponseEquals($xml)
     public function seeSoapResponseIncludes($xml)
     {
         $xml = $this->canonicalize($xml);
-        \PHPUnit_Framework_Assert::assertContains($xml, $this->xmlResponse->C14N(), "found in XML Response");
+        $this->assertContains($xml, $this->xmlResponse->C14N(), "found in XML Response");
     }
 
 
@@ -250,7 +272,7 @@ public function dontSeeSoapResponseEquals($xml)
     public function dontSeeSoapResponseIncludes($xml)
     {
         $xml = $this->canonicalize($xml);
-        \PHPUnit_Framework_Assert::assertNotContains($xml, $this->xmlResponse->C14N(), "found in XML Response");
+        $this->assertNotContains($xml, $this->xmlResponse->C14N(), "found in XML Response");
     }
 
     /**
@@ -285,14 +307,14 @@ public function seeSoapResponseContainsStructure($xml)
         $els = $this->xmlResponse->getElementsByTagName($root->nodeName);
 
         if (empty($els)) {
-            return \PHPUnit_Framework_Assert::fail("Element {$root->nodeName} not found in response");
+            $this->fail("Element {$root->nodeName} not found in response");
         }
 
         $matches = false;
         foreach ($els as $node) {
             $matches |= $this->structureMatches($root, $node);
         }
-        \PHPUnit_Framework_Assert::assertTrue((bool)$matches, "this structure is in response");
+        $this->assertTrue((bool)$matches, "this structure is in response");
 
     }
 
@@ -455,7 +477,7 @@ protected function buildRequest()
 
     protected function processRequest($action, $body)
     {
-        $this->client->request(
+        $this->getClient()->request(
             'POST',
             $this->config['endpoint'],
             [], [],
@@ -472,7 +494,7 @@ protected function processInternalRequest($action, $body)
     {
         ob_start();
         try {
-            $this->client->setServerParameter('HTTP_HOST', 'localhost');
+            $this->getClient()->setServerParameter('HTTP_HOST', 'localhost');
             $this->processRequest($action, $body);
         } catch (\ErrorException $e) {
             // Zend_Soap outputs warning as an exception

tests/unit/Codeception/Module/SoapTest.php

@@ -17,9 +17,9 @@ public function setUp() {
         $this->module = new \Codeception\Module\SOAP(make_container());
         $this->module->_setConfig(array('schema' => 'http://www.w3.org/2001/xml.xsd', 'endpoint' => 'http://codeception.com/api/wsdl'));
         $this->layout = \Codeception\Configuration::dataDir().'/xml/layout.xml';
-        $this->module->client = Stub::makeEmpty('\Codeception\Lib\Connector\Universal');
-        $this->module->is_functional = true;
+        $this->module->isFunctional = true;
         $this->module->_before(Stub::makeEmpty('\Codeception\TestCase\Cept'));
+        $this->module->client = Stub::makeEmpty('\Codeception\Lib\Connector\Universal');
     }
 
     public function testXmlIsBuilt() {