|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright © Magento, Inc. All rights reserved. |
| 4 | + * See COPYING.txt for license details. |
| 5 | + */ |
| 6 | +declare(strict_types = 1); |
| 7 | + |
| 8 | +namespace Magento\FunctionalTestingFramework\Console; |
| 9 | + |
| 10 | +use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig; |
| 11 | +use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter; |
| 12 | +use Symfony\Component\Console\Input\ArrayInput; |
| 13 | +use Symfony\Component\Console\Input\InputInterface; |
| 14 | +use Symfony\Component\Console\Output\OutputInterface; |
| 15 | +use Symfony\Component\Process\Process; |
| 16 | +use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException; |
| 17 | +use Symfony\Component\Console\Input\InputOption; |
| 18 | + |
| 19 | +class GenerateTestFailedCommand extends BaseGenerateCommand |
| 20 | +{ |
| 21 | + /** |
| 22 | + * Default Test group to signify not in suite |
| 23 | + */ |
| 24 | + const DEFAULT_TEST_GROUP = 'default'; |
| 25 | + |
| 26 | + /** |
| 27 | + * @var string |
| 28 | + */ |
| 29 | + private $testsReRunFile; |
| 30 | + |
| 31 | + /** |
| 32 | + * @var array |
| 33 | + */ |
| 34 | + private $failedList = []; |
| 35 | + |
| 36 | + /** |
| 37 | + * Configures the current command. |
| 38 | + * |
| 39 | + * @return void |
| 40 | + */ |
| 41 | + protected function configure() |
| 42 | + { |
| 43 | + $this->setName('generate:failed') |
| 44 | + ->setDescription('Generate a set of tests failed'); |
| 45 | + |
| 46 | + parent::configure(); |
| 47 | + } |
| 48 | + |
| 49 | + /** |
| 50 | + * Executes the current command. |
| 51 | + * |
| 52 | + * @param InputInterface $input |
| 53 | + * @param OutputInterface $output |
| 54 | + * @return integer |
| 55 | + * @throws \Exception |
| 56 | + * |
| 57 | + * @SuppressWarnings(PHPMD.UnusedLocalVariable) |
| 58 | + * @SuppressWarnings(PHPMD.UnusedFormalParameter) |
| 59 | + */ |
| 60 | + protected function execute(InputInterface $input, OutputInterface $output): int |
| 61 | + { |
| 62 | + $this->testsFailedFile = $this->getTestsOutputDir() . self::FAILED_FILE; |
| 63 | + $this->testsReRunFile = $this->getTestsOutputDir() . "rerun_tests"; |
| 64 | + |
| 65 | + $force = $input->getOption('force'); |
| 66 | + $debug = $input->getOption('debug') ?? MftfApplicationConfig::LEVEL_DEVELOPER; // for backward compatibility |
| 67 | + $allowSkipped = $input->getOption('allow-skipped'); |
| 68 | + $verbose = $output->isVerbose(); |
| 69 | + |
| 70 | + // Create Mftf Configuration |
| 71 | + MftfApplicationConfig::create( |
| 72 | + $force, |
| 73 | + MftfApplicationConfig::EXECUTION_PHASE, |
| 74 | + $verbose, |
| 75 | + $debug, |
| 76 | + $allowSkipped |
| 77 | + ); |
| 78 | + |
| 79 | + $testConfiguration = $this->getFailedTestList(); |
| 80 | + |
| 81 | + if ($testConfiguration === null) { |
| 82 | + // no failed tests found, run is a success |
| 83 | + return 0; |
| 84 | + } |
| 85 | + |
| 86 | + $command = $this->getApplication()->find('generate:tests'); |
| 87 | + $args = [ |
| 88 | + '--tests' => $testConfiguration, |
| 89 | + '--force' => $force, |
| 90 | + '--remove' => true, |
| 91 | + '--debug' => $debug, |
| 92 | + '--allow-skipped' => $allowSkipped, |
| 93 | + '-v' => $verbose |
| 94 | + ]; |
| 95 | + $command->run(new ArrayInput($args), $output); |
| 96 | + $output->writeln("Test Failed Generated, now run:failed command"); |
| 97 | + return 1; |
| 98 | + } |
| 99 | + |
| 100 | + /** |
| 101 | + * Returns a json string of tests that failed on the last run |
| 102 | + * |
| 103 | + * @return string |
| 104 | + */ |
| 105 | + private function getFailedTestList() |
| 106 | + { |
| 107 | + $failedTestDetails = ['tests' => [], 'suites' => []]; |
| 108 | + |
| 109 | + if (realpath($this->testsFailedFile)) { |
| 110 | + $testList = $this->readFailedTestFile($this->testsFailedFile); |
| 111 | + |
| 112 | + foreach ($testList as $test) { |
| 113 | + if (!empty($test)) { |
| 114 | + $this->writeFailedTestToFile($test, $this->testsReRunFile); |
| 115 | + $testInfo = explode(DIRECTORY_SEPARATOR, $test); |
| 116 | + $testName = explode(":", $testInfo[count($testInfo) - 1])[1]; |
| 117 | + $suiteName = $testInfo[count($testInfo) - 2]; |
| 118 | + |
| 119 | + if ($suiteName === self::DEFAULT_TEST_GROUP) { |
| 120 | + array_push($failedTestDetails['tests'], $testName); |
| 121 | + } else { |
| 122 | + $suiteName = $this->sanitizeSuiteName($suiteName); |
| 123 | + $failedTestDetails['suites'] = array_merge_recursive( |
| 124 | + $failedTestDetails['suites'], |
| 125 | + [$suiteName => [$testName]] |
| 126 | + ); |
| 127 | + } |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | + if (empty($failedTestDetails['tests']) & empty($failedTestDetails['suites'])) { |
| 132 | + return null; |
| 133 | + } |
| 134 | + if (empty($failedTestDetails['tests'])) { |
| 135 | + $failedTestDetails['tests'] = null; |
| 136 | + } |
| 137 | + if (empty($failedTestDetails['suites'])) { |
| 138 | + $failedTestDetails['suites'] = null; |
| 139 | + } |
| 140 | + $testConfigurationJson = json_encode($failedTestDetails); |
| 141 | + return $testConfigurationJson; |
| 142 | + } |
| 143 | + |
| 144 | + /** |
| 145 | + * Trim potential suite_parallel_0_G to suite_parallel |
| 146 | + * |
| 147 | + * @param string $suiteName |
| 148 | + * @return string |
| 149 | + */ |
| 150 | + private function sanitizeSuiteName($suiteName) |
| 151 | + { |
| 152 | + $suiteNameArray = explode("_", $suiteName); |
| 153 | + if (array_pop($suiteNameArray) === 'G') { |
| 154 | + if (is_numeric(array_pop($suiteNameArray))) { |
| 155 | + $suiteName = implode("_", $suiteNameArray); |
| 156 | + } |
| 157 | + } |
| 158 | + return $suiteName; |
| 159 | + } |
| 160 | + |
| 161 | + /** |
| 162 | + * Returns an array of tests read from the failed test file in _output |
| 163 | + * |
| 164 | + * @param string $filePath |
| 165 | + * @return array|boolean |
| 166 | + */ |
| 167 | + private function readFailedTestFile($filePath) |
| 168 | + { |
| 169 | + return file($filePath, FILE_IGNORE_NEW_LINES); |
| 170 | + } |
| 171 | + |
| 172 | + /** |
| 173 | + * Writes the test name to a file if it does not already exist |
| 174 | + * |
| 175 | + * @param string $test |
| 176 | + * @param string $filePath |
| 177 | + * @return void |
| 178 | + */ |
| 179 | + private function writeFailedTestToFile($test, $filePath) |
| 180 | + { |
| 181 | + if (file_exists($filePath)) { |
| 182 | + if (strpos(file_get_contents($filePath), $test) === false) { |
| 183 | + file_put_contents($filePath, "\n" . $test, FILE_APPEND); |
| 184 | + } |
| 185 | + } else { |
| 186 | + file_put_contents($filePath, $test . "\n"); |
| 187 | + } |
| 188 | + } |
| 189 | +} |
0 commit comments