chore(init-templates): move init templates to new assertions module by corymhall · Pull Request #17062 · aws/aws-cdk

corymhall · 2021-10-19T19:12:00Z

this updates both v1 and v2 init templates to use the new assertions
module. I also added tests for the python app templates since those were
missing.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

gitpod-io · 2021-10-19T19:12:02Z

.../lib/init-templates/v1/app/java/src/test/java/com/myorg/%name.PascalCased%Test.template.java

...s-cdk/lib/init-templates/v1/app/python/tests/unit/test_%name.PythonModule%_stack.template.py

rix0rrr · 2021-10-20T16:29:59Z

packages/aws-cdk/lib/init-templates/v1/app/python/requirements.txt

@@ -1 +1,2 @@
 -e .
+pytest


Should we not add a version here? Feels safer.

For Python should we be using == or >= for deps?

rix0rrr · 2021-10-20T16:30:40Z

packages/aws-cdk/lib/init-templates/v1/app/python/setup.template.py


    install_requires=[
        "aws-cdk.core==%cdk-version%",
+        "aws-cdk.assertions==%cdk-version%",


I've been told using setup.py for applications is actually an anti-pattern, and we should only be using this for libraries.

Not a big Python user myself, and probably out of scope for the current PR... but if you agree, something to consider maybe?

I updated the Python templates to remove setup.py in favor of requirements.txt & requirements-dev.txt. Not sure if we actually need to distinguish between the two in a CDK app though?

...ib/init-templates/v1/sample-app/python/tests/unit/test_%name.PythonModule%_stack.template.py

packages/aws-cdk/lib/init-templates/v2/app/go/%name%_test.template.go

rix0rrr · 2021-10-20T16:33:32Z

Didn't get all the way through yet

this updates both v1 and v2 init templates to use the new assertions module. I also added tests for the python app templates since those were missing.

requirements.txt and requirements-dev.txt

update app templates for go to create an empty stack. this updates the go app template to have the same behavior as the other languages.

nija-at

I've only gone through the v1 templates so far.

.../lib/init-templates/v1/app/java/src/test/java/com/myorg/%name.PascalCased%Test.template.java

packages/aws-cdk/lib/init-templates/v1/app/go/%name%.template.go

packages/aws-cdk/lib/init-templates/v1/app/java/pom.template.xml

.../lib/init-templates/v1/app/java/src/test/java/com/myorg/%name.PascalCased%Test.template.java

packages/aws-cdk/lib/init-templates/v1/lib/typescript/test/%name%.test.template.ts

...ib/init-templates/v1/sample-app/python/tests/unit/test_%name.PythonModule%_stack.template.py

Pull request has been modified.

example test

nija-at

Looks good. See couple of minor comments below.

packages/aws-cdk/lib/init-templates/v1/app/go/%name%.template.go

.../lib/init-templates/v1/app/java/src/test/java/com/myorg/%name.PascalCased%Test.template.java

nija-at

Approved with 'do-not-merge'. See comments above.

mergify · 2021-11-03T20:50:50Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2021-11-03T21:44:41Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
Commit ID: af14406
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2021-11-03T21:44:43Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

The init templates were modified as part of #17062. One change was for the 'app' and 'sample-app' templates to use 'requirements.txt' instead of 'setup.py'. In that conversion, a quirk of the `%constructsversion%` replacement was lost; that replacement inserts the version comparison `>=` itself, so having it in the requirements.txt results in a broken specifier. This was caught in the forward-merge to v2, where there are additional tests verfying the constructs versions.

#17333) The init templates were modified as part of #17062. One change was for the 'app' and 'sample-app' templates to use 'requirements.txt' instead of 'setup.py'. In that conversion, a quirk of the `%constructsversion%` replacement was lost; that replacement inserts the version comparison `>=` itself, so having it in the requirements.txt results in a broken specifier. This was caught in the forward-merge to v2, where there are additional tests verfying the constructs versions. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…ws#17062) this updates both v1 and v2 init templates to use the new assertions module. I also added tests for the python app templates since those were missing. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

aws#17333) The init templates were modified as part of aws#17062. One change was for the 'app' and 'sample-app' templates to use 'requirements.txt' instead of 'setup.py'. In that conversion, a quirk of the `%constructsversion%` replacement was lost; that replacement inserts the version comparison `>=` itself, so having it in the requirements.txt results in a broken specifier. This was caught in the forward-merge to v2, where there are additional tests verfying the constructs versions. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

) Fixes issue [#9135](aws/aws-cdk#9135) by updating the README to be consistent with [AWS docs](https://docs.aws.amazon.com/cdk/v2/guide/work-with-cdk-python.html#work-with-cdk-python-dependencies) Note that setup.py was removed from the python init-template in PR [#17062](aws/aws-cdk#17062) --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license Co-authored-by: Gowthami Gudipati <gudipatg@amazon.com>

rix0rrr reviewed Oct 20, 2021

View reviewed changes

corymhall added 5 commits October 22, 2021 17:40

chore(init-templates): move init templates to new assertions module

27ec3ca

this updates both v1 and v2 init templates to use the new assertions module. I also added tests for the python app templates since those were missing.

fixing quotes

1eec242

updating python template tests and switch from setup.py to

6eac2b6

requirements.txt and requirements-dev.txt

updating init-templates integration scripts to run tests

d68cac5

add v1 and v2 sample-app template for go

e2ad34b

update app templates for go to create an empty stack. this updates the go app template to have the same behavior as the other languages.

nija-at previously requested changes Oct 26, 2021

View reviewed changes

fixing java templates

5e5ce9b

mergify bot added the contribution/core This is a PR that came from AWS. label Oct 27, 2021

corymhall added 2 commits November 3, 2021 15:05

updating app templates to have an example resource and corresponding

a6db11e

example test

switching to resourceCountIs instead of Match.anyValue()

5ba25a9

corymhall requested a review from nija-at November 3, 2021 15:38

nija-at reviewed Nov 3, 2021

View reviewed changes

packages/aws-cdk/lib/init-templates/v1/app/go/%name%.template.go Show resolved Hide resolved

.../lib/init-templates/v1/app/java/src/test/java/com/myorg/%name.PascalCased%Test.template.java Outdated Show resolved Hide resolved

nija-at added the pr/do-not-merge This PR should not be merged at this time. label Nov 3, 2021

nija-at approved these changes Nov 3, 2021

View reviewed changes

corymhall added 2 commits November 3, 2021 17:40

final updates based on comments

0c300d9

typo

4608316

corymhall removed the pr/do-not-merge This PR should not be merged at this time. label Nov 3, 2021

Merge branch 'master' into init-template-assertions

af14406

mergify bot merged commit ca20805 into aws:master Nov 3, 2021

njlynch mentioned this pull request Nov 4, 2021

chore(cli): v2 python init templates have incorrect constructs version #17333

Merged

gudipati mentioned this pull request Jan 21, 2026

fix(cli): outdated instructions in README of python init template aws/aws-cdk-cli#1047

Merged

gudipati mentioned this pull request Jan 28, 2026

[cli] Initialize Python application without setup.py #9135

Closed

2 tasks

		@@ -1 +1,2 @@
		-e .
		pytest

Conversation

corymhall commented Oct 19, 2021

Uh oh!

gitpod-io bot commented Oct 19, 2021

Uh oh!

Uh oh!

Uh oh!

rix0rrr Oct 20, 2021

Choose a reason for hiding this comment

Uh oh!

corymhall Oct 25, 2021

Choose a reason for hiding this comment

Uh oh!

rix0rrr Oct 20, 2021

Choose a reason for hiding this comment

Uh oh!

corymhall Oct 25, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rix0rrr commented Oct 20, 2021

Uh oh!

nija-at left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nija-at left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nija-at left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Nov 3, 2021

Uh oh!

aws-cdk-automation commented Nov 3, 2021

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants