From 43014748bfceb9d25ad66437849939cc5b134db7 Mon Sep 17 00:00:00 2001
From: Johann150 <johann.galle@protonmail.com>
Date: Sat, 27 Feb 2021 09:54:56 +0100
Subject: [PATCH] optimise tests

added comments on the tests to document what they tests because some also test
multiple things
---
 tests/data/content/.meta         |  2 --
 tests/data/content/test.de.gmi   |  0
 tests/data/content/testdir/.meta |  2 ++
 tests/tests.rs                   | 25 +++++++++++++++++++++++--
 4 files changed, 25 insertions(+), 4 deletions(-)
 delete mode 100644 tests/data/content/test.de.gmi

diff --git a/tests/data/content/.meta b/tests/data/content/.meta
index 26ff40d..d6e931a 100644
--- a/tests/data/content/.meta
+++ b/tests/data/content/.meta
@@ -1,7 +1,5 @@
 # test setting a mime type
 test: text/html
-# test globs and setting parameters
-*.de.gmi: ;lang=de
 # test double star globs
 **/*.nl.gmi: ;lang=nl
 # test setting multiple parameters
diff --git a/tests/data/content/test.de.gmi b/tests/data/content/test.de.gmi
deleted file mode 100644
index e69de29..0000000
diff --git a/tests/data/content/testdir/.meta b/tests/data/content/testdir/.meta
index a8f622d..03d6851 100644
--- a/tests/data/content/testdir/.meta
+++ b/tests/data/content/testdir/.meta
@@ -1,2 +1,4 @@
 # test distributed configurations
 index.gmi: 51 No index file for you.
+# test which configuration file is used
+*.nl.gmi: text/plain;lang=nl
diff --git a/tests/tests.rs b/tests/tests.rs
index 9f046bf..4c36cdf 100644
--- a/tests/tests.rs
+++ b/tests/tests.rs
@@ -82,6 +82,8 @@ fn get(args: &[&str], addr: SocketAddr, url: &str) -> Result<Page, anyhow::Error
 }
 
 #[test]
+/// - serves index page for a directory
+/// - serves the correct content
 fn index_page() {
     let page = get(&[], addr(1965), "gemini://localhost").expect("could not get page");
 
@@ -106,6 +108,8 @@ fn index_page() {
 }
 
 #[test]
+/// - the `--addr` configuration works
+/// - MIME media types can be set in the configuration file
 fn meta() {
     let page = get(
         &["--addr", "[::]:1966"],
@@ -124,6 +128,8 @@ fn meta() {
 }
 
 #[test]
+/// - MIME type is correctly guessed for `.gmi` files
+/// - MIME media type parameters can be set in the configuration file
 fn meta_param() {
     let page = get(
         &["--addr", "[::]:1967"],
@@ -142,11 +148,13 @@ fn meta_param() {
 }
 
 #[test]
+/// - globs in the configuration file work correctly
+/// - distributed configuration file is used when `-C` flag not used
 fn glob() {
     let page = get(
         &["--addr", "[::]:1968"],
         addr(1968),
-        "gemini://localhost/test.de.gmi",
+        "gemini://localhost/testdir/a.nl.gmi",
     )
     .expect("could not get page");
 
@@ -154,12 +162,14 @@ fn glob() {
         page.header,
         Header {
             status: Status::Success,
-            meta: "text/gemini;lang=de".to_string(),
+            meta: "text/plain;lang=nl".to_string(),
         }
     );
 }
 
 #[test]
+/// - double globs (i.e. `**`) work correctly in the configuration file
+/// - central configuration file is used when `-C` flag is used
 fn doubleglob() {
     let page = get(
         &["--addr", "[::]:1969", "-C"],
@@ -178,6 +188,7 @@ fn doubleglob() {
 }
 
 #[test]
+/// - full header lines can be set in the configuration file
 fn full_header_preset() {
     let page = get(
         &["--addr", "[::]:1970"],
@@ -196,6 +207,8 @@ fn full_header_preset() {
 }
 
 #[test]
+/// - hostname is checked when provided
+/// - status for wrong host is "proxy request refused"
 fn hostname_check() {
     let page = get(
         &["--addr", "[::]:1971", "--hostname", "example.org"],
@@ -208,6 +221,8 @@ fn hostname_check() {
 }
 
 #[test]
+/// - port is checked when hostname is provided
+/// - status for wrong port is "proxy request refused"
 fn port_check() {
     let page = get(
         &["--addr", "[::]:1972", "--hostname", "example.org"],
@@ -220,6 +235,7 @@ fn port_check() {
 }
 
 #[test]
+/// - status for paths with hidden segments is "gone" if file does not exist
 fn secret_nonexistent() {
     let page = get(
         &["--addr", "[::]:1973"],
@@ -232,6 +248,7 @@ fn secret_nonexistent() {
 }
 
 #[test]
+/// - status for paths with hidden segments is "gone" if file exists
 fn secret_exists() {
     let page = get(
         &["--addr", "[::]:1974"],
@@ -244,6 +261,7 @@ fn secret_exists() {
 }
 
 #[test]
+/// - secret file served if `--serve-secret` is enabled
 fn serve_secret() {
     let page = get(
         &["--addr", "[::]:1975", "--serve-secret"],
@@ -257,6 +275,9 @@ fn serve_secret() {
 
 #[test]
 #[should_panic(expected = "AlertReceived(ProtocolVersion)")]
+/// - if TLSv1.3 is selected, does not accept TLSv1.2 connections
+///   (lower versions do not have to be tested because rustls does not even
+///   support them, making agate incapable of accepting them)
 fn explicit_tls_version() {
     use rustls::{ClientSession, ProtocolVersion};
     use std::io::Read;