MQE-1600: unit and static test fixes

Author: jilu1

dev/tests/unit/Magento/FunctionalTestFramework/DataGenerator/Handlers/CredentialStoreTest.php renamed to dev/tests/unit/Magento/FunctionalTestFramework/DataGenerator/Handlers/SecretStorage/FileStorageTest.php

@@ -4,33 +4,34 @@
  * See COPYING.txt for license details.
  */
 
-namespace tests\unit\Magento\FunctionalTestFramework\DataGenerator\Handlers;
+namespace tests\unit\Magento\FunctionalTestFramework\DataGenerator\Handlers\SecretStorage;
 
-use Magento\FunctionalTestingFramework\DataGenerator\Handlers\CredentialStore;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\SecretStorage\FileStorage;
 use Magento\FunctionalTestingFramework\Util\MagentoTestCase;
 use AspectMock\Test as AspectMock;
 
-class CredentialStoreTest extends MagentoTestCase
+class FileStorageTest extends MagentoTestCase
 {
 
     /**
-     * Test basic encryption/decryption functionality in CredentialStore class.
+     * Test basic encryption/decryption functionality in FileStorage class.
      */
     public function testBasicEncryptDecrypt()
     {
-        $testKey = 'myKey';
+        $testKey = 'magento/myKey';
         $testValue = 'myValue';
 
-        AspectMock::double(CredentialStore::class, [
+        AspectMock::double(FileStorage::class, [
             'readInCredentialsFile' => ["$testKey=$testValue"]
         ]);
 
-        $encryptedCred = CredentialStore::getInstance()->getSecret($testKey);
+        $fileStorage = new FileStorage();
+        $encryptedCred = $fileStorage->getEncryptedValue($testKey);
 
         // assert the value we've gotten is in fact not identical to our test value
         $this->assertNotEquals($testValue, $encryptedCred);
 
-        $actualValue = CredentialStore::getInstance()->decryptSecretValue($encryptedCred);
+        $actualValue = $fileStorage->getDecryptedValue($encryptedCred);
 
         // assert that we are able to successfully decrypt our secret value
         $this->assertEquals($testValue, $actualValue);

etc/config/.env.example

@@ -30,7 +30,7 @@ BROWSER=chrome
 #MAGENTO_RESTAPI_SERVER_PORT=8080
 #MAGENTO_RESTAPI_SERVER_PROTOCOL=https
 
-*** Uncomment and set vault base url and access token if you want to use vault to manage _CREDS secrets ***#
+#*** Uncomment and set vault base url and access token if you want to use vault to manage _CREDS secrets ***#
 #CREDENTIAL_VAULT_BASE_URL=
 #CREDENTIAL_VAULT_TOKEN=
 

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/CredentialStore.php

@@ -79,15 +79,15 @@ private function __construct()
     public function getSecret($key)
     {
         // Get secret data from vault storage first
-        if (!is_null($this->credVault)) {
+        if (null !== $this->credVault) {
             $value = $this->credVault->getEncryptedValue($key);
             if (!empty($value)) {
                 return $value;
             }
         }
 
         // Get secret data from file when not found in vault
-        if (!is_null($this->credFile)) {
+        if (null !== $this->credFile) {
             $value = $this->credFile->getEncryptedValue($key);
             if (!empty($value)) {
                 return $value;
@@ -107,11 +107,11 @@ public function getSecret($key)
      */
     public function decryptSecretValue($value)
     {
-        if (!is_null($this->credVault)) {
+        if (null !== $this->credVault) {
             return $this->credVault->getDecryptedValue($value);
         }
 
-        if (!is_null($this->credFile)) {
+        if (null !== $this->credFile) {
             return $this->credFile->getDecryptedValue($value);
         }
     }
@@ -124,11 +124,11 @@ public function decryptSecretValue($value)
      */
     public function decryptAllSecretsInString($string)
     {
-        if (!is_null($this->credVault)) {
+        if (null !== $this->credVault) {
             return $this->credVault->getAllDecryptedValues($string);
         }
 
-        if (!is_null($this->credFile)) {
+        if (null !== $this->credFile) {
             return $this->credFile->getAllDecryptedValues($string);
         }
     }

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/SecretStorage/BaseStorage.php

@@ -31,9 +31,12 @@ abstract class BaseStorage
      */
     protected static $cachedSecretData = [];
 
+    /**
+     * BaseStorage constructor
+     */
     public function __construct()
     {
-        if (is_null(self::$encodedKey)) {
+        if (null === self::$encodedKey) {
             self::$encodedKey = base64_encode(openssl_random_pseudo_bytes(16));
             self::$iv = substr(hash('sha256', self::$encodedKey), 0, 16);
         }

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/SecretStorage/FileStorage.php

@@ -41,7 +41,7 @@ public function __construct()
     public function getEncryptedValue($key)
     {
         // Check if secret is in cached array
-        if (!is_null($value = parent::getEncryptedValue($key))) {
+        if (null !== ($value = parent::getEncryptedValue($key))) {
             return $value;
         }
 
@@ -52,7 +52,6 @@ public function getEncryptedValue($key)
                     "retrieving secret for key name {$key} from file"
                 );
             }
-
         } catch (\Exception $e) {
         }
 

src/Magento/FunctionalTestingFramework/DataGenerator/Handlers/SecretStorage/VaultStorage.php

@@ -51,9 +51,9 @@ class VaultStorage extends BaseStorage
     public function __construct($baseUrl, $token)
     {
         parent::__construct();
-        if (is_null(self::$client)) {
+        if (null === self::$client) {
             // Creating the client using Guzzle6 Transport and passing a custom url
-            self::$client = new Client(new Guzzle6Transport(['base_url' => $baseUrl . self::BASE_PATH]));
+            self::$client = new Client(new Guzzle6Transport(['base_url' => $baseUrl]));
         }
         $this->token = $token;
         if (!$this->authenticated()) {
@@ -70,7 +70,7 @@ public function __construct($baseUrl, $token)
     public function getEncryptedValue($key)
     {
         // Check if secret is in cached array
-        if (!is_null($value = parent::getEncryptedValue($key))) {
+        if (null !== ($value = parent::getEncryptedValue($key))) {
             return $value;
         }
 
@@ -124,7 +124,7 @@ private function authenticated()
             if ($authenticated) {
                 return true;
             }
-        } catch (\Psr\Cache\InvalidArgumentException $e) {
+        } catch (\Exception $e) {
         }
         return false;
     }