chore: run e2e tests on demand #441

flochaz · 2022-01-07T14:28:28Z

Description of your changes

Running e2e tests on demand.

Next we will need to make sure that some following PRs handle decision made in discussion #315 .

Potential improvment

Run only when module changes with --onlyChanged --changedSince=main option on jest

How to verify this change

Check for https://github.com/awslabs/aws-lambda-powertools-typescript/actions/workflows/run-e2e-tests.yml tests run

Related issues, RFCs

#418

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

packages/metrics/tests/e2e/decorator.test.ts

dreamorosi

Thanks, this is huge!

Just left some minor suggestions to reword part of the contributing section + added a disclaimer about potential costs of running the tests.

~~Only other note is that the unit tests in logger are not yet tagged so even when running test:e2e the regular unit ones are running.~~ Done in e3a83ce

CONTRIBUTING.md

flochaz · 2022-01-07T17:13:08Z

Thanks, this is huge!

Just left some minor suggestions to reword part of the contributing section + added a disclaimer about potential costs of running the tests.

~~Only other note is that the unit tests in logger are not yet tagged so even when running test:e2e the regular unit ones are running.~~ Done in e3a83ce

thx for the commit !

…tegTests

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

CONTRIBUTING.md

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

saragerion

Thanks for the great work @flochaz! Looking forward to merge this one, but I left a few comments in this PR that I think should be discussed before merging it.

Also I think I need a better understanding of what will be included in the upcoming PR's related to the same ticket, always in the spirit of maintaining the PRs size small.

CONTRIBUTING.md

saragerion · 2022-01-12T15:27:33Z

CONTRIBUTING.md

+* `AWS_PROFILE` to use the right credentials
+* `DISABLE_TEARDOWN` if you don't want your stack to be destroyed at the end of the test (useful in dev mode when iterating over your code).
+
+Example: `DISABLE_TEARDOWN=true AWS_PROFILE=ara npx jest --group=integ/other/example`


Minor: can we add a real example?

CONTRIBUTING.md

package.json

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

CONTRIBUTING.md

saragerion

Almost there!

saragerion · 2022-01-14T13:28:20Z

CONTRIBUTING.md

+1. Create an IAM role in your target AWS account, with the least amount of privilege.
+
+    As mentioned above in this page, we are leveraging CDK to deploy and consequently clean-up resources on AWS. Therefore to run those tests through Github actions you will need to grant specific permissions to your workflow.  
+
+    We recommend following [Amazon IAM best practices](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html) for the AWS credentials used in GitHub Actions workflows, including:
+    * Do not store credentials in your repository's code.
+    * [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) to the credentials used in GitHub Actions workflows.  Grant only the permissions required to perform the actions in your GitHub Actions workflows.
+    * [Monitor the activity](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#keep-a-log) of the credentials used in GitHub Actions workflows.
+
+    For an example of how to create a role in CDK, you can look at [@pahud/cdk-github-oidc](https://constructs.dev/packages/@pahud/cdk-github-oidc) construct.
+
+    More information about:  
+
+    - [Github OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/
+    - ["Configure AWS Credentials" Action For GitHub Actions](https://github.com/aws-actions/configure-aws-credentials/)
+1. Add your new role into your [Github fork secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) with name  `AWS_ROLE_ARN_TO_ASSUME`.
+1. In your forked repository, go to the "Actions" tabs, select the `run-e2e-tests` workflow.
+1. In the run-e2e-tests workflow page, select "Run workflow" and run it on the desired branch.


Nit: steps numbers are all "1."

They rendered correctly by GitHub preview & according to spec it's not required for them to be in order:

To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one.

But for those who are reading the source I agree that it was confusing, changed it in 973a9d5.

saragerion · 2022-01-14T13:28:30Z

packages/commons/package.json

@@ -11,7 +11,8 @@
  },
  "scripts": {
    "commit": "commit",
-    "test": "jest  --detectOpenHandles --coverage --verbose",
+    "test": "npm run test:unit",
+    "test:unit": "jest --group=unit --detectOpenHandles --coverage --verbose",


dreamorosi · 2022-01-14T13:38:10Z

@flochaz pushed a commit because I noticed that the "⚠️ " symbol here was not rendering properly, also addressed one comment while there, hope you don't mind.

saragerion

LGTM

flochaz added 7 commits January 6, 2022 16:08

add AWS infra to run E2E tests

c3b427d

Fix e2e tests and add missing scripts

27bfa90

split workflow

cd7b015

Fix region and account setting for tracing e2e

7015f64

add log to tracing e2e

d1acd31

alternative to get account

b367d80

revert increase timeout

52a20d8

github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label Jan 7, 2022

flochaz added 2 commits January 7, 2022 15:30

remove test trigger

c0a4301

remove aws-infra

38fdb75

dreamorosi reviewed Jan 7, 2022

View reviewed changes

packages/metrics/tests/e2e/decorator.test.ts Show resolved Hide resolved

flochaz added 2 commits January 7, 2022 17:26

add Contributing

ea45fdf

fix on merge

bdf800f

dreamorosi requested changes Jan 7, 2022

View reviewed changes

dreamorosi assigned flochaz Jan 7, 2022

dreamorosi added all automation This item relates to automation labels Jan 7, 2022

dreamorosi added this to the production-ready-release milestone Jan 7, 2022

dreamorosi and others added 3 commits January 7, 2022 18:00

chore: added jest group runner dep + config + headers to logger

e3a83ce

chore: added group filter in regular cmd tests for logger

6db56fa

Add manual command for get trace summary

6046c08

flochaz and others added 6 commits January 7, 2022 18:15

Merge remote-tracking branch 'origin/main' into chore/cicd/automateIn…

08e8050

…tegTests

Update CONTRIBUTING.md

ff9a87f

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

Update CONTRIBUTING.md

13103b8

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

Update CONTRIBUTING.md

3a189ba

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

Update CONTRIBUTING.md

5fbdc66

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

Update CONTRIBUTING.md

f86e54f

Co-authored-by: Andrea Amorosi <dreamorosi@gmail.com>

saragerion reviewed Jan 12, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

saragerion reviewed Jan 12, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

saragerion reviewed Jan 12, 2022

View reviewed changes

CONTRIBUTING.md Outdated Show resolved Hide resolved

flochaz and others added 6 commits January 12, 2022 16:31

Update CONTRIBUTING.md

d0f9736

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update .github/workflows/run-e2e-tests.yml

530d50d

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

df4e51a

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

5ff1931

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

9d0daa8

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

1d22541

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

saragerion reviewed Jan 12, 2022

View reviewed changes

flochaz and others added 5 commits January 13, 2022 07:37

Update CONTRIBUTING.md

1e4c897

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

ee00ffc

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

57c3bb0

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

Update CONTRIBUTING.md

0de1d03

Co-authored-by: Sara Gerion <47529391+saragerion@users.noreply.github.com>

homogenize tests run process

64304ce

flochaz force-pushed the chore/cicd/automateIntegTests branch from f90ba87 to 64304ce Compare January 13, 2022 08:10

fix indentation

4f62c1a

flochaz force-pushed the chore/cicd/automateIntegTests branch from 3151afc to 4f62c1a Compare January 13, 2022 17:23

dreamorosi previously approved these changes Jan 14, 2022

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

saragerion reviewed Jan 14, 2022

View reviewed changes

Update CONTRIBUTING.md

973a9d5

dreamorosi dismissed their stale review via 973a9d5 January 14, 2022 13:32

dreamorosi self-requested a review January 14, 2022 13:35

dreamorosi approved these changes Jan 14, 2022

View reviewed changes

saragerion approved these changes Jan 14, 2022

View reviewed changes

flochaz merged commit d6aae13 into main Jan 14, 2022

flochaz deleted the chore/cicd/automateIntegTests branch January 14, 2022 16:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: run e2e tests on demand #441

chore: run e2e tests on demand #441

flochaz commented Jan 7, 2022 •

edited

Loading

dreamorosi left a comment •

edited

Loading

flochaz commented Jan 7, 2022

saragerion left a comment •

edited

Loading

saragerion Jan 12, 2022

saragerion left a comment

saragerion Jan 14, 2022

dreamorosi Jan 14, 2022

saragerion Jan 14, 2022

dreamorosi commented Jan 14, 2022

saragerion left a comment

chore: run e2e tests on demand #441

chore: run e2e tests on demand #441

Conversation

flochaz commented Jan 7, 2022 • edited Loading

Description of your changes

How to verify this change

Related issues, RFCs

PR status

Checklist

dreamorosi left a comment • edited Loading

Choose a reason for hiding this comment

flochaz commented Jan 7, 2022

saragerion left a comment • edited Loading

Choose a reason for hiding this comment

saragerion Jan 12, 2022

Choose a reason for hiding this comment

saragerion left a comment

Choose a reason for hiding this comment

saragerion Jan 14, 2022

Choose a reason for hiding this comment

dreamorosi Jan 14, 2022

Choose a reason for hiding this comment

saragerion Jan 14, 2022

Choose a reason for hiding this comment

dreamorosi commented Jan 14, 2022

saragerion left a comment

Choose a reason for hiding this comment

flochaz commented Jan 7, 2022 •

edited

Loading

dreamorosi left a comment •

edited

Loading

saragerion left a comment •

edited

Loading