XmlTest Class Reference

Inheritance diagram for XmlTest:

Public Member Functions
	testDeserializeInvalidArgumentException ()
	testDeserialize ()
	testHandleErrors ()
	testDeserializeMagentoWebapiExceptionDeveloperModeOn ()
	testDeserializeMagentoWebapiExceptionDeveloperModeOff ()

Protected Member Functions
	setUp ()
	tearDown ()

Protected Attributes
	$_xmlParserMock
	$_xmlDeserializer
	$_appStateMock

Detailed Description

Definition at line 8 of file XmlTest.php.

Member Function Documentation

setUp()

setUp ( )

protected

Prepare mocks for SUT constructor.

Initialize SUT.

Definition at line 19 of file XmlTest.php.

    {
        $this->_xmlParserMock = $this->createPartialMock(
            \Magento\Framework\Xml\Parser::class,
            ['xmlToArray', 'loadXML']
        );
        $this->_appStateMock = $this->createMock(\Magento\Framework\App\State::class);
        $this->_xmlDeserializer = new \Magento\Framework\Webapi\Rest\Request\Deserializer\Xml(
            $this->_xmlParserMock,
            $this->_appStateMock
        );
        parent::setUp();
    }

tearDown()

tearDown ( )

protected

Definition at line 35 of file XmlTest.php.

    {
        unset($this->_xmlDeserializer);
        unset($this->_xmlParserMock);
        unset($this->_appStateMock);
        parent::tearDown();
    }

testDeserialize()

testDeserialize

(

)

Prepare mocks for SUT constructor.

Initialize SUT.

Definition at line 50 of file XmlTest.php.

    {
        $this->_xmlParserMock->expects($this->once())->method('loadXML');
        $validInputXml = '<?xml version="1.0"?><xml><key1>test1</key1><key2>test2</key2></xml>';
        $returnArray = ['xml' => ['key1' => 'test1', 'key2' => 'test2']];
        $this->_xmlParserMock->expects($this->once())->method('xmlToArray')->will($this->returnValue($returnArray));
        $expectedArray = ['key1' => 'test1', 'key2' => 'test2'];
        $this->assertEquals(
            $expectedArray,
            $this->_xmlDeserializer->deserialize($validInputXml),
            'Request XML body was parsed incorrectly into array of params.'
        );
    }

testDeserializeInvalidArgumentException()

testDeserializeInvalidArgumentException

(

)

Definition at line 43 of file XmlTest.php.

    {
        $this->expectException('InvalidArgumentException');
        $this->expectExceptionMessage('"boolean" data type is invalid. String is expected.');
        $this->_xmlDeserializer->deserialize(false);
    }

testDeserializeMagentoWebapiExceptionDeveloperModeOff()

testDeserializeMagentoWebapiExceptionDeveloperModeOff

(

)

Prepare mocks for SUT constructor.

Initialize SUT.

Definition at line 117 of file XmlTest.php.

    {
        $this->_appStateMock->expects($this->once())
            ->method('getMode')
            ->will($this->returnValue('production'));
        $errorMessage = 'End tag for "key1" was omitted.';
        $this->_xmlDeserializer->handleErrors(null, $errorMessage, null, null);
        $this->_xmlParserMock->expects($this->once())->method('loadXML');
        $invalidXml = '<?xml version="1.0"?><xml><key1>test1</xml>';
        try {
            $this->_xmlDeserializer->deserialize($invalidXml);
            $this->fail("Exception is expected to be raised");
        } catch (\Magento\Framework\Webapi\Exception $e) {
            $this->assertInstanceOf(\Magento\Framework\Webapi\Exception::class, $e, 'Exception type is invalid');
            $this->assertEquals('Decoding error.', $e->getMessage(), 'Exception message is invalid');
            $this->assertEquals(
                \Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST,
                $e->getHttpCode(),
                'HTTP code is invalid'
            );
        }
    }

testDeserializeMagentoWebapiExceptionDeveloperModeOn()

testDeserializeMagentoWebapiExceptionDeveloperModeOn

(

)

Prepare mocks for SUT constructor.

Initialize SUT.

Definition at line 91 of file XmlTest.php.

    {
        $this->_appStateMock->expects($this->once())
            ->method('getMode')
            ->will($this->returnValue('developer'));
        $errorMessage = 'End tag for "key1" was omitted.';
        $this->_xmlDeserializer->handleErrors(null, $errorMessage, null, null);
        $this->_xmlParserMock->expects($this->once())->method('loadXML');
        $invalidXml = '<?xml version="1.0"?><xml><key1>test1</xml>';
        try {
            $this->_xmlDeserializer->deserialize($invalidXml);
            $this->fail("Exception is expected to be raised");
        } catch (\Magento\Framework\Webapi\Exception $e) {
            $exceptionMessage = 'Decoding Error: End tag for "key1" was omitted.';
            $this->assertInstanceOf(\Magento\Framework\Webapi\Exception::class, $e, 'Exception type is invalid');
            $this->assertEquals($exceptionMessage, $e->getMessage(), 'Exception message is invalid');
            $this->assertEquals(
                \Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST,
                $e->getHttpCode(),
                'HTTP code is invalid'
            );
        }
    }

testHandleErrors()

testHandleErrors

(

)

Add error message

Assert that first error message was added

Add error message

Assert that both error messages were added

Definition at line 66 of file XmlTest.php.

    {
        $firstErrorMessage = "No document type declaration. ";
        $this->_xmlDeserializer->handleErrors(null, $firstErrorMessage, null, null);
        $this->assertAttributeEquals(
            $firstErrorMessage,
            '_errorMessage',
            $this->_xmlDeserializer,
            'Error message was not set to xml deserializer.'
        );
        $secondErrorMessage = "Strings should be wrapped in double quotes.";
        $expectedMessages = $firstErrorMessage . $secondErrorMessage;
        $this->_xmlDeserializer->handleErrors(null, $secondErrorMessage, null, null);
        $this->assertAttributeEquals(
            $expectedMessages,
            '_errorMessage',
            $this->_xmlDeserializer,
            'Error messages were not set to xml deserializer.'
        );
    }

Field Documentation

$_appStateMock

$_appStateMock

protected

Definition at line 17 of file XmlTest.php.

$_xmlDeserializer

$_xmlDeserializer

protected

Definition at line 14 of file XmlTest.php.

$_xmlParserMock

$_xmlParserMock

protected

Definition at line 11 of file XmlTest.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Webapi/Test/Unit/Rest/Request/Deserializer/XmlTest.php