Merge pull request #597 from aws-amplify/fix-e2e-tests

chore: fix e2e tests related to flutter pubspec file

Author: phani-srikar

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

@@ -116,8 +116,7 @@ function initializeFrontend(chain: ExecutionContext, config: AmplifyFrontendConf
   switch (config.frontendType) {
     case AmplifyFrontend.android:
       chain
-        .send('j')
-        .sendCarriageReturn()
+        .sendLine('android')
         .wait('Where is your Res directory')
         .sendCarriageReturn()
       return;

packages/amplify-codegen-e2e-tests/package.json

@@ -34,7 +34,8 @@
     "graphql-tag": "^2.10.1",
     "lodash": "^4.17.19",
     "uuid": "^3.4.0",
-    "yargs": "^15.1.0"
+    "yargs": "^15.1.0",
+    "js-yaml": "^4.0.0"
   },
   "devDependencies": {
     "@types/jest": "^27.0.0",

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

@@ -17,12 +17,14 @@ import {
   getAdminApp,
   amplifyPullSandbox,
   getProjectSchema,
+  AmplifyFrontend,
 } from '@aws-amplify/amplify-codegen-e2e-core';
 import { existsSync } from 'fs';
 import path from 'path';
 import { isNotEmptyDir, generateSourceCode } from '../utils';
 import { JSONUtilities } from '@aws-amplify/amplify-cli-core';
 import { SandboxApp } from '../types/SandboxApp';
+import { createPubspecLockFile } from '../codegen-tests-base';
 
 const schema = 'simple_model.graphql';
 const envName = 'pulltest';
@@ -72,6 +74,10 @@ describe('Amplify pull in amplify app with codegen tests', () => {
       it(`should generate models and do not delete user files by amplify pull in an empty folder of ${config.frontendType} app`, async () => {
         //generate pre existing user file
         const userSourceCodePath = generateSourceCode(emptyProjectRoot, config.srcDir);
+        // Flutter projects need min dart version to be met for modelgen to succeed.
+        if (config?.frontendType === AmplifyFrontend.flutter) {
+          createPubspecLockFile(emptyProjectRoot);
+        };
         //amplify pull in a new project
         await amplifyPull(emptyProjectRoot, { emptyDir: true, appId, frontendConfig: config });
         expect(existsSync(userSourceCodePath)).toBe(true);
@@ -110,6 +116,10 @@ describe('Amplify pull in sandbox app with codegen tests', () => {
     it(`should pull sandbox, download schema and generate models without deleting user files in ${config.frontendType} project`, async () => {
       //generate pre existing user file
       const userSourceCodePath = generateSourceCode(projectRoot, config.srcDir);
+      // Flutter projects need min dart version to be met for modelgen to succeed.
+      if (config?.frontendType === AmplifyFrontend.flutter) {
+        createPubspecLockFile(projectRoot);
+      };
       //pull sandbox app
       await amplifyPullSandbox(projectRoot, {
         appType: config.frontendType,

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

@@ -4,11 +4,13 @@ import {
     updateApiSchema,
     createRandomName,
     generateModels,
-    AmplifyFrontendConfig
+    AmplifyFrontendConfig,
+    AmplifyFrontend
 } from '@aws-amplify/amplify-codegen-e2e-core';
-import { existsSync } from "fs";
+import { existsSync, writeFileSync } from "fs";
 import path from 'path';
 import { isNotEmptyDir, generateSourceCode } from '../utils';
+const yaml = require('js-yaml');
 
 export async function testCodegenModels(config: AmplifyFrontendConfig, projectRoot: string, schema: string, outputDir?: string) {
     const name = createRandomName();
@@ -23,14 +25,34 @@ export async function testCodegenModels(config: AmplifyFrontendConfig, projectRo
     //generate pre existing user file
     const userSourceCodePath = generateSourceCode(projectRoot, config.srcDir);
 
+    // For flutter frontend, we need to have a pubspec lock file with supported dart version
+    if (config?.frontendType === AmplifyFrontend.flutter) {
+        createPubspecLockFile(projectRoot);
+    }
+
     //generate models
     await expect(generateModels(projectRoot, outputDir)).resolves.not.toThrow();
 
     // pre-existing file should still exist
     expect(existsSync(userSourceCodePath)).toBe(true);
+
     // datastore models are generated at correct location
     const dirToCheck = outputDir
         ? path.join(projectRoot, outputDir)
         : path.join(projectRoot, config.modelgenDir);
     expect(isNotEmptyDir(dirToCheck)).toBe(true);
 }
+
+export const createPubspecLockFile = (projectRoot: string) => {
+    const lockFile = {
+        packages: {
+          amplify_flutter: {
+            version: '2.0.0'
+          },
+        },
+    };
+    const pubspecPath = path.join(projectRoot, 'pubspec.lock');
+    if (!existsSync(pubspecPath)) {
+        writeFileSync(pubspecPath, yaml.dump(lockFile));
+    }
+};