@aws-cdk-testing/cli-integ 3.5.0 → 3.6.0

package/lib/shell.ts

@@ -1,331 +0,0 @@
-import * as child_process from 'child_process';
-import * as fs from 'fs';
-import * as os from 'os';
-import * as path from 'path';
-import { TestContext } from './integ-test';
-import { Process } from './process';
-import { TemporaryDirectoryContext } from './with-temporary-directory';
-
-/**
- * A shell command that does what you want
- *
- * Is platform-aware, handles errors nicely.
- */
-export async function shell(command: string[], options: ShellOptions = {}): Promise<string> {
-  if (options.modEnv && options.env) {
-    throw new Error('Use either env or modEnv but not both');
-  }
-
-  const outputs = new Set(options.outputs);
-  const writeToOutputs = (x: string) => {
-    for (const outputStream of outputs) {
-      outputStream.write(x);
-    }
-  };
-
-  // Always output the command
-  writeToOutputs(`💻 ${command.join(' ')}\n`);
-  const show = options.show ?? 'always';
-
-  const env = options.env ?? (options.modEnv ? { ...process.env, ...options.modEnv } : process.env);
-  const tty = options.interact && options.interact.length > 0;
-
-  // Coerce to `any` because `ShellOptions` contains custom properties
-  // that don't exist in the underlying interfaces. We could either rebuild each options map,
-  // or just pass through and let the underlying implemenation ignore what it doesn't know about.
-  // We choose the lazy one.
-  const spawnOptions = { ...options, env } as any;
-
-  const child = tty
-    ? Process.spawnTTY(command[0], command.slice(1), spawnOptions)
-    : Process.spawn(command[0], command.slice(1), spawnOptions)
-
-  // copy because we will be shifting it
-  const remainingInteractions = [...(options.interact ?? [])];
-
-  return new Promise<string>((resolve, reject) => {
-    const stdout = new Array<Buffer>();
-    const stderr = new Array<Buffer>();
-
-    const lastLine = new LastLine();
-
-    child.onStdout(chunk => {
-      if (show === 'always') {
-        writeToOutputs(chunk.toString('utf-8'));
-      }
-      stdout.push(chunk);
-      lastLine.append(chunk.toString('utf-8'));
-
-      const interaction = remainingInteractions[0];
-      if (interaction) {
-
-        if (interaction.prompt.test(lastLine.get())) {
-
-          // subprocess expects a user input now.
-          // first, shift the interactions to ensure the same interaction is not reused
-          remainingInteractions.shift();
-
-          // then, reset the last line to prevent repeated matches caused by tty echoing
-          lastLine.reset();
-
-          // now write the input with a slight delay to ensure
-          // the child process has already started reading.
-          setTimeout(() => {
-            child.writeStdin(interaction.input + (interaction.end ?? os.EOL));
-          }, 500);
-        }
-
-      }
-
-    });
-
-    if (tty && options.captureStderr === false) {
-      // in a tty stderr goes to the same fd as stdout
-      throw new Error(`Cannot disable 'captureStderr' in tty`);
-    }
-
-    if (!tty) {
-      // in a tty stderr goes to the same fd as stdout, so onStdout
-      // is sufficient.
-      child.onStderr(chunk => {
-        if (show === 'always') {
-          writeToOutputs(chunk.toString('utf-8'));
-        }
-        if (options.captureStderr ?? true) {
-          stderr.push(chunk);
-        }
-      });
-    }
-
-    child.onError(reject);
-
-    child.onExit(code => {
-      const stderrOutput = Buffer.concat(stderr).toString('utf-8');
-      const stdoutOutput = Buffer.concat(stdout).toString('utf-8');
-      const out = (options.onlyStderr ? stderrOutput : stdoutOutput + stderrOutput).trim();
-
-      const logAndreject = (error: Error) => {
-        if (show === 'error') {
-          writeToOutputs(`${out}\n`);
-        }
-        reject(error);
-      }
-
-      if (remainingInteractions.length !== 0) {
-        // regardless of the exit code, if we didn't consume all expected interactions we probably
-        // did somethiing wrong.
-        logAndreject(new Error(`Expected more user interactions but subprocess exited with ${code}`));
-        return;
-      }
-
-      if (code === 0 || options.allowErrExit) {
-        resolve(out);
-      } else {
-        logAndreject(new Error(`'${command.join(' ')}' exited with error code ${code}.`));
-      }
-    });
-  });
-}
-
-/**
- * Models a single user interaction with the shell.
- */
-export interface UserInteraction {
-  /**
-   * The prompt to expect. Regex matched against the last line in
-   * the output before the prompt is displayed.
-   *
-   * Most commonly this would be a simple string to match for inclusion.
-   *
-   * Examples:
-   *
-   * - Process Output: "Hey there! Are you sure?"
-   *   Prompt: /Are you sure?/
-   *   Match (Yes/No): Yes
-   *   Reason: "Hey there! Are you sure?" ~ /Are you sure?/
-   *
-   * - Process Output: "Hey there!\nAre you sure?"
-   *   Prompt: /Are you sure?/
-   *   Match (Yes/No): Yes
-   *   Reason: "Are you sure?" ~ /Are you sure?/
-   *
-   * - Process Output: "Are you sure?\n(remember this is destructive)"
-   *   Prompt: /Are you sure?/
-   *   Match (Yes/No): No
-   *   Reason: "(remember this is destructive)" ≄ /Are you sure?/
-   *
-   * - Process Output: "Are you sure?\n(remember this is destructive)"
-   *   Prompt: /remember this is destructive/
-   *   Match (Yes/No): Yes
-   *   Reason: "(remember this is destructive)" ~ /remember this is destructive/
-   *
-   */
-  readonly prompt: RegExp;
-  /**
-   * The input to provide.
-   */
-  readonly input: string;
-
-  /**
-   * The string to signal the end of input.
-   *
-   * @default os.EOL
-   */
-  readonly end?: string;
-}
-
-export interface ShellOptions extends child_process.SpawnOptions {
-  /**
-   * Properties to add to 'env'
-   */
-  readonly modEnv?: Record<string, string | undefined>;
-
-  /**
-   * Don't fail when exiting with an error
-   *
-   * @default false
-   */
-  readonly allowErrExit?: boolean;
-
-  /**
-   * Whether to capture stderr
-   *
-   * @default true
-   */
-  readonly captureStderr?: boolean;
-
-  /**
-   * Pass output here
-   */
-  readonly outputs?: NodeJS.WritableStream[];
-
-  /**
-   * Only return stderr. For example, this is used to validate
-   * that when CI=true, all logs are sent to stdout.
-   *
-   * @default false
-   */
-  readonly onlyStderr?: boolean;
-
-  /**
-   * Don't log to stdout
-   *
-   * @default always
-   */
-  readonly show?: 'always' | 'never' | 'error';
-
-  /**
-   * Provide user interaction to respond to shell prompts.
-   *
-   * Order and count should correspond to the expected prompts issued by the subprocess.
-   */
-  readonly interact?: UserInteraction[];
-
-}
-
-export class ShellHelper {
-  public static fromContext(context: TestContext & TemporaryDirectoryContext) {
-    return new ShellHelper(context.integTestDir, context.output);
-  }
-
-  constructor(
-    private readonly _cwd: string,
-    private readonly _output: NodeJS.WritableStream) { }
-
-  public async shell(command: string[], options: Omit<ShellOptions, 'cwd' | 'outputs'> = {}): Promise<string> {
-    return shell(command, {
-      outputs: [this._output],
-      cwd: this._cwd,
-      ...options,
-      modEnv: {
-        // give every shell its own docker config directory
-        // so that parallel runs don't interfere with each other.
-        DOCKER_CONFIG: path.join(this._cwd, '.docker'),
-        ...options.modEnv,
-      },
-    });
-  }
-}
-
-/**
- * rm -rf reimplementation, don't want to depend on an NPM package for this
- *
- * Returns `true` if everything got deleted, or `false` if some files could
- * not be deleted due to permissions issues.
- */
-export function rimraf(fsPath: string): boolean {
-  try {
-    let success = true;
-    const isDir = fs.lstatSync(fsPath).isDirectory();
-
-    if (isDir) {
-      for (const file of fs.readdirSync(fsPath)) {
-        success &&= rimraf(path.join(fsPath, file));
-      }
-      fs.rmdirSync(fsPath);
-    } else {
-      fs.unlinkSync(fsPath);
-    }
-    return success;
-  } catch (e: any) {
-    // Can happen if some files got generated inside a Docker container and are now inadvertently owned by `root`.
-    // We can't ever clean those up anymore, but since it only happens inside GitHub Actions containers we also don't care too much.
-    if (e.code === 'EACCES' || e.code === 'ENOTEMPTY') { return false; }
-
-    // Already gone
-    if (e.code === 'ENOENT') { return true; }
-
-    throw e;
-  }
-}
-
-export function addToShellPath(x: string) {
-  const parts = process.env.PATH?.split(':') ?? [];
-
-  if (!parts.includes(x)) {
-    parts.unshift(x);
-  }
-
-  process.env.PATH = parts.join(':');
-}
-
-/**
- * Accumulate text since the last line break (or beginning of string) it has seen in the chunks.
- *
- * Examples:
- *
- * - Chunks: ['one\n', 'two\n', three']
- * - Last Line: 'three'
- *
- * - Chunks: ['one', 'two', '\nthree']
- * - Last Line: 'three'
- *
- * - Chunks: ['one', 'two']
- * - Last Line: 'onetwo'
- *
- * - Chunks: ['one', 'two', '\nthree', 'four']
- * - Last Line: 'threefour'
- */
-class LastLine {
-
-  private lastLine: string = '';
-
-  public append(chunk: string): void {
-    const lines = chunk.split(os.EOL);
-    if (lines.length === 1) {
-      // chunk doesn't contain a new line so just append
-      this.lastLine += lines[0];
-    } else {
-      // chunk contains multiple lines so just override with the last one
-      this.lastLine = lines[lines.length - 1];
-    }
-  }
-
-  public get(): string {
-    return this.lastLine;
-  }
-
-  public reset() {
-    this.lastLine = '';
-  }
-}

package/lib/staging/codeartifact.ts

@@ -1,387 +0,0 @@
-import {
-  AssociateExternalConnectionCommand,
-  CodeartifactClient,
-  CreateDomainCommand,
-  CreateRepositoryCommand,
-  DeleteRepositoryCommand,
-  DescribeDomainCommand,
-  DescribeRepositoryCommand,
-  GetAuthorizationTokenCommand,
-  GetRepositoryEndpointCommand,
-  ListPackagesCommand,
-  ListPackagesRequest,
-  ListRepositoriesCommand,
-  ListTagsForResourceCommand,
-  PutPackageOriginConfigurationCommand,
-} from '@aws-sdk/client-codeartifact';
-import { sleep } from '../aws';
-
-const COLLECT_BY_TAG = 'collect-by';
-const REPO_LIFETIME_MS = 24 * 3600 * 1000; // One day
-
-export class TestRepository {
-  public static readonly DEFAULT_DOMAIN = 'test-cdk';
-
-  public static async newRandom() {
-    const qualifier = Math.random()
-      .toString(36)
-      .replace(/[^a-z0-9]+/g, '');
-
-    const repo = new TestRepository(`test-${qualifier}`);
-    await repo.prepare();
-    return repo;
-  }
-
-  public static async newWithName(name: string) {
-    const repo = new TestRepository(name);
-    await repo.prepare();
-    return repo;
-  }
-
-  public static existing(repositoryName: string) {
-    return new TestRepository(repositoryName);
-  }
-
-  /**
-   * Garbage collect repositories
-   */
-  public static async gc() {
-    if (!(await TestRepository.existing('*dummy*').domainExists())) {
-      return;
-    }
-
-    const codeArtifact = new CodeartifactClient();
-
-    let nextToken: string | undefined;
-    do {
-      const page = await codeArtifact.send(
-        new ListRepositoriesCommand({
-          nextToken: nextToken,
-        }),
-      );
-
-      for (const repo of page.repositories ?? []) {
-        const tags = await codeArtifact.send(
-          new ListTagsForResourceCommand({
-            resourceArn: repo.arn!,
-          }),
-        );
-        const collectable = tags?.tags?.find((t) => t.key === COLLECT_BY_TAG && Number(t.value) < Date.now());
-        if (collectable) {
-          // eslint-disable-next-line no-console
-          console.log('Deleting', repo.name);
-          await codeArtifact.send(
-            new DeleteRepositoryCommand({
-              domain: repo.domainName!,
-              repository: repo.name!,
-            }),
-          );
-        }
-      }
-
-      nextToken = page.nextToken;
-    } while (nextToken);
-  }
-
-  public readonly npmUpstream = 'npm-upstream';
-  public readonly pypiUpstream = 'pypi-upstream';
-  public readonly nugetUpstream = 'nuget-upstream';
-  public readonly mavenUpstream = 'maven-upstream';
-  public readonly domain = TestRepository.DEFAULT_DOMAIN;
-
-  private readonly codeArtifact = new CodeartifactClient();
-
-  private _loginInformation: LoginInformation | undefined;
-
-  private constructor(public readonly repositoryName: string) {}
-
-  public async prepare() {
-    await this.ensureDomain();
-    await this.ensureUpstreams();
-
-    await this.ensureRepository(this.repositoryName, {
-      description: 'Testing repository',
-      upstreams: [this.npmUpstream, this.pypiUpstream, this.nugetUpstream, this.mavenUpstream],
-      tags: {
-        [COLLECT_BY_TAG]: `${Date.now() + REPO_LIFETIME_MS}`,
-      },
-    });
-  }
-
-  public async loginInformation(): Promise<LoginInformation> {
-    if (this._loginInformation) {
-      return this._loginInformation;
-    }
-
-    this._loginInformation = {
-      authToken: (
-        await this.codeArtifact.send(
-          new GetAuthorizationTokenCommand({
-            domain: this.domain,
-            durationSeconds: 12 * 3600,
-          }),
-        )
-      ).authorizationToken!,
-      repositoryName: this.repositoryName,
-
-      npmEndpoint: (
-        await this.codeArtifact.send(
-          new GetRepositoryEndpointCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-            format: 'npm',
-          }),
-        )
-      ).repositoryEndpoint!,
-
-      mavenEndpoint: (
-        await this.codeArtifact.send(
-          new GetRepositoryEndpointCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-            format: 'maven',
-          }),
-        )
-      ).repositoryEndpoint!,
-
-      nugetEndpoint: (
-        await this.codeArtifact.send(
-          new GetRepositoryEndpointCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-            format: 'nuget',
-          }),
-        )
-      ).repositoryEndpoint!,
-
-      pypiEndpoint: (
-        await this.codeArtifact.send(
-          new GetRepositoryEndpointCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-            format: 'pypi',
-          }),
-        )
-      ).repositoryEndpoint!,
-    };
-    return this._loginInformation;
-  }
-
-  public async delete() {
-    try {
-      await this.codeArtifact.send(
-        new DeleteRepositoryCommand({
-          domain: this.domain,
-          repository: this.repositoryName,
-        }),
-      );
-
-      // eslint-disable-next-line no-console
-      console.log('Deleted', this.repositoryName);
-    } catch (e: any) {
-      if (e.name !== 'ResourceNotFoundException') {
-        throw e;
-      }
-      // Okay
-    }
-  }
-
-  /**
-   * List all packages and mark them as "allow upstream versions".
-   *
-   * If we don't do this and we publish `foo@2.3.4-rc.0`, then we can't
-   * download `foo@2.3.0` anymore because by default CodeArtifact will
-   * block different versions from the same package.
-   */
-  public async markAllUpstreamAllow() {
-    for await (const pkg of this.listPackages({ upstream: 'BLOCK' })) {
-      await retryThrottled(() =>
-        this.codeArtifact.send(
-          new PutPackageOriginConfigurationCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-
-            format: pkg.format!,
-            package: pkg.package!,
-            namespace: pkg.namespace!,
-            restrictions: {
-              publish: 'ALLOW',
-              upstream: 'ALLOW',
-            },
-          }),
-        ),
-      );
-    }
-  }
-
-  private async ensureDomain() {
-    if (await this.domainExists()) {
-      return;
-    }
-    await this.codeArtifact.send(
-      new CreateDomainCommand({
-        domain: this.domain,
-        tags: [{ key: 'testing', value: 'true' }],
-      }),
-    );
-  }
-
-  private async ensureUpstreams() {
-    await this.ensureRepository(this.npmUpstream, {
-      description: 'The upstream repository for NPM',
-      external: 'public:npmjs',
-    });
-    await this.ensureRepository(this.mavenUpstream, {
-      description: 'The upstream repository for Maven',
-      external: 'public:maven-central',
-    });
-    await this.ensureRepository(this.nugetUpstream, {
-      description: 'The upstream repository for NuGet',
-      external: 'public:nuget-org',
-    });
-    await this.ensureRepository(this.pypiUpstream, {
-      description: 'The upstream repository for PyPI',
-      external: 'public:pypi',
-    });
-  }
-
-  private async ensureRepository(
-    name: string,
-    options?: {
-      readonly description?: string;
-      readonly external?: string;
-      readonly upstreams?: string[];
-      readonly tags?: Record<string, string>;
-    },
-  ) {
-    if (await this.repositoryExists(name)) {
-      return;
-    }
-
-    await this.codeArtifact.send(
-      new CreateRepositoryCommand({
-        domain: this.domain,
-        repository: name,
-        description: options?.description,
-        upstreams: options?.upstreams?.map((repositoryName) => ({ repositoryName })),
-        tags: options?.tags ? Object.entries(options.tags).map(([key, value]) => ({ key, value })) : undefined,
-      }),
-    );
-
-    if (options?.external) {
-      const externalConnection = options.external;
-      await retry(() =>
-        this.codeArtifact.send(
-          new AssociateExternalConnectionCommand({
-            domain: this.domain,
-            repository: name,
-            externalConnection,
-          }),
-        ),
-      );
-    }
-  }
-
-  private async domainExists() {
-    try {
-      await this.codeArtifact.send(new DescribeDomainCommand({ domain: this.domain }));
-      return true;
-    } catch (e: any) {
-      if (e.name !== 'ResourceNotFoundException') {
-        throw e;
-      }
-      return false;
-    }
-  }
-
-  private async repositoryExists(name: string) {
-    try {
-      await this.codeArtifact.send(new DescribeRepositoryCommand({ domain: this.domain, repository: name }));
-      return true;
-    } catch (e: any) {
-      if (e.name !== 'ResourceNotFoundException') {
-        throw e;
-      }
-      return false;
-    }
-  }
-
-  private async *listPackages(filter: Pick<ListPackagesRequest, 'upstream' | 'publish' | 'format'> = {}) {
-    let response = await retryThrottled(() =>
-      this.codeArtifact.send(
-        new ListPackagesCommand({
-          domain: this.domain,
-          repository: this.repositoryName,
-          ...filter,
-        }),
-      ),
-    );
-
-    while (true) {
-      for (const p of response.packages ?? []) {
-        yield p;
-      }
-
-      if (!response.nextToken) {
-        break;
-      }
-
-      response = await retryThrottled(() =>
-        this.codeArtifact.send(
-          new ListPackagesCommand({
-            domain: this.domain,
-            repository: this.repositoryName,
-            ...filter,
-            nextToken: response.nextToken,
-          }),
-        ),
-      );
-    }
-  }
-}
-
-async function retry<A>(block: () => Promise<A>) {
-  let attempts = 3;
-  while (true) {
-    try {
-      return await block();
-    } catch (e: any) {
-      if (attempts-- === 0) {
-        throw e;
-      }
-      // eslint-disable-next-line no-console
-      console.debug(e.message);
-      await sleep(500);
-    }
-  }
-}
-
-async function retryThrottled<A>(block: () => Promise<A>) {
-  let time = 100;
-  let attempts = 15;
-  while (true) {
-    try {
-      return await block();
-    } catch (e: any) {
-      // eslint-disable-next-line no-console
-      console.debug(e.message);
-      if (e.name !== 'ThrottlingException') {
-        throw e;
-      }
-      if (attempts-- === 0) {
-        throw e;
-      }
-      await sleep(Math.floor(Math.random() * time));
-      time *= 2;
-    }
-  }
-}
-
-export interface LoginInformation {
-  readonly authToken: string;
-  readonly repositoryName: string;
-  readonly npmEndpoint: string;
-  readonly mavenEndpoint: string;
-  readonly nugetEndpoint: string;
-  readonly pypiEndpoint: string;
-}