Added assertion messages for some traits.

Author: AlexSkrypnyk

.vortex/tests/phpunit/Traits/Steps/StepEnvironmentTrait.php

@@ -29,30 +29,22 @@ protected function stepGitignore(): void {
   protected function stepEnvChanges(): void {
     $this->logStepStart();
 
-    // Assert that .env does not contain test values.
-    $this->assertFileNotContainsString('.env', 'MY_CUSTOM_VAR');
-    $this->assertFileNotContainsString('.env', 'my_custom_var_value');
+    $this->assertFileNotContainsString('.env', 'MY_CUSTOM_VAR', '.env does not contain test values');
+    $this->assertFileNotContainsString('.env', 'my_custom_var_value', '.env does not contain test values');
 
-    // Assert that test variable is not available inside of containers.
     $this->cmdFail('ahoy cli "printenv | grep -q MY_CUSTOM_VAR"');
 
-    // Assert that test value is not available inside of containers.
     $this->cmdFail('ahoy cli \'echo $MY_CUSTOM_VAR | grep -q my_custom_var_value\'', '! my_custom_var_value');
 
     // Add variable to the .env file and apply the change to container.
     $this->addVarToFile('.env', 'MY_CUSTOM_VAR', 'my_custom_var_value');
     $this->cmd('ahoy up cli');
     $this->syncToContainer();
 
-    // Assert that .env contains test values.
-    $this->assertFileContainsString('.env', 'MY_CUSTOM_VAR');
-    $this->assertFileContainsString('.env', 'my_custom_var_value');
-
-    // Assert that test variable and values are available inside of containers.
-    $this->cmd('ahoy cli "printenv | grep MY_CUSTOM_VAR"', 'my_custom_var_value');
-
-    // Assert that test variable and value are available inside of containers.
-    $this->cmd('ahoy cli \'echo $MY_CUSTOM_VAR | grep my_custom_var_value\'', 'my_custom_var_value');
+    $this->assertFileContainsString('.env', 'MY_CUSTOM_VAR', '.env contains test values');
+    $this->assertFileContainsString('.env', 'my_custom_var_value', '.env contains test values');
+    $this->cmd('ahoy cli "printenv | grep MY_CUSTOM_VAR"', 'my_custom_var_value', 'Assert that test variable and values are available inside of containers.');
+    $this->cmd('ahoy cli \'echo $MY_CUSTOM_VAR | grep my_custom_var_value\'', 'my_custom_var_value', 'Assert that test variable and values are available inside of containers.');
 
     // Restore file, apply changes and assert that original behaviour has been
     // restored.
@@ -71,26 +63,25 @@ protected function stepEnvChanges(): void {
   protected function stepTimezone(): void {
     $this->logStepStart();
 
-    // Assert that .env contains a default value.
-    // Note that AEDT changes to AEST during winter.
-    $this->assertFileContainsString('.env', 'TZ=UTC');
-    $this->cmd('docker compose exec -T cli date', 'UTC');
-    $this->cmd('docker compose exec -T php date', 'UTC');
-    $this->cmd('docker compose exec -T nginx date', 'UTC');
-    $this->cmd('docker compose exec -T database date', 'UTC');
+    $this->logSubstep('Assert default timezone values.');
+    $this->assertFileContainsString('.env', 'TZ=UTC', '.env contains a default value.');
+    $this->cmd('docker compose exec -T cli date', 'UTC', 'Date is in default timezone inside CLI container by default');
+    $this->cmd('docker compose exec -T php date', 'UTC', 'Date is in default timezone inside PHP container by default');
+    $this->cmd('docker compose exec -T nginx date', 'UTC', 'Date is in default timezone inside Nginx container by default');
+    $this->cmd('docker compose exec -T database date', 'UTC', 'Date is in default timezone inside Database container by default');
 
-    // Add variable to the .env file and apply the change to container.
+    $this->logSubstep('Add variable to the .env file and apply the change to container.');
     $this->addVarToFile('.env', 'TZ', '"Australia/Perth"');
     $this->syncToContainer();
     $this->cmd('ahoy up');
 
-    $this->cmd('docker compose exec -T cli date', 'AWST');
-    $this->cmd('docker compose exec -T php date', 'AWST');
-    $this->cmd('docker compose exec -T nginx date', 'AWST');
-    $this->cmd('docker compose exec -T database date', 'AWST');
+    $this->logSubstep('Assert custom timezone values.');
+    $this->cmd('docker compose exec -T cli date', 'AWST', 'Date is in custom timezone inside CLI container');
+    $this->cmd('docker compose exec -T php date', 'AWST', 'Date is in custom timezone inside PHP container');
+    $this->cmd('docker compose exec -T nginx date', 'AWST', 'Date is in custom timezone inside Nginx container');
+    $this->cmd('docker compose exec -T database date', 'AWST', 'Date is in custom timezone inside Database container');
 
-    // Restore file, apply changes and assert that original behaviour has been
-    // restored.
+    $this->logSubstep('Restore file, apply changes and assert that original behaviour has been restored.');
     $this->restoreFile('.env');
     $this->syncToContainer();
     $this->cmd('ahoy up');

.vortex/tests/phpunit/Traits/Steps/StepFrontendTrait.php

@@ -50,9 +50,7 @@ protected function stepAhoyFe(string $webroot = 'web'): void {
     $this->syncToContainer();
     $this->cmd('ahoy fe');
     $this->syncToHost();
-    // Assets compiled for production are minified (no spaces between
-    // properties and their values).
-    $this->assertFileContainsString($minified_file, 'background:' . $test_color1);
+    $this->assertFileContainsString($minified_file, 'background:' . $test_color1, 'Assets compiled for production are minified (no spaces between properties and their values)');
 
     $this->logSubstep('Build FE assets for development');
 
@@ -65,9 +63,7 @@ protected function stepAhoyFe(string $webroot = 'web'): void {
     $this->syncToContainer();
     $this->cmd('ahoy fed');
     $this->syncToHost();
-    // Note that assets compiled for development are not minified (contains
-    // spaces between properties and their values).
-    $this->assertFileContainsString($minified_file, 'background: ' . $test_color2);
+    $this->assertFileContainsString($minified_file, 'background: ' . $test_color2, 'Assets compiled for development are not minified (contains spaces between properties and their values)');
 
     $this->logStepFinish();
   }