Merge pull request #4362 from tgross35/ctest-ci

Add `ctest` to the root workspace and enable CI

Author: tgross35

.github/workflows/ci.yaml

@@ -213,6 +213,23 @@ jobs:
             export PATH=$HOME/.rust_solaris/bin:$PATH
             ./ci/run.sh ${{ matrix.target }}
 
+  ctest_msrv:
+    name: Check MSRV
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    env:
+      RUSTFLAGS: # No need to check warnings on old MSRV, unset `-Dwarnings`
+    steps:
+    - uses: actions/checkout@master
+    - run: |
+        msrv="$(perl -ne 'print if s/rust-version\s*=\s*"(.*)"/\1/g' ctest/Cargo.toml)"
+        echo "MSRV: $msrv"
+        echo "MSRV=$msrv" >> "$GITHUB_ENV"
+    - name: Install Rust
+      run: rustup update "$MSRV" --no-self-update && rustup default "$MSRV"
+    - uses: Swatinem/rust-cache@v2
+    - run: cargo build -p ctest
+
   # One job that "summarizes" the success state of this pipeline. This can then be added to branch
   # protection, rather than having to add each job separately.
   success:
@@ -224,6 +241,7 @@ jobs:
       - test_tier2
       - test_tier2_vm
       - verify_build
+      - ctest_msrv
     # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
     # failed" as success. So we have to do some contortions to ensure the job fails if any of its
     # dependencies fails.

Cargo.toml

@@ -140,4 +140,8 @@ rustc-dep-of-std = ["rustc-std-workspace-core"]
 extra_traits = []
 
 [workspace]
-members = ["libc-test"]
+members = [
+    "ctest",
+    "ctest-test",
+    "libc-test",
+]

ci/docker/x86_64-unknown-linux-gnu/Dockerfile

@@ -2,7 +2,7 @@ FROM ubuntu:24.10
 
 RUN apt-get update
 RUN apt-get install -y --no-install-recommends \
-  gcc libc6-dev ca-certificates linux-headers-generic
+  gcc g++ libc6-dev ca-certificates linux-headers-generic
 
 RUN apt search linux-headers
 RUN ls /usr/src

ci/run.sh

@@ -93,6 +93,19 @@ case "$target" in
     *) cmd="$cmd --workspace"
 esac
 
+# garando_errors only compiles on `cfg(any(unix, windows))`
+case "$target" in
+    *wasm*) cmd="$cmd --exclude ctest --exclude ctest-test"
+esac
+
+# # FIXME(ctest): duplicate symbol errors for statics, e.g. T1_static_mut_u8, on Unix-
+# # like platforms.
+# cast "$(uname -s)" in
+#     *windows*msvc) ;;
+#     *apple*) ;;
+#     *) cmd="$cmd --exclude ctest-test" ;;
+# esca
+
 if [ "$target" = "s390x-unknown-linux-gnu" ]; then
     # FIXME: s390x-unknown-linux-gnu often fails to test due to timeout,
     # so we retry this N times.

ctest-test/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "testcrate"
+name = "ctest-test"
 version = "0.1.0"
 authors = ["Alex Crichton <[email protected]>"]
 build = "build.rs"
@@ -11,12 +11,8 @@ ctest = { path = "../ctest" }
 cc = "1.0"
 
 [dependencies]
-libc = "0.2"
-
-[lib]
-name = "testcrate"
-test = false
-doctest = false
+cfg-if = "1.0.0"
+libc = { path = ".." }
 
 [[bin]]
 name = "t1"

ctest-test/build.rs

@@ -1,3 +1,5 @@
+use std::process::Command;
+
 fn main() {
     use std::env;
     let opt_level = env::var("OPT_LEVEL")
@@ -48,34 +50,43 @@ fn main() {
         .skip_roundtrip(|_| true)
         .generate("src/t2.rs", "t2gen.rs");
 
-    ctest::TestGenerator::new()
-        .header("t1.h")
-        .language(ctest::Lang::CXX)
-        .include("src")
-        .fn_cname(|a, b| b.unwrap_or(a).to_string())
-        .type_name(move |ty, is_struct, is_union| match ty {
-            "T1Union" => ty.to_string(),
-            "Transparent" => ty.to_string(),
-            t if is_struct => format!("struct {}", t),
-            t if is_union => format!("union {}", t),
-            t => t.to_string(),
-        })
-        .volatile_item(t1_volatile)
-        .array_arg(t1_arrays)
-        .skip_roundtrip(|n| n == "Arr")
-        .generate("src/t1.rs", "t1gen_cxx.rs");
-    ctest::TestGenerator::new()
-        .header("t2.h")
-        .language(ctest::Lang::CXX)
-        .include("src")
-        .type_name(move |ty, is_struct, is_union| match ty {
-            "T2Union" => ty.to_string(),
-            t if is_struct => format!("struct {}", t),
-            t if is_union => format!("union {}", t),
-            t => t.to_string(),
-        })
-        .skip_roundtrip(|_| true)
-        .generate("src/t2.rs", "t2gen_cxx.rs");
+    println!("cargo::rustc-check-cfg=cfg(has_cxx)");
+    if !cfg!(unix) || Command::new("c++").arg("v").output().is_ok() {
+        // A C compiler is always available, but these are only run if a C++ compiler is
+        // also available.
+        println!("cargo::rustc-cfg=has_cxx");
+
+        ctest::TestGenerator::new()
+            .header("t1.h")
+            .language(ctest::Lang::CXX)
+            .include("src")
+            .fn_cname(|a, b| b.unwrap_or(a).to_string())
+            .type_name(move |ty, is_struct, is_union| match ty {
+                "T1Union" => ty.to_string(),
+                "Transparent" => ty.to_string(),
+                t if is_struct => format!("struct {}", t),
+                t if is_union => format!("union {}", t),
+                t => t.to_string(),
+            })
+            .volatile_item(t1_volatile)
+            .array_arg(t1_arrays)
+            .skip_roundtrip(|n| n == "Arr")
+            .generate("src/t1.rs", "t1gen_cxx.rs");
+        ctest::TestGenerator::new()
+            .header("t2.h")
+            .language(ctest::Lang::CXX)
+            .include("src")
+            .type_name(move |ty, is_struct, is_union| match ty {
+                "T2Union" => ty.to_string(),
+                t if is_struct => format!("struct {}", t),
+                t if is_union => format!("union {}", t),
+                t => t.to_string(),
+            })
+            .skip_roundtrip(|_| true)
+            .generate("src/t2.rs", "t2gen_cxx.rs");
+    } else {
+        println!("cargo::warning=skipping C++ tests");
+    }
 }
 
 fn t1_volatile(i: ctest::VolatileItemKind) -> bool {

ctest-test/src/bin/t1.rs

@@ -1,7 +1,7 @@
 #![cfg(not(test))]
 #![deny(warnings)]
 
+use ctest_test::t1::*;
 use libc::*;
-use testcrate::t1::*;
 
 include!(concat!(env!("OUT_DIR"), "/t1gen.rs"));

ctest-test/src/bin/t1_cxx.rs

@@ -1,7 +1,12 @@
 #![cfg(not(test))]
-#![deny(warnings)]
 
-use libc::*;
-use testcrate::t1::*;
+cfg_if::cfg_if! {
+    if #[cfg(has_cxx)] {
+        use ctest_test::t1::*;
+        use libc::*;
 
-include!(concat!(env!("OUT_DIR"), "/t1gen_cxx.rs"));
+        include!(concat!(env!("OUT_DIR"), "/t1gen_cxx.rs"));
+    } else {
+        fn main() {}
+    }
+}

ctest-test/src/bin/t2.rs

@@ -1,6 +1,6 @@
 #![cfg(not(test))]
 #![deny(warnings)]
 
-use testcrate::t2::*;
+use ctest_test::t2::*;
 
 include!(concat!(env!("OUT_DIR"), "/t2gen.rs"));

ctest-test/src/bin/t2_cxx.rs

@@ -1,6 +1,11 @@
 #![cfg(not(test))]
-#![deny(warnings)]
 
-use testcrate::t2::*;
+cfg_if::cfg_if! {
+    if #[cfg(has_cxx)] {
+        use ctest_test::t2::*;
 
-include!(concat!(env!("OUT_DIR"), "/t2gen_cxx.rs"));
+        include!(concat!(env!("OUT_DIR"), "/t2gen_cxx.rs"));
+    } else {
+        fn main() {}
+    }
+}