Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Increase precision of test case duration measurements. #1793

Merged
merged 10 commits into from
Sep 8, 2021
Merged

Increase precision of test case duration measurements. #1793

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7c16400
Use higher definition clock for test case run time measurement
joac Sep 1, 2021
008aa0c
Use fake timers for duration tests
joac Sep 1, 2021
5da8dce
Nomalize dash caracter on tables
joac Sep 1, 2021
8a4fc7b
Make the normalization dash insensitive
joac Sep 1, 2021
2be6546
Remove console log and fix linter issues
joac Sep 1, 2021
824e90a
Update CHANGELOG.md
joac Sep 2, 2021
370ffbe
Merge branch 'main' into main
aslakhellesoy Sep 3, 2021
e65c7bd
Merge branch 'main' into main
aurelien-reeves Sep 7, 2021
dfcf587
Limit number of decimal places to 2 on usage formatter
joac Sep 8, 2021
96ce2fd
Fix usage formatter test
joac Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ See the [migration guide](./docs/migration.md) for details of how to migrate fro
### Added

### Changed
* Use performance timers for test case duration measurement.
joac marked this conversation as resolved.
Show resolved Hide resolved

### Deprecated

Expand Down
13 changes: 13 additions & 0 deletions features/support/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import FakeTimers, { InstalledClock } from '@sinonjs/fake-timers'
import timeMethods from '../time'

import { After, Before, formatterHelpers } from '../../'
import fs from 'fs'
import fsExtra from 'fs-extra'
Expand Down Expand Up @@ -110,3 +113,13 @@ After(async function (this: World) {
)
}
})

let clock: InstalledClock

Before(async function () {
clock = FakeTimers.withGlobal(timeMethods).install()
})

After(async function () {
clock.uninstall()
})
52 changes: 26 additions & 26 deletions features/usage_formatter.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,21 @@ Feature: usage formatter
When I run cucumber-js with `--format usage`
Then it outputs the text:
"""
┌────────────────────┬──────────┬───────────────────────────────────────┐
│ Pattern / Text │ Duration │ Location │
├────────────────────┼──────────┼───────────────────────────────────────┤
│ step A │ <d>ms │ features/step_definitions/steps.js:3 │
│ step A │ <d>ms │ features/a.feature:3 │
├────────────────────┼──────────┼───────────────────────────────────────┤
│ /^(slow )?step B$/ │ <d>ms │ features/step_definitions/steps.js:4 │
│ slow step B │ <d>ms │ features/a.feature:5 │
│ step B │ <d>ms │ features/a.feature:4 │
├────────────────────┼──────────┼───────────────────────────────────────┤
│ step C │ <d>ms │ features/step_definitions/steps.js:11 │
│ step C │ <d>ms │ features/a.feature:6 │
├────────────────────┼──────────┼───────────────────────────────────────┤
│ step D │ UNUSED │ features/step_definitions/steps.js:12 │
└────────────────────┴──────────┴───────────────────────────────────────┘
┌────────────────────┬──────────────┬───────────────────────────────────────┐
│ Pattern / Text │ Duration │ Location │
├────────────────────┼──────────────┼───────────────────────────────────────┤
│ step A │ <d>ms │ features/step_definitions/steps.js:3 │
│ step A │ <d>ms │ features/a.feature:3 │
├────────────────────┼──────────────┼───────────────────────────────────────┤
│ /^(slow )?step B$/ │ <d>ms │ features/step_definitions/steps.js:4 │
│ slow step B │ <d>ms │ features/a.feature:5 │
│ step B │ <d>ms │ features/a.feature:4 │
├────────────────────┼──────────────┼───────────────────────────────────────┤
│ step C │ <d>ms │ features/step_definitions/steps.js:11 │
│ step C │ <d>ms │ features/a.feature:6 │
├────────────────────┼──────────────┼───────────────────────────────────────┤
│ step D │ UNUSED │ features/step_definitions/steps.js:12 │
└────────────────────┴──────────────┴───────────────────────────────────────┘
"""

Scenario: only list 5 slowest matches
Expand Down Expand Up @@ -81,15 +81,15 @@ Feature: usage formatter
When I run cucumber-js with `--format usage`
Then it outputs the text:
"""
┌──────────────────┬──────────┬──────────────────────────────────────┐
│ Pattern / Text │ Duration │ Location │
├──────────────────┼──────────┼──────────────────────────────────────┤
│ /^(slow )?step$/ │ <d>ms │ features/step_definitions/steps.js:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ 5 more │ │ │
└──────────────────┴──────────┴──────────────────────────────────────┘
┌──────────────────┬──────────────┬──────────────────────────────────────┐
joac marked this conversation as resolved.
Show resolved Hide resolved
│ Pattern / Text │ Duration │ Location │
├──────────────────┼──────────────┼──────────────────────────────────────┤
│ /^(slow )?step$/ │ <d>ms │ features/step_definitions/steps.js:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ slow step │ <d>ms │ features/a.feature:3 │
│ 5 more │ │ │
└──────────────────┴──────────────┴──────────────────────────────────────┘
"""
4 changes: 3 additions & 1 deletion src/time.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { performance } from 'perf_hooks'
import * as messages from '@cucumber/messages'

let previousTimestamp: number
Expand All @@ -14,6 +15,7 @@ const methods: any = {
},
setInterval: setInterval.bind(global),
setTimeout: setTimeout.bind(global),
performance,
}

if (typeof setImmediate !== 'undefined') {
Expand All @@ -22,7 +24,7 @@ if (typeof setImmediate !== 'undefined') {
}

function getTimestamp(): number {
aurelien-reeves marked this conversation as resolved.
Show resolved Hide resolved
return new methods.Date().getTime()
return methods.performance.now()
}

export function durationBetweenTimestamps(
Expand Down