aboutsummaryrefslogtreecommitdiffstats
path: root/tests
diff options
context:
space:
mode:
Diffstat (limited to 'tests')
-rw-r--r--tests/readme.rs125
-rw-r--r--tests/serve_request.rs3
2 files changed, 128 insertions, 0 deletions
diff --git a/tests/readme.rs b/tests/readme.rs
new file mode 100644
index 0000000..56a3afd
--- /dev/null
+++ b/tests/readme.rs
@@ -0,0 +1,125 @@
+mod fixtures;
+
+use fixtures::{server, Error, TestServer, DIRECTORIES, FILES};
+use rstest::rstest;
+use select::predicate::Attr;
+use select::{document::Document, node::Node};
+use std::fs::{remove_file, File};
+use std::io::Write;
+use std::path::PathBuf;
+
+/// Do not show readme contents by default
+#[rstest]
+fn no_readme_contents(server: TestServer) -> Result<(), Error> {
+ let body = reqwest::blocking::get(server.url())?.error_for_status()?;
+ let parsed = Document::from_read(body)?;
+
+ // Check that the regular file listing still works.
+ for &file in FILES {
+ assert!(parsed.find(|x: &Node| x.text() == file).next().is_some());
+ }
+ for &dir in DIRECTORIES {
+ assert!(parsed.find(|x: &Node| x.text() == dir).next().is_some());
+ }
+
+ // Check that there is no readme stuff here.
+ assert!(parsed.find(Attr("id", "readme")).next().is_none());
+ assert!(parsed.find(Attr("id", "readme-filename")).next().is_none());
+ assert!(parsed.find(Attr("id", "readme-contents")).next().is_none());
+
+ Ok(())
+}
+
+/// Show readme contents when told to if there is a readme file in the root
+#[rstest(
+ readme_name,
+ case("Readme.md"),
+ case("readme.md"),
+ case("README.md"),
+ case("README.MD"),
+ case("ReAdMe.Md")
+)]
+fn show_root_readme_contents(
+ #[with(&["--readme"])] server: TestServer,
+ readme_name: &str,
+) -> Result<(), Error> {
+ let readme_path = write_readme_contents(server.path().to_path_buf(), readme_name);
+ let body = reqwest::blocking::get(server.url())?.error_for_status()?;
+ let parsed = Document::from_read(body)?;
+
+ // All the files are still getting listed...
+ for &file in FILES {
+ assert!(parsed.find(|x: &Node| x.text() == file).next().is_some());
+ }
+ // ...in addition to the readme contents below the file listing.
+ assert_readme_contents(&parsed, &readme_name);
+ remove_file(readme_path).unwrap();
+ Ok(())
+}
+
+/// Show readme contents when told to if there is a readme file in any of the directories
+#[rstest(
+ readme_name,
+ case("Readme.md"),
+ case("readme.md"),
+ case("README.md"),
+ case("README.MD"),
+ case("ReAdMe.Md")
+)]
+fn show_nested_readme_contents(
+ #[with(&["--readme"])] server: TestServer,
+ readme_name: &str,
+) -> Result<(), Error> {
+ for dir in DIRECTORIES {
+ let readme_path = write_readme_contents(server.path().join(dir), readme_name);
+ let body = reqwest::blocking::get(server.url().join(dir)?)?.error_for_status()?;
+ let parsed = Document::from_read(body)?;
+
+ // All the files are still getting listed...
+ for &file in FILES {
+ assert!(parsed.find(|x: &Node| x.text() == file).next().is_some());
+ }
+ // ...in addition to the readme contents below the file listing.
+ assert_readme_contents(&parsed, &readme_name);
+ remove_file(readme_path).unwrap();
+ }
+ Ok(())
+}
+
+fn write_readme_contents(path: PathBuf, filename: &str) -> PathBuf {
+ let readme_path = path.join(filename);
+ let mut readme_file = File::create(&readme_path).unwrap();
+ readme_file
+ .write(format!("Contents of {}", filename).to_string().as_bytes())
+ .expect("Couldn't write readme");
+ readme_path
+}
+
+fn assert_readme_contents(parsed_dom: &Document, filename: &str) {
+ assert!(parsed_dom.find(Attr("id", "readme")).next().is_some());
+ assert!(parsed_dom
+ .find(Attr("id", "readme-filename"))
+ .next()
+ .is_some());
+ assert!(
+ parsed_dom
+ .find(Attr("id", "readme-filename"))
+ .next()
+ .unwrap()
+ .text()
+ == filename
+ );
+ assert!(parsed_dom
+ .find(Attr("id", "readme-contents"))
+ .next()
+ .is_some());
+ assert!(
+ parsed_dom
+ .find(Attr("id", "readme-contents"))
+ .next()
+ .unwrap()
+ .text()
+ .trim()
+ == format!("Contents of {}", filename)
+ );
+}
diff --git a/tests/serve_request.rs b/tests/serve_request.rs
index b23f7e2..f376469 100644
--- a/tests/serve_request.rs
+++ b/tests/serve_request.rs
@@ -33,6 +33,9 @@ fn serves_requests_with_no_options(tmpdir: TempDir) -> Result<(), Error> {
for &file in FILES {
assert!(parsed.find(|x: &Node| x.text() == file).next().is_some());
}
+ for &dir in DIRECTORIES {
+ assert!(parsed.find(|x: &Node| x.text() == dir).next().is_some());
+ }
child.kill()?;