Skip to content

Verify undocumented allure_test cases do not emit blank descriptions #17

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

Merged
baev merged 2 commits into from
Jun 28, 2026
Merged

Verify undocumented allure_test cases do not emit blank descriptions #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bde4f0b
Verify undocumented allure_test cases do not emit blank descriptions
baev Jun 27, 2026
f044f0f
fix build
baev Jun 28, 2026
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
10 changes: 9 additions & 1 deletion crates/allure-cargotest/tests/e2e.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ impl Drop for TempProjectDir {
#[allure_cargotest::log_asserts]
fn generates_allure_results_for_descriptions_sample() {
allure::description(
"Verifies the description sample emits explicit descriptions, doc comment descriptions, and doc comment opt-outs.",
"Verifies the description sample emits explicit descriptions, doc comment descriptions, missing-doc omissions, and doc comment opt-outs.",
);
let (results, _, _project_dir) = run_sample("descriptions", true);
let result = results
Expand Down Expand Up @@ -74,6 +74,14 @@ fn generates_allure_results_for_descriptions_sample() {
);
assert_eq!(json_string(result, "descriptionHtml"), None);

let result = results
.get("leaves_description_absent_without_doc_comment")
.expect("missing leaves_description_absent_without_doc_comment result");
assert_has_allure_result_fields(result);
assert_eq!(json_string(result, "status"), Some("passed"));
assert_eq!(json_string(result, "description"), None);
assert_eq!(json_string(result, "descriptionHtml"), None);

let result = results
.get("skips_doc_comment_description")
.expect("missing skips_doc_comment_description result");
Expand Down
6 changes: 3 additions & 3 deletions smokes/allure-cargotest/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions smokes/allure-cargotest/expected-fullnames.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ attachments::writes_attachment
concurrent_metadata::metadata_for_first_test_stays_isolated
concurrent_metadata::metadata_for_second_test_stays_isolated
default_and_global_labels::writes_default_and_global_labels
descriptions::leaves_description_absent_without_doc_comment
descriptions::skips_doc_comment_description
descriptions::uses_doc_comment_as_description
descriptions::writes_descriptions
Expand Down
6 changes: 6 additions & 0 deletions smokes/allure-cargotest/tests/descriptions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ fn uses_doc_comment_as_description() {
allure.log_step("doc comment description was applied by the macro");
}

#[allure_test]
#[test]
fn leaves_description_absent_without_doc_comment() {
allure.log_step("no doc comment description was added by the macro");
}

/// skipped doc comment description
#[allure_test(doc = false)]
#[test]
Expand Down