From b72051d385fe178cbb95865942bc42b983665a63 Mon Sep 17 00:00:00 2001 From: Chinedu Francis Nwafili Date: Sun, 27 Jan 2019 10:08:56 -0500 Subject: [PATCH 1/6] Pass arguments through to cargo test --- docs/src/commands/build.md | 2 +- docs/src/commands/test.md | 54 ++++++++++++++++++++++++++++++++++++++ src/build.rs | 12 --------- src/command/build.rs | 2 +- src/command/test.rs | 27 ++++++++----------- src/test/mod.rs | 8 +++++- 6 files changed, 74 insertions(+), 31 deletions(-) create mode 100644 docs/src/commands/test.md diff --git a/docs/src/commands/build.md b/docs/src/commands/build.md index 96371fc..49b4540 100644 --- a/docs/src/commands/build.md +++ b/docs/src/commands/build.md @@ -59,7 +59,7 @@ wasm-pack build --target nodejs | Option | Description | |-----------|-----------------------------------------------------------------------------------------------------------------| | `nodejs` | Outputs JS that uses CommonJS modules, for use with a `require` statement. `main` key in `package.json`. | -| `nomodules` | Outputs JS that use no modules. `browser` key in `package.json`. | +| `no-modules` | Outputs JS that use no modules. `browser` key in `package.json`. | | `browser` | Outputs JS that uses ES6 modules, primarily for use with `import` statements and/or bundlers such as `webpack`. `module` key in `package.json`. `sideEffects: false` by default. | ## Scope diff --git a/docs/src/commands/test.md b/docs/src/commands/test.md new file mode 100644 index 0000000..5f679ce --- /dev/null +++ b/docs/src/commands/test.md @@ -0,0 +1,54 @@ +# wasm-pack test + +The `wasm-pack test` command wraps the [wasm-bindgen-test-runner](https://rustwasm.github.io/wasm-bindgen/wasm-bindgen-test/index.html) +CLI allowing you to run wasm tests in different browsers without needing to install the different +webdrivers yourself. + +``` +wasm-pack test --help +``` + +## Path + +The `wasm-pack test` command can be given an optional path argument. + +This path should point to a directory that contains a `Cargo.toml` file. If no +path is given, the `test` command will run in the current directory. + +``` +# Run tests for the current directory's crate +wasm-pack test + +# Run tests for a specified crate +wasm-pack test crates/crate-in-my-workspace +``` + +## Profile + +The `test` command accepts an optional profile argument: `--release`. + +If none is supplied, then a debug test build will be used. + +## Test environment + +Choose where to run your tests by passing in any combination of testing environment flags. + +`--headless` is useful for running browser tests in a headless browser as part of a CI process. + +``` +wasm-pack test --node --firefox --chrome --safari --headless +``` + +## Extra options + +The `test` command can pass extra options straight to `cargo test` even if they are not +supported in wasm-pack. + +To use them you should add standalone `--` argument at the very +end of your command, and all the arguments you want to pass to cargo should go after. + +Here's an example of running only tests that contain the world "apple". + +``` +wasm-pack test --firefox --headless -- --manifest-path=crates/my-workspace-crate/Cargo.toml apple +``` diff --git a/src/build.rs b/src/build.rs index 9e29c6d..e0fb1ca 100644 --- a/src/build.rs +++ b/src/build.rs @@ -93,15 +93,3 @@ pub fn cargo_build_wasm( child::run(cmd, "cargo build").context("Compiling your crate to WebAssembly failed")?; Ok(()) } - -/// Run `cargo build --tests` targetting `wasm32-unknown-unknown`. -pub fn cargo_build_wasm_tests(path: &Path, debug: bool) -> Result<(), Error> { - let mut cmd = Command::new("cargo"); - cmd.current_dir(path).arg("build").arg("--tests"); - if !debug { - cmd.arg("--release"); - } - cmd.arg("--target").arg("wasm32-unknown-unknown"); - child::run(cmd, "cargo build").context("Compilation of your program failed")?; - Ok(()) -} diff --git a/src/command/build.rs b/src/command/build.rs index ee59a75..4dd5d79 100644 --- a/src/command/build.rs +++ b/src/command/build.rs @@ -19,7 +19,7 @@ use std::str::FromStr; use std::time::Instant; use PBAR; -/// Everything required to configure and run the `wasm-pack init` command. +/// Everything required to configure and run the `wasm-pack build` command. #[allow(missing_docs)] pub struct Build { pub crate_path: PathBuf, diff --git a/src/command/test.rs b/src/command/test.rs index ff2f348..7c492b4 100644 --- a/src/command/test.rs +++ b/src/command/test.rs @@ -78,6 +78,10 @@ pub struct TestOptions { #[structopt(long = "release", short = "r")] /// Build with the release profile. pub release: bool, + + #[structopt(last = true)] + /// List of extra options to pass to `cargo test` + pub extra_options: Vec, } /// A configured `wasm-pack test` command. @@ -96,6 +100,7 @@ pub struct Test { headless: bool, release: bool, test_runner_path: Option, + extra_options: Vec } type TestStep = fn(&mut Test, &Step) -> Result<(), Error>; @@ -115,6 +120,7 @@ impl Test { geckodriver, safari, safaridriver, + extra_options, } = test_opts; let crate_path = set_crate_path(path)?; @@ -147,6 +153,7 @@ impl Test { headless, release, test_runner_path: None, + extra_options, }) } @@ -213,7 +220,6 @@ impl Test { step_test_safari if self.safari, ], BuildMode::Noinstall => steps![ - step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -240,18 +246,6 @@ impl Test { Ok(()) } - fn step_build_tests(&mut self, step: &Step) -> Result<(), Error> { - info!("Compiling tests to wasm..."); - - let msg = format!("{}Compiling tests to WASM...", emoji::CYCLONE); - PBAR.step(step, &msg); - - build::cargo_build_wasm_tests(&self.crate_path, !self.release)?; - - info!("Finished compiling tests to wasm."); - Ok(()) - } - fn step_install_wasm_bindgen(&mut self, step: &Step) -> Result<(), Error> { info!("Identifying wasm-bindgen dependency..."); let lockfile = Lockfile::new(&self.crate_data)?; @@ -306,6 +300,7 @@ impl Test { "CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER", &self.test_runner_path.as_ref().unwrap(), )), + &self.extra_options )?; info!("Finished running tests in node."); Ok(()) @@ -349,7 +344,7 @@ impl Test { envs.push(("NO_HEADLESS", "1")); } - test::cargo_test_wasm(&self.crate_path, self.release, envs)?; + test::cargo_test_wasm(&self.crate_path, self.release, envs, &self.extra_options)?; Ok(()) } @@ -391,7 +386,7 @@ impl Test { envs.push(("NO_HEADLESS", "1")); } - test::cargo_test_wasm(&self.crate_path, self.release, envs)?; + test::cargo_test_wasm(&self.crate_path, self.release, envs, &self.extra_options)?; Ok(()) } @@ -430,7 +425,7 @@ impl Test { envs.push(("NO_HEADLESS", "1")); } - test::cargo_test_wasm(&self.crate_path, self.release, envs)?; + test::cargo_test_wasm(&self.crate_path, self.release, envs, &self.extra_options)?; Ok(()) } } diff --git a/src/test/mod.rs b/src/test/mod.rs index 77eff43..7448567 100644 --- a/src/test/mod.rs +++ b/src/test/mod.rs @@ -10,7 +10,12 @@ use std::process::Command; /// Run `cargo test` with the `nightly` toolchain and targeting /// `wasm32-unknown-unknown`. -pub fn cargo_test_wasm(path: &Path, release: bool, envs: I) -> Result<(), failure::Error> +pub fn cargo_test_wasm( + path: &Path, + release: bool, + envs: I, + extra_options: &Vec, +) -> Result<(), failure::Error> where I: IntoIterator, K: AsRef, @@ -23,6 +28,7 @@ where cmd.arg("--release"); } cmd.arg("--target").arg("wasm32-unknown-unknown"); + cmd.args(extra_options); child::run(cmd, "cargo test").context("Running Wasm tests with wasm-bindgen-test failed")?; // NB: `child::run` took care of ensuring that test output gets printed. From 42413acb493d8d939143d0db14e6ddc4d6197ea4 Mon Sep 17 00:00:00 2001 From: Chinedu Francis Nwafili Date: Sun, 27 Jan 2019 10:29:48 -0500 Subject: [PATCH 2/6] cargo fmt --- src/command/test.rs | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/command/test.rs b/src/command/test.rs index 7c492b4..829f3d3 100644 --- a/src/command/test.rs +++ b/src/command/test.rs @@ -100,7 +100,7 @@ pub struct Test { headless: bool, release: bool, test_runner_path: Option, - extra_options: Vec + extra_options: Vec, } type TestStep = fn(&mut Test, &Step) -> Result<(), Error>; @@ -197,7 +197,6 @@ impl Test { BuildMode::Normal => steps![ step_check_rustc_version, step_add_wasm_target, - step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -209,7 +208,6 @@ impl Test { ], BuildMode::Force => steps![ step_add_wasm_target, - step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -300,7 +298,7 @@ impl Test { "CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER", &self.test_runner_path.as_ref().unwrap(), )), - &self.extra_options + &self.extra_options, )?; info!("Finished running tests in node."); Ok(()) From f7ad0e7c5a133fbd154864a0de1855ee3b8af6f0 Mon Sep 17 00:00:00 2001 From: Chinedu Francis Nwafili Date: Sun, 27 Jan 2019 10:31:15 -0500 Subject: [PATCH 3/6] Add instructions for options --- docs/src/commands/test.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/commands/test.md b/docs/src/commands/test.md index 5f679ce..ec8663f 100644 --- a/docs/src/commands/test.md +++ b/docs/src/commands/test.md @@ -52,3 +52,5 @@ Here's an example of running only tests that contain the world "apple". ``` wasm-pack test --firefox --headless -- --manifest-path=crates/my-workspace-crate/Cargo.toml apple ``` + +`cargo test -h` for a list of all options that you can pass through. From 879e3aa7a68a793d6c871967380137b42c1fddfc Mon Sep 17 00:00:00 2001 From: Chinedu Francis Nwafili Date: Sun, 27 Jan 2019 11:44:01 -0500 Subject: [PATCH 4/6] Add back building tests --- src/build.rs | 17 ++++++++++++++++- src/command/test.rs | 15 +++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/src/build.rs b/src/build.rs index e0fb1ca..e706b6a 100644 --- a/src/build.rs +++ b/src/build.rs @@ -25,7 +25,7 @@ pub fn check_rustc_version(step: &Step) -> Result { } else { Ok(mv.to_string()) } - }, + } None => bail!("We can't figure out what your Rust version is- which means you might not have Rust installed. Please install Rust version 1.30.0 or higher."), } } @@ -93,3 +93,18 @@ pub fn cargo_build_wasm( child::run(cmd, "cargo build").context("Compiling your crate to WebAssembly failed")?; Ok(()) } + +/// Run `cargo build --tests` targetting `wasm32-unknown-unknown`. +/// +/// This generates the `Cargo.lock` file that we use in order to know which version of +/// wasm-bindgen-cli to use when running tests. +pub fn cargo_build_wasm_tests(path: &Path, debug: bool) -> Result<(), Error> { + let mut cmd = Command::new("cargo"); + cmd.current_dir(path).arg("build").arg("--tests"); + if !debug { + cmd.arg("--release"); + } + cmd.arg("--target").arg("wasm32-unknown-unknown"); + child::run(cmd, "cargo build").context("Compilation of your program failed")?; + Ok(()) +} diff --git a/src/command/test.rs b/src/command/test.rs index 829f3d3..45950fc 100644 --- a/src/command/test.rs +++ b/src/command/test.rs @@ -197,6 +197,7 @@ impl Test { BuildMode::Normal => steps![ step_check_rustc_version, step_add_wasm_target, + step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -208,6 +209,7 @@ impl Test { ], BuildMode::Force => steps![ step_add_wasm_target, + step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -218,6 +220,7 @@ impl Test { step_test_safari if self.safari, ], BuildMode::Noinstall => steps![ + step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -244,6 +247,18 @@ impl Test { Ok(()) } + fn step_build_tests(&mut self, step: &Step) -> Result<(), Error> { + info!("Compiling tests to wasm..."); + + let msg = format!("{}Compiling tests to WASM...", emoji::CYCLONE); + PBAR.step(step, &msg); + + build::cargo_build_wasm_tests(&self.crate_path, !self.release)?; + + info!("Finished compiling tests to wasm."); + Ok(()) + } + fn step_install_wasm_bindgen(&mut self, step: &Step) -> Result<(), Error> { info!("Identifying wasm-bindgen dependency..."); let lockfile = Lockfile::new(&self.crate_data)?; From 3f06d2d959d7e51dabd7410cababd629cff3217e Mon Sep 17 00:00:00 2001 From: Chinedu Francis Nwafili Date: Sun, 27 Jan 2019 11:44:59 -0500 Subject: [PATCH 5/6] Fix formatting --- src/command/test.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/command/test.rs b/src/command/test.rs index 45950fc..f07d4a9 100644 --- a/src/command/test.rs +++ b/src/command/test.rs @@ -197,7 +197,7 @@ impl Test { BuildMode::Normal => steps![ step_check_rustc_version, step_add_wasm_target, - step_build_tests, + step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), @@ -220,7 +220,7 @@ impl Test { step_test_safari if self.safari, ], BuildMode::Noinstall => steps![ - step_build_tests, + step_build_tests, step_install_wasm_bindgen, step_test_node if self.node, step_get_chromedriver if self.chrome && self.chromedriver.is_none(), From 1e4ae144fd68a441aca304e091da1adae172639e Mon Sep 17 00:00:00 2001 From: csmoe Date: Mon, 28 Jan 2019 08:22:22 -0500 Subject: [PATCH 6/6] Apply suggestions from code review Thanks! Co-Authored-By: chinedufn --- src/test/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/mod.rs b/src/test/mod.rs index 7448567..8edecf0 100644 --- a/src/test/mod.rs +++ b/src/test/mod.rs @@ -14,7 +14,7 @@ pub fn cargo_test_wasm( path: &Path, release: bool, envs: I, - extra_options: &Vec, + extra_options: &[String], ) -> Result<(), failure::Error> where I: IntoIterator,