Merge pull request #300 from aws-amplify/e2e-testing

Fix E2e tests by including the API category walkthrough changes

Author: phani-srikar

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

@@ -32,14 +32,15 @@ const defaultOptions: AddApiOptions = {
   testingWithLatestCodebase: false
 };
 
-export function addApiWithoutSchema(cwd: string, opts: Partial<AddApiOptions> = {}) {
+export function addApiWithoutSchema(cwd: string, opts: Partial<AddApiOptions & { apiKeyExpirationDays: number }> = {}) {
   const options = _.assign(defaultOptions, opts);
   return new Promise<void>((resolve, reject) => {
-    spawn(getCLIPath(), ['add', 'api'], { cwd, stripColors: true })
+    spawn(getCLIPath(options.testingWithLatestCodebase), ['add', 'api'], { cwd, stripColors: true })
       .wait('Please select from one of the below mentioned services:')
       .sendCarriageReturn()
       .wait(/.*Here is the GraphQL API that we will create. Select a setting to edit or continue.*/)
       .sendKeyUp(3)
+      .sendCarriageReturn()
       .wait('Provide API name:')
       .sendLine(options.apiName)
       .wait(/.*Here is the GraphQL API that we will create. Select a setting to edit or continue.*/)
@@ -48,10 +49,9 @@ export function addApiWithoutSchema(cwd: string, opts: Partial<AddApiOptions> =
       .sendCarriageReturn()
       .wait('Do you want to edit the schema now?')
       .sendConfirmNo()
-      .wait('Successfully added resource collectionapi locally')
-      // .wait(
-      //   '"amplify publish" will build all your local backend and frontend resources (if you have hosting category added) and provision it in the cloud',
-      // )
+      .wait(
+        '"amplify publish" will build all your local backend and frontend resources (if you have hosting category added) and provision it in the cloud',
+      )
       .run((err: Error) => {
         if (!err) {
           resolve();
@@ -126,45 +126,6 @@ export function addApiWithBlankSchemaAndConflictDetection(cwd: string) {
   });
 }
 
-export function addApiWithSchemaAndConflictDetection(cwd: string, schemaFile: string) {
-  const schemaPath = getSchemaPath(schemaFile);
-  return new Promise<void>((resolve, reject) => {
-    spawn(getCLIPath(), ['add', 'api'], { cwd, stripColors: true })
-      .wait('Please select from one of the below mentioned services:')
-      .sendCarriageReturn()
-      .wait('Provide API name:')
-      .sendCarriageReturn()
-      .wait(/.*Choose the default authorization type for the API.*/)
-      .sendCarriageReturn()
-      .wait(/.*Enter a description for the API key.*/)
-      .sendCarriageReturn()
-      .wait(/.*After how many days from now the API key should expire.*/)
-      .sendCarriageReturn()
-      .wait(/.*Do you want to configure advanced settings for the GraphQL API.*/)
-      .sendLine(KEY_DOWN_ARROW) // Down
-      .wait(/.*Configure additional auth types.*/)
-      .sendLine('n')
-      .wait(/.*Enable conflict detection.*/)
-      .sendLine('y')
-      .wait(/.*Select the default resolution strategy.*/)
-      .sendCarriageReturn()
-      .wait(/.*Do you have an annotated GraphQL schema.*/)
-      .sendLine('y')
-      .wait('Provide your schema file path:')
-      .sendLine(schemaPath)
-      .wait(
-        '"amplify publish" will build all your local backend and frontend resources (if you have hosting category added) and provision it in the cloud',
-      )
-      .run((err: Error) => {
-        if (!err) {
-          resolve();
-        } else {
-          reject(err);
-        }
-      });
-  });
-}
-
 export function updateApiSchema(cwd: string, projectName: string, schemaName: string, forceUpdate: boolean = false) {
   const testSchemaPath = getSchemaPath(schemaName);
   let schemaText = fs.readFileSync(testSchemaPath).toString();
@@ -265,26 +226,6 @@ export function apiDisableDataStore(cwd: string, settings: any) {
   });
 }
 
-export function apiUpdateToggleDataStore(cwd: string, settings: any = {}) {
-  return new Promise<void>((resolve, reject) => {
-    spawn(getCLIPath(settings.testingWithLatestCodebase), ['update', 'api'], { cwd, stripColors: true })
-      .wait('Please select from one of the below mentioned services:')
-      .sendCarriageReturn()
-      .wait('Select from the options below')
-      .send(KEY_DOWN_ARROW)
-      .sendLine(KEY_DOWN_ARROW) // select enable datastore for the api
-      .wait(/.*Successfully updated resource.*/)
-      .sendEof()
-      .run((err: Error) => {
-        if (!err) {
-          resolve();
-        } else {
-          reject(err);
-        }
-      });
-  });
-}
-
 export function updateAPIWithResolutionStrategyWithoutModels(cwd: string, settings: any) {
   return new Promise<void>((resolve, reject) => {
     spawn(getCLIPath(settings.testingWithLatestCodebase), ['update', 'api'], { cwd, stripColors: true })

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

@@ -1,9 +1,11 @@
 import { 
     createNewProjectDir,
     initProjectWithProfile,
-    addApiWithSchema,
     addCodegen,
-    DEFAULT_JS_CONFIG
+    DEFAULT_JS_CONFIG,
+    createRandomName,
+    addApiWithoutSchema,
+    updateApiSchema
 } from "amplify-codegen-e2e-core";
 import { existsSync } from "fs";
 import path from 'path';
@@ -46,7 +48,9 @@ describe('codegen add tests - JS', () => {
     it(`Adding codegen twice gives appropriate message`, async () => {
         // init project and add API category
         await initProjectWithProfile(projectRoot, { ...config });
-        await addApiWithSchema(projectRoot, schema);
+        const projectName = createRandomName();
+        await addApiWithoutSchema(projectRoot, { apiName: projectName });
+        await updateApiSchema(projectRoot, projectName, schema);
 
         const userSourceCodePath = testSetupBeforeAddCodegen(projectRoot, config);
 

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

@@ -2,10 +2,10 @@ import {
   createNewProjectDir, 
   deleteProjectDir,
   deleteProject,
-  addApiWithSchema,
   initJSProjectWithProfile,
   amplifyPush,
   generateModels,
+  addApiWithoutSchema,
   updateApiSchema
 } from "amplify-codegen-e2e-core";
 import { addEnvironment, checkoutEnvironment } from "../environment/env";
@@ -27,7 +27,9 @@ describe('env codegen tests', () => {
   it('should generate models in different environments', async () => {
     //create amplify project with enva
     await initJSProjectWithProfile(projectRoot, { envName: 'enva' });
-    await addApiWithSchema(projectRoot, schema, { apiName });
+    await addApiWithoutSchema(projectRoot, { apiName: apiName });
+    await updateApiSchema(projectRoot, apiName, schema);
+
     await amplifyPush(projectRoot);
     //create new envb
     await addEnvironment(projectRoot, { envName: 'envb' });

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

@@ -3,7 +3,9 @@ import {
   deleteProjectDir,
   deleteProject,
   initJSProjectWithProfile,
-  addApiWithSchemaAndConflictDetection,
+  addApiWithBlankSchemaAndConflictDetection,
+  updateApiSchema,
+  createRandomName,
   amplifyPush,
   amplifyPull,
   getAppId,
@@ -37,9 +39,11 @@ describe('Amplify pull in amplify app with codegen tests', () => {
   let projectRoot: string;
   let appId: string;
   beforeAll(async () => {
+    const name = createRandomName();
     projectRoot = await createNewProjectDir('pullCodegen');
-    await initJSProjectWithProfile(projectRoot, { envName, disableAmplifyAppCreation: false });
-    await addApiWithSchemaAndConflictDetection(projectRoot, schema);
+    await initJSProjectWithProfile(projectRoot, { name, envName, disableAmplifyAppCreation: false });
+    await addApiWithBlankSchemaAndConflictDetection(projectRoot);
+    await updateApiSchema(projectRoot, name, schema);
     await amplifyPush(projectRoot);
     appId = getAppId(projectRoot);
     expect(appId).toBeDefined();

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

@@ -3,7 +3,9 @@ import {
     DEFAULT_JS_CONFIG, 
     removeCodegen,
     initProjectWithProfile,
-    addApiWithSchema
+    addApiWithoutSchema,
+    updateApiSchema,
+    createRandomName
 } from "amplify-codegen-e2e-core";
 import { deleteAmplifyProject, testRemoveCodegen } from '../codegen-tests-base';
 
@@ -23,7 +25,9 @@ describe('codegen remove tests - JS', () => {
     it(`Give appropriate message during remove when codegen is not added in JS project`, async () => {
         // init project and add API category
         await initProjectWithProfile(projectRoot, DEFAULT_JS_CONFIG);
-        await addApiWithSchema(projectRoot, schema);
+        const projectName = createRandomName();
+        await addApiWithoutSchema(projectRoot, { apiName: projectName });
+        await updateApiSchema(projectRoot, projectName, schema);
 
         // remove command should give expected message
         await expect(removeCodegen(projectRoot, false)).resolves.not.toThrow();

packages/amplify-codegen-e2e-tests/src/codegen-tests-base/datastore-modelgen.ts

@@ -1,23 +1,24 @@
 import {
     initProjectWithProfile,
     addApiWithBlankSchemaAndConflictDetection,
-    generateModels,
-    AmplifyFrontendConfig,
+    updateApiSchema,
     createRandomName,
-    updateApiSchema
+    generateModels,
+    AmplifyFrontendConfig
 } from "amplify-codegen-e2e-core";
 import { existsSync } from "fs";
 import path from 'path';
 import { isNotEmptyDir, generateSourceCode } from '../utils';
 
 export async function testCodegenModels(config: AmplifyFrontendConfig, projectRoot: string, schema: string) {
+    const name = createRandomName();
+
     // init project and add API category
-    await initProjectWithProfile(projectRoot, { ...config });
+    await initProjectWithProfile(projectRoot, { name, ...config });
 
     //enable datastore
-    const projectName = createRandomName();
     await addApiWithBlankSchemaAndConflictDetection(projectRoot);
-    await updateApiSchema(projectRoot, projectName, schema);
+    await updateApiSchema(projectRoot, name, schema);
 
     //generate pre existing user file
     const userSourceCodePath = generateSourceCode(projectRoot, config.srcDir);

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

@@ -5,8 +5,8 @@ import {
     createRandomName,
     amplifyPushWithCodegenAdd,
     AmplifyFrontendConfig,
-    apiUpdateToggleDataStore,
-    amplifyPushWithCodegenUpdate
+    amplifyPushWithCodegenUpdate,
+    updateAPIWithResolutionStrategyWithModels
 } from "amplify-codegen-e2e-core";
 import { existsSync } from "fs";
 import path from 'path';
@@ -32,7 +32,7 @@ export async function testPushCodegen(config: AmplifyFrontendConfig, projectRoot
     expect(isNotEmptyDir(path.join(projectRoot, config.graphqlCodegenDir))).toBe(true);
 
     //enable datastore
-    await apiUpdateToggleDataStore(projectRoot);
+    await updateAPIWithResolutionStrategyWithModels(projectRoot, {});
     //push with codegen update
     await amplifyPushWithCodegenUpdate(projectRoot);
     expect(existsSync(userSourceCodePath)).toBe(true);

packages/amplify-codegen-e2e-tests/src/schema-api-directives/tests/key-howTo4.ts

@@ -1,5 +1,5 @@
 import _ from 'lodash';
-import { addApiWithSchemaAndConflictDetection, amplifyPush } from 'amplify-codegen-e2e-core';
+import { addApiWithBlankSchemaAndConflictDetection, updateApiSchema, amplifyPush } from 'amplify-codegen-e2e-core';
 import { getApiKey, configureAmplify, getConfiguredAppsyncClientAPIKeyAuth } from '../authHelper';
 import { testQueries, testMutations } from '../common';
 
@@ -269,8 +269,9 @@ export const expected_result_query5 = {
   },
 };
 
-export async function runTest(projectDir: string, testModule: any) {
-  await addApiWithSchemaAndConflictDetection(projectDir, testModule.schemaName);
+export async function runTest(projectDir: string, testModule: any, appName: string) {
+  await addApiWithBlankSchemaAndConflictDetection(projectDir);
+  await updateApiSchema(projectDir, appName, testModule.schemaName);
   await amplifyPush(projectDir);
 
   const awsconfig = configureAmplify(projectDir);