Merge pull request #247 from DataDog/bump-datadog-ci/2.35.0

Drarig29 · web-flow · commit 5befc2fbac4d · 2024-05-21T17:48:45.000+02:00
[dep] Bump datadog-ci to `2.35.0`
diff --git a/.github/workflows/e2e/global.config.json b/.github/workflows/e2e/global.config.json
@@ -1,5 +1,5 @@
 {
-  "global": {
+  "defaultTestOverrides": {
     "headers": {
       "X-Fake-Header": "fake value"
     },
diff --git a/README.md b/README.md
@@ -93,9 +93,9 @@ jobs:
           variables: 'START_URL=https://staging.website.com,PASSWORD=stagingpassword'
 ```
 
-### Example workflow using a global configuration override with `config_path`
+### Example workflow using a global configuration file with `config_path`
 
-This GitHub Action overrides the path to the global `datadog-ci.config.json` file.
+By default, the path to the global configuration file is `datadog-ci.json`. You can override this path with the `config_path` input.
 
 ```yaml
 name: Run Synthetic tests with custom config
@@ -110,10 +110,10 @@ jobs:
         with:
           api_key: ${{secrets.DD_API_KEY}}
           app_key: ${{secrets.DD_APP_KEY}}
-          config_path: './synthetics-config.json'
+          config_path: './global.config.json'
 ```
 
-For an example test file, see this [`global.config.json` file][13].
+For an example of global configuration file, see this [`global.config.json` file][13].
 
 ## Inputs
 
diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -53,8 +53,8 @@ describe('Run Github Action', () => {
       expect(synthetics.executeTests).toHaveBeenCalledWith(expect.anything(), {
         ...config,
         ...inputs,
-        global: {
-          ...config.global,
+        defaultTestOverrides: {
+          ...config.defaultTestOverrides,
           pollingTimeout: config.pollingTimeout,
         },
       })
@@ -72,8 +72,8 @@ describe('Run Github Action', () => {
       expect(synthetics.executeTests).toHaveBeenCalledWith(expect.anything(), {
         ...config,
         ...inputs,
-        global: {
-          ...config.global,
+        defaultTestOverrides: {
+          ...config.defaultTestOverrides,
           pollingTimeout: config.pollingTimeout,
         },
         publicIds,
@@ -92,8 +92,8 @@ describe('Run Github Action', () => {
       expect(synthetics.executeTests).toHaveBeenCalledWith(expect.anything(), {
         ...config,
         ...inputs,
-        global: {
-          ...config.global,
+        defaultTestOverrides: {
+          ...config.defaultTestOverrides,
           pollingTimeout: config.pollingTimeout,
           variables: {
             START_URL: 'https://example.org',
@@ -120,8 +120,8 @@ describe('Run Github Action', () => {
       expect(synthetics.executeTests).toHaveBeenCalledWith(expect.anything(), {
         ...config,
         ...inputs,
-        global: {
-          ...config.global,
+        defaultTestOverrides: {
+          ...config.defaultTestOverrides,
           pollingTimeout: config.pollingTimeout,
         },
       })
@@ -144,8 +144,8 @@ describe('Run Github Action', () => {
         ...config,
         ...inputs,
         datadogSite: 'datadoghq.com',
-        global: {
-          ...config.global,
+        defaultTestOverrides: {
+          ...config.defaultTestOverrides,
           pollingTimeout: config.pollingTimeout,
         },
       })
diff --git a/__tests__/resolve-config.test.ts b/__tests__/resolve-config.test.ts
@@ -45,26 +45,29 @@ describe('Resolves Config', () => {
     ) => {
       callback(null, Buffer.from(JSON.stringify({files: ['foobar.synthetics.json']})))
     }) as typeof fs.readFile
+
     jest.spyOn(fs, 'existsSync').mockImplementation(() => true)
     jest.spyOn(fs, 'readFile').mockImplementation(fakeReadFile)
+
     await expect(resolveConfig.resolveConfig(mockReporter)).resolves.toStrictEqual({
       ...config,
       ...requiredInputs,
       files: ['foobar.synthetics.json'],
-      global: {
-        ...config.global,
+      defaultTestOverrides: {
+        ...config.defaultTestOverrides,
         pollingTimeout: config.pollingTimeout,
       },
     })
   })
 
-  test('Default configuration applied if global configuration empty', async () => {
+  test('Default configuration applied if global configuration is empty', async () => {
     jest.spyOn(fs, 'existsSync').mockImplementation(() => false)
+
     await expect(resolveConfig.resolveConfig(mockReporter)).resolves.toStrictEqual({
       ...config,
       ...requiredInputs,
-      global: {
-        ...config.global,
+      defaultTestOverrides: {
+        ...config.defaultTestOverrides,
         pollingTimeout: config.pollingTimeout,
       },
     })
@@ -79,8 +82,8 @@ describe('Resolves Config', () => {
     await expect(resolveConfig.resolveConfig(mockReporter)).resolves.toStrictEqual({
       ...config,
       ...requiredInputs,
-      global: {
-        ...config.global,
+      defaultTestOverrides: {
+        ...config.defaultTestOverrides,
         pollingTimeout: config.pollingTimeout,
         variables: {START_URL: 'https://example.org', MY_VARIABLE: 'My title'},
       },
@@ -91,8 +94,8 @@ describe('Resolves Config', () => {
     await expect(resolveConfig.resolveConfig(mockReporter)).resolves.toStrictEqual({
       ...config,
       ...requiredInputs,
-      global: {
-        ...config.global,
+      defaultTestOverrides: {
+        ...config.defaultTestOverrides,
         pollingTimeout: config.pollingTimeout,
       },
     })
@@ -130,7 +133,9 @@ describe('Resolves Config', () => {
   describe('parses integer', () => {
     test('falls back to default if input is not set', async () => {
       expect(resolveConfig.getDefinedInteger('polling_timeout')).toBeUndefined()
-      expect((await resolveConfig.resolveConfig(mockReporter)).global.pollingTimeout).toStrictEqual(30 * 60 * 1000)
+      expect((await resolveConfig.resolveConfig(mockReporter)).defaultTestOverrides?.pollingTimeout).toStrictEqual(
+        30 * 60 * 1000
+      )
     })
 
     test('falls back to default if input is an empty value', async () => {
@@ -139,7 +144,9 @@ describe('Resolves Config', () => {
         INPUT_POLLING_TIMEOUT: '',
       }
       expect(resolveConfig.getDefinedInteger('polling_timeout')).toBeUndefined()
-      expect((await resolveConfig.resolveConfig(mockReporter)).global.pollingTimeout).toStrictEqual(30 * 60 * 1000)
+      expect((await resolveConfig.resolveConfig(mockReporter)).defaultTestOverrides?.pollingTimeout).toStrictEqual(
+        30 * 60 * 1000
+      )
     })
 
     test('throws if input is a float', async () => {
@@ -155,7 +162,7 @@ describe('Resolves Config', () => {
         ...process.env,
         INPUT_POLLING_TIMEOUT: '1',
       }
-      expect((await resolveConfig.resolveConfig(mockReporter)).global.pollingTimeout).toStrictEqual(1)
+      expect((await resolveConfig.resolveConfig(mockReporter)).defaultTestOverrides?.pollingTimeout).toStrictEqual(1)
     })
   })
 })
diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
   "packageManager": "yarn@3.4.1",
   "dependencies": {
     "@actions/core": "^1.9.1",
-    "@datadog/datadog-ci": "^2.33.0",
+    "@datadog/datadog-ci": "^2.35.0",
     "deep-extend": "0.6.0"
   },
   "devDependencies": {
diff --git a/src/fixtures.ts b/src/fixtures.ts
@@ -5,6 +5,7 @@ export const config: synthetics.RunTestsCommandConfig = {
   appKey: '',
   configPath: 'datadog-ci.json',
   datadogSite: 'datadoghq.com',
+  defaultTestOverrides: {},
   failOnCriticalErrors: false,
   failOnMissingTests: false,
   failOnTimeout: true,
diff --git a/src/resolve-config.ts b/src/resolve-config.ts
@@ -54,6 +54,13 @@ export const resolveConfig = async (reporter: synthetics.MainReporter): Promise<
       appKey,
       configPath,
       datadogSite,
+      defaultTestOverrides: deepExtend(
+        config.defaultTestOverrides,
+        utils.removeUndefinedValues({
+          pollingTimeout,
+          variables: synthetics.utils.parseVariablesFromCli(variableStrings, reporter.log.bind(reporter)),
+        })
+      ),
       failOnCriticalErrors,
       failOnMissingTests,
       failOnTimeout,
@@ -63,18 +70,11 @@ export const resolveConfig = async (reporter: synthetics.MainReporter): Promise<
       subdomain,
       testSearchQuery,
       tunnel,
-      global: deepExtend(
-        config.global,
-        utils.removeUndefinedValues({
-          pollingTimeout,
-          variables: synthetics.utils.parseVariablesFromCli(variableStrings, reporter.log.bind(reporter)),
-        })
-      ),
     })
   )
 
-  // Pass root polling timeout to global override to get it applied to all tests if not defined individually
-  config.global.pollingTimeout = config.global.pollingTimeout ?? config.pollingTimeout
+  // Pass root polling timeout to default test overrides to get it applied to all tests if not defined individually
+  config.defaultTestOverrides.pollingTimeout = config.defaultTestOverrides.pollingTimeout ?? config.pollingTimeout
 
   return config
 }
diff --git a/yarn.lock b/yarn.lock
@@ -1488,9 +1488,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@datadog/datadog-ci@npm:^2.33.0":
-  version: 2.33.0
-  resolution: "@datadog/datadog-ci@npm:2.33.0"
+"@datadog/datadog-ci@npm:^2.35.0":
+  version: 2.35.0
+  resolution: "@datadog/datadog-ci@npm:2.35.0"
   dependencies:
     "@aws-sdk/client-cloudwatch-logs": ^3.537.0
     "@aws-sdk/client-iam": ^3.535.0
@@ -1540,7 +1540,7 @@ __metadata:
     yamux-js: 0.1.2
   bin:
     datadog-ci: dist/cli.js
-  checksum: bd2b66fbffb1a2b6d04b34ebc06e0fdc0bb48be86c3b6d9c2f6cc828b2bab4d881dbe1398fe39ea5a6b6921d7aef4ae6116c282c8c5efa23de515ac2ebab5683
+  checksum: 8f0e51cde69997f2584467dcd0eb89d1e49fc5d49c14599b54671cee52e0a07675a037b9e164fd7ebe3d5c70f9a0985495bb9b73612ec59bfa52d67fe0a2ca18
   languageName: node
   linkType: hard
 
@@ -3954,7 +3954,7 @@ __metadata:
   resolution: "datadog-synthetics-github-action@workspace:."
   dependencies:
     "@actions/core": ^1.9.1
-    "@datadog/datadog-ci": ^2.33.0
+    "@datadog/datadog-ci": ^2.35.0
     "@types/deep-extend": 0.4.32
     "@types/jest": ^29.5.8
     "@types/node": ^20.11.13

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "global": {`
	`2`	`+ "defaultTestOverrides": {`
`3`	`3`	`"headers": {`
`4`	`4`	`"X-Fake-Header": "fake value"`
`5`	`5`	`},`