chore(cicd): cdk examples and e2e tests for metrics #326
Conversation
flochaz
force-pushed
the
examples/cdk
branch
from
98918af to
e72dfd6
Compare
|
Pushed a change in the
Opened also a separate issue to work on exposing better APIs for manual instrumentation: #334 |
flochaz
force-pushed
the
examples/cdk
branch
from
593443a to
663854b
Compare
| /* If you don't specify 'env', this stack will be environment-agnostic. | ||
| * Account/Region-dependent features and context lookups will not work, | ||
| * but a single synthesized template can be deployed anywhere. */ | ||
|
|
||
| /* Uncomment the next line to specialize this stack for the AWS Account | ||
| * and Region that are implied by the current CLI configuration. */ | ||
| // env: { account: process.env.CDK_DEFAULT_ACCOUNT, region: process.env.CDK_DEFAULT_REGION }, | ||
|
|
||
| /* Uncomment the next line if you know exactly what Account and Region you | ||
| * want to deploy the stack to. */ | ||
| // env: { account: '123456789012', region: 'us-east-1' }, | ||
|
|
||
| /* For more information, see https://docs.aws.amazon.com/cdk/latest/guide/environments.html */ |
|
|
||
| // Invoke all functions twice | ||
| for (let i = 0; i < 2; i++) { | ||
| new custom_resources.AwsCustomResource(this, `Invoke-std-func-${i}`, { |
There was a problem hiding this comment.
Should we wrap these 3 resource creations in to a function? They are almost the same except the passed function.
| defaultDimensions: { environment: 'example', type: 'withDecorator' }, | ||
| }) | ||
| public handler(_event: unknown, _context: Context, _callback: Callback<unknown>): void | Promise<unknown> { | ||
| // ### Experiment logger |
There was a problem hiding this comment.
Why is there a word "Experiment"?
| @@ -0,0 +1,17 @@ | |||
| // import * as cdk from 'aws-cdk-lib'; | |||
There was a problem hiding this comment.
We can also remove these unused comments.
| // Despite lambda has been called twice, coldstart metric sum should only be 1 | ||
| const singleDataPoint = coldStartMetricStat.Datapoints ? coldStartMetricStat.Datapoints[0] : {}; | ||
| expect(singleDataPoint.Sum).toBe(1); | ||
| }, 9000000); |
There was a problem hiding this comment.
That's 2.5 hr. Do you intend to be 15 mins? (one less 0)
| stack: stackArtifact, | ||
| }); | ||
| } | ||
| }, 9000000); |
There was a problem hiding this comment.
That's 2.5 hr. Do you intend to be 15 mins? (one less 0)
heitorlessa
added
the
internal
|
@saragerion @ijemmy @flochaz - looks like this lock file was generated by node@16, which will break node@14 users when the want to do |
Thx @michaelbrewer. I am opening an issue and will fix asap. |
For those coming here in the future, the issue was that we recently started recommending Using |
|
Sorry about this. I guess things where in flux (so now with the clear contributor guide and the gitpod/CodeSpaces support). It should be clear what the local setup should be. |
Description of your changes
How to verify this change
Global example
cd examples/cdk npm install npm run build npm run cdk deployThis will deploy 3 lambdas and invoke them twice (to have one cold start and one warm)
Metrics e2e test
Run procedure
Doc (might be worth to move that in CONTRIBUTING.md ?)
Tests are under
testfolder and splitted into two categories: Unit tests and e2e tests.This split happen thanks to jest-runner-groups.
Unit tests, under
test/unitfolder, don't need AWS Account to run and can only verify your construct's logic and it's capability to be synthesised to Cloud Formation.Integration tests, under
test/e2efolder, will test the deployability (cfn stack deploy) of your construct, potentially its functionality and its deprovisioning capability (cfn stack destroy) and therefore will need an AWS account.Unit testing
Write
As mentioned before, tests are splitted thanks to jest-runner-groups and therefore needs to be tagged properly by adding the following comments in your unit test file:
Run
npm run testYou can run selective tests by restricting the group to the one you want. For instance
npx jest --group=unit/metrics/all.e2e testing
Write
As mentioned before, tests are splitted thanks to jest-runner-groups and therefore needs to be tagged properly by adding the following comments in your unit test file:
and leverage
aws-cdkpackage to programatically deploy and destroy stacks. Seemetrics/tests/e2e/decorator.test.tsas an example.Run
To run unit tests you can either use projen task
npm run test:e2ewhich will only run jest integ testsnpx jest --group=e2eYou can run selective tests by restricting the group to the one you want. For instance
npx jest --group=e2e/other/example.Two important env variable can be used:
AWS_PROFILEto use the right credentialsDISABLE_TEARDOWNif 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/exampleRelated issues, RFCs
#136
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.