Merge pull request #30 from magento-commerce/imported-magento-magento2-functional-testing-framework-817

[Imported] Add support for admin WebAPI token refresh

Author: soumyau

docs/configuration.md

@@ -408,6 +408,16 @@ Example:
 REMOTE_STORAGE_AWSS3_PREFIX=local
 ```
 
+### MAGENTO_ADMIN_WEBAPI_TOKEN_LIFETIME
+
+The lifetime (in seconds) of Magento Admin WebAPI token; if token is older than this value a refresh attempt will be made just before the next WebAPI call.
+
+Example:
+
+```conf
+MAGENTO_ADMIN_WEBAPI_TOKEN_LIFETIME=10800
+```
+
 <!-- Link definitions -->
 
 [`MAGENTO_CLI_COMMAND_PATH`]: #magento_cli_command_path

etc/config/.env.example

@@ -72,4 +72,8 @@ BROWSER_LOG_BLOCKLIST=other
 
 #*** Elastic Search version used for test ***#
 ELASTICSEARCH_VERSION=7
+
+#*** Lifetime (in seconds) of Magento Admin WebAPI Token; if token is older than this value a refresh attempt will be made just before the next WebAPI call ***#
+#MAGENTO_ADMIN_WEBAPI_TOKEN_LIFETIME=10800
+
 #*** End of .env ***#

src/Magento/FunctionalTestingFramework/DataTransport/Auth/WebApiAuth.php

@@ -36,6 +36,13 @@ class WebApiAuth
      */
     private static $adminAuthTokens = [];
 
+    /**
+     * Timestamps of when admin user tokens were created.  They need to be refreshed every ~4 hours
+     *
+     * @var int[]
+     */
+    private static $adminAuthTokenTimestamps = [];
+
     /**
      * Return the API token for an admin user
      * Use MAGENTO_ADMIN_USERNAME and MAGENTO_ADMIN_PASSWORD when $username and/or $password is/are omitted
@@ -62,7 +69,7 @@ public static function getAdminToken($username = null, $password = null)
             throw new FastFailException($message, $context);
         }
 
-        if (isset(self::$adminAuthTokens[$login])) {
+        if (self::hasExistingToken($login)) {
             return self::$adminAuthTokens[$login];
         }
 
@@ -97,6 +104,7 @@ public static function getAdminToken($username = null, $password = null)
             $token = json_decode($response);
             if ($token !== null) {
                 self::$adminAuthTokens[$login] = $token;
+                self::$adminAuthTokenTimestamps[$login] = time();
                 return $token;
             }
             $errMessage = "Invalid response: {$response}";
@@ -117,4 +125,23 @@ public static function getAdminToken($username = null, $password = null)
         $context = ['url' => $authUrl];
         throw new FastFailException($message, $context);
     }
+
+    /**
+     * Is there an existing WebAPI admin token for this login?
+     *
+     * @param string $login
+     * @return boolean
+     */
+    private static function hasExistingToken(string $login)
+    {
+        if (!isset(self::$adminAuthTokens[$login])) {
+            return false;
+        }
+
+        $tokenLifetime = getenv('MAGENTO_ADMIN_WEBAPI_TOKEN_LIFETIME');
+
+        $isTokenExpired = $tokenLifetime && time() - self::$adminAuthTokenTimestamps[$login] > $tokenLifetime;
+
+        return !$isTokenExpired;
+    }
 }