Skip to content

Commit 63a8e2f

Browse files
okolesnykokolesnyk
authored
Merge pull request #165 from magento-commerce/2.x-develop-filters
MQE-3251: Release MFTF 2.7.3 to allow filters functionality for Magento 2.3.x
2 parents 042c6a6 + db5466e commit 63a8e2f

File tree

7 files changed

+633
-63
lines changed

7 files changed

+633
-63
lines changed

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
Magento Functional Testing Framework Changelog
22
================================================
3+
2.7.3
4+
---------
5+
6+
### Enhancements
7+
8+
* Add filter for groups, now we can generate tests with specific group annotation
39

410
2.7.2
511
---------

‎composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "magento/magento2-functional-testing-framework",
33
"description": "Magento2 Functional Testing Framework",
44
"type": "library",
5-
"version": "2.7.2",
5+
"version": "2.7.3",
66
"license": "AGPL-3.0",
77
"keywords": ["magento", "automation", "functional", "testing"],
88
"config": {

‎composer.lock

+38-37
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Magento/FunctionalTestingFramework/Console/StaticChecksCommand.php

+89-25
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,20 @@
1515
use Symfony\Component\Console\Exception\InvalidArgumentException;
1616
use Symfony\Component\Console\Input\InputArgument;
1717
use Symfony\Component\Console\Input\InputInterface;
18+
use Symfony\Component\Console\Input\InputOption;
1819
use Symfony\Component\Console\Output\OutputInterface;
1920
use Exception;
21+
use Symfony\Component\Console\Style\SymfonyStyle;
2022

2123
class StaticChecksCommand extends Command
2224
{
25+
/**
26+
* Associative array containing static ruleset properties.
27+
*
28+
* @var array
29+
*/
30+
private $ruleSet;
31+
2332
/**
2433
* Pool of all existing static check objects
2534
*
@@ -34,6 +43,13 @@ class StaticChecksCommand extends Command
3443
*/
3544
private $staticCheckObjects;
3645

46+
/**
47+
* Console output style
48+
*
49+
* @var SymfonyStyle
50+
*/
51+
protected $ioStyle;
52+
3753
/**
3854
* Configures the current command.
3955
*
@@ -44,14 +60,20 @@ protected function configure()
4460
$list = new StaticChecksList();
4561
$this->allStaticCheckObjects = $list->getStaticChecks();
4662
$staticCheckNames = implode(', ', array_keys($this->allStaticCheckObjects));
47-
$description = "This command will run all static checks on xml test materials. "
48-
. "Available static check scripts are:\n{$staticCheckNames}";
63+
$description = 'This command will run all static checks on xml test materials. '
64+
. 'Available static check scripts are:' . PHP_EOL . $staticCheckNames;
4965
$this->setName('static-checks')
5066
->setDescription($description)
5167
->addArgument(
5268
'names',
5369
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
5470
'name(s) of specific static check script(s) to run'
71+
)->addOption(
72+
'path',
73+
'p',
74+
InputOption::VALUE_OPTIONAL,
75+
'Path to a MFTF test module to run "deprecatedEntityUsage" static check script. ' . PHP_EOL
76+
. 'Option is ignored by other static check scripts.' . PHP_EOL
5577
);
5678
}
5779

@@ -65,32 +87,41 @@ protected function configure()
6587
*/
6688
protected function execute(InputInterface $input, OutputInterface $output)
6789
{
90+
$this->ioStyle = new SymfonyStyle($input, $output);
6891
try {
69-
$this->validateInputArguments($input, $output);
92+
$this->validateInput($input);
7093
} catch (InvalidArgumentException $e) {
7194
LoggingUtil::getInstance()->getLogger(StaticChecksCommand::class)->error($e->getMessage());
72-
$output->writeln($e->getMessage() . " Please fix input arguments and rerun.");
95+
$this->ioStyle->error($e->getMessage() . ' Please fix input argument(s) or option(s) and rerun.');
7396
return 1;
7497
}
7598

99+
$cmdFailed = false;
76100
$errors = [];
77101
foreach ($this->staticCheckObjects as $name => $staticCheck) {
78102
LoggingUtil::getInstance()->getLogger(get_class($staticCheck))->info(
79-
"\nRunning static check script for: " . $name
80-
);
81-
$output->writeln(
82-
"\nRunning static check script for: " . $name
103+
'Running static check script for: ' . $name . PHP_EOL
83104
);
84105

85-
$staticCheck->execute($input);
106+
$this->ioStyle->text(PHP_EOL . 'Running static check script for: ' . $name . PHP_EOL);
107+
$start = microtime(true);
108+
try {
109+
$staticCheck->execute($input);
110+
} catch (Exception $e) {
111+
$cmdFailed = true;
112+
LoggingUtil::getInstance()->getLogger(get_class($staticCheck))->error($e->getMessage() . PHP_EOL);
113+
$this->ioStyle->error($e->getMessage());
114+
}
115+
$end = microtime(true);
116+
$errors += $staticCheck->getErrors();
86117

87118
$staticOutput = $staticCheck->getOutput();
88119
LoggingUtil::getInstance()->getLogger(get_class($staticCheck))->info($staticOutput);
89-
$output->writeln($staticOutput);
90-
$errors += $staticCheck->getErrors();
91-
}
120+
$this->ioStyle->text($staticOutput);
92121

93-
if (empty($errors)) {
122+
$this->ioStyle->text('Total execution time is ' . (string)($end - $start) . ' seconds.' . PHP_EOL);
123+
}
124+
if (!$cmdFailed && empty($errors)) {
94125
return 0;
95126
} else {
96127
return 1;
@@ -104,30 +135,63 @@ protected function execute(InputInterface $input, OutputInterface $output)
104135
* @return void
105136
* @throws InvalidArgumentException
106137
*/
107-
private function validateInputArguments(InputInterface $input)
138+
private function validateInput(InputInterface $input)
108139
{
109140
$this->staticCheckObjects = [];
110141
$requiredChecksNames = $input->getArgument('names');
111-
$invalidCheckNames = [];
112-
// Found user required static check script(s) to run,
113-
// If no static check name is supplied, run all static check scripts
142+
// Build list of static check names to run.
143+
if (empty($requiredChecksNames)) {
144+
$this->parseRulesetJson();
145+
$requiredChecksNames = $this->ruleSet['tests'] ?? null;
146+
}
114147
if (empty($requiredChecksNames)) {
115148
$this->staticCheckObjects = $this->allStaticCheckObjects;
116149
} else {
117-
for ($index = 0; $index < count($requiredChecksNames); $index++) {
118-
if (in_array($requiredChecksNames[$index], array_keys($this->allStaticCheckObjects))) {
119-
$this->staticCheckObjects[$requiredChecksNames[$index]] =
120-
$this->allStaticCheckObjects[$requiredChecksNames[$index]];
121-
} else {
122-
$invalidCheckNames[] = $requiredChecksNames[$index];
123-
}
150+
$this->validateTestNames($requiredChecksNames);
151+
}
152+
}
153+
154+
/**
155+
* Validates that all passed in static-check names match an existing static check
156+
* @param string[] $requiredChecksNames
157+
* @return void
158+
*/
159+
private function validateTestNames($requiredChecksNames)
160+
{
161+
$invalidCheckNames = [];
162+
for ($index = 0; $index < count($requiredChecksNames); $index++) {
163+
if (in_array($requiredChecksNames[$index], array_keys($this->allStaticCheckObjects))) {
164+
$this->staticCheckObjects[$requiredChecksNames[$index]] =
165+
$this->allStaticCheckObjects[$requiredChecksNames[$index]];
166+
} else {
167+
$invalidCheckNames[] = $requiredChecksNames[$index];
124168
}
125169
}
126170

127171
if (!empty($invalidCheckNames)) {
128172
throw new InvalidArgumentException(
129-
"Invalid static check script(s): " . implode(', ', $invalidCheckNames) . "."
173+
'Invalid static check script(s): ' . implode(', ', $invalidCheckNames) . '.'
130174
);
131175
}
132176
}
177+
178+
/**
179+
* Parses and sets local ruleSet. If not found, simply returns and lets script continue.
180+
* @return void;
181+
*/
182+
private function parseRulesetJson()
183+
{
184+
$pathAddition = "/dev/tests/acceptance/";
185+
// MFTF is both NOT attached and no MAGENTO_BP defined in .env
186+
if (MAGENTO_BP === FW_BP) {
187+
$pathAddition = "/dev/";
188+
}
189+
$pathToRuleset = MAGENTO_BP . $pathAddition . "staticRuleset.json";
190+
if (!file_exists($pathToRuleset)) {
191+
$this->ioStyle->text("No ruleset under $pathToRuleset" . PHP_EOL);
192+
return;
193+
}
194+
$this->ioStyle->text("Using ruleset under $pathToRuleset" . PHP_EOL);
195+
$this->ruleSet = json_decode(file_get_contents($pathToRuleset), true);
196+
}
133197
}

0 commit comments

Comments
 (0)