Skip to content

Commit 0b50be7

Browse files
dreamorosiam29d
dreamorosi
and
am29d
authored
test(metrics): migrate tests to vitest & refactor (aws-powertools#3355)
Co-authored-by: Alexander Schueren <[email protected]>
1 parent 7e8578e commit 0b50be7

21 files changed

+1651
-3275
lines changed

‎.github/workflows/reusable-run-linting-check-and-unit-tests.yml

+1-26
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ jobs:
5050
"packages/tracer",
5151
"packages/parser",
5252
"packages/parameters",
53+
"packages/metrics"
5354
]
5455
fail-fast: false
5556
steps:
@@ -70,32 +71,6 @@ jobs:
7071
run: |
7172
npm run test:unit:coverage -w ${{ matrix.workspace }}
7273
npm run test:unit:types -w ${{ matrix.workspace }}
73-
run-linting-check-and-unit-tests-on-utilities:
74-
runs-on: ubuntu-latest
75-
env:
76-
NODE_ENV: dev
77-
strategy:
78-
matrix:
79-
version: [18, 20, 22]
80-
fail-fast: false
81-
steps:
82-
- name: Checkout code
83-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
84-
- name: Setup NodeJS
85-
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
86-
with:
87-
node-version: ${{ matrix.version }}
88-
cache: "npm"
89-
- name: Setup dependencies
90-
uses: aws-powertools/actions/.github/actions/cached-node-modules@d406bac5563f1d8c793519a3eedfe620f6a14872
91-
with:
92-
nodeVersion: ${{ matrix.version }}
93-
- name: Run linting
94-
run: |
95-
npm run lint -w packages/metrics
96-
- name: Run unit tests
97-
run: |
98-
npm t -w packages/metrics
9974
check-examples:
10075
runs-on: ubuntu-latest
10176
env:

‎.husky/pre-push

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
npm t \
2-
-w packages/metrics
3-
41
npx vitest --run \
52
--exclude tests/unit/layer-publisher.test.ts \
63
--coverage --coverage.thresholds.100 \

‎packages/metrics/jest.config.cjs

-31
This file was deleted.

‎packages/metrics/package.json

+10-8
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@
1010
"access": "public"
1111
},
1212
"scripts": {
13-
"test": "npm run test:unit",
14-
"test:unit": "jest --group=unit --detectOpenHandles --coverage --verbose",
15-
"test:e2e:nodejs18x": "RUNTIME=nodejs18x jest --group=e2e",
16-
"test:e2e:nodejs20x": "RUNTIME=nodejs20x jest --group=e2e",
17-
"test:e2e:nodejs22x": "RUNTIME=nodejs22x jest --group=e2e",
18-
"test:e2e": "jest --group=e2e",
19-
"watch": "jest --group=unit --watch ",
13+
"test": "vitest --run tests/unit",
14+
"test:unit": "vitest --run tests/unit",
15+
"test:unit:coverage": "vitest --run tests/unit --coverage.enabled --coverage.thresholds.100 --coverage.include='src/**'",
16+
"test:unit:types": "echo 'Not Implemented'",
17+
"test:unit:watch": "vitest tests/unit",
18+
"test:e2e:nodejs18x": "RUNTIME=nodejs18x vitest --run tests/e2e",
19+
"test:e2e:nodejs20x": "RUNTIME=nodejs20x vitest --run tests/e2e",
20+
"test:e2e:nodejs22x": "RUNTIME=nodejs22x vitest --run tests/e2e",
21+
"test:e2e": "vitest --run tests/e2e",
2022
"build:cjs": "tsc --build tsconfig.json && echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json",
2123
"build:esm": "tsc --build tsconfig.esm.json && echo '{ \"type\": \"module\" }' > lib/esm/package.json",
2224
"build": "npm run build:esm & npm run build:cjs",
@@ -96,4 +98,4 @@
9698
"serverless",
9799
"nodejs"
98100
]
99-
}
101+
}

‎packages/metrics/src/Metrics.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -827,9 +827,9 @@ class Metrics extends Utility implements MetricsInterface {
827827
/**
828828
* @deprecated Use {@link Metrics.setThrowOnEmptyMetrics | `setThrowOnEmptyMetrics()`} instead.
829829
*/
830-
public throwOnEmptyMetrics(): void {
830+
/* v8 ignore start */ public throwOnEmptyMetrics(): void {
831831
this.shouldThrowOnEmptyMetrics = true;
832-
}
832+
} /* v8 ignore stop */
833833

834834
/**
835835
* Gets the current number of dimensions count.

‎packages/metrics/tests/e2e/basicFeatures.decorators.test.ts

+3-25
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* Test metrics standard functions
3-
*
4-
* @group e2e/metrics/decorator
5-
*/
61
import { join } from 'node:path';
72
import {
83
TestStack,
@@ -12,6 +7,7 @@ import {
127
CloudWatchClient,
138
GetMetricStatisticsCommand,
149
} from '@aws-sdk/client-cloudwatch';
10+
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
1511
import { getMetrics, sortDimensions } from '../helpers/metricsUtils.js';
1612
import { MetricsTestNodejsFunction } from '../helpers/resources.js';
1713
import {
@@ -74,7 +70,7 @@ describe('Metrics E2E tests, basic features decorator usage', () => {
7470

7571
describe('ColdStart metrics', () => {
7672
it(
77-
'should capture ColdStart Metric',
73+
'captures the ColdStart Metric',
7874
async () => {
7975
const {
8076
EXPECTED_NAMESPACE: expectedNamespace,
@@ -106,15 +102,6 @@ describe('Metrics E2E tests, basic features decorator usage', () => {
106102
// Check coldstart metric value
107103
const adjustedStartTime = new Date(startTime.getTime() - ONE_MINUTE);
108104
const endTime = new Date(new Date().getTime() + ONE_MINUTE);
109-
console.log(
110-
`Manual command: aws cloudwatch get-metric-statistics --namespace ${expectedNamespace} --metric-name ColdStart --start-time ${Math.floor(
111-
adjustedStartTime.getTime() / 1000
112-
)} --end-time ${Math.floor(
113-
endTime.getTime() / 1000
114-
)} --statistics 'Sum' --period 60 --dimensions '${JSON.stringify(
115-
expectedDimensions
116-
)}'`
117-
);
118105
const coldStartMetricStat = await cloudwatchClient.send(
119106
new GetMetricStatisticsCommand({
120107
Namespace: expectedNamespace,
@@ -139,7 +126,7 @@ describe('Metrics E2E tests, basic features decorator usage', () => {
139126

140127
describe('Default and extra dimensions', () => {
141128
it(
142-
'should produce a Metric with the default and extra one dimensions',
129+
'produces a Metric with the default and extra one dimensions',
143130
async () => {
144131
const {
145132
EXPECTED_NAMESPACE: expectedNamespace,
@@ -179,15 +166,6 @@ describe('Metrics E2E tests, basic features decorator usage', () => {
179166
startTime.getTime() - 3 * ONE_MINUTE
180167
);
181168
const endTime = new Date(new Date().getTime() + ONE_MINUTE);
182-
console.log(
183-
`Manual command: aws cloudwatch get-metric-statistics --namespace ${expectedNamespace} --metric-name ${expectedMetricName} --start-time ${Math.floor(
184-
adjustedStartTime.getTime() / 1000
185-
)} --end-time ${Math.floor(
186-
endTime.getTime() / 1000
187-
)} --statistics 'Sum' --period 60 --dimensions '${JSON.stringify(
188-
expectedDimensions
189-
)}'`
190-
);
191169
const metricStat = await cloudwatchClient.send(
192170
new GetMetricStatisticsCommand({
193171
Namespace: expectedNamespace,

‎packages/metrics/tests/e2e/basicFeatures.manual.test.ts

+3-25
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
/**
2-
* Test metrics standard functions
3-
*
4-
* @group e2e/metrics/standardFunctions
5-
*/
61
import { join } from 'node:path';
72
import {
83
TestStack,
@@ -12,6 +7,7 @@ import {
127
CloudWatchClient,
138
GetMetricStatisticsCommand,
149
} from '@aws-sdk/client-cloudwatch';
10+
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
1511
import { getMetrics, sortDimensions } from '../helpers/metricsUtils.js';
1612
import { MetricsTestNodejsFunction } from '../helpers/resources.js';
1713
import {
@@ -72,7 +68,7 @@ describe('Metrics E2E tests, manual usage', () => {
7268

7369
describe('ColdStart metrics', () => {
7470
it(
75-
'should capture ColdStart Metric',
71+
'captures the ColdStart Metric',
7672
async () => {
7773
const { EXPECTED_NAMESPACE: expectedNamespace } = commonEnvironmentVars;
7874

@@ -92,15 +88,6 @@ describe('Metrics E2E tests, manual usage', () => {
9288
// Check coldstart metric value
9389
const adjustedStartTime = new Date(startTime.getTime() - 60 * 1000);
9490
const endTime = new Date(new Date().getTime() + 60 * 1000);
95-
console.log(
96-
`Manual command: aws cloudwatch get-metric-statistics --namespace ${expectedNamespace} --metric-name ColdStart --start-time ${Math.floor(
97-
adjustedStartTime.getTime() / 1000
98-
)} --end-time ${Math.floor(
99-
endTime.getTime() / 1000
100-
)} --statistics 'Sum' --period 60 --dimensions '${JSON.stringify([
101-
{ Name: 'service', Value: expectedServiceName },
102-
])}'`
103-
);
10491
const coldStartMetricStat = await cloudwatchClient.send(
10592
new GetMetricStatisticsCommand({
10693
Namespace: expectedNamespace,
@@ -125,7 +112,7 @@ describe('Metrics E2E tests, manual usage', () => {
125112

126113
describe('Default and extra dimensions', () => {
127114
it(
128-
'should produce a Metric with the default and extra one dimensions',
115+
'produces a Metric with the default and extra one dimensions',
129116
async () => {
130117
const {
131118
EXPECTED_NAMESPACE: expectedNamespace,
@@ -165,15 +152,6 @@ describe('Metrics E2E tests, manual usage', () => {
165152
startTime.getTime() - 3 * ONE_MINUTE
166153
);
167154
const endTime = new Date(new Date().getTime() + ONE_MINUTE);
168-
console.log(
169-
`Manual command: aws cloudwatch get-metric-statistics --namespace ${expectedNamespace} --metric-name ${expectedMetricName} --start-time ${Math.floor(
170-
adjustedStartTime.getTime() / 1000
171-
)} --end-time ${Math.floor(
172-
endTime.getTime() / 1000
173-
)} --statistics 'Sum' --period 60 --dimensions '${JSON.stringify(
174-
expectedDimensions
175-
)}'`
176-
);
177155
const metricStat = await cloudwatchClient.send(
178156
new GetMetricStatisticsCommand({
179157
Namespace: expectedNamespace,

‎packages/metrics/tests/helpers/metricsUtils.ts

+1-27
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
import type { LambdaInterface } from '@aws-lambda-powertools/commons/types';
21
import {
32
type CloudWatchClient,
43
type Dimension,
54
ListMetricsCommand,
65
type ListMetricsCommandOutput,
76
} from '@aws-sdk/client-cloudwatch';
8-
import type { Context, Handler } from 'aws-lambda';
97
import promiseRetry from 'promise-retry';
10-
import { MetricUnit, type Metrics } from '../../src/index.js';
11-
import type { ExtraOptions } from '../../src/types/index.js';
128

139
const getMetrics = async (
1410
cloudWatchClient: CloudWatchClient,
@@ -43,29 +39,7 @@ const getMetrics = async (
4339
}, retryOptions);
4440
};
4541

46-
const setupDecoratorLambdaHandler = (
47-
metrics: Metrics,
48-
options: ExtraOptions = {}
49-
): Handler => {
50-
class LambdaFunction implements LambdaInterface {
51-
@metrics.logMetrics(options)
52-
public async handler<TEvent>(
53-
_event: TEvent,
54-
_context: Context
55-
): Promise<string> {
56-
metrics.addMetric('decorator-lambda-test-metric', MetricUnit.Count, 1);
57-
58-
return 'Lambda invoked!';
59-
}
60-
}
61-
62-
const handlerClass = new LambdaFunction();
63-
const handler = handlerClass.handler.bind(handlerClass);
64-
65-
return handler;
66-
};
67-
6842
const sortDimensions = (dimensions?: Dimension[]): Dimension[] | undefined =>
6943
dimensions?.sort((a, b) => (a.Name || '').localeCompare(b?.Name || ''));
7044

71-
export { getMetrics, setupDecoratorLambdaHandler, sortDimensions };
45+
export { getMetrics, sortDimensions };

‎packages/metrics/tests/tsconfig.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
{
22
"extends": "../tsconfig.json",
33
"compilerOptions": {
4-
"rootDir": "../",
4+
"rootDir": "../../",
55
"noEmit": true
66
},
7-
"include": ["../src/**/*", "./**/*"]
7+
"include": [
8+
"../../testing/src/setupEnv.ts",
9+
"../src/**/*",
10+
"./**/*"
11+
]
812
}

0 commit comments

Comments
 (0)