Skip to content

Commit 1fe7ad1

Browse files
akash1810akash1810
authored
ci: Mock gu:cdk:version (#16698)
Implements mocking of `gu:cdk:version` to make GuCDK updates easier. See also https://github.com/guardian/cdk/blob/main/docs/best-practices.md#mocking-gucdkversion. NOTE: In theory we could DRY this out and perform the mock once via global setup, however I've not managed to get this working. See also https://nodejs.org/api/test.html#global-setup-and-teardown.
1 parent 0757a1b commit 1fe7ad1

6 files changed

Lines changed: 42 additions & 27 deletions

File tree

‎ab-testing/cdk/lib/__snapshots__/abTestingConfig.test.ts.snap‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ exports[`The ID5 Baton Lambda stack > matches the CODE snapshot 1`] = `
22
{
33
"Metadata": {
44
"gu:cdk:constructs": [],
5-
"gu:cdk:version": "64.5.1"
5+
"gu:cdk:version": "TEST"
66
},
77
"Parameters": {
88
"BuildId": {
@@ -46,7 +46,7 @@ exports[`The ID5 Baton Lambda stack > matches the PROD snapshot 1`] = `
4646
{
4747
"Metadata": {
4848
"gu:cdk:constructs": [],
49-
"gu:cdk:version": "64.5.1"
49+
"gu:cdk:version": "TEST"
5050
},
5151
"Parameters": {
5252
"BuildId": {

‎ab-testing/cdk/lib/__snapshots__/deploymentLambda.test.ts.snap‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ exports[`The AB testing deployment lambda stack > matches the CODE snapshot 1`]
55
"GuDistributionBucketParameter",
66
"GuLambdaFunction"
77
],
8-
"gu:cdk:version": "64.5.1"
8+
"gu:cdk:version": "TEST"
99
},
1010
"Parameters": {
1111
"SsmParameterValueaccountservicesdotcomstorebucketC96584B6F00A464EAD1953AFF4B05118Parameter": {
@@ -55,7 +55,7 @@ exports[`The AB testing deployment lambda stack > matches the CODE snapshot 1`]
5555
},
5656
{
5757
"Key": "gu:cdk:version",
58-
"Value": "64.5.1"
58+
"Value": "TEST"
5959
},
6060
{
6161
"Key": "gu:repo",
@@ -294,7 +294,7 @@ exports[`The AB testing deployment lambda stack > matches the CODE snapshot 1`]
294294
},
295295
{
296296
"Key": "gu:cdk:version",
297-
"Value": "64.5.1"
297+
"Value": "TEST"
298298
},
299299
{
300300
"Key": "gu:repo",
@@ -327,7 +327,7 @@ exports[`The AB testing deployment lambda stack > matches the PROD snapshot 1`]
327327
"GuDistributionBucketParameter",
328328
"GuLambdaFunction"
329329
],
330-
"gu:cdk:version": "64.5.1"
330+
"gu:cdk:version": "TEST"
331331
},
332332
"Parameters": {
333333
"SsmParameterValueaccountservicesdotcomstorebucketC96584B6F00A464EAD1953AFF4B05118Parameter": {
@@ -377,7 +377,7 @@ exports[`The AB testing deployment lambda stack > matches the PROD snapshot 1`]
377377
},
378378
{
379379
"Key": "gu:cdk:version",
380-
"Value": "64.5.1"
380+
"Value": "TEST"
381381
},
382382
{
383383
"Key": "gu:repo",
@@ -616,7 +616,7 @@ exports[`The AB testing deployment lambda stack > matches the PROD snapshot 1`]
616616
},
617617
{
618618
"Key": "gu:cdk:version",
619-
"Value": "64.5.1"
619+
"Value": "TEST"
620620
},
621621
{
622622
"Key": "gu:repo",

‎ab-testing/cdk/lib/__snapshots__/notificationLambda.test.ts.snap‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
1010
"GuScheduledLambda",
1111
"GuLambdaErrorPercentageAlarm"
1212
],
13-
"gu:cdk:version": "64.5.1"
13+
"gu:cdk:version": "TEST"
1414
},
1515
"Resources": {
1616
"EmailIdentityAbtestingnotificationlambdaE053C648": {
@@ -24,7 +24,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
2424
},
2525
{
2626
"Key": "gu:cdk:version",
27-
"Value": "64.5.1"
27+
"Value": "TEST"
2828
},
2929
{
3030
"Key": "gu:repo",
@@ -113,7 +113,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
113113
"Tags": [
114114
{
115115
"Key": "gu:cdk:version",
116-
"Value": "64.5.1"
116+
"Value": "TEST"
117117
},
118118
{
119119
"Key": "gu:repo",
@@ -166,7 +166,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
166166
},
167167
{
168168
"Key": "gu:cdk:version",
169-
"Value": "64.5.1"
169+
"Value": "TEST"
170170
},
171171
{
172172
"Key": "gu:repo",
@@ -340,7 +340,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
340340
},
341341
{
342342
"Key": "gu:cdk:version",
343-
"Value": "64.5.1"
343+
"Value": "TEST"
344344
},
345345
{
346346
"Key": "gu:repo",
@@ -452,7 +452,7 @@ exports[`The AB testing notification lambda stack > matches the CODE snapshot 1`
452452
"Tags": [
453453
{
454454
"Key": "gu:cdk:version",
455-
"Value": "64.5.1"
455+
"Value": "TEST"
456456
},
457457
{
458458
"Key": "gu:repo",
@@ -494,7 +494,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
494494
"GuScheduledLambda",
495495
"GuLambdaErrorPercentageAlarm"
496496
],
497-
"gu:cdk:version": "64.5.1"
497+
"gu:cdk:version": "TEST"
498498
},
499499
"Resources": {
500500
"EmailIdentityAbtestingnotificationlambdaE053C648": {
@@ -508,7 +508,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
508508
},
509509
{
510510
"Key": "gu:cdk:version",
511-
"Value": "64.5.1"
511+
"Value": "TEST"
512512
},
513513
{
514514
"Key": "gu:repo",
@@ -597,7 +597,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
597597
"Tags": [
598598
{
599599
"Key": "gu:cdk:version",
600-
"Value": "64.5.1"
600+
"Value": "TEST"
601601
},
602602
{
603603
"Key": "gu:repo",
@@ -660,7 +660,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
660660
},
661661
{
662662
"Key": "gu:cdk:version",
663-
"Value": "64.5.1"
663+
"Value": "TEST"
664664
},
665665
{
666666
"Key": "gu:repo",
@@ -834,7 +834,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
834834
},
835835
{
836836
"Key": "gu:cdk:version",
837-
"Value": "64.5.1"
837+
"Value": "TEST"
838838
},
839839
{
840840
"Key": "gu:repo",
@@ -869,7 +869,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
869869
},
870870
{
871871
"Key": "gu:cdk:version",
872-
"Value": "64.5.1"
872+
"Value": "TEST"
873873
},
874874
{
875875
"Key": "gu:repo",
@@ -1006,7 +1006,7 @@ exports[`The AB testing notification lambda stack > matches the PROD snapshot 1`
10061006
"Tags": [
10071007
{
10081008
"Key": "gu:cdk:version",
1009-
"Value": "64.5.1"
1009+
"Value": "TEST"
10101010
},
10111011
{
10121012
"Key": "gu:repo",

‎ab-testing/cdk/lib/abTestingConfig.test.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { describe, it } from "node:test";
22
import { snapshot } from "node:test";
33
import { basename } from "path";
4+
import { TrackingTag } from "@guardian/cdk/lib/constants/tracking-tag.js";
45
import { GuRoot } from "@guardian/cdk/lib/constructs/root.js";
56
import { Template } from "aws-cdk-lib/assertions";
67
import { AbTestingConfig } from "./abTestingConfig.ts";
@@ -13,7 +14,9 @@ snapshot.setResolveSnapshotPath(
1314
);
1415

1516
void describe("The ID5 Baton Lambda stack", () => {
16-
void it("matches the CODE snapshot", ({ assert }) => {
17+
void it("matches the CODE snapshot", ({ assert, mock }) => {
18+
mock.property(TrackingTag, "Value", "TEST");
19+
1720
const app = new GuRoot();
1821
const stack = new AbTestingConfig(app, "AbTestingConfig", {
1922
stack: "frontend",
@@ -26,7 +29,9 @@ void describe("The ID5 Baton Lambda stack", () => {
2629
assert.snapshot(template.toJSON());
2730
});
2831

29-
void it("matches the PROD snapshot", ({ assert }) => {
32+
void it("matches the PROD snapshot", ({ assert, mock }) => {
33+
mock.property(TrackingTag, "Value", "TEST");
34+
3035
const app = new GuRoot();
3136
const stack = new AbTestingConfig(app, "AbTestingConfig", {
3237
stack: "frontend",

‎ab-testing/cdk/lib/deploymentLambda.test.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { describe, it } from "node:test";
22
import { snapshot } from "node:test";
33
import { basename } from "path";
4+
import { TrackingTag } from "@guardian/cdk/lib/constants/tracking-tag.js";
45
import { GuRoot } from "@guardian/cdk/lib/constructs/root.js";
56
import { Template } from "aws-cdk-lib/assertions";
67
import { AbTestingDeploymentLambda } from "./deploymentLambda.ts";
@@ -13,7 +14,9 @@ snapshot.setResolveSnapshotPath(
1314
);
1415

1516
void describe("The AB testing deployment lambda stack", () => {
16-
void it("matches the CODE snapshot", ({ assert }) => {
17+
void it("matches the CODE snapshot", ({ assert, mock }) => {
18+
mock.property(TrackingTag, "Value", "TEST");
19+
1720
const app = new GuRoot();
1821
const stack = new AbTestingDeploymentLambda(
1922
app,
@@ -30,7 +33,9 @@ void describe("The AB testing deployment lambda stack", () => {
3033
assert.snapshot(template.toJSON());
3134
});
3235

33-
void it("matches the PROD snapshot", ({ assert }) => {
36+
void it("matches the PROD snapshot", ({ assert, mock }) => {
37+
mock.property(TrackingTag, "Value", "TEST");
38+
3439
const app = new GuRoot();
3540
const stack = new AbTestingDeploymentLambda(
3641
app,

‎ab-testing/cdk/lib/notificationLambda.test.ts‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { describe, it } from "node:test";
22
import { snapshot } from "node:test";
33
import { basename } from "path";
4+
import { TrackingTag } from "@guardian/cdk/lib/constants/tracking-tag.js";
45
import { GuRoot } from "@guardian/cdk/lib/constructs/root.js";
56
import { Template } from "aws-cdk-lib/assertions";
67
import { AbTestingNotificationLambda } from "./notificationLambda.ts";
@@ -13,7 +14,9 @@ snapshot.setResolveSnapshotPath(
1314
);
1415

1516
void describe("The AB testing notification lambda stack", () => {
16-
void it("matches the CODE snapshot", ({ assert }) => {
17+
void it("matches the CODE snapshot", ({ assert, mock }) => {
18+
mock.property(TrackingTag, "Value", "TEST");
19+
1720
const app = new GuRoot();
1821
const stack = new AbTestingNotificationLambda(
1922
app,
@@ -30,7 +33,9 @@ void describe("The AB testing notification lambda stack", () => {
3033
assert.snapshot(template.toJSON());
3134
});
3235

33-
void it("matches the PROD snapshot", ({ assert }) => {
36+
void it("matches the PROD snapshot", ({ assert, mock }) => {
37+
mock.property(TrackingTag, "Value", "TEST");
38+
3439
const app = new GuRoot();
3540
const stack = new AbTestingNotificationLambda(
3641
app,

0 commit comments

Comments
 (0)