test: add e2e testing for config generation (#682)

* test: add e2e testing for config generation

* remove unused imports

* test

* fix tests

* fix tests

* use getClientConfigPath in assertPostDeployment

* remove unused import

* remove createProject from MinimalWithTypescriptIdiomTestProject

* remove sandbox config test and move testing all config formats to pipeline deploy test

* remove unused import

* add new method for asserting client config generation

Author: rtpascual

.changeset/gold-dancers-punch.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/integration-tests': patch
+---
+
+Add e2e testing for config generation

package-lock.json

@@ -8,6 +8,7 @@
     "@aws-amplify/backend-auth": "0.3.3",
     "@aws-amplify/backend-secret": "^0.3.0",
     "@aws-amplify/backend-storage": "0.3.0",
+    "@aws-amplify/client-config": "^0.4.0",
     "@aws-amplify/data-schema": "^0.12.9",
     "@aws-sdk/client-amplify": "^3.440.0",
     "@aws-sdk/client-cloudformation": "^3.421.0",

packages/integration-tests/package.json

@@ -21,6 +21,7 @@ import {
 import assert from 'node:assert';
 import { TestBranch, amplifyAppPool } from '../amplify_app_pool.js';
 import { BackendIdentifier } from '@aws-amplify/plugin-types';
+import { ClientConfigFormat } from '@aws-amplify/client-config';
 import { testConcurrencyLevel } from './test_concurrency.js';
 
 const testProjectCreators = getTestProjectCreators();
@@ -75,6 +76,28 @@ void describe(
               branchBackendIdentifier.name
             )
           );
+
+          // test generating all client formats
+          for (const format of Object.values(ClientConfigFormat)) {
+            await amplifyCli(
+              [
+                'generate',
+                'config',
+                '--branch',
+                testBranch.branchName,
+                '--app-id',
+                testBranch.appId,
+                '--format',
+                format,
+              ],
+              testProject.projectDirPath
+            ).run();
+
+            await testProject.assertClientConfigExists(
+              testProject.projectDirPath,
+              format
+            );
+          }
         });
       });
     });

packages/integration-tests/src/test-e2e/deployment.test.ts

@@ -154,15 +154,4 @@ class DataStorageAuthWithTriggerTestProject extends TestProjectBase {
       await this.secretClient.removeSecret(backendId, secretName);
     }
   };
-
-  assertPostDeployment = async (): Promise<void> => {
-    const clientConfig = await fs.readFile(
-      path.join(this.projectDirPath, 'amplifyconfiguration.json'),
-      'utf-8'
-    );
-    // check that the client config is a valid json object
-    // we're not validating content here because it was causing e2e noise for small updates without providing value
-    // individual components of the client config are tested at the unit / integration level
-    JSON.parse(clientConfig);
-  };
 }

packages/integration-tests/src/test-project-setup/data_storage_auth_with_triggers.ts

@@ -1,7 +1,5 @@
 import { TestProjectBase } from './test_project_base.js';
 import fs from 'fs/promises';
-import assert from 'node:assert';
-import path from 'path';
 import { createEmptyAmplifyProject } from './create_empty_amplify_project.js';
 import { CloudFormationClient } from '@aws-sdk/client-cloudformation';
 import { TestProjectCreator } from './test_project_creator.js';
@@ -65,11 +63,4 @@ class MinimalWithTypescriptIdiomTestProject extends TestProjectBase {
   ) {
     super(name, projectDirPath, projectAmplifyDirPath, cfnClient);
   }
-
-  assertPostDeployment = async (): Promise<void> => {
-    const clientConfigStats = await fs.stat(
-      path.join(this.projectDirPath, 'amplifyconfiguration.json')
-    );
-    assert.ok(clientConfigStats.isFile());
-  };
 }

packages/integration-tests/src/test-project-setup/minimal_with_typescript_idioms.ts

@@ -1,5 +1,9 @@
 import { BackendIdentifierConversions } from '@aws-amplify/platform-core';
 import { BackendIdentifier } from '@aws-amplify/plugin-types';
+import {
+  ClientConfigFormat,
+  getClientConfigPath,
+} from '@aws-amplify/client-config';
 import { amplifyCli } from '../process-controller/process_controller.js';
 import {
   confirmDeleteSandbox,
@@ -12,6 +16,8 @@ import {
   CloudFormationClient,
   DeleteStackCommand,
 } from '@aws-sdk/client-cloudformation';
+import fsp from 'fs/promises';
+import assert from 'node:assert';
 
 /**
  * Keeps test project update info.
@@ -26,7 +32,6 @@ export type TestProjectUpdate = {
  * The base abstract class for test project.
  */
 export abstract class TestProjectBase {
-  abstract assertPostDeployment: () => Promise<void>;
   abstract readonly sourceProjectAmplifyDirPath: URL;
 
   /**
@@ -90,4 +95,25 @@ export abstract class TestProjectBase {
   async getUpdates(): Promise<TestProjectUpdate[]> {
     return [];
   }
+
+  /**
+   * Verify the project after deployment.
+   */
+  async assertPostDeployment(): Promise<void> {
+    await this.assertClientConfigExists(
+      this.projectDirPath,
+      ClientConfigFormat.JSON
+    );
+  }
+
+  /**
+   * Verify client config file is generated with the provided directory and format.
+   */
+  async assertClientConfigExists(dir?: string, format?: ClientConfigFormat) {
+    const clientConfigStats = await fsp.stat(
+      await getClientConfigPath(dir ?? this.projectDirPath, format)
+    );
+
+    assert.ok(clientConfigStats.isFile());
+  }
 }

packages/integration-tests/src/test-project-setup/test_project_base.ts

@@ -6,6 +6,7 @@
     { "path": "../backend-auth" },
     { "path": "../backend-secret" },
     { "path": "../backend-storage" },
+    { "path": "../client-config" },
     { "path": "../platform-core" }
   ],
   "exclude": ["**/node_modules", "**/lib", "src/e2e-tests", "test-projects"]