Skip to content

polish(@wdio/reporter): better display retried scenarios#13880

Merged
christian-bromann merged 1 commit intomainfrom
cb/cucumber-suite-retry
Nov 13, 2024
Merged

polish(@wdio/reporter): better display retried scenarios#13880
christian-bromann merged 1 commit intomainfrom
cb/cucumber-suite-retry

Conversation

@christian-bromann
Copy link
Member

@christian-bromann christian-bromann commented Nov 13, 2024

Proposed changes

This patch enables proper spec reporting when Cucumber scenarios are being retried. Before it would look like:

 "spec" Reporter:
------------------------------------------------------------------
[chrome 130.0.6723.117 mac #0-0] Running: chrome (v130.0.6723.117) on mac
[chrome 130.0.6723.117 mac #0-0] Session ID: 6b7e1b42487586c61efffa736922cd76
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0] » /cucumber/features/my-feature.feature
[chrome 130.0.6723.117 mac #0-0] Example feature
[chrome 130.0.6723.117 mac #0-0] As a user of WebdriverIO
[chrome 130.0.6723.117 mac #0-0] I should be able to use different commands
[chrome 130.0.6723.117 mac #0-0] to get informations about elements on the page
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0]     Get size of an element
[chrome 130.0.6723.117 mac #0-0]        ✓ Given I go on the website "https://github.com/"
[chrome 130.0.6723.117 mac #0-0]        ✓ Then should the element ".header-logged-out a" be 32px wide and 34.5px high
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0] 3 passing (2.9s)
[chrome 130.0.6723.117 mac #0-0] 1 failing


Spec Files:      1 passed, 1 total (100% completed) in 00:00:16

now it looks like:

 "spec" Reporter:
------------------------------------------------------------------
[chrome 130.0.6723.117 mac #0-0] Running: chrome (v130.0.6723.117) on mac
[chrome 130.0.6723.117 mac #0-0] Session ID: 8b549c317945d98b58dfcc1432afdec7
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0] » /cucumber/features/my-feature.feature
[chrome 130.0.6723.117 mac #0-0] Example feature
[chrome 130.0.6723.117 mac #0-0] As a user of WebdriverIO
[chrome 130.0.6723.117 mac #0-0] I should be able to use different commands
[chrome 130.0.6723.117 mac #0-0] to get informations about elements on the page
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0] Get size of an element (1x retries)
[chrome 130.0.6723.117 mac #0-0]    ✓ Given I go on the website "https://github.com/"
[chrome 130.0.6723.117 mac #0-0]    ✓ Then should the element ".header-logged-out a" be 32px wide and 34.5px high
[chrome 130.0.6723.117 mac #0-0]
[chrome 130.0.6723.117 mac #0-0] 2 passing (1.9s)
[chrome 130.0.6723.117 mac #0-0] 1 retried


Spec Files:      1 passed, 1 total (100% completed) in 00:00:12

fixes #13879

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

n/a

Reviewers: @webdriverio/project-committers

@christian-bromann christian-bromann added the PR: Polish 💅 PRs that contain improvements on existing features label Nov 13, 2024
@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 13, 2024

Open in Stackblitz

eslint-plugin-wdio

pnpm add https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@13880

@wdio/appium-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@13880

@wdio/allure-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@13880

@wdio/browser-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@13880

@wdio/browserstack-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@13880

@wdio/cli

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@13880

@wdio/concise-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@13880

@wdio/config

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@13880

@wdio/cucumber-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@13880

@wdio/dot-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@13880

@wdio/firefox-profile-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@13880

@wdio/globals

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@13880

@wdio/jasmine-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@13880

@wdio/junit-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@13880

@wdio/json-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@13880

@wdio/lighthouse-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@13880

@wdio/local-runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@13880

@wdio/logger

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@13880

@wdio/protocols

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@13880

@wdio/mocha-framework

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@13880

@wdio/repl

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@13880

@wdio/reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@13880

@wdio/runner

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@13880

@wdio/sauce-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@13880

@wdio/shared-store-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@13880

@wdio/smoke-test-cjs-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@13880

@wdio/smoke-test-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@13880

@wdio/smoke-test-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@13880

@wdio/spec-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@13880

@wdio/static-server-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@13880

@wdio/sumologic-reporter

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@13880

@wdio/testingbot-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@13880

@wdio/types

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@13880

@wdio/utils

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@13880

@wdio/webdriver-mock-service

pnpm add https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@13880

webdriverio

pnpm add https://pkg.pr.new/webdriverio/webdriverio@13880

webdriver

pnpm add https://pkg.pr.new/webdriverio/webdriverio/webdriver@13880

commit: c592eb0

@christian-bromann christian-bromann merged commit c947574 into main Nov 13, 2024
@christian-bromann christian-bromann deleted the cb/cucumber-suite-retry branch November 13, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: Polish 💅 PRs that contain improvements on existing features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🐛 Bug]: cucumberOpts.retry is not properly labeled in the spec reporter

1 participant