* renamed exception classes

* improved error formatting in console
* prepared modules for partitioning

Author: DavertMik

src/Codeception/Module/SOAP.php

@@ -32,10 +32,11 @@
  *
  */
 
-use Codeception\Exception\ModuleRequire;
+use Codeception\Exception\ModuleRequireException;
 use Codeception\Lib\Framework;
 use Codeception\Lib\InnerBrowser;
 use Codeception\Util\Soap as SoapUtils;
+use Codeception\Util\XmlStructure;
 
 class SOAP extends \Codeception\Module
 {
@@ -69,6 +70,11 @@ class SOAP extends \Codeception\Module
      */
     public $xmlResponse = null;
 
+    /**
+     * @var XmlStructure
+     */
+    protected $xmlStructure;
+
     /**
      * @var InnerBrowser
      */
@@ -97,7 +103,7 @@ public function _inject(InnerBrowser $connectionModule)
     private function getClient()
     {
         if (!$this->client) {
-            throw new ModuleRequire($this, "Connection client is not available.");
+            throw new ModuleRequireException($this, "Connection client is not available.");
         }
         return $this->client;
     }
@@ -192,6 +198,7 @@ public function sendSoapRequest($action, $body = "")
 
         $this->debugSection("Response", $response);
         $this->xmlResponse = SoapUtils::toXml($response);
+        $this->xmlStructure = new XmlStructure($this->xmlResponse);
     }
 
     /**
@@ -300,22 +307,18 @@ public function seeSoapResponseContainsStructure($xml)
     {
         $xml = SoapUtils::toXml($xml);
         $this->debugSection("Structure", $xml->saveXML());
-        $root = $xml->firstChild;
-
-        $this->debugSection("Structure Root", $root->nodeName);
-
-        $els = $this->xmlResponse->getElementsByTagName($root->nodeName);
-
-        if (empty($els)) {
-            $this->fail("Element {$root->nodeName} not found in response");
-        }
-
-        $matches = false;
-        foreach ($els as $node) {
-            $matches |= $this->structureMatches($root, $node);
-        }
-        $this->assertTrue((bool)$matches, "this structure is in response");
+        $this->assertTrue((bool)$this->xmlValidator->matchXmlStructure($xml), "this structure is in response");
+    }
 
+    /**
+     * Opposite to `seeSoapResponseContainsStructure`
+     * @param $xml
+     */
+    public function dontSeeSoapResponseContainsStructure($xml)
+    {
+        $xml = SoapUtils::toXml($xml);
+        $this->debugSection("Structure", $xml->saveXML());
+        $this->assertFalse((bool)$this->xmlValidator->matchXmlStructure($xml), "this structure is in response");
     }
 
     /**
@@ -331,12 +334,7 @@ public function seeSoapResponseContainsStructure($xml)
      */
     public function seeSoapResponseContainsXPath($xpath)
     {
-        $path = new \DOMXPath($this->xmlResponse);
-        $res = $path->query($xpath);
-        if ($res === false) {
-            $this->fail("XPath selector is malformed");
-        }
-        $this->assertGreaterThan(0, $res->length);
+        $this->assertTrue($this->xmlValidator->matchesXpath($xpath));
     }
 
     /**
@@ -352,12 +350,7 @@ public function seeSoapResponseContainsXPath($xpath)
      */
     public function dontSeeSoapResponseContainsXPath($xpath)
     {
-        $path = new \DOMXPath($this->xmlResponse);
-        $res = $path->query($xpath);
-        if ($res === false) {
-            $this->fail("XPath selector is malformed");
-        }
-        $this->assertEquals(0, $res->length);
+        $this->assertFalse($this->xmlValidator->matchesXpath($xpath));
     }
 
 
@@ -368,7 +361,7 @@ public function dontSeeSoapResponseContainsXPath($xpath)
      */
     public function seeResponseCodeIs($code)
     {
-        \PHPUnit_Framework_Assert::assertEquals($code, $this->client->getInternalResponse()->getStatus(), "soap response code matches expected");
+        $this->assertEquals($code, $this->client->getInternalResponse()->getStatus(), "soap response code matches expected");
     }
 
     /**
@@ -381,7 +374,7 @@ public function seeResponseCodeIs($code)
      */
     public function grabTextContentFrom($cssOrXPath)
     {
-        $el = $this->matchElement($cssOrXPath);
+        $el = $this->xmlValidator->matchElement($cssOrXPath);
         return $el->textContent;
     }
 
@@ -396,64 +389,21 @@ public function grabTextContentFrom($cssOrXPath)
      */
     public function grabAttributeFrom($cssOrXPath, $attribute)
     {
-        $el = $this->matchElement($cssOrXPath);
+        $el = $this->xmlValidator->matchElement($cssOrXPath);
         if (!$el->hasAttribute($attribute)) {
             $this->fail("Attribute not found in element matched by '$cssOrXPath'");
         }
         return $el->getAttribute($attribute);
     }
 
-    /**
-     * @param $cssOrXPath
-     * @return \DOMElement
-     */
-    protected function matchElement($cssOrXPath)
-    {
-        $xpath = new \DOMXpath($this->xmlResponse);
-        try {
-            $selector = \Symfony\Component\CssSelector\CssSelector::toXPath($cssOrXPath);
-            $els = $xpath->query($selector);
-            if ($els) {
-                return $els->item(0);
-            }
-        } catch (\Symfony\Component\CssSelector\Exception\ParseException $e) {
-        }
-        $els = $xpath->query($cssOrXPath);
-        if ($els) {
-            return $els->item(0);
-        }
-        $this->fail("No node matched CSS or XPath '$cssOrXPath'");
-    }
-
-
-    protected function structureMatches($schema, $xml)
-    {
-        foreach ($schema->childNodes as $node1) {
-            $matched = false;
-            foreach ($xml->childNodes as $node2) {
-                if ($node1->nodeName == $node2->nodeName) {
-                    $matched = $this->structureMatches($node1, $node2);
-                    if ($matched) {
-                        break;
-                    }
-                }
-            }
-            if (!$matched) {
-                return false;
-            }
-        }
-        return true;
-    }
-
     protected function getSchema()
     {
         return $this->config['schema'];
     }
 
     protected function canonicalize($xml)
     {
-        $xml = SoapUtils::toXml($xml)->C14N();
-        return $xml;
+        return SoapUtils::toXml($xml)->C14N();
     }
 
     /**