aws-cdk 0.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,276 @@
+## CLI Commands
+
+All CDK CLI Commands are defined in `lib/config.ts`. This file is translated
+into a valid `yargs` configuration by `bin/user-input-gen`, which is generated by `@aws-cdk/user-input-gen`.
+The `yargs` configuration is generated into the function `parseCommandLineArguments()`,
+in `lib/parse-command-line-arguments.ts`, and is checked into git for readability and
+inspectability; do not edit this file by hand, as every subsequent `yarn build` will
+overwrite any manual edits. If you need to leverage a `yargs` feature not used by
+the CLI, you must add support for it to `@aws-cdk/user-input-gen`.
+
+Note that `bin/user-input-gen` is executed by `ts-node`, which allows `config.ts` to
+reference functions and other identifiers defined in the CLI before the CLI is
+built.
+
+### Dynamic Values
+
+Some values, such as the user's platform, cannot be computed at build time.
+Some commands depend on these values, and thus `user-input-gen` must generate the
+code to compute these values at build time.
+
+The only way to do this today is to reference a parameter with `DynamicValue.fromParameter`.
+The caller of `parseCommandLineArguments()` must pass the parameter.
+
+## Integration Tests
+
+Unit tests are automatically run as part of the regular build. Integration tests
+aren't run automatically since they have nontrivial requirements to run.
+
+#### Looking for the CDK CLI integration tests?
+
+The CDK CLI integration tests live in @aws-cdk-testing. See [here](../../packages/%40aws-cdk-testing/cli-integ/README.md) for more information on the tests and how to run them.
+
+### Three ways of running the tests
+
+We are reusing the same set of integration tests in 3 ways. In each of
+those cases, we get the code we're testing to test from a different source.
+
+- Run them as part of development. In this case, we get the CLI
+  and the framework libraries from the source repository.
+- Run them as integration tests in the pipeline. In this case, we get a specific
+  version of the CLI and the framework libraries from a set of candidate NPM
+  packages.
+- Run them continuously, as a canary. In this case, we get the latest CLI and
+  the framework libraries directly from the package managers, same as an
+  end user would do.
+
+To hide the differences between these different ways of running the tests,
+there are 3 scripts. They all take as command-line argument the ACTUAL test
+script to run, and prepare the environment in such a way that the tests
+will use the `cdk` command and the libraries from the distribution selected.
+
+To run the CLI integ tests in each configuration:
+
+```
+$ test/integ/run-against-repo test/integ/cli/test.sh
+$ test/integ/run-against-dist test/integ/cli/test.sh
+$ test/integ/run-against-release test/integ/cli/test.sh
+```
+
+To run a single integ test in the source tree:
+
+```
+$ test/integ/run-against-repo test/integ/cli/test.sh -t 'SUBSTRING OF THE TEST NAME'
+```
+
+To run regression tests in the source tree:
+
+```
+$ test/integ/test-cli-regression-against-current-code.sh [-t '...']
+```
+
+Integ tests can run in parallel across multiple regions. Set the `AWS_REGIONS`
+environment variable to a comma-separate list of regions:
+
+```
+$ env AWS_REGIONS=us-west-2,us-west-1,eu-central-1,eu-west-2,eu-west-3 test/integ/run-against-repo test/integ/cli/test.sh
+```
+
+Elements from the list of region will be exclusively allocated to one test at
+a time. The tests will run in parallel up to the concurrency limit imposed by
+jest (default of 5, controllable by `--maxConcurrency`) and the available
+number of elements. Regions may be repeated in the list in which case more
+than one test will run at a time in that region.
+
+If `AWS_REGIONS` is not set, all tests will sequentially run in the one
+region set in `AWS_REGION`.
+
+Run with `env INTEG_NO_CLEAN=1` to forego cleaning up the temporary directory,
+in order to be able to debug 'cdk synth' output.
+
+### CLI integration tests
+
+CLI tests will exercise a number of common CLI scenarios, and deploy actual
+stacks to your AWS account.
+
+REQUIREMENTS
+
+* All packages have been compiled.
+* Shell has been preloaded with AWS credentials.
+
+Run:
+
+```
+yarn integ-cli
+```
+
+This command runs two types of tests:
+
+#### Functional
+
+These tests simply run the local integration tests located in [`test/integ/cli`](./test/integ/cli). They test the proper deployment of stacks and in general the correctness of the actions performed by the CLI.
+
+You can also run just these tests by executing:
+
+```console
+yarn integ-cli-no-regression
+```
+
+##### Warning
+
+Since the tests take a long time to run, we run them in parallel in order to minimize running time. Jest does not have
+good support for parallelism, the only thing that exists is `test.concurrent()` and it has a couple of limitations:
+
+- It's not possible to only run a subset of tests, all tests will execute (the reason for this is that it will start all
+  tests in parallel, but only `await` your selected subset specified with the `-t TESTNAME` option. However, all tests
+  are running and Node will not exit until they're all finished).
+- It's not possible to use `beforeEach()` and `afterEach()`.
+
+Because of the first limitation, concurrency is only enabled on the build server (via the `JEST_TEST_CONCURRENT`
+environment variable), not locally. Note: tests using `beforeEach()` will appear to work locally, but will fail on the
+build server! Don't use it!
+
+#### Regression
+
+Validate that previously tested functionality still works in light of recent changes to the CLI. This is done by fetching the functional tests of the previous published release, and running them against the new CLI code.
+
+These tests run in two variations:
+
+- **against local framework code**
+
+  Use your local framework code. This is important to make sure the new CLI version
+  will work properly with the new framework version.
+
+  > See a concrete failure [example](https://github.com/aws/aws-cdk-rfcs/blob/master/text/00110-cli-framework-compatibility-strategy.md#remove---target-from-docker-build-command)
+
+- **against previously release code**
+
+  Fetches the framework code from the previous release. This is important to make sure
+  the new CLI version does not rely on new framework features to provide the same functionality.
+
+  > See a concrete failure [example](https://github.com/aws/aws-cdk-rfcs/blob/master/text/00110-cli-framework-compatibility-strategy.md#change-artifact-metadata-type-value)
+
+You can also run just these tests by executing:
+
+```console
+yarn integ-cli-regression
+```
+
+Note that these tests can only be executed using the `run-against-dist` wrapper. Why? well, it doesn't really make sense to `run-against-repo` when testing the **previously released code**, since we obviously cannot use the repo. Granted, running **against local framework code** can somehow work, but it required a few too many hacks in the current codebase to make it seem worthwhile.
+
+##### Implementation
+
+The implementation of the regression suites is not trivial to reason about and follow. Even though the code includes inline comments, we break down the exact details to better serve us in maintaining it and regaining context.
+
+Before diving into it, we establish a few key concepts:
+
+- `CANDIDATE_VERSION` - This is the version of the code that is being built in the pipeline, and its value is stored in the `build.json` file of the packaged artifact of the repo.
+- `PREVIOUS_VERSION` - This is the version previous to the `CANDIDATE_VERSION`.
+- `CLI_VERSION` - This is the version of the CLI we are testing. It is **always** the same as the `CANDIDATE_VERSION` since we want to test the latest CLI code.
+- `FRAMEWORK_VERSION` - This is the version of the framework we are testing. It varies between the two variation of the regression suites.
+Its value can either be that of `CANDIDATE_VERSION` (for testing against the latest framework code), or `PREVIOUS_VERSION` (for testing against the previously published version of the framework code).
+
+Following are the steps involved in running these tests:
+
+1. Run [`./bump-candidate.sh`](../../scripts/bump-candidate.sh) to differentiate between the local version and the published version. For example, if the version in `lerna.json` is `1.67.0`, this script will result in a version `1.67.0-rc.0`. This is needed so that we can launch a verdaccio instance serving local tarballs without worrying about conflicts with the public npm uplink. This will help us avoid version quirks that might happen during the *post-release-pre-merge-back* time window.
+
+2. Run [`./align-version.sh`](../../scripts/align-version.sh) to configure the above version in all our packages.
+
+3. Build and Pack the repository. The produced tarballs will be versioned with the above version.
+
+4. Run `test/integ/run-against-dist test/integ/test-cli-regression-against-latest-release.sh` (or `test/integ/test-cli-regression-against-latest-code.sh`)
+
+5. First, the `run-against-dist` wrapper will run and:
+
+    - Read the `CANDIDATE_VERSION` from `build.json` and export it.
+    - [Launch verdaccio](./test/integ/run-against-dist#L29) to serve all local tarballs (serves the `CANDIDATE_VERSION` now)
+    - [Install the CLI](./test/integ/run-against-dist#L30) using the `CANDIDATE_VERSION` version `CANDIDATE_VERSION` env variable.
+    - Execute the given script.
+
+6. Both cli regression test scripts run the same [`run_regression_against_framework_version`](./test/integ/test-cli-regression.bash#L22) function. This function accepts which framework version should the regression run against, it can be either `CANDIDATE_VERSION` or `PREVIOUS_VERSION`. Note that the argument is not the actual value of the version, but instead is just an [indirection identifier](./test/integ/test-cli-regression.bash#L81). The function will:
+
+    - Calculate the actual value of the previous version based on the candidate version. (fetches from github)
+    - Download the previous version tarball from npm and extract the integration tests.
+    - Export a `FRAMWORK_VERSION` env variable based on the caller, and execute the integration tests of the previous version.
+
+7. Our integration tests now run and have knowledge of which framework version they should [install](./test/integ/helpers/cdk.ts#L74).
+
+That "basically" it, hope it makes sense...
+
+### Init template integration tests
+
+Init template tests will initialize and compile the init templates that the
+CLI ships with.
+
+REQUIREMENTS
+
+* Running on a machine that has all language tools available (JDK, .NET Core,
+  Python installed).
+* All packages have been compiled.
+* All packages have been packaged to their respective languages (`pack.sh`).
+
+Run:
+
+```
+npm run integ-init
+```
+
+## Integration test modes
+
+These two sets of integration tests have 3 running modes:
+
+- Developer mode, when called through `npm run`. Will use the source tree.
+- Integration test, when called from a directory with the build artifacts
+  (the `dist` directory).
+- Canaries, when called with `IS_CANARY=true`. Will use the build artifacts
+  up on the respective package managers.
+
+The integration test and canary modes are used in the CDK publishing pipeline
+and the CDK canaries, respectively. You wouldn't normally need to run
+them directly that way.
+
+## Bundling
+
+Our CLI package is built and packaged using the [node-bundle](../../tools/%40aws-cdk/node-bundle/README.md) tool.
+
+This has two affects one should be aware of:
+
+### Runtime Dependencies
+
+All runtime dependencies are converted to `devDependencies`, as they are bundled inside
+the package and don't require installation by consumers. This process happens on-demand during packaging,
+this is why our [source code](./package.json) still contains those dependencies,
+but the [npm](https://www.npmjs.com/package/aws-cdk) package does not.
+
+### Attributions
+
+The bundler also creates an attributions document that lists out license information for the entire
+dependency closure. This document is stored in the [THIRD_PARTY_LICENSES](./THIRD_PARTY_LICENSES) file.
+Our build process validates that the file committed to source matches the expected auto-generated one.
+We do this so that our source code always contains the up to date attributions document, and so that we can
+backtrack/review changes to it using normal code review processes.
+
+Whenever a dependency changes (be it direct or transitive, new package or new version), the attributions document
+will change, and needs to be regenerated. For you, this means that:
+
+1. When you manually upgrade a dependency, you must also regenerate the document by running `yarn pkglint` inside the CLI package.
+2. When you build the CLI locally, you must ensure your dependencies are up to date by running `yarn install` inside the CLI package.
+Otherwise, you might get an error like so: `aws-cdk: - [bundle/outdated-attributions] THIRD_PARTY_LICENSES is outdated (fixable)`.
+
+## Source Maps
+
+The source map handling is not entirely intuitive, so it bears some description here.
+
+There are 2 steps to producing a CLI build:
+
+- First we compile TypeScript to JavaScript. This step is configured to produce inline sourcemaps.
+- Then we bundle JavaScript -> bundled JavaScript. This removes the inline
+  sourcemaps, and also is configured to *not* emit a fresh sourcemap file.
+
+The upshot is that we don't vend a 30+MB sourcemap to customers that they have no use for,
+and that we don't slow down Node loading those sourcemaps, while if we are locally developing
+and testing the sourcemaps are still present and can be used.
+
+During the CLI initialization, we always enable source map support: if we are developing
+then source maps are present and can be used, while in a production build there will be no
+source maps so there's nothing to load anyway.

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-2025 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