@aws-cdk-testing/cli-integ 0.0.0

package/.eslintrc.js

@@ -0,0 +1,9 @@
+var path = require('path');
+var fs = require('fs');
+var contents = fs.readFileSync(`${__dirname}/.eslintrc.json`, { encoding: 'utf-8' });
+// Strip comments, JSON.parse() doesn't like those
+contents = contents.replace(/^\/\/.*$/m, '');
+var json = JSON.parse(contents);
+// Patch the .json config with something that can only be represented in JS
+json.parserOptions.tsconfigRootDir = __dirname;
+module.exports = json;

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,16 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Third party attributions of this package can be found in the THIRD_PARTY_LICENSES file

package/README.md

@@ -0,0 +1,205 @@
+# CDK CLI integration test
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)
+
+---
+
+<!--END STABILITY BANNER-->
+
+This package contains CDK CLI integration test suites, as well as helper tools necessary to run those suites against various different distributions of the CDK (in the source repository, against a build directory, or against published releases).
+
+> The tools and tests themselves should arguably be in different packages, but I want to prevent package proliferation. For now we'll keep them together.
+
+## Tests
+
+The tests themselves are in the `tests/` directory:
+
+```text
+tests/
+├── cli-integ-tests
+├── init-csharp
+├── init-fsharp
+├── init-java
+├── init-javascript
+├── init-python
+├── init-typescript-app
+├── init-typescript-lib
+├── init-go
+└── uberpackage
+```
+
+Each subdirectory contains one test **suite**, and in the development pipeline each suite is run individually in a CodeBuild job, all in parallel. This requires manual configuration in the pipeline: to add a new suite, first add a suite here, then add the suite to the pipeline as well. The safest strategy is to add a trivially succeeding suite first (for example, a single test with `expect(true).toBeTruthy()`), add it to the pipeline, and then write the actual tests.
+
+Test suites are written as a collection of Jest tests, and they are run using Jest, using the code in the `lib/` directory as helpers.
+
+### Setup
+
+Building the @aws-cdk-testing package is not very different from building the rest of the CDK. However, If you are having issues with the tests, you can ensure your environment is built properly by following the steps below:
+
+```shell
+yarn install # Install dependencies
+npx lerna run build --scope=aws-cdk # Build the CDK cli
+yarn build # Build the @aws-cdk-testing/cli-integ package
+../../../scripts/align-version.sh # Align the versions of CDK packages
+```
+
+### Running tests with debugger
+
+```json
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "args": ["-a", "cli-integ-tests", "-t", "context in stage propagates to top"],
+      "name": "debug integ tests",
+      "program": "~/aws-cdk/packages/@aws-cdk-testing/cli-integ/bin/run-suite",
+      "console": "integratedTerminal",
+      "sourceMaps": true,
+      "skipFiles": [ "<node_internals>/**/*" ],
+      "stopOnEntry": false
+    }
+  ]
+}
+```
+
+1. Assuming you checked out the `aws-cdk` repository in your `~` directory, use the above `launch.json`.
+2. In the `"args"` value after `"-t"`, place the name of the test that you'd like to run.
+3. Press the VS code green arrow to launch the debugger.
+
+### Running a test suite
+
+You run a suite using the `bin/run-suite` tool. You must select either a version of the CLI and framework which can be `npm install`ed, or point to the root of the source tree:
+
+```shell
+# Use the given source tree
+$ bin/run-suite --use-source=/path/to/repo-root <SUITE_NAME>
+
+# Automatically determine the source tree root
+$ bin/run-suite -a <SUITE_NAME>
+
+# Run against a released version
+$ bin/run-suite --use-cli-release=2.34.5 <SUITE_NAME>
+```
+
+To run a specific test, add `-t` and a substring of the test name. For example:
+
+```shell
+bin/run-suite -a cli-integ-tests -t 'load old assemblies'
+```
+
+### Running a test suite against binaries
+
+Some test suites require package binaries stages in CodeArtifact repositories to run. This requires you to do a full build, then create a CodeArtifact repository in your own account, uploading the packages there, and then running the tests in a shell configured to have NPM, Pip, Maven etc look for those packages in CodeArtifact.
+
+```shell
+# Build and pack all of CDK (will take ~an hour)
+$ ./build.sh
+$ ./pack.sh
+
+# Use publib to upload to CodeArtifact
+$ npm install -g publib
+# publib-ca is a CLI tool that comes with publib
+$ publib-ca create
+$ publib-ca publish /path/to/dist
+
+# Run the tests against those repositories (may need to substitute 0.0.0 w/ local number)
+$ source ~/.publib-ca/usage/activate.bash
+$ bin/run-suite --use-cli-release=0.0.0 <SUITE_NAME>
+
+# Clean up
+$ publib-ca delete
+```
+
+## Tools
+
+There are a number of tools in the `bin/` directory. They are:
+
+```text
+bin/
+├── apply-patches
+├── query-github
+├── run-suite
+├── stage-distribution
+└── test-root
+```
+
+* `apply-patches`: used for regression testing. Applies patches to historical versions of the tests to fix false positive test failures.
+* `query-github`: used for regression testing. Queries GitHub for previously released versions.
+* `run-suite`: run one of the test suites in the `tests/` directory.
+* `stage-distribution`: used for testing in the pipeline. Uploads candidate release binaries to CodeArtifact so that they can be installed using `npm install`, `pip install`, etc.
+* `test-root`: return the directory containing all tests (used for applying patches).
+
+## Regression testing
+
+The regression testing mechanism is somewhat involved and therefore deserves its own section. The principle is not too hard to explain though:
+
+*We run the previous version of the CLI integ tests against the new candidate release of the CLI, to make sure we didn't accidentally introduce any breaking behavior*.
+
+This is slightly complicated by two facts:
+
+* (1) Both the CLI and the framework may have changed, and an incompatibility may have arisen between the framework and CLI. Newer CLIs must always support older framework versions. We therefore run two flavors of the integration tests:
+  * Old tests, new CLI, new framework
+  * Old tests, new CLI, old framework
+
+The testing matrix looks like this:
+
+```text
+                 OLD TESTS                             NEW TESTS
+
+                    CLI                                   CLI
+                Old    New                            Old    New
+            ┌────────┬────────┐                   ┌────────┬────────┐
+     F'WORK │  prev  │        │            F'WORK │        │        │
+        Old │  rls   │  regr  │               Old │ (N/A)  │   ?    │
+            │ integ  │        │                   │        │        │
+            ├────────┼────────┤                   ├────────┼────────┤
+            │        │        │                   │        │  cur   │
+        New │ (N/A)  │  regr  │               New │ (N/A)  │  rls   │
+            │        │        │                   │        │ integ  │
+            └────────┴────────┘                   └────────┴────────┘
+```
+
+We are covering everything except "new tests, new CLI, old framework", which is not clear that it even makes sense to test because some new features may rely on framework support which will not be in the old version yet.
+
+* (2) Sometimes, old tests will fail on newer releases when we introduce breaking changes to the framework or CLI for something serious (such as security reasons), or maybe because we had a bug in an old version that happened to pass, but now the test needs to be updated in order to pass a bugfix.
+
+For this case we have a patching mechanism, so that in a NEW release of the tools, we include files that are copied over an OLD release of the test, that allows them to pass. For the simplest case there is a mechanism to suppress the run of a single test, so that we can skip the running of one test for one release. For more complicated cases we copy in patched `.js` source files which will replace old source files. (Patches are considered part of the *tools*, not part of the *tests*).
+
+### Mechanism
+
+To run the tests in a regressory fashion, do the following:
+
+* Download the current `@aws-cdk-testing/cli-integ` artifact at `V1`.
+* Determine the previous version `V0` (use `query-github` for this).
+* Download the previous `@aws-cdk-testing/cli-integ` artifact at `V0`.
+* From the `V1` artifact, apply the `V0` patch set.
+* Run the `V0` tests with the `--framework-version` option:
+
+```shell
+# Old tests, new CLI, new framework
+V0/bin/run-suite --use-cli-release=V1 --framework-version=V1 [...]
+
+# Old tests, new CLI, old framework
+V0/bin/run-suite --use-cli-release=V1 --framework-version=V0 [...]
+```
+
+### Patching
+
+To patch a previous set of tests to make them pass with a new release, add a directory to `resources/cli-regression-patches`. The simplest method is to add a `skip-tests.txt` file:
+
+```shell
+# The version of the tests that are currently failing (V0 in the paragraph above)
+export VERSION=X.Y.Z
+
+mkdir -p resources/cli-regression-patches/v${VERSION}
+cp skip-tests.txt resources/cli-regression-patches/v${VERSION}/
+```
+
+Now edit `resources/cli-regression-patches/vX.Y.Z/skip-tests.txt` and put the name of the test you want to skip on a line by itself.
+
+If you need to replace source files, it's probably best to stick compiled `.js` files in here. `.ts` source files wouldn't compile because they'd be missing `imports`.

package/bin/apply-patches

@@ -0,0 +1,22 @@
+#!/bin/bash
+# Written in bash just because that's easier with all the file manipulation
+set -eu
+scriptdir=$(cd $(dirname $0) && pwd)
+version="$1"
+target_dir="$2"
+
+
+if [[ ! -f "$2/skip-tests.txt" ]]; then
+  echo "$2: does not look like a test root directory." >&2
+  exit 1
+fi
+
+
+candidate_dir="${scriptdir}/../resources/cli-regression-patches/v${version}"
+
+if [[ -d "$candidate_dir" ]]; then
+  echo "Found patch directory: ${candidate_dir}"
+  cp -vR "${candidate_dir}/"* "$2"
+else
+  echo "No patch directory named: ${candidate_dir}"
+fi

package/bin/download-and-run-old-tests

@@ -0,0 +1,52 @@
+#!/bin/bash
+set -eu
+# Download old tests and run them. Written in bash, just because. Needs to do contortions, see below.
+#
+# Usage:
+#
+#   download-and-run-old-tests <version> [...args to run-suite...]
+set -x
+
+scriptdir=$(cd $(dirname $0) && pwd)
+
+version="$1"
+target_directory="old_tests"
+shift
+
+rm -rf $target_directory && mkdir $target_directory
+
+# The old tests package MUST be 'npm install <pkg>'ed as a dependency, but MUST NOT
+# end up in a `node_modules` directory.
+#
+# - MUST be 'npm install'ed: we need transitive dependencies as well.
+# - as a dependency: if we check out the source and do an `npm install --production` in the
+#   package.json directory, NPM will still try to resolve devDependencies (even though it doesn't
+#   need to install them), and the devDeps do not exist on npmjs.
+# - MUST NOT end up in `node_modules`: Jest 27 will ignore all tests that have `node_modules` in
+#   the path, and this behavior is not configurable before Jest 28. Unfortunately, because of TypeScript
+#   typing issues, we cannot move past Jest 27.
+#
+# To achieve this, do an `npm install <pkg>` then follow up with an `mv` to move the files out.
+if !  npm install --prefix $target_directory --no-save @aws-cdk-testing/cli-integ@$version > npm.log 2>&1; then
+    cat npm.log >&2
+    # Catch a "package does not exist" error, have to do it this way because for some reason,
+    # 'npm view <pkg>' doesn't exit with an error... :s
+    if grep -q 'code ETARGET' npm.log; then
+        echo "During migration, @aws-cdk-testing/cli-integ@$version does not exist yet." >&2
+
+
+        # Do create an empty junit.xml file -- if we don't, then the "upload report" phase will fail
+        # if there are 0 files to upload.
+        echo '<testsuites id="Norun" name="No run" tests="0" failures="0" time="0"></testsuites>' > junit.xml
+        exit 0
+    fi
+    exit 1
+fi
+
+mv $($target_directory/node_modules/.bin/test-root)/* $target_directory
+
+# Apply new patches to old tests
+${scriptdir}/apply-patches $version $target_directory
+
+# Run the suite from the old tests
+exec $target_directory/bin/run-suite "$@"

package/bin/query-github

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('./query-github.js');

package/bin/query-github.d.ts

@@ -0,0 +1 @@
+export {};

package/bin/query-github.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs = require("yargs");
+const github_1 = require("../lib/github");
+async function main() {
+    var _a;
+    const args = await yargs
+        .option('token', {
+        descripton: 'GitHub token (default: from environment GITHUB_TOKEN)',
+        alias: 't',
+        type: 'string',
+        requiresArg: true,
+    })
+        .command('last-release', 'Query the last release', cmd => cmd
+        .option('prior-to', {
+        description: 'Return the most recent release before the given version',
+        alias: 'p',
+        type: 'string',
+        requiresArg: true,
+    })
+        .option('major', {
+        description: 'Return the most recent release that matches',
+        alias: 'm',
+        type: 'string',
+        requiresArg: true,
+    }))
+        .demandCommand()
+        .help()
+        .showHelpOnFail(false)
+        .argv;
+    const command = args._[0];
+    const token = (_a = args.token) !== null && _a !== void 0 ? _a : process.env.GITHUB_TOKEN;
+    if (!token) {
+        throw new Error('Either pass --token or set GITHUB_TOKEN.');
+    }
+    switch (command) {
+        case 'last-release':
+            if (args['prior-to'] && args.major) {
+                throw new Error('Cannot pass both `--prior-to and --major at the same time');
+            }
+            // eslint-disable-next-line no-console
+            console.log(await (0, github_1.fetchPreviousVersion)(token, {
+                priorTo: args['prior-to'],
+                majorVersion: args.major,
+            }));
+            break;
+    }
+}
+main().catch(e => {
+    // eslint-disable-next-line no-console
+    console.error(e);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVlcnktZ2l0aHViLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsicXVlcnktZ2l0aHViLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEsK0JBQStCO0FBQy9CLDBDQUFxRDtBQUVyRCxLQUFLLFVBQVUsSUFBSTs7SUFDakIsTUFBTSxJQUFJLEdBQUcsTUFBTSxLQUFLO1NBQ3JCLE1BQU0sQ0FBQyxPQUFPLEVBQUU7UUFDZixVQUFVLEVBQUUsdURBQXVEO1FBQ25FLEtBQUssRUFBRSxHQUFHO1FBQ1YsSUFBSSxFQUFFLFFBQVE7UUFDZCxXQUFXLEVBQUUsSUFBSTtLQUNsQixDQUFDO1NBQ0QsT0FBTyxDQUFDLGNBQWMsRUFBRSx3QkFBd0IsRUFBRSxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUc7U0FDMUQsTUFBTSxDQUFDLFVBQVUsRUFBRTtRQUNsQixXQUFXLEVBQUUseURBQXlEO1FBQ3RFLEtBQUssRUFBRSxHQUFHO1FBQ1YsSUFBSSxFQUFFLFFBQVE7UUFDZCxXQUFXLEVBQUUsSUFBSTtLQUNsQixDQUFDO1NBQ0QsTUFBTSxDQUFDLE9BQU8sRUFBRTtRQUNmLFdBQVcsRUFBRSw2Q0FBNkM7UUFDMUQsS0FBSyxFQUFFLEdBQUc7UUFDVixJQUFJLEVBQUUsUUFBUTtRQUNkLFdBQVcsRUFBRSxJQUFJO0tBQ2xCLENBQUMsQ0FBQztTQUNKLGFBQWEsRUFBRTtTQUNmLElBQUksRUFBRTtTQUNOLGNBQWMsQ0FBQyxLQUFLLENBQUM7U0FDckIsSUFBSSxDQUFDO0lBRVIsTUFBTSxPQUFPLEdBQUcsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUUxQixNQUFNLEtBQUssR0FBRyxNQUFBLElBQUksQ0FBQyxLQUFLLG1DQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDO0lBQ3JELElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUNYLE1BQU0sSUFBSSxLQUFLLENBQUMsMENBQTBDLENBQUMsQ0FBQztJQUM5RCxDQUFDO0lBRUQsUUFBUSxPQUFPLEVBQUUsQ0FBQztRQUNoQixLQUFLLGNBQWM7WUFDakIsSUFBSSxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO2dCQUNuQyxNQUFNLElBQUksS0FBSyxDQUFDLDJEQUEyRCxDQUFDLENBQUM7WUFDL0UsQ0FBQztZQUVELHNDQUFzQztZQUN0QyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sSUFBQSw2QkFBb0IsRUFBQyxLQUFLLEVBQUU7Z0JBQzVDLE9BQU8sRUFBRSxJQUFJLENBQUMsVUFBVSxDQUFDO2dCQUN6QixZQUFZLEVBQUUsSUFBSSxDQUFDLEtBQUs7YUFDekIsQ0FBQyxDQUFDLENBQUM7WUFDSixNQUFNO0lBQ1YsQ0FBQztBQUNILENBQUM7QUFFRCxJQUFJLEVBQUUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUU7SUFDZixzQ0FBc0M7SUFDdEMsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNqQixPQUFPLENBQUMsUUFBUSxHQUFHLENBQUMsQ0FBQztBQUN2QixDQUFDLENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCAqIGFzIHlhcmdzIGZyb20gJ3lhcmdzJztcbmltcG9ydCB7IGZldGNoUHJldmlvdXNWZXJzaW9uIH0gZnJvbSAnLi4vbGliL2dpdGh1Yic7XG5cbmFzeW5jIGZ1bmN0aW9uIG1haW4oKSB7XG4gIGNvbnN0IGFyZ3MgPSBhd2FpdCB5YXJnc1xuICAgIC5vcHRpb24oJ3Rva2VuJywge1xuICAgICAgZGVzY3JpcHRvbjogJ0dpdEh1YiB0b2tlbiAoZGVmYXVsdDogZnJvbSBlbnZpcm9ubWVudCBHSVRIVUJfVE9LRU4pJyxcbiAgICAgIGFsaWFzOiAndCcsXG4gICAgICB0eXBlOiAnc3RyaW5nJyxcbiAgICAgIHJlcXVpcmVzQXJnOiB0cnVlLFxuICAgIH0pXG4gICAgLmNvbW1hbmQoJ2xhc3QtcmVsZWFzZScsICdRdWVyeSB0aGUgbGFzdCByZWxlYXNlJywgY21kID0+IGNtZFxuICAgICAgLm9wdGlvbigncHJpb3ItdG8nLCB7XG4gICAgICAgIGRlc2NyaXB0aW9uOiAnUmV0dXJuIHRoZSBtb3N0IHJlY2VudCByZWxlYXNlIGJlZm9yZSB0aGUgZ2l2ZW4gdmVyc2lvbicsXG4gICAgICAgIGFsaWFzOiAncCcsXG4gICAgICAgIHR5cGU6ICdzdHJpbmcnLFxuICAgICAgICByZXF1aXJlc0FyZzogdHJ1ZSxcbiAgICAgIH0pXG4gICAgICAub3B0aW9uKCdtYWpvcicsIHtcbiAgICAgICAgZGVzY3JpcHRpb246ICdSZXR1cm4gdGhlIG1vc3QgcmVjZW50IHJlbGVhc2UgdGhhdCBtYXRjaGVzJyxcbiAgICAgICAgYWxpYXM6ICdtJyxcbiAgICAgICAgdHlwZTogJ3N0cmluZycsXG4gICAgICAgIHJlcXVpcmVzQXJnOiB0cnVlLFxuICAgICAgfSkpXG4gICAgLmRlbWFuZENvbW1hbmQoKVxuICAgIC5oZWxwKClcbiAgICAuc2hvd0hlbHBPbkZhaWwoZmFsc2UpXG4gICAgLmFyZ3Y7XG5cbiAgY29uc3QgY29tbWFuZCA9IGFyZ3MuX1swXTtcblxuICBjb25zdCB0b2tlbiA9IGFyZ3MudG9rZW4gPz8gcHJvY2Vzcy5lbnYuR0lUSFVCX1RPS0VOO1xuICBpZiAoIXRva2VuKSB7XG4gICAgdGhyb3cgbmV3IEVycm9yKCdFaXRoZXIgcGFzcyAtLXRva2VuIG9yIHNldCBHSVRIVUJfVE9LRU4uJyk7XG4gIH1cblxuICBzd2l0Y2ggKGNvbW1hbmQpIHtcbiAgICBjYXNlICdsYXN0LXJlbGVhc2UnOlxuICAgICAgaWYgKGFyZ3NbJ3ByaW9yLXRvJ10gJiYgYXJncy5tYWpvcikge1xuICAgICAgICB0aHJvdyBuZXcgRXJyb3IoJ0Nhbm5vdCBwYXNzIGJvdGggYC0tcHJpb3ItdG8gYW5kIC0tbWFqb3IgYXQgdGhlIHNhbWUgdGltZScpO1xuICAgICAgfVxuXG4gICAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgbm8tY29uc29sZVxuICAgICAgY29uc29sZS5sb2coYXdhaXQgZmV0Y2hQcmV2aW91c1ZlcnNpb24odG9rZW4sIHtcbiAgICAgICAgcHJpb3JUbzogYXJnc1sncHJpb3ItdG8nXSxcbiAgICAgICAgbWFqb3JWZXJzaW9uOiBhcmdzLm1ham9yLFxuICAgICAgfSkpO1xuICAgICAgYnJlYWs7XG4gIH1cbn1cblxubWFpbigpLmNhdGNoKGUgPT4ge1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgbm8tY29uc29sZVxuICBjb25zb2xlLmVycm9yKGUpO1xuICBwcm9jZXNzLmV4aXRDb2RlID0gMTtcbn0pO1xuIl19

package/bin/query-github.ts

@@ -0,0 +1,56 @@
+import * as yargs from 'yargs';
+import { fetchPreviousVersion } from '../lib/github';
+
+async function main() {
+  const args = await yargs
+    .option('token', {
+      descripton: 'GitHub token (default: from environment GITHUB_TOKEN)',
+      alias: 't',
+      type: 'string',
+      requiresArg: true,
+    })
+    .command('last-release', 'Query the last release', cmd => cmd
+      .option('prior-to', {
+        description: 'Return the most recent release before the given version',
+        alias: 'p',
+        type: 'string',
+        requiresArg: true,
+      })
+      .option('major', {
+        description: 'Return the most recent release that matches',
+        alias: 'm',
+        type: 'string',
+        requiresArg: true,
+      }))
+    .demandCommand()
+    .help()
+    .showHelpOnFail(false)
+    .argv;
+
+  const command = args._[0];
+
+  const token = args.token ?? process.env.GITHUB_TOKEN;
+  if (!token) {
+    throw new Error('Either pass --token or set GITHUB_TOKEN.');
+  }
+
+  switch (command) {
+    case 'last-release':
+      if (args['prior-to'] && args.major) {
+        throw new Error('Cannot pass both `--prior-to and --major at the same time');
+      }
+
+      // eslint-disable-next-line no-console
+      console.log(await fetchPreviousVersion(token, {
+        priorTo: args['prior-to'],
+        majorVersion: args.major,
+      }));
+      break;
+  }
+}
+
+main().catch(e => {
+  // eslint-disable-next-line no-console
+  console.error(e);
+  process.exitCode = 1;
+});

package/bin/run-suite

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('./run-suite.js');

package/bin/run-suite.d.ts

@@ -0,0 +1 @@
+export {};