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.

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

Add scenario description to JSON and add test for JSON correctly populating the description from a feature #749

Merged
merged 4 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Added
Changed
+++++++
* Step arguments ``"datatable"`` and ``"docstring"`` are now reserved, and they can't be used as step argument names.
* Scenario ``description`` field is now set for JSON output

Deprecated
++++++++++
Expand Down
2 changes: 1 addition & 1 deletion src/pytest_bdd/cucumber_json.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def stepmap(step: dict[str, Any]) -> dict[str, Any]:
"id": report.item["name"],
"name": scenario["name"],
"line": scenario["line_number"],
"description": "",
"description": scenario["description"],
"tags": self._serialize_tags(scenario),
"type": "scenario",
"steps": [stepmap(step) for step in scenario["steps"]],
Expand Down
1 change: 1 addition & 0 deletions src/pytest_bdd/reporting.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ def serialize(self) -> dict[str, Any]:
"name": scenario.name,
"line_number": scenario.line_number,
"tags": sorted(scenario.tags),
"description": scenario.description,
"feature": {
"keyword": feature.keyword,
"name": feature.name,
Expand Down
41 changes: 22 additions & 19 deletions tests/feature/test_cucumber_json.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,12 @@ def test_step_trace(pytester):
"""
@feature-tag
Feature: One passing scenario, one failing scenario
This is a feature description

@scenario-passing-tag
Scenario: Passing
This is a scenario description

Given a passing step
And some other passing step

Expand Down Expand Up @@ -116,108 +119,108 @@ def test_passing_outline():
assert result.ret
expected = [
{
"description": "",
"description": "This is a feature description",
"elements": [
{
"description": "",
"description": "This is a scenario description",
"id": "test_passing",
"keyword": "Scenario",
"line": 5,
"line": 6,
"name": "Passing",
"steps": [
{
"keyword": "Given",
"line": 6,
"line": 9,
"match": {"location": ""},
"name": "a passing step",
"result": {"status": "passed", "duration": OfType(int)},
},
{
"keyword": "And",
"line": 7,
"line": 10,
"match": {"location": ""},
"name": "some other passing step",
"result": {"status": "passed", "duration": OfType(int)},
},
],
"tags": [{"name": "scenario-passing-tag", "line": 4}],
"tags": [{"name": "scenario-passing-tag", "line": 5}],
"type": "scenario",
},
{
"description": "",
"id": "test_failing",
"keyword": "Scenario",
"line": 10,
"line": 13,
"name": "Failing",
"steps": [
{
"keyword": "Given",
"line": 11,
"line": 14,
"match": {"location": ""},
"name": "a passing step",
"result": {"status": "passed", "duration": OfType(int)},
},
{
"keyword": "And",
"line": 12,
"line": 15,
"match": {"location": ""},
"name": "a failing step",
"result": {"error_message": OfType(str), "status": "failed", "duration": OfType(int)},
},
],
"tags": [{"name": "scenario-failing-tag", "line": 9}],
"tags": [{"name": "scenario-failing-tag", "line": 12}],
"type": "scenario",
},
{
"description": "",
"keyword": "Scenario Outline",
"tags": [{"line": 14, "name": "scenario-outline-passing-tag"}],
"tags": [{"line": 17, "name": "scenario-outline-passing-tag"}],
"steps": [
{
"line": 16,
"line": 19,
"match": {"location": ""},
"result": {"status": "passed", "duration": OfType(int)},
"keyword": "Given",
"name": "type str and value hello",
}
],
"line": 15,
"line": 18,
"type": "scenario",
"id": "test_passing_outline[str-hello]",
"name": "Passing outline",
},
{
"description": "",
"keyword": "Scenario Outline",
"tags": [{"line": 14, "name": "scenario-outline-passing-tag"}],
"tags": [{"line": 17, "name": "scenario-outline-passing-tag"}],
"steps": [
{
"line": 16,
"line": 19,
"match": {"location": ""},
"result": {"status": "passed", "duration": OfType(int)},
"keyword": "Given",
"name": "type int and value 42",
}
],
"line": 15,
"line": 18,
"type": "scenario",
"id": "test_passing_outline[int-42]",
"name": "Passing outline",
},
{
"description": "",
"keyword": "Scenario Outline",
"tags": [{"line": 14, "name": "scenario-outline-passing-tag"}],
"tags": [{"line": 17, "name": "scenario-outline-passing-tag"}],
"steps": [
{
"line": 16,
"line": 19,
"match": {"location": ""},
"result": {"status": "passed", "duration": OfType(int)},
"keyword": "Given",
"name": "type float and value 1.0",
}
],
"line": 15,
"line": 18,
"type": "scenario",
"id": "test_passing_outline[float-1.0]",
"name": "Passing outline",
Expand Down
4 changes: 4 additions & 0 deletions tests/feature/test_report.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ def _(cucumbers, left):
"keyword": "Scenario",
"line_number": 5,
"name": "Passing",
"description": "",
"steps": [
{
"duration": OfType(float),
Expand Down Expand Up @@ -155,6 +156,7 @@ def _(cucumbers, left):
"keyword": "Scenario",
"line_number": 10,
"name": "Failing",
"description": "",
"steps": [
{
"duration": OfType(float),
Expand Down Expand Up @@ -192,6 +194,7 @@ def _(cucumbers, left):
"keyword": "Scenario Outline",
"line_number": 14,
"name": "Outlined",
"description": "",
"steps": [
{
"duration": OfType(float),
Expand Down Expand Up @@ -237,6 +240,7 @@ def _(cucumbers, left):
"keyword": "Scenario Outline",
"line_number": 14,
"name": "Outlined",
"description": "",
"steps": [
{
"duration": OfType(float),
Expand Down
Loading