feat(lib): exposed testing matchers for other languages properly #1935

Maed223 · 2022-07-19T00:19:10Z

Testing matchers placed in class for jsii exposure

DanielMSchmidt

Some smaller things

test/csharp/testing-matchers/test.ts

This reverts commit 1258245.

This reverts commit a9cc009.

jsteinich

I mostly focused on the C# and Java pieces since I'm not familiar with unit testing in Python or Go.
Really just minor points about trying to align closer with conventions of the specific languages.

packages/cdktf-cli/templates/csharp/.hooks.sscaff.js

packages/cdktf-cli/templates/csharp/TestProgram.cs

jsteinich · 2022-07-26T01:49:49Z

packages/cdktf-cli/templates/csharp/TestProgram.cs

+    // The tests below are example tests, you can find more information at
+    // https://cdk.tf/testing
+    public class TestProgram{
+        private static TerraformStack stack = new TerraformStack(Testing.app(), "stack");


I'd probably opt for doing this in a test setup rather than a static variable.

I think we can do a follow up for this one 👍

packages/cdktf-cli/templates/java/pom.xml

jsteinich · 2022-07-26T02:10:49Z

test/java/testing-matchers/test.ts

+      "src/main/java/com/mycompany/app/JunitTesting.java"
+    );
+    await driver.copyFiles("update-pom.sh");
+    await driver.exec("bash update-pom.sh");


Why not just copy an updated pom file?

I think this is something we can do in a follow up PR

website/docs/cdktf/test/unit-tests.mdx

jsteinich · 2022-07-26T02:21:34Z

In the future the creation of a testing adapter similar to the one for jest would be an improvement. Currently Users have to access the pass attribute directly, and the message attribute is more jest specific. Further refinement in the future could improve usability.

The problem I see with delaying changes is that we are likely to encounter breaking changes or further suboptimal experience when adding in the future.
Since the additional return information seems to be targeted towards jest at this point, and since jest has an additional adapter, I'd recommend having internal functions that both the jest adapter and public methods make use of. This would still allow the same code and increased jest support to be present, while simplifying the public signatures for other languages to just return a boolean.

Co-authored-by: Jon Steinich <[email protected]>

Outdate and we can improve the docs even after the release, so not blocking :)

* fix(lib): exposed testing matchers for other languages properly * added documentation for increased support of unit testing * updated templates to add testing and various small changes to integration tests * fixed docs formating * Update website/docs/cdktf/test/unit-tests.mdx Co-authored-by: Laura Pacilio <[email protected]> * Update website/docs/cdktf/test/unit-tests.mdx Co-authored-by: Laura Pacilio <[email protected]> * Update website/docs/cdktf/test/unit-tests.mdx Co-authored-by: Laura Pacilio <[email protected]> * Update website/docs/cdktf/test/unit-tests.mdx Co-authored-by: Laura Pacilio <[email protected]> * Revert "Update website/docs/cdktf/test/unit-tests.mdx" This reverts commit 1258245. * Revert "Update website/docs/cdktf/test/unit-tests.mdx" This reverts commit a9cc009. * fixed templates that caused build errors in tests * update to testing docs * fixed async tests for java dotnet * chore: fix wording Co-authored-by: Jon Steinich <[email protected]> * chore: improve wording Co-authored-by: Jon Steinich <[email protected]> * chore: fix wording Co-authored-by: Jon Steinich <[email protected]> * chore: use default test path in java * chore: only expose boolean instead of AssertionReturn for now Co-authored-by: Laura Pacilio <[email protected]> Co-authored-by: Daniel Schmidt <[email protected]> Co-authored-by: Jon Steinich <[email protected]>

github-actions · 2022-11-26T01:49:08Z

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

Maed223 requested a review from DanielMSchmidt July 19, 2022 00:19

vercel bot deployed to Preview July 19, 2022 00:19 View deployment

vercel bot deployed to Preview July 19, 2022 00:48 View deployment

DanielMSchmidt reviewed Jul 19, 2022

View reviewed changes

test/csharp/testing-matchers/test.ts Show resolved Hide resolved

test/csharp/testing-matchers/test.ts Outdated Show resolved Hide resolved

test/csharp/testing-matchers/test.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview July 19, 2022 21:29 View deployment

vercel bot deployed to Preview July 20, 2022 16:38 View deployment

vercel bot deployed to Preview July 20, 2022 19:49 View deployment

vercel bot deployed to Preview July 20, 2022 20:49 View deployment

vercel bot deployed to Preview July 21, 2022 19:48 View deployment

Maed223 marked this pull request as draft July 21, 2022 20:26

vercel bot deployed to Preview July 22, 2022 14:22 View deployment

Maed223 added the ci/updating-snapshots CI is currently updating this PR with new snapshot tests label Jul 22, 2022

github-actions bot removed the ci/updating-snapshots CI is currently updating this PR with new snapshot tests label Jul 22, 2022

vercel bot deployed to Preview July 22, 2022 14:35 View deployment

Maed223 added ci/update-snapshots When set on a PR a GH Action will update and push all snapshot tests ci/updating-snapshots CI is currently updating this PR with new snapshot tests and removed ci/updating-snapshots CI is currently updating this PR with new snapshot tests labels Jul 22, 2022

github-actions bot added ci/updating-snapshots CI is currently updating this PR with new snapshot tests and removed ci/update-snapshots When set on a PR a GH Action will update and push all snapshot tests labels Jul 22, 2022

vercel bot deployed to Preview July 22, 2022 15:50 View deployment

github-actions bot removed the ci/updating-snapshots CI is currently updating this PR with new snapshot tests label Jul 22, 2022

Maed223 added ci/update-snapshots When set on a PR a GH Action will update and push all snapshot tests ci/updating-snapshots CI is currently updating this PR with new snapshot tests labels Jul 22, 2022

github-actions bot removed the ci/update-snapshots When set on a PR a GH Action will update and push all snapshot tests label Jul 22, 2022

Maed223 removed the ci/updating-snapshots CI is currently updating this PR with new snapshot tests label Jul 22, 2022

fix(lib): exposed testing matchers for other languages properly

bb50cd9

Maed223 added 3 commits July 25, 2022 16:35

Revert "Update website/docs/cdktf/test/unit-tests.mdx"

d41c933

This reverts commit 1258245.

Revert "Update website/docs/cdktf/test/unit-tests.mdx"

126f7b0

This reverts commit a9cc009.

fixed templates that caused build errors in tests

a6610b8

vercel bot deployed to Preview July 25, 2022 23:21 View deployment

vercel bot deployed to Preview July 25, 2022 23:25 View deployment

update to testing docs

a9025f0

vercel bot deployed to Preview July 25, 2022 23:52 View deployment

fixed async tests for java dotnet

cb59a53

vercel bot deployed to Preview July 26, 2022 01:36 View deployment

jsteinich reviewed Jul 26, 2022

View reviewed changes

chore: fix wording

33c1b95

Co-authored-by: Jon Steinich <[email protected]>

vercel bot deployed to Preview July 26, 2022 11:05 View deployment

DanielMSchmidt and others added 3 commits July 26, 2022 13:06

chore: improve wording

fb2e2f3

Co-authored-by: Jon Steinich <[email protected]>

chore: fix wording

066c50f

Co-authored-by: Jon Steinich <[email protected]>

Merge branch 'main' into fix-testing-matchers

6f42fe1

vercel bot deployed to Preview July 26, 2022 11:12 View deployment

chore: use default test path in java

f6dcc70

vercel bot had a problem deploying to Preview July 26, 2022 12:29 Failure

vercel bot deployed to Preview July 26, 2022 12:35 View deployment

chore: only expose boolean instead of AssertionReturn for now

dacb81c

DanielMSchmidt force-pushed the fix-testing-matchers branch from 384b718 to dacb81c Compare July 26, 2022 12:49

vercel bot deployed to Preview July 26, 2022 12:53 View deployment

DanielMSchmidt changed the title ~~fix(lib): exposed testing matchers for other languages properly~~ feat(lib): exposed testing matchers for other languages properly Jul 26, 2022

DanielMSchmidt merged commit abc1596 into main Jul 26, 2022

DanielMSchmidt deleted the fix-testing-matchers branch July 26, 2022 13:57

github-actions bot locked as resolved and limited conversation to collaborators Nov 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(lib): exposed testing matchers for other languages properly #1935

feat(lib): exposed testing matchers for other languages properly #1935

Maed223 commented Jul 19, 2022

DanielMSchmidt left a comment

jsteinich left a comment

jsteinich Jul 26, 2022

DanielMSchmidt Jul 26, 2022

jsteinich Jul 26, 2022

DanielMSchmidt Jul 26, 2022

jsteinich commented Jul 26, 2022

github-actions bot commented Nov 26, 2022

feat(lib): exposed testing matchers for other languages properly #1935

feat(lib): exposed testing matchers for other languages properly #1935

Conversation

Maed223 commented Jul 19, 2022

DanielMSchmidt left a comment

Choose a reason for hiding this comment

jsteinich left a comment

Choose a reason for hiding this comment

jsteinich Jul 26, 2022

Choose a reason for hiding this comment

DanielMSchmidt Jul 26, 2022

Choose a reason for hiding this comment

jsteinich Jul 26, 2022

Choose a reason for hiding this comment

DanielMSchmidt Jul 26, 2022

Choose a reason for hiding this comment

jsteinich commented Jul 26, 2022

github-actions bot commented Nov 26, 2022