Add MSRV support and testing to this repository (#1557)

alexcrichton · web-flow · commit 777f8bedc699 · 2024-05-13T18:35:17.000Z
* Add MSRV support and testing to this repository

This mirrors the support in Wasmtime, which Wasmtime depends on, to this
repository as well to ensure all various crates are tagged and CI works
similarly.

* Fix a warning on CI

* Fix compat with Rust 1.76

* Fix warnings in `wast` crate when features are disabled

* Disable tests for libdl crate
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -40,7 +40,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - run: rustup update stable --no-self-update && rustup default stable
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
     - uses: bytecodealliance/wasmtime/.github/actions/binary-compatible-builds@v20.0.0
       with:
         name: ${{ matrix.build }}
@@ -63,8 +63,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: true
-      - name: Install Rust
-        run: rustup update stable --no-self-update && rustup default stable
+      - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
       - name: Test (no-hash-maps)
         run: cargo test --workspace --locked --features no-hash-maps
 
@@ -73,29 +72,26 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        build: [stable, beta, nightly, macos, windows]
         include:
-          - build: stable
-            os: ubuntu-latest
-            rust: stable
-          - build: beta
-            os: ubuntu-latest
+          - os: ubuntu-latest
+            rust: default
+          - os: ubuntu-latest
             rust: beta
-          - build: nightly
-            os: ubuntu-latest
+          - os: ubuntu-latest
             rust: nightly
-          - build: macos
-            os: macos-latest
-            rust: stable
-          - build: windows
-            os: windows-latest
-            rust: stable
+          - os: macos-latest
+            rust: default
+          - os: windows-latest
+            rust: default
+          - os: ubuntu-latest
+            rust: msrv
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - name: Install Rust (rustup)
-      run: rustup update ${{ matrix.rust }} --no-self-update && rustup default ${{ matrix.rust }}
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
+      with:
+        toolchain: ${{ matrix.rust }}
     - run: cargo test --locked --all
 
   test_extra_features:
@@ -105,7 +101,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - run: rustup update stable --no-self-update && rustup default stable
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
     - run: cargo test --locked -p wasmparser --benches
     - run: cargo test --locked -p wasm-encoder --all-features
     - run: cargo test -p wasm-smith --features wasmparser
@@ -123,7 +119,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - run: rustup update stable --no-self-update && rustup default stable
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
     - run: cmake -S examples -B examples/build -DCMAKE_BUILD_TYPE=Release
     - run: cmake --build examples/build --config Release
 
@@ -134,13 +130,13 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - name: Install Rust (rustup)
-      run: rustup update 1.77.0 --no-self-update && rustup default 1.77.0
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
+      with:
+        toolchain: 1.77.0
     - run: |
         curl -LO https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-21/wasi-sdk-21.0-linux.tar.gz
         tar xf wasi-sdk-21.0-linux.tar.gz
         export WASI_SDK_PATH=$(pwd)/wasi-sdk-21.0
-        rustup target add wasm32-wasi
         cd crates/wit-component/dl && bash check.sh
 
   wasm:
@@ -150,9 +146,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - name: Install Rust
-      run: rustup update stable --no-self-update && rustup default stable
-    - run: rustup target add wasm32-wasi
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
     - run: |
         tag=v10.0.1
         curl -LO https://github.com/bytecodealliance/wasmtime/releases/download/${tag}/wasmtime-${tag}-x86_64-linux.tar.xz
@@ -172,8 +166,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Install Rust
-      run: rustup update stable && rustup default stable && rustup component add rustfmt
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
+    - run: rustup component add rustfmt
     # Note that this doesn't use `cargo fmt` because that doesn't format
     # modules-defined-in-macros which is in use in `wast` for example. This is
     # the best alternative I can come up with at this time
@@ -186,8 +180,9 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - name: Install Rust
-      run: rustup update nightly && rustup default nightly
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
+      with:
+        toolchain: nightly
     - run: cargo install cargo-fuzz
     - run: cargo fuzz build --dev -s none
     - run: cargo fuzz build --dev --features wasmtime -s none
@@ -196,6 +191,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
       - run: rustup target add x86_64-unknown-none
       - run: cargo check --benches -p wasm-smith
       - run: cargo check --no-default-features
@@ -246,7 +242,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: true
-    - run: rustup update stable && rustup default stable
+    - uses: bytecodealliance/wasmtime/.github/actions/install-rust@v20.0.0
     - run: rustc ci/publish.rs
     # Make sure the tree is publish-able as-is
     - run: ./publish verify
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,6 +11,7 @@ keywords = ["webassembly", "wasm"]
 repository = "https://github.com/bytecodealliance/wasm-tools"
 readme = "README.md"
 exclude = ['tests/wabt', 'tests/testsuite', 'tests/snapshots', 'ci']
+rust-version.workspace = true
 
 [lints]
 workspace = true
@@ -34,6 +35,9 @@ all = "allow"
 [workspace.package]
 edition = '2021'
 version = "0.207.0"
+# Current policy for wasm-tools is the same as Wasmtime which is that this
+# number can be no larger than the current stable release of Rust minus 2.
+rust-version = "1.76.0"
 
 [workspace.dependencies]
 anyhow = "1.0.58"
diff --git a/crates/c-api/Cargo.toml b/crates/c-api/Cargo.toml
@@ -8,6 +8,7 @@ license = "Apache-2.0 WITH LLVM-exception"
 readme = "./README.md"
 repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/c-api"
 publish = false
+rust-version.workspace = true
 
 [lib]
 name = "wasmtools"
diff --git a/crates/fuzz-stats/Cargo.toml b/crates/fuzz-stats/Cargo.toml
@@ -2,6 +2,7 @@
 name = "fuzz-stats"
 edition.workspace = true
 publish = false
+rust-version.workspace = true
 
 [dependencies]
 anyhow = { workspace = true }
diff --git a/crates/wasm-compose/Cargo.toml b/crates/wasm-compose/Cargo.toml
@@ -9,6 +9,7 @@ repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wa
 homepage = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wasm-compose"
 documentation = "https://docs.rs/wasm-compose"
 description = "A library for composing WebAssembly components."
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-compose/example/middleware/Cargo.toml b/crates/wasm-compose/example/middleware/Cargo.toml
@@ -3,6 +3,7 @@ name = "middleware"
 version = "0.1.0"
 edition = "2021"
 publish = false
+rust-version.workspace = true
 
 [dependencies]
 flate2 = "1.0.24"
diff --git a/crates/wasm-compose/example/server/Cargo.toml b/crates/wasm-compose/example/server/Cargo.toml
@@ -3,6 +3,7 @@ name = "host"
 version = "0.1.0"
 edition = "2021"
 publish = false
+rust-version.workspace = true
 
 [dependencies]
 async-std = { version = "1.12.0", features = ["attributes"] }
diff --git a/crates/wasm-compose/example/service/Cargo.toml b/crates/wasm-compose/example/service/Cargo.toml
@@ -3,6 +3,7 @@ name = "svc"
 version = "0.1.0"
 edition = "2021"
 publish = false
+rust-version.workspace = true
 
 [dependencies]
 cargo-component-bindings = "0.6.0"
diff --git a/crates/wasm-encoder/Cargo.toml b/crates/wasm-encoder/Cargo.toml
@@ -11,6 +11,7 @@ documentation = "https://docs.rs/wasm-encoder"
 description = """
 A low-level WebAssembly encoder.
 """
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-metadata/Cargo.toml b/crates/wasm-metadata/Cargo.toml
@@ -5,6 +5,7 @@ edition.workspace = true
 license = "Apache-2.0 WITH LLVM-exception"
 repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wasm-metadata"
 description = "Read and manipulate WebAssembly metadata"
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-mutate-stats/Cargo.toml b/crates/wasm-mutate-stats/Cargo.toml
@@ -2,6 +2,7 @@
 name = "wasm-mutate-stats"
 edition.workspace = true
 publish = false
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-mutate/Cargo.toml b/crates/wasm-mutate/Cargo.toml
@@ -5,6 +5,7 @@ edition.workspace = true
 license = "Apache-2.0 WITH LLVM-exception"
 repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wasm-mutate"
 description = "A WebAssembly test case mutator"
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-shrink/Cargo.toml b/crates/wasm-shrink/Cargo.toml
@@ -9,6 +9,7 @@ readme = "./README.md"
 repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wasm-shrink"
 name = "wasm-shrink"
 version.workspace = true
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wasm-smith/Cargo.toml b/crates/wasm-smith/Cargo.toml
@@ -10,6 +10,7 @@ readme = "./README.md"
 repository = "https://github.com/bytecodealliance/wasm-tools/tree/main/crates/wasm-smith"
 version.workspace = true
 exclude = ["/benches/corpus"]
+rust-version.workspace = true
 
 [[bench]]
 name = "corpus"
diff --git a/crates/wasmparser/Cargo.toml b/crates/wasmparser/Cargo.toml
@@ -11,6 +11,7 @@ A simple event-driven library for parsing WebAssembly binary files.
 """
 edition.workspace = true
 exclude = ["benches/*.wasm"]
+rust-version.workspace = true
 
 [lints]
 workspace = true
@@ -46,7 +47,7 @@ default = ['std', 'validate']
 std = ['indexmap/std']
 
 # Tells the wasmparser crate to avoid using hash based maps and sets.
-# 
+#
 # Some embedded environments cannot provide a random source which is required
 # to properly initialize hashmap based data structures for resilience against
 # malious actors that control their inputs.
diff --git a/crates/wasmparser/src/collections/index_map/tests.rs b/crates/wasmparser/src/collections/index_map/tests.rs
@@ -75,11 +75,11 @@ fn extend_works() {
     for (index, (key, value)) in values.into_iter().enumerate() {
         assert_get(&mut map, key, (index, value));
     }
-    assert!(map.iter().eq(values.each_ref().map(|(k, v)| (k, v))));
-    assert!(map.iter_mut().eq(values.each_mut().map(|(k, v)| (&*k, v))));
-    assert!(map.keys().eq(values.each_ref().map(|(k, _v)| k)));
-    assert!(map.values().eq(values.each_ref().map(|(_k, v)| v)));
-    assert!(map.values_mut().eq(values.each_mut().map(|(_k, v)| v)));
+    assert!(map.iter().eq(values.iter().map(|(k, v)| (k, v))));
+    assert!(map.iter_mut().eq(values.iter_mut().map(|(k, v)| (&*k, v))));
+    assert!(map.keys().eq(values.iter().map(|(k, _v)| k)));
+    assert!(map.values().eq(values.iter().map(|(_k, v)| v)));
+    assert!(map.values_mut().eq(values.iter_mut().map(|(_k, v)| v)));
     assert!(map.into_iter().eq(values));
 }
 
diff --git a/crates/wasmprinter/Cargo.toml b/crates/wasmprinter/Cargo.toml
@@ -11,6 +11,7 @@ documentation = "https://docs.rs/wasmprinter"
 description = """
 Rust converter from the WebAssembly binary format to the text format.
 """
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wast/Cargo.toml b/crates/wast/Cargo.toml
@@ -11,6 +11,7 @@ documentation = "https://docs.rs/wast"
 description = """
 Customizable Rust parsers for the WebAssembly Text formats WAT and WAST
 """
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wast/src/lib.rs b/crates/wast/src/lib.rs
@@ -347,12 +347,16 @@ pub mod lexer;
 pub mod parser;
 pub mod token;
 
+#[cfg(feature = "wasm-module")]
 mod encode;
 mod error;
+#[cfg(feature = "wasm-module")]
 mod gensym;
+#[cfg(feature = "wasm-module")]
 mod names;
 pub use self::error::*;
 
+#[cfg(feature = "wasm-module")]
 macro_rules! id {
     ($($t:tt)*) => ($($t)*)
 }
diff --git a/crates/wast/src/parser.rs b/crates/wast/src/parser.rs
@@ -82,6 +82,7 @@ use std::usize;
 /// modules/components which be far trickier. For now we just say that when
 /// the parser goes too deep we return an error saying there's too many
 /// nested items. It would be great to not return an error here, though!
+#[cfg(feature = "wasm-module")]
 pub(crate) const MAX_PARENS_DEPTH: usize = 100;
 
 /// A top-level convenience parsing function that parses a `T` from `buf` and
@@ -483,6 +484,7 @@ impl<'a> Parser<'a> {
         }
     }
 
+    #[cfg(feature = "wasm-module")]
     pub(crate) fn has_meaningful_tokens(self) -> bool {
         self.buf.lexer.iter(0).any(|t| match t {
             Ok(token) => !matches!(
@@ -759,6 +761,7 @@ impl<'a> Parser<'a> {
     }
 
     /// Checks that the parser parens depth hasn't exceeded the maximum depth.
+    #[cfg(feature = "wasm-module")]
     pub(crate) fn depth_check(&self) -> Result<()> {
         if self.parens_depth() > MAX_PARENS_DEPTH {
             Err(self.error("item nesting too deep"))
diff --git a/crates/wast/src/token.rs b/crates/wast/src/token.rs
@@ -75,6 +75,7 @@ impl<'a> Id<'a> {
         }
     }
 
+    #[cfg(feature = "wasm-module")]
     pub(crate) fn gensym(span: Span, gen: u32) -> Id<'a> {
         Id {
             name: "gensym",
@@ -95,6 +96,7 @@ impl<'a> Id<'a> {
         self.span
     }
 
+    #[cfg(feature = "wasm-module")]
     pub(crate) fn is_gensym(&self) -> bool {
         self.gen != 0
     }
@@ -180,6 +182,7 @@ impl Index<'_> {
         }
     }
 
+    #[cfg(feature = "wasm-module")]
     pub(crate) fn is_resolved(&self) -> bool {
         matches!(self, Index::Num(..))
     }
diff --git a/crates/wat/Cargo.toml b/crates/wat/Cargo.toml
@@ -11,6 +11,7 @@ documentation = "https://docs.rs/wat"
 description = """
 Rust parser for the WebAssembly Text format, WAT
 """
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wit-component/Cargo.toml b/crates/wit-component/Cargo.toml
@@ -11,6 +11,7 @@ documentation = "https://docs.rs/wit-component"
 description = """
 Tooling for working with `*.wit` and component files together.
 """
+rust-version.workspace = true
 
 [lints]
 workspace = true
diff --git a/crates/wit-component/dl/Cargo.toml b/crates/wit-component/dl/Cargo.toml
diff --git a/crates/wit-parser/Cargo.toml b/crates/wit-parser/Cargo.toml
diff --git a/crates/wit-parser/fuzz/Cargo.toml b/crates/wit-parser/fuzz/Cargo.toml
diff --git a/crates/wit-smith/Cargo.toml b/crates/wit-smith/Cargo.toml
diff --git a/fuzz/Cargo.toml b/fuzz/Cargo.toml
diff --git a/src/bin/wasm-tools/main.rs b/src/bin/wasm-tools/main.rs
