fix(integ-tests): add integ tests for the toolkit library

Signed-off-by: github-actions <github-actions@github.com>

Author: rix0rrr

.github/workflows/integ.yml

@@ -1569,6 +1569,7 @@ const cliInteg = configureProject(
     ],
     devDeps: [
       yarnCling,
+      toolkitLib,
       '@types/semver@^7',
       '@types/yargs@^16',
       '@types/fs-extra@^9',
@@ -1604,6 +1605,8 @@ const cliInteg = configureProject(
 );
 cliInteg.eslint?.addIgnorePattern('resources/**/*.ts');
 
+cliInteg.deps.addDependency('@aws-cdk/toolkit-lib', pj.DependencyType.OPTIONAL);
+
 const compiledDirs = ['tests', 'test', 'lib'];
 for (const compiledDir of compiledDirs) {
   cliInteg.gitignore.addPatterns(`${compiledDir}/**/*.js`);

.projenrc.ts

@@ -45,11 +45,12 @@ inject these dependencies into tests. Users can specify component versions, but
 Test Authors are responsible for taking these parameters and using it to set up
 the right environment for the tests.
 
-| Component             | Command-line argument                | Default     | Treatment by runner        | Treatment in test                         |
-|-----------------------|--------------------------------------|-------------|----------------------------|-------------------------------------------|
-| CDK Construct Library | `--framework-version=VERSION`        | Latest      | Nothing                    | `npm install` into temporary project dir. |
-| CDK CLI               | `--cli-version=VERSION`              | Auto source | `npm install` into tempdir | Add to `$PATH`.                           |
+| Component             | Command-line argument                | Default     | Treatment by runner        | Treatment in test                             |
+|-----------------------|--------------------------------------|-------------|----------------------------|-----------------------------------------------|
+| CDK Construct Library | `--framework-version=VERSION`        | Latest      | Nothing                    | `npm install` into temporary project dir.     |
+| CDK CLI               | `--cli-version=VERSION`              | Auto source | `npm install` into tempdir | Add to `$PATH`.                               |
 |                       | `--cli-source=ROOT` or `auto`        | Auto source |                            | Add `<ROOT>/packages/aws-cdk/bin` to `$PATH`. |
+| Toolkit Library       | `--toolkit-lib-version=VERSION`      | Devdep      | Install into its own deps  | Nothing
 
 ### Running a test suite
 

packages/@aws-cdk-testing/cli-integ/.projen/deps.json

@@ -34,6 +34,11 @@ async function main() {
         alias: 'f',
         type: 'string',
       })
+      .options('toolkit-lib-version', {
+        describe: 'Toolkit lib version to use',
+        alias: 'l',
+        type: 'string',
+      })
       .option('use-source', {
         descripton: 'Use TypeScript packages from the given source repository (or "auto")',
         type: 'string',
@@ -153,6 +158,8 @@ async function main() {
       library,
     });
 
+    const jestConfig = path.resolve(__dirname, '..', '..', 'resources', 'integ.jest.config.js');
+
     await jest.run([
       '--randomize',
       ...args.runInBand ? ['-i'] : [],
@@ -161,7 +168,7 @@ async function main() {
       ...args.maxWorkers ? [`--maxWorkers=${args.maxWorkers}`] : [],
       ...passWithNoTests ? ['--passWithNoTests'] : [],
       ...args['test-file'] ? [args['test-file']] : [],
-    ], path.resolve(__dirname, '..', '..', 'resources', 'integ.jest.config.js'));
+    ], jestConfig);
   } finally {
     for (const disp of disposables) {
       await disp.dispose();

packages/@aws-cdk-testing/cli-integ/.projen/tasks.json

@@ -24,6 +24,15 @@ export async function npmMostRecentMatching(packageName: string, range: string)
   return output[output.length - 1];
 }
 
+export async function npmQueryInstalledVersion(packageName: string, dir: string) {
+  const reportStr = await shell(['node', require.resolve('npm'), 'list', '--json', '--depth', '0', packageName], {
+    cwd: dir,
+    show: 'error',
+  });
+  const report = JSON.parse(reportStr);
+  return report.dependencies[packageName].version;
+}
+
 /**
  * Use NPM preinstalled on the machine to look up a list of TypeScript versions
  */

packages/@aws-cdk-testing/cli-integ/README.md

@@ -2,6 +2,7 @@ import * as os from 'os';
 import * as path from 'path';
 import * as fs from 'fs-extra';
 import type { IRunnerSource, ITestCliSource, IPreparedRunnerSource } from './source';
+import { npmQueryInstalledVersion } from '../npm';
 import { addToShellPath, rimraf, shell } from '../shell';
 
 export class RunnerCliNpmSource implements IRunnerSource<ITestCliSource> {
@@ -18,13 +19,7 @@ export class RunnerCliNpmSource implements IRunnerSource<ITestCliSource> {
     await shell(['node', require.resolve('npm'), 'install', `aws-cdk@${this.range}`], {
       cwd: tempDir,
     });
-
-    const reportStr = await shell(['node', require.resolve('npm'), 'list', '--json', '--depth', '0', 'aws-cdk'], {
-      cwd: tempDir,
-      show: 'error',
-    });
-    const report = JSON.parse(reportStr);
-    const installedVersion = report.dependencies['aws-cdk'].version;
+    const installedVersion = await npmQueryInstalledVersion('aws-cdk', tempDir);
 
     return {
       version: installedVersion,

packages/@aws-cdk-testing/cli-integ/lib/cli/run-suite.ts

@@ -10,23 +10,25 @@ import { addToShellPath } from '../shell';
  */
 export class RunnerCliRepoSource implements IRunnerSource<ITestCliSource> {
   public readonly sourceDescription: string;
-  private readonly cliPath: string;
+  private readonly cliBinPath: string;
 
   constructor(private readonly repoRoot: string) {
-    this.cliPath = path.join(this.repoRoot, 'packages', 'aws-cdk', 'bin');
-    this.sourceDescription = this.cliPath;
+    this.cliBinPath = path.join(this.repoRoot, 'packages', 'aws-cdk', 'bin');
+    this.sourceDescription = this.cliBinPath;
   }
 
   public async runnerPrepare(): Promise<IPreparedRunnerSource<ITestCliSource>> {
     if (!await fs.pathExists(path.join(this.repoRoot, 'package.json')) || !await fs.pathExists(path.join(this.repoRoot, 'yarn.lock'))) {
       throw new Error(`${this.repoRoot}: does not look like the repository root`);
     }
 
+    const pj = JSON.parse(await fs.readFile(path.join(this.cliBinPath, '..', 'package.json'), 'utf-8'));
+
     return {
-      version: '*',
+      version: pj.version,
       dispose: () => Promise.resolve(),
       serialize: () => {
-        return [TestCliRepoSource, [this.cliPath]];
+        return [TestCliRepoSource, [this.cliBinPath]];
       },
     };
   }

packages/@aws-cdk-testing/cli-integ/lib/npm.ts

@@ -5,9 +5,9 @@ import { findUp } from '../files';
  * Find the root directory of the repo from the current directory
  */
 export async function autoFindRoot() {
-  const found = findUp('release.json');
+  const found = findUp('yarn.lock');
   if (!found) {
-    throw new Error(`Could not determine repository root: 'release.json' not found from ${process.cwd()}`);
+    throw new Error(`Could not determine repository root: 'yarn.lock' not found from ${process.cwd()}`);
   }
   return path.dirname(found);
 }