Skip to content

MQE-2016: Add warning for test materials that violate naming convention #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 11, 2020
Merged

MQE-2016: Add warning for test materials that violate naming convention #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1efdb22
MQE-2016: Add warning for test materials that violate naming convention
tomreece Mar 10, 2020
b3db4a2
MQE-2016: Add warning for test materials that violate naming convention
tomreece Mar 11, 2020
16b7c0b
Merge branch 'develop' into MQE-2016
tomreece Mar 11, 2020
29fa7fa
Merge branch 'develop' into MQE-2016
tomreece Mar 11, 2020
6aaa2f0
Merge remote-tracking branch 'origin/develop' into MQE-2016
tomreece Mar 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/DataObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\DataGenerator\Util\DataExtensionUtil;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;

class DataObjectHandler implements ObjectHandlerInterface
{
Expand Down Expand Up @@ -58,6 +59,20 @@ class DataObjectHandler implements ObjectHandlerInterface
*/
private $extendUtil;

/**
* Validates and keeps track of entity name violations.
*
* @var NameValidationUtil
*/
private $entityNameValidator;

/**
* Validates and keeps track of entity key violations.
*
* @var NameValidationUtil
*/
private $entityKeyValidator;

/**
* Constructor
*/
Expand All @@ -68,6 +83,8 @@ private function __construct()
if (!$parserOutput) {
return;
}
$this->entityNameValidator = new NameValidationUtil();
$this->entityKeyValidator = new NameValidationUtil();
$this->entityDataObjects = $this->processParserOutput($parserOutput);
$this->extendUtil = new DataExtensionUtil();
}
Expand Down Expand Up @@ -132,14 +149,19 @@ private function processParserOutput($parserOutput)
throw new XmlException(sprintf(self::DATA_NAME_ERROR_MSG, $name));
}

$filename = $rawEntity[self::_FILENAME] ?? null;
$this->entityNameValidator->validatePascalCase(
$name,
NameValidationUtil::DATA_ENTITY_NAME,
$filename
);
$type = $rawEntity[self::_TYPE] ?? null;
$data = [];
$deprecated = null;
$linkedEntities = [];
$uniquenessData = [];
$vars = [];
$parentEntity = null;
$filename = $rawEntity[self::_FILENAME] ?? null;

if (array_key_exists(self::_DATA, $rawEntity)) {
$data = $this->processDataElements($rawEntity);
Expand Down Expand Up @@ -188,7 +210,8 @@ private function processParserOutput($parserOutput)

$entityDataObjects[$entityDataObject->getName()] = $entityDataObject;
}

$this->entityNameValidator->summarize(NameValidationUtil::DATA_ENTITY_NAME);
$this->entityKeyValidator->summarize(NameValidationUtil::DATA_ENTITY_KEY);
return $entityDataObjects;
}

Expand Down Expand Up @@ -220,7 +243,14 @@ private function processDataElements($entityData)
{
$dataValues = [];
foreach ($entityData[self::_DATA] as $dataElement) {
$dataElementKey = strtolower($dataElement[self::_KEY]);
$originalDataElementKey = $dataElement[self::_KEY];
$filename = $entityData[self::_FILENAME] ?? null;
$this->entityKeyValidator->validateCamelCase(
$originalDataElementKey,
NameValidationUtil::DATA_ENTITY_KEY,
$filename
);
$dataElementKey = strtolower($originalDataElementKey);
$dataElementValue = $dataElement[self::_VALUE] ?? "";
$dataValues[$dataElementKey] = $dataElementValue;
}
Expand Down
9 changes: 9 additions & 0 deletions ...to/FunctionalTestingFramework/DataGenerator/Handlers/OperationDefinitionObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;

class OperationDefinitionObjectHandler implements ObjectHandlerInterface
{
Expand Down Expand Up @@ -136,7 +137,14 @@ private function initialize()
$objectManager = ObjectManagerFactory::getObjectManager();
$parser = $objectManager->create(OperationDefinitionParser::class);
$parserOutput = $parser->readOperationMetadata()[OperationDefinitionObjectHandler::ENTITY_OPERATION_ROOT_TAG];

$operationNameValidator = new NameValidationUtil();
foreach ($parserOutput as $dataDefName => $opDefArray) {
$operationNameValidator->validatePascalCase(
$dataDefName,
NameValidationUtil::METADATA_OPERATION_NAME
);

$operation = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_TYPE];
$dataType = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_DATA_TYPE];
$url = $opDefArray[OperationDefinitionObjectHandler::ENTITY_OPERATION_URL] ?? null;
Expand Down Expand Up @@ -230,6 +238,7 @@ private function initialize()
$deprecated
);
}
$operationNameValidator->summarize(NameValidationUtil::METADATA_OPERATION_NAME);
}

/**
Expand Down
6 changes: 6 additions & 0 deletions src/Magento/FunctionalTestingFramework/Page/Handlers/PageObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\Page\Objects\PageObject;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
use Magento\FunctionalTestingFramework\XmlParser\PageParser;
use Magento\FunctionalTestingFramework\Exceptions\XmlException;

Expand Down Expand Up @@ -54,10 +55,14 @@ private function __construct()
return;
}

$pageNameValidator = new NameValidationUtil();
foreach ($parserOutput as $pageName => $pageData) {
if (preg_match('/[^a-zA-Z0-9_]/', $pageName)) {
throw new XmlException(sprintf(self::NAME_BLACKLIST_ERROR_MSG, $pageName));
}

$filename = $pageData[self::FILENAME] ?? null;
$pageNameValidator->validateAffixes($pageName, NameValidationUtil::PAGE, $filename);
$area = $pageData[self::AREA] ?? null;
$url = $pageData[self::URL] ?? null;

Expand All @@ -82,6 +87,7 @@ private function __construct()
$this->pageObjects[$pageName] =
new PageObject($pageName, $url, $module, $sectionNames, $parameterized, $area, $filename, $deprecated);
}
$pageNameValidator->summarize(NameValidationUtil::PAGE . " name");
}

/**
Expand Down
16 changes: 14 additions & 2 deletions src/Magento/FunctionalTestingFramework/Page/Handlers/SectionObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\Page\Objects\ElementObject;
use Magento\FunctionalTestingFramework\Page\Objects\SectionObject;
use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;
use Magento\FunctionalTestingFramework\XmlParser\SectionParser;
use Magento\FunctionalTestingFramework\Exceptions\XmlException;

Expand Down Expand Up @@ -58,18 +58,29 @@ private function __construct()
return;
}

$sectionNameValidator = new NameValidationUtil();
$elementNameValidator = new NameValidationUtil();
foreach ($parserOutput as $sectionName => $sectionData) {
$elements = [];

if (preg_match('/[^a-zA-Z0-9_]/', $sectionName)) {
throw new XmlException(sprintf(self::SECTION_NAME_ERROR_MSG, $sectionName));
}

$filename = $sectionData[self::FILENAME] ?? null;
$sectionNameValidator->validateAffixes($sectionName, NameValidationUtil::SECTION, $filename);

try {
foreach ($sectionData[SectionObjectHandler::ELEMENT] as $elementName => $elementData) {
if (preg_match('/[^a-zA-Z0-9_]/', $elementName)) {
throw new XmlException(sprintf(self::ELEMENT_NAME_ERROR_MSG, $elementName, $sectionName));
}

$elementNameValidator->validateCamelCase(
$elementName,
NameValidationUtil::SECTION_ELEMENT_NAME,
$filename
);
$elementType = $elementData[SectionObjectHandler::TYPE] ?? null;
$elementSelector = $elementData[SectionObjectHandler::SELECTOR] ?? null;
$elementLocatorFunc = $elementData[SectionObjectHandler::LOCATOR_FUNCTION] ?? null;
Expand All @@ -96,7 +107,6 @@ private function __construct()
throw new XmlException($exception->getMessage() . " in Section '{$sectionName}'");
}

$filename = $sectionData[self::FILENAME] ?? null;
$sectionDeprecated = $sectionData[self::OBJ_DEPRECATED] ?? null;

if ($sectionDeprecated !== null) {
Expand All @@ -113,6 +123,8 @@ private function __construct()
$sectionDeprecated
);
}
$sectionNameValidator->summarize(NameValidationUtil::SECTION . " name");
$elementNameValidator->summarize(NameValidationUtil::SECTION_ELEMENT_NAME);
}

/**
Expand Down
14 changes: 13 additions & 1 deletion src/Magento/FunctionalTestingFramework/Test/Handlers/ActionGroupObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
use Magento\FunctionalTestingFramework\ObjectManager\ObjectHandlerInterface;
use Magento\FunctionalTestingFramework\ObjectManagerFactory;
use Magento\FunctionalTestingFramework\Test\Objects\ActionGroupObject;
use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
use Magento\FunctionalTestingFramework\Test\Parsers\ActionGroupDataParser;
use Magento\FunctionalTestingFramework\Test\Util\ActionGroupObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\ObjectExtensionUtil;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;

/**
* Class ActionGroupObjectHandler
Expand All @@ -22,6 +22,7 @@ class ActionGroupObjectHandler implements ObjectHandlerInterface
const BEFORE_AFTER_ERROR_MSG = "Merge Error - Steps cannot have both before and after attributes.\tTestStep='%s'";
const ACTION_GROUP_ROOT = 'actionGroups';
const ACTION_GROUP = 'actionGroup';
const ACTION_GROUP_FILENAME_ATTRIBUTE = 'filename';

/**
* Single instance of class var
Expand Down Expand Up @@ -110,14 +111,25 @@ private function initActionGroups()
$actionGroupObjectExtractor = new ActionGroupObjectExtractor();
$neededActionGroup = $parsedActionGroups[ActionGroupObjectHandler::ACTION_GROUP_ROOT];

$actionGroupNameValidator = new NameValidationUtil();
foreach ($neededActionGroup as $actionGroupName => $actionGroupData) {
if (!in_array($actionGroupName, ["nodeName", "xsi:noNamespaceSchemaLocation"])) {
$filename = $actionGroupData[ActionGroupObjectHandler::ACTION_GROUP_FILENAME_ATTRIBUTE];
$actionGroupNameValidator->validatePascalCase(
$actionGroupName,
NameValidationUtil::ACTION_GROUP_NAME,
$filename
);
}

if (!is_array($actionGroupData)) {
continue;
}

$this->actionGroups[$actionGroupName] =
$actionGroupObjectExtractor->extractActionGroup($actionGroupData);
}
$actionGroupNameValidator->summarize(NameValidationUtil::ACTION_GROUP_NAME);
}

/**
Expand Down
9 changes: 6 additions & 3 deletions src/Magento/FunctionalTestingFramework/Test/Handlers/TestObjectHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@
use Magento\FunctionalTestingFramework\Test\Parsers\TestDataParser;
use Magento\FunctionalTestingFramework\Test\Util\ObjectExtensionUtil;
use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
use Magento\FunctionalTestingFramework\Test\Util\AnnotationExtractor;
use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
use PHP_CodeSniffer\Tokenizers\PHP;
use Magento\FunctionalTestingFramework\Util\Validation\NameValidationUtil;

/**
* Class TestObjectHandler
*/
class TestObjectHandler implements ObjectHandlerInterface
{
const XML_ROOT = 'tests';
const TEST_FILENAME_ATTRIBUTE = 'filename';

/**
* Test Object Handler
Expand Down Expand Up @@ -142,7 +142,10 @@ private function initTestData()
}

$exceptionCollector = new ExceptionCollector();
$testNameValidator = new NameValidationUtil();
foreach ($parsedTestArray as $testName => $testData) {
$filename = $testData[TestObjectHandler::TEST_FILENAME_ATTRIBUTE];
$testNameValidator->validatePascalCase($testName, NameValidationUtil::TEST_NAME, $filename);
if (!is_array($testData)) {
continue;
}
Expand All @@ -153,7 +156,7 @@ private function initTestData()
}
}
$exceptionCollector->throwException();

$testNameValidator->summarize(NameValidationUtil::TEST_NAME);
$testObjectExtractor->getAnnotationExtractor()->validateStoryTitleUniqueness();
$testObjectExtractor->getAnnotationExtractor()->validateTestCaseIdTitleUniqueness();
}
Expand Down
Loading