add matrix options

Author: AaronZyLee

packages/amplify-codegen-e2e-core/src/categories/codegen.ts

@@ -76,42 +76,66 @@ export function generateTypes(cwd: string) : Promise<void> {
 
 // CLI workflow to add codegen to Amplify project
 export function addCodegen(cwd: string, settings: any = {}): Promise<void> {
+  const defaultSettings = {
+    params: [],
+    isAPINotAdded: false,
+    isCodegenAdded: false,
+    frontendType: AmplifyFrontend.javascript,
+    framework: 'none',
+    codegenTarget: 'typescript',
+    isStatementGenerated: true,
+    statementNamePattern: '\r', // default value
+    maxDepth: '\r', // default value
+    isTypeGenerated: true,
+    typeFileName: '\r', // default value
+  }
+  const mergedSettings = { ...defaultSettings, ...settings };
   return new Promise((resolve, reject) => {
-    const params = settings.params
-      ? ['codegen', 'add', ...settings.params]
+    const params = mergedSettings.params
+      ? ['codegen', 'add', ...mergedSettings.params]
       : ['codegen', 'add'];
     const chain = spawn(getCLIPath(), params, { cwd, stripColors: true });
-    if (settings.isAPINotAdded) {
+    if (mergedSettings.isAPINotAdded) {
       chain.wait("There are no GraphQL APIs available.");
       chain.wait("Add by running $amplify api add");
     }
-    else if (settings.isCodegenAdded) {
+    else if (mergedSettings.isCodegenAdded) {
       chain.wait("Codegen support only one GraphQL API per project");
     }
     else {
-      if (settings.frontendType === AmplifyFrontend.javascript) {
+      if (mergedSettings.frontendType === AmplifyFrontend.javascript) {
         chain.wait('Choose the code generation language target');
-        if (settings.framework === 'angular' || settings.framework === 'ionic') {
-          singleSelect(chain, settings.codegenTarget, ['angular', 'typescript']);
+        if (mergedSettings.framework === 'angular' || mergedSettings.framework === 'ionic') {
+          singleSelect(chain, mergedSettings.codegenTarget, ['angular', 'typescript']);
         } else {
-          singleSelect(chain, settings.codegenTarget, ['javascript', 'typescript', 'flow']);
+          singleSelect(chain, mergedSettings.codegenTarget, ['javascript', 'typescript', 'flow']);
         }
       }
       chain
         .wait('Enter the file name pattern of graphql queries, mutations and subscriptions')
-        .sendCarriageReturn()
-        .wait('Do you want to generate/update all possible GraphQL operations')
-        .sendLine('y')
-        .wait('Enter maximum statement depth [increase from default if your schema is deeply')
-        .sendCarriageReturn();
-      const isTypeGenIncluded = settings.frontendType === AmplifyFrontend.ios
-        || (settings.frontendType === AmplifyFrontend.javascript && settings.codegenTarget !== 'javascript');
+        .sendLine(mergedSettings.statementNamePattern)
+        .wait('Do you want to generate/update all possible GraphQL operations');
+      if (mergedSettings.isStatementGenerated) {
+        chain
+          .sendLine('y')
+          .wait('Enter maximum statement depth [increase from default if your schema is deeply')
+          .sendLine(mergedSettings.maxDepth);
+      } else {
+        chain.sendLine('n');
+      }
+
+      const isTypeGenIncluded = mergedSettings.frontendType === AmplifyFrontend.ios
+        || (mergedSettings.frontendType === AmplifyFrontend.javascript && mergedSettings.codegenTarget !== 'javascript');
       if (isTypeGenIncluded) {
         chain
           .wait('Enter the file name for the generated code')
-          .sendCarriageReturn()
-          .wait('Do you want to generate code for your newly created GraphQL API')
-          .sendCarriageReturn();
+          .sendLine(mergedSettings.typeFileName)
+          .wait('Do you want to generate code for your newly created GraphQL API');
+          if (mergedSettings.isTypeGenerated) {
+            chain.sendLine('y');
+          } else {
+            chain.sendLine('n');
+          }
       }
     }
 

packages/amplify-codegen-e2e-core/src/configure/index.ts

@@ -17,7 +17,7 @@ const defaultProjectSettings = {
   name: '\r',
   envName: 'integtest',
   editor: '\r',
-  appType: 'javascript',
+  frontendType: 'javascript',
   framework: 'none',
   srcDir: '\r',
   distDir: '\r',
@@ -152,6 +152,7 @@ export function amplifyConfigureProject(settings: {
 
 export function amplifyConfigureProjectInfo(settings: {
   cwd: string,
+  frontendType: string,
 }): Promise<void> {
   const {
     cwd,
@@ -166,9 +167,9 @@ export function amplifyConfigureProjectInfo(settings: {
       .wait('Choose your default editor:')
       .sendLine(s.editor)
       .wait("Choose the type of app that you're building") 
-      .sendLine(s.appType);
+      .sendLine(s.frontendType);
 
-    switch (s.appType) {
+    switch (s.frontendType) {
       case 'javascript':
         chain.wait('What javascript framework are you using');
         singleSelect(chain, s.framework, javaScriptFrameworkList);
@@ -192,11 +193,20 @@ export function amplifyConfigureProjectInfo(settings: {
       case 'flutter':
         chain
           .wait('Where do you want to store your configuration file?')
-          .sendLine(s.srcDir)
+          .sendLine(s.srcDir);
+        break;
       default:
-        throw new Error(`Frontend type ${s.appType} is not supported.`);
+        throw new Error(`Frontend type ${s.frontendType} is not supported.`);
     }
 
-    chain.wait('Successfully made configuration changes to your project.');
+    chain
+      .wait('Successfully made configuration changes to your project.')
+      .run((err: Error) => {
+        if (!err) {
+          resolve();
+        } else {
+          reject(err);
+        }
+      });
   })
 }

packages/amplify-codegen-e2e-core/src/init/initProjectHelper.ts

@@ -78,7 +78,7 @@ export function initJSProjectWithProfile(cwd: string, settings: Object = {}): Pr
     }
 
     chain
-      .wait('Help improve Amplify CLI by sharing non sensitive configurations on failures')
+      .wait('Help improve Amplify CLI by sharing non-sensitive project configurations on failures')
       .sendConfirmYes()
       .wait('Try "amplify add api" to create a backend API and then "amplify push" to deploy everything')
       .run((err: Error) => {
@@ -120,7 +120,7 @@ export function initAndroidProjectWithProfile(cwd: string, settings: Object): Pr
       .sendCarriageReturn()
       .wait('Please choose the profile you want to use')
       .sendLine(s.profileName)
-      .wait('Help improve Amplify CLI by sharing non sensitive configurations on failures')
+      .wait('Help improve Amplify CLI by sharing non-sensitive project configurations on failures')
       .sendConfirmYes()
       .wait('Try "amplify add api" to create a backend API and then "amplify push" to deploy everything')
       .run((err: Error) => {
@@ -163,17 +163,11 @@ export function initIosProjectWithProfile(cwd: string, settings: Object): Promis
       .sendCarriageReturn()
       .wait('Please choose the profile you want to use')
       .sendLine(s.profileName)
-      .wait('Help improve Amplify CLI by sharing non sensitive configurations on failures')
+      .wait('Help improve Amplify CLI by sharing non-sensitive project configurations on failures')
       .sendConfirmYes()
       .wait('Try "amplify add api" to create a backend API and then "amplify push" to deploy everything')
-      .run((err: Error) => {
-        if (!err) {
-          addCITags(cwd);
-
-          resolve();
-        } else {
-          reject(err);
-        }
+      .run(() => {
+        resolve();
       });
   });
 }
@@ -206,7 +200,7 @@ export function initFlutterProjectWithProfile(cwd: string, settings: Object): Pr
     singleSelect(chain, s.region, amplifyRegions);
 
     chain
-      .wait('Help improve Amplify CLI by sharing non sensitive configurations on failures')
+      .wait('Help improve Amplify CLI by sharing non-sensitive project configurations on failures')
       .sendConfirmYes()
       .wait('Try "amplify add api" to create a backend API and then "amplify push" to deploy everything')
       .run((err: Error) => {

packages/amplify-codegen-e2e-tests/src/__tests__/add-codegen-js.test.ts

@@ -7,6 +7,9 @@ import {
     addApiWithoutSchema,
     updateApiSchema,
     AmplifyFrontend,
+    apiGqlCompile,
+    removeCodegen,
+    amplifyConfigureProjectInfo,
 } from "@aws-amplify/amplify-codegen-e2e-core";
 import { existsSync } from "fs";
 import path from 'path';
@@ -17,6 +20,7 @@ import {
     testSetupBeforeAddCodegen,
     getGraphQLConfigFilePath,
     testValidGraphQLConfig,
+    testAddCodegenMatrix,
 } from '../codegen-tests-base';
 
 const schema = 'simple_model.graphql';
@@ -82,17 +86,51 @@ describe('codegen add tests - JS', () => {
     it(`supports add codegen with redundant region parameter`, async () => {
         await testAddCodegen(config, projectRoot, schema, ['--region', 'us-fake-1']);
     });
+});
 
-    describe.only('JS codegen matrix test', async () => {
-      it('Adding codegen works as expected', async () => {
-        config =   {
-          frontendType: AmplifyFrontend.javascript,
-          framework: 'angular',
-          codegenTarget: 'angluar',
-          srcDir: 'src',
-          graphqlCodegenDir : 'src/graphql'
-        }
-        await testAddCodegen(config, projectRoot, schema);
-      });
-    });
+describe.only('JS codegen matrix test', () => {
+  let projectRoot: string;
+  let config = DEFAULT_JS_CONFIG;
+
+  beforeAll(async () => {
+    projectRoot = await createNewProjectDir('addCodegenMatrixJS');
+    // init project and add API category
+    await initProjectWithProfile(projectRoot, { ...config });
+    const projectName = createRandomName();
+    await addApiWithoutSchema(projectRoot, { apiName: projectName });
+    await updateApiSchema(projectRoot, projectName, schema);
+    await apiGqlCompile(projectRoot);
+    
+  });
+  beforeEach(async () => {
+
+  });
+  afterEach(async () => {
+    await removeCodegen(projectRoot);
+    await amplifyConfigureProjectInfo({ cwd: projectRoot, frontendType: 'flutter'} )
+  });
+  afterAll(async () => {
+      await deleteAmplifyProject(projectRoot);
+  });
+
+  it('Adding codegen works as expected 1', async () => {
+    config =   {
+      frontendType: AmplifyFrontend.javascript,
+      framework: 'ionic',
+      codegenTarget: 'angluar',
+      srcDir: 'src',
+      graphqlCodegenDir : 'src/graphql'
+    }
+    await testAddCodegenMatrix(config, projectRoot);
+  });
+  it('Adding codegen works as expected 2', async () => {
+    config =   {
+      frontendType: AmplifyFrontend.javascript,
+      framework: 'react',
+      codegenTarget: 'typescript',
+      srcDir: 'src',
+      graphqlCodegenDir : 'src/graphql'
+    }
+    await testAddCodegenMatrix(config, projectRoot);
+  });
 });

packages/amplify-codegen-e2e-tests/src/codegen-tests-base/add-codegen.ts

@@ -11,12 +11,39 @@ import {
     generateStatementsAndTypes,
     generateStatements,
     generateTypes,
+    amplifyConfigureProjectInfo,
+    deleteProjectDir,
 } from "@aws-amplify/amplify-codegen-e2e-core";
 import { existsSync, readFileSync, writeFileSync, readdirSync, rmSync } from "fs";
 import path from 'path';
 import { isNotEmptyDir } from '../utils';
 import { getGraphQLConfigFilePath, testSetupBeforeAddCodegen, testValidGraphQLConfig } from "./test-setup";
 
+type CodegenMatrixTestProps = AmplifyFrontendConfig & {
+  params?: string[];
+  isAPINotAdded?: boolean;
+  isCodegenAdded?: boolean;
+  frontendType?: AmplifyFrontend;
+  framework?: string;
+  codegenTarget?: string;
+  isStatementGenerated?: boolean;
+  statementNamePattern?: string;
+  maxDepth?: number;
+  isTypeGenerated?: boolean;
+  typeFileName?: string;
+}
+
+export async function testAddCodegenMatrix(config: CodegenMatrixTestProps, projectRoot: string) {
+  await amplifyConfigureProjectInfo({ cwd: projectRoot, ...config });
+  deleteProjectDir(path.join(projectRoot, config.graphqlCodegenDir));
+  // Setup the non-amplify project with schema and pre-existing files
+  const userSourceCodePath = testSetupBeforeAddCodegen(projectRoot, config);
+  await expect(addCodegen(projectRoot, { ...config })).resolves.not.toThrow();
+  expect(isNotEmptyDir(path.join(projectRoot, config.graphqlCodegenDir))).toBe(true);
+  // pre-existing file should still exist
+  expect(existsSync(userSourceCodePath)).toBe(true);
+}
+
 export async function testAddCodegen(config: AmplifyFrontendConfig, projectRoot: string, schema: string, additionalParams?: Array<string>) {
     // init project and add API category
     await initProjectWithProfile(projectRoot, { ...config });

shared-scripts.sh

@@ -225,7 +225,7 @@ function _installCLIFromLocalRegistry {
     fi
     setNpmRegistryUrlToLocal
     changeNpmGlobalPath
-    npm install -g @aws-amplify/cli-internal@cdk228withdata3
+    npm install -g @aws-amplify/cli-internal
     echo "using Amplify CLI version: "$(amplify --version)
     npm list -g --depth=1 | grep -e '@aws-amplify/amplify-category-api' -e 'amplify-codegen'
     unsetNpmRegistryUrl