Merge pull request #491 from Nukesor/replace-outdated-actions

Nukesor · web-flow · commit c088e9acd414 · 2024-01-27T22:45:16.000+01:00
ci: Replace actions-rs actions
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -40,12 +40,10 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          override: true
           components: llvm-tools-preview
-          target: ${{ matrix.target }}
+          targets: ${{ matrix.target }}
 
       - uses: actions/cache@v3
         with:
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -56,12 +56,10 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          override: true
-          components: rustfmt, clippy
-          target: ${{ matrix.target }}
+          components: llvm-tools-preview
+          targets: ${{ matrix.target }}
 
       - uses: actions/cache@v3
         with:
@@ -77,13 +75,7 @@ jobs:
             ${{ runner.os }}-cargo-${{ matrix.target }}-
 
       - name: cargo fmt
-        uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
+        run : cargo fmt --all -- --check
 
       - name: cargo clippy
-        uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: --tests --workspace -- -D warnings
+        run: cargo clippy --tests --workspace -- -D warnings
diff --git a/.github/workflows/package-binary.yml b/.github/workflows/package-binary.yml
@@ -83,18 +83,17 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Setup Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          target: ${{ matrix.target }}
-          override: true
+          components: llvm-tools-preview
+          targets: ${{ matrix.target }}
 
       - name: cargo build
-        uses: actions-rs/cargo@v1
+        uses: houseabsolute/actions-rust-cross@v0
         with:
           command: build
-          args: --release --locked --target=${{ matrix.target }}
-          use-cross: ${{ matrix.cross }}
+          args: --release --locked
+          target: ${{ matrix.target }}
 
       - name: Compress client
         uses: svenstaro/upx-action@v2
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -39,49 +39,46 @@ jobs:
           - os: ubuntu-latest
             target: x86_64-unknown-linux-gnu
             cross: false
-            strip: true
           - os: ubuntu-latest
             target: aarch64-unknown-linux-musl
             cross: true
-            strip: false
           - os: ubuntu-latest
             target: armv7-unknown-linux-musleabihf
             cross: true
-            strip: false
           - os: ubuntu-latest
             target: arm-unknown-linux-musleabihf
             cross: true
-            strip: false
           - os: windows-latest
             target: x86_64-pc-windows-msvc
             cross: false
-            strip: true
           - os: macos-latest
             target: x86_64-apple-darwin
             cross: false
-            strip: true
           - os: macos-latest
             target: aarch64-apple-darwin
             cross: true
-            strip: true
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
       - name: Setup Rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable
-          override: true
           components: llvm-tools-preview
-          target: ${{ matrix.target }}
+          targets: ${{ matrix.target }}
 
       - name: Install cargo-nextest
         uses: taiki-e/install-action@v2
         with:
           tool: nextest
 
+      - name: Install cargo-cross
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cross
+        if: ${{ matrix.cross }}
+
       - uses: actions/cache@v3
         with:
           path: |
@@ -94,24 +91,37 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-cargo-${{ matrix.target }}-
 
+      # ----- Non-Cross path
       - name: cargo build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --target=${{ matrix.target }}
-          use-cross: ${{ matrix.cross }}
+        run: cargo build --target=${{ matrix.target }}
+        if: ${{ !matrix.cross }}
 
       - name: cargo test
-        uses: actions-rs/cargo@v1
-        if: ${{ !matrix.cross }}
+        run: cargo nextest run --workspace --target=${{ matrix.target }}
         env:
           NEXTEST_PROFILE: ci # defined in .config/nextest.toml
-        with:
-          command: nextest
-          args: run --workspace --target=${{ matrix.target }}
-          use-cross: ${{ matrix.cross }}
+        if: ${{ !matrix.cross }}
+
+      # ----- Cross path
+      #- name: Install qemu
+      #  run: apt-get install --assume-yes binfmt-support qemu-user-static qemu-user
+      #  if: ${{ matrix.cross }}
+
+      - name: cargo build
+        run: cross build --target=${{ matrix.target }}
+        if: ${{ matrix.cross }}
+
+      # We don't do automated testing for cross builds yet.
+      # - They don't work in the CI. I have yet to figure out why things aren't set up properly.
+      # - The tests run way to slow and all kinds of race conditions are triggered.
+      #   Until we find a way to run time related tests in an ultra slow environment, this needs to be postponed.
+      #- name: cargo test
+      #  run: cross test run --workspace --target=${{ matrix.target }}
+      #  env:
+      #    NEXTEST_PROFILE: ci # defined in .config/nextest.toml
+      #  if: ${{ matrix.cross }}
 
-      # The test result artifacts are used by the test-report.yaml workflow.
+      # ----- Test result artifacts are used by the test-report.yaml workflow.
       - name: upload test results
         uses: actions/upload-artifact@v3
         if: ${{ !matrix.cross }}
diff --git a/Cross.toml b/Cross.toml
@@ -0,0 +1,36 @@
+[target.x86_64-unknown-linux-musl]
+image = "ghcr.io/cross-rs/x86_64-unknown-linux-musl:main"
+pre-build = [
+    """
+    dpkg --add-architecture amd64 && \
+    apt-get update && \
+    apt-get install --assume-yes lld clang
+    """
+]
+
+[target.aarch64-unknown-linux-musl]
+image = "ghcr.io/cross-rs/aarch64-unknown-linux-musl:main"
+pre-build = [
+    """
+    apt-get update && \
+    apt-get install --assume-yes lld clang
+    """
+]
+
+[target.armv7-unknown-linux-musleabihf]
+image = "ghcr.io/cross-rs/armv7-unknown-linux-musleabihf:main"
+pre-build = [
+    """
+    apt-get update && \
+    apt-get install --assume-yes lld clang
+    """
+]
+
+[target.arm-unknown-linux-musleabihf]
+image = "ghcr.io/cross-rs/arm-unknown-linux-musleabihf:main"
+pre-build = [
+    """
+    apt-get update && \
+    apt-get install --assume-yes lld clang
+    """
+]
diff --git a/docs/Architecture.md b/docs/Architecture.md
diff --git a/docs/Cross.md b/docs/Cross.md
@@ -0,0 +1,13 @@
+# Cross compilation
+
+Compilation and testing for other architectures is rather easy with `cross`.
+
+1. Install `cargo-cross`.
+1. Make sure to install `qemu`.
+  - On Arch-Linux install `qemu-user-static-binfmt`.
+  - On Ubuntu install `binfmt-support` and `qemu-user-static`.
+
+Run the build/test against the target infrastructure, I.e.:
+
+- `cross build --target=aarch64-unknown-linux-musl`
+- `cross test --target=aarch64-unknown-linux-musl`
diff --git a/pueue/tests/client/integration/follow.rs b/pueue/tests/client/integration/follow.rs
@@ -2,7 +2,6 @@ use anyhow::{Context, Result};
 use rstest::rstest;
 
 use crate::client::helper::*;
-use pueue_lib::network::message::ResetMessage;
 
 pub fn set_read_local_logs(daemon: &mut PueueDaemon, read_local_logs: bool) -> Result<()> {
     // Force the client to read remote logs via config file.
@@ -102,44 +101,48 @@ async fn fail_on_non_existing(#[case] read_local_logs: bool) -> Result<()> {
     Ok(())
 }
 
-/// This test is ignored on apple, since it's super flaky. Somebody has to debug this.
-#[cfg(not(target = "x86_64-apple-darwin"))]
-mod non_apple {
-    use super::*;
-
-    /// Fail and print an error message when following a non-existing task disappears
-    #[rstest]
-    #[case(true)]
-    #[case(false)]
-    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
-    async fn fail_on_disappearing(#[case] read_local_logs: bool) -> Result<()> {
-        let mut daemon = daemon().await?;
-        set_read_local_logs(&mut daemon, read_local_logs)?;
-        let shared = &daemon.settings.shared;
-
-        // Add a task echoes something and waits for a while
-        assert_success(add_task(shared, "echo test && sleep 20").await?);
-        wait_for_task_condition(shared, 0, |task| task.is_running()).await?;
-
-        // Reset the daemon after 2 seconds. At this point, the client will already be following the
-        // output and should notice that the task went away..
-        // This is a bit hacky, but our client test helper always waits for the command to finish
-        // and I'm feeling too lazy to add a new helper function now.
-        let moved_shared = shared.clone();
-        tokio::task::spawn(async move {
-            sleep_ms(2000).await;
-            // Reset the daemon
-            send_message(&moved_shared, ResetMessage {})
-                .await
-                .expect("Failed to send Start tasks message");
-        });
-
-        // Execute `follow` and remove the task
-        // The client should exit with exit code `1`.
-        let output = run_client_command(shared, &["follow", "0"])?;
-
-        assert_snapshot_matches_stdout("follow__fail_on_disappearing", output.stdout)?;
-
-        Ok(())
-    }
-}
+// /// This test is commented for the time being.
+// /// There's a race condition that can happen from time to time.
+// /// It's especially reliably hit on MacOS for some reason.
+// ///
+// /// What happens is that the daemon resets in between reading the output of the file
+// /// and the check whether the task actually still exists in the daemon.
+// /// There's really no way to properly work around this.
+// /// So I'll keep this commented for the time being.
+// ///
+// ///
+// /// Fail and print an error message when following a non-existing task disappears
+// #[rstest]
+// #[case(true)]
+// #[case(false)]
+// #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+// async fn fail_on_disappearing(#[case] read_local_logs: bool) -> Result<()> {
+//     let mut daemon = daemon().await?;
+//     set_read_local_logs(&mut daemon, read_local_logs)?;
+//     let shared = &daemon.settings.shared;
+//
+//     // Add a task echoes something and waits for a while
+//     assert_success(add_task(shared, "echo test && sleep 20").await?);
+//     wait_for_task_condition(shared, 0, |task| task.is_running()).await?;
+//
+//     // Reset the daemon after 2 seconds. At this point, the client will already be following the
+//     // output and should notice that the task went away..
+//     // This is a bit hacky, but our client test helper always waits for the command to finish
+//     // and I'm feeling too lazy to add a new helper function now.
+//     let moved_shared = shared.clone();
+//     tokio::task::spawn(async move {
+//         sleep_ms(2000).await;
+//         // Reset the daemon
+//         send_message(&moved_shared, ResetMessage {})
+//             .await
+//             .expect("Failed to send Start tasks message");
+//     });
+//
+//     // Execute `follow` and remove the task
+//     // The client should exit with exit code `1`.
+//     let output = run_client_command(shared, &["follow", "0"])?;
+//
+//     assert_snapshot_matches_stdout("follow__fail_on_disappearing", output.stdout)?;
+//
+//     Ok(())
+// }
diff --git a/pueue/tests/helper/daemon.rs b/pueue/tests/helper/daemon.rs
@@ -23,13 +23,14 @@ pub async fn shutdown_daemon(shared: &Shared) -> Result<Message> {
 /// long.
 pub async fn get_pid(pid_path: &Path) -> Result<i32> {
     // Give the daemon about 1 sec to boot and create the pid file.
-    let tries = 20;
+    let sleep = 50;
+    let tries = TIMEOUT / sleep;
     let mut current_try = 0;
 
     while current_try < tries {
         // The daemon didn't create the pid file yet. Wait for 100ms and try again.
         if !pid_path.exists() {
-            sleep_ms(50).await;
+            sleep_ms(sleep).await;
             current_try += 1;
             continue;
         }
@@ -58,15 +59,16 @@ pub async fn get_pid(pid_path: &Path) -> Result<i32> {
 /// Waits for a daemon to shut down.
 pub async fn wait_for_shutdown(child: &mut Child) -> Result<()> {
     // Give the daemon about 1 sec to shutdown.
-    let tries = 40;
+    let sleep = 50;
+    let tries = TIMEOUT / sleep;
     let mut current_try = 0;
 
     while current_try < tries {
         // Try to read the process exit code. If this succeeds or
         // an error is returned, the process is gone.
         if let Ok(None) = child.try_wait() {
             // Process is still alive, wait a little longer
-            sleep_ms(50).await;
+            sleep_ms(sleep).await;
             current_try += 1;
             continue;
         }
diff --git a/pueue/tests/helper/fixtures.rs b/pueue/tests/helper/fixtures.rs
@@ -45,13 +45,14 @@ pub async fn daemon_with_settings(settings: Settings, tempdir: TempDir) -> Resul
     tokio::spawn(run_and_handle_error(path, true));
     let pid = get_pid(&settings.shared.pid_path()).await?;
 
-    let tries = 20;
+    let sleep = 50;
+    let tries = TIMEOUT / sleep;
     let mut current_try = 0;
 
     // Wait up to 1s for the unix socket to pop up.
     let socket_path = settings.shared.unix_socket_path();
     while current_try < tries {
-        sleep_ms(50).await;
+        sleep_ms(sleep).await;
         if socket_path.exists() {
             create_test_groups(&settings.shared).await?;
             return Ok(PueueDaemon {
@@ -100,13 +101,14 @@ pub async fn standalone_daemon(shared: &Shared) -> Result<Child> {
         .stderr(Stdio::piped())
         .spawn()?;
 
-    let tries = 20;
+    let sleep = 50;
+    let tries = TIMEOUT / sleep;
     let mut current_try = 0;
 
     // Wait up to 1s for the unix socket to pop up.
     let socket_path = shared.unix_socket_path();
     while current_try < tries {
-        sleep_ms(50).await;
+        sleep_ms(sleep).await;
         if socket_path.exists() {
             return Ok(child);
         }
diff --git a/pueue/tests/helper/mod.rs b/pueue/tests/helper/mod.rs
diff --git a/pueue/tests/helper/wait.rs b/pueue/tests/helper/wait.rs
