Use a special text file for testing that the documentation server works.

korpling · Aug 4, 2023 · 26f4344 · 26f4344
1 parent b18cec4
commit 26f4344
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 41 deletions.
diff --git a/build.rs b/build.rs
diff --git a/docs/book/compile.txt b/docs/book/compile.txt
@@ -0,0 +1,2 @@
+This file is only included to make sure the automatic tests can be executed
+whether the documentation has been compiled or not.
diff --git a/docs/src/compile.txt b/docs/src/compile.txt
@@ -0,0 +1,2 @@
+This file is only included to make sure the automatic tests can be executed
+whether the documentation has been compiled or not.
diff --git a/docs/src/test.txt b/docs/src/test.txt
@@ -0,0 +1,6 @@
+This file is only included to make sure the automatic tests can be executed
+whether the documentation has been compiled or not.
+
+You can compile the documentation by installing mdBook and then executing
+
+> mdbook docs/
diff --git a/src/documentation_server.rs b/src/documentation_server.rs
@@ -95,11 +95,16 @@ mod tests {
     use tower::util::ServiceExt;
 
     #[tokio::test]
-    async fn index_found() {
+    async fn compile_instructions_found() {
         let app = app().unwrap();
 
         let response = app
-            .oneshot(Request::builder().uri("/").body(Body::empty()).unwrap())
+            .oneshot(
+                Request::builder()
+                    .uri("/compile.txt")
+                    .body(Body::empty())
+                    .unwrap(),
+            )
             .await
             .unwrap();