fix: prevent panic in cucumber JSON formatter on stopOnFailure#717
Open
andrelince wants to merge 1 commit into
Open
fix: prevent panic in cucumber JSON formatter on stopOnFailure#717andrelince wants to merge 1 commit into
andrelince wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes a panic in the Cucumber JSON formatter when StopOnFailure stops execution early, ensuring a partial (but valid) JSON report can still be produced.
Changes:
- Guard Cucumber formatter access to
Storage.MustGetPickleResultso missing results don’t panic underStopOnFailure. - Add a unit test that runs the cucumber formatter with
StopOnFailureenabled and verifies output is still valid JSON. - Add cucumber formatter “golden” output for the
stop_on_first_failurefeature to the formatter output test fixtures.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| internal/formatters/fmt_cucumber.go | Avoids panics by safely handling missing PickleResult entries when runs stop early. |
| internal/formatters/fmt_cucumber_test.go | Adds regression coverage to ensure cucumber JSON output is still produced with StopOnFailure. |
| internal/formatters/formatter-tests/cucumber/stop_on_first_failure | Adds expected cucumber JSON output fixture for the stop_on_first_failure feature in formatter output comparisons. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+84
to
86
| pickleResult := f.getPickleResult(pickle.Id) | ||
| pickleStepResults := f.Storage.MustGetPickleStepResultsByPickleID(pickle.Id) | ||
|
|
| return cukeStep | ||
| } | ||
|
|
||
| // getPickleResult deals with the fact that if there's no result due to 'StopOnFirstFailure' being |
Comment on lines
+44
to
+49
| elements := features[0]["elements"].([]interface{}) | ||
| if len(elements) != 2 { | ||
| t.Fatalf("expected two scenarios, got %d", len(elements)) | ||
| } | ||
|
|
||
| second := elements[1].(map[string]interface{}) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤔 What's changed?
fmt_cucumber_test.go) to assert the changesThis PR is a follow up to this other PR
⚡️ What's your motivation?
I use godog for professional integration tests that run in our PR pipeline, and we rely on a report being generated for every run (both success and failure). These test suites can take up to an hour when they pass, so we enable stopOnFailure to fail fast and free up CI resources as soon as a single scenario fails.
However, when stopOnFailure is enabled and a scenario fails, the cucumber JSON formatter panics before writing the report, so we can’t collect the partial report for the scenarios that did run. This change ensures we still get a valid JSON report even when the run stops early.
🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.