SoapContext::iSendRequestYAML() - Code Metrics - Inspection of "Add send SOAP request with arguments as YAML for s..." - asgorobets/SoapExtension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f7638b...035d48 )

by Alexei

created 2016-04-12 03:03 UTC

SoapContext::iSendRequestYAML() A

↳ Parent: SoapContext

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php
/**
 * @author Alexei Gorobet, <[email protected]>
 */
namespace Behat\SoapExtension\Context;

use Symfony\Component\Yaml\Yaml;
use PHPUnit_Framework_Assert as Assertions;
// Argument processors.
use Behat\Gherkin\Node\TableNode;
use Behat\Gherkin\Node\PyStringNode;
// Utils.
use Behat\SoapExtension\Utils\SoapFaultProcessor;
// Scopes.
use Behat\Behat\Hook\Scope\BeforeStepScope;

/**
 * Class SoapContext.
 *
 * @package Behat\SoapExtension\Context
 *
 * @todo Rename methods.
 * @todo Document methods.
 * @todo Make steps more flexible with regex.
 */
class SoapContext extends RawSoapContext
{
    /**
     * @var mixed
     */
    private $value;
    private $fault;

    /**
     * Sets the WSDL for the next SOAP request.
     *
     * @param string $wsdl
     *   Publicly accessible URL to wsdl
     *
     * @Given I am working with SOAP service WSDL :wsdl
     */
    public function iAmWorkingWithSoapServiceWSDL($wsdl)
    {
        $this->setWSDL($wsdl);
    }

    /**
     * Sets the WSDL for the next SOAP request to NULL.
     *
     * @Given I am working with SOAP service in non-WSDL mode
     */
    public function iAmWorkingWithSoapServiceNoWSDL()
    {
        $this->setWSDL(null);
    }

    /**
     * @Given I am working with SOAP service with options list:
     */
    public function iAmWorkingWithSoapServiceWithOptions(TableNode $options)
    {
        foreach ($options->getRowsHash() as $option => $value) {
            $this->setOption($option, $value);
        }
    }

    /**
     * @Given I am working with SOAP service with options as YAML:
     */
    public function iAmWorkingWithSoapServiceWithOptionsYaml(PyStringNode $options)
    {
        foreach (Yaml::parse($options->getRaw()) as $option => $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $this->setOption($option, $value);
        }
    }

    /**
     * Send SOAP request with params list.
     *
     * @Given I call SOAP function :function with params list:
     */
    public function iSendRequestWithParams($function, TableNode $params)
    {
        $this->sendRequest($function, [$params->getRowsHash()]);
    }

    /**
     * Send SOAP request with raw body.
     *
     * @Given I call SOAP with raw body:
     */
    public function iSendRequestBody(PyStringNode $body)
    {
        // Tell SOAP we want to send the body as XML, if not otherwise specified.
        $this->setOption('use', SOAP_LITERAL);
        $this->setOption('style', SOAP_DOCUMENT);
        $this->sendRequest('MethodNameIsIgnored', [new \SoapVar($body->getRaw(), XSD_ANYXML)]);
    }

    /**
     * Send SOAP request with function arguments array as YAML.
     *
     * @Given I call SOAP function :function with arguments array as YAML:
     */
    public function iSendRequestYAML($function, PyStringNode $arguments)
    {
        $arguments = Yaml::parse($arguments->getRaw());
        $this->sendRequest($function, $arguments);
    }

    /**
     * @Given I register the following XPATH namespaces:
     */
    public function iRegisterXpathNamespaces(TableNode $namespaces)
    {
        foreach ($namespaces->getRowsHash() as $prefix => $uri) {
            $this->setNamespace($prefix, $uri);
        }
    }

    /**
     * @Then /^(?:|I )expect SOAP exception(?:| with code "(\d+)")(?:|( and| or)? with message "([^"]+?)")$/
     */
    public function expectException($code = null, $condition = null, $message = null)
    {
        // Exit with an error because we're expected an exception and got nothing.
        if (null === $this->fault) {
            throw new \RuntimeException('Expected \SoapFault exception was not thrown!');
        }

        new SoapFaultProcessor($this->fault, $code, $message, $condition);

        // If processor didn't throw an exception, then we shouldn't too.
        $this->fault = null;
    }

    /**
     * @Given I should see SOAP response property :property equals to :text
     */
    public function iShouldSeeSoapResponsePropertyEquals($text, $property)
    {
        Assertions::assertEquals($text, $this->extractResponseProperty($property));
    }

    /**
     * @Given I should see SOAP response property :property is not :text
     */
    public function iShouldSeeSoapResponsePropertyNotEquals($text, $property)
    {
        Assertions::assertNotEquals($text, $this->extractResponseProperty($property));
    }

    /**
     * @Given I should see SOAP response property :property contains :text
     */
    public function iShouldSeeSoapResponsePropertyContains($text, $property)
    {
        Assertions::assertContains($text, $this->extractResponseProperty($property));
    }

    /**
     * @Given I should see SOAP response property :property doesn't contain :text
     */
    public function iShouldSeeSoapResponsePropertyNotContains($text, $property)
    {
        Assertions::assertNotContains($text, $this->extractResponseProperty($property));
    }

    /**
     * @Then I should see SOAP response property :property matching pattern :pattern
     */
    public function iShouldSeeSoapResponsePropertyMatches($pattern, $property)
    {
        Assertions::assertRegExp($pattern, $this->extractResponseProperty($property));
    }

    /**
     * @Then I should see that SOAP Response matches XPATH :xpath
     */
    public function iShouldSeeThatSOAPResponseMatchesXpath($xpath)
    {
        Assertions::assertTrue(
            $this->extractResponseValueMatchingXPATH($xpath) !== false,
            "Couldn't find node matching provided XPATH: "
        );
    }

    /**
     * @Given I am working with SOAP response property :property
     */
    public function iWorkWithResponseProperty($property)
    {
        $this->value = $this->extractResponseProperty($property);
    }

    /**
     * @Given I am working with SOAP element matching XPATH :xpath
     */
    public function iWorkWithElementTextMatchingXPATH($xpath)
    {
        $this->value = $this->extractResponseValueMatchingXPATH($xpath);
    }

    /**
     * @Then saved SOAP value equals to :text
     */
    public function savedValueEquals($text)
    {
        Assertions::assertEquals($text, $this->value);
    }

    /**
     * @Then saved SOAP value is not equal to :text
     */
    public function savedValueNotEquals($text)
    {
        Assertions::assertNotEquals($text, $this->value);
    }

    /**
     * @Then saved SOAP value contains :text
     */
    public function savedValueContains($text)
    {
        Assertions::assertContains($text, $this->value);
    }

    /**
     * @Then saved SOAP value doesn't contain :text
     */
    public function savedValueNotContains($text)
    {
        Assertions::assertNotContains($text, $this->value);
    }

    /**
     * @Then saved SOAP value matches :pattern
     */
    public function savedValueMatchesRegExp($pattern)
    {
        Assertions::assertRegExp($pattern, $this->value);
    }

    /**
     * @Then saved SOAP value doesn't match :pattern
     */
    public function savedValueNotMatchesRegExp($pattern)
    {
        Assertions::assertNotRegExp($pattern, $this->value);
    }

    /**
     * @BeforeStep
     */
    public function beforeStepCheckForException(BeforeStepScope $scope)
    {
        // Check for SOAP exception from previously executed step.
        $this->fault = $this->getException();

        // @todo Is it really a better way to do this?
        if (null !== $this->fault && strpos($scope->getStep()->getText(), 'SOAP exception') === false) {
            throw $this->fault;
        }
    }
}


1			<?php
2			/**
3			* @author Alexei Gorobet, <[email protected]>
4			*/
5			namespace Behat\SoapExtension\Context;
6
7			use Symfony\Component\Yaml\Yaml;
8			use PHPUnit_Framework_Assert as Assertions;
9			// Argument processors.
10			use Behat\Gherkin\Node\TableNode;
11			use Behat\Gherkin\Node\PyStringNode;
12			// Utils.
13			use Behat\SoapExtension\Utils\SoapFaultProcessor;
14			// Scopes.
15			use Behat\Behat\Hook\Scope\BeforeStepScope;
16
17			/**
18			* Class SoapContext.
19			*
20			* @package Behat\SoapExtension\Context
21			*
22			* @todo Rename methods.
23			* @todo Document methods.
24			* @todo Make steps more flexible with regex.
25			*/
26			class SoapContext extends RawSoapContext
27			{
28			/**
29			* @var mixed
30			*/
31			private $value;
32			private $fault;
33
34			/**
35			* Sets the WSDL for the next SOAP request.
36			*
37			* @param string $wsdl
38			* Publicly accessible URL to wsdl
39			*
40			* @Given I am working with SOAP service WSDL :wsdl
41			*/
42			public function iAmWorkingWithSoapServiceWSDL($wsdl)
43			{
44			$this->setWSDL($wsdl);
45			}
46
47			/**
48			* Sets the WSDL for the next SOAP request to NULL.
49			*
50			* @Given I am working with SOAP service in non-WSDL mode
51			*/
52			public function iAmWorkingWithSoapServiceNoWSDL()
53			{
54			$this->setWSDL(null);
55			}
56
57			/**
58			* @Given I am working with SOAP service with options list:
59			*/
60			public function iAmWorkingWithSoapServiceWithOptions(TableNode $options)
61			{
62			foreach ($options->getRowsHash() as $option => $value) {
63			$this->setOption($option, $value);
64			}
65			}
66
67			/**
68			* @Given I am working with SOAP service with options as YAML:
69			*/
70			public function iAmWorkingWithSoapServiceWithOptionsYaml(PyStringNode $options)
71			{
72			foreach (Yaml::parse($options->getRaw()) as $option => $value) {
			0 ignored issues – show Bug introduced 2016-03-30 18:23 UTC by Report Bug Copy Issue Report The expression `\Symfony\Component\Yaml\...rse($options->getRaw())` of type `array\|string\|object<stdClass>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
73			$this->setOption($option, $value);
74			}
75			}
76
77			/**
78			* Send SOAP request with params list.
79			*
80			* @Given I call SOAP function :function with params list:
81			*/
82			public function iSendRequestWithParams($function, TableNode $params)
83			{
84			$this->sendRequest($function, [$params->getRowsHash()]);
85			}
86
87			/**
88			* Send SOAP request with raw body.
89			*
90			* @Given I call SOAP with raw body:
91			*/
92			public function iSendRequestBody(PyStringNode $body)
93			{
94			// Tell SOAP we want to send the body as XML, if not otherwise specified.
95			$this->setOption('use', SOAP_LITERAL);
96			$this->setOption('style', SOAP_DOCUMENT);
97			$this->sendRequest('MethodNameIsIgnored', [new \SoapVar($body->getRaw(), XSD_ANYXML)]);
98			}
99
100			/**
101			* Send SOAP request with function arguments array as YAML.
102			*
103			* @Given I call SOAP function :function with arguments array as YAML:
104			*/
105			public function iSendRequestYAML($function, PyStringNode $arguments)
106			{
107			$arguments = Yaml::parse($arguments->getRaw());
108			$this->sendRequest($function, $arguments);
109			}
110
111			/**
112			* @Given I register the following XPATH namespaces:
113			*/
114			public function iRegisterXpathNamespaces(TableNode $namespaces)
115			{
116			foreach ($namespaces->getRowsHash() as $prefix => $uri) {
117			$this->setNamespace($prefix, $uri);
118			}
119			}
120
121			/**
122			* @Then /^(?:\|I )expect SOAP exception(?:\| with code "(\d+)")(?:\|( and\| or)? with message "([^"]+?)")$/
123			*/
124			public function expectException($code = null, $condition = null, $message = null)
125			{
126			// Exit with an error because we're expected an exception and got nothing.
127			if (null === $this->fault) {
128			throw new \RuntimeException('Expected \SoapFault exception was not thrown!');
129			}
130
131			new SoapFaultProcessor($this->fault, $code, $message, $condition);
132
133			// If processor didn't throw an exception, then we shouldn't too.
134			$this->fault = null;
135			}
136
137			/**
138			* @Given I should see SOAP response property :property equals to :text
139			*/
140			public function iShouldSeeSoapResponsePropertyEquals($text, $property)
141			{
142			Assertions::assertEquals($text, $this->extractResponseProperty($property));
143			}
144
145			/**
146			* @Given I should see SOAP response property :property is not :text
147			*/
148			public function iShouldSeeSoapResponsePropertyNotEquals($text, $property)
149			{
150			Assertions::assertNotEquals($text, $this->extractResponseProperty($property));
151			}
152
153			/**
154			* @Given I should see SOAP response property :property contains :text
155			*/
156			public function iShouldSeeSoapResponsePropertyContains($text, $property)
157			{
158			Assertions::assertContains($text, $this->extractResponseProperty($property));
159			}
160
161			/**
162			* @Given I should see SOAP response property :property doesn't contain :text
163			*/
164			public function iShouldSeeSoapResponsePropertyNotContains($text, $property)
165			{
166			Assertions::assertNotContains($text, $this->extractResponseProperty($property));
167			}
168
169			/**
170			* @Then I should see SOAP response property :property matching pattern :pattern
171			*/
172			public function iShouldSeeSoapResponsePropertyMatches($pattern, $property)
173			{
174			Assertions::assertRegExp($pattern, $this->extractResponseProperty($property));
175			}
176
177			/**
178			* @Then I should see that SOAP Response matches XPATH :xpath
179			*/
180			public function iShouldSeeThatSOAPResponseMatchesXpath($xpath)
181			{
182			Assertions::assertTrue(
183			$this->extractResponseValueMatchingXPATH($xpath) !== false,
184			"Couldn't find node matching provided XPATH: "
185			);
186			}
187
188			/**
189			* @Given I am working with SOAP response property :property
190			*/
191			public function iWorkWithResponseProperty($property)
192			{
193			$this->value = $this->extractResponseProperty($property);
194			}
195
196			/**
197			* @Given I am working with SOAP element matching XPATH :xpath
198			*/
199			public function iWorkWithElementTextMatchingXPATH($xpath)
200			{
201			$this->value = $this->extractResponseValueMatchingXPATH($xpath);
202			}
203
204			/**
205			* @Then saved SOAP value equals to :text
206			*/
207			public function savedValueEquals($text)
208			{
209			Assertions::assertEquals($text, $this->value);
210			}
211
212			/**
213			* @Then saved SOAP value is not equal to :text
214			*/
215			public function savedValueNotEquals($text)
216			{
217			Assertions::assertNotEquals($text, $this->value);
218			}
219
220			/**
221			* @Then saved SOAP value contains :text
222			*/
223			public function savedValueContains($text)
224			{
225			Assertions::assertContains($text, $this->value);
226			}
227
228			/**
229			* @Then saved SOAP value doesn't contain :text
230			*/
231			public function savedValueNotContains($text)
232			{
233			Assertions::assertNotContains($text, $this->value);
234			}
235
236			/**
237			* @Then saved SOAP value matches :pattern
238			*/
239			public function savedValueMatchesRegExp($pattern)
240			{
241			Assertions::assertRegExp($pattern, $this->value);
242			}
243
244			/**
245			* @Then saved SOAP value doesn't match :pattern
246			*/
247			public function savedValueNotMatchesRegExp($pattern)
248			{
249			Assertions::assertNotRegExp($pattern, $this->value);
250			}
251
252			/**
253			* @BeforeStep
254			*/
255			public function beforeStepCheckForException(BeforeStepScope $scope)
256			{
257			// Check for SOAP exception from previously executed step.
258			$this->fault = $this->getException();
259
260			// @todo Is it really a better way to do this?
261			if (null !== $this->fault && strpos($scope->getStep()->getText(), 'SOAP exception') === false) {
262			throw $this->fault;
263			}
264			}
265			}
266

asgorobets / SoapExtension

GitHub Access Token became invalid

Push — master ( f7638b...035d48 )

SoapContext::iSendRequestYAML() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like