MCLOUD-6235: Cover new functionality with functional tests

Author: oshmyheliuk

src/Test/Functional/Acceptance/ErrorCodesCest.php

@@ -0,0 +1,102 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Test\Functional\Acceptance;
+
+use Magento\MagentoCloud\App\Error;
+
+/**
+ * This test cover functionality of state-aware error codes.
+ * Checks that failed scenario returns correct error code different to 1 or 255.
+ * Checks that var/log/cloud.error.log file was created and contains correct data.
+ * Checks that `ece-tools error:show` command returns correct errors info
+ */
+class ErrorCodesCest extends AbstractCest
+{
+    /**
+     * @param \CliTester $I
+     * @throws \Robo\Exception\TaskException
+     */
+    public function testDeployFailed(\CliTester $I): void
+    {
+        $I->runEceDockerCommand('build:compose --mode=production');
+        $I->copyFileToWorkDir('files/error_codes/.magento.env.fail.yaml', '.magento.env.yaml');
+
+        $I->runDockerComposeCommand('run build cloud-build');
+        $I->startEnvironment();
+        $I->assertFalse($I->runDockerComposeCommand('run deploy cloud-deploy'));
+        $I->seeInOutput(sprintf(
+            '[%d] Variable DATABASE_CONFIGURATION is not configured properly',
+            Error::DEPLOY_WRONG_CONFIGURATION_DB
+        ));
+        $I->seeInOutput('returned non-zero exit status ' . Error::DEPLOY_WRONG_CONFIGURATION_DB);
+
+        $errorLog = $I->grabFileContent('/var/log/cloud.error.log');
+
+        $errors = $this->getErrors($errorLog);
+
+        $I->assertArrayHasKey(Error::WARN_MISSED_MODULE_SECTION, $errors);
+        $I->assertArrayHasKey(Error::WARN_SCD_OPTIONS_IGNORANCE, $errors);
+        $I->assertArrayHasKey(Error::WARN_CONFIGURATION_STATE_NOT_IDEAL, $errors);
+        $I->assertArrayHasKey(Error::WARN_DEPRECATED_MYSQL_SEARCH_ENGINE, $errors);
+        $I->assertArrayHasKey(Error::DEPLOY_WRONG_CONFIGURATION_DB, $errors);
+
+        $I->runDockerComposeCommand('run deploy ece-command error:show');
+        $I->seeInOutput('errorCode: ' . Error::WARN_MISSED_MODULE_SECTION);
+        $I->seeInOutput('errorCode: ' . Error::WARN_SCD_OPTIONS_IGNORANCE);
+        $I->seeInOutput('errorCode: ' . Error::WARN_CONFIGURATION_STATE_NOT_IDEAL);
+        $I->seeInOutput('errorCode: ' . Error::WARN_DEPRECATED_MYSQL_SEARCH_ENGINE);
+        $I->seeInOutput('errorCode: ' . Error::DEPLOY_WRONG_CONFIGURATION_DB);
+        $I->seeInOutput('type: critical');
+    }
+
+    /**
+     * @param \CliTester $I
+     * @throws \Robo\Exception\TaskException
+     */
+    public function testDeploySuccess(\CliTester $I): void
+    {
+        $I->runEceDockerCommand('build:compose --mode=production');
+        $I->copyFileToWorkDir('files/error_codes/.magento.env.success.yaml', '.magento.env.yaml');
+
+        $I->runDockerComposeCommand('run build cloud-build');
+        $I->startEnvironment();
+        $I->assertTrue($I->runDockerComposeCommand('run deploy cloud-deploy'));
+        $I->assertTrue($I->runDockerComposeCommand('run deploy cloud-post-deploy'));
+        $I->doNotSeeInOutput('returned non-zero exit status');
+
+        $errorLog = $I->grabFileContent('/var/log/cloud.error.log');
+
+        $errors = $this->getErrors($errorLog);
+
+        $I->assertArrayHasKey(Error::WARN_MISSED_MODULE_SECTION, $errors);
+        $I->assertArrayHasKey(Error::WARN_SCD_OPTIONS_IGNORANCE, $errors);
+        $I->assertArrayHasKey(Error::WARN_CONFIGURATION_STATE_NOT_IDEAL, $errors);
+
+        $I->runDockerComposeCommand('run deploy ece-command error:show');
+        $I->seeInOutput('errorCode: ' . Error::WARN_MISSED_MODULE_SECTION);
+        $I->seeInOutput('errorCode: ' . Error::WARN_SCD_OPTIONS_IGNORANCE);
+        $I->seeInOutput('errorCode: ' . Error::WARN_CONFIGURATION_STATE_NOT_IDEAL);
+        $I->doNotSeeInOutput('type: critical');
+    }
+
+    /**
+     * @param string $errorLog
+     * @return array
+     */
+    private function getErrors(string $errorLog): array
+    {
+        $errors = [];
+
+        foreach (explode("\n", $errorLog) as $errorLine) {
+            $error = json_decode(trim($errorLine), true);
+            $errors[$error['errorCode']] = $error;
+        }
+
+        return $errors;
+    }
+}

tests/functional/_data/files/error_codes/.magento.env.fail.yaml

@@ -0,0 +1,8 @@
+stage:
+    build:
+        SCD_THREADS: 3
+    global:
+        SCD_ON_DEMAND: true
+    deploy:
+        DATABASE_CONFIGURATION:
+            host:

tests/functional/_data/files/error_codes/.magento.env.success.yaml

@@ -0,0 +1,3 @@
+stage:
+    global:
+        SCD_ON_DEMAND: true