MQE-1763: Investigate and fix failure due to absence of AcceptanceTester class

Author: tomreece

docs/troubleshooting.md

@@ -2,6 +2,40 @@
 
 Having a little trouble with the MFTF? See some common errors and fixes below.
 
+## AcceptanceTester class issues
+
+If you see the following error:
+
+```terminal
+AcceptanceTester class doesn't exist in suite folder.
+Run the 'build' command to generate it
+```
+
+#### Reason
+
+Something went wrong during the `mftf build:project` command that prevented the creation of the AcceptanceTester class.
+
+#### Solution
+
+This issue is fixed in MFTF 2.5.0.
+
+In versions of MFTF lower than 2.5.0 you should:
+
+1. Open the functional.suite.yml file at:
+    ```terminal
+    <magento root directory>/dev/tests/acceptance/tests/functional.suite.yml
+    ```
+2. Add quotation marks (`"`) around these values:
+    1. `%SELENIUM_HOST%`
+    2. `%SELENIUM_PORT%`
+    3. `%SELENIUM_PROTOCOL%`
+    4. `%SELENIUM_PATH%`
+3. Run the `vendor/bin/mftf build:project` command again.
+4. You should see the AcceptanceTester class is created at:
+    ```terminal
+   <magento root directory>/vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/AcceptanceTester.php
+    ```
+
 ## WebDriver issues
 
 Troubleshoot your WebDriver issues on various browsers.

src/Magento/FunctionalTestingFramework/Console/BuildProjectCommand.php

@@ -7,6 +7,7 @@
 
 namespace Magento\FunctionalTestingFramework\Console;
 
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -94,14 +95,16 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $process->setWorkingDirectory(TESTS_BP);
         $process->setIdleTimeout(600);
         $process->setTimeout(0);
-        $process->run(
+        $codeceptReturnCode = $process->run(
             function ($type, $buffer) use ($output) {
-                if ($output->isVerbose()) {
-                    $output->write($buffer);
-                }
+                $output->write($buffer);
             }
         );
 
+        if ($codeceptReturnCode !== 0) {
+            throw new TestFrameworkException("The codecept build command failed unexpectedly. Please see the above output for more details.");
+        }
+
         if ($input->getOption('upgrade')) {
             $upgradeCommand = new UpgradeTestsCommand();
             $upgradeOptions = new ArrayInput(['path' => TESTS_MODULE_PATH]);
@@ -133,9 +136,7 @@ private function generateConfigFiles(OutputInterface $output)
             $output->writeln("codeception.yml configuration successfully applied.");
         }
 
-        if ($output->isVerbose()) {
-            $output->writeln("codeception.yml applied to " . TESTS_BP . DIRECTORY_SEPARATOR . 'codeception.yml');
-        }
+        $output->writeln("codeception.yml applied to " . TESTS_BP . DIRECTORY_SEPARATOR . 'codeception.yml');
 
         // copy the functional suite yml, will only copy if there are differences between the template the destination
         $fileSystem->copy(
@@ -144,10 +145,8 @@ private function generateConfigFiles(OutputInterface $output)
         );
         $output->writeln('functional.suite.yml configuration successfully applied.');
 
-        if ($output->isVerbose()) {
-            $output->writeln("functional.suite.yml applied to " .
-                TESTS_BP . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'functional.suite.yml');
-        }
+        $output->writeln("functional.suite.yml applied to " .
+            TESTS_BP . DIRECTORY_SEPARATOR . 'tests' . DIRECTORY_SEPARATOR . 'functional.suite.yml');
 
         $fileSystem->copy(
             FW_BP . '/etc/config/.credentials.example',