How to use onRunComplete method in ava

...9test('Will not play onSuitePass if no test ran', () => {10  const subject = new AudioReporter(gc(), {})11  subject.options = runtimeOptions({ onSuitePass: ['audio/onSuitePass/昇格.mp3'] })12  subject.player = { play() { throw new Error('should not play') } }13  subject.onRunComplete({}, ar({ numTotalTestSuites: 0 }))14})15test('Will not play onStart if test estimated to take less than 10s to run', () => {16  const subject = new AudioReporter(gc(), {})17  subject.options = runtimeOptions({18    onSuitePass: ['audio/onSuitePass/昇格.mp3']19  })20  subject.player = { play() { throw new Error('should not play') } }21  subject.onRunStart(ar(), { estimatedTime: 10, showStatus: false })22})23test('Will play onStart if test estimated to take more than 10s to run', () => {24  const subject = new AudioReporter(gc(), {})25  subject.options = runtimeOptions({ onSuitePass: ['audio/onSuitePass/昇格.mp3'] })26  const o = new AssertOrder(1)27  subject.player = { play() { o.once(1) } }28  subject.onRunStart(ar(), { estimatedTime: 10.01, showStatus: false })29  o.end()30})31test('Will play onStart if there is no estimate', () => {32  const subject = new AudioReporter(gc(), {})33  subject.options = runtimeOptions({ onSuitePass: ['audio/onSuitePass/昇格.mp3'] })34  const o = new AssertOrder(1)35  subject.player = { play() { o.once(1) } }36  subject.onRunStart(ar({ numTotalTestSuites: 1 }), { estimatedTime: 0, showStatus: false })37  o.end()38})39test('pick one if onStart has more than one entry', () => {40  const subject = new AudioReporter(gc(), {})41  subject.options = runtimeOptions({42    onStart: ['audio/onSuitePass/昇格.mp3', 'audio/onSuitePass/勝利ジングル.mp3']43  })44  const calls = [0, 0]45  subject.player = {46    play(file) {47      calls[subject.options.onStart.indexOf(file)]++48    }49  }50  for (let i = 0; i < 100; i++)51    subject.onRunStart(ar(), { estimatedTime: 10.01, showStatus: false })52  t(calls[0] * calls[1] > 0)53})54test('pick one if onSuitePass is an array', () => {55  const subject = new AudioReporter(gc(), {})56  subject.options = runtimeOptions({57    onSuitePass: ['audio/onSuitePass/昇格.mp3', 'audio/onSuitePass/勝利ジングル.mp3']58  })59  const calls = [0, 0]60  subject.player = {61    play(file) {62      calls[subject.options.onSuitePass.indexOf(file)]++63    }64  }65  for (let i = 0; i < 100; i++)66    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))67  t(calls[0] * calls[1] > 0)68})69test('pick one if onSuiteFailure is an array', () => {70  const subject = new AudioReporter(gc(), {})71  subject.options = runtimeOptions({72    onSuiteFailure: ['audio/onSuitePass/昇格.mp3', 'audio/onSuitePass/勝利ジングル.mp3']73  })74  const calls = [0, 0]75  subject.player = {76    play(file) {77      calls[subject.options.onSuiteFailure.indexOf(file)]++78    }79  }80  for (let i = 0; i < 100; i++)81    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 1 }))82  t(calls[0] * calls[1] > 0)83})84describe('watch mode', () => {85  test('play onSuitePass on first run', () => {86    const subject = new AudioReporter(gc({ watch: true }), {})87    subject.options = runtimeOptions({88      onSuitePass: ['audio/onSuitePass/昇格.mp3']89    })90    store.reset()91    const o = new AssertOrder(1)92    subject.player = { play() { o.once(1) } }93    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))94    o.end()95  })96  test('do not play onSuitePass on second pass', () => {97    const subject = new AudioReporter(gc({ watch: true }), {})98    subject.options = runtimeOptions({99      onSuitePass: ['audio/onSuitePass/昇格.mp3']100    })101    store.reset()102    const o = new AssertOrder(1)103    subject.player = { play() { o.once(1) } }104    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))105    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))106    o.end()107  })108  test('play onSuitePass again on pass after failure', () => {109    const subject = new AudioReporter(gc({ watch: true }), {})110    subject.options = runtimeOptions({111      onSuitePass: ['audio/onSuitePass/昇格.mp3'],112      onSuiteFailure: ['audio/onSuitePass/昇格.mp3']113    })114    store.reset()115    const o = new AssertOrder(1)116    subject.player = {117      play() {118        o.exactly(1, 3)119      }120    }121    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))122    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 1 }))123    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))124    o.end()125  })126  test('do not play onSuitePass/Failure on interruption', () => {127    const subject = new AudioReporter(gc({ watch: true }), {})128    subject.options = runtimeOptions({129      onSuitePass: ['audio/onSuitePass/昇格.mp3'],130      onSuiteFailure: ['audio/onSuitePass/昇格.mp3']131    })132    store.reset()133    subject.player = { play() { throw new Error('should not play') } }134    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0, wasInterrupted: true }))135    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 1, wasInterrupted: true }))136  })137  test('kill onStart when run completes', () => {138    const subject = new AudioReporter(gc({ watch: true }), {})139    subject.options = runtimeOptions({140      onStart: ['audio/onSuitePass/昇格.mp3']141    })142    store.reset()143    const o = new AssertOrder(1)144    subject.player = { play() { return { kill() { o.once(1) } } } }145    subject.onRunStart(ar(), { estimatedTime: 11, showStatus: false })146    subject.onRunComplete({}, ar())147    o.end()148  })149  test('kill onSuitePass when run starts', () => {150    const subject = new AudioReporter(gc({ watch: true }), {})151    subject.options = runtimeOptions({152      onStart: ['audio/onSuitePass/昇格.mp3'],153      onSuitePass: ['audio/onSuitePass/昇格.mp3']154    })155    store.reset()156    const o = new AssertOrder(1)157    subject.player = { play() { return { kill() { o.once(1) } } } }158    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 0 }))159    subject.onRunStart(ar(), { estimatedTime: 11, showStatus: false })160    o.end()161  })162  test('kill onSuiteFailure when run starts', () => {163    const subject = new AudioReporter(gc({ watch: true }), {})164    subject.options = runtimeOptions({165      onStart: ['audio/onSuitePass/昇格.mp3'],166      onSuiteFailure: ['audio/onSuitePass/昇格.mp3']167    })168    store.reset()169    const o = new AssertOrder(1)170    subject.player = { play() { return { kill() { o.once(1) } } } }171    subject.onRunComplete({}, ar({ numTotalTestSuites: 1, numFailedTestSuites: 1 }))172    subject.onRunStart(ar(), { estimatedTime: 11, showStatus: false })173    o.end()174  })175})176test('when debug = true, log is enabled', () => {177  store.devel = true178  try {179    const subject = new AudioReporter(gc(), { debug: true })180    t.strictEqual(subject.log.enabled, true)181  }182  catch {183    store.devel = false184  }185})186test('when debug = false, log is not enabled', () => {187  const subject = new AudioReporter(gc(), { debug: false })188  t.strictEqual(subject.log.enabled, false)189})190test('lower master volume in OSX affect onStart', () => {191  const subject = new AudioReporter(gc(), { volume: 0.25 })192  let actual193  subject.player = { player: 'afplay', play(_file, option) { actual = option } }194  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))195  t.deepStrictEqual(actual, { afplay: ['-v', 0.01] })196})197test('lower master volume in OSX affect onComplete', () => {198  const subject = new AudioReporter(gc(), { volume: 0.25 })199  let actual200  subject.player = { player: 'afplay', play(_file, option) { actual = option } }201  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))202  t.deepStrictEqual(actual, { afplay: ['-v', 0.01] })203})204test('lower master volume in Windows affect onStart', () => {205  const subject = new AudioReporter(gc(), { volume: 0.25 })206  let actual207  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }208  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))209  t.deepStrictEqual(actual, { mplayer: ['-volume', 25] })210})211test('lower master volume in Windows affect onComplete', () => {212  const subject = new AudioReporter(gc(), { volume: 0.25 })213  let actual214  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }215  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))216  t.deepStrictEqual(actual, { mplayer: ['-volume', 25] })217})218test('lower onStartVolume in OSX affect onStart', () => {219  const subject = new AudioReporter(gc(), { onStartVolume: 0.25 })220  let actual221  subject.player = { player: 'afplay', play(_file, option) { actual = option } }222  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))223  t.deepStrictEqual(actual, { afplay: ['-v', 0.01] })224})225test('lower onStartVolume in OSX will not affect onComplete', () => {226  const subject = new AudioReporter(gc(), { onStartVolume: 0.25 })227  let actual228  subject.player = { player: 'afplay', play(_file, option) { actual = option } }229  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))230  t.deepStrictEqual(actual, { afplay: ['-v', 1] })231})232test('lower onStartVolume in Windows affect onStart', () => {233  const subject = new AudioReporter(gc(), { onStartVolume: 0.25 })234  let actual235  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }236  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))237  t.deepStrictEqual(actual, { mplayer: ['-volume', 25] })238})239test('lower onStartVolume in Windows will not affect onComplete', () => {240  const subject = new AudioReporter(gc(), { onStartVolume: 0.25 })241  let actual242  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }243  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))244  t.deepStrictEqual(actual, { mplayer: ['-volume', 100] })245})246test('lower onCompleteVolume in OSX will not affect onStart', () => {247  const subject = new AudioReporter(gc(), { onCompleteVolume: 0.25 })248  let actual249  subject.player = { player: 'afplay', play(_file, option) { actual = option } }250  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))251  t.deepStrictEqual(actual, { afplay: ['-v', 0.1] })252})253test('lower onCompleteVolume in OSX affect onComplete', () => {254  const subject = new AudioReporter(gc(), { onCompleteVolume: 0.25 })255  let actual256  subject.player = { player: 'afplay', play(_file, option) { actual = option } }257  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))258  t.deepStrictEqual(actual, { afplay: ['-v', 0.01] })259})260test('lower onCompleteVolume in Windows will not affect onStart', () => {261  const subject = new AudioReporter(gc(), { onCompleteVolume: 0.25 })262  let actual263  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }264  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))265  t.deepStrictEqual(actual, { mplayer: ['-volume', 50] })266})267test('lower onCompleteVolume in Windows affect onComplete', () => {268  const subject = new AudioReporter(gc(), { onCompleteVolume: 0.25 })269  let actual270  subject.player = { player: 'mplayer', play(_file, option) { actual = option } }271  subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))272  t.deepStrictEqual(actual, { mplayer: ['-volume', 25] })273})274test('disable will not play when complete', async () => {275  const subject = new AudioReporter(gc(), { disable: true })276  subject.player = { player: 'mplayer', play() { throw new Error('should not call') } }277  await subject.onRunComplete(undefined, ar({ numTotalTestSuites: 1 }))278})279test('disable will not play when complete', () => {280  const subject = new AudioReporter(gc(), { disable: true })281  subject.player = { player: 'mplayer', play() { throw new Error('should not call') } }282  subject.onRunStart(ar({ numTotalTestSuites: 1 }), roso({ estimatedTime: 11 }))283})284function gc(config: Partial<Config.GlobalConfig> = {}) {285  return config as Config.GlobalConfig286}287function ar(results: Partial<AggregatedResult> = {}) {288  return results as AggregatedResult289}290function roso(options: Partial<ReporterOnStartOptions> = {}) {291  return options as ReporterOnStartOptions...

...84    console.log('Activating reruns with interval (ms)', intervalMs);85    this._intervalMs = intervalMs;86    this._timeout = null;87  }88  onRunComplete() {89    this._timeout !== null && clearTimeout(this._timeout);90    if (!ASSERT_IS_DEV && RERUN_WAIT) {91      this._timeout = setTimeout(() => {92        tracker.modifyAll();93      }, this._intervalMs);94    }95  }96}97const reruns = new Reruns({98  tracker,99  intervalMs: RERUN_WAIT * 1000100});101class MetricsServer {102  constructor({ port, getMetrics }) {103    this.port = port;104    this.getMetrics = getMetrics;105  }106  serveMetrics(res) {107    res.writeHead(200, { 'Content-Type': 'text/plain' });108    res.end(this.getMetrics());109  }110  serveRerun(res) {111    console.log('Rerun endpoint called');112    tracker.modifyAll();113    res.writeHead(200, { 'Content-Type': 'text/plain' });114    res.end('{}');115  }116  start() {117    this.server = http.createServer((req, res) => {118      //console.log('req', req.url, req.headers);119      if ('/metrics' == req.url) return this.serveMetrics(res);120      if ('POST' == req.method && '/rerun' == req.url) return this.serveRerun(res);121      res.writeHead(404, { 'Content-Length': '0' });122      res.end();123    });124    this.server.on('clientError', (err, socket) => {125      socket.end('HTTP/1.1 400 Bad Request\r\n\r\n');126    });127    this.server.listen(this.port, '0.0.0.0');128    console.log('Server listening on port', this.port);129  }130  stop() {131    this.server.close();132  }133}134const server = new MetricsServer({135  port: PORT,136  getMetrics: () => register.metrics()137});138server.start();139class MetricsReporter {140  constructor(globalConfig, options) {141    this._globalConfig = globalConfig;142    this._options = options;143    // Can't change how Jest instantiates the reporter, so get this one from global144    this._tracker = tracker;145  }146  onRunStart() {147    //console.log('onRunStart', arguments);148  }149  150  onTestStart() {151    //console.log('onTestStart', arguments);152  }153  onRunComplete(contexts, results) {154    //console.log('onRunComplete', contexts, results);155    const { testResults } = results;156    for (let i = 0; i < testResults.length; i++) {157      const { testFilePath, numFailingTests } = testResults[i];158      this._tracker.pathSeen(testFilePath, { numFailingTests });159    }160    test_suites_run.set(results.numTotalTestSuites);161    test_suites_run_total.inc(results.numTotalTestSuites);162    tests_run.set(results.numTotalTests);163    tests_run_total.inc(results.numTotalTests);164    assertions_failed_total.inc(results.numFailedTests);165    if (!this._globalConfig.watch && !this._globalConfig.watchAll) {166      //console.log('Not a watch run. Exiting');167      server.stop();168    }169    reruns.onRunComplete();170  }171}...

...90};91SubSuite.prototype.signalRunComplete = function signalRunComplete(error) {92  if (!this.onRunComplete) return;93  this.state = 'complete';94  this.onRunComplete(error);95  this.onRunComplete = null;96}...

...18    delete process.env.BUILDKITE_ANALYTICS_TOKEN19  })20  it('prints a console message and returns', () => {21    const reporter = new JestBuildkiteAnalyticsReporter({}, {})22    reporter.onRunComplete({}, {})23    expect(console.error).toBeCalledTimes(1)24    expect(console.error).toHaveBeenLastCalledWith('Missing BUILDKITE_ANALYTICS_TOKEN')25  })26})27describe('with empty token', () => {28  beforeEach(() => {29    process.env.BUILDKITE_ANALYTICS_TOKEN = ''30  })31  it('prints a console message and returns', () => {32    const reporter = new JestBuildkiteAnalyticsReporter({}, {})33    reporter.onRunComplete({}, {})34    expect(console.error).toBeCalledTimes(1)35    expect(console.error).toHaveBeenLastCalledWith('Missing BUILDKITE_ANALYTICS_TOKEN')36  })37})38describe('with token "abc"', () => {39  beforeEach(() => {40    process.env.BUILDKITE_ANALYTICS_TOKEN = 'abc';41    process.env.BUILDKITE_ANALYTICS_KEY = 'key123';42  })43  describe('result chunking', () => {44    it('posts a result', () => {45      axios.post.mockResolvedValue({ data: "Success" })46      const reporter = new JestBuildkiteAnalyticsReporter({}, {})47      reporter._testResults = ['result']48      reporter.onRunComplete({}, {})49      expect(axios.post.mock.calls[0]).toEqual([50        "https://analytics-api.buildkite.com/v1/uploads",51        {52          "data": [ "result" ],53          "format": "json",54          "run_env": {55            "ci": "generic",56            "collector": "js-buildkite-test-collector",57            "key": "key123",58            "version": version59          }60        },61        {62          "headers": {63            "Authorization": "Token token=\"abc\"",64            "Content-Type": "application/json",65          }66        }67      ])68    })69    it('does a single posts if < 5000', () => {70      axios.post.mockResolvedValue({ data: "Success" });71      72      const reporter = new JestBuildkiteAnalyticsReporter({}, {})73      reporter._testResults = Array(4999).fill('result')74      reporter.onRunComplete({}, {})75      expect(axios.post.mock.calls.length).toBe(1)76    })77    it('posts 5000 results at a time', () => {78      axios.post.mockResolvedValue({ data: "Success" })79      80      const reporter = new JestBuildkiteAnalyticsReporter({}, {})81      reporter._testResults = Array(12000).fill('result')82      reporter.onRunComplete({}, {})83      expect(axios.post.mock.calls.length).toBe(3)84    })85  })...

...4  private _globalConfig: Config.GlobalConfig;5  constructor(globalConfig: Config.GlobalConfig) {6    this._globalConfig = globalConfig;7  }8  onRunComplete(_contexts: Set<Context>, results: AggregatedResult) {9    const failures: Record<string, string[]> = {};10    results.testResults.map((result) => {11      const filePath = path.relative(this._globalConfig.rootDir, result.testFilePath);12      result.testResults.map((assertionResult) => {13        if (assertionResult.status === 'failed') {14          failures[filePath] = failures[filePath] || [];15          failures[filePath].push(assertionResult.fullName);16        }17      });18    });19    if (Object.keys(failures).length) {20      console.log('\nFailed test summary:\n');21      Object.entries(failures).forEach(([file, testFailures]) => {22        console.log(file);...