Merge pull request #142 from magento-gl/MQE-3092

MQE-3092 throw error message if key value pair is not mapped properly in .credentials file

Author: KevinBKozan

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

@@ -8,27 +8,30 @@
 namespace tests\unit\Magento\FunctionalTestFramework\DataGenerator\Handlers\SecretStorage;
 
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\SecretStorage\FileStorage;
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use ReflectionClass;
+use ReflectionException;
 use tests\unit\Util\MagentoTestCase;
 
 class FileStorageTest extends MagentoTestCase
 {
     /**
      * Test basic encryption/decryption functionality in FileStorage class.
+     * @throws TestFrameworkException|ReflectionException
      */
     public function testBasicEncryptDecrypt(): void
     {
         $testKey = 'magento/myKey';
         $testValue = 'myValue';
-        $creds = ["$testKey=$testValue"];
+        $cred = ["$testKey=$testValue"];
 
         $fileStorage = new FileStorage();
         $reflection = new ReflectionClass(FileStorage::class);
 
         // Emulate initialize() function result with the test credentials
         $reflectionMethod = $reflection->getMethod('encryptCredFileContents');
         $reflectionMethod->setAccessible(true);
-        $secretData = $reflectionMethod->invokeArgs($fileStorage, [$creds]);
+        $secretData = $reflectionMethod->invokeArgs($fileStorage, [$cred]);
 
         // Set encrypted test credentials to the private 'secretData' property
         $reflectionProperty = $reflection->getProperty('secretData');
@@ -45,4 +48,32 @@ public function testBasicEncryptDecrypt(): void
         // assert that we are able to successfully decrypt our secret value
         $this->assertEquals($testValue, $actualValue);
     }
+
+    /**
+     * Test empty value encryption/decryption functionality in FileStorage class.
+     * @return void
+     * @throws TestFrameworkException|ReflectionException
+     */
+    public function testEmptyValueEncryptDecrypt(): void
+    {
+        $this->expectException(TestFrameworkException::class);
+
+        $testKey = 'magento/myKey';
+        $cred = ["$testKey"];
+
+        $fileStorage = new FileStorage();
+        $reflection = new ReflectionClass(FileStorage::class);
+
+        // Emulate initialize() function result with the test credentials
+        $reflectionMethod = $reflection->getMethod('encryptCredFileContents');
+        $reflectionMethod->setAccessible(true);
+        $secretData = $reflectionMethod->invokeArgs($fileStorage, [$cred]);
+
+        // Set encrypted test credentials to the private 'secretData' property
+        $reflectionProperty = $reflection->getProperty('secretData');
+        $reflectionProperty->setAccessible(true);
+        $reflectionProperty->setValue($fileStorage, $secretData);
+
+        $fileStorage->getEncryptedValue($testKey);
+    }
 }

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

@@ -6,8 +6,8 @@
 
 namespace Magento\FunctionalTestingFramework\DataGenerator\Handlers\SecretStorage;
 
-use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 use Magento\FunctionalTestingFramework\Util\Logger\LoggingUtil;
 use Magento\FunctionalTestingFramework\Util\Path\FilePathFormatter;
 
@@ -93,13 +93,18 @@ private function readInCredentialsFile()
      *
      * @param array $credContents
      * @return array
+     * @throws TestFrameworkException
      */
     private function encryptCredFileContents($credContents)
     {
         $encryptedCreds = [];
         foreach ($credContents as $credValue) {
             if (substr($credValue, 0, 1) === '#' || empty($credValue)) {
                 continue;
+            } elseif (strpos($credValue, "=") === false) {
+                throw new TestFrameworkException(
+                    $credValue . " not configured correctly in .credentials file"
+                );
             }
 
             list($key, $value) = explode("=", $credValue, 2);