diff --git a/.github/.dependabot.yml b/.github/.dependabot.yml
index a597b3771a..86b1f65fd1 100644
--- a/.github/.dependabot.yml
+++ b/.github/.dependabot.yml
@@ -5,6 +5,9 @@ updates:
directory: /
schedule:
interval: weekly
+ commit_message:
+ prefix: "chore"
+ include_scope: true
ignore:
- dependency-name: jsii
- dependency-name: "@jsii/*"
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 4b5ed844b0..258a630cfd 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -6,19 +6,21 @@ on:
paths-ignore:
- "**.md"
- "docs/**"
+ - "website/**"
jobs:
build-docker-image:
if: github.repository == 'hashicorp/terraform-cdk'
runs-on: ubuntu-latest
steps:
+ - uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Cache Docker layers
uses: actions/cache@v2
with:
path: /tmp/.buildx-cache
- key: ${{ runner.os }}-buildx-${{ hashFiles('/Dockerfile') }}
+ key: ${{ runner.os }}-buildx-${{ hashFiles('/Dockerfile', '.terraform.versions.json') }}
restore-keys: |
${{ runner.os }}-buildx-
- name: Login to DockerHub
@@ -26,6 +28,12 @@ jobs:
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
+ - id: tf-versions
+ run: |
+ DEFAULT_TERRAFORM_VERSION=$(cat .terraform.versions.json | jq -r '.default')
+ AVAILABLE_TERRAFORM_VERSIONS=$(cat .terraform.versions.json | jq -r '.available | join(" ")')
+ echo "::set-output name=default::$DEFAULT_TERRAFORM_VERSION"
+ echo "::set-output name=available::$AVAILABLE_TERRAFORM_VERSIONS"
- name: Build and push
uses: docker/build-push-action@v2
with:
@@ -34,3 +42,6 @@ jobs:
tags: hashicorp/jsii-terraform:latest
cache-from: type=local,src=/tmp/.buildx-cache
cache-to: type=local,dest=/tmp/.buildx-cache
+ build-args: |
+ DEFAULT_TERRAFORM_VERSION=${{ steps.tf-versions.outputs.default }}
+ AVAILABLE_TERRAFORM_VERSIONS=${{ steps.tf-versions.outputs.available }}
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
index 5631be3cfb..8cad0fcfa4 100644
--- a/.github/workflows/examples.yml
+++ b/.github/workflows/examples.yml
@@ -4,18 +4,32 @@ on:
paths-ignore:
- "**.md"
- "docs/**"
+ - "website/**"
jobs:
- build:
+ build-example-matrix:
+ runs-on: ubuntu-latest
+ outputs:
+ examples: ${{ steps.set-examples.outputs.examples }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ - id: set-examples
+ run: |
+ tfDefault=$(cat .terraform.versions.json | jq -r '.default')
+ examples=$(npx lerna list --scope "@examples/*" | jq -R -s -c --arg tfDefault "${tfDefault}" 'split("\n") | map(select(length > 0)) | { target: values, terraform: [$tfDefault]}')
+ echo $examples
+ echo "::set-output name=examples::$examples"
+
+ examples:
+ needs: build-example-matrix
runs-on: ubuntu-latest
strategy:
- matrix:
- terraform: ["0.15.4"]
- target: ["python", "csharp", "java", "typescript", "go"]
+ fail-fast: false
+ matrix: ${{fromJSON(needs.build-example-matrix.outputs.examples)}}
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
env:
- TF_PLUGIN_CACHE_DIR: "/root/.terraform.d/plugin-cache"
CHECKPOINT_DISABLE: "1"
steps:
- uses: actions/checkout@v2
@@ -29,12 +43,8 @@ jobs:
TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
- name: create bundle
run: yarn package
- - name: bootstrap plugin cache
- run: yum install -y jq && yarn bootstrap-plugin-cache
- env:
- TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
- name: examples integration tests
- run: yarn examples:integration:${TEST_TARGET}
+ run: test/run-against-dist tools/build-examples.sh ${TEST_TARGET}
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
TEST_TARGET: "${{ matrix.target }}"
diff --git a/.github/workflows/build.yml b/.github/workflows/integration.yml
similarity index 56%
rename from .github/workflows/build.yml
rename to .github/workflows/integration.yml
index d35d3d5db1..bd7f73aabd 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/integration.yml
@@ -1,16 +1,16 @@
-name: Build
+name: Integration Tests
on:
pull_request:
paths-ignore:
- "**.md"
- "docs/**"
+ - "website/**"
jobs:
- build:
+ prepare-integration-tests:
runs-on: ubuntu-latest
- strategy:
- matrix:
- terraform: ["0.14.11", "0.15.4"]
+ outputs:
+ tests: ${{ steps.build-test-matrix.outputs.tests }}
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
env:
@@ -28,91 +28,64 @@ jobs:
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- - name: installing dependencies
+ - name: installing dependencies and build
run: |
yarn install
- - name: compile
- run: |
tools/align-version.sh
yarn build
- env:
- TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
- - name: test
- run: |
- yarn test
- env:
- TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
- - name: create bundle
- run: yarn package
+ yarn package
- name: Upload dist
- if: ${{ matrix.terraform == '0.14.11' }}
uses: actions/upload-artifact@v2
with:
name: dist
path: dist
+ - name: installing test dependencies
+ run: |
+ cd test && yarn install
+ - id: build-test-matrix
+ run: |
+ ./tools/build-test-matrix.sh
linux_integration:
+ needs: prepare-integration-tests
runs-on: ubuntu-latest
strategy:
- matrix:
- terraform: ["0.14.11", "0.15.4"]
- target: ["typescript", "python", "java", "csharp", "go"]
+ fail-fast: false
+ matrix: ${{fromJSON(needs.prepare-integration-tests.outputs.tests)}}
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
- needs: build
env:
CHECKPOINT_DISABLE: "1"
TERRAFORM_VERSION: ${{ matrix.terraform }}
steps:
- uses: actions/checkout@v2
- - name: Get yarn cache directory path
- id: yarn-cache-dir-path
- run: echo "::set-output name=dir::$(yarn cache dir)"
- - uses: actions/cache@v2
- id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
- with:
- path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
- key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
- restore-keys: |
- ${{ runner.os }}-yarn-
- name: Download dist
uses: actions/download-artifact@v2
with:
name: dist
path: dist
- - name: installing dependencies
- run: yarn install
+ - name: install test dependencies
+ run: cd test && yarn
- name: integration tests
- run: yarn integration:${TEST_TARGET}
+ run: cd test && ./run-against-dist npx jest ${TEST_TARGET}
env:
TEST_TARGET: ${{ matrix.target }}
TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
windows_integration:
+ needs: prepare-integration-tests
runs-on: windows-latest
strategy:
- matrix:
- terraform: ["0.14.11", "0.15.4"]
- target: ["typescript", "python", "java", "csharp", "go"]
- needs: build
+ fail-fast: false
+ matrix: ${{fromJSON(needs.prepare-integration-tests.outputs.tests)}}
env:
CHECKPOINT_DISABLE: "1"
TERRAFORM_VERSION: ${{ matrix.terraform }}
steps:
- uses: actions/checkout@v2
- - name: Get yarn cache directory path
- id: yarn-cache-dir-path
- run: echo "::set-output name=dir::$(yarn cache dir)"
- - uses: actions/cache@v2
- id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
- with:
- path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
- key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
- restore-keys: |
- ${{ runner.os }}-yarn-
- name: HashiCorp - Setup Terraform
uses: hashicorp/setup-terraform@v1
with:
@@ -129,10 +102,10 @@ jobs:
with:
name: dist
path: dist
- - name: installing dependencies
- run: yarn install
+ - name: install test dependencies
+ run: cd test && yarn
- name: integration tests
- run: yarn integration:windows:${env:TEST_TARGET}
+ run: cd test && ./run-against-dist.bat "npx jest ${env:TEST_TARGET}"
env:
TEST_TARGET: ${{ matrix.target }}
TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
diff --git a/.github/workflows/pr-lint.yml b/.github/workflows/pr-lint.yml
index d43ab3ecc7..0f734ca427 100644
--- a/.github/workflows/pr-lint.yml
+++ b/.github/workflows/pr-lint.yml
@@ -30,6 +30,7 @@ jobs:
cli
hcl2json
hcl2cdk
+ provider-generator
tests
examples
readme
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 202a1f485a..968195def4 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -6,11 +6,14 @@ on:
paths-ignore:
- "**.md"
- "docs/**"
+ - "website/**"
jobs:
- build_artifact:
+ prepare-release:
if: github.repository == 'hashicorp/terraform-cdk'
runs-on: ubuntu-latest
+ outputs:
+ tests: ${{ steps.build-test-matrix.outputs.tests }}
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
env:
@@ -30,15 +33,60 @@ jobs:
yarn test
- name: create bundle
run: yarn package
- - name: integration tests
- run: yarn integration
- env:
- TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
- name: Upload artifact
uses: actions/upload-artifact@v1
with:
name: dist
path: dist
+ - name: installing test dependencies
+ run: |
+ cd test && yarn install
+ - id: build-test-matrix
+ run: |
+ ./tools/build-test-matrix.sh
+
+ integration-tests:
+ needs: prepare-release
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix: ${{fromJSON(needs.prepare-release.outputs.tests)}}
+ container:
+ image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
+ env:
+ CHECKPOINT_DISABLE: "1"
+ steps:
+ - uses: actions/checkout@v2
+ - name: Download dist
+ uses: actions/download-artifact@v2
+ with:
+ name: dist
+ path: dist
+ - name: install test dependencies
+ run: cd test && yarn
+ - name: integration tests
+ run: cd test && ./run-against-dist npx jest ${TEST_TARGET}
+ env:
+ TEST_TARGET: ${{ matrix.target }}
+ TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
+
+ release_github:
+ name: Release to Github
+ needs:
+ - prepare-release
+ - integration-tests
+ runs-on: ubuntu-latest
+ container:
+ image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
+ steps:
+ - uses: actions/checkout@v2
+ - name: installing dependencies
+ run: |
+ yarn install
+ - name: Download build artifacts
+ uses: actions/download-artifact@v1
+ with:
+ name: dist
- name: Release to github
run: yarn release-github
env:
@@ -46,7 +94,9 @@ jobs:
release_npm:
name: Release to Github Packages NPM regitry
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -62,7 +112,9 @@ jobs:
release_pypi:
name: Release to PyPi
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -79,7 +131,9 @@ jobs:
release_maven:
name: Release to Maven
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -100,7 +154,9 @@ jobs:
release_nuget:
name: Release to NuGet
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -117,7 +173,9 @@ jobs:
release_golang:
name: Release Go to Github Repo
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
diff --git a/.github/workflows/release_next.yml b/.github/workflows/release_next.yml
index 583187f018..b53a8e0049 100644
--- a/.github/workflows/release_next.yml
+++ b/.github/workflows/release_next.yml
@@ -6,11 +6,14 @@ on:
paths-ignore:
- "**.md"
- "docs/**"
+ - "website/**"
jobs:
- build_artifact:
+ prepare-release:
if: github.repository == 'hashicorp/terraform-cdk'
runs-on: ubuntu-latest
+ outputs:
+ tests: ${{ steps.build-test-matrix.outputs.tests }}
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
env:
@@ -23,18 +26,48 @@ jobs:
- run: yarn build
- run: yarn test
- run: yarn package
- - run: yarn integration
- env:
- TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
- name: Upload artifact
uses: actions/upload-artifact@v1
with:
name: dist
path: dist
+ - name: installing test dependencies
+ run: |
+ cd test && yarn install
+ - id: build-test-matrix
+ run: |
+ ./tools/build-test-matrix.sh
+
+ integration-tests:
+ needs: prepare-release
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix: ${{fromJSON(needs.prepare-release.outputs.tests)}}
+ container:
+ image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
+ env:
+ CHECKPOINT_DISABLE: "1"
+ steps:
+ - uses: actions/checkout@v2
+ - name: Download dist
+ uses: actions/download-artifact@v2
+ with:
+ name: dist
+ path: dist
+ - name: install test dependencies
+ run: cd test && yarn
+ - name: integration tests
+ run: cd test && ./run-against-dist npx jest ${TEST_TARGET}
+ env:
+ TEST_TARGET: ${{ matrix.target }}
+ TERRAFORM_CLOUD_TOKEN: ${{ secrets.TERRAFORM_CLOUD_TOKEN }}
release_npm:
name: Release to NPM
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -51,7 +84,9 @@ jobs:
release_pypi:
name: Release to PyPi
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -68,7 +103,9 @@ jobs:
release_maven:
name: Release to Maven
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -89,7 +126,9 @@ jobs:
release_nuget:
name: Release to NuGet
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
@@ -106,7 +145,9 @@ jobs:
release_golang:
name: Release Go to Github Repo
- needs: build_artifact
+ needs:
+ - prepare-release
+ - integration-tests
runs-on: ubuntu-latest
container:
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
diff --git a/.github/workflows/unit.yml b/.github/workflows/unit.yml
new file mode 100644
index 0000000000..cd8ad2936e
--- /dev/null
+++ b/.github/workflows/unit.yml
@@ -0,0 +1,59 @@
+name: Unit Tests
+on:
+ pull_request:
+ paths-ignore:
+ - "**.md"
+ - "docs/**"
+ - "website/**"
+
+jobs:
+ build-tf-matrix:
+ runs-on: ubuntu-latest
+ outputs:
+ versions: ${{ steps.build-tf-versions.outputs.versions }}
+ container:
+ image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
+ steps:
+ - uses: actions/checkout@v2
+ - id: build-tf-versions
+ run: |
+ versions=$(cat .terraform.versions.json | jq -c '.tested | { terraform: . }')
+ echo "::set-output name=versions::$versions"
+
+ unit-tests:
+ needs: build-tf-matrix
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix: ${{fromJSON(needs.build-tf-matrix.outputs.versions)}}
+ container:
+ image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform
+ env:
+ CHECKPOINT_DISABLE: "1"
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Get yarn cache directory path
+ id: yarn-cache-dir-path
+ run: echo "::set-output name=dir::$(yarn cache dir)"
+ - uses: actions/cache@v2
+ id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+ with:
+ path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+ key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-yarn-
+ - name: installing dependencies
+ run: |
+ yarn install
+ - name: compile
+ run: |
+ tools/align-version.sh
+ yarn build
+ env:
+ TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
+ - name: test
+ run: |
+ yarn test
+ env:
+ TERRAFORM_BINARY_NAME: "terraform${{ matrix.terraform }}"
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
new file mode 100644
index 0000000000..32c5584bdd
--- /dev/null
+++ b/.github/workflows/website.yml
@@ -0,0 +1,25 @@
+name: Website
+on:
+ - pull_request
+
+jobs:
+ lint:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Get yarn cache directory path
+ id: yarn-cache-dir-path
+ run: echo "::set-output name=dir::$(yarn cache dir)"
+ - uses: actions/cache@v2
+ id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+ with:
+ path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+ key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+ restore-keys: |
+ ${{ runner.os }}-yarn-
+ - name: installing dependencies
+ run: |
+ yarn install
+ - name: prettier
+ run: |
+ yarn prettier --check ./website
diff --git a/.prettierignore b/.prettierignore
index 058f80a90f..ec03222e1f 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -6,3 +6,6 @@ packages/cdktf-cli/templates/*/cdktf.json
*.json
**/.jsii
packages/*/coverage
+packages/**/.yalc
+packages/**/dist
+dist
diff --git a/.terraform.versions.json b/.terraform.versions.json
new file mode 100644
index 0000000000..9de21df8cc
--- /dev/null
+++ b/.terraform.versions.json
@@ -0,0 +1,11 @@
+{
+ "default": "1.0.7",
+ "available": [
+ "1.0.7",
+ "0.15.4"
+ ],
+ "tested": [
+ "1.0.7",
+ "0.15.4"
+ ]
+}
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 92c648cda2..7eb13b16f5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,85 @@
**Breaking Changes**
+Abbreviated version below, for a guide see [Upgrade Guide for 0.7](./docs/upgrade-guide/upgrading-to-0.7.md)
+
+### Namespaced AWS Provider Resources [#572](https://github.com/hashicorp/terraform-cdk/issues/572)
+
+The AWS Provider has a size that makes it hard to navigate in editors, especially in languages that compile it to a single file like Python. We implemented namespaces that hold Resources and Data Sources the same category together, the categories can be found on the [AWS Provider page](https://registry.terraform.io/providers/hashicorp/aws/latest/docs).
+If you don't use the AWS provider no action is needed, if you do you need to adjust your import statements to match the namespaces. You can find more information at [the upgrade guide](./docs/upgrade-guide/upgrading-to-0.7.md).
+
+## 0.6.4 (October 4, 2021)
+
+**Breaking Changes**
+
+### fix(cli): Better handle non-registry modules and improved naming [\#929](https://github.com/hashicorp/terraform-cdk/pull/929)
+
+If you use Terraform Modules you will need to adust their names. We changed the naming to be more intuitive, e.g. `TerraformAwsModulesVpcAws` is now `Vpc`. To migrate please run `cdktf get` with this version and change your imports to match the new abbreviated form.
+
+**Fixed Bugs**
+
+- fix(cli): directly depend on cli-spinners v2.6.0 [\#1116](https://github.com/hashicorp/terraform-cdk/pull/1116)
+- fix(cli): create .cdktf folder if needed [\#1107](https://github.com/hashicorp/terraform-cdk/pull/1107)
+- fix(lib): check for null on removing metadata in testing framework [\#1075](https://github.com/hashicorp/terraform-cdk/pull/1075)
+- fix: ignore build output in prettier [\#1077](https://github.com/hashicorp/terraform-cdk/pull/1077)
+
+**Chores**
+
+- chore(deps): bump trim-newlines from 3.0.0 to 3.0.1 [\#863](https://github.com/hashicorp/terraform-cdk/pull/863)
+- chore(docs): remove roadmap link from README [\#1067](https://github.com/hashicorp/terraform-cdk/pull/1067)
+
+## 0.6.3 (September 22, 2021)
+
+**Features**
+
+- feat(hcl2cdk): Add logical id override when construct id's aren't unique [\#1045](https://github.com/hashicorp/terraform-cdk/pull/1045)
+- feat(lib): use jest asymetric matchers & nicer error messages [\#1052](https://github.com/hashicorp/terraform-cdk/pull/1052)
+
+**Fixed Bugs**
+
+- fix(hcl2cdk): Correctly handle remote state [\#1031](https://github.com/hashicorp/terraform-cdk/pull/1031)
+- fix(docs): adjust setup handling in docs [\#1048](https://github.com/hashicorp/terraform-cdk/pull/1048)
+- fix(cli): don't create config.json files if none was present before [\#1054](https://github.com/hashicorp/terraform-cdk/pull/1054)
+- fix(lib): fix source path generated for local modules [\#947](https://github.com/hashicorp/terraform-cdk/pull/947)
+- fix(docs): typo in documentation [\#1060](https://github.com/hashicorp/terraform-cdk/pull/1060)
+- fix(lib): Fix release pipeline [\#1061](https://github.com/hashicorp/terraform-cdk/pull/1061)
+
+**Chores**
+
+- chore(tests): Build examples as matrix - 1 build per example [\#1043](https://github.com/hashicorp/terraform-cdk/pull/1043)
+- chore(tests): Fix release pipeline [\#1050](https://github.com/hashicorp/terraform-cdk/pull/1050)
+- chore(tests): Upgrade to jest 0.27 for integration tests and retry failed tests once [\#1051](https://github.com/hashicorp/terraform-cdk/pull/1051)
+- chore(deps): bump tmpl from 1.0.4 to 1.0.5 [\#1055](https://github.com/hashicorp/terraform-cdk/pull/1055)
+- chore: fix config for dependabot [\#1057](https://github.com/hashicorp/terraform-cdk/pull/1057)
+
+## 0.6.2 (September 17, 2021)
+
+**Fixed Bugs**
+
+- fix(cli): replaceAll not available in node v14 [\#1036](https://github.com/hashicorp/terraform-cdk/pull/1036)
+- fix(cli): fix import path for Manifest (was relative) [\#1037](https://github.com/hashicorp/terraform-cdk/pull/1037)
+
+**Chores**
+
+- chore: lint monorepo for relative imports between packages [\#1040](https://github.com/hashicorp/terraform-cdk/pull/1040)
+- chore: remove duplicated jest interface members [\#1042](https://github.com/hashicorp/terraform-cdk/pull/1042)
+
+**Documentation**
+
+- feat(docs): add docs for `Testing.renderConstructTree()` [\#1029](https://github.com/hashicorp/terraform-cdk/pull/1029)
+
+## 0.6.1 (September 16, 2021)
+
+**Fixed Bugs**
+
+- fix(lib): Fix testing setup [\#1027](https://github.com/hashicorp/terraform-cdk/pull/1027)
+
+## 0.6.0 (September 15, 2021)
+
+**Breaking Changes**
+
+Abbreviated version below, for a guide see [Upgrade Guide for 0.6](./docs/upgrade-guide/upgrading-to-0.6.md)
+
### Constructs upgrade (`v3` to `v10`)
The `constructs` package serves as the base for all building blocks of the CDKs (e.g. CDK for Terraform, AWS CDK and cdk8s). Recently the `constructs` package was lifted to v10 with a few but major changes. The reason behind those was to make it future proof and stable across different CDKs. In this process the API surface area of the `constructs` base package was reduced and some functionality has been moved directly to the AWS CDK instead. For more information and the underlying motivation for the changes to the `constructs` library refer to the [Removal of Construct Compatibility Layer RFC](https://github.com/aws/aws-cdk-rfcs/blob/master/text/0192-remove-constructs-compat.md).
@@ -9,13 +88,68 @@ The `constructs` package serves as the base for all building blocks of the CDKs
#### Moved functionality
- `Aspects` are now part of `cdktf` as they've been removed from `constructs`. If you use them, you need to change your import statement to import them from the `cdktf` package. The api also has changed a bit. The new way to register `Aspects` is `Aspects.of(construct).add(aspect)` instead of `construct.node.applyAspect(aspect)`.
-- The `construct.node.addInfo()`, `construct.node.addWarning()` and `construct.node.Error()` methods are now available under the `Annotations.of(construct)` API: e.g. `Annotations.of(construct).addWarning('my warning')`. `Annotations` are a part of the `cdktf` base library.
+- The `construct.node.addInfo()`, `construct.node.addWarning()` and `construct.node.addError()` methods are now available under the `Annotations.of(construct)` API: e.g. `Annotations.of(construct).addWarning('my warning')`. `Annotations` are a part of the `cdktf` base library.
#### Removed functionality
-- `construct.onPrepare` / `construct.prepare()` has been removed. Instead you can use `Aspects`: `Aspects.of(this).add({ visit: () => this.prepare() });`.
+- `construct.onPrepare` / `construct.prepare()` has been removed. Instead you can use [`Aspects`](./docs/upgrade-guide/upgrading-to-0.6.md#onprepare-and-prepare-have-been-removed).
- `onSynthesize` has been removed. If you find yourself needing support for it, please file a new issue on this repo and describe your use-case.
+**Features**
+
+- feat(hcl2cdk): inform about recommended variable usage [\#875](https://github.com/hashicorp/terraform-cdk/pull/875)
+- feat(lib): make asset paths change if asset content changes [\#769](https://github.com/hashicorp/terraform-cdk/pull/769)
+- feat(cli): Introduce support for shell completions [\#943](https://github.com/hashicorp/terraform-cdk/pull/943)
+- feat(lib): Print a hint when the app has been passed to a backend instead of the stack [\#945](https://github.com/hashicorp/terraform-cdk/pull/945)
+- feat(lib): expose unit testing helpers [\#942](https://github.com/hashicorp/terraform-cdk/pull/942)
+- feat(cli): detect and validate used node & go version [\#855](https://github.com/hashicorp/terraform-cdk/pull/855)
+- feat(lib): expose terraform functions [\#903](https://github.com/hashicorp/terraform-cdk/pull/903)
+
+**Documentation**
+
+- chore(docs): add a first short note about how to release [\#864](https://github.com/hashicorp/terraform-cdk/pull/864)
+- feat(docs): document how to connect CDKTF to Terraform Cloud [\#874](https://github.com/hashicorp/terraform-cdk/pull/874)
+- fix(docs): update docs to be correct about outdir since multiple stacks feature [\#872](https://github.com/hashicorp/terraform-cdk/pull/872)
+- fix(hcl2cdk): aliased provider missed in graph [\#876](https://github.com/hashicorp/terraform-cdk/pull/876)
+- chore(docs): release pre-built providers [\#892](https://github.com/hashicorp/terraform-cdk/pull/892)
+- chore(docs): update telemetry.md for 0.6 release [\#1017](https://github.com/hashicorp/terraform-cdk/pull/1017)
+- chore(docs): remove custom adapter section for now [\#1021](https://github.com/hashicorp/terraform-cdk/pull/1021)
+- feat(docs): upgrade guide for v0.6 [\#991](https://github.com/hashicorp/terraform-cdk/pull/991)
+
+**Fixed Bugs**
+
+- fix(lib): keysToSnakeCase needs to ignore intrinsic tokens [\#902](https://github.com/hashicorp/terraform-cdk/pull/902)
+- fix(lib): synthesise numbers correctly [\#899](https://github.com/hashicorp/terraform-cdk/pull/899)
+- fix(lib): better error for uninitialized provider [\#896](https://github.com/hashicorp/terraform-cdk/pull/896)
+- fix(cli): Don't specify --user flag when running in an pip activated virtualenv [\#912](https://github.com/hashicorp/terraform-cdk/pull/912)
+- fix(deps): check in husky hooks [\#919](https://github.com/hashicorp/terraform-cdk/pull/919)
+- fix(lib): Alternative Validation Approach [\#911](https://github.com/hashicorp/terraform-cdk/pull/911)
+- fix(cli): Don't print sensitive outputs when running deploy [\#940](https://github.com/hashicorp/terraform-cdk/pull/940)
+- fix(tests): enable windows test with escapes [\#957](https://github.com/hashicorp/terraform-cdk/pull/957)
+- fix(hcl2cdk): Fix convert with numeric count [\#1011](https://github.com/hashicorp/terraform-cdk/pull/1011)
+- fix(lib): Module references to providers synthesizes array instead of map [\#933](https://github.com/hashicorp/terraform-cdk/pull/933)
+- fix(tests): disable terraform cloud test for now [\#955](https://github.com/hashicorp/terraform-cdk/pull/955)
+
+**Chores**
+
+- chore(lib): speed up TS compilation [\#873](https://github.com/hashicorp/terraform-cdk/pull/873)
+- chore(deps): ignore tsbuildinfo [\#894](https://github.com/hashicorp/terraform-cdk/pull/894)
+- chore(docs): Brief reference for local provider usage [\#897](https://github.com/hashicorp/terraform-cdk/pull/897)
+- chore(docs): Link Python Poetry community template [\#922](https://github.com/hashicorp/terraform-cdk/pull/922)
+- chore(deps): bump tar from 4.4.13 to 4.4.17 [\#914](https://github.com/hashicorp/terraform-cdk/pull/914)
+- chore(tests): remove unused aws provider dependency to speed up test [\#926](https://github.com/hashicorp/terraform-cdk/pull/926)
+- chore: fix typos [\#927](https://github.com/hashicorp/terraform-cdk/pull/927)
+- chore(lib): BREAKING CHANGE upgrade constructs lib to v10 [\#921](https://github.com/hashicorp/terraform-cdk/pull/921)
+- chore(deps): Upgrade yargs to v17 [\#779](https://github.com/hashicorp/terraform-cdk/pull/779)
+- chore(tests): Align workflow trigger [\#931](https://github.com/hashicorp/terraform-cdk/pull/931)
+- chore(cli): Make sure Python dependencies are working locally [\#936](https://github.com/hashicorp/terraform-cdk/pull/936)
+- chore(deps): bump tar from 4.4.17 to 4.4.19 [\#941](https://github.com/hashicorp/terraform-cdk/pull/941)
+- chore(release): run all tests on npm test [\#962](https://github.com/hashicorp/terraform-cdk/pull/962)
+- chore(hcl2cdk): Provide guidance for imports [\#949](https://github.com/hashicorp/terraform-cdk/pull/949)
+- chore(deps): bump axios from 0.21.1 to 0.21.4 [\#963](https://github.com/hashicorp/terraform-cdk/pull/963)
+- refactor(lib): use the same jest config everywhere [\#930](https://github.com/hashicorp/terraform-cdk/pull/930)
+- feat(cli): Improve telemetry [\#895](https://github.com/hashicorp/terraform-cdk/pull/895)
+
## 0.5.0 (July 29, 2021)
**New Features**
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index db2c92255f..d1059ddd6c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -33,16 +33,7 @@ $ yarn build
## Examples
-We have a few top level script commands which are executed with Lerna to make the handling of examples easier:
-
-```
-yarn examples:reinstall // -> reinstall dependencies in Python examples
-yarn examples:build // -> fetch providers for examples and build them
-yarn examples:synth // -> synth all examples
-yarn examples:integration // -> run all of the above
-```
-
-For this work, each example needs a `package.json` with at least a minmal config like this:
+We run the examples as part of our integration tests for each Pull Request. To support this, each example needs a `package.json` with at least a minmal config like this:
```json
{
@@ -57,7 +48,7 @@ For this work, each example needs a `package.json` with at least a minmal config
}
```
-Lerna is filtering for the `@examples/` prefix in the `name` field.
+If the example shouldn't be run as part of the build pipeline, a `"private": true` entry can be added to `package.json`. Please make sure to add the ignore reason as JSON comment to `package.json` (e.g. `"//": "This example takes ages to build").
## Development
diff --git a/Dockerfile b/Dockerfile
index 5372dc4a1a..827ebf1a70 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,15 +1,16 @@
FROM docker.mirror.hashicorp.services/jsii/superchain:node14
+ARG DEFAULT_TERRAFORM_VERSION
+ARG AVAILABLE_TERRAFORM_VERSIONS
+
RUN yum install -y unzip jq gcc gcc-c++ && curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python3
-ENV DEFAULT_TERRAFORM_VERSION=0.15.4 \
- TF_PLUGIN_CACHE_DIR="/root/.terraform.d/plugin-cache" \
+ENV TF_PLUGIN_CACHE_DIR="/root/.terraform.d/plugin-cache" \
# MAVEN_OPTS is set in jsii/superchain with -Xmx512m. This isn't enough memory for provider generation.
MAVEN_OPTS="-Xms256m -Xmx3G"
# Install Terraform
-RUN AVAILABLE_TERRAFORM_VERSIONS="0.14.11 ${DEFAULT_TERRAFORM_VERSION}" && \
- for VERSION in ${AVAILABLE_TERRAFORM_VERSIONS}; do curl -LOk https://releases.hashicorp.com/terraform/${VERSION}/terraform_${VERSION}_linux_amd64.zip && \
+RUN for VERSION in ${AVAILABLE_TERRAFORM_VERSIONS}; do curl -LOk https://releases.hashicorp.com/terraform/${VERSION}/terraform_${VERSION}_linux_amd64.zip && \
mkdir -p /usr/local/bin/tf/versions/${VERSION} && \
unzip terraform_${VERSION}_linux_amd64.zip -d /usr/local/bin/tf/versions/${VERSION} && \
ln -s /usr/local/bin/tf/versions/${VERSION}/terraform /usr/local/bin/terraform${VERSION};rm terraform_${VERSION}_linux_amd64.zip;done && \
diff --git a/README.md b/README.md
index 6b77800462..0883eaafa9 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ HashiCorp Terraform.
## Overview
-CDK for Terraform apps are written in one of the supported programming languages and can leverage the entire ecosystem of Terraform [modules](./docs/working-with-cdk-for-terraform/using-modules.md) and [providers](./docs/working-with-cdk-for-terraform/using-providers.md). The application [synthesizes](./docs/working-with-cdk-for-terraform/synthesizing-config.md) Terraform configuration in JSON. Terraform or the CDK for Terraform can then be used to deploy the application.
+CDK for Terraform apps are written in one of the supported programming languages and can leverage the entire ecosystem of Terraform [modules](./docs/working-with-cdk-for-terraform/using-modules.md), [providers](./docs/working-with-cdk-for-terraform/using-providers.md), and [functions](./docs/working-with-cdk-for-terraform/terraform-functions.md). The application [synthesizes](./docs/working-with-cdk-for-terraform/synthesizing-config.md) Terraform configuration in JSON. Terraform or the CDK for Terraform can then be used to deploy the application.
The CDK for Terraform project includes two packages:
@@ -114,12 +114,14 @@ Choose a language:
- Using the CDK for Terraform [tokens](./docs/working-with-cdk-for-terraform/tokens.md).
- Using Terraform [data sources](./docs/working-with-cdk-for-terraform/data-sources.md).
- Using Terraform [variables](./docs/working-with-cdk-for-terraform/terraform-variables.md).
+- Using Terraform [functions](./docs/working-with-cdk-for-terraform/terraform-functions.md)
- Synthesizing Terraform configuration using CDK for Terraform [synthesize](./docs/working-with-cdk-for-terraform/synthesizing-config.md) command.
- Project [telemetry](./docs/working-with-cdk-for-terraform/telemetry.md).
- Defining Terraform [locals](./docs/working-with-cdk-for-terraform/terraform-locals.md).
- Handling breaking changes with [feature flags](./docs/working-with-cdk-for-terraform/feature-flags.md).
- Writing own [remote templates](./docs/working-with-cdk-for-terraform/remote-templates.md) for init.
- Using [assets](./docs/working-with-cdk-for-terraform/terraform-assets.md) to transfer files into the Terraform context.
+- Learn how to write [tests](./docs/working-with-cdk-for-terraform/testing.md).
@@ -141,7 +143,6 @@ CDK for Terraform is an early experimental project and the development team woul
- Ask a question on the HashiCorp [Discuss](https://discuss.hashicorp.com/) using the [terraform-cdk](https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/) category.
- Report a [bug](https://github.com/hashicorp/terraform-cdk/issues/new?assignees=&labels=bug&template=bug-report.md&title=) or request a new [feature](https://github.com/hashicorp/terraform-cdk/issues/new?assignees=&labels=enhancement&template=feature-request.md&title=).
- Browse all [open issues](https://github.com/hashicorp/terraform-cdk/issues).
-- [Roadmap](https://github.com/orgs/hashicorp/projects/77).
## Building
diff --git a/docs/upgrade-guide/upgrading-to-0.6.md b/docs/upgrade-guide/upgrading-to-0.6.md
new file mode 100644
index 0000000000..47a45f1c84
--- /dev/null
+++ b/docs/upgrade-guide/upgrading-to-0.6.md
@@ -0,0 +1,177 @@
+# Upgrading to CDKTF version 0.6
+
+CDK for Terraform version 0.6 uses [`constructs`](https://github.com/aws/constructs) version 10. For most users upgrading the versions should be seamless. If you are using more advanced APIs from the `constructs` library, see the [Constructs API Changes](#constructs-api-changes) section.
+
+## Background
+
+Since version 0.6 the `cdktf` package depends on `constructs` v10 (formerly was v3). While that jump might look big, v10 is actually going to be the next major version after v3. The reason for this jump lies in the underlying intention: The `constructs` lib v10 is supposed to stay around for a while and is supposed to offer a very stable API.
+To achieve this stability in the core functionality a lot has been removed from v10. For further background information you can read into the [PR for v10](https://github.com/aws/constructs/pull/263) or the AWS CDK RFC [Removal of Construct Compatibility Layer](https://github.com/aws/aws-cdk-rfcs/blob/master/text/0192-remove-constructs-compat.md).
+
+While using the v0.6 `cdktf-cli` to deploy stacks that are using an older version of `cdktf` and `constructs` should still work, we recommend upgrading the `cdktf` and `constructs` packages.
+
+## Pre-built providers
+
+All upcoming releases of the [pre-built providers](https://cdk.tf/prebuilt-providers) will depend on `constructs` v10. So we recommend to upgrade your project.
+If you cannot upgrade the `cdktf` version, you can switch to [generating provider bindings](https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules) via `cdktf get`.
+
+## Upgrading a TypeScript / JavaScript CDKTF project
+
+To upgrade a TypeScript or JavaScript CDKTF project, adjust the versions in the `package.json` file of your project.
+
+```jsonc
+{
+ // ...
+ "dependencies": {
+ "cdktf": "^0.6.0",
+ "constructs": "^10.0.5"
+ }
+}
+```
+
+Afterwards run `npm install` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+## Upgrading a Python CDKTF project
+
+### `pipenv` (`python`-template)
+
+To upgrade a Python CDKTF project using `pipenv`, adjust the versions in the `Pipfile` of your project.
+
+```toml
+[packages]
+cdktf = "~=0.6.0"
+```
+
+Afterwards run `pipenv install` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+### Pip3 (`python-pip`-template)
+
+To upgrade a Python CDKTF project using `pip3`, adjust the versions in the `requirements.txt` of your project.
+
+```
+cdktf~=0.6.0
+```
+
+Afterwards run `pip3 install -r requirements.txt` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+## Upgrading a Java CDKTF project
+
+To upgrade a Java CDKTF project, adjust the versions in the `pom.xml` file of your project.
+
+```xml
+
+
+
+ com.hashicorp
+ cdktf
+ 0.6.0
+
+
+ software.constructs
+ constructs
+ 10.0.5
+
+
+
+
+```
+
+Afterwards run `mvn install` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+## Upgrading a CSharp CDKTF project
+
+To upgrade a C# CDKTF project, adjust the versions in the `*.csproj` file of your project.
+
+```xml
+
+
+
+
+
+
+```
+
+Afterwards run `dotnet restore` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+## Upgrading a Golang CDKTF project
+
+To upgrade a Golang CDKTF project, adjust the versions in the `go.mod` file of your project.
+
+```
+require github.com/aws/constructs-go/constructs/v10 v10.0.5
+require github.com/hashicorp/terraform-cdk-go/cdktf v0.6.0
+```
+
+Afterwards run `go get` to update the depedencies and `cdktf get` to re-generate the provider bindings if you don't only use pre-built providers.
+
+You also need to adjust all imports to refer to `constructs/v10` instead of `constructs/v3`.
+
+```
+import (
+ "github.com/aws/constructs-go/constructs/v10"
+)
+```
+
+## Constructs API Changes
+
+### `Aspects` moved to `cdktf`
+
+`Aspects` are now part of `cdktf` as they've been removed from `constructs`. If you use them, you need to change your import statement to import them from the `cdktf` package. The API also has changed a bit:
+
+```typescript
+// to register Aspects, use
+import { Aspects } from "cdktf"; // new
+Aspects.of(construct).add(aspect);
+
+// instead of
+construct.node.applyAspect(aspect); // old
+```
+
+### `construct.node.addInfo()` / `addWarning()` / `addError()` moved to `Annotations`
+
+The aforementioned methods are now available via the `Annotations` API:
+
+```typescript
+// use
+import { Annotations } from "cdktf"; // new
+Annotations.of(construct).addInfo("hello");
+
+// instead of
+construct.node.addInfo("hello"); // old
+```
+
+Annotations will also be printed by the `cdktf-cli` after your stack was synthesized. One ore more `error` annotations will make the `synth` fail.
+
+### `onPrepare()` and `prepare()` have been removed
+
+```typescript
+// use
+import { Aspects } from "cdktf";
+class MyConstruct extends Construct {
+ constructor(scope: IConstruct, id: string) {
+ super(scope, id);
+
+ Aspects.of(this).add({
+ visit: (node: IConstruct) => {
+ // visit will also be called on any childs of this construct
+ if (node === this) console.log("some work");
+ },
+ });
+ }
+}
+
+// instead of
+class MyConstruct extends Construct {
+ onPrepare() {
+ console.log("some work");
+ }
+}
+```
+
+### `onSynthesize` has been removed
+
+Should you need support for this, please file a [new issue](https://cdk.tf/feature) on this repo and describe your use-case.
+
+## Further support
+
+If you encounter anything that is missing from this guide or not working as expected, please don't hesitate to file a [bug](https://cdk.tf/bug) so we can improve this guide. You can also post your question to HashiCorp [Discuss](https://discuss.hashicorp.com/) using the [terraform-cdk](https://discuss.hashicorp.com/c/terraform-core/cdk-for-terraform/) category.
diff --git a/docs/upgrade-guide/upgrading-to-0.7.md b/docs/upgrade-guide/upgrading-to-0.7.md
new file mode 100644
index 0000000000..c78f80b94a
--- /dev/null
+++ b/docs/upgrade-guide/upgrading-to-0.7.md
@@ -0,0 +1,110 @@
+# Upgrading to CDKTF version 0.7
+
+## AWS Provider has namespaced resources
+
+The AWS Provider has a size that makes it hard to navigate in editors, especially in languages that compile it to a single file like Python. We implemented namespaces that hold Resources and Data Sources the same category together, the categories can be found on the [AWS Provider page](https://registry.terraform.io/providers/hashicorp/aws/latest/docs).
+If you don't use the AWS provider no action is needed, if you do you need to adjust your import statements to match the namespaces.
+
+### Typescript
+
+For Typescript you need to change the imports and reference the namespace
+
+```ts
+// Before
+import { CloudFrontDistribution, AwsProvider, Route53Record, AcmCertificateValidation } from "./.gen/providers/aws";
+
+// After
+import { CloudFront, AwsProvider, Route53, ACM } from "./.gen/providers/aws";
+
+// Before
+new Route53Record(this, "CertValidationRecord", ...)
+
+// After
+new Route53.Route53Record(this, "CertValidationRecord", ...)
+```
+
+Alternatively you can deconstruct the namespace:
+
+```ts
+// Before
+import {
+ CloudFrontDistribution,
+ AwsProvider,
+ Route53Record,
+ AcmCertificateValidation,
+} from "./.gen/providers/aws";
+
+// After
+import { CloudFront, AwsProvider, Route53, ACM } from "./.gen/providers/aws";
+const { CloudFrontDistribution } = CloudFront;
+const { Route53Record } = Route53;
+const { AcmCertificateValidation } = ACM;
+```
+
+### Python
+
+For Python only the imports need to be changed:
+
+```py
+# Before
+from imports.aws import AwsProvider, SnsTopic
+# After
+from imports.aws import AwsProvider
+from imports.aws.sns import SnsTopic
+```
+
+### C#
+
+For C# only the imports need to be changed:
+
+```csharp
+// Before
+using aws;
+
+// After
+using aws;
+using aws.sns;
+```
+
+### Java
+
+For Java only the imports need to be changed:
+
+```java
+// Before
+import imports.aws.AwsProvider;
+import imports.aws.SnsTopic;
+
+// After
+import imports.aws.AwsProvider;
+import imports.aws.sns.SnsTopic;
+```
+
+### Go
+
+For Go only the imports need to be changed:
+
+```go
+
+// Before
+
+import (
+ "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/hashicorp/aws"
+
+ "github.com/aws/constructs-go/constructs/v10"
+ "github.com/aws/jsii-runtime-go"
+ "github.com/hashicorp/terraform-cdk-go/cdktf"
+)
+
+
+// After
+import (
+ "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/hashicorp/aws"
+ "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/hashicorp/aws/ec2"
+
+ "github.com/aws/constructs-go/constructs/v10"
+ "github.com/aws/jsii-runtime-go"
+ "github.com/hashicorp/terraform-cdk-go/cdktf"
+)
+
+```
diff --git a/docs/working-with-cdk-for-terraform/cdktf-json.md b/docs/working-with-cdk-for-terraform/cdktf-json.md
index 1a36246f4e..2103f48789 100644
--- a/docs/working-with-cdk-for-terraform/cdktf-json.md
+++ b/docs/working-with-cdk-for-terraform/cdktf-json.md
@@ -25,6 +25,7 @@ export interface Config {
readonly language?: Language; // Target language for building provider or module bindings. Currently supported: `typescript`, `python`, `java`, `csharp`, and `go`
readonly output: string; // Default: 'cdktf.out'. Where the synthesized JSON should go. Also will be the working directory for Terraform operations
readonly codeMakerOutput: string; // Default: '.gen'. Path where generated provider bindings will be rendered to.
+ readonly projectId: string; // Default: generated UUID. Unique identifier for the project used to differentiate projects
readonly terraformProviders?: RequirementDefinition[]; // Terraform Providers to build
readonly terraformModules?: RequirementDefinition[]; // Terraform Modules to build
}
diff --git a/docs/working-with-cdk-for-terraform/telemetry.md b/docs/working-with-cdk-for-terraform/telemetry.md
index ad75f0c719..6ae41537ce 100644
--- a/docs/working-with-cdk-for-terraform/telemetry.md
+++ b/docs/working-with-cdk-for-terraform/telemetry.md
@@ -1,8 +1,7 @@
# Telemetry
CDK for Terraform CLI ([cdktf-cli](../../packages/cdktf-cli)) interacts with a HashiCorp service called [Checkpoint](https://checkpoint.hashicorp.com)
-to report project metrics such as cdktf version, project language, provider name, platform name, and other details that help guide the project maintainers with
-feature and roadmap decisions. The code that interacts with Checkpoint is part of CDK for Terraform CLI and can be read [here](../../packages/cdktf-cli/lib/checkpoint.ts).
+to report project metrics such as cdktf version, project language, provider name, platform name, and other details that help guide the project maintainers with feature and roadmap decisions. Starting with CDK for Terraform 0.6, this information will also include a random UUID that uniquely identifies the machine, and new projects will have a project-specific UUID added to the cdktf.json file. The purpose of these UUIDs is to help the team understand how the tool is being used in order to help us prioritize features. The code that interacts with Checkpoint is part of CDK for Terraform CLI and can be read [here](../../packages/cdktf-cli/lib/checkpoint.ts).
All HashiCorp projects including Terraform that is used by CDK for Terraform use Checkpoint.
Read more about project metrics [here](https://github.com/hashicorp/terraform-cdk/issues/325).
diff --git a/website/docs/cdktf/concepts/fundamentals/functions.html.md b/docs/working-with-cdk-for-terraform/terraform-functions.md
similarity index 87%
rename from website/docs/cdktf/concepts/fundamentals/functions.html.md
rename to docs/working-with-cdk-for-terraform/terraform-functions.md
index 66049d31fd..e807a70996 100644
--- a/website/docs/cdktf/concepts/fundamentals/functions.html.md
+++ b/docs/working-with-cdk-for-terraform/terraform-functions.md
@@ -1,11 +1,4 @@
----
-layout: "docs"
-page_title: "Functions"
-sidebar_current: "cdktf"
-description: "TODO: describe me"
----
-
-# Functions
+# Terraform Functions
Terraform provides a set of functions that can be used through the CDK for Terraform.
@@ -27,4 +20,4 @@ To explore the functionality either check out the [Terraform Documentation](http
## When not to use
-- For inputs not tied to Terraform (e.g. Environment variables / Local Files) since it's easier to use the programming language you use
\ No newline at end of file
+- For inputs not tied to Terraform (e.g. Environment variables / Local Files) since it's easier to use the programming language you use
diff --git a/docs/working-with-cdk-for-terraform/testing.md b/docs/working-with-cdk-for-terraform/testing.md
new file mode 100644
index 0000000000..60bcb12d29
--- /dev/null
+++ b/docs/working-with-cdk-for-terraform/testing.md
@@ -0,0 +1,142 @@
+# Testing CDK Applications
+
+Testing your application can give you faster feedback cycles and guard you against unwanted changes.
+
+## Unit Tests
+
+Unit testing is currently only supported for Typescript with jest.
+We generate all files necessary to run jest when you run `cdktf init` so that you can start writing tests right away. If you want to add jest to an existing project, please [follow their guide](https://jestjs.io/docs/getting-started). Once done you need to add these lines in a [setup file after env](https://jestjs.io/docs/configuration#setupfilesafterenv-array) (you can configure this via the `setupFilesAfterEnv` key in your jest configuration, it takes an array of file paths as input):
+
+```js
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
+```
+
+### Writing Assertions
+
+```ts
+import { Testing } from "cdktf";
+import { Image, Container } from "../.gen/providers/docker";
+import MyApplicationsAbstraction from "../app"; // Could be a class extending from cdktf.Resource
+import "cdktf/lib/testing/adapters/jest"; // This is needed to get Typescript types for the new matchers
+
+describe("Unit testing using assertions", () => {
+ it("should contain a container", () => {
+ expect(
+ Testing.synthScope((scope) => {
+ new MyApplicationsAbstraction(scope, "my-app", {});
+ })
+ ).toHaveResource(Container);
+ });
+
+ it("should use an ubuntu image", () => {
+ expect(
+ Testing.synthScope((scope) => {
+ new MyApplicationsAbstraction(scope, "my-app", {});
+ })
+ ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ });
+});
+```
+
+In the example above we use `Testing.synthScope` to test a part of the application. This creates a scope we can use to test a subset of the application and returns a JSON string representing the synthesized HCL-JSON. We can then use custom matchers to verify our code acts as intended.
+
+- `toHaveResource`: Checks if a certain resource exists
+- `toHaveResourceWithProperties`: Checks if a certain resource exists with all properties passed
+- `toHaveDataSource`: Checks if a certain data source exists
+- `toHaveDataSourceWithProperties`: Checks if a certain data source exists with all properties passed
+
+Since we are using jest you can also use asymetric matchers like [`expect.anything()`](https://jestjs.io/docs/expect#expectanything), [`expect.arrayContaining([...])`](https://jestjs.io/docs/expect#expectarraycontainingarray), and [`expect.objectContaining({...})`](https://jestjs.io/docs/expect#expectobjectcontainingobject):
+
+```ts
+expect(synthesized).toHaveResourceWithProperties(aws.S3Bucket, {
+ bucketPrefix: `sls-example-frontend-test`,
+ website: [
+ expect.objectContaining({
+ indexDocument: "index.html",
+ errorDocument: "index.html",
+ }),
+ ],
+});
+```
+
+### Snapshot Testing
+
+Snapshot tests are a very useful tool whenever you want to make sure your infrastructure does not change unexpectedly. You can read more about them in the [Jest docs](https://jestjs.io/docs/snapshot-testing).
+
+```ts
+import { Testing } from "cdktf";
+import { Image, Container } from "../.gen/providers/docker";
+import MyApplicationsAbstraction from "../app"; // Could be a class extending from cdktf.Resource
+import "cdktf/lib/testing/adapters/jest"; // This is needed to get Typescript types for the new matchers
+
+describe("Unit testing using snapshots", () => {
+ it("Tests a custom abstraction", () => {
+ expect(
+ Testing.synthScope((stack) => {
+ const app = new MyApplicationsAbstraction(scope, "my-app", {});
+ app.addEndpoint("127.0.0.1"); // This could be a method your class exposes
+ })
+ ).toMatchInlineSnapshot(); // There is also .toMatchSnapshot() to write the snapshot to a file
+ });
+});
+```
+
+Besides `Testing.synthScope()` there is also `Testing.renderConstructTree()` which does not synthesize anything but prints a tree of the structure of your constructs. This can be used to assert an exact structure (without looking at the parameters inside).
+
+```ts
+import { Testing } from "cdktf";
+import MyApp from "../app"; // could be your root cdktf.App
+
+describe("Unit testing using snapshots", () => {
+ it("Tests a constructs tree structure", () => {
+ const app = new MyApp();
+ expect(Testing.renderConstructTree(app)).toMatchInlineSnapshot(`
+ "App
+ └── MyStack (TerraformStack)
+ ├── Resource1 (MyResource)
+ └── Resource2 (MyResource)
+ "
+ `);
+ });
+});
+```
+
+### Integration with Terraform
+
+When using [overrides](./escape-hatch.md) it can happen that you produce invalid Terraform configuration.
+To test this before running `cdktf plan` / `cdktf deploy` you can assert that [`terraform validate`](https://www.terraform.io/docs/cli/commands/validate.html) or [`terraform plan`](https://www.terraform.io/docs/cli/commands/plan.html) run successfully (even on parts of your application).
+
+```ts
+import { Testing } from "cdktf";
+
+describe("Checking validity", () => {
+ it("check if the produced terraform configuration is valid", () => {
+ const app = Testing.app();
+ const stack = new TerraformStack(app, "test");
+
+ const app = new MyApplicationsAbstraction(stack, "my-app", {});
+ app.addEndpoint("127.0.0.1"); // This could be a method your class exposes
+
+ // We need to do a full synth to validate the terraform configuration
+ expect(Testing.fullSynth(app)).toBeValidTerraform();
+ });
+
+ it("check if this can be planned", () => {
+ const app = Testing.app();
+ const stack = new TerraformStack(app, "test");
+
+ const app = new MyApplicationsAbstraction(stack, "my-app", {});
+ app.addEndpoint("127.0.0.1"); // This could be a method your class exposes
+
+ // We need to do a full synth to plan the terraform configuration
+ expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ });
+});
+```
+
+## Integration Testing
+
+While we currently don't have many helpers for integration testing there are some examples one can take as inspiration:
+
+- [CDK Day 2021](https://github.com/ansgarm/talk-cdkday-2021/tree/master/test)
diff --git a/examples/csharp/aws/Main.cs b/examples/csharp/aws/Main.cs
index a148814ca2..54cd79fd7a 100644
--- a/examples/csharp/aws/Main.cs
+++ b/examples/csharp/aws/Main.cs
@@ -2,6 +2,9 @@
using System.Collections.Generic;
using System.Linq;
using aws;
+using aws.DataSources;
+using aws.DynamoDb;
+using aws.Sns;
using Constructs;
using HashiCorp.Cdktf;
diff --git a/examples/go/aws/cdktf.json b/examples/go/aws/cdktf.json
index e007de7362..c9cd123bb0 100644
--- a/examples/go/aws/cdktf.json
+++ b/examples/go/aws/cdktf.json
@@ -7,7 +7,7 @@
],
"terraformModules": [
{
- "name": "aws-eks-module",
+ "name": "eks",
"source": "terraform-aws-modules/eks/aws",
"version": "~> 16.0"
}
diff --git a/examples/go/aws/main.go b/examples/go/aws/main.go
index f783e85639..47d27c71bc 100644
--- a/examples/go/aws/main.go
+++ b/examples/go/aws/main.go
@@ -1,8 +1,9 @@
package main
import (
- eks "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/aws_eks_module"
+ "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/eks"
"github.com/hashicorp/terraform-cdk/examples/go/aws/generated/hashicorp/aws"
+ "github.com/hashicorp/terraform-cdk/examples/go/aws/generated/hashicorp/aws/ec2"
"github.com/aws/constructs-go/constructs/v10"
"github.com/aws/jsii-runtime-go"
@@ -16,7 +17,7 @@ func NewExampleCdktfGoAwsStack(scope constructs.Construct, id string) cdktf.Terr
Region: jsii.String("us-east-1"),
})
- aws.NewInstance(stack, jsii.String("Hello"), &aws.InstanceConfig{
+ ec2.NewInstance(stack, jsii.String("Hello"), &ec2.InstanceConfig{
Ami: jsii.String("ami-2757f631"),
InstanceType: jsii.String("t2.micro"),
Tags: &map[string]*string{
@@ -24,7 +25,7 @@ func NewExampleCdktfGoAwsStack(scope constructs.Construct, id string) cdktf.Terr
},
})
- eks.NewAwsEksModule(stack, jsii.String("EKS"), &eks.AwsEksModuleOptions{
+ eks.NewEks(stack, jsii.String("EKS"), &eks.EksOptions{
ClusterName: jsii.String("my-eks"),
Subnets: jsii.Strings("a", "b"),
VpcId: jsii.String("id"),
diff --git a/examples/go/aws/package.json b/examples/go/aws/package.json
index df28523760..c737ee1927 100644
--- a/examples/go/aws/package.json
+++ b/examples/go/aws/package.json
@@ -1,5 +1,7 @@
{
+ "//": "This example test is disabled via the 'private' attribute since it takes more than 20 minutes to build",
"name": "@examples/go-aws",
+ "private": true,
"version": "0.0.0",
"license": "MPL-2.0",
"scripts": {
diff --git a/examples/go/google/package.json b/examples/go/google/package.json
index 0a9734bb88..d70e41bbb9 100644
--- a/examples/go/google/package.json
+++ b/examples/go/google/package.json
@@ -1,5 +1,7 @@
{
+ "//": "This example test is disabled via the 'private' attribute since it takes more than 20 minutes to build",
"name": "@examples/go-google",
+ "private": true,
"version": "0.0.0",
"license": "MPL-2.0",
"scripts": {
diff --git a/examples/java/aws/src/main/java/com/mycompany/app/Main.java b/examples/java/aws/src/main/java/com/mycompany/app/Main.java
index 840111d1b1..6ac71173c6 100644
--- a/examples/java/aws/src/main/java/com/mycompany/app/Main.java
+++ b/examples/java/aws/src/main/java/com/mycompany/app/Main.java
@@ -11,10 +11,10 @@
import com.hashicorp.cdktf.TerraformStack;
import imports.aws.AwsProvider;
-import imports.aws.DataAwsRegion;
-import imports.aws.DynamodbTable;
-import imports.aws.DynamodbTableAttribute;
-import imports.aws.SnsTopic;
+import imports.aws.data_sources.DataAwsRegion;
+import imports.aws.dynamo_db.DynamodbTable;
+import imports.aws.dynamo_db.DynamodbTableAttribute;
+import imports.aws.sns.SnsTopic;
import software.constructs.Construct;
public class Main extends TerraformStack {
diff --git a/examples/java/gradle-shared-module/module-a/src/main/java/com/example/cdktf/modules/ModuleA.java b/examples/java/gradle-shared-module/module-a/src/main/java/com/example/cdktf/modules/ModuleA.java
index 3bce6bc535..b2b7cd13b8 100644
--- a/examples/java/gradle-shared-module/module-a/src/main/java/com/example/cdktf/modules/ModuleA.java
+++ b/examples/java/gradle-shared-module/module-a/src/main/java/com/example/cdktf/modules/ModuleA.java
@@ -3,7 +3,7 @@
import com.example.cdktf.common.BaseApplicationModule;
import com.hashicorp.cdktf.App;
import imports.aws.AwsProvider;
-import imports.aws.SecretsmanagerSecret;
+import imports.aws.secrets_manager.SecretsmanagerSecret;
import software.constructs.Construct;
public class ModuleA extends BaseApplicationModule {
diff --git a/examples/python/aws-eks/main.py b/examples/python/aws-eks/main.py
index 1e157f6863..3781751570 100755
--- a/examples/python/aws-eks/main.py
+++ b/examples/python/aws-eks/main.py
@@ -5,7 +5,8 @@
from cdktf import App, TerraformStack, TerraformOutput, Token
# for terraform provider
-from imports.aws import AwsProvider, DataAwsCallerIdentity
+from imports.aws import AwsProvider
+from imports.aws.data_sources import DataAwsCallerIdentity
# for terraform module
from imports.vpc import Vpc
diff --git a/examples/python/aws/main.py b/examples/python/aws/main.py
index a4bf762d41..8546d191bb 100755
--- a/examples/python/aws/main.py
+++ b/examples/python/aws/main.py
@@ -1,8 +1,9 @@
#!/usr/bin/env python
from constructs import Construct
from cdktf import App, TerraformStack
-from imports.aws import SnsTopic, AwsProvider
-from imports.terraform_aws_modules.vpc.aws import TerraformAwsModulesVpcAws
+from imports.aws import AwsProvider
+from imports.aws.sns import SnsTopic
+from imports.terraform_aws_modules.aws import Vpc
class MyStack(TerraformStack):
@@ -11,7 +12,7 @@ def __init__(self, scope: Construct, ns: str):
AwsProvider(self, 'Aws', region='eu-central-1')
- TerraformAwsModulesVpcAws(self, 'CustomVpc',
+ Vpc(self, 'CustomVpc',
name='custom-vpc',
cidr='10.0.0.0/16',
azs=["us-east-1a", "us-east-1b"],
diff --git a/examples/typescript/aws-cloudfront-proxy/.gitignore b/examples/typescript/aws-cloudfront-proxy/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/aws-cloudfront-proxy/.gitignore
+++ b/examples/typescript/aws-cloudfront-proxy/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/aws-cloudfront-proxy/__tests__/main-test.ts b/examples/typescript/aws-cloudfront-proxy/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/aws-cloudfront-proxy/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/aws-cloudfront-proxy/help b/examples/typescript/aws-cloudfront-proxy/help
index c28f5e5008..83a74dd683 100644
--- a/examples/typescript/aws-cloudfront-proxy/help
+++ b/examples/typescript/aws-cloudfront-proxy/help
@@ -1,19 +1,30 @@
========================================================================================================
- Your cdktf typescript project is ready!
+ Your cdktf typescript project is ready!
- cat help Print this message
+ cat help Print this message
Compile:
- npm run compile Compile typescript code to javascript (or "yarn watch")
- npm run watch Watch for changes and compile typescript in the background
- npm run build Get + compile
+ npm run compile Compile typescript code to javascript (or "yarn watch")
+ npm run watch Watch for changes and compile typescript in the background
+ npm run build cdktf get and compile typescript
Synthesize:
- npm run synth Synthesize Terraform resources from stacks to cdktf.out/ (ready for 'terraform apply')
+ cdktf synth Synthesize Terraform resources from stacks to cdktf.out/ (ready for 'terraform apply')
+
+ Diff:
+ cdktf diff Perform a diff (terraform plan) for the given stack
+
+ Deploy:
+ cdktf deploy Deploy the given stack
+
+ Destroy:
+ cdktf destroy Destroy the stack
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
- Deploy:
- terraform apply ./cdktf.out
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/aws-cloudfront-proxy/jest.config.js b/examples/typescript/aws-cloudfront-proxy/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/aws-cloudfront-proxy/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/aws-cloudfront-proxy/main.ts b/examples/typescript/aws-cloudfront-proxy/main.ts
index eb8b792492..2fd38b8a3b 100644
--- a/examples/typescript/aws-cloudfront-proxy/main.ts
+++ b/examples/typescript/aws-cloudfront-proxy/main.ts
@@ -1,12 +1,6 @@
import { Construct } from "constructs";
import { App, TerraformStack, TerraformOutput } from "cdktf";
-import {
- CloudfrontDistribution,
- AcmCertificate,
- Route53Record,
- AcmCertificateValidation,
- AwsProvider,
-} from "./.gen/providers/aws";
+import { CloudFront, AwsProvider, Route53, ACM } from "./.gen/providers/aws";
class MyStack extends TerraformStack {
constructor(scope: Construct, ns: string) {
@@ -25,7 +19,7 @@ class MyStack extends TerraformStack {
alias: "route53",
});
- const cert = new AcmCertificate(this, "cert", {
+ const cert = new ACM.AcmCertificate(this, "cert", {
domainName,
validationMethod: "DNS",
provider,
@@ -36,7 +30,7 @@ class MyStack extends TerraformStack {
// privateZone: false
// })
- const record = new Route53Record(this, "CertValidationRecord", {
+ const record = new Route53.Route53Record(this, "CertValidationRecord", {
name: cert.domainValidationOptions("0").resourceRecordName,
type: cert.domainValidationOptions("0").resourceRecordType,
records: [cert.domainValidationOptions("0").resourceRecordValue],
@@ -46,92 +40,96 @@ class MyStack extends TerraformStack {
allowOverwrite: true,
});
- new AcmCertificateValidation(this, "certvalidation", {
+ new ACM.AcmCertificateValidation(this, "certvalidation", {
certificateArn: cert.arn,
validationRecordFqdns: [record.fqdn],
provider,
});
- const distribution = new CloudfrontDistribution(this, "cloudfront", {
- enabled: true,
- isIpv6Enabled: true,
-
- viewerCertificate: [
- {
- acmCertificateArn: cert.arn,
- sslSupportMethod: "sni-only",
- },
- ],
-
- restrictions: [
- {
- geoRestriction: [
- {
- restrictionType: "none",
- },
- ],
- },
- ],
-
- origin: [
- {
- originId,
- domainName: proxyTarget,
- customOriginConfig: [
- {
- httpPort: 80,
- httpsPort: 443,
- originProtocolPolicy: "http-only",
- originSslProtocols: ["TLSv1.2", "TLSv1.1"],
- },
- ],
- },
- ],
-
- aliases: [domainName],
-
- defaultCacheBehavior: [
- {
- minTtl: 0,
- defaultTtl: 60,
- maxTtl: 86400,
- allowedMethods: [
- "DELETE",
- "GET",
- "HEAD",
- "OPTIONS",
- "PATCH",
- "POST",
- "PUT",
- ],
- cachedMethods: ["GET", "HEAD"],
- targetOriginId: originId,
- viewerProtocolPolicy: "redirect-to-https",
- forwardedValues: [
- {
- cookies: [
- {
- forward: "all",
- },
- ],
- headers: [
- "Host",
- "Accept-Datetime",
- "Accept-Encoding",
- "Accept-Language",
- "User-Agent",
- "Referer",
- "Origin",
- "X-Forwarded-Host",
- ],
- queryString: true,
- },
- ],
- },
- ],
- });
-
- new Route53Record(this, "distribution_domain", {
+ const distribution = new CloudFront.CloudfrontDistribution(
+ this,
+ "cloudfront",
+ {
+ enabled: true,
+ isIpv6Enabled: true,
+
+ viewerCertificate: [
+ {
+ acmCertificateArn: cert.arn,
+ sslSupportMethod: "sni-only",
+ },
+ ],
+
+ restrictions: [
+ {
+ geoRestriction: [
+ {
+ restrictionType: "none",
+ },
+ ],
+ },
+ ],
+
+ origin: [
+ {
+ originId,
+ domainName: proxyTarget,
+ customOriginConfig: [
+ {
+ httpPort: 80,
+ httpsPort: 443,
+ originProtocolPolicy: "http-only",
+ originSslProtocols: ["TLSv1.2", "TLSv1.1"],
+ },
+ ],
+ },
+ ],
+
+ aliases: [domainName],
+
+ defaultCacheBehavior: [
+ {
+ minTtl: 0,
+ defaultTtl: 60,
+ maxTtl: 86400,
+ allowedMethods: [
+ "DELETE",
+ "GET",
+ "HEAD",
+ "OPTIONS",
+ "PATCH",
+ "POST",
+ "PUT",
+ ],
+ cachedMethods: ["GET", "HEAD"],
+ targetOriginId: originId,
+ viewerProtocolPolicy: "redirect-to-https",
+ forwardedValues: [
+ {
+ cookies: [
+ {
+ forward: "all",
+ },
+ ],
+ headers: [
+ "Host",
+ "Accept-Datetime",
+ "Accept-Encoding",
+ "Accept-Language",
+ "User-Agent",
+ "Referer",
+ "Origin",
+ "X-Forwarded-Host",
+ ],
+ queryString: true,
+ },
+ ],
+ },
+ ],
+ }
+ );
+
+ new Route53.Route53Record(this, "distribution_domain", {
name: domainName,
type: "A",
// zoneId: zone.zoneId,
diff --git a/examples/typescript/aws-cloudfront-proxy/package.json b/examples/typescript/aws-cloudfront-proxy/package.json
index f6725b98f2..f1bf641e8b 100644
--- a/examples/typescript/aws-cloudfront-proxy/package.json
+++ b/examples/typescript/aws-cloudfront-proxy/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -20,8 +20,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/aws-cloudfront-proxy/setup.js b/examples/typescript/aws-cloudfront-proxy/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/aws-cloudfront-proxy/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/aws-multiple-stacks/.gitignore b/examples/typescript/aws-multiple-stacks/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/aws-multiple-stacks/.gitignore
+++ b/examples/typescript/aws-multiple-stacks/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/aws-multiple-stacks/__tests__/main-test.ts b/examples/typescript/aws-multiple-stacks/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/aws-multiple-stacks/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/aws-multiple-stacks/help b/examples/typescript/aws-multiple-stacks/help
new file mode 100644
index 0000000000..83a74dd683
--- /dev/null
+++ b/examples/typescript/aws-multiple-stacks/help
@@ -0,0 +1,34 @@
+========================================================================================================
+
+ Your cdktf typescript project is ready!
+
+ cat help Print this message
+
+ Compile:
+ npm run compile Compile typescript code to javascript (or "yarn watch")
+ npm run watch Watch for changes and compile typescript in the background
+ npm run build cdktf get and compile typescript
+
+ Synthesize:
+ cdktf synth Synthesize Terraform resources from stacks to cdktf.out/ (ready for 'terraform apply')
+
+ Diff:
+ cdktf diff Perform a diff (terraform plan) for the given stack
+
+ Deploy:
+ cdktf deploy Deploy the given stack
+
+ Destroy:
+ cdktf destroy Destroy the stack
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
+
+ Upgrades:
+ npm run get Import/update Terraform providers and modules (you should check-in this directory)
+ npm run upgrade Upgrade cdktf modules to latest version
+ npm run upgrade:next Upgrade cdktf modules to latest "@next" version (last commit)
+
+========================================================================================================
diff --git a/examples/typescript/aws-multiple-stacks/jest.config.js b/examples/typescript/aws-multiple-stacks/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/aws-multiple-stacks/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/aws-multiple-stacks/main.ts b/examples/typescript/aws-multiple-stacks/main.ts
index 00094fcd86..6cdddbb4bd 100644
--- a/examples/typescript/aws-multiple-stacks/main.ts
+++ b/examples/typescript/aws-multiple-stacks/main.ts
@@ -1,6 +1,6 @@
import { Construct } from "constructs";
import { App, TerraformStack } from "cdktf";
-import { AwsProvider, Instance } from "./.gen/providers/aws";
+import { AwsProvider, EC2 } from "./.gen/providers/aws";
interface MyStackConfig {
environment: string;
@@ -17,7 +17,7 @@ class MyStack extends TerraformStack {
region,
});
- new Instance(this, "Hello", {
+ new EC2.Instance(this, "Hello", {
ami: "ami-2757f631",
instanceType: "t2.micro",
tags: {
diff --git a/examples/typescript/aws-multiple-stacks/package.json b/examples/typescript/aws-multiple-stacks/package.json
index 959a10bba1..c606169cc0 100644
--- a/examples/typescript/aws-multiple-stacks/package.json
+++ b/examples/typescript/aws-multiple-stacks/package.json
@@ -12,6 +12,7 @@
"apply": "terraform apply ./cdktf.out"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"typescript": "^3.9.7",
"cdktf-cli": "0.0.0"
diff --git a/examples/typescript/aws-multiple-stacks/setup.js b/examples/typescript/aws-multiple-stacks/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/aws-multiple-stacks/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/aws-prebuilt/.gitignore b/examples/typescript/aws-prebuilt/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/aws-prebuilt/.gitignore
+++ b/examples/typescript/aws-prebuilt/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/aws-prebuilt/__tests__/main-test.ts b/examples/typescript/aws-prebuilt/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/aws-prebuilt/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/aws-prebuilt/help b/examples/typescript/aws-prebuilt/help
new file mode 100644
index 0000000000..83a74dd683
--- /dev/null
+++ b/examples/typescript/aws-prebuilt/help
@@ -0,0 +1,34 @@
+========================================================================================================
+
+ Your cdktf typescript project is ready!
+
+ cat help Print this message
+
+ Compile:
+ npm run compile Compile typescript code to javascript (or "yarn watch")
+ npm run watch Watch for changes and compile typescript in the background
+ npm run build cdktf get and compile typescript
+
+ Synthesize:
+ cdktf synth Synthesize Terraform resources from stacks to cdktf.out/ (ready for 'terraform apply')
+
+ Diff:
+ cdktf diff Perform a diff (terraform plan) for the given stack
+
+ Deploy:
+ cdktf deploy Deploy the given stack
+
+ Destroy:
+ cdktf destroy Destroy the stack
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
+
+ Upgrades:
+ npm run get Import/update Terraform providers and modules (you should check-in this directory)
+ npm run upgrade Upgrade cdktf modules to latest version
+ npm run upgrade:next Upgrade cdktf modules to latest "@next" version (last commit)
+
+========================================================================================================
diff --git a/examples/typescript/aws-prebuilt/jest.config.js b/examples/typescript/aws-prebuilt/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/aws-prebuilt/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/aws-prebuilt/package.json b/examples/typescript/aws-prebuilt/package.json
index 68cab3729e..c553d5f8e2 100644
--- a/examples/typescript/aws-prebuilt/package.json
+++ b/examples/typescript/aws-prebuilt/package.json
@@ -9,8 +9,10 @@
"synth": "cdktf synth"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
},
"dependencies": {
diff --git a/examples/typescript/aws-prebuilt/setup.js b/examples/typescript/aws-prebuilt/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/aws-prebuilt/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/azure-app-service/.gitignore b/examples/typescript/azure-app-service/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/azure-app-service/.gitignore
+++ b/examples/typescript/azure-app-service/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/azure-app-service/__tests__/main-test.ts b/examples/typescript/azure-app-service/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/azure-app-service/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/azure-app-service/help b/examples/typescript/azure-app-service/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/azure-app-service/help
+++ b/examples/typescript/azure-app-service/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/azure-app-service/jest.config.js b/examples/typescript/azure-app-service/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/azure-app-service/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/azure-app-service/package.json b/examples/typescript/azure-app-service/package.json
index 2c68428f2d..7897638ccc 100644
--- a/examples/typescript/azure-app-service/package.json
+++ b/examples/typescript/azure-app-service/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.27",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
diff --git a/examples/typescript/azure-app-service/setup.js b/examples/typescript/azure-app-service/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/azure-app-service/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/azure/.gitignore b/examples/typescript/azure/.gitignore
index 72f5b96ca4..1dfae30c78 100755
--- a/examples/typescript/azure/.gitignore
+++ b/examples/typescript/azure/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/azure/__tests__/main-test.ts b/examples/typescript/azure/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/azure/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/azure/help b/examples/typescript/azure/help
index 9662c25dc4..83a74dd683 100755
--- a/examples/typescript/azure/help
+++ b/examples/typescript/azure/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/azure/jest.config.js b/examples/typescript/azure/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/azure/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/azure/package.json b/examples/typescript/azure/package.json
index f9eb29b092..bb4a1bc6df 100755
--- a/examples/typescript/azure/package.json
+++ b/examples/typescript/azure/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/azure/setup.js b/examples/typescript/azure/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/azure/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/backends/azurerm/.gitignore b/examples/typescript/backends/azurerm/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/backends/azurerm/.gitignore
+++ b/examples/typescript/backends/azurerm/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/backends/azurerm/__tests__/main-test.ts b/examples/typescript/backends/azurerm/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/backends/azurerm/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/backends/azurerm/help b/examples/typescript/backends/azurerm/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/backends/azurerm/help
+++ b/examples/typescript/backends/azurerm/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/backends/azurerm/jest.config.js b/examples/typescript/backends/azurerm/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/backends/azurerm/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/backends/azurerm/package.json b/examples/typescript/backends/azurerm/package.json
index c53317ede5..b57325f2ce 100644
--- a/examples/typescript/backends/azurerm/package.json
+++ b/examples/typescript/backends/azurerm/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/backends/azurerm/setup.js b/examples/typescript/backends/azurerm/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/backends/azurerm/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/backends/gcs/.gitignore b/examples/typescript/backends/gcs/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/backends/gcs/.gitignore
+++ b/examples/typescript/backends/gcs/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/backends/gcs/__tests__/main-test.ts b/examples/typescript/backends/gcs/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/backends/gcs/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/backends/gcs/help b/examples/typescript/backends/gcs/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/backends/gcs/help
+++ b/examples/typescript/backends/gcs/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/backends/gcs/jest.config.js b/examples/typescript/backends/gcs/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/backends/gcs/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/backends/gcs/package.json b/examples/typescript/backends/gcs/package.json
index 9a78f03257..b137f2d27a 100644
--- a/examples/typescript/backends/gcs/package.json
+++ b/examples/typescript/backends/gcs/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/backends/gcs/setup.js b/examples/typescript/backends/gcs/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/backends/gcs/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/backends/remote/.gitignore b/examples/typescript/backends/remote/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/backends/remote/.gitignore
+++ b/examples/typescript/backends/remote/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/backends/remote/__tests__/main-test.ts b/examples/typescript/backends/remote/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/backends/remote/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/backends/remote/help b/examples/typescript/backends/remote/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/backends/remote/help
+++ b/examples/typescript/backends/remote/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/backends/remote/jest.config.js b/examples/typescript/backends/remote/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/backends/remote/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/backends/remote/package.json b/examples/typescript/backends/remote/package.json
index fb5f46145a..8bde93c70a 100644
--- a/examples/typescript/backends/remote/package.json
+++ b/examples/typescript/backends/remote/package.json
@@ -1,17 +1,19 @@
{
- "name": "@deactivated-examples/typescript-backends-remote",
+ "//": "This example test is disabled via the 'private' attribute since it needs credentials (I assume at least)",
+ "name": "@examples/typescript-backends-remote",
+ "private": true,
"version": "1.0.0",
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +25,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/backends/remote/setup.js b/examples/typescript/backends/remote/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/backends/remote/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/backends/s3/.gitignore b/examples/typescript/backends/s3/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/backends/s3/.gitignore
+++ b/examples/typescript/backends/s3/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/backends/s3/__tests__/main-test.ts b/examples/typescript/backends/s3/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/backends/s3/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/backends/s3/cdktf.json b/examples/typescript/backends/s3/cdktf.json
index d7eb8ed063..e7815a7369 100644
--- a/examples/typescript/backends/s3/cdktf.json
+++ b/examples/typescript/backends/s3/cdktf.json
@@ -3,5 +3,6 @@
"app": "npm run --silent compile && node main.js",
"terraformProviders": [
"aws@~> 2.0"
- ]
+ ],
+ "projectId": "5498d255-7568-45ac-b866-ec47fea2a693"
}
\ No newline at end of file
diff --git a/examples/typescript/backends/s3/help b/examples/typescript/backends/s3/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/backends/s3/help
+++ b/examples/typescript/backends/s3/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/backends/s3/jest.config.js b/examples/typescript/backends/s3/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/backends/s3/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/backends/s3/main.ts b/examples/typescript/backends/s3/main.ts
index 9c98ae61f4..0fbd3d3309 100644
--- a/examples/typescript/backends/s3/main.ts
+++ b/examples/typescript/backends/s3/main.ts
@@ -5,7 +5,7 @@ import {
S3Backend,
DataTerraformRemoteStateS3,
} from "cdktf";
-import { AwsProvider, DataAwsS3BucketObject } from "./.gen/providers/aws";
+import { AwsProvider, S3 } from "./.gen/providers/aws";
class MyStack extends TerraformStack {
constructor(scope: Construct, name: string) {
@@ -31,7 +31,7 @@ class MyStack extends TerraformStack {
});
// Reference Remote State
- new DataAwsS3BucketObject(this, "object", {
+ new S3.DataAwsS3BucketObject(this, "object", {
bucket: "objectbucket",
key: otherState.get("bucket_key"),
});
diff --git a/examples/typescript/backends/s3/package.json b/examples/typescript/backends/s3/package.json
index 2f3a91ac5f..2d85318ac5 100644
--- a/examples/typescript/backends/s3/package.json
+++ b/examples/typescript/backends/s3/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/backends/s3/setup.js b/examples/typescript/backends/s3/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/backends/s3/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/docker/.gitignore b/examples/typescript/docker/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/docker/.gitignore
+++ b/examples/typescript/docker/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/docker/__tests__/main-test.ts b/examples/typescript/docker/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/docker/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/docker/help b/examples/typescript/docker/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/docker/help
+++ b/examples/typescript/docker/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/docker/jest.config.js b/examples/typescript/docker/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/docker/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/docker/package.json b/examples/typescript/docker/package.json
index a711baee53..bb58ad44ae 100644
--- a/examples/typescript/docker/package.json
+++ b/examples/typescript/docker/package.json
@@ -9,15 +9,20 @@
"compile": "tsc --pretty",
"synth": "cdktf synth",
"plan": "cd ./cdktf.out && terraform init && terraform plan",
- "apply": "terraform apply ./cdktf.out"
+ "apply": "terraform apply ./cdktf.out",
+ "test": "jest",
+ "test:watch": "jest --watch"
},
"dependencies": {
"cdktf": "0.0.0",
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
+ "@types/jest": "27.0.1",
"typescript": "^3.9.7",
+ "jest": "27.1.0",
"cdktf-cli": "0.0.0"
}
-}
\ No newline at end of file
+}
diff --git a/examples/typescript/docker/setup.js b/examples/typescript/docker/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/docker/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/docker/tsconfig.json b/examples/typescript/docker/tsconfig.json
index 5e9b4bdab3..a759d617e3 100644
--- a/examples/typescript/docker/tsconfig.json
+++ b/examples/typescript/docker/tsconfig.json
@@ -25,9 +25,7 @@
"target": "ES2018",
"incremental": true
},
- "include": [
- "**/*.ts"
- ],
+ "include": [ "**/*.ts" ],
"exclude": [
"node_modules"
]
diff --git a/examples/typescript/google-cloudrun/.gitignore b/examples/typescript/google-cloudrun/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/google-cloudrun/.gitignore
+++ b/examples/typescript/google-cloudrun/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/google-cloudrun/__tests__/main-test.ts b/examples/typescript/google-cloudrun/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/google-cloudrun/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/google-cloudrun/help b/examples/typescript/google-cloudrun/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/google-cloudrun/help
+++ b/examples/typescript/google-cloudrun/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/google-cloudrun/jest.config.js b/examples/typescript/google-cloudrun/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/google-cloudrun/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/google-cloudrun/package.json b/examples/typescript/google-cloudrun/package.json
index 582eb3271b..8fa027e3e5 100644
--- a/examples/typescript/google-cloudrun/package.json
+++ b/examples/typescript/google-cloudrun/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.27",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/google-cloudrun/setup.js b/examples/typescript/google-cloudrun/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/google-cloudrun/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/google/.gitignore b/examples/typescript/google/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/google/.gitignore
+++ b/examples/typescript/google/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/google/__tests__/main-test.ts b/examples/typescript/google/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/google/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/google/help b/examples/typescript/google/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/google/help
+++ b/examples/typescript/google/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/google/jest.config.js b/examples/typescript/google/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/google/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/google/package.json b/examples/typescript/google/package.json
index 46cc89e265..6301306ad2 100644
--- a/examples/typescript/google/package.json
+++ b/examples/typescript/google/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/google/setup.js b/examples/typescript/google/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/google/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/kubernetes/.gitignore b/examples/typescript/kubernetes/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/kubernetes/.gitignore
+++ b/examples/typescript/kubernetes/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/kubernetes/__tests__/main-test.ts b/examples/typescript/kubernetes/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/kubernetes/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/kubernetes/help b/examples/typescript/kubernetes/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/kubernetes/help
+++ b/examples/typescript/kubernetes/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/kubernetes/jest.config.js b/examples/typescript/kubernetes/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/kubernetes/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/kubernetes/main.ts b/examples/typescript/kubernetes/main.ts
index 4829fa27b5..840a4fc915 100644
--- a/examples/typescript/kubernetes/main.ts
+++ b/examples/typescript/kubernetes/main.ts
@@ -1,5 +1,5 @@
import { Construct } from "constructs";
-import { App, TerraformStack } from "cdktf";
+import { App, TerraformStack, Fn } from "cdktf";
import {
KubernetesProvider,
Namespace,
@@ -26,7 +26,11 @@ class KubeStack extends TerraformStack {
metadata: [
{
name: app,
- namespace: exampleNamespace.metadata[0].name,
+ namespace: Fn.lookup(
+ Fn.element(exampleNamespace.metadata, 0),
+ "name",
+ "default" // falls back to the `default` kubernetes namespace if no name was set
+ ),
labels: {
app,
},
diff --git a/examples/typescript/kubernetes/package.json b/examples/typescript/kubernetes/package.json
index a4ce14d6c6..e0ca038b65 100644
--- a/examples/typescript/kubernetes/package.json
+++ b/examples/typescript/kubernetes/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/kubernetes/setup.js b/examples/typescript/kubernetes/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/kubernetes/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/ucloud/.gitignore b/examples/typescript/ucloud/.gitignore
index 72f5b96ca4..1dfae30c78 100755
--- a/examples/typescript/ucloud/.gitignore
+++ b/examples/typescript/ucloud/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/ucloud/__tests__/main-test.ts b/examples/typescript/ucloud/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/ucloud/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/ucloud/help b/examples/typescript/ucloud/help
index 9662c25dc4..83a74dd683 100755
--- a/examples/typescript/ucloud/help
+++ b/examples/typescript/ucloud/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/ucloud/jest.config.js b/examples/typescript/ucloud/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/ucloud/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/ucloud/package.json b/examples/typescript/ucloud/package.json
index a28bc5712e..34f17c46dc 100755
--- a/examples/typescript/ucloud/package.json
+++ b/examples/typescript/ucloud/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"upgrade": "npm i cdktf@latest cdktf-cli@latest",
"upgrade:next": "npm i cdktf@next cdktf-cli@next"
},
@@ -23,8 +23,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
diff --git a/examples/typescript/ucloud/setup.js b/examples/typescript/ucloud/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/ucloud/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/examples/typescript/vault/.gitignore b/examples/typescript/vault/.gitignore
index 72f5b96ca4..1dfae30c78 100644
--- a/examples/typescript/vault/.gitignore
+++ b/examples/typescript/vault/.gitignore
@@ -6,4 +6,6 @@ cdktf.log
*terraform.*.tfstate*
.gen
.terraform
-tsconfig.tsbuildinfo
\ No newline at end of file
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js
\ No newline at end of file
diff --git a/examples/typescript/vault/__tests__/main-test.ts b/examples/typescript/vault/__tests__/main-test.ts
new file mode 100644
index 0000000000..9fb090d6a8
--- /dev/null
+++ b/examples/typescript/vault/__tests__/main-test.ts
@@ -0,0 +1,85 @@
+// import { Testing } from "cdktf";
+// import "cdktf/lib/testing/adapters/jest";
+
+describe("My CDKTF Application", () => {
+ it.todo("should be tested");
+
+ // // All Unit testst test the synthesised terraform code, it does not create real-world resources
+ // describe("Unit testing using assertions", () => {
+ // it("should contain a resource", () => {
+ // // import { Image,Container } from "./.gen/providers/docker"
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResource(Container);
+
+ // expect(
+ // Testing.synthScope((scope) => {
+ // new MyApplicationsAbstraction(scope, "my-app", {});
+ // })
+ // ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+ // });
+ // });
+
+ // describe("Unit testing using snapshots", () => {
+ // it("Tests the snapshot", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestProvider(stack, "provider", {
+ // accessKey: "1",
+ // });
+
+ // new TestResource(stack, "test", {
+ // name: "my-resource",
+ // });
+
+ // expect(Testing.synth(stack)).toMatchSnapshot();
+ // });
+
+ // it("Tests a combination of resources", () => {
+ // expect(
+ // Testing.synthScope((stack) => {
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // })
+ // ).toMatchInlineSnapshot();
+ // });
+ // });
+
+ // describe("Checking validity", () => {
+ // it("check if the produced terraform configuration is valid", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toBeValidTerraform();
+ // });
+
+ // it("check if this can be planned", () => {
+ // const app = Testing.app();
+ // const stack = new TerraformStack(app, "test");
+
+ // new TestDataSource(stack, "test-data-source", {
+ // name: "foo",
+ // });
+
+ // new TestResource(stack, "test-resource", {
+ // name: "bar",
+ // });
+ // expect(Testing.fullSynth(app)).toPlanSuccessfully();
+ // });
+ // });
+});
diff --git a/examples/typescript/vault/help b/examples/typescript/vault/help
index 9662c25dc4..83a74dd683 100644
--- a/examples/typescript/vault/help
+++ b/examples/typescript/vault/help
@@ -20,7 +20,11 @@
Destroy:
cdktf destroy Destroy the stack
-
+
+ Test:
+ npm run test Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+ npm run test:watch Watches the tests and reruns them on change
+
Upgrades:
npm run get Import/update Terraform providers and modules (you should check-in this directory)
diff --git a/examples/typescript/vault/jest.config.js b/examples/typescript/vault/jest.config.js
new file mode 100644
index 0000000000..1d2da1265e
--- /dev/null
+++ b/examples/typescript/vault/jest.config.js
@@ -0,0 +1,11 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+ clearMocks: true,
+ coverageProvider: "v8",
+ setupFilesAfterEnv: ["setup.js"],
+ };
+
diff --git a/examples/typescript/vault/package.json b/examples/typescript/vault/package.json
index 9e53d3d840..9cba2be3b4 100644
--- a/examples/typescript/vault/package.json
+++ b/examples/typescript/vault/package.json
@@ -4,14 +4,14 @@
"main": "main.js",
"types": "main.ts",
"license": "MPL-2.0",
- "private": true,
"scripts": {
"get": "cdktf get",
"build": "yarn get && tsc",
"synth": "cdktf synth",
"compile": "tsc --pretty",
"watch": "tsc -w",
- "test": "echo ok",
+ "test": "jest",
+ "test:watch": "jest --watch",
"docker:start": "docker run --rm -p 8200:8200 --cap-add=IPC_LOCK -d --name=dev-vault vault",
"docker:token": "docker logs dev-vault 2>&1 | grep -w \"Root Token:\"",
"docker:stop": "docker stop dev-vault",
@@ -26,8 +26,10 @@
"constructs": "^10.0.5"
},
"devDependencies": {
+ "@types/jest": "27.0.1",
"@types/node": "^14.0.26",
"cdktf-cli": "0.0.0",
+ "jest": "27.1.0",
"typescript": "^3.9.7"
}
}
\ No newline at end of file
diff --git a/examples/typescript/vault/setup.js b/examples/typescript/vault/setup.js
new file mode 100644
index 0000000000..0b7e72f07b
--- /dev/null
+++ b/examples/typescript/vault/setup.js
@@ -0,0 +1,2 @@
+const cdktf = require("cdktf");
+cdktf.Testing.setupJest();
diff --git a/package.json b/package.json
index 574c304376..183b737857 100644
--- a/package.json
+++ b/package.json
@@ -1,9 +1,9 @@
{
"name": "root",
- "version": "0.5.0",
+ "version": "0.6.4",
"private": true,
"scripts": {
- "build": "lerna run --scope cdktf* --scope @cdktf/* build",
+ "build": "lerna run --scope 'cdktf*' --scope @cdktf/* build",
"format": "prettier --write .",
"package": "lerna run package && tools/collect-dist.sh",
"package:python": "lerna run package:python && tools/collect-dist.sh",
@@ -11,17 +11,11 @@
"package:dotnet": "lerna run package:dotnet && tools/collect-dist.sh",
"package:js": "lerna run package:js && tools/collect-dist.sh",
"package-windows": "lerna run package && tools\\collect-dist.bat",
- "bootstrap-plugin-cache": "./test/run-against-dist ./tools/bootstrap-plugin-cache.sh",
- "examples:integration": "test/run-against-dist tools/build-examples.sh",
- "examples:integration:java": "test/run-against-dist tools/build-examples-sequential.sh java",
- "examples:integration:csharp": "test/run-against-dist tools/build-examples.sh csharp",
- "examples:integration:python": "test/run-against-dist tools/build-examples.sh python",
- "examples:integration:typescript": "test/run-against-dist tools/build-examples-sequential.sh typescript",
- "examples:integration:go": "test/run-against-dist tools/build-examples-sequential.sh go",
- "pretest": "prettier --check .",
- "test": "lerna run --scope cdktf* --scope @cdktf* test",
- "watch": "lerna run --parallel --stream --scope @cdktf/* --scope cdktf* watch-preserve-output",
- "link-packages": "lerna exec --scope cdktf* --scope @cdktf* yarn link",
+ "pretest": "yarn lint:workspace && prettier --check .",
+ "test": "lerna run --scope 'cdktf*' --scope @cdktf/* test",
+ "watch": "lerna run --parallel --stream --scope @cdktf/* --scope 'cdktf*' watch-preserve-output",
+ "lint:workspace": "eslint .",
+ "link-packages": "lerna exec --scope 'cdktf*' --scope @cdktf/* yarn link",
"integration": "cd test && ./run-against-dist npx jest --runInBand",
"integration:typescript": "cd test && ./run-against-dist npx jest --runInBand typescript",
"integration:python": "cd test && ./run-against-dist npx jest --runInBand python",
@@ -51,7 +45,6 @@
"examples/java/*",
"examples/csharp/*",
"examples/go/*",
- "test",
".yalc/*",
".yalc/@*/*"
],
@@ -66,9 +59,36 @@
"husky": ">=6",
"lerna": "^4.0.0",
"lint-staged": ">=10",
- "prettier": "^2.3.1"
+ "prettier": "^2.3.1",
+ "eslint-plugin-import": "^2.24.2",
+ "eslint-plugin-monorepo": "^0.3.2",
+ "@typescript-eslint/eslint-plugin": "^4.28.1",
+ "@typescript-eslint/parser": "^4.28.1",
+ "eslint": "^7.29.0"
},
"lint-staged": {
"**/*.{ts,tsx,js,css,md}": "prettier --write"
+ },
+ "eslintConfig": {
+ "parser": "@typescript-eslint/parser",
+ "plugins": [
+ "@typescript-eslint",
+ "monorepo"
+ ],
+ "settings": {
+ "react": {
+ "version": "detect"
+ }
+ },
+ "rules": {
+ "monorepo/no-relative-import": "error"
+ },
+ "ignorePatterns": [
+ "node_modules",
+ "dist",
+ "coverage",
+ "*.d.ts",
+ "*.js"
+ ]
}
}
diff --git a/packages/@cdktf/hcl2cdk/jest.config.js b/packages/@cdktf/hcl2cdk/jest.config.js
index ae8f2789ca..fd01b50e45 100644
--- a/packages/@cdktf/hcl2cdk/jest.config.js
+++ b/packages/@cdktf/hcl2cdk/jest.config.js
@@ -1,7 +1,4 @@
module.exports = {
- "roots": [
- "/test"
- ],
testMatch: ['**/*.test.ts', '**/*.test.tsx'],
"transform": {
"^.+\\.tsx?$": "ts-jest"
diff --git a/packages/@cdktf/hcl2cdk/lib/expressions.ts b/packages/@cdktf/hcl2cdk/lib/expressions.ts
index 3eadd7a779..e445527240 100644
--- a/packages/@cdktf/hcl2cdk/lib/expressions.ts
+++ b/packages/@cdktf/hcl2cdk/lib/expressions.ts
@@ -2,7 +2,7 @@ import * as t from "@babel/types";
import reservedWords from "reserved-words";
import { camelCase, pascalCase } from "./utils";
import { TerraformResourceBlock, Scope } from "./types";
-import isValidDomain from "is-valid-domain";
+import { getResourceNamespace } from "@cdktf/provider-generator";
export type Reference = {
start: number;
@@ -224,31 +224,53 @@ export function variableName(
export function constructAst(type: string, isModuleImport: boolean) {
if (isModuleImport) {
- return t.memberExpression(
- t.identifier(pascalCase(type)),
- t.identifier(pascalCase(type))
- );
+ return t.memberExpression(t.identifier(type), t.identifier(type));
}
// resources or data sources
if (!type.includes("./") && type.includes(".")) {
const parts = type.split(".");
if (parts[0] === "data") {
+ const [_, provider, resource] = parts;
+ const namespace = getResourceNamespace(provider, resource);
+ if (namespace) {
+ return t.memberExpression(
+ t.memberExpression(
+ t.identifier(provider), // e.g. aws
+ t.identifier(namespace.name) // e.g. EC2
+ ),
+ t.identifier(pascalCase(`data_${provider}_${resource}`)) // e.g. DataAwsInstance
+ );
+ }
+
return t.memberExpression(
- t.identifier(parts[1]), // e.g. aws
- t.identifier(pascalCase(`data_${parts[1]}_${parts[2]}`)) // e.g. DataAwsNatGateway
+ t.identifier(provider), // e.g. aws
+ t.identifier(pascalCase(`data_${provider}_${resource}`)) // e.g. DataAwsNatGateway
+ );
+ }
+
+ const [provider, resource] = parts;
+ const namespace = getResourceNamespace(provider, resource);
+ if (namespace) {
+ return t.memberExpression(
+ t.memberExpression(
+ t.identifier(provider), // e.g. aws
+ t.identifier(namespace.name) // e.g. EC2
+ ),
+ t.identifier(pascalCase(resource)) // e.g. Instance
);
}
return t.memberExpression(
- t.identifier(parts[0]), // e.g. aws
- t.identifier(pascalCase(parts[1])) // e.g. NatGateway
+ t.identifier(provider), // e.g. google
+ t.identifier(pascalCase(resource)) // e.g. BigQueryTable
);
}
+
return t.identifier(pascalCase(type));
}
export function referenceToAst(scope: Scope, ref: Reference) {
- const [resource, _name, ...selector] = ref.referencee.full.split(".");
+ const [resource, , ...selector] = ref.referencee.full.split(".");
const variableReference = t.identifier(
camelCase(referenceToVariableName(scope, ref))
@@ -420,23 +442,3 @@ export function findUsedReferences(
[]
);
}
-
-// Logic from https://github.com/hashicorp/terraform/blob/e09b831f6ee35d37b11b8dcccd3a6d6f6db5e5ff/internal/addrs/module_source.go#L198
-export function isRegistryModule(source: string) {
- const parts = source.split("/");
- if (
- source.startsWith(".") ||
- parts.length < 3 ||
- parts.length > 4 ||
- source.includes("github.com") ||
- source.includes("bitbucket.org")
- ) {
- return false;
- }
-
- if (parts.length === 4 && !isValidDomain(parts[0])) {
- return false;
- }
-
- return true;
-}
diff --git a/packages/@cdktf/hcl2cdk/lib/generation.ts b/packages/@cdktf/hcl2cdk/lib/generation.ts
index 92a00a65eb..313638baac 100644
--- a/packages/@cdktf/hcl2cdk/lib/generation.ts
+++ b/packages/@cdktf/hcl2cdk/lib/generation.ts
@@ -22,8 +22,8 @@ import {
referenceToVariableName,
extractDynamicBlocks,
constructAst,
- isRegistryModule,
} from "./expressions";
+import { TerraformModuleConstraint } from "@cdktf/provider-generator";
function getReference(graph: DirectedGraph, id: string) {
const neighbors = graph.outNeighbors(id);
@@ -157,6 +157,43 @@ function addOverrideExpression(
return ast;
}
+function addOverrideLogicalIdExpression(variable: string, logicalId: string) {
+ const ast = t.expressionStatement(
+ t.callExpression(
+ t.memberExpression(
+ t.identifier(variable),
+ t.identifier("overrideLogicalId")
+ ),
+ [t.stringLiteral(logicalId)]
+ )
+ );
+
+ t.addComment(
+ ast,
+ "leading",
+ "This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match."
+ );
+
+ return ast;
+}
+
+function getRemoteStateType(item: Resource) {
+ const backendRecord = item.find((val) => val.backend);
+ if (backendRecord) {
+ const backend = backendRecord.backend;
+ switch (backend) {
+ case "remote":
+ return "";
+ case "etcdv3":
+ return "_etcd_v3";
+ default:
+ return `_${backend}`;
+ }
+ } else {
+ return "";
+ }
+}
+
export function resource(
scope: Scope,
type: string,
@@ -167,7 +204,10 @@ export function resource(
): t.Statement[] {
const [provider, ...name] = type.split("_");
const nodeIds = graph.nodes();
- const resource = `${provider}.${name.join("_")}`;
+ const resource =
+ provider === "data.terraform"
+ ? `cdktf.data_terraform_${name.join("_")}${getRemoteStateType(item)}`
+ : `${provider}.${name.join("_")}`;
const { for_each, count, ...config } = item[0];
const dynBlocks = extractDynamicBlocks(config);
@@ -191,6 +231,7 @@ export function resource(
config,
nodeIds,
false,
+ false,
getReference(graph, id) || overrideReference
),
];
@@ -215,17 +256,28 @@ you need to keep this like it is.`;
}
if (count) {
- const references = extractReferencesFromExpression(count, nodeIds, [
- "count",
- ]);
- expressions.push(
- addOverrideExpression(
- varName,
+ if (typeof count === "number") {
+ expressions.push(
+ addOverrideExpression(
+ varName,
+ "count",
+ valueToTs(scope, count, nodeIds),
+ loopComment
+ )
+ );
+ } else {
+ const references = extractReferencesFromExpression(count, nodeIds, [
"count",
- referencesToAst(scope, count, references),
- loopComment
- )
- );
+ ]);
+ expressions.push(
+ addOverrideExpression(
+ varName,
+ "count",
+ referencesToAst(scope, count, references),
+ loopComment
+ )
+ );
+ }
}
// Check for dynamic blocks
@@ -257,13 +309,17 @@ function asExpression(
config: TerraformResourceBlock,
nodeIds: string[],
isModuleImport: boolean,
+ isProvider: boolean,
reference?: Reference
) {
const { provider, providers, lifecycle, ...otherOptions } = config as any;
+ const constructId = uniqueId(scope.constructs, name);
+ const overrideId = !isProvider && constructId !== name;
+
const expression = t.newExpression(constructAst(type, isModuleImport), [
t.thisExpression(),
- t.stringLiteral(uniqueId(scope.constructs, name)),
+ t.stringLiteral(constructId),
valueToTs(scope, otherOptions, nodeIds),
]);
@@ -272,7 +328,7 @@ function asExpression(
? referenceToVariableName(scope, reference)
: variableName(scope, type, name);
- if (reference || providers || provider || lifecycle) {
+ if (reference || providers || provider || lifecycle || overrideId) {
statements.push(
t.variableDeclaration("const", [
t.variableDeclarator(t.identifier(varName), expression),
@@ -311,6 +367,10 @@ function asExpression(
);
}
+ if (overrideId) {
+ statements.push(addOverrideLogicalIdExpression(varName, name));
+ }
+
return statements;
}
@@ -334,6 +394,7 @@ export function output(
sensitive,
},
nodeIds,
+ false,
false
);
}
@@ -360,6 +421,7 @@ export function variable(
props,
nodeIds,
false,
+ false,
getReference(graph, id)
);
}
@@ -393,24 +455,15 @@ export function modules(
const [{ source, version, ...props }] = item;
const nodeIds = graph.nodes();
- if (isRegistryModule(source)) {
- return asExpression(
- scope,
- source,
- key,
- props,
- nodeIds,
- true,
- getReference(graph, id)
- );
- }
+ const moduleConstraint = new TerraformModuleConstraint(source);
return asExpression(
scope,
- "cdktf.TerraformHclModule",
+ moduleConstraint.className,
key,
- { ...props, source },
+ props,
nodeIds,
+ true,
false,
getReference(graph, id)
);
@@ -432,7 +485,8 @@ export function provider(
key,
props,
nodeIds,
- false
+ false,
+ true
);
}
@@ -449,15 +503,23 @@ export const providerImports = (providers: string[]) =>
)() as t.Statement;
});
-export const moduleImports = (modules: Record | undefined) =>
- Object.values(modules || {})
- .filter(([{ source }]) => isRegistryModule(source))
- .map(
- ([{ source }]) =>
- template(
- `import * as ${pascalCase(source)} from "./.gen/modules/${source}"`
- )() as t.Statement
+export const moduleImports = (modules: Record | undefined) => {
+ const uniqueModules = new Set();
+ Object.values(modules || {}).map(([module]) =>
+ uniqueModules.add(module.source)
+ );
+
+ const imports: t.Statement[] = [];
+ uniqueModules.forEach((m) => {
+ const moduleConstraint = new TerraformModuleConstraint(m);
+ imports.push(
+ template.ast(
+ `import * as ${moduleConstraint.className} from "./.gen/modules/${moduleConstraint.fileName}"`
+ ) as t.Statement
);
+ });
+ return imports;
+};
export function gen(statements: t.Statement[]) {
return prettier.format(generate(t.program(statements) as any).code, {
diff --git a/packages/@cdktf/hcl2cdk/lib/index.ts b/packages/@cdktf/hcl2cdk/lib/index.ts
index 23569da0a8..0665da0526 100644
--- a/packages/@cdktf/hcl2cdk/lib/index.ts
+++ b/packages/@cdktf/hcl2cdk/lib/index.ts
@@ -1,4 +1,5 @@
import { parse } from "@cdktf/hcl2json";
+import { isRegistryModule } from "@cdktf/provider-generator";
import * as t from "@babel/types";
import prettier from "prettier";
import * as path from "path";
@@ -9,7 +10,7 @@ import * as rosetta from "jsii-rosetta";
import * as z from "zod";
import { schema } from "./schema";
-import { findUsedReferences, isRegistryModule } from "./expressions";
+import { findUsedReferences } from "./expressions";
import {
backendToExpression,
cdktfImport,
@@ -191,9 +192,9 @@ ${JSON.stringify((err as z.ZodError).errors)}`);
// In Terraform one can implicitly define the provider by using resources of that type
const explicitProviders = Object.keys(plan.provider || {});
- const implicitProviders = Object.keys({ ...plan.resource, ...plan.data }).map(
- (type) => type.split("_")[0]
- );
+ const implicitProviders = Object.keys({ ...plan.resource, ...plan.data })
+ .filter((type) => type !== "terraform_remote_state")
+ .map((type) => type.split("_")[0]);
const providerRequirements = Array.from(
new Set([...explicitProviders, ...implicitProviders])
@@ -218,27 +219,29 @@ ${JSON.stringify((err as z.ZodError).errors)}`);
);
// We collect all module sources
- const moduleRequirements = (
- Object.values(plan.module || {}).reduce(
- (carry, moduleBlock) => [
- ...carry,
- ...moduleBlock.reduce(
- (arr, { source }) => [...arr, source],
- [] as string[]
- ),
- ],
- [] as string[]
- ) || []
- ).filter((source) => isRegistryModule(source));
+ const moduleRequirements = [
+ ...new Set(
+ Object.values(plan.module || {}).reduce(
+ (carry, moduleBlock) => [
+ ...carry,
+ ...moduleBlock.reduce(
+ (arr, { source, version }) => [
+ ...arr,
+ version ? `${source}@${version}` : source,
+ ],
+ [] as string[]
+ ),
+ ],
+ [] as string[]
+ ) || []
+ ),
+ ];
// Variables, Outputs, and Backends are defined in the CDKTF project so we need to import from it
// If none are used we don't want to leave a stray import
const cdktfImports =
plan.terraform?.some((tf) => Object.keys(tf.backend || {}).length > 0) ||
- Object.keys({ ...plan.variable, ...plan.output }).length > 0 ||
- Object.values(plan.module || {}).filter(
- ([{ source }]) => !isRegistryModule(source)
- ).length > 0
+ Object.keys({ ...plan.variable, ...plan.output }).length > 0
? [cdktfImport]
: ([] as t.Statement[]);
@@ -371,3 +374,5 @@ export async function convertProject(
stats,
};
}
+
+export { isRegistryModule };
diff --git a/packages/@cdktf/hcl2cdk/package.json b/packages/@cdktf/hcl2cdk/package.json
index 49ebdb726b..779e923c36 100644
--- a/packages/@cdktf/hcl2cdk/package.json
+++ b/packages/@cdktf/hcl2cdk/package.json
@@ -30,12 +30,12 @@
"@babel/generator": "^7.14.5",
"@babel/template": "^7.14.5",
"@babel/types": "^7.14.5",
- "@cdktf/hcl2json": "*",
+ "@cdktf/hcl2json": "0.0.0",
+ "@cdktf/provider-generator": "0.0.0",
"camelcase": "^6.2.0",
"glob": "7.1.7",
"graphology": "^0.20.0",
"graphology-types": "^0.19.2",
- "is-valid-domain": "^0.1.2",
"jsii-rosetta": "^1.30.0",
"prettier": "^2.3.1",
"reserved-words": "^0.1.2",
@@ -47,6 +47,7 @@
"@types/node": "^14.0.0",
"@types/reserved-words": "^0.1.0",
"jest": "^26.6.3",
- "typescript": "^4.2.2"
+ "typescript": "^4.2.2",
+ "ts-jest": "^26.4.4"
}
}
diff --git a/packages/@cdktf/hcl2cdk/test/__snapshots__/hcl2cdk.test.ts.snap b/packages/@cdktf/hcl2cdk/test/__snapshots__/hcl2cdk.test.ts.snap
index bc1d6ff8d3..9ee9332040 100644
--- a/packages/@cdktf/hcl2cdk/test/__snapshots__/hcl2cdk.test.ts.snap
+++ b/packages/@cdktf/hcl2cdk/test/__snapshots__/hcl2cdk.test.ts.snap
@@ -32,33 +32,22 @@ new auth0.Auth0Provider(this, \\"auth0_2\\", {
`;
exports[`convert all module types configuration 1`] = `
-"import * as cdktf from \\"cdktf\\";
-import * as AppTerraformIoExampleCorpK8SClusterAzurerm from \\"./.gen/modules/app.terraform.io/example-corp/k8s-cluster/azurerm\\";
-import * as HashicorpConsulAws from \\"./.gen/modules/hashicorp/consul/aws\\";
-new cdktf.TerraformHclModule(this, \\"consul\\", {
- source: \\"./consul\\",
-});
-new cdktf.TerraformHclModule(this, \\"consul-butbucket\\", {
- source: \\"bitbucket.org/hashicorp/terraform-consul-aws\\",
-});
-new cdktf.TerraformHclModule(this, \\"consul-git\\", {
- source: \\"git@github.com:hashicorp/example.git\\",
-});
-new cdktf.TerraformHclModule(this, \\"consul-github\\", {
- source: \\"github.com/hashicorp/example\\",
-});
-new AppTerraformIoExampleCorpK8SClusterAzurerm.AppTerraformIoExampleCorpK8SClusterAzurerm(
- this,
- \\"consul-hosted-registry\\",
- {}
-);
-new HashicorpConsulAws.HashicorpConsulAws(this, \\"consul-registry\\", {});
-new cdktf.TerraformHclModule(this, \\"storage\\", {
- source: \\"git::ssh://username@example.com/storage.git\\",
-});
-new cdktf.TerraformHclModule(this, \\"vpc\\", {
- source: \\"git::https://example.com/vpc.git\\",
-});
+"import * as Consul from \\"./.gen/modules/consul\\";
+import * as TerraformConsulAws from \\"./.gen/modules/hashicorp/terraform-consul-aws\\";
+import * as Example from \\"./.gen/modules/hashicorp/example\\";
+import * as Example from \\"./.gen/modules/hashicorp/example\\";
+import * as K8SCluster from \\"./.gen/modules/example-corp/azurerm/k8s-cluster\\";
+import * as Consul from \\"./.gen/modules/hashicorp/aws/consul\\";
+import * as Storage from \\"./.gen/modules/storage\\";
+import * as Vpc from \\"./.gen/modules/vpc\\";
+new Consul.Consul(this, \\"consul\\", {});
+new TerraformConsulAws.TerraformConsulAws(this, \\"consul-butbucket\\", {});
+new Example.Example(this, \\"consul-git\\", {});
+new Example.Example(this, \\"consul-github\\", {});
+new K8SCluster.K8SCluster(this, \\"consul-hosted-registry\\", {});
+new Consul.Consul(this, \\"consul-registry\\", {});
+new Storage.Storage(this, \\"storage\\", {});
+new Vpc.Vpc(this, \\"vpc\\", {});
"
`;
@@ -102,11 +91,11 @@ exports[`convert complex for each loops configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-const awsAcmCertificateExample = new aws.AcmCertificate(this, \\"example\\", {
+const awsAcmCertificateExample = new aws.ACM.AcmCertificate(this, \\"example\\", {
domainName: \\"example.com\\",
validationMethod: \\"DNS\\",
});
-const dataAwsRoute53ZoneExample = new aws.DataAwsRoute53Zone(
+const dataAwsRoute53ZoneExample = new aws.Route53.DataAwsRoute53Zone(
this,
\\"example_1\\",
{
@@ -114,14 +103,24 @@ const dataAwsRoute53ZoneExample = new aws.DataAwsRoute53Zone(
privateZone: false,
}
);
-const awsRoute53RecordExample = new aws.Route53Record(this, \\"example_2\\", {
- allowOverwrite: true,
- name: \\"\${each.value.name}\\",
- records: [\\"\${each.value.record}\\"],
- ttl: 60,
- type: \\"\${each.value.type}\\",
- zoneId: dataAwsRoute53ZoneExample.zoneId,
-});
+
+/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
+dataAwsRoute53ZoneExample.overrideLogicalId(\\"example\\");
+const awsRoute53RecordExample = new aws.Route53.Route53Record(
+ this,
+ \\"example_2\\",
+ {
+ allowOverwrite: true,
+ name: \\"\${each.value.name}\\",
+ records: [\\"\${each.value.record}\\"],
+ ttl: 60,
+ type: \\"\${each.value.type}\\",
+ zoneId: dataAwsRoute53ZoneExample.zoneId,
+ }
+);
+
+/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
+awsRoute53RecordExample.overrideLogicalId(\\"example\\");
/*In most cases loops should be handled in the programming language context and
not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input
@@ -137,7 +136,7 @@ awsRoute53RecordExample.addOverride(
}
}}\`
);
-const awsAcmCertificateValidationExample = new aws.AcmCertificateValidation(
+const awsAcmCertificateValidationExample = new aws.ACM.AcmCertificateValidation(
this,
\\"example_3\\",
{
@@ -145,9 +144,15 @@ const awsAcmCertificateValidationExample = new aws.AcmCertificateValidation(
validationRecordFqdns: \`\\\\\${[for record in \${awsRoute53RecordExample.fqn} : record.fqdn]}\`,
}
);
-new aws.LbListener(this, \\"example_4\\", {
+
+/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
+awsAcmCertificateValidationExample.overrideLogicalId(\\"example\\");
+const awsLbListenerExample = new aws.ELB.LbListener(this, \\"example_4\\", {
certificateArn: awsAcmCertificateValidationExample.certificateArn,
});
+
+/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
+awsLbListenerExample.overrideLogicalId(\\"example\\");
"
`;
@@ -155,7 +160,7 @@ exports[`convert complex resource configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-new aws.CloudfrontDistribution(this, \\"s3_distribution\\", {
+new aws.CloudFront.CloudfrontDistribution(this, \\"s3_distribution\\", {
aliases: [\\"mysite.example.com\\", \\"yoursite.example.com\\"],
comment: \\"Some comment\\",
defaultCacheBehavior: [
@@ -281,15 +286,15 @@ exports[`convert conditionals configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-const awsKmsKeyExamplekms = new aws.KmsKey(this, \\"examplekms\\", {
+const awsKmsKeyExamplekms = new aws.KMS.KmsKey(this, \\"examplekms\\", {
deletionWindowInDays: 7,
description: \\"KMS key 1\\",
});
-const awsS3BucketExamplebucket = new aws.S3Bucket(this, \\"examplebucket\\", {
+const awsS3BucketExamplebucket = new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \\"examplebuckettftest\\",
});
-new aws.S3BucketObject(this, \\"examplebucket_object\\", {
+new aws.S3.S3BucketObject(this, \\"examplebucket_object\\", {
bucket: \`\\\\\${\${awsKmsKeyExamplekms.deletionWindowInDays} > 3 ? \${awsS3BucketExamplebucket.id} : []}\`,
key: \\"someobject\\",
kmsKeyId: awsKmsKeyExamplekms.arn,
@@ -308,7 +313,7 @@ import * as aws from \\"./.gen/providers/aws\\";
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const users = new cdktf.TerraformVariable(this, \\"users\\", {});
-const awsIamUserLb = new aws.IamUser(this, \\"lb\\", {
+const awsIamUserLb = new aws.IAM.IamUser(this, \\"lb\\", {
name: \`\\\\\${element(\${users.value}, count.index)}\`,
path: \\"/system/\\",
tags: {
@@ -346,7 +351,7 @@ You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/
const bucketName = new cdktf.TerraformVariable(this, \\"bucket_name\\", {
default: \\"demo\\",
});
-const dataAwsS3BucketExamplebucket = new aws.DataAwsS3Bucket(
+const dataAwsS3BucketExamplebucket = new aws.S3.DataAwsS3Bucket(
this,
\\"examplebucket\\",
{
@@ -354,7 +359,7 @@ const dataAwsS3BucketExamplebucket = new aws.DataAwsS3Bucket(
bucket: bucketName.value,
}
);
-new aws.S3BucketObject(this, \\"examplebucket_object\\", {
+new aws.S3.S3BucketObject(this, \\"examplebucket_object\\", {
bucket: dataAwsS3BucketExamplebucket.arn,
key: \\"someobject\\",
source: \\"index.html\\",
@@ -374,7 +379,7 @@ You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/
const bucketName = new cdktf.TerraformVariable(this, \\"bucket_name\\", {
default: \\"demo\\",
});
-new aws.S3Bucket(this, \\"examplebucket\\", {
+new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: bucketName.value,
tags: {
@@ -384,6 +389,17 @@ new aws.S3Bucket(this, \\"examplebucket\\", {
"
`;
+exports[`convert duplicate modules configuration 1`] = `
+"import * as Vpc from \\"./.gen/modules/terraform-aws-modules/aws/vpc\\";
+new Vpc.Vpc(this, \\"vpca\\", {
+ name: \\"my-vpc-a\\",
+});
+new Vpc.Vpc(this, \\"vpcb\\", {
+ name: \\"my-vpc-b\\",
+});
+"
+`;
+
exports[`convert dynamic blocks configuration 1`] = `
"import * as cdktf from \\"cdktf\\";
@@ -396,7 +412,7 @@ You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/
const namespace = new cdktf.TerraformVariable(this, \\"namespace\\", {});
const settings = new cdktf.TerraformVariable(this, \\"settings\\", {});
const awsElasticBeanstalkEnvironmentTfenvtest =
- new aws.ElasticBeanstalkEnvironment(this, \\"tfenvtest\\", {
+ new aws.ElasticBeanstalk.ElasticBeanstalkEnvironment(this, \\"tfenvtest\\", {
application: \\"best-app\\",
setting: [],
name: \\"tf-test-name\\",
@@ -438,11 +454,11 @@ import * as aws from \\"./.gen/providers/aws\\";
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const buckets = new cdktf.TerraformVariable(this, \\"buckets\\", {});
-const awsKmsKeyExamplekms = new aws.KmsKey(this, \\"examplekms\\", {
+const awsKmsKeyExamplekms = new aws.KMS.KmsKey(this, \\"examplekms\\", {
deletionWindowInDays: 7,
description: \\"KMS key 1\\",
});
-const awsS3BucketExamplebucket = new aws.S3Bucket(this, \\"examplebucket\\", {
+const awsS3BucketExamplebucket = new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \\"\${each.key}\\",
});
@@ -455,7 +471,7 @@ awsS3BucketExamplebucket.addOverride(
\\"for_each\\",
\`\\\\\${toset(\${buckets.value}.*)}\`
);
-const awsS3BucketObjectExamplebucketObject = new aws.S3BucketObject(
+const awsS3BucketObjectExamplebucketObject = new aws.S3.S3BucketObject(
this,
\\"examplebucket_object\\",
{
@@ -539,7 +555,7 @@ import * as aws from \\"./.gen/providers/aws\\";
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const users = new cdktf.TerraformVariable(this, \\"users\\", {});
-const awsIamUserLb = new aws.IamUser(this, \\"lb\\", {
+const awsIamUserLb = new aws.IAM.IamUser(this, \\"lb\\", {
name: \\"\${each.key}\\",
path: \\"/system/\\",
tags: {
@@ -610,7 +626,7 @@ import * as aws from \\"./.gen/providers/aws\\";
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const settings = new cdktf.TerraformVariable(this, \\"settings\\", {});
-new aws.S3Bucket(this, \\"examplebucket\\", {
+new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \`\\\\\${\${settings.value}[0][\\"bucket_name\\"]}\`,
});
@@ -626,10 +642,8 @@ new cdktf.LocalBackend(this, {
`;
exports[`convert local module configuration 1`] = `
-"import * as cdktf from \\"cdktf\\";
-new cdktf.TerraformHclModule(this, \\"aws_vpc\\", {
- source: \\"./aws_vpc\\",
-});
+"import * as AwsVpc from \\"./.gen/modules/aws_vpc\\";
+new AwsVpc.AwsVpc(this, \\"aws_vpc\\", {});
"
`;
@@ -650,7 +664,7 @@ exports[`convert locals references configuration 1`] = `
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
const bucketName = \\"foo\\";
-new aws.S3Bucket(this, \\"examplebucket\\", {
+new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: bucketName,
});
@@ -658,8 +672,8 @@ new aws.S3Bucket(this, \\"examplebucket\\", {
`;
exports[`convert modules configuration 1`] = `
-"import * as TerraformAwsModulesVpcAws from \\"./.gen/modules/terraform-aws-modules/vpc/aws\\";
-new TerraformAwsModulesVpcAws.TerraformAwsModulesVpcAws(this, \\"vpc\\", {
+"import * as Vpc from \\"./.gen/modules/terraform-aws-modules/aws/vpc\\";
+new Vpc.Vpc(this, \\"vpc\\", {
azs: [\\"eu-west-1a\\", \\"eu-west-1b\\", \\"eu-west-1c\\"],
cidr: \\"10.0.0.0/16\\",
enableNatGateway: true,
@@ -679,7 +693,7 @@ exports[`convert multiple blocks configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-new aws.SecurityGroup(this, \\"allow_tls\\", {
+new aws.VPC.SecurityGroup(this, \\"allow_tls\\", {
description: \\"Allow TLS inbound traffic\\",
egress: [
{
@@ -803,7 +817,7 @@ import * as aws from \\"./.gen/providers/aws\\";
/*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const settings = new cdktf.TerraformVariable(this, \\"settings\\", {});
-new aws.S3Bucket(this, \\"examplebucket\\", {
+new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \`\\\\\${\${settings.value}[\\"bucket_name\\"]}\`,
});
@@ -814,7 +828,7 @@ exports[`convert provider alias configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-import * as TerraformAwsModulesVpcAws from \\"./.gen/modules/terraform-aws-modules/vpc/aws\\";
+import * as Vpc from \\"./.gen/modules/terraform-aws-modules/aws/vpc\\";
new aws.AwsProvider(this, \\"aws\\", {
region: \\"us-east-1\\",
});
@@ -822,12 +836,11 @@ new aws.AwsProvider(this, \\"aws_1\\", {
alias: \\"west\\",
region: \\"us-west-2\\",
});
-const terraformAwsModulesVpcAwsVpc =
- new TerraformAwsModulesVpcAws.TerraformAwsModulesVpcAws(this, \\"vpc\\", {});
-terraformAwsModulesVpcAwsVpc.addOverride(\\"providers\\", {
+const vpcVpc = new Vpc.Vpc(this, \\"vpc\\", {});
+vpcVpc.addOverride(\\"providers\\", {
aws: \`\\\\\${\${awsWest.fqn}}\`,
});
-const awsInstanceFoo = new aws.Instance(this, \\"foo\\", {
+const awsInstanceFoo = new aws.EC2.Instance(this, \\"foo\\", {
foo: \\"bar\\",
});
awsInstanceFoo.addOverride(\\"provider\\", \`\\\\\${\${awsWest.fqn}}\`);
@@ -874,24 +887,20 @@ new auth0.Auth0Provider(this, \\"auth0\\", {
exports[`convert referenced modules configuration 1`] = `
"import * as cdktf from \\"cdktf\\";
-import * as TerraformAwsModulesVpcAws from \\"./.gen/modules/terraform-aws-modules/vpc/aws\\";
-const vpc = new TerraformAwsModulesVpcAws.TerraformAwsModulesVpcAws(
- this,
- \\"vpc\\",
- {
- azs: [\\"eu-west-1a\\", \\"eu-west-1b\\", \\"eu-west-1c\\"],
- cidr: \\"10.0.0.0/16\\",
- enableNatGateway: true,
- enableVpnGateway: true,
- name: \\"my-vpc\\",
- privateSubnets: [\\"10.0.1.0/24\\", \\"10.0.2.0/24\\", \\"10.0.3.0/24\\"],
- publicSubnets: [\\"10.0.101.0/24\\", \\"10.0.102.0/24\\", \\"10.0.103.0/24\\"],
- tags: {
- environment: \\"dev\\",
- terraform: \\"true\\",
- },
- }
-);
+import * as Vpc from \\"./.gen/modules/terraform-aws-modules/aws/vpc\\";
+const vpc = new Vpc.Vpc(this, \\"vpc\\", {
+ azs: [\\"eu-west-1a\\", \\"eu-west-1b\\", \\"eu-west-1c\\"],
+ cidr: \\"10.0.0.0/16\\",
+ enableNatGateway: true,
+ enableVpnGateway: true,
+ name: \\"my-vpc\\",
+ privateSubnets: [\\"10.0.1.0/24\\", \\"10.0.2.0/24\\", \\"10.0.3.0/24\\"],
+ publicSubnets: [\\"10.0.101.0/24\\", \\"10.0.102.0/24\\", \\"10.0.103.0/24\\"],
+ tags: {
+ environment: \\"dev\\",
+ terraform: \\"true\\",
+ },
+});
new cdktf.TerraformOutput(this, \\"subnet_ids\\", {
value: vpc.publicSubnetsOutput,
});
@@ -913,6 +922,43 @@ new cdktf.RemoteBackend(this, {
"
`;
+exports[`convert remote state configuration 1`] = `
+"new cdktf.DataTerraformRemoteState(this, \\"vpc\\", {
+ backend: \\"remote\\",
+ config: [
+ {
+ organization: \\"hashicorp\\",
+ workspaces: [
+ {
+ name: \\"vpc-prod\\",
+ },
+ ],
+ },
+ ],
+});
+"
+`;
+
+exports[`convert remote state types configuration 1`] = `
+"new cdktf.DataTerraformRemoteStateEtcdV3(this, \\"etcdv3\\", {
+ backend: \\"etcdv3\\",
+ config: [
+ {
+ prefix: \\"terraform-state/\\",
+ },
+ ],
+});
+new cdktf.DataTerraformRemoteStateS3(this, \\"s3\\", {
+ backend: \\"s3\\",
+ config: [
+ {
+ bucket: \\"mybucket\\",
+ },
+ ],
+});
+"
+`;
+
exports[`convert required namespaced provider configuration 1`] = `
"import * as cdktf from \\"cdktf\\";
@@ -935,15 +981,15 @@ exports[`convert resource references configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-const awsKmsKeyExamplekms = new aws.KmsKey(this, \\"examplekms\\", {
+const awsKmsKeyExamplekms = new aws.KMS.KmsKey(this, \\"examplekms\\", {
deletionWindowInDays: 7,
description: \\"KMS key 1\\",
});
-const awsS3BucketExamplebucket = new aws.S3Bucket(this, \\"examplebucket\\", {
+const awsS3BucketExamplebucket = new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \\"examplebuckettftest\\",
});
-new aws.S3BucketObject(this, \\"examplebucket_object\\", {
+new aws.S3.S3BucketObject(this, \\"examplebucket_object\\", {
bucket: awsS3BucketExamplebucket.id,
key: \\"someobject\\",
kmsKeyId: awsKmsKeyExamplekms.arn,
@@ -956,15 +1002,15 @@ exports[`convert resource references with HCL functions configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-const awsKmsKeyExamplekms = new aws.KmsKey(this, \\"examplekms\\", {
+const awsKmsKeyExamplekms = new aws.KMS.KmsKey(this, \\"examplekms\\", {
deletionWindowInDays: 7,
description: \\"KMS key 1\\",
});
-const awsS3BucketExamplebucket = new aws.S3Bucket(this, \\"examplebucket\\", {
+const awsS3BucketExamplebucket = new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: \\"examplebuckettftest\\",
});
-new aws.S3BucketObject(this, \\"examplebucket_object\\", {
+new aws.S3.S3BucketObject(this, \\"examplebucket_object\\", {
bucket: \`\\\\\${element(\${awsS3BucketExamplebucket.fqn}, 0).id}\`,
key: \\"someobject\\",
kmsKeyId: awsKmsKeyExamplekms.arn,
@@ -980,9 +1026,12 @@ exports[`convert same name local, var, out configuration 1`] = `
You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/terraform-variables.md*/
const test = new cdktf.TerraformVariable(this, \\"test\\", {});
const localTest = \`\\\\\${\${test.value}} + 1\`;
-new cdktf.TerraformOutput(this, \\"test_1\\", {
+const cdktfTerraformOutputTest = new cdktf.TerraformOutput(this, \\"test_1\\", {
value: localTest,
});
+
+/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
+cdktfTerraformOutputTest.overrideLogicalId(\\"test\\");
"
`;
@@ -995,11 +1044,35 @@ new cdktf.TerraformOutput(this, \\"cidr_out\\", {
"
`;
+exports[`convert simple count configuration 1`] = `
+"/*Provider bindings are generated by running cdktf get.
+See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
+import * as aws from \\"./.gen/providers/aws\\";
+const awsInstanceMultipleServers = new aws.EC2.Instance(
+ this,
+ \\"multiple_servers\\",
+ {
+ ami: \\"ami-0c2b8ca1dad447f8a\\",
+ instanceType: \\"t2.micro\\",
+ tags: {
+ name: \\"Server \${count.index}\\",
+ },
+ }
+);
+
+/*In most cases loops should be handled in the programming language context and
+not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input
+you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source
+you need to keep this like it is.*/
+awsInstanceMultipleServers.addOverride(\\"count\\", 4);
+"
+`;
+
exports[`convert simple data source configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-new aws.DataAwsSubnet(this, \\"selected\\", {
+new aws.VPC.DataAwsSubnet(this, \\"selected\\", {
id: \\"subnet_id\\",
});
"
@@ -1009,17 +1082,16 @@ exports[`convert simple resource configuration 1`] = `
"/*Provider bindings are generated by running cdktf get.
See https://github.com/hashicorp/terraform-cdk/blob/main/docs/working-with-cdk-for-terraform/using-providers.md#importing-providers-and-modules for more details.*/
import * as aws from \\"./.gen/providers/aws\\";
-new aws.Vpc(this, \\"example\\", {
+new aws.VPC.Vpc(this, \\"example\\", {
cidrBlock: \\"10.0.0.0/16\\",
});
"
`;
exports[`convert terraform workspace configuration 1`] = `
-"import * as cdktf from \\"cdktf\\";
-new cdktf.TerraformHclModule(this, \\"example\\", {
+"import * as MyModule from \\"./.gen/modules/my-module\\";
+new MyModule.MyModule(this, \\"example\\", {
namePrefix: \\"app-\${terraform.workspace}\\",
- source: \\"./my-module\\",
});
"
`;
@@ -1036,7 +1108,7 @@ You can read more about this at https://github.com/hashicorp/terraform-cdk/blob/
const bucketName = new cdktf.TerraformVariable(this, \\"bucket_name\\", {
default: \\"demo\\",
});
-new aws.S3Bucket(this, \\"examplebucket\\", {
+new aws.S3.S3Bucket(this, \\"examplebucket\\", {
acl: \\"private\\",
bucket: bucketName.value,
});
diff --git a/packages/@cdktf/hcl2cdk/test/convertProject.test.ts b/packages/@cdktf/hcl2cdk/test/convertProject.test.ts
index ab1d6d9dbc..16dcc3ae68 100644
--- a/packages/@cdktf/hcl2cdk/test/convertProject.test.ts
+++ b/packages/@cdktf/hcl2cdk/test/convertProject.test.ts
@@ -62,13 +62,13 @@ app.synth();`,
"node": ">=10.12"
},
"dependencies": {
- "cdktf": "*",
+ "cdktf": "next",
"constructs": "^10.0.5"
},
"devDependencies": {
"@types/node": "^14.0.26",
"typescript": "^3.9.7",
- "cdktf-cli": "*"
+ "cdktf-cli": "next"
}
}`,
],
diff --git a/packages/@cdktf/hcl2cdk/test/hcl2cdk.test.ts b/packages/@cdktf/hcl2cdk/test/hcl2cdk.test.ts
index 58a904977d..02ff3cfe0b 100644
--- a/packages/@cdktf/hcl2cdk/test/hcl2cdk.test.ts
+++ b/packages/@cdktf/hcl2cdk/test/hcl2cdk.test.ts
@@ -309,6 +309,21 @@ describe("convert", () => {
}
}`,
],
+ [
+ "duplicate modules",
+ `
+ module "vpca" {
+ source = "terraform-aws-modules/vpc/aws"
+
+ name = "my-vpc-a"
+ }
+
+ module "vpcb" {
+ source = "terraform-aws-modules/vpc/aws"
+
+ name = "my-vpc-b"
+ }`,
+ ],
[
"referenced modules",
`
@@ -537,6 +552,21 @@ describe("convert", () => {
}
}`,
],
+ [
+ "simple count",
+ `
+ resource "aws_instance" "multiple_servers" {
+ count = 4
+
+ ami = "ami-0c2b8ca1dad447f8a"
+ instance_type = "t2.micro"
+
+ tags = {
+ Name = "Server \${count.index}"
+ }
+ }
+ `,
+ ],
[
"dynamic blocks",
`
@@ -887,6 +917,41 @@ describe("convert", () => {
}
`,
],
+ [
+ "remote state",
+ `
+ data "terraform_remote_state" "vpc" {
+ backend = "remote"
+
+ config = {
+ organization = "hashicorp"
+ workspaces = {
+ name = "vpc-prod"
+ }
+ }
+ }
+ `,
+ ],
+ [
+ "remote state types",
+ `
+ data "terraform_remote_state" "etcdv3" {
+ backend = "etcdv3"
+
+ config = {
+ prefix = "terraform-state/"
+ }
+ }
+
+ data "terraform_remote_state" "s3" {
+ backend = "s3"
+
+ config = {
+ bucket = "mybucket"
+ }
+ }
+ `,
+ ],
])("%s configuration", async (_name, hcl) => {
const { all } = await convert(hcl, {
language: "typescript",
diff --git a/packages/@cdktf/hcl2json/jest.config.js b/packages/@cdktf/hcl2json/jest.config.js
index ae8f2789ca..fd01b50e45 100644
--- a/packages/@cdktf/hcl2json/jest.config.js
+++ b/packages/@cdktf/hcl2json/jest.config.js
@@ -1,7 +1,4 @@
module.exports = {
- "roots": [
- "/test"
- ],
testMatch: ['**/*.test.ts', '**/*.test.tsx'],
"transform": {
"^.+\\.tsx?$": "ts-jest"
diff --git a/packages/@cdktf/hcl2json/lib/index.ts b/packages/@cdktf/hcl2json/lib/index.ts
index 53bfdce64c..163ac9ed87 100644
--- a/packages/@cdktf/hcl2json/lib/index.ts
+++ b/packages/@cdktf/hcl2json/lib/index.ts
@@ -19,7 +19,9 @@ interface GoBridge {
const jsRoot: Record = {};
function sleep() {
- return new Promise(global.setImmediate);
+ return new Promise((resolve) => {
+ setTimeout(resolve, 0);
+ });
}
function goBridge(getBytes: Promise) {
diff --git a/packages/@cdktf/hcl2json/package.json b/packages/@cdktf/hcl2json/package.json
index 102d94bbeb..f00e487612 100644
--- a/packages/@cdktf/hcl2json/package.json
+++ b/packages/@cdktf/hcl2json/package.json
@@ -35,6 +35,7 @@
"@types/jest": "^26.0.20",
"@types/node": "^14.0.0",
"jest": "^26.6.3",
- "typescript": "^4.2.2"
+ "typescript": "^4.2.2",
+ "ts-jest": "^26.4.4"
}
}
diff --git a/packages/@cdktf/provider-generator/.gitignore b/packages/@cdktf/provider-generator/.gitignore
new file mode 100644
index 0000000000..e68455a6fa
--- /dev/null
+++ b/packages/@cdktf/provider-generator/.gitignore
@@ -0,0 +1,4 @@
+**/*.d.ts.map
+**/*.js.map
+tsconfig.tsbuildinfo
+!tsconfig.json
\ No newline at end of file
diff --git a/packages/@cdktf/provider-generator/README.md b/packages/@cdktf/provider-generator/README.md
new file mode 100644
index 0000000000..669205bafa
--- /dev/null
+++ b/packages/@cdktf/provider-generator/README.md
@@ -0,0 +1,24 @@
+# @cdktf/provider-generator
+
+`@cdktf/provider-generator` exposes an API to generate Terraform CDK provider bindings.
+
+## Usage
+
+```sh
+yarn install @cdktf/provider-generator
+```
+
+### Generate bindings
+
+```ts
+const constructsMaker = new ConstructsMaker(
+ constructsOptions,
+ constraints,
+ (payload: { targetLanguage: string; trackingPayload: Record }) =>
+ sendTelemetry("get", {
+ language: payload.targetLanguage,
+ ...payload.trackingPayload,
+ })
+);
+await constructsMaker.generate();
+```
diff --git a/packages/@cdktf/provider-generator/jest.config.js b/packages/@cdktf/provider-generator/jest.config.js
new file mode 100644
index 0000000000..fd01b50e45
--- /dev/null
+++ b/packages/@cdktf/provider-generator/jest.config.js
@@ -0,0 +1,11 @@
+module.exports = {
+ testMatch: ['**/*.test.ts', '**/*.test.tsx'],
+ "transform": {
+ "^.+\\.tsx?$": "ts-jest"
+ },
+ moduleFileExtensions: [
+ "js",
+ "ts",
+ "tsx"
+ ],
+}
diff --git a/packages/@cdktf/provider-generator/lib/config.test.ts b/packages/@cdktf/provider-generator/lib/config.test.ts
new file mode 100644
index 0000000000..f94ce33289
--- /dev/null
+++ b/packages/@cdktf/provider-generator/lib/config.test.ts
@@ -0,0 +1,746 @@
+import { parseConfig } from "../lib/config";
+import * as fs from "fs-extra";
+import * as os from "os";
+import * as path from "path";
+
+export async function mkdtemp(closure: (dir: string) => Promise