search

getgauge / html-report

HTML report generation plugin for Gauge
Apache License 2.0
29 stars 41 forks source link

Programmatically skipped steps which generate a skip are not highlighted as skipped in the report #320

Open chadlwilson opened 1 month ago

chadlwilson commented 1 month ago

Expected behavior

As noted in https://github.com/getgauge/gauge-python/pull/397, when programmatically skipping scenarios ( https://github.com/getgauge/gauge/pull/2502 ) from a step or a hook, ideally it should be clear from the report which step generated the skip instruction.

Actual behavior

Currently the step shows as passed.

Steps to reproduce

  1. Use a gauge-dotnet or gauge-python project which has a step which throws/raises a SkipScenarioException
  2. View the html-report for that scenario
  3. Note that the step that generated the skip is passed, even though the scenario is shown as skipped.

It might be sufficient to change the code below

https://github.com/getgauge/html-report/blob/19ee5a6ba70c454958bcdffa9b62c9675d20dabf/generator/transform.go#L619-L630

and add the below after checking the executionResult however needs to be validated as to what it looks like and whether it displays in a way that is clear as to the reason the step is skipped since skips can be done for multiple reasons.

    if res.GetExecutionResult().GetSkipScenario() {
        return skip
    }

Gauge version

$ gauge -v
Gauge version: 1.6.9
Commit Hash: aff43ef

Plugins
-------
dotnet (0.7.2)
html-report (4.3.1)
python (0.4.7)