From 317de809248036279e297b8dcf035e7996fadf4a Mon Sep 17 00:00:00 2001 From: Akash Askoolum Date: Sat, 17 Apr 2021 16:34:39 +0100 Subject: [PATCH] refactor!: Rename `library-info` to be more intention revealing Rename `library-info` to `tracking-tag` to be more descriptive and intention revealing. This change makes the mocking advice added in #448 less confusing as the module name maps to the intent. BREAKING CHANGE: `"@guardian/cdk/lib/constants/library-info"` renamed to `"@guardian/cdk/lib/constants/tracking-tag"` Update the mock path in `jest.setup.js` - `"@guardian/cdk/lib/constants/library-info"` becomes `"@guardian/cdk/lib/constants/tracking-tag"`. --- docs/001-general-usage.md | 2 +- jest.setup.js | 2 +- src/constants/__mocks__/{library-info.ts => tracking-tag.ts} | 0 src/constants/{library-info.ts => tracking-tag.ts} | 0 src/constructs/autoscaling/asg.test.ts | 2 +- src/constructs/core/stack.test.ts | 2 +- src/constructs/core/stack.ts | 2 +- .../loadbalancing/alb/application-load-balancer.test.ts | 2 +- .../loadbalancing/alb/application-target-group.test.ts | 2 +- src/constructs/loadbalancing/elb.test.ts | 2 +- src/constructs/rds/instance.test.ts | 2 +- src/patterns/ec2-app.test.ts | 2 +- 12 files changed, 10 insertions(+), 10 deletions(-) rename src/constants/__mocks__/{library-info.ts => tracking-tag.ts} (100%) rename src/constants/{library-info.ts => tracking-tag.ts} (100%) diff --git a/docs/001-general-usage.md b/docs/001-general-usage.md index e74b9efa32..c11a3c7b54 100644 --- a/docs/001-general-usage.md +++ b/docs/001-general-usage.md @@ -94,7 +94,7 @@ This can be done with a few config changes. First, create `jest.setup.js` and add the global mock: ```javascript -jest.mock("@guardian/cdk/lib/constants/library-info"); +jest.mock("@guardian/cdk/lib/constants/tracking-tag"); ``` Next, edit `jest.config.js` setting the [`setupFilesAfterEnv`](https://jestjs.io/docs/configuration#setupfilesafterenv-array) property: diff --git a/jest.setup.js b/jest.setup.js index 2cd92e0788..6ee546a3fb 100644 --- a/jest.setup.js +++ b/jest.setup.js @@ -1 +1 @@ -jest.mock("./src/constants/library-info"); +jest.mock("./src/constants/tracking-tag"); diff --git a/src/constants/__mocks__/library-info.ts b/src/constants/__mocks__/tracking-tag.ts similarity index 100% rename from src/constants/__mocks__/library-info.ts rename to src/constants/__mocks__/tracking-tag.ts diff --git a/src/constants/library-info.ts b/src/constants/tracking-tag.ts similarity index 100% rename from src/constants/library-info.ts rename to src/constants/tracking-tag.ts diff --git a/src/constructs/autoscaling/asg.test.ts b/src/constructs/autoscaling/asg.test.ts index dd02855fce..93023fde3a 100644 --- a/src/constructs/autoscaling/asg.test.ts +++ b/src/constructs/autoscaling/asg.test.ts @@ -5,7 +5,7 @@ import { InstanceType, UserData, Vpc } from "@aws-cdk/aws-ec2"; import { ApplicationProtocol } from "@aws-cdk/aws-elasticloadbalancingv2"; import { Stack } from "@aws-cdk/core"; import { Stage } from "../../constants"; -import { TrackingTag } from "../../constants/library-info"; +import { TrackingTag } from "../../constants/tracking-tag"; import type { Resource, SynthedStack } from "../../utils/test"; import { alphabeticalTags, findResourceByTypeAndLogicalId, simpleGuStackForTesting } from "../../utils/test"; import type { AppIdentity } from "../core/identity"; diff --git a/src/constructs/core/stack.test.ts b/src/constructs/core/stack.test.ts index 4b3160f791..7af6836932 100644 --- a/src/constructs/core/stack.test.ts +++ b/src/constructs/core/stack.test.ts @@ -4,7 +4,7 @@ import { SynthUtils } from "@aws-cdk/assert"; import { Role, ServicePrincipal } from "@aws-cdk/aws-iam"; import { App } from "@aws-cdk/core"; import { Stage, Stages } from "../../constants"; -import { TrackingTag } from "../../constants/library-info"; +import { TrackingTag } from "../../constants/tracking-tag"; import { alphabeticalTags, simpleGuStackForTesting } from "../../utils/test"; import type { SynthedStack } from "../../utils/test"; import { GuParameter } from "./parameters"; diff --git a/src/constructs/core/stack.ts b/src/constructs/core/stack.ts index dbe57eb900..7b0aeecdeb 100644 --- a/src/constructs/core/stack.ts +++ b/src/constructs/core/stack.ts @@ -1,7 +1,7 @@ import type { App, StackProps } from "@aws-cdk/core"; import { Stack, Tags } from "@aws-cdk/core"; import { Stage } from "../../constants"; -import { TrackingTag } from "../../constants/library-info"; +import { TrackingTag } from "../../constants/tracking-tag"; import type { StackStageIdentity } from "./identity"; import type { GuStageDependentValue } from "./mappings"; import { GuStageMapping } from "./mappings"; diff --git a/src/constructs/loadbalancing/alb/application-load-balancer.test.ts b/src/constructs/loadbalancing/alb/application-load-balancer.test.ts index 366a2c41b6..d6e6791248 100644 --- a/src/constructs/loadbalancing/alb/application-load-balancer.test.ts +++ b/src/constructs/loadbalancing/alb/application-load-balancer.test.ts @@ -3,7 +3,7 @@ import "../../../utils/test/jest"; import { SynthUtils } from "@aws-cdk/assert"; import { Vpc } from "@aws-cdk/aws-ec2"; import { Stack } from "@aws-cdk/core"; -import { TrackingTag } from "../../../constants/library-info"; +import { TrackingTag } from "../../../constants/tracking-tag"; import type { SynthedStack } from "../../../utils/test"; import { alphabeticalTags, simpleGuStackForTesting } from "../../../utils/test"; import type { AppIdentity } from "../../core/identity"; diff --git a/src/constructs/loadbalancing/alb/application-target-group.test.ts b/src/constructs/loadbalancing/alb/application-target-group.test.ts index bb82a7d21c..806332bc55 100644 --- a/src/constructs/loadbalancing/alb/application-target-group.test.ts +++ b/src/constructs/loadbalancing/alb/application-target-group.test.ts @@ -3,7 +3,7 @@ import "../../../utils/test/jest"; import { Vpc } from "@aws-cdk/aws-ec2"; import { ApplicationProtocol } from "@aws-cdk/aws-elasticloadbalancingv2"; import { Stack } from "@aws-cdk/core"; -import { TrackingTag } from "../../../constants/library-info"; +import { TrackingTag } from "../../../constants/tracking-tag"; import { alphabeticalTags, simpleGuStackForTesting } from "../../../utils/test"; import type { AppIdentity } from "../../core/identity"; import { GuApplicationTargetGroup } from "./application-target-group"; diff --git a/src/constructs/loadbalancing/elb.test.ts b/src/constructs/loadbalancing/elb.test.ts index a8b7f3a87d..586b9792f1 100644 --- a/src/constructs/loadbalancing/elb.test.ts +++ b/src/constructs/loadbalancing/elb.test.ts @@ -3,7 +3,7 @@ import "../../utils/test/jest"; import { SynthUtils } from "@aws-cdk/assert/lib/synth-utils"; import { Vpc } from "@aws-cdk/aws-ec2"; import { Stack } from "@aws-cdk/core"; -import { TrackingTag } from "../../constants/library-info"; +import { TrackingTag } from "../../constants/tracking-tag"; import { alphabeticalTags, simpleGuStackForTesting } from "../../utils/test"; import type { SynthedStack } from "../../utils/test"; import type { AppIdentity } from "../core/identity"; diff --git a/src/constructs/rds/instance.test.ts b/src/constructs/rds/instance.test.ts index 23a311dccc..21fbf5f62d 100644 --- a/src/constructs/rds/instance.test.ts +++ b/src/constructs/rds/instance.test.ts @@ -3,7 +3,7 @@ import "../../utils/test/jest"; import { Vpc } from "@aws-cdk/aws-ec2"; import { DatabaseInstanceEngine, ParameterGroup, PostgresEngineVersion } from "@aws-cdk/aws-rds"; import { Stack } from "@aws-cdk/core"; -import { TrackingTag } from "../../constants/library-info"; +import { TrackingTag } from "../../constants/tracking-tag"; import { alphabeticalTags, simpleGuStackForTesting } from "../../utils/test"; import { GuDatabaseInstance } from "./instance"; diff --git a/src/patterns/ec2-app.test.ts b/src/patterns/ec2-app.test.ts index e48b55d5f3..87a07e6bc2 100644 --- a/src/patterns/ec2-app.test.ts +++ b/src/patterns/ec2-app.test.ts @@ -1,7 +1,7 @@ import "@aws-cdk/assert/jest"; import { SynthUtils } from "@aws-cdk/assert"; import { Stage } from "../constants"; -import { TrackingTag } from "../constants/library-info"; +import { TrackingTag } from "../constants/tracking-tag"; import { GuDistributionBucketParameter, GuPrivateConfigBucketParameter } from "../constructs/core"; import { alphabeticalTags, simpleGuStackForTesting } from "../utils/test"; import { GuApplicationPorts, GuEc2App, GuNodeApp, GuPlayApp } from "./ec2-app";