test: fix test failures on Windows

.github/workflows/bot.yml

@@ -0,0 +1,97 @@
+on:
+  issue_comment:
+    types: [created]
+
+name: Bot
+
+jobs:
+  pr_pre_comment:
+    # This job only runs for pull request comments
+    name: Comment before taking snapshots
+    if: ${{ github.event.issue.pull_request && github.event.comment.body == '/snapshot' }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/github-script@v6
+      with:
+        script: |
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: "Start taking snapshots for this pull request.\n" +
+                  `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`
+          });
+  pr_snapshot:
+    # This job only runs for pull request comments
+    name: Generate a snapshot
+    needs: [pr_pre_comment]
+    if: ${{ github.event.issue.pull_request && github.event.comment.body == '/snapshot' }}
+    strategy:
+      # Do not run in parallel because we may create a new commit
+      max-parallel: 1
+      matrix:
+        name: [windows, linux]
+        include:
+        - name: windows
+          os: windows-2022
+        - name: linux
+          os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    env:
+      # Set TRYCMD=overwrite to update snapshot
+      TRYCMD: overwrite
+    steps:
+    - uses: actions/github-script@v6
+      id: target-branch
+      with:
+        result-encoding: string
+        script: |
+          const pull_request = await github.rest.pulls.get({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            pull_number: context.issue.number
+          });
+          return pull_request.data.head.ref;
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ steps.target-branch.outputs.result }}
+    - uses: actions-rs/toolchain@v1
+      with:
+        components: rustfmt, clippy
+      # Pinned to the commit hash of v2.2.1
+    - uses: Swatinem/rust-cache@6fd3edff6979b79f87531400ad694fb7f2c84b1f
+      with:
+        shared-key: pr-snapshot-commented-${{ matrix.name }}
+    - uses: actions-rs/cargo@v1
+        # Generate new snapshots
+      with:
+        command: test
+        args: cli_tests
+    - if: matrix.name == 'linux'
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git commit -am "test: update snapshot for ${{ matrix.name }}" || true
+        git push || true
+    - if: matrix.name == 'windows'
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git commit -am "test: update snapshot for ${{ matrix.name }}"
+        git push
+  pr_post_comment:
+    # This job only runs for pull request comments
+    name: Comment after taking snapshots
+    needs: [pr_snapshot]
+    if: ${{ github.event.issue.pull_request && github.event.comment.body == '/snapshot' }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/github-script@v6
+      with:
+        script: |
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: 'Taking snapshots has been completed.'
+          });

.github/workflows/build_binaries_on_new_releases.yml

@@ -27,7 +27,7 @@ jobs:
           os: macos-latest
           target: x86_64-apple-darwin
         - name: windows
-          os: windows-2019
+          os: windows-2022
           target: x86_64-pc-windows-msvc
 
     steps:
@@ -47,7 +47,7 @@ jobs:
     - name: Archive the binary for publishing on release assets
       shell: bash
       run: |
-        if [ "${{ matrix.os }}" = "windows-2019" ]; then
+        if [ "${{ matrix.os }}" = "windows-2022" ]; then
           7z a -tzip dynein-${{ matrix.name }}.zip ./target/release/dy.exe
         else
           tar -C ./target/release/ -cvzf dynein-${{ matrix.name }}.tar.gz dy

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ name: CI
 
 jobs:
   build_and_test:
-    name: Rust project
+    name: Test and build on Linux
     runs-on: ubuntu-latest
     env:
       RUST_LOG: debug # Output debug log
@@ -50,3 +50,31 @@ jobs:
       with:
         command: build
         args: --release --all-features
+  build_and_test_on_windows:
+    name: Test and build on Windows
+    runs-on: windows-2022
+    env:
+      RUST_LOG: debug # Output debug log
+      RUST_BACKTRACE: 1 # Dump backtrace on panic
+      DYNEIN_TEST_NO_DOCKER_SETUP: true
+      # define AWS credentials in environment for test
+      AWS_ACCESS_KEY_ID: test
+      AWS_SECRET_ACCESS_KEY: test
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions-rs/toolchain@v1
+      with:
+        components: rustfmt, clippy
+        # Pinned to the commit hash of v2.2.1
+    - uses: Swatinem/rust-cache@6fd3edff6979b79f87531400ad694fb7f2c84b1f
+      with:
+        shared-key: build-and-test-on-windows
+    - uses: actions-rs/cargo@v1
+      with:
+          # Currently, we only conduct snapshot tests because GitHub Actions does not support containers in Windows.
+        command: test
+        args: cli_tests
+    - uses: actions-rs/cargo@v1
+      with:
+        command: build
+        args: --release --all-features

README.md

@@ -1223,10 +1223,24 @@ pre-commit install
 We use [trycmd](https://crates.io/crates/trycmd) to conduct snapshot testing for CLI.
 If the snapshot is needed to be updated, run command;
 
+MacOS and Linux
 ```shell
 TRYCMD=overwrite cargo test --test cli_tests
 ```
 
+Windows (PowerShell)
+```powershell
+$Env:TRYCMD='overwrite'
+cargo test --test cli_tests
+[Environment]::SetEnvironmentVariable('TRYCMD',$null)
+```
+
+Please note that we use different snapshots for the Windows environment.
+
+### Bot
+If you want to update snapshots of commands, you can use bot command `/snapshot` in your pull request.
+Please note that you must type exactly as written.
+
 ## Asides
 
 dynein is named after [a motor protein](https://en.wikipedia.org/wiki/Dynein).

tests/cli_tests.rs

@@ -18,5 +18,9 @@ use trycmd;
 
 #[test]
 fn cli_tests() {
-    trycmd::TestCases::new().case("tests/cmd/*.md");
+    if cfg!(windows) {
+        trycmd::TestCases::new().case("tests/cmd_windows/*.md");
+    } else {
+        trycmd::TestCases::new().case("tests/cmd/*.md");
+    }
 }