MQE-1248: Expose MFTF DEFAULT_TIMEZONE configuration in .env

- new .env DEFAULT_TIMEZONE, defaults to 'America/Los_Angeles'
- generateDate now uses this value (or override if provided)
- DEFAULT_TIMEZONE and timezone attribute are now checked in generation; fast fail in generation as opposed to run-time

Author: KevinBKozan

dev/tests/_bootstrap.php

@@ -40,7 +40,8 @@
     'MAGENTO_BASE_URL' => 'http://baseurl:8080',
     'MAGENTO_BACKEND_NAME' => 'admin',
     'MAGENTO_ADMIN_USERNAME' => 'admin',
-    'MAGENTO_ADMIN_PASSWORD' => 'admin123'
+    'MAGENTO_ADMIN_PASSWORD' => 'admin123',
+    'DEFAULT_TIMEZONE' => 'America/Los_Angeles'
 ];
 
 foreach ($TEST_ENVS as $key => $value) {

dev/tests/functional/_bootstrap.php

@@ -45,4 +45,14 @@
 
     defined('MAGENTO_CLI_COMMAND_PARAMETER') || define('MAGENTO_CLI_COMMAND_PARAMETER', 'command');
     $env->setEnvironmentVariable('MAGENTO_CLI_COMMAND_PARAMETER', MAGENTO_CLI_COMMAND_PARAMETER);
+
+    defined('DEFAULT_TIMEZONE') || define('DEFAULT_TIMEZONE', 'America/Los_Angeles');
+    $env->setEnvironmentVariable('DEFAULT_TIMEZONE', DEFAULT_TIMEZONE);
+    
+    try {
+        new DateTimeZone(DEFAULT_TIMEZONE);
+    } catch (\Exception $e) {
+        throw new \Exception("Invalid DEFAULT_TIMEZONE in .env: " . DEFAULT_TIMEZONE . PHP_EOL);        
+    }
+
 }

dev/tests/unit/Magento/FunctionalTestFramework/Test/Objects/ActionObjectTest.php

@@ -370,6 +370,21 @@ public function testTooManyArgumentException()
         $actionObject->resolveReferences();
     }
 
+    /**
+     * Action object should throw an exception if the timezone provided is not valid.
+     */
+    public function testInvalidTimezoneException()
+    {
+        $this->expectException(TestReferenceException::class);
+
+        $actionObject = new ActionObject('key123', 'generateDate', [
+            'timezone' => "INVALID_TIMEZONE"
+        ]);
+
+        // Call the method under test
+        $actionObject->resolveReferences();
+    }
+
     private function mockSectionHandlerWithElement($elementObject)
     {
         $sectionObject = new SectionObject('SectionObject', ['elementObject' => $elementObject]);

dev/tests/verification/Resources/BasicFunctionalTest.txt

@@ -107,6 +107,10 @@ class BasicFunctionalTestCest
 		$date->setTimestamp(strtotime("Now"));
 		$date->setTimezone(new \DateTimeZone("America/Los_Angeles"));
 		$generateDateKey = $date->format("H:i:s");
+		$date = new \DateTime();
+		$date->setTimestamp(strtotime("Now"));
+		$date->setTimezone(new \DateTimeZone("UTC"));
+		$generateDateKey2 = $date->format("H:i:s");
 		$grabAttributeFromKey1 = $I->grabAttributeFrom(".functionalTestSelector", "someInput");
 		$grabCookieKey1 = $I->grabCookie("grabCookieInput", ['domain' => 'www.google.com']);
 		$grabFromCurrentUrlKey1 = $I->grabFromCurrentUrl("/grabCurrentUrl");

dev/tests/verification/TestModule/Test/BasicFunctionalTest.xml

@@ -62,6 +62,7 @@
         <fillField selector=".functionalTestSelector" userInput="someInput" stepKey="fillFieldKey1" />
         <fillField selector=".functionalTestSelector" userInput="0" stepKey="fillFieldKey2" />
         <generateDate date="Now" format="H:i:s" stepKey="generateDateKey"/>
+        <generateDate date="Now" format="H:i:s" stepKey="generateDateKey2" timezone="UTC"/>
         <grabAttributeFrom selector=".functionalTestSelector" userInput="someInput" stepKey="grabAttributeFromKey1" />
         <grabCookie userInput="grabCookieInput" parameterArray="['domain' => 'www.google.com']" stepKey="grabCookieKey1" />
         <grabFromCurrentUrl regex="/grabCurrentUrl" stepKey="grabFromCurrentUrlKey1" />

etc/config/.env.example

@@ -31,6 +31,9 @@ BROWSER=chrome
 #FW_BP=
 #TESTS_MODULE_PATH=
 
+#*** Uncomment this property to change the default timezone MFTF will use for the generateDate action ***#
+#DEFAULT_TIMEZONE=America/Los_Angeles
+
 #*** These properties impact the modules loaded into MFTF, you can point to your own full path, or a custom set of modules located with the core set
 MODULE_WHITELIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_ConfigurableProductCatalogSearch
 #CUSTOM_MODULE_PATHS=

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -19,6 +19,7 @@
 
 /**
  * Class ActionObject
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ActionObject
 {
@@ -62,6 +63,7 @@ class ActionObject
     const FUNCTION_CLOSURE_ACTIONS = ['waitForElementChange', 'performOn'];
     const MERGE_ACTION_ORDER_AFTER = 'after';
     const MERGE_ACTION_ORDER_BEFORE = 'before';
+    const ACTION_ATTRIBUTE_TIMEZONE = 'timezone';
     const ACTION_ATTRIBUTE_URL = 'url';
     const ACTION_ATTRIBUTE_SELECTOR = 'selector';
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PARAMETER = '/\(.+\)/';
@@ -256,6 +258,7 @@ public function resolveReferences()
             $this->resolveSelectorReferenceAndTimeout();
             $this->resolveUrlReference();
             $this->resolveDataInputReferences();
+            $this->validateTimezoneAttribute();
             if ($this->getType() == "deleteData") {
                 $this->validateMutuallyExclusiveAttributes(self::DELETE_DATA_MUTUAL_EXCLUSIVE_ATTRIBUTES);
             }
@@ -599,6 +602,28 @@ private function validateUrlAreaAgainstActionType($obj)
         }
     }
 
+    /**
+     * Validates that the timezone attribute contains a valid value.
+     *
+     * @return void
+     * @throws TestReferenceException
+     */
+    private function validateTimezoneAttribute()
+    {
+        $attributes = $this->getCustomActionAttributes();
+        if (isset($attributes[self::ACTION_ATTRIBUTE_TIMEZONE])) {
+            $timezone = $attributes[self::ACTION_ATTRIBUTE_TIMEZONE];
+            try {
+                new \DateTimeZone($timezone);
+            } catch (\Exception $e) {
+                throw new TestReferenceException(
+                    "Timezone '{$timezone}' is not a valid timezone",
+                    ["stepKey" => $this->getStepKey(), self::ACTION_ATTRIBUTE_TIMEZONE => $timezone]
+                );
+            }
+        }
+    }
+
     /**
      * Gets the object's dataByName with given $match, differentiating behavior between <array> and <data> nodes.
      * @param string $obj

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -1283,7 +1283,7 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                     $testSteps .= $argRef;
                     break;
                 case "generateDate":
-                    $timezone = "America/Los_Angeles";
+                    $timezone = getenv("DEFAULT_TIMEZONE");
                     if (isset($customActionAttributes['timezone'])) {
                         $timezone = $customActionAttributes['timezone'];
                     }

src/Magento/FunctionalTestingFramework/_bootstrap.php

@@ -45,6 +45,15 @@
 
     defined('MAGENTO_CLI_COMMAND_PARAMETER') || define('MAGENTO_CLI_COMMAND_PARAMETER', 'command');
     $env->setEnvironmentVariable('MAGENTO_CLI_COMMAND_PARAMETER', MAGENTO_CLI_COMMAND_PARAMETER);
+    
+    defined('DEFAULT_TIMEZONE') || define('DEFAULT_TIMEZONE', 'America/Los_Angeles');
+    $env->setEnvironmentVariable('DEFAULT_TIMEZONE', DEFAULT_TIMEZONE);
+
+    try {
+        new DateTimeZone(DEFAULT_TIMEZONE);
+    } catch (\Exception $e) {
+        throw new \Exception("Invalid DEFAULT_TIMEZONE in .env: " . DEFAULT_TIMEZONE . PHP_EOL);
+    }
 }
 
 // TODO REMOVE THIS CODE ONCE WE HAVE STOPPED SUPPORTING dev/tests/acceptance PATH