Skip to content

Commit 89163ae

Browse files
authored
verify undocumented allure_test cases do not emit blank descriptions (via #17)
1 parent a4adad7 commit 89163ae

4 files changed

Lines changed: 19 additions & 4 deletions

File tree

crates/allure-cargotest/tests/e2e.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ impl Drop for TempProjectDir {
4545
#[allure_cargotest::log_asserts]
4646
fn generates_allure_results_for_descriptions_sample() {
4747
allure::description(
48-
"Verifies the description sample emits explicit descriptions, doc comment descriptions, and doc comment opt-outs.",
48+
"Verifies the description sample emits explicit descriptions, doc comment descriptions, missing-doc omissions, and doc comment opt-outs.",
4949
);
5050
let (results, _, _project_dir) = run_sample("descriptions", true);
5151
let result = results
@@ -74,6 +74,14 @@ fn generates_allure_results_for_descriptions_sample() {
7474
);
7575
assert_eq!(json_string(result, "descriptionHtml"), None);
7676

77+
let result = results
78+
.get("leaves_description_absent_without_doc_comment")
79+
.expect("missing leaves_description_absent_without_doc_comment result");
80+
assert_has_allure_result_fields(result);
81+
assert_eq!(json_string(result, "status"), Some("passed"));
82+
assert_eq!(json_string(result, "description"), None);
83+
assert_eq!(json_string(result, "descriptionHtml"), None);
84+
7785
let result = results
7886
.get("skips_doc_comment_description")
7987
.expect("missing skips_doc_comment_description result");

smokes/allure-cargotest/Cargo.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

smokes/allure-cargotest/expected-fullnames.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ attachments::writes_attachment
22
concurrent_metadata::metadata_for_first_test_stays_isolated
33
concurrent_metadata::metadata_for_second_test_stays_isolated
44
default_and_global_labels::writes_default_and_global_labels
5+
descriptions::leaves_description_absent_without_doc_comment
56
descriptions::skips_doc_comment_description
67
descriptions::uses_doc_comment_as_description
78
descriptions::writes_descriptions

smokes/allure-cargotest/tests/descriptions.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ fn uses_doc_comment_as_description() {
1515
allure.log_step("doc comment description was applied by the macro");
1616
}
1717

18+
#[allure_test]
19+
#[test]
20+
fn leaves_description_absent_without_doc_comment() {
21+
allure.log_step("no doc comment description was added by the macro");
22+
}
23+
1824
/// skipped doc comment description
1925
#[allure_test(doc = false)]
2026
#[test]

0 commit comments

Comments
 (0)