From a07c1bdf4da77c8227c110e750fce7169618d75e Mon Sep 17 00:00:00 2001 From: khai96_ Date: Mon, 29 Apr 2019 01:07:02 +0700 Subject: [PATCH 1/3] Split integration test into multiple files --- tests/auth.rs | 50 ++++++++++++ tests/cli.rs | 176 +---------------------------------------- tests/helpers.rs | 37 +++++++++ tests/serve_request.rs | 44 +++++++++++ tests/upload_files.rs | 51 ++++++++++++ 5 files changed, 184 insertions(+), 174 deletions(-) create mode 100644 tests/auth.rs create mode 100644 tests/helpers.rs create mode 100644 tests/serve_request.rs create mode 100644 tests/upload_files.rs diff --git a/tests/auth.rs b/tests/auth.rs new file mode 100644 index 000000000..cefc7ec1d --- /dev/null +++ b/tests/auth.rs @@ -0,0 +1,50 @@ +mod helpers; +use helpers::*; + +#[rstest_parametrize( + cli_auth_arg, client_username, client_password, + case("testuser:testpassword", "testuser", "testpassword"), + case( + "testuser:sha256:9f735e0df9a1ddc702bf0a1a7b83033f9f7153a00c29de82cedadc9957289b05", + "testuser", + "testpassword" + ), + case( + "testuser:sha512:e9e633097ab9ceb3e48ec3f70ee2beba41d05d5420efee5da85f97d97005727587fda33ef4ff2322088f4c79e8133cc9cd9f3512f4d3a303cbdb5bc585415a00", + "testuser", + "testpassword" + ), +)] +fn auth_works( + tmpdir: TempDir, + port: u16, + cli_auth_arg: &str, + client_username: &str, + client_password: &str +) -> Result<(), Error> { + let mut child = Command::cargo_bin("miniserve")? + .arg(tmpdir.path()) + .arg("-p") + .arg(port.to_string()) + .arg("-a") + .arg(cli_auth_arg) + .stdout(Stdio::null()) + .spawn()?; + + sleep(Duration::from_secs(1)); + + let client = reqwest::Client::new(); + let body = client + .get(format!("http://localhost:{}", port).as_str()) + .basic_auth(client_username, Some(client_password)) + .send()? + .error_for_status()?; + let parsed = Document::from_read(body)?; + for &file in FILES { + assert!(parsed.find(Text).any(|x| x.text() == file)); + } + + child.kill()?; + + Ok(()) +} diff --git a/tests/cli.rs b/tests/cli.rs index a67f5de52..c021eb7e8 100644 --- a/tests/cli.rs +++ b/tests/cli.rs @@ -1,177 +1,5 @@ -use assert_cmd::prelude::*; -use assert_fs::fixture::TempDir; -use assert_fs::prelude::*; -use clap::{crate_name, crate_version}; -use port_check::free_local_port; -use reqwest; -use reqwest::multipart; -use rstest::rstest; -use select::document::Document; -use select::predicate::{Attr, Text}; -use std::process::{Command, Stdio}; -use std::thread::sleep; -use std::time::Duration; -use rstest::rstest_parametrize; - -type Error = Box; - -static FILES: &[&str] = &["test.txt", "test.html", "test.mkv"]; - -/// Test fixture which creates a temporary directory with a few files inside. -pub fn tmpdir() -> TempDir { - let tmpdir = assert_fs::TempDir::new().expect("Couldn't create a temp dir for tests"); - for &file in FILES { - tmpdir - .child(file) - .write_str("Test Hello Yes") - .expect("Couldn't write to file"); - } - tmpdir -} - -/// Get a free port. -pub fn port() -> u16 { - free_local_port().expect("Couldn't find a free local port") -} - -#[rstest] -fn serves_requests_with_no_options(tmpdir: TempDir) -> Result<(), Error> { - let mut child = Command::cargo_bin("miniserve")? - .arg(tmpdir.path()) - .stdout(Stdio::null()) - .spawn()?; - - sleep(Duration::from_secs(1)); - - let body = reqwest::get("http://localhost:8080")?.error_for_status()?; - let parsed = Document::from_read(body)?; - for &file in FILES { - assert!(parsed.find(Text).any(|x| x.text() == file)); - } - - child.kill()?; - - Ok(()) -} - -#[rstest] -fn serves_requests_with_non_default_port(tmpdir: TempDir, port: u16) -> Result<(), Error> { - let mut child = Command::cargo_bin("miniserve")? - .arg(tmpdir.path()) - .arg("-p") - .arg(port.to_string()) - .stdout(Stdio::null()) - .spawn()?; - - sleep(Duration::from_secs(1)); - - let body = reqwest::get(format!("http://localhost:{}", port).as_str())?.error_for_status()?; - let parsed = Document::from_read(body)?; - for &file in FILES { - assert!(parsed.find(Text).any(|x| x.text() == file)); - } - - child.kill()?; - - Ok(()) -} - -#[rstest_parametrize( - cli_auth_arg, client_username, client_password, - case("testuser:testpassword", "testuser", "testpassword"), - case( - "testuser:sha256:9f735e0df9a1ddc702bf0a1a7b83033f9f7153a00c29de82cedadc9957289b05", - "testuser", - "testpassword" - ), - case( - "testuser:sha512:e9e633097ab9ceb3e48ec3f70ee2beba41d05d5420efee5da85f97d97005727587fda33ef4ff2322088f4c79e8133cc9cd9f3512f4d3a303cbdb5bc585415a00", - "testuser", - "testpassword" - ), -)] -fn auth_works( - tmpdir: TempDir, - port: u16, - cli_auth_arg: &str, - client_username: &str, - client_password: &str -) -> Result<(), Error> { - let mut child = Command::cargo_bin("miniserve")? - .arg(tmpdir.path()) - .arg("-p") - .arg(port.to_string()) - .arg("-a") - .arg(cli_auth_arg) - .stdout(Stdio::null()) - .spawn()?; - - sleep(Duration::from_secs(1)); - - let client = reqwest::Client::new(); - let body = client - .get(format!("http://localhost:{}", port).as_str()) - .basic_auth(client_username, Some(client_password)) - .send()? - .error_for_status()?; - let parsed = Document::from_read(body)?; - for &file in FILES { - assert!(parsed.find(Text).any(|x| x.text() == file)); - } - - child.kill()?; - - Ok(()) -} - -#[rstest] -fn uploading_files_works(tmpdir: TempDir, port: u16) -> Result<(), Error> { - let test_file_name = "uploaded test file.txt"; - - let mut child = Command::cargo_bin("miniserve")? - .arg(tmpdir.path()) - .arg("-p") - .arg(port.to_string()) - .arg("-u") - .stdout(Stdio::null()) - .spawn()?; - - sleep(Duration::from_secs(1)); - - // Before uploading, check whether the uploaded file does not yet exist. - let body = reqwest::get(format!("http://localhost:{}", port).as_str())?.error_for_status()?; - let parsed = Document::from_read(body)?; - assert!(parsed.find(Text).all(|x| x.text() != test_file_name)); - - // Perform the actual upload. - let upload_action = parsed - .find(Attr("id", "file_submit")) - .next() - .expect("Couldn't find element with id=file_submit") - .attr("action") - .expect("Upload form doesn't have action attribute"); - let form = multipart::Form::new(); - let part = multipart::Part::text("this should be uploaded") - .file_name(test_file_name) - .mime_str("text/plain")?; - let form = form.part("file_to_upload", part); - - let client = reqwest::Client::new(); - client - .post(format!("http://localhost:{}{}", port, upload_action).as_str()) - .multipart(form) - .send()? - .error_for_status()?; - - // After uploading, check whether the uploaded file is now getting listed. - let body = reqwest::get(format!("http://localhost:{}", port).as_str())?; - let parsed = Document::from_read(body)?; - assert!(parsed.find(Text).any(|x| x.text() == test_file_name)); - - child.kill()?; - - Ok(()) -} +mod helpers; +use helpers::*; #[test] /// Show help and exit. diff --git a/tests/helpers.rs b/tests/helpers.rs new file mode 100644 index 000000000..3c5ad7279 --- /dev/null +++ b/tests/helpers.rs @@ -0,0 +1,37 @@ +pub use assert_cmd::prelude::*; +pub use assert_fs::fixture::TempDir; +pub use assert_fs::prelude::*; +pub use clap::{crate_name, crate_version}; +pub use port_check::free_local_port; +pub use reqwest; +pub use reqwest::multipart; +pub use rstest::rstest; +pub use select::document::Document; +pub use select::predicate::{Attr, Text}; +pub use std::process::{Command, Stdio}; +pub use std::thread::sleep; +pub use std::time::Duration; +pub use rstest::rstest_parametrize; + +/// Error type used by tests +pub type Error = Box; + +/// File names for testing purpose +pub static FILES: &[&str] = &["test.txt", "test.html", "test.mkv"]; + +/// Test fixture which creates a temporary directory with a few files inside. +pub fn tmpdir() -> TempDir { + let tmpdir = assert_fs::TempDir::new().expect("Couldn't create a temp dir for tests"); + for &file in FILES { + tmpdir + .child(file) + .write_str("Test Hello Yes") + .expect("Couldn't write to file"); + } + tmpdir +} + +/// Get a free port. +pub fn port() -> u16 { + free_local_port().expect("Couldn't find a free local port") +} diff --git a/tests/serve_request.rs b/tests/serve_request.rs new file mode 100644 index 000000000..10b2bfc4a --- /dev/null +++ b/tests/serve_request.rs @@ -0,0 +1,44 @@ +mod helpers; +use helpers::*; + +#[rstest] +fn serves_requests_with_no_options(tmpdir: TempDir) -> Result<(), Error> { + let mut child = Command::cargo_bin("miniserve")? + .arg(tmpdir.path()) + .stdout(Stdio::null()) + .spawn()?; + + sleep(Duration::from_secs(1)); + + let body = reqwest::get("http://localhost:8080")?.error_for_status()?; + let parsed = Document::from_read(body)?; + for &file in FILES { + assert!(parsed.find(Text).any(|x| x.text() == file)); + } + + child.kill()?; + + Ok(()) +} + +#[rstest] +fn serves_requests_with_non_default_port(tmpdir: TempDir, port: u16) -> Result<(), Error> { + let mut child = Command::cargo_bin("miniserve")? + .arg(tmpdir.path()) + .arg("-p") + .arg(port.to_string()) + .stdout(Stdio::null()) + .spawn()?; + + sleep(Duration::from_secs(1)); + + let body = reqwest::get(format!("http://localhost:{}", port).as_str())?.error_for_status()?; + let parsed = Document::from_read(body)?; + for &file in FILES { + assert!(parsed.find(Text).any(|x| x.text() == file)); + } + + child.kill()?; + + Ok(()) +} diff --git a/tests/upload_files.rs b/tests/upload_files.rs new file mode 100644 index 000000000..4ebdb6928 --- /dev/null +++ b/tests/upload_files.rs @@ -0,0 +1,51 @@ +mod helpers; +use helpers::*; + +#[rstest] +fn uploading_files_works(tmpdir: TempDir, port: u16) -> Result<(), Error> { + let test_file_name = "uploaded test file.txt"; + + let mut child = Command::cargo_bin("miniserve")? + .arg(tmpdir.path()) + .arg("-p") + .arg(port.to_string()) + .arg("-u") + .stdout(Stdio::null()) + .spawn()?; + + sleep(Duration::from_secs(1)); + + // Before uploading, check whether the uploaded file does not yet exist. + let body = reqwest::get(format!("http://localhost:{}", port).as_str())?.error_for_status()?; + let parsed = Document::from_read(body)?; + assert!(parsed.find(Text).all(|x| x.text() != test_file_name)); + + // Perform the actual upload. + let upload_action = parsed + .find(Attr("id", "file_submit")) + .next() + .expect("Couldn't find element with id=file_submit") + .attr("action") + .expect("Upload form doesn't have action attribute"); + let form = multipart::Form::new(); + let part = multipart::Part::text("this should be uploaded") + .file_name(test_file_name) + .mime_str("text/plain")?; + let form = form.part("file_to_upload", part); + + let client = reqwest::Client::new(); + client + .post(format!("http://localhost:{}{}", port, upload_action).as_str()) + .multipart(form) + .send()? + .error_for_status()?; + + // After uploading, check whether the uploaded file is now getting listed. + let body = reqwest::get(format!("http://localhost:{}", port).as_str())?; + let parsed = Document::from_read(body)?; + assert!(parsed.find(Text).any(|x| x.text() == test_file_name)); + + child.kill()?; + + Ok(()) +} From 014bc52dc0e693bca8183bcf19c813452a34cc1c Mon Sep 17 00:00:00 2001 From: khai96_ Date: Mon, 29 Apr 2019 18:37:04 +0700 Subject: [PATCH 2/3] Move helpers.rs to fixtures/mod.rs --- tests/auth.rs | 4 ++-- tests/cli.rs | 4 ++-- tests/{helpers.rs => fixtures/mod.rs} | 0 tests/serve_request.rs | 4 ++-- tests/upload_files.rs | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) rename tests/{helpers.rs => fixtures/mod.rs} (100%) diff --git a/tests/auth.rs b/tests/auth.rs index cefc7ec1d..48f070ef5 100644 --- a/tests/auth.rs +++ b/tests/auth.rs @@ -1,5 +1,5 @@ -mod helpers; -use helpers::*; +mod fixtures; +use fixtures::*; #[rstest_parametrize( cli_auth_arg, client_username, client_password, diff --git a/tests/cli.rs b/tests/cli.rs index c021eb7e8..fe0f14154 100644 --- a/tests/cli.rs +++ b/tests/cli.rs @@ -1,5 +1,5 @@ -mod helpers; -use helpers::*; +mod fixtures; +use fixtures::*; #[test] /// Show help and exit. diff --git a/tests/helpers.rs b/tests/fixtures/mod.rs similarity index 100% rename from tests/helpers.rs rename to tests/fixtures/mod.rs diff --git a/tests/serve_request.rs b/tests/serve_request.rs index 10b2bfc4a..31b9b7568 100644 --- a/tests/serve_request.rs +++ b/tests/serve_request.rs @@ -1,5 +1,5 @@ -mod helpers; -use helpers::*; +mod fixtures; +use fixtures::*; #[rstest] fn serves_requests_with_no_options(tmpdir: TempDir) -> Result<(), Error> { diff --git a/tests/upload_files.rs b/tests/upload_files.rs index 4ebdb6928..1bdecc376 100644 --- a/tests/upload_files.rs +++ b/tests/upload_files.rs @@ -1,5 +1,5 @@ -mod helpers; -use helpers::*; +mod fixtures; +use fixtures::*; #[rstest] fn uploading_files_works(tmpdir: TempDir, port: u16) -> Result<(), Error> { From b7d35f5d48882c804e22de0019822c9406576033 Mon Sep 17 00:00:00 2001 From: khai96_ Date: Wed, 1 May 2019 11:04:21 +0700 Subject: [PATCH 3/3] Allow dead code to fix false negative warnings --- tests/fixtures/mod.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/fixtures/mod.rs b/tests/fixtures/mod.rs index 3c5ad7279..d074cb0f6 100644 --- a/tests/fixtures/mod.rs +++ b/tests/fixtures/mod.rs @@ -1,3 +1,5 @@ +#![allow(dead_code)] + pub use assert_cmd::prelude::*; pub use assert_fs::fixture::TempDir; pub use assert_fs::prelude::*;