From c50bfda34f6559211688957d50a21207f46fdcb5 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume1.gomez@gmail.com>
Date: Sun, 27 Oct 2024 11:26:45 +0100
Subject: [PATCH] Add GUI regression test for doc struct fields margins
---
tests/rustdoc-gui/fields.goml | 49 +++++++++++++++++++++++-----
tests/rustdoc-gui/struct-fields.goml | 3 +-
2 files changed, 42 insertions(+), 10 deletions(-)
diff --git a/tests/rustdoc-gui/fields.goml b/tests/rustdoc-gui/fields.goml
index b8139a2edac10..5d13d7be2f972 100644
--- a/tests/rustdoc-gui/fields.goml
+++ b/tests/rustdoc-gui/fields.goml
@@ -1,13 +1,36 @@
-// This test checks that fields are displayed as expected (one by line).
-go-to: "file://" + |DOC_PATH| + "/test_docs/fields/struct.Struct.html"
-store-position: ("#structfield\.a", {"y": a_y})
-store-position: ("#structfield\.b", {"y": b_y})
-assert: |a_y| < |b_y|
+// This test checks that fields are displayed as expected (one by line) and they are surrounded
+// by margins.
-go-to: "file://" + |DOC_PATH| + "/test_docs/fields/union.Union.html"
-store-position: ("#structfield\.a", {"y": a_y})
-store-position: ("#structfield\.b", {"y": b_y})
-assert: |a_y| < |b_y|
+define-function: (
+ "check-fields",
+ [path, selector_1, selector_2],
+ block {
+ go-to: "file://" + |DOC_PATH| + "/test_docs/fields/" + |path|
+ store-position: (|selector_1|, {"y": a_y})
+ store-position: (|selector_2|, {"y": b_y})
+ assert: |a_y| < |b_y|
+
+ // Check the margins.
+ assert-css: (".structfield.section-header", {
+ "margin-top": "9.6px",
+ "margin-bottom": "9.6px",
+ "margin-left": "0px",
+ "margin-right": "0px",
+ }, ALL)
+ }
+)
+
+call-function: ("check-fields", {
+ "path": "struct.Struct.html",
+ "selector_1": "#structfield\.a",
+ "selector_2": "#structfield\.b",
+})
+
+call-function: ("check-fields", {
+ "path": "union.Union.html",
+ "selector_1": "#structfield\.a",
+ "selector_2": "#structfield\.b",
+})
go-to: "file://" + |DOC_PATH| + "/test_docs/fields/enum.Enum.html"
store-position: ("#variant\.A\.field\.a", {"y": a_y})
@@ -16,3 +39,11 @@ assert: |a_y| < |b_y|
store-position: ("#variant\.B\.field\.a", {"y": a_y})
store-position: ("#variant\.B\.field\.b", {"y": b_y})
assert: |a_y| < |b_y|
+
+// Check the margins.
+assert-css: (".sub-variant-field .section-header", {
+ "margin-top": "0px",
+ "margin-bottom": "0px",
+ "margin-left": "0px",
+ "margin-right": "0px",
+}, ALL)
diff --git a/tests/rustdoc-gui/struct-fields.goml b/tests/rustdoc-gui/struct-fields.goml
index 3c87a4cd65427..302a1a0d80bfa 100644
--- a/tests/rustdoc-gui/struct-fields.goml
+++ b/tests/rustdoc-gui/struct-fields.goml
@@ -1,4 +1,5 @@
-// This test ensures that each field is on its own line (In other words, they have display: block).
+// This test ensures that each field is on its own line (In other words, they have
+// `display: block`).
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.StructWithPublicUndocumentedFields.html"
store-property: ("//*[@id='structfield.first']", {"offsetTop": first_top})