chore: dx improvement for code build (#664)

* chore: dx improvement

* fix script

* fix spec

Author: AaronZyLee

.codebuild/cleanup_e2e_resources.yml

@@ -8,4 +8,8 @@ env:
 phases:
   build:
     commands:
-      - source ./shared-scripts.sh && _cleanupE2EResources
+      - source ./shared-scripts.sh && _cleanupE2EResources
+artifacts:
+  files:
+    - '**/*'
+  base-directory: $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports

.codebuild/cleanup_workflow.yml

@@ -9,4 +9,8 @@ phases:
   build:
     commands:
       - yarn production-build
-      - cd packages/amplify-codegen-e2e-tests && yarn clean-e2e-resources
+      - cd packages/amplify-codegen-e2e-tests && yarn clean-e2e-resources
+artifacts:
+  files:
+    - '**/*'
+  base-directory: $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports

.codebuild/run_android_modelgen_e2e_test.yml

@@ -25,10 +25,11 @@ phases:
       - source ./shared-scripts.sh && _runE2ETestsLinux
   post_build:
     commands:
+      - source ./shared-scripts.sh && _unassumeTestAccountCredentials
       - aws sts get-caller-identity
       - source ./shared-scripts.sh && _scanArtifacts
 
 artifacts:
   files:
-    - $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports/*
-  discard-paths: yes
+    - '**/*'
+  base-directory: $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports

.codebuild/run_e2e_tests.yml

@@ -16,10 +16,11 @@ phases:
       - source ./shared-scripts.sh && _runE2ETestsLinux
   post_build:
     commands:
+      - source ./shared-scripts.sh && _unassumeTestAccountCredentials
       - aws sts get-caller-identity
       - source ./shared-scripts.sh && _scanArtifacts
 
 artifacts:
   files:
-    - $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports/*
-  discard-paths: yes
+    - '**/*'
+  base-directory: $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports

.codebuild/run_ios_modelgen_e2e_test.yml

@@ -28,5 +28,5 @@ phases:
 
 artifacts:
   files:
-    - $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports/*
-  discard-paths: yes
+    - '**/*'
+  base-directory: $CODEBUILD_SRC_DIR/packages/amplify-codegen-e2e-tests/amplify-e2e-reports

packages/amplify-codegen-e2e-core/src/nexpect-reporter.js

@@ -60,8 +60,10 @@ class AmplifyCLIExecutionReporter {
 
   onRunComplete(contexts, results) {
     const { publicPath = process.cwd(), filename = 'jest_html_reporters.html', logoImgPath } = this._options;
+    const runIdx = process.env['RUN_INDEX'] ?? '0';
     const logoImg = logoImgPath ? imgToBase64(logoImgPath) : undefined;
-    fs.ensureDirSync(publicPath);
+    const reportPath = path.join(publicPath, runIdx);
+    fs.ensureDirSync(reportPath);
 
     const processedResults = results.testResults.map(result => {
       const resultCopy = { ...result };
@@ -73,7 +75,7 @@ class AmplifyCLIExecutionReporter {
 
           const recordingWithPath = recordings.map(r => {
             const castFile = `${uuid.v4()}.cast`;
-            const castFilePath = path.join(publicPath, castFile);
+            const castFilePath = path.join(reportPath, castFile);
             fs.writeFileSync(castFilePath, r.recording);
             const rCopy = { ...r };
             delete rCopy.recording;
@@ -98,7 +100,7 @@ class AmplifyCLIExecutionReporter {
     resultsWithRecordings._reporterOptions = { ...this._options, logoImg, customInfos: {} };
     const data = JSON.stringify(resultsWithRecordings);
 
-    const filePath = path.resolve(publicPath, filename);
+    const filePath = path.resolve(reportPath, filename);
     // const filePathMock = path.resolve(publicPath, `devMock.json`);
     // fs.writeFileSync(filePathMock, data);
     const htmlTemplate = fs.readFileSync(localTemplatePath, 'utf-8');

packages/amplify-codegen-e2e-tests/src/cleanup-e2e-resources.ts

@@ -20,7 +20,7 @@ const AWS_REGIONS_TO_RUN_TESTS = [
   'ap-southeast-2',
 ];
 
-const reportPath = path.normalize(path.join(__dirname, '..', 'amplify-e2e-reports', 'stale-resources.json'));
+const reportPathDir = path.normalize(path.join(__dirname, '..', 'amplify-e2e-reports'));
 
 const MULTI_JOB_APP = '<Amplify App reused by multiple apps>';
 const ORPHAN = '<orphan>';
@@ -546,7 +546,8 @@ const deleteCfnStack = async (account: AWSAccountInfo, accountIndex: number, sta
   }
 };
 
-const generateReport = (jobs: _.Dictionary<ReportEntry>): void => {
+const generateReport = (jobs: _.Dictionary<ReportEntry>, accountIdx: number): void => {
+  const reportPath = path.join(reportPathDir, `stale-resources-${accountIdx}.json`);
   fs.ensureFileSync(reportPath);
   fs.writeFileSync(reportPath, JSON.stringify(jobs, null, 4));
 };
@@ -688,7 +689,7 @@ const cleanupAccount = async (account: AWSAccountInfo, accountIndex: number, fil
   const allResources = await mergeResourcesByCCIJob(apps, stacks, buckets, orphanBuckets, orphanIamRoles);
   const staleResources = _.pickBy(allResources, filterPredicate);
 
-  generateReport(staleResources);
+  generateReport(staleResources, accountIndex);
   await deleteResources(account, accountIndex, staleResources);
   console.log(`${generateAccountInfo(account, accountIndex)} Cleanup done!`);
 };

scripts/view-test-artifacts.sh

@@ -2,24 +2,43 @@
 
 source ./scripts/cloud-utils.sh
 
+# Function to convert S3 ARN to S3 URI
+function convertArnToUri {
+  local arn="$1"
+
+  # Remove "arn:aws:s3:::" from the beginning of the ARN
+  local stripped_arn="${arn#arn:aws:s3:::}"
+
+  # Extract the bucket name and object key
+  local bucket_name="${stripped_arn%%/*}"
+  local object_key="${stripped_arn#*/}"
+
+  # Create the S3 URI
+  local s3_uri="s3://$bucket_name/$object_key"
+
+  echo "$s3_uri"
+}
+
 function downloadS3Artifact {
   # Get temporary access for the account
   E2E_ROLE_NAME=CodebuildDeveloper
   E2E_PROFILE_NAME=AmplifyAPIE2EProd
   authenticate $E2E_ACCOUNT_PROD $E2E_ROLE_NAME "$E2E_PROFILE_NAME"
 
-  local s3_object_uri=$1
-  local destination_dir=$2
+  echo "Fetching artifact location from build"
+  s3_arn=$(aws codebuild batch-get-builds --profile="$E2E_PROFILE_NAME" --ids "$1" --region us-east-1 --query 'builds[0].artifacts.location')
+  # Have to remove double quote for arn
+  s3_object_uri=$(convertArnToUri ${s3_arn//\"/})
 
   echo "Downloading objects from S3 bucket..."
-  aws s3 cp "$s3_object_uri" "$destination_dir" --recursive --profile="$E2E_PROFILE_NAME"
-  echo "Download complete. Files are saved in: $destination_dir"
+  aws s3 cp $s3_object_uri $2 --recursive --profile="$E2E_PROFILE_NAME"
+  echo "Download complete. Files are saved in: $2"
 }
 
 function playTestArtifact {
   # Check if an S3 object URI is provided
   if [ $# -eq 0 ]; then
-    echo "Provide the S3 URI of the artifact: $0 <s3_object_uri>"
+    echo "Provide the code build id: $0 <code_build_id>"
     exit 1
   fi
 
@@ -29,7 +48,7 @@ function playTestArtifact {
   trap "cleanup $temp_dir" SIGINT SIGTERM # Register cleanup function to handle Ctrl+C
 
   echo "Starting test artifact playback..."
-  downloadS3Artifact "$s3_object_uri" "$temp_dir"
+  downloadS3Artifact "$code_build_id" "$temp_dir"
 
 
   local subfolders=("$temp_dir"/*/)

scripts/view-test-artifacts.ts

@@ -111,7 +111,8 @@ const downloadSingleTestArtifact = async (tempDir: string, artifact: Required<Te
 
   return Promise.all(
     listObjectsResponse.Contents.filter(hasKey).map(({ Key }) => {
-      const filePath = path.join(artifactDownloadPath, Key.split('/').pop()!);
+      const filePath = path.join(artifactDownloadPath, Key.split('/').slice(3).join('/'));
+      fs.ensureDirSync(path.dirname(filePath));
       return new Promise((resolve, reject) => {
         const writer = fs.createWriteStream(filePath);
         s3.getObject({ Bucket, Key }).createReadStream().pipe(writer);

shared-scripts.sh

@@ -205,7 +205,14 @@ function _cleanupE2EResources {
   echo "Running clean up script"
   build_batch_arn=$(aws codebuild batch-get-builds --ids $CODEBUILD_BUILD_ID | jq -r -c '.builds[0].buildBatchArn')
   echo "Cleanup resources for batch build $build_batch_arn"
-  yarn clean-e2e-resources --buildBatchArn $build_batch_arn
+  yarn clean-e2e-resources buildBatchArn $build_batch_arn
+}
+
+function _unassumeTestAccountCredentials {
+    echo "Unassume Role"
+    unset AWS_ACCESS_KEY_ID
+    unset AWS_SECRET_ACCESS_KEY
+    unset AWS_SESSION_TOKEN
 }
 
 # The following functions are forked from circleci local publish helper
@@ -243,29 +250,29 @@ function retry {
     MAX_ATTEMPTS=2
     SLEEP_DURATION=5
     FIRST_RUN=true
-    n=0
+    RUN_INDEX=0
     FAILED_TEST_REGEX_FILE="./amplify-e2e-reports/amplify-e2e-failed-test.txt"
     if [ -f  $FAILED_TEST_REGEX_FILE ]; then
         rm -f $FAILED_TEST_REGEX_FILE
     fi
-    until [ $n -ge $MAX_ATTEMPTS ]
+    until [ $RUN_INDEX -ge $MAX_ATTEMPTS ]
     do
         echo "Attempting $@ with max retries $MAX_ATTEMPTS"
         setAwsAccountCredentials
-        "$@" && break
-        n=$[$n+1]
+        RUN_INDEX="$RUN_INDEX" "$@" && break
+        RUN_INDEX=$[$RUN_INDEX+1]
         FIRST_RUN=false
-        echo "Attempt $n completed."
+        echo "Attempt $RUN_INDEX completed."
         sleep $SLEEP_DURATION
     done
-    if [ $n -ge $MAX_ATTEMPTS ]; then
+    if [ $RUN_INDEX -ge $MAX_ATTEMPTS ]; then
         echo "failed: ${@}" >&2
         exit 1
     fi
 
     resetAwsAccountCredentials
     TEST_SUITE=${TEST_SUITE:-"TestSuiteNotSet"}
-    echo "Attempt $n succeeded."
+    echo "Attempt $RUN_INDEX succeeded."
     exit 0 # don't fail the step if putting the metric fails
 }