move WASI skip list from workflow into test annotations

Author: DePasqualeOrg

.github/workflows/wasi.yml

@@ -41,10 +41,14 @@ jobs:
         UTILS=$(./util/show-utils.sh | tr ' ' '\n' | grep -vE "^($EXCLUDE)$" | sed 's/^/-p uu_/' | tr '\n' ' ')
         cargo test --target wasm32-wasip1 --no-default-features $UTILS
     - name: Run integration tests via wasmtime
+      env:
+        RUSTFLAGS: --cfg wasi_runner
       run: |
         # Build the WASI binary
         cargo build --target wasm32-wasip1 --no-default-features --features feat_wasm
         # Run host-compiled integration tests against the WASI binary.
+        # Tests incompatible with WASI are annotated with
+        # #[cfg_attr(wasi_runner, ignore)] in the test source files.
         # TODO: add integration tests for these tools as WASI support is extended:
         #   arch b2sum cat cksum cp csplit date dir dircolors fmt join ln
         #   ls md5sum mkdir mv nproc pathchk pr printenv ptx pwd readlink
@@ -60,66 +64,4 @@ jobs:
           test_head:: test_link:: test_nl:: test_numfmt:: \
           test_od:: test_paste:: test_printf:: test_shuf:: test_sum:: \
           test_tee:: test_tr:: test_true:: test_truncate:: \
-          test_unexpand:: test_unlink:: test_wc:: \
-          \
-          `# WASI sandbox: host paths (/proc, /sys, /dev) not visible in guest` \
-          --skip test_factor::test_parallel \
-          --skip test_cut::test_too_large \
-          --skip test_read_backwards_bytes_proc_fs_version \
-          --skip test_read_backwards_bytes_proc_fs_modules \
-          --skip test_read_backwards_lines_proc_fs_modules \
-          --skip test_read_backwards_bytes_sys_kernel_profiling \
-          --skip test_files_from_pseudo_filesystem \
-          --skip test_files0_stops_after_stdout_write_error \
-          --skip test_dev_zero_write_error_dev_full \
-          --skip test_dev_zero_closed_pipe \
-          --skip test_simd_respects_glibc_tunables \
-          --skip test_comm::test_comm_anonymous_pipes \
-          --skip test_comm::test_read_error \
-          --skip test_base64::test_read_error \
-          --skip test_expand::test_read_error \
-          --skip test_unexpand::test_read_error \
-          --skip test_od::test_skip_bytes_proc_file_without_seeking \
-          --skip test_shuf::write_errors_are_reported \
-          --skip test_tee::linux_only \
-          --skip test_tee::test_readonly \
-          \
-          `# WASI spec: argv/filenames must be valid UTF-8` \
-          --skip test_invalid_utf8_args \
-          --skip test_dirname_non_utf8_paths \
-          --skip test_trailing_dot_non_utf8 \
-          --skip test_8bit_non_utf8_delimiter \
-          --skip test_non_utf8_delimiter \
-          --skip test_echo_invalid_unicode_in_arguments \
-          --skip mb_invalid_unicode \
-          --skip non_utf_8_input \
-          --skip non_utf_8 \
-          --skip test_octal_escape_ambiguous_followed_by_non_utf8 \
-          --skip test_truncate_non_utf8_set \
-          --skip test_output_lossy_utf8 \
-          --skip non_utf8_paths \
-          --skip non_utf8_filename \
-          --skip non_utf8_name \
-          --skip test_invalid_unicode_in_filename \
-          --skip test_one_byte_section_delimiter \
-          --skip test_section_delimiter_non_utf8 \
-          --skip test_number_separator_non_utf8 \
-          \
-          `# WASI: no FIFO/mkfifo support` \
-          --skip test_fifo_error_reference_file_only \
-          --skip test_fifo_error_reference_and_size \
-          --skip test_fifo_error_size_only \
-          \
-          `# WASI: no pipe/signal support` \
-          --skip test_broken_pipe_no_error \
-          --skip test_tee_output_not_buffered \
-          \
-          `# WASI: no subprocess spawning (test shells out or invokes another binary)` \
-          --skip test_all_but_last_bytes_large_file_piped \
-          --skip test_all_but_last_lines_large_file \
-          --skip test_cmd_result_stderr_check_and_stderr_str_check \
-          \
-          `# WASI: stdin file position not preserved through wasmtime` \
-          --skip test_od::test_read_bytes \
-          --skip test_validate_stdin_offset_lines \
-          --skip test_validate_stdin_offset_bytes
+          test_unexpand:: test_unlink:: test_wc::

Cargo.toml

@@ -718,6 +718,7 @@ workspace = true
 unexpected_cfgs = { level = "warn", check-cfg = [
   'cfg(fuzzing)',
   'cfg(target_os, values("cygwin"))',
+  'cfg(wasi_runner)',
 ] }
 unused_qualifications = "warn"
 

docs/src/wasi-test-gaps.md

@@ -0,0 +1,33 @@
+# WASI integration test gaps
+
+Tests annotated with `#[cfg_attr(wasi_runner, ignore = "...")]` are skipped when running integration tests against a WASI binary via wasmtime. This document tracks the reasons so that gaps in WASI support are visible in one place.
+
+To find all annotated tests: `grep -rn 'wasi_runner, ignore' tests/`
+
+## Tools not yet covered by integration tests
+
+arch, b2sum, cat, cksum, cp, csplit, date, dir, dircolors, fmt, join, ln, ls, md5sum, mkdir, mv, nproc, pathchk, pr, printenv, ptx, pwd, readlink, realpath, rm, rmdir, seq, sha1sum, sha224sum, sha256sum, sha384sum, sha512sum, shred, sleep, sort, split, tail, touch, tsort, uname, uniq, vdir, yes
+
+## WASI sandbox: host paths not visible
+
+The WASI guest only sees directories explicitly mapped with `--dir`. Host paths like `/proc`, `/sys`, and `/dev` are not accessible. Affected tests include those that read `/proc/version`, `/proc/modules`, `/proc/cpuinfo`, `/proc/self/mem`, `/sys/kernel/profiling`, `/dev/null`, `/dev/zero`, `/dev/full`, and tests that rely on anonymous pipes or Linux-specific I/O error paths.
+
+## WASI: argv/filenames must be valid UTF-8
+
+The WASI specification requires that argv entries and filenames are valid UTF-8. Tests that pass non-UTF-8 bytes as arguments or create files with non-UTF-8 names cannot run under WASI.
+
+## WASI: no FIFO/mkfifo support
+
+WASI does not support creating or opening FIFOs (named pipes). Tests that use `mkfifo` are skipped.
+
+## WASI: no pipe/signal support
+
+WASI does not support Unix signals or pipe creation. Tests that rely on `SIGPIPE`, broken pipe detection, or pipe-based I/O are skipped.
+
+## WASI: no subprocess spawning
+
+WASI does not support spawning child processes. Tests that shell out to other commands or invoke a second binary are skipped.
+
+## WASI: stdin file position not preserved through wasmtime
+
+When stdin is a seekable file, wasmtime does not preserve the file position between the host and guest. Tests that validate stdin offset behavior after `head` reads are skipped.

tests/by-util/test_base64.rs

@@ -20,6 +20,7 @@ fn test_version() {
 
 #[test]
 #[cfg(target_os = "linux")]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_base64_non_utf8_paths() {
     use std::os::unix::ffi::OsStringExt;
     let (at, mut ucmd) = at_and_ucmd!();
@@ -277,6 +278,7 @@ cyBvdmVyIHRoZSBsYXp5IGRvZy4=
 
 #[test]
 #[cfg(all(target_os = "linux", not(target_env = "musl")))]
+#[cfg_attr(wasi_runner, ignore = "WASI sandbox: host paths not visible")]
 fn test_read_error() {
     new_ucmd!()
         .arg("/proc/self/mem")

tests/by-util/test_basename.rs

@@ -138,6 +138,7 @@ fn test_too_many_args_output() {
 
 #[cfg(any(unix, target_os = "redox"))]
 #[test]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_invalid_utf8_args() {
     let param = uucore::os_str_from_bytes(b"/tmp/some-\xc0-file.k\xf3")
         .expect("Only unix platforms can test non-unicode names");

tests/by-util/test_basenc.rs

@@ -396,6 +396,7 @@ fn test_file() {
 
 #[test]
 #[cfg(target_os = "linux")]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_file_with_non_utf8_name() {
     use std::os::unix::ffi::OsStringExt;
     let (at, mut ucmd) = at_and_ucmd!();

tests/by-util/test_comm.rs

@@ -658,6 +658,7 @@ fn test_comm_eintr_handling() {
 }
 
 #[test]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_output_lossy_utf8() {
     let scene = TestScenario::new(util_name!());
     let at = &scene.fixtures;
@@ -683,6 +684,7 @@ fn test_output_lossy_utf8() {
 
 #[test]
 #[cfg(any(target_os = "linux", target_os = "android"))]
+#[cfg_attr(wasi_runner, ignore = "WASI sandbox: host paths not visible")]
 fn test_comm_anonymous_pipes() {
     use std::{io::Write, os::fd::AsRawFd, process};
     use uucore::pipes::pipe;
@@ -722,6 +724,7 @@ fn test_comm_anonymous_pipes() {
 
 #[test]
 #[cfg(all(target_os = "linux", not(target_env = "musl")))]
+#[cfg_attr(wasi_runner, ignore = "WASI sandbox: host paths not visible")]
 fn test_read_error() {
     new_ucmd!()
         .arg("/proc/self/mem")

tests/by-util/test_cut.rs

@@ -137,6 +137,7 @@ fn test_delimiter_with_byte_and_char() {
 }
 
 #[test]
+#[cfg_attr(wasi_runner, ignore = "WASI sandbox: host paths not visible")]
 fn test_too_large() {
     new_ucmd!()
         .args(&["-b1-18446744073709551615", "/dev/null"])
@@ -569,6 +570,7 @@ fn test_multiple_mode_args() {
 
 #[test]
 #[cfg(unix)]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_8bit_non_utf8_delimiter() {
     use std::ffi::OsStr;
     use std::os::unix::ffi::OsStrExt;
@@ -635,6 +637,7 @@ fn test_failed_write_is_reported() {
 
 #[test]
 #[cfg(target_os = "linux")]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_cut_non_utf8_paths() {
     use std::fs::File;
     use std::io::Write;

tests/by-util/test_dirname.rs

@@ -72,6 +72,7 @@ fn test_empty() {
 
 #[test]
 #[cfg(unix)]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_dirname_non_utf8_paths() {
     use std::ffi::OsStr;
     use std::os::unix::ffi::OsStrExt;
@@ -177,6 +178,7 @@ fn test_trailing_dot_emoji() {
 
 #[test]
 #[cfg(unix)]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn test_trailing_dot_non_utf8() {
     use std::ffi::OsStr;
     use std::os::unix::ffi::OsStrExt;

tests/by-util/test_echo.rs

@@ -586,6 +586,7 @@ fn multibyte_escape_unicode() {
 }
 
 #[test]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn non_utf_8_hex_round_trip() {
     new_ucmd!()
         .args(&["-e", r"\xFF"])
@@ -610,6 +611,7 @@ fn nine_bit_octal() {
 
 #[test]
 #[cfg(target_family = "unix")]
+#[cfg_attr(wasi_runner, ignore = "WASI: argv/filenames must be valid UTF-8")]
 fn non_utf_8() {
     use std::ffi::OsStr;
     use std::os::unix::ffi::OsStrExt;
@@ -664,6 +666,7 @@ fn test_cmd_result_stdout_check_and_stdout_str_check() {
 }
 
 #[test]
+#[cfg_attr(wasi_runner, ignore = "WASI: no subprocess spawning")]
 fn test_cmd_result_stderr_check_and_stderr_str_check() {
     let ts = TestScenario::new("echo");