tracing: run tests on wasm32-unknown-unknown (tokio-rs#959)

Mythra · web-flow · commit 9a2ae7181eb5 · 2020-08-27T11:12:26.000-07:00
## Motivation refs tokio-rs#642 Start Testing the core crate in a wasm environment. This requires a special runner, and an extra dev-dependency. All tests have been ported over except for `span::spans_always_go_to_the_subscriber_that_tagged_them_even_across_threads` because that spins up a thread, and wasm has no concept of threads being spun up. ## Solution Add a wasm-pack tester, and properly tag all tests.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -166,7 +166,6 @@ jobs:
       matrix:
         # TODO(securityinsanity): slowly add wasm32 test runner to each crate, and move to seperate actions that run tests.
         subcrate:
-        - tracing
         - tracing-appender
         - tracing-attributes
         - tracing-core
@@ -192,6 +191,25 @@ jobs:
         command: test
         args: --no-run -p ${{ matrix.subcrate }}
 
+  test-wasm:
+    needs: check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        subcrate:
+        - tracing
+    steps:
+    - uses: actions/checkout@main
+    - uses: actions-rs/toolchain@v1
+      with:
+        target: wasm32-unknown-unknown
+        toolchain: stable
+        override: true
+    - name: install test runner for wasm
+      run:  curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+    - name: run wasm tests
+      run: cd ${{ matrix.subcrate }} && wasm-pack test --node
+
   test-os:
     # Test against stable Rust across macOS, Windows, and Linux.
     needs: check
diff --git a/tracing/Cargo.toml b/tracing/Cargo.toml
@@ -37,6 +37,9 @@ futures = "0.1"
 criterion = { version = "0.3", default_features = false }
 log = "0.4"
 
+[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
+wasm-bindgen-test = "^0.3"
+
 [features]
 default = ["std", "attributes"]
 
diff --git a/tracing/test-log-support/tests/log_no_trace.rs b/tracing/test-log-support/tests/log_no_trace.rs
@@ -5,6 +5,7 @@ extern crate test_log_support;
 use test_log_support::Test;
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn test_always_log() {
     let test = Test::start();
diff --git a/tracing/test-log-support/tests/log_with_trace.rs b/tracing/test-log-support/tests/log_with_trace.rs
@@ -26,6 +26,7 @@ impl tracing::Subscriber for NopSubscriber {
     }
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn log_with_trace() {
     tracing::subscriber::set_global_default(NopSubscriber).expect("set global should succeed");
diff --git a/tracing/test-log-support/tests/span_activity_filtered_separately.rs b/tracing/test-log-support/tests/span_activity_filtered_separately.rs
@@ -5,6 +5,7 @@ extern crate test_log_support;
 use test_log_support::Test;
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn span_activity_filtered_separately() {
     let test = Test::with_filters(&[
diff --git a/tracing/test-log-support/tests/span_lifecycle_can_be_enabled.rs b/tracing/test-log-support/tests/span_lifecycle_can_be_enabled.rs
@@ -5,6 +5,7 @@ extern crate test_log_support;
 use test_log_support::Test;
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn span_lifecycle_can_be_enabled() {
     let test = Test::with_filters(&[
diff --git a/tracing/test-log-support/tests/span_lifecycle_defaults_off.rs b/tracing/test-log-support/tests/span_lifecycle_defaults_off.rs
@@ -5,6 +5,7 @@ extern crate test_log_support;
 use test_log_support::Test;
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn span_lifecycle_defaults_off() {
     let test = Test::with_filters(&[(module_path!(), log::LevelFilter::Trace)]);
diff --git a/tracing/test-log-support/tests/span_lifecycle_is_trace.rs b/tracing/test-log-support/tests/span_lifecycle_is_trace.rs
@@ -5,6 +5,7 @@ extern crate test_log_support;
 use test_log_support::Test;
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn span_lifecycle_is_trace() {
     let test = Test::with_filters(&[
diff --git a/tracing/test_static_max_level_features/tests/test.rs b/tracing/test_static_max_level_features/tests/test.rs
@@ -33,6 +33,7 @@ impl Subscriber for TestSubscriber {
     fn exit(&self, _span: &Id) {}
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn test_static_max_level_features() {
     let me = Arc::new(State {
diff --git a/tracing/tests/event.rs b/tracing/tests/event.rs
@@ -20,6 +20,7 @@ use tracing::{
 
 macro_rules! event_without_message {
     ($name:ident: $e:expr) => {
+        #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
         #[test]
         fn $name() {
             let (subscriber, handle) = subscriber::mock()
@@ -55,6 +56,7 @@ event_without_message! {nonzeroi32_event_without_message: std::num::NonZeroI32::
 // needs API breakage
 //event_without_message!{nonzerou128_event_without_message: std::num::NonZeroU128::new(42).unwrap()}
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn event_with_message() {
     let (subscriber, handle) = subscriber::mock()
@@ -71,6 +73,7 @@ fn event_with_message() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn message_without_delims() {
     let (subscriber, handle) = subscriber::mock()
@@ -99,6 +102,7 @@ fn message_without_delims() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn string_message_without_delims() {
     let (subscriber, handle) = subscriber::mock()
@@ -126,6 +130,7 @@ fn string_message_without_delims() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn one_with_everything() {
     let (subscriber, handle) = subscriber::mock()
@@ -160,6 +165,7 @@ fn one_with_everything() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn moved_field() {
     let (subscriber, handle) = subscriber::mock()
@@ -180,6 +186,7 @@ fn moved_field() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn dotted_field_name() {
     let (subscriber, handle) = subscriber::mock()
@@ -200,6 +207,7 @@ fn dotted_field_name() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn borrowed_field() {
     let (subscriber, handle) = subscriber::mock()
@@ -222,6 +230,7 @@ fn borrowed_field() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 // If emitting log instrumentation, this gets moved anyway, breaking the test.
 #[cfg(not(feature = "log"))]
@@ -262,6 +271,7 @@ fn move_field_out_of_struct() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn display_shorthand() {
     let (subscriber, handle) = subscriber::mock()
@@ -281,6 +291,7 @@ fn display_shorthand() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn debug_shorthand() {
     let (subscriber, handle) = subscriber::mock()
@@ -300,6 +311,7 @@ fn debug_shorthand() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn both_shorthands() {
     let (subscriber, handle) = subscriber::mock()
@@ -320,6 +332,7 @@ fn both_shorthands() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn explicit_child() {
     let (subscriber, handle) = subscriber::mock()
@@ -336,6 +349,7 @@ fn explicit_child() {
     handle.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn explicit_child_at_levels() {
     let (subscriber, handle) = subscriber::mock()
diff --git a/tracing/tests/filter_caching_is_lexically_scoped.rs b/tracing/tests/filter_caching_is_lexically_scoped.rs
@@ -19,6 +19,7 @@ use std::sync::{
     Arc,
 };
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn filter_caching_is_lexically_scoped() {
     pub fn my_great_function() -> bool {
diff --git a/tracing/tests/filters_are_not_reevaluated_for_the_same_span.rs b/tracing/tests/filters_are_not_reevaluated_for_the_same_span.rs
@@ -18,6 +18,7 @@ use std::sync::{
     Arc,
 };
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn filters_are_not_reevaluated_for_the_same_span() {
     // Asserts that the `span!` macro caches the result of calling
diff --git a/tracing/tests/filters_are_reevaluated_for_different_call_sites.rs b/tracing/tests/filters_are_reevaluated_for_different_call_sites.rs
@@ -18,6 +18,7 @@ use std::sync::{
     Arc,
 };
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn filters_are_reevaluated_for_different_call_sites() {
     // Asserts that the `span!` macro caches the result of calling
diff --git a/tracing/tests/filters_dont_leak.rs b/tracing/tests/filters_dont_leak.rs
@@ -3,6 +3,7 @@
 mod support;
 use self::support::*;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn spans_dont_leak() {
     fn do_span() {
@@ -43,6 +44,7 @@ fn spans_dont_leak() {
     handle2.assert_finished();
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn events_dont_leak() {
     fn do_event() {
diff --git a/tracing/tests/macro_imports.rs b/tracing/tests/macro_imports.rs
@@ -1,5 +1,6 @@
 use tracing::Level;
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn prefixed_span_macros() {
     tracing::span!(Level::DEBUG, "foo");
@@ -10,6 +11,7 @@ fn prefixed_span_macros() {
     tracing::error_span!("foo");
 }
 
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
 #[test]
 fn prefixed_event_macros() {
     tracing::event!(Level::DEBUG, "foo");
diff --git a/tracing/tests/macros.rs b/tracing/tests/macros.rs
diff --git a/tracing/tests/max_level_hint.rs b/tracing/tests/max_level_hint.rs
diff --git a/tracing/tests/multiple_max_level_hints.rs b/tracing/tests/multiple_max_level_hints.rs
diff --git a/tracing/tests/span.rs b/tracing/tests/span.rs
diff --git a/tracing/tests/subscriber.rs b/tracing/tests/subscriber.rs

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ impl tracing::Subscriber for NopSubscriber {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
	`29`	`+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]`
`29`	`30`	`#[test]`
`30`	`31`	`fn log_with_trace() {`
`31`	`32`	`tracing::subscriber::set_global_default(NopSubscriber).expect("set global should succeed");`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ impl Subscriber for TestSubscriber {`
`33`	`33`	`fn exit(&self, _span: &Id) {}`
`34`	`34`	`}`
`35`	`35`
	`36`	`+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]`
`36`	`37`	`#[test]`
`37`	`38`	`fn test_static_max_level_features() {`
`38`	`39`	`let me = Arc::new(State {`