Merge pull request #100 from buildkite/upload-tags-option

pda · web-flow · commit da1a0126f5ef · 2025-02-10T15:46:51.000+10:30
Introduce `tags` option
diff --git a/e2e/cypress.test.js b/e2e/cypress.test.js
@@ -65,6 +65,8 @@ describe('examples/cypress', () => {
       expect(json).toHaveProperty("run_env.version")
       expect(json).toHaveProperty("run_env.collector", "js-buildkite-test-collector")
 
+      expect(json).toHaveProperty("tags", { "hello": "cypress" }) // examples/cypress/cypress.config.js
+
       expect(json).toHaveProperty("data[0].name", 'renders')
       expect(json).toHaveProperty("data[0].identifier", '<Component /> renders')
       expect(json).toHaveProperty("data[0].location", "cypress/component/Component.cy.jsx") // Cypress does not report test line numbers, otherwise we'd see it here
diff --git a/e2e/jasmine.test.js b/e2e/jasmine.test.js
@@ -63,6 +63,8 @@ describe('examples/jasmine', () => {
       expect(json).toHaveProperty("run_env.version")
       expect(json).toHaveProperty("run_env.collector", "js-buildkite-test-collector")
 
+      expect(json).toHaveProperty("tags", { "hello": "jasmine" }) // examples/jasmine/spec/example.spec.js
+
       expect(json).toHaveProperty("data[0].name", '1 + 2 to equal 3')
       expect(json).toHaveProperty("data[0].location", "spec/example.spec.js:7")
       expect(json).toHaveProperty("data[0].file_name", "spec/example.spec.js")
diff --git a/e2e/jest.test.js b/e2e/jest.test.js
@@ -70,6 +70,8 @@ describe('examples/jest', () => {
       expect(json).toHaveProperty("run_env.version")
       expect(json).toHaveProperty("run_env.collector", "js-buildkite-test-collector")
 
+      expect(json).toHaveProperty("tags", { "hello": "jest" }) // examples/jest/jest.config.js
+
       expect(json).toHaveProperty("data[0].scope", '')
       expect(json).toHaveProperty("data[0].name", '1 + 2 to equal 3')
       expect(json).toHaveProperty("data[0].location", "example.test.js:2")
@@ -121,7 +123,7 @@ describe('examples/jest', () => {
 
     test('it should not throw an error', (done) => {
       exec('npm test passed.test.js', { cwd, env }, (error, stdout, stderr) => {
-        console.log(stdout)
+        //console.log(stdout)
         expect(error).toBeNull()
 
         done()
diff --git a/e2e/mocha.test.js b/e2e/mocha.test.js
@@ -70,6 +70,8 @@ describe('examples/mocha', () => {
       expect(json).toHaveProperty("run_env.version")
       expect(json).toHaveProperty("run_env.collector", "js-buildkite-test-collector")
 
+      expect(json).toHaveProperty("tags", {"hello": "mocha"}) // examples/mocha/config.json
+
       expect(json).toHaveProperty("data[0].name", '1 + 2 to equal 3')
       expect(json).toHaveProperty("data[0].location", "test.js") // Mocha does not report test line numbers, otherwise we'd see it here
       expect(json).toHaveProperty("data[0].file_name", "test.js")
diff --git a/e2e/playwright.test.js b/e2e/playwright.test.js
@@ -61,6 +61,8 @@ describe('examples/playwright', () => {
     expect(data).toHaveProperty("run_env.version")
     expect(data).toHaveProperty("run_env.collector", "js-buildkite-test-collector")
 
+    expect(data).toHaveProperty("tags", { "hello": "playwright" }) // examples/playwright/playwright.config.js
+
     expect(data).toHaveProperty("data[0].scope", ' chromium example.spec.js has title')
     expect(data).toHaveProperty("data[0].name", 'has title')
     expect(data).toHaveProperty("data[0].location", "tests/example.spec.js:3:1")
diff --git a/examples/cypress/cypress.config.js b/examples/cypress/cypress.config.js
@@ -4,6 +4,7 @@ module.exports = defineConfig({
   reporter: "../../cypress/reporter",
   reporterOptions: {
     token_name: "BUILDKITE_ANALYTICS_TOKEN",
+    tags: { "hello": "cypress" },
   },
   component: {
     devServer: {
diff --git a/examples/jasmine/spec/example.spec.js b/examples/jasmine/spec/example.spec.js
@@ -1,6 +1,6 @@
 let axios = require('axios')
 var BuildkiteReporter = require('buildkite-test-collector/jasmine/reporter');
-var buildkiteReporter = new BuildkiteReporter();
+var buildkiteReporter = new BuildkiteReporter(undefined, { tags: { hello: "jasmine" }});
 jasmine.getEnv().addReporter(buildkiteReporter);
 
 // No scope
@@ -18,4 +18,4 @@ describe('sum', () => {
 // Test instrumenting a HTTP request
 it('connects to buildkite.com', async () => {
   const response = await axios.get('https://buildkite.com/')
-})
+})
diff --git a/examples/jest/jest.config.js b/examples/jest/jest.config.js
@@ -2,11 +2,13 @@ const config = {
   // Send results to Test Analytics
   reporters: [
     'default',
-    'buildkite-test-collector/jest/reporter'
+    ['buildkite-test-collector/jest/reporter', {
+      tags: { hello: "jest" }
+    }]
   ],
 
   // Enable column + line capture for Test Analytics
   testLocationInResults: true
 };
 
-module.exports = config;
+module.exports = config;
diff --git a/examples/mocha/config.json b/examples/mocha/config.json
@@ -1,3 +1,8 @@
 {
-  "reporterEnabled": "spec, buildkite-test-collector/mocha/reporter"
-}
+  "reporterEnabled": "spec, buildkite-test-collector/mocha/reporter",
+  "buildkiteTestCollectorMochaReporterReporterOptions": {
+    "tags": {
+      "hello": "mocha"
+    }
+  }
+}
diff --git a/examples/playwright/playwright.config.js b/examples/playwright/playwright.config.js
@@ -5,7 +5,12 @@ const { defineConfig, devices } = require('@playwright/test');
  */
 module.exports = defineConfig({
   testDir: './tests',
-  reporter: [['line'], ['buildkite-test-collector/playwright/reporter']],
+  reporter: [
+    ['line'],
+    ['buildkite-test-collector/playwright/reporter', {
+      tags: { "hello": "playwright" }
+    }]
+  ],
   webServer: {
     command: 'npm start',
     url: 'http://127.0.0.1:18080',
diff --git a/jasmine/reporter.js b/jasmine/reporter.js
@@ -42,6 +42,7 @@ class JasmineBuildkiteAnalyticsReporter {
     this._options = options
     this._testResults = []
     this._testEnv = (new CI()).env();
+    this._tags = options?.tags;
     this._paths = new Paths(config, this._testEnv.location_prefix)
   }
 
@@ -76,7 +77,7 @@ class JasmineBuildkiteAnalyticsReporter {
   }
 
   jasmineDone(result, done) {
-    return uploadTestResults(this._testEnv, this._testResults, this._options, done)
+    return uploadTestResults(this._testEnv, this._tags, this._testResults, this._options, done)
   }
 
   analyticsResult(testResult) {
@@ -101,4 +102,4 @@ class JasmineBuildkiteAnalyticsReporter {
   }
 }
 
-module.exports = JasmineBuildkiteAnalyticsReporter
+module.exports = JasmineBuildkiteAnalyticsReporter
diff --git a/jest/reporter.js b/jest/reporter.js
@@ -9,6 +9,7 @@ class JestBuildkiteAnalyticsReporter {
     this._options = options
     this._testResults = []
     this._testEnv = (new CI()).env();
+    this._tags = options?.tags;
     this._paths = new Paths(globalConfig, this._testEnv.location_prefix)
   }
 
@@ -24,7 +25,7 @@ class JestBuildkiteAnalyticsReporter {
   }
 
   onRunComplete(_test, _results, _options) {
-    return uploadTestResults(this._testEnv, this._testResults, this._options)
+    return uploadTestResults(this._testEnv, this._tags, this._testResults, this._options)
   }
 
   onTestStart(test) {
diff --git a/mocha/reporter.js b/mocha/reporter.js
@@ -22,6 +22,7 @@ class MochaBuildkiteAnalyticsReporter {
     this._options = { token: process.env[`${options.reporterOptions.token_name}`]}
     this._testResults = []
     this._testEnv = (new CI()).env();
+    this._tags = options.reporterOptions.tags;
     this._paths = new Paths({ cwd: process.cwd() }, this._testEnv.location_prefix)
 
     runner
@@ -66,7 +67,7 @@ class MochaBuildkiteAnalyticsReporter {
   // On the other hand, done() can be used to wait for an async process and programatically exit the process, even when `--exit` option is used.
   // ref: https://github.com/mochajs/mocha/pull/1218
   done(_failures, exit) {
-    uploadTestResults(this._testEnv, this._testResults, this._options, exit)
+    uploadTestResults(this._testEnv, this._tags, this._testResults, this._options, exit)
   }
 
   analyticsResult(state) {
diff --git a/playwright/reporter.js b/playwright/reporter.js
@@ -24,6 +24,7 @@ class PlaywrightBuildkiteAnalyticsReporter {
   constructor(options) {
     this._testResults = [];
     this._testEnv = (new CI()).env();
+    this._tags = options?.tags;
     this._options = options;
     this._paths = new Paths({ cwd: process.cwd() }, this._testEnv.location_prefix);
   }
@@ -32,7 +33,7 @@ class PlaywrightBuildkiteAnalyticsReporter {
 
   onEnd() {
     return new Promise(resolve => {
-      uploadTestResults(this._testEnv, this._testResults, this._options, resolve);
+      uploadTestResults(this._testEnv, this._tags, this._testResults, this._options, resolve);
     })
   }
 
diff --git a/util/uploadTestResults.js b/util/uploadTestResults.js
@@ -4,7 +4,7 @@ const axios = require('axios')
 const CHUNK_SIZE = 5000
 const DEFAULT_BUILDKITE_ANALYTICS_BASE_URL = 'https://analytics-api.buildkite.com/v1/uploads'
 
-const uploadTestResults = (env, results, options, done) => {
+const uploadTestResults = (env, tags, results, options, done) => {
   const buildkiteAnalyticsToken = options?.token || process.env.BUILDKITE_ANALYTICS_TOKEN
   const buildkiteAnalyticsUrl = options?.url || process.env.BUILDKITE_ANALYTICS_BASE_URL || DEFAULT_BUILDKITE_ANALYTICS_BASE_URL
 
@@ -58,6 +58,7 @@ const uploadTestResults = (env, results, options, done) => {
     const data = {
       'format': 'json',
       'run_env': env,
+      'tags': tags || {},
       "data": results.slice(i, i + CHUNK_SIZE),
     }
 
diff --git a/util/uploadTestResults.test.js b/util/uploadTestResults.test.js
@@ -36,14 +36,14 @@ describe('with no token', () => {
   })
 
   it('prints a console message and returns', () => {
-    uploadTestResults({}, [])
+    uploadTestResults({}, {}, [])
 
     expect(console.error).toBeCalledTimes(1)
     expect(console.error).toHaveBeenLastCalledWith('Missing BUILDKITE_ANALYTICS_TOKEN')
   })
 
   ensureDoneBeingCalledOnce(mockDone => {
-    uploadTestResults({}, [], {}, mockDone)
+    uploadTestResults({}, {}, [], {}, mockDone)
   });
 })
 
@@ -53,14 +53,14 @@ describe('with empty token', () => {
   })
 
   it('prints a console message and returns', () => {
-    uploadTestResults({}, [])
+    uploadTestResults({}, {}, [])
 
     expect(console.error).toBeCalledTimes(1)
     expect(console.error).toHaveBeenLastCalledWith('Missing BUILDKITE_ANALYTICS_TOKEN')
   })
 
   ensureDoneBeingCalledOnce(mockDone => {
-    uploadTestResults({}, [], {}, mockDone)
+    uploadTestResults({}, {}, [], {}, mockDone)
   });
 })
 
@@ -72,7 +72,7 @@ describe('with token "abc" defined in reporter options', () => {
   it('posts a result', () => {
     axios.post.mockResolvedValue({ data: "Success" })
 
-    uploadTestResults(new CI().env(), ['result'], { token: 'abc' })
+    uploadTestResults(new CI().env(), {}, ['result'], { token: 'abc' })
 
     expect(axios.post.mock.calls[0]).toEqual([
       "https://analytics-api.buildkite.com/v1/uploads",
@@ -84,7 +84,8 @@ describe('with token "abc" defined in reporter options', () => {
           "collector": "js-buildkite-test-collector",
           "key": "key123",
           "version": version
-        }
+        },
+        "tags": {}
       },
       {
         "headers": {
@@ -96,7 +97,7 @@ describe('with token "abc" defined in reporter options', () => {
   })
 
   ensureDoneBeingCalledOnce(async mockDone => {
-    await uploadTestResults(new CI().env(), ['result'], { token: 'abc' }, mockDone)
+    await uploadTestResults(new CI().env(), {}, ['result'], { token: 'abc' }, mockDone)
   });
 })
 
@@ -106,11 +107,21 @@ describe('with token "abc"', () => {
     process.env.BUILDKITE_ANALYTICS_KEY = 'key123';
   })
 
+  describe('with tags', () => {
+    it('posts tags', () => {
+      axios.post.mockResolvedValue({ data: "Success" })
+
+      uploadTestResults(new CI().env(), {"hello": "world"}, ['result'])
+
+      expect(axios.post.mock.calls[0][1].tags).toEqual({"hello": "world"});
+    });
+  });
+
   describe('result chunking', () => {
     it('posts a result', () => {
       axios.post.mockResolvedValue({ data: "Success" })
 
-      uploadTestResults(new CI().env(), ['result'])
+      uploadTestResults(new CI().env(), {}, ['result'])
 
       expect(axios.post.mock.calls[0]).toEqual([
         "https://analytics-api.buildkite.com/v1/uploads",
@@ -122,7 +133,8 @@ describe('with token "abc"', () => {
             "collector": "js-buildkite-test-collector",
             "key": "key123",
             "version": version
-          }
+          },
+          "tags": {}
         },
         {
           "headers": {
@@ -136,33 +148,33 @@ describe('with token "abc"', () => {
     it('does a single posts if < 5000', () => {
       axios.post.mockResolvedValue({ data: "Success" });
 
-      uploadTestResults({}, Array(4999).fill('result'))
+      uploadTestResults({}, {}, Array(4999).fill('result'))
 
       expect(axios.post.mock.calls.length).toBe(1)
     })
 
     it('posts 5000 results at a time', () => {
       axios.post.mockResolvedValue({ data: "Success" })
 
-      uploadTestResults({}, Array(12000).fill('result'))
+      uploadTestResults({}, {}, Array(12000).fill('result'))
 
       expect(axios.post.mock.calls.length).toBe(3)
     })
 
     ensureDoneBeingCalledOnce(async mockDone => {
-      await uploadTestResults({}, Array(12000).fill('result'), {}, mockDone)
+      await uploadTestResults({}, {}, Array(12000).fill('result'), {}, mockDone)
     });
   })
 
   describe('with no results', () => {
     it('does not post', () => {
-      uploadTestResults({}, [])
+      uploadTestResults({}, {}, [])
 
       expect(axios.post.mock.calls.length).toBe(0)
     })
 
     ensureDoneBeingCalledOnce(async mockDone => {
-      await uploadTestResults({}, [], {}, mockDone)
+      await uploadTestResults({}, {}, [], {}, mockDone)
     });
   })
 })
