Run tests with Miri (#59)

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
-          components: "clippy,rustfmt"
+          components: "clippy,miri,rustfmt"
           toolchain: nightly
       - uses: actions-rs/cargo@v1
         with:
@@ -209,6 +209,11 @@ jobs:
           args: "--manifest-path=www/Cargo.toml"
           command: test
           toolchain: nightly
+      - uses: actions-rs/cargo@v1
+        with:
+          args: test --manifest-path=lib/Cargo.toml
+          command: miri
+          toolchain: nightly
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml"
@@ -320,57 +325,57 @@ jobs:
           toolchain: stable
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --no-default-features --features=alloc"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release --no-default-features --features=alloc"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --no-default-features"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release --no-default-features"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/internal/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/internal/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
   windows:
     runs-on: windows-latest
     steps:
@@ -503,54 +508,54 @@ jobs:
           toolchain: stable
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --no-default-features --features=alloc"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release --no-default-features --features=alloc"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --no-default-features"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/Cargo.toml --release --no-default-features"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/internal/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/internal/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/Cargo.toml"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"
       - uses: actions-rs/cargo@v1
         with:
           args: "--manifest-path=lib/macro/Cargo.toml --release"
           command: build
-          toolchain: "1.46"
+          toolchain: "1.47"

lib/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Changelog
 
+### Minor
+
+- Bump MSRV from 1.46 to 1.47
+
 ### Patch
 
+- Use TryInto for slice to array conversion
 - Update documentation with reference to attack vectors
 
 ## 2.3.3

lib/Cargo.toml

@@ -4,7 +4,7 @@ version = "2.3.3"
 authors = ["Julien Cretin <git@ia0.eu>"]
 license = "MIT"
 edition = "2018"
-rust-version = "1.46"
+rust-version = "1.47"
 keywords = ["no_std", "base64", "base32", "hex"]
 categories = ["encoding", "no-std"]
 readme = "README.md"

lib/macro/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.12"
 authors = ["Julien Cretin <cretin@google.com>"]
 license = "MIT"
 edition = "2018"
-rust-version = "1.46"
+rust-version = "1.47"
 keywords = ["no_std", "base64", "base32", "hex", "macro"]
 categories = ["encoding", "no-std"]
 readme = "README.md"

lib/macro/internal/Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.10"
 authors = ["Julien Cretin <cretin@google.com>"]
 license = "MIT"
 edition = "2018"
-rust-version = "1.46"
+rust-version = "1.47"
 description = "Internal library for data-encoding-macro"
 readme = "README.md"
 repository = "https://github.com/ia0/data-encoding"

lib/src/lib.rs

@@ -159,6 +159,7 @@ use alloc::string::String;
 use alloc::vec;
 #[cfg(feature = "alloc")]
 use alloc::vec::Vec;
+use core::convert::TryInto;
 
 macro_rules! check {
     ($e: expr, $c: expr) => {
@@ -251,11 +252,6 @@ unsafe fn chunk_mut_unchecked(x: &mut [u8], n: usize, i: usize) -> &mut [u8] {
     core::slice::from_raw_parts_mut(ptr, n)
 }
 
-unsafe fn as_array(x: &[u8]) -> &[u8; 256] {
-    debug_assert_eq!(x.len(), 256);
-    &*(x.as_ptr() as *const [u8; 256])
-}
-
 fn div_ceil(x: usize, m: usize) -> usize {
     (x + m - 1) / m
 }
@@ -1220,11 +1216,11 @@ impl Default for Specification {
 
 impl Encoding {
     fn sym(&self) -> &[u8; 256] {
-        unsafe { as_array(&self.0[0 .. 256]) }
+        self.0[0 .. 256].try_into().unwrap()
     }
 
     fn val(&self) -> &[u8; 256] {
-        unsafe { as_array(&self.0[256 .. 512]) }
+        self.0[256 .. 512].try_into().unwrap()
     }
 
     fn pad(&self) -> Option<u8> {

lib/tests/lib.rs

@@ -310,17 +310,16 @@ fn ignore() {
     let no_pad = spec.encoding().unwrap();
     spec.padding = Some('=');
     let padded = spec.encoding().unwrap();
-    if cfg!(debug_assertions) {
-        forall(&no_pad, b"0 ", 14);
-        forall(&no_pad, b"0 .", 9);
-        forall(&padded, b"0= ", 9);
-        forall(&padded, b"0= .", 7);
-    } else {
-        forall(&no_pad, b"0 ", 18);
-        forall(&no_pad, b"0 .", 11);
-        forall(&padded, b"0= ", 11);
-        forall(&padded, b"0= .", 9);
-    }
+    #[cfg(miri)]
+    const MAX: [usize; 4] = [4, 3, 3, 2];
+    #[cfg(all(not(miri), debug_assertions))]
+    const MAX: [usize; 4] = [14, 9, 9, 7];
+    #[cfg(all(not(miri), not(debug_assertions)))]
+    const MAX: [usize; 4] = [18, 11, 11, 9];
+    forall(&no_pad, b"0 ", MAX[0]);
+    forall(&no_pad, b"0 .", MAX[1]);
+    forall(&padded, b"0= ", MAX[2]);
+    forall(&padded, b"0= .", MAX[3]);
     assert_eq!(padded.decode(b"000=====").unwrap(), [0]);
     assert_eq!(padded.decode(b"000   =====").unwrap(), [0]);
     assert_eq!(padded.decode(b"000000==").unwrap(), [0, 0]);

nostd/Cargo.toml

@@ -5,7 +5,6 @@ authors = ["Julien Cretin <cretin@google.com>"]
 edition = "2021"
 license = "MIT"
 publish = false
-resolver = "2"
 
 [features]
 alloc = ["data-encoding/alloc"]

nostd/src/main.rs

@@ -1,6 +1,6 @@
-#![feature(lang_items, default_alloc_error_handler)]
 #![no_std]
 #![no_main]
+#![feature(lang_items)]
 
 use core::fmt::Write;
 

xtask/src/main.rs

@@ -32,7 +32,7 @@ enum Toolchain {
     #[strum(serialize = "stable")]
     Stable,
 
-    #[strum(serialize = "1.46")]
+    #[strum(serialize = "1.47")]
     Msrv,
 }
 
@@ -87,6 +87,9 @@ enum Task {
     #[strum(serialize = "test")]
     Test,
 
+    #[strum(serialize = "miri")]
+    Miri,
+
     #[strum(serialize = "bench")]
     Bench,
 
@@ -108,8 +111,9 @@ impl Action {
         let default_args: &[&str] = match (self.task, self.dir) {
             (Task::Format, _) => &["--", "--check"],
             (Task::Clippy, _) => &["--", "--deny=warnings"],
-            (Task::Audit, _) => &["--deny=warnings"],
             (Task::Build, Dir::Nostd) => &["--release"],
+            (Task::Miri, _) => &["test"],
+            (Task::Audit, _) => &["--deny=warnings"],
             _ => &[],
         };
         instructions += Instruction {
@@ -199,12 +203,14 @@ impl Instruction {
                 step.uses = Some("actions-rs/cargo@v1".to_owned());
                 step.with.insert("toolchain".to_owned(), toolchain.to_string());
                 step.with.insert("command".to_owned(), self.cmd.to_owned());
-                let mut args = format!("--manifest-path={dir}/Cargo.toml");
-                for arg in &self.args {
-                    args.push(' ');
-                    args.push_str(&shell_escape::escape(arg.into()));
+                let mut args: Vec<Cow<str>> =
+                    vec![format!("--manifest-path={dir}/Cargo.toml").into()];
+                args.extend(self.args.iter().map(|x| shell_escape::escape(x.into())));
+                if self.cmd == "miri" {
+                    // Miri expects the sub-command before the cargo options.
+                    args.rotate_left(1);
                 }
-                step.with.insert("args".to_owned(), args);
+                step.with.insert("args".to_owned(), args.join(" "));
             }
             Executor::Shell => {
                 let mut cmd = format!("cd {} && ", shell_escape::escape(dir.to_string().into()));
@@ -367,6 +373,7 @@ impl Flags {
                             .filter_map(|x| match x.task {
                                 Task::Format => Some("rustfmt"),
                                 Task::Clippy => Some("clippy"),
+                                Task::Miri => Some("miri"),
                                 _ => None,
                             })
                             .collect();
@@ -429,6 +436,10 @@ impl Actions {
                     // Clippy is currently broken on cmp and www.
                     continue;
                 }
+                if task == Task::Miri && !matches!(dir, Dir::Lib) {
+                    // Miri is slow, so only run where it matters.
+                    continue;
+                }
                 if task == Task::Bench && !matches!(dir, Dir::Lib | Dir::Bin) {
                     // Bench is only supported for lib and bin.
                     continue;