Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6aaed54

Browse files
daxpeddadaxpedda
committedDec 19, 2024··
Use LLVM_PROFILE_FILE for test coverage
1 parent e464ba3 commit 6aaed54

File tree

16 files changed

+176
-50
lines changed

16 files changed

+176
-50
lines changed
 

Diff for: ‎.github/workflows/main.yml

+2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ jobs:
7272
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-macro-support -- -D warnings
7373
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-multi-value-xform -- -D warnings
7474
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-shared -- -D warnings
75+
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-test-shared -- -D warnings
7576
- run: cargo clippy --no-deps --all-features --target wasm32-unknown-unknown -p wasm-bindgen-test -- -D warnings
7677
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-test-macro -- -D warnings
7778
- run: cargo clippy --no-deps --all-features -p wasm-bindgen-threads-xform -- -D warnings
@@ -275,6 +276,7 @@ jobs:
275276
- run: cargo test -p wasm-bindgen-wasm-interpreter
276277
- run: cargo test -p wasm-bindgen-futures
277278
- run: cargo test -p wasm-bindgen-shared
279+
- run: cargo test -p wasm-bindgen-test-shared
278280

279281
test_with_geckodriver:
280282
strategy:

Diff for: ‎CHANGELOG.md

+3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@
4040
* `console.*()` calls in tests are now always intercepted by default. To show them use `--nocapture`. When shown they are always printed in-place instead of after test results, analogous to `cargo test`.
4141
[#4356](https://github.com/rustwasm/wasm-bindgen/pull/4356)
4242

43+
* Replace `WASM_BINDGEN_UNSTABLE_TEST_PROFRAW_OUT` and `WASM_BINDGEN_UNSTABLE_TEST_PROFRAW_PREFIX` with parsing `LLVM_PROFILE_FILE` analogous to Rust test coverage.
44+
[#4367](https://github.com/rustwasm/wasm-bindgen/pull/4367)
45+
4346
### Fixed
4447

4548
- Fixed using [JavaScript keyword](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#keywords) as identifiers not being handled correctly.

Diff for: ‎Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ resolver = "2"
135135

136136
[patch.crates-io]
137137
js-sys = { path = 'crates/js-sys' }
138+
minicov = { git = "https://github.com/daxpedda/minicov", branch = "module-signature" }
138139
wasm-bindgen = { path = '.' }
139140
wasm-bindgen-futures = { path = 'crates/futures' }
140141
web-sys = { path = 'crates/web-sys' }

Diff for: ‎crates/cli/Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ ureq = { version = "2.7", default-features = false, features = ["brotli", "gzip"
3535
walrus = "0.23"
3636
wasm-bindgen-cli-support = { path = "../cli-support", version = "=0.2.99" }
3737
wasm-bindgen-shared = { path = "../shared", version = "=0.2.99" }
38+
wasm-bindgen-test-shared = { path = "../test-shared", version = "=0.2.99" }
3839

3940
[dev-dependencies]
4041
assert_cmd = "2"

Diff for: ‎crates/cli/src/bin/wasm-bindgen-test-runner/main.rs

+1-33
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ use clap::Parser;
1616
use clap::ValueEnum;
1717
use std::env;
1818
use std::fs;
19-
use std::path::Path;
2019
use std::path::PathBuf;
2120
use std::thread;
2221
use wasm_bindgen_cli_support::Bindgen;
@@ -102,12 +101,6 @@ fn main() -> anyhow::Result<()> {
102101

103102
let shell = shell::Shell::new();
104103

105-
let file_name = cli
106-
.file
107-
.file_name()
108-
.map(Path::new)
109-
.context("file to test is not a valid file, can't extract file name")?;
110-
111104
// Collect all tests that the test harness is supposed to run. We assume
112105
// that any exported function with the prefix `__wbg_test` is a test we need
113106
// to execute.
@@ -276,8 +269,6 @@ fn main() -> anyhow::Result<()> {
276269
b.split_linked_modules(true);
277270
}
278271

279-
let coverage = coverage_args(file_name);
280-
281272
b.debug(debug)
282273
.input_module(module, wasm)
283274
.keep_debug(false)
@@ -288,7 +279,7 @@ fn main() -> anyhow::Result<()> {
288279

289280
match test_mode {
290281
TestMode::Node { no_modules } => {
291-
node::execute(module, tmpdir.path(), cli, &tests, !no_modules, coverage)?
282+
node::execute(module, tmpdir.path(), cli, &tests, !no_modules)?
292283
}
293284
TestMode::Deno => deno::execute(module, tmpdir.path(), cli, &tests)?,
294285
TestMode::Browser { .. }
@@ -310,7 +301,6 @@ fn main() -> anyhow::Result<()> {
310301
&tests,
311302
test_mode,
312303
std::env::var("WASM_BINDGEN_TEST_NO_ORIGIN_ISOLATION").is_err(),
313-
coverage,
314304
)
315305
.context("failed to spawn server")?;
316306
let addr = srv.server_addr();
@@ -379,28 +369,6 @@ impl TestMode {
379369
}
380370
}
381371

382-
fn coverage_args(file_name: &Path) -> PathBuf {
383-
fn generated(file_name: &Path, prefix: &str) -> String {
384-
let res = format!("{prefix}{}.profraw", file_name.display());
385-
res
386-
}
387-
388-
let prefix = env::var_os("WASM_BINDGEN_UNSTABLE_TEST_PROFRAW_PREFIX")
389-
.map(|s| s.to_str().unwrap().to_string())
390-
.unwrap_or_default();
391-
392-
match env::var_os("WASM_BINDGEN_UNSTABLE_TEST_PROFRAW_OUT") {
393-
Some(s) => {
394-
let mut buf = PathBuf::from(s);
395-
if buf.is_dir() {
396-
buf.push(generated(file_name, &prefix));
397-
}
398-
buf
399-
}
400-
None => PathBuf::from(generated(file_name, &prefix)),
401-
}
402-
}
403-
404372
/// Possible values for the `--format` option.
405373
#[derive(Debug, Clone, Copy, ValueEnum)]
406374
enum FormatSetting {

Diff for: ‎crates/cli/src/bin/wasm-bindgen-test-runner/node.rs

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
use std::env;
22
use std::fs;
3-
use std::path::{Path, PathBuf};
3+
use std::path::Path;
4+
use std::process;
45
use std::process::Command;
56

67
use anyhow::{Context, Error};
@@ -49,8 +50,18 @@ pub fn execute(
4950
cli: Cli,
5051
tests: &[String],
5152
module_format: bool,
52-
coverage: PathBuf,
5353
) -> Result<(), Error> {
54+
let coverage_env = if let Ok(env) = env::var("LLVM_PROFILE_FILE") {
55+
&format!("\"{env}\"")
56+
} else {
57+
"undefined"
58+
};
59+
let coverage_pid = process::id();
60+
let coverage_temp_dir = env::temp_dir()
61+
.to_str()
62+
.map(String::from)
63+
.context("failed to parse path to temporary directory")?;
64+
5465
let mut js_to_execute = format!(
5566
r#"
5667
{exit};
@@ -68,8 +79,10 @@ pub fn execute(
6879
const ok = await cx.run(tests.map(n => wasm.__wasm[n]));
6980
7081
const coverage = wasm.__wbgtest_cov_dump();
71-
if (coverage !== undefined)
72-
await fs.writeFile('{coverage}', coverage);
82+
if (coverage !== undefined) {{
83+
const path = wasm.__wbgtest_coverage_path({coverage_env}, {coverage_pid}, {coverage_temp_dir:?}, wasm.__wbgtest_module_signature());
84+
await fs.writeFile(path, coverage);
85+
}}
7386
7487
if (!ok)
7588
exit(1);
@@ -92,7 +105,6 @@ pub fn execute(
92105
} else {
93106
r"import fs from 'node:fs/promises'".to_string()
94107
},
95-
coverage = coverage.display(),
96108
nocapture = cli.nocapture.clone(),
97109
console_override = SHARED_SETUP,
98110
args = cli.into_args(),

Diff for: ‎crates/cli/src/bin/wasm-bindgen-test-runner/server.rs

+24-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
use std::borrow::Cow;
2-
use std::fs;
32
use std::io::{Read, Write};
43
use std::net::SocketAddr;
5-
use std::path::{Path, PathBuf};
4+
use std::path::Path;
5+
use std::{env, fs, process};
66

77
use anyhow::{anyhow, Context, Error};
88
use rouille::{Request, Response, Server};
@@ -18,14 +18,14 @@ pub(crate) fn spawn(
1818
tests: &[String],
1919
test_mode: TestMode,
2020
isolate_origin: bool,
21-
coverage: PathBuf,
2221
) -> Result<Server<impl Fn(&Request) -> Response + Send + Sync>, Error> {
2322
let mut js_to_execute = String::new();
2423

2524
let cov_import = if test_mode.no_modules() {
26-
"let __wbgtest_cov_dump = wasm_bindgen.__wbgtest_cov_dump;"
25+
"let __wbgtest_cov_dump = wasm_bindgen.__wbgtest_cov_dump;\n\
26+
let __wbgtest_module_signature = wasm_bindgen.__wbgtest_module_signature;"
2727
} else {
28-
"__wbgtest_cov_dump,"
28+
"__wbgtest_cov_dump,__wbgtest_module_signature,"
2929
};
3030
let cov_dump = r#"
3131
// Dump the coverage data collected during the tests
@@ -34,6 +34,9 @@ pub(crate) fn spawn(
3434
if (coverage !== undefined) {
3535
await fetch("/__wasm_bindgen/coverage", {
3636
method: "POST",
37+
headers: {
38+
"Module-Signature": __wbgtest_module_signature(),
39+
},
3740
body: coverage
3841
});
3942
}
@@ -326,7 +329,13 @@ pub(crate) fn spawn(
326329

327330
return response;
328331
} else if request.url() == "/__wasm_bindgen/coverage" {
329-
return if let Err(e) = handle_coverage_dump(&coverage, request) {
332+
let module_signature = request
333+
.header("Module-Signature")
334+
.expect("sent coverage data without module signature")
335+
.parse()
336+
.expect("sent invalid module signature");
337+
338+
return if let Err(e) = handle_coverage_dump(module_signature, request) {
330339
let s: &str = &format!("Failed to dump coverage: {e}");
331340
log::error!("{s}");
332341
let mut ret = Response::text(s);
@@ -386,9 +395,17 @@ pub(crate) fn spawn(
386395
}
387396
}
388397

389-
fn handle_coverage_dump(profraw_path: &Path, request: &Request) -> anyhow::Result<()> {
398+
fn handle_coverage_dump(module_signature: u64, request: &Request) -> anyhow::Result<()> {
390399
// This is run after all tests are done and dumps the data received in the request
391400
// into a single profraw file
401+
let profraw_path = wasm_bindgen_test_shared::coverage_path(
402+
env::var("LLVM_PROFILE_FILE").ok().as_deref(),
403+
process::id(),
404+
env::temp_dir()
405+
.to_str()
406+
.context("failed to parse path to temporary directory")?,
407+
module_signature,
408+
);
392409
let mut profraw = std::fs::File::create(profraw_path)?;
393410
let mut data = Vec::new();
394411
if let Some(mut r_data) = request.data() {

Diff for: ‎crates/test-shared/Cargo.toml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[package]
2+
authors = ["The wasm-bindgen Developers"]
3+
description = """
4+
Shared support between wasm-bindgen-test and wasm-bindgen-test-runner, an internal
5+
dependency.
6+
"""
7+
documentation = "https://docs.rs/wasm-bindgen-test-shared"
8+
edition = "2021"
9+
homepage = "https://rustwasm.github.io/wasm-bindgen/"
10+
include = ["/LICENSE-*", "/src"]
11+
license = "MIT OR Apache-2.0"
12+
name = "wasm-bindgen-test-shared"
13+
repository = "https://github.com/rustwasm/wasm-bindgen/tree/master/crates/test-shared"
14+
rust-version = "1.57"
15+
version = "0.2.99"
16+
17+
[lints]
18+
workspace = true

Diff for: ‎crates/test-shared/LICENSE-APACHE

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../LICENSE-APACHE

Diff for: ‎crates/test-shared/LICENSE-MIT

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../LICENSE-MIT

Diff for: ‎crates/test-shared/src/lib.rs

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
#![doc(html_root_url = "https://docs.rs/wasm-bindgen-test-shared/0.2")]
2+
#![no_std]
3+
4+
extern crate alloc;
5+
6+
use alloc::string::{String, ToString};
7+
8+
pub fn coverage_path(env: Option<&str>, pid: u32, tmpdir: &str, module_signature: u64) -> String {
9+
let env = env.unwrap_or("default_%m_%p.profraw");
10+
11+
let mut path = String::new();
12+
let mut chars = env.chars().enumerate().peekable();
13+
14+
while let Some((index, char)) = chars.next() {
15+
if char != '%' {
16+
path.push(char);
17+
continue;
18+
}
19+
20+
if chars.next_if(|(_, c)| *c == 'p').is_some() {
21+
path.push_str(&pid.to_string())
22+
} else if chars.next_if(|(_, c)| *c == 'h').is_some() {
23+
path.push_str("wbgt")
24+
} else if chars.next_if(|(_, c)| *c == 't').is_some() {
25+
path.push_str(tmpdir)
26+
} else {
27+
let mut last_index = index;
28+
29+
loop {
30+
if let Some((index, _)) = chars.next_if(|(_, c)| c.is_ascii_digit()) {
31+
last_index = index;
32+
} else if chars.next_if(|(_, c)| *c == 'm').is_some() {
33+
path.push_str(&module_signature.to_string());
34+
path.push_str("_0");
35+
break;
36+
} else {
37+
path.push_str(&env[index..=last_index]);
38+
break;
39+
}
40+
}
41+
}
42+
}
43+
44+
path
45+
}
46+
47+
#[test]
48+
fn test() {
49+
fn asssert<'a>(env: impl Into<Option<&'a str>>, result: &str) {
50+
assert_eq!(coverage_path(env.into(), 123, "tmp", 456), result);
51+
}
52+
53+
asssert(None, "default_456_0_123.profraw");
54+
asssert("", "");
55+
asssert("%p", "123");
56+
asssert("%h", "wbgt");
57+
asssert("%t", "tmp");
58+
asssert("%m", "456_0");
59+
asssert("%0123456789m", "456_0");
60+
asssert("%", "%");
61+
asssert("%%", "%%");
62+
asssert("%a", "%a");
63+
asssert("%0123456789", "%0123456789");
64+
asssert("%0123456789p", "%0123456789p");
65+
asssert("%%p", "%123");
66+
asssert("%%%p", "%%123");
67+
asssert("%a%p", "%a123");
68+
asssert("%0123456789%p", "%0123456789123");
69+
asssert("%p%", "123%");
70+
asssert("%p%%", "123%%");
71+
asssert("%p%a", "123%a");
72+
asssert("%p%0123456789", "123%0123456789");
73+
asssert("%p%0123456789p", "123%0123456789p");
74+
asssert("%m%a", "456_0%a");
75+
asssert("%m%0123456789", "456_0%0123456789");
76+
asssert("%m%0123456789p", "456_0%0123456789p");
77+
asssert("%0123456789m%a", "456_0%a");
78+
asssert("%0123456789m%0123456789", "456_0%0123456789");
79+
asssert("%0123456789m%0123456789p", "456_0%0123456789p");
80+
}

Diff for: ‎crates/test/Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ js-sys = { path = '../js-sys', version = '=0.3.76', default-features = false }
1919
wasm-bindgen = { path = '../..', version = '=0.2.99', default-features = false }
2020
wasm-bindgen-futures = { path = '../futures', version = '=0.4.49', default-features = false }
2121
wasm-bindgen-test-macro = { path = '../test-macro', version = '=0.3.49' }
22+
wasm-bindgen-test-shared = { path = "../test-shared", version = "=0.2.99" }
2223

2324
[target.'cfg(all(target_arch = "wasm32", wasm_bindgen_unstable_test_coverage))'.dependencies]
2425
minicov = "0.3"

Diff for: ‎crates/test/src/coverage.rs

+12
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,15 @@ pub fn __wbgtest_cov_dump() -> Option<Vec<u8>> {
2323
pub fn __wbgtest_cov_dump() -> Option<Vec<u8>> {
2424
None
2525
}
26+
27+
#[cfg(wasm_bindgen_unstable_test_coverage)]
28+
#[wasm_bindgen]
29+
pub fn __wbgtest_module_signature() -> Option<u64> {
30+
Some(minicov::module_signature())
31+
}
32+
33+
#[cfg(not(wasm_bindgen_unstable_test_coverage))]
34+
#[wasm_bindgen]
35+
pub fn __wbgtest_module_signature() -> Option<u64> {
36+
None
37+
}

Diff for: ‎crates/test/src/rt/node.rs

+11
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,14 @@ impl super::Formatter for Node {
4444
NodeError::from(err.clone()).stack()
4545
}
4646
}
47+
48+
/// Path to use for coverage data.
49+
#[wasm_bindgen]
50+
pub fn __wbgtest_coverage_path(
51+
env: Option<String>,
52+
pid: u32,
53+
temp_dir: &str,
54+
module_signature: u64,
55+
) -> String {
56+
wasm_bindgen_test_shared::coverage_path(env.as_deref(), pid, temp_dir, module_signature)
57+
}

0 commit comments

Comments
 (0)
Please sign in to comment.