From 8005092cf0dcb05665c7e7f06fa29dfb45d3c529 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume1.gomez@gmail.com>
Date: Sun, 21 Feb 2021 14:25:12 +0100
Subject: [PATCH] Add rustdoc gui tests

---
 src/test/rustdoc-gui/basic-code.goml          |  3 +
 src/test/rustdoc-gui/basic.goml               |  4 ++
 src/test/rustdoc-gui/code-sidebar-toggle.goml |  6 ++
 src/test/rustdoc-gui/lib.rs                   | 67 +++++++++++++++++++
 src/test/rustdoc-gui/list_code_block.goml     |  3 +
 src/test/rustdoc-gui/theme-change.goml        | 10 +++
 src/test/rustdoc-gui/toggle-docs.goml         |  7 ++
 7 files changed, 100 insertions(+)
 create mode 100644 src/test/rustdoc-gui/basic-code.goml
 create mode 100644 src/test/rustdoc-gui/basic.goml
 create mode 100644 src/test/rustdoc-gui/code-sidebar-toggle.goml
 create mode 100644 src/test/rustdoc-gui/lib.rs
 create mode 100644 src/test/rustdoc-gui/list_code_block.goml
 create mode 100644 src/test/rustdoc-gui/theme-change.goml
 create mode 100644 src/test/rustdoc-gui/toggle-docs.goml

diff --git a/src/test/rustdoc-gui/basic-code.goml b/src/test/rustdoc-gui/basic-code.goml
new file mode 100644
index 0000000000000..8da465662547a
--- /dev/null
+++ b/src/test/rustdoc-gui/basic-code.goml
@@ -0,0 +1,3 @@
+goto: file://|DOC_PATH|/index.html
+click: ".srclink"
+assert: (".line-numbers", 1)
diff --git a/src/test/rustdoc-gui/basic.goml b/src/test/rustdoc-gui/basic.goml
new file mode 100644
index 0000000000000..ed23300860b70
--- /dev/null
+++ b/src/test/rustdoc-gui/basic.goml
@@ -0,0 +1,4 @@
+goto: file://|DOC_PATH|/index.html
+assert: ("#functions")
+goto: ./struct.Foo.html
+assert: ("div.type-decl")
diff --git a/src/test/rustdoc-gui/code-sidebar-toggle.goml b/src/test/rustdoc-gui/code-sidebar-toggle.goml
new file mode 100644
index 0000000000000..69fc860244b7b
--- /dev/null
+++ b/src/test/rustdoc-gui/code-sidebar-toggle.goml
@@ -0,0 +1,6 @@
+goto: file://|DOC_PATH|/index.html
+click: ".srclink"
+click: "#sidebar-toggle"
+wait-for: 500
+fail: true
+assert: ("#source-sidebar", { "left": "-300px" })
diff --git a/src/test/rustdoc-gui/lib.rs b/src/test/rustdoc-gui/lib.rs
new file mode 100644
index 0000000000000..3c996f5b65c92
--- /dev/null
+++ b/src/test/rustdoc-gui/lib.rs
@@ -0,0 +1,67 @@
+//! The point of this crate is to be able to have enough different "kinds" of
+//! documentation generated so we can test each different features.
+
+#![crate_name = "test_docs"]
+
+use std::fmt;
+
+/// Basic function with some code examples:
+///
+/// ```
+/// println!("nothing fancy");
+/// ```
+///
+/// A failing to compile one:
+///
+/// ```compile_fail
+/// println!("where did my argument {} go? :'(");
+/// ```
+///
+/// An ignored one:
+///
+/// ```ignore (it's a test)
+/// Let's say I'm just some text will ya?
+/// ```
+pub fn foo() {}
+
+/// Just a normal struct.
+pub struct Foo;
+
+/// Just a normal enum.
+pub enum WhoLetTheDogOut {
+    /// Woof!
+    Woof,
+    /// Meoooooooow...
+    Meow,
+}
+
+/// Who doesn't love to wrap a `format!` call?
+pub fn some_more_function<T: fmt::Debug>(t: &T) -> String {
+    format!("{:?}", t)
+}
+
+/// Woohoo! A trait!
+pub trait AnotherOne {
+    /// Some func 1.
+    fn func1();
+
+    /// Some func 2.
+    fn func2();
+
+    /// Some func 3.
+    fn func3();
+}
+
+/// Check for "i" signs in lists!
+///
+/// 1. elem 1
+/// 2.test 1
+///   ```compile_fail
+///   fn foo() {}
+///   ```
+/// 3. elem 3
+/// 4. ```ignore (it's a test)
+///    fn foo() {}
+///    ```
+/// 5. elem 5
+pub fn check_list_code_block() {}
diff --git a/src/test/rustdoc-gui/list_code_block.goml b/src/test/rustdoc-gui/list_code_block.goml
new file mode 100644
index 0000000000000..6f2465a5587f2
--- /dev/null
+++ b/src/test/rustdoc-gui/list_code_block.goml
@@ -0,0 +1,3 @@
+goto: file://|DOC_PATH|/index.html
+goto: ./fn.check_list_code_block.html
+assert: ("pre.rust.fn")
diff --git a/src/test/rustdoc-gui/theme-change.goml b/src/test/rustdoc-gui/theme-change.goml
new file mode 100644
index 0000000000000..5bd65f61f4905
--- /dev/null
+++ b/src/test/rustdoc-gui/theme-change.goml
@@ -0,0 +1,10 @@
+goto: file://|DOC_PATH|/index.html
+click: "#theme-picker"
+click: "#theme-choices > button:first-child"
+wait-for: 500
+// should be the ayu theme so let's check the color
+assert: ("body", { "background-color": "rgb(15, 20, 25)" })
+click: "#theme-choices > button:last-child"
+wait-for: 500
+// should be the light theme so let's check the color
+assert: ("body", { "background-color": "rgb(255, 255, 255)" })
diff --git a/src/test/rustdoc-gui/toggle-docs.goml b/src/test/rustdoc-gui/toggle-docs.goml
new file mode 100644
index 0000000000000..1ded33f659d3c
--- /dev/null
+++ b/src/test/rustdoc-gui/toggle-docs.goml
@@ -0,0 +1,7 @@
+goto: file://|DOC_PATH|/index.html
+click: "#toggle-all-docs"
+wait-for: 5000
+assert: ("#main > div.docblock.hidden-by-usual-hider")
+click: "#toggle-all-docs"
+wait-for: 5000
+assert: ("#main > div.docblock.hidden-by-usual-hider", 0)