fix(integ-runner): improve git directory handling for snapshot operations

Fixes issues with git operations by using the -C flag to specify the correct git repository directory. This ensures integ-runner works correctly when executed from outside the repository under test. Also standardizes the directory used for running CDK apps to always be the current working directory.

Author: mrgrain

packages/@aws-cdk/integ-runner/lib/runner/integ-test-runner.ts

@@ -11,7 +11,7 @@ import { IntegRunner } from './runner-base';
 import * as logger from '../logger';
 import { chunks, exec, promiseWithResolvers } from '../utils';
 import type { DestructiveChange, AssertionResults, AssertionResult } from '../workers/common';
-import { DiagnosticReason, formatAssertionResults } from '../workers/common';
+import { DiagnosticReason, formatAssertionResults, formatError } from '../workers/common';
 
 export interface CommonOptions {
   /**
@@ -114,15 +114,19 @@ export class IntegTestRunner extends IntegRunner {
    * all branches and we then search for one that starts with `HEAD branch: `
    */
   private checkoutSnapshot(): void {
-    const cwd = this.directory;
+    // We use the directory that contains the snapshot to run git commands in
+    // We don't change the cwd for executing git, but instead use the -C flag
+    // @see https://git-scm.com/docs/git#Documentation/git.txt--Cltpathgt
+    // This way we are guaranteed to operate under the correct git repo, even
+    // when executing integ-runner from outside the repo under test.
+    const gitCwd = path.dirname(this.snapshotDir);
+    const git = ['git', '-C', gitCwd];
 
     // https://git-scm.com/docs/git-merge-base
     let baseBranch: string | undefined = undefined;
     // try to find the base branch that the working branch was created from
     try {
-      const origin: string = exec(['git', 'remote', 'show', 'origin'], {
-        cwd,
-      });
+      const origin: string = exec([...git, 'remote', 'show', 'origin']);
       const originLines = origin.split('\n');
       for (const line of originLines) {
         if (line.trim().startsWith('HEAD branch: ')) {
@@ -141,22 +145,18 @@ export class IntegTestRunner extends IntegRunner {
     // if we found the base branch then get the merge-base (most recent common commit)
     // and checkout the snapshot using that commit
     if (baseBranch) {
-      const relativeSnapshotDir = path.relative(this.directory, this.snapshotDir);
+      const relativeSnapshotDir = path.relative(gitCwd, this.snapshotDir);
 
       try {
-        const base = exec(['git', 'merge-base', 'HEAD', baseBranch], {
-          cwd,
-        });
-        exec(['git', 'checkout', base, '--', relativeSnapshotDir], {
-          cwd,
-        });
+        const base = exec([...git, 'merge-base', 'HEAD', baseBranch]);
+        exec([...git, 'checkout', base, '--', relativeSnapshotDir]);
       } catch (e) {
         logger.warning('%s\n%s',
           `Could not checkout snapshot directory '${this.snapshotDir}'. Please verify the following command completes correctly:`,
-          `git checkout $(git merge-base HEAD ${baseBranch}) -- ${relativeSnapshotDir}`,
+          `git -C ${gitCwd} checkout $(git -C ${gitCwd} merge-base HEAD ${baseBranch}) -- ${relativeSnapshotDir}`,
           '',
         );
-        logger.warning('error: %s', e);
+        logger.warning('error: %s', formatError(e));
       }
     }
   }

packages/@aws-cdk/integ-runner/lib/runner/integration-tests.ts

@@ -106,22 +106,17 @@ export class IntegTest {
     this.appCommand = info.appCommand ?? 'node {filePath}';
     this.absoluteFileName = path.resolve(info.fileName);
     this.fileName = path.relative(process.cwd(), info.fileName);
-
-    const parsed = path.parse(this.fileName);
     this.discoveryRelativeFileName = path.relative(info.discoveryRoot, info.fileName);
-    // if `--watch` then we need the directory to be the cwd
-    this.directory = info.watch ? process.cwd() : parsed.dir;
 
-    // if we are running in a package directory then just use the fileName
-    // as the testname, but if we are running in a parent directory with
-    // multiple packages then use the directory/filename as the testname
-    //
-    // Looks either like `integ.mytest` or `package/test/integ.mytest`.
-    const relDiscoveryRoot = path.relative(process.cwd(), info.discoveryRoot);
-    this.testName = this.directory === path.join(relDiscoveryRoot, 'test') || this.directory === path.join(relDiscoveryRoot)
-      ? parsed.name
-      : path.join(path.relative(this.info.discoveryRoot, parsed.dir), parsed.name);
+    // for consistency, always run the CDK apps under test from the CWD
+    // this is especially important for languages that use the CWD to discover assets
+    // @see https://github.com/aws/aws-cdk-cli/issues/638
+    this.directory = process.cwd();
 
+    // We treat the discovery root as the base for test names
+    // Looks either like `integ.mytest` or `package/test/integ.mytest`.
+    const parsed = path.parse(this.fileName);
+    this.testName = path.join(path.relative(this.info.discoveryRoot, parsed.dir), parsed.name);
     this.normalizedTestName = parsed.name;
     this.snapshotDir = path.join(parsed.dir, `${parsed.base}.snapshot`);
     this.temporaryOutputDir = path.join(parsed.dir, `${CDK_OUTDIR_PREFIX}.${parsed.base}.snapshot`);