Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): remove adapter part #1157

Merged
merged 2 commits into from
Oct 18, 2021
Merged

chore(docs): remove adapter part #1157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c482002
chore(docs): remove adapter part
DanielMSchmidt Oct 18, 2021
d1232ad
Merge branch 'main' into review-testing
schersh Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 1 addition & 18 deletions website/docs/cdktf/test/unit-tests.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Write assertions and snapshot tests for your CDK for Terraform app

# Unit Tests

Testing your application can give you faster feedback cycles and guard you against unwanted changes. Currently, testing in Typescript with jest is best supported, but refer to [write your own adapter](#write-your-own-adapter) to see how you can use your favorite test framework.
Testing your application can give you faster feedback cycles and guard you against unwanted changes. Currently, testing is only supported in 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). Then, you need to add these lines in a [setup file](https://jestjs.io/docs/configuration#setupfiles-array):

Expand Down Expand Up @@ -104,23 +104,6 @@ describe("Checking validity", () => {
});
```

## Write Your Own Adapter

We export the matchers so that you can use them in the context of your preferred testing framework. You can import the object `testingMatchers` / `testing_matchers` (for Python) and use the matchers (e.g. `toPlanSuccessfully` / `to_plan_successfully`) directly as functions.

This is an example of how this might look in Python. Please be aware that this is untested code.

```py
from cdktf import testing, testing_matchers
from . import MyStack, MyResource
from imports.aws import SnsTopic

def test_my_resource_has_sns_topic():
synthesized = testing.synthScope(lambda scope: MyResource(scope, "my-resource", "my-param"))
assertion = testing_matchers.toHaveResourceWithProperties(synthesized, SnsTopic)
assert assertion.pass
```

## Integration Testing

CDK for Terraform does not currently offer many helpers for integration testing, but you can create them for your use cases. Here is a recent example: [CDK Day 2021](https://github.com/ansgarm/talk-cdkday-2021/tree/master/test).