Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/dev/tests/static/framework/Magento/TestFramework/Integrity/ |
<?php
/**
* An abstract test class for XML/XSD validation
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\TestFramework\Integrity;
abstract class AbstractConfig extends \PHPUnit\Framework\TestCase
{
public function testXmlFiles()
{
if (null === $this->_getXmlName()) {
$this->markTestSkipped('No XML validation of files requested');
}
$invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
$invoker(
/**
* @param string $configFile
*/
function ($configFile) {
$this->_validateFileExpectSuccess($configFile, $this->_getXsd(), $this->_getFileXsd());
},
\Magento\Framework\App\Utility\Files::init()->getConfigFiles($this->_getXmlName())
);
}
public function testSchemaUsingValidXml()
{
$xmlFile = $this->_getKnownValidXml();
$schema = $this->_getXsd();
$this->_validateFileExpectSuccess($xmlFile, $schema);
}
public function testSchemaUsingInvalidXml($expectedErrors = null)
{
if (!function_exists('libxml_set_external_entity_loader')) {
$this->markTestSkipped('Skipped due to MAGETWO-45033');
}
$xmlFile = $this->_getKnownInvalidXml();
$schema = $this->_getXsd();
$this->_validateFileExpectFailure($xmlFile, $schema, $expectedErrors);
}
public function testFileSchemaUsingPartialXml()
{
if (!function_exists('libxml_set_external_entity_loader')) {
$this->markTestSkipped('Skipped due to MAGETWO-45033');
}
$xmlFile = $this->_getKnownValidPartialXml();
if ($xmlFile === null) {
$this->markTestSkipped('No Partial File');
return;
}
$schema = $this->_getFileXsd();
$this->_validateFileExpectSuccess($xmlFile, $schema);
}
public function testFileSchemaUsingInvalidXml($expectedErrors = null)
{
if (!function_exists('libxml_set_external_entity_loader')) {
$this->markTestSkipped('Skipped due to MAGETWO-45033');
}
$xmlFile = $this->_getKnownInvalidPartialXml();
if ($xmlFile === null) {
$this->markTestSkipped('No Partial File');
return;
}
$schema = $this->_getFileXsd();
$this->_validateFileExpectFailure($xmlFile, $schema, $expectedErrors);
}
public function testSchemaUsingPartialXml($expectedErrors = null)
{
if (!function_exists('libxml_set_external_entity_loader')) {
$this->markTestSkipped('Skipped due to MAGETWO-45033');
}
$xmlFile = $this->_getKnownValidPartialXml();
if ($xmlFile === null) {
$this->markTestSkipped('No Partial File');
return;
}
$schema = $this->_getXsd();
$this->_validateFileExpectFailure($xmlFile, $schema, $expectedErrors);
}
/**
* Run schema validation against a known bad xml file with a provided schema.
*
* This helper expects the validation to fail and will fail a test if no errors are found.
*
* @param $xmlFile string a known bad xml file.
* @param $schemaFile string schema that should find errors in the known bad xml file.
* @param $fileSchemaFile string schema that should find errors in the known bad xml file
*/
protected function _validateFileExpectSuccess($xmlFile, $schemaFile, $fileSchemaFile = null)
{
$dom = new \DOMDocument();
$dom->loadXML(file_get_contents($xmlFile));
$errors = \Magento\Framework\Config\Dom::validateDomDocument($dom, $schemaFile);
if ($errors) {
if ($fileSchemaFile !== null) {
$moreErrors = \Magento\Framework\Config\Dom::validateDomDocument($dom, $fileSchemaFile);
if (empty($moreErrors)) {
return;
} else {
$errors = array_merge($errors, $moreErrors);
}
}
$this->fail(
'There is a problem with the schema. A known good XML file failed validation: ' . PHP_EOL . implode(
PHP_EOL . PHP_EOL,
$errors
)
);
}
}
/**
* Run schema validation against an xml file with a provided schema.
*
* This helper expects the validation to pass and will fail a test if any errors are found.
*
* @param $xmlFile string a known good xml file.
* @param $schemaFile string schema that should find no errors in the known good xml file.
* @param $expectedErrors null|array that may contain a list of expected errors. Each element can be a substring
* of an error, but all errors must be listed.
*/
protected function _validateFileExpectFailure($xmlFile, $schemaFile, $expectedErrors = null)
{
$dom = new \DOMDocument();
$dom->loadXML(file_get_contents($xmlFile));
$actualErrors = \Magento\Framework\Config\Dom::validateDomDocument($dom, $schemaFile);
if (isset($expectedErrors)) {
$this->assertNotEmpty(
$actualErrors,
'No schema validation errors found, expected errors: ' . PHP_EOL . implode(PHP_EOL, $expectedErrors)
);
foreach ($expectedErrors as $expectedError) {
$found = false;
foreach ($actualErrors as $errorKey => $actualError) {
if (!(strpos($actualError, $expectedError) === false)) {
// found expected string
$found = true;
// remove found error from list of actual errors
unset($actualErrors[$errorKey]);
break;
}
}
$this->assertTrue(
$found,
'Failed asserting that ' . $expectedError . " is in: \n" . implode(PHP_EOL, $actualErrors)
);
}
// list of actual errors should now be empty
$this->assertEmpty($actualErrors, "There were unexpected errors: \n" . implode(PHP_EOL, $actualErrors));
} elseif (!$actualErrors) {
$this->fail('There is a problem with the schema. A known bad XML file passed validation');
}
}
/**
* Returns the name of the XSD file to be used to validate the XML
*
* @return string
*/
abstract protected function _getXsd();
/**
* The location of a single valid complete xml file
*
* @return string
*/
abstract protected function _getKnownValidXml();
/**
* The location of a single known invalid complete xml file
*
* @return string
*/
abstract protected function _getKnownInvalidXml();
/**
* The location of a single known valid partial xml file
*
* @return string
*/
abstract protected function _getKnownValidPartialXml();
/**
* Returns the name of the XSD file to be used to validate partial XML
*
* @return string
*/
abstract protected function _getFileXsd();
/**
* The location of a single known invalid partial xml file
*
* @return string
*/
abstract protected function _getKnownInvalidPartialXml();
/**
* Returns the name of the xml files to validate
*
* @return string
*/
abstract protected function _getXmlName();
}