Make strip script strip all binaries under target

If there were both debug & release dirs it would only strip one binary, and if
the debug dir had no binary at all it would error, even if the release dir had
one.

.github/workflows/test.yml

@@ -14,153 +14,167 @@ jobs:
           - platform_name: FreeBSD-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-freebsd
-            expect_file: "x86-64.+FreeBSD"
             expect_cross: true
+            expect_file: "x86-64.+FreeBSD"
+            expect_stripped: false
             can_test: false
 
           - platform_name: Linux-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-linux-musl
-            expect_file: "ELF.+x86-64"
             expect_cross: false
+            expect_file: "ELF.+x86-64"
+            expect_stripped: true
             can_test: true
 
           - platform_name: Linux-aarch64
             os: ubuntu-20.04
             target: aarch64-unknown-linux-musl
-            expect_file: "aarch64"
             expect_cross: true
+            expect_file: "aarch64"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-arm
             os: ubuntu-20.04
             target: arm-unknown-linux-musleabi
-            expect_file: "32.+ARM"
             expect_cross: true
+            expect_file: "32.+ARM"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-i586
             os: ubuntu-20.04
             target: i586-unknown-linux-musl
-            expect_file: "ELF.+80386"
             expect_cross: false
+            expect_file: "ELF.+80386"
+            expect_stripped: true
             can_test: true
 
           - platform_name: Linux-mips
             os: ubuntu-20.04
             target: mips-unknown-linux-musl
-            expect_file: "MIPS32.+mips-"
             expect_cross: true
+            expect_file: "MIPS32.+mips-"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-mipsel
             os: ubuntu-20.04
             target: mipsel-unknown-linux-musl
-            expect_file: "MIPS32.+mipsel-"
             expect_cross: true
+            expect_file: "MIPS32.+mipsel-"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-mips64
             os: ubuntu-20.04
             target: mips64-unknown-linux-muslabi64
-            expect_file: "MIPS64"
             expect_cross: true
+            expect_file: "MIPS64"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-mips64el
             os: ubuntu-20.04
             target: mips64el-unknown-linux-muslabi64
-            expect_file: "MIPS64"
             expect_cross: true
+            expect_file: "MIPS64"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-powerpc
             os: ubuntu-20.04
             target: powerpc-unknown-linux-gnu
-            expect_file: "32.+PowerPC"
             expect_cross: true
+            expect_file: "32.+PowerPC"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-powerpc64
             os: ubuntu-20.04
             target: powerpc64-unknown-linux-gnu
-            expect_file: "64.+PowerPC"
             expect_cross: true
+            expect_file: "64.+PowerPC"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-powerpc64le
             os: ubuntu-20.04
             target: powerpc64le-unknown-linux-gnu
-            expect_file: "64.+PowerPC"
             expect_cross: true
+            expect_file: "64.+PowerPC"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-riscv64
             os: ubuntu-20.04
             target: riscv64gc-unknown-linux-gnu
-            expect_file: "64.+RISC-V"
             expect_cross: true
+            expect_file: "64.+RISC-V"
+            expect_stripped: false
             can_test: true
 
           - platform_name: Linux-s390x
             os: ubuntu-20.04
             target: s390x-unknown-linux-gnu
-            expect_file: "64.+S/390"
             expect_cross: true
+            expect_file: "64.+S/390"
+            expect_stripped: false
             can_test: true
 
           - platform_name: NetBSD-x86_64
             os: ubuntu-20.04
             target: x86_64-unknown-netbsd
-            expect_file: "x86-64.+NetBSD"
             expect_cross: true
+            expect_file: "x86-64.+NetBSD"
+            expect_stripped: false
             can_test: false
 
           - platform_name: Windows-aarch64
             os: windows-latest
             target: aarch64-pc-windows-msvc
-            expect_file: "Aarch64.+Windows"
             expect_cross: false
+            expect_file: "Aarch64.+Windows"
+            expect_stripped: false
             can_test: false
 
           - platform_name: Windows-i686
             os: windows-latest
             target: i686-pc-windows-msvc
-            expect_file: "80386.+Windows"
             expect_cross: false
+            expect_file: "80386.+Windows"
+            expect_stripped: true
             can_test: true
 
           - platform_name: Windows-x86_64
             os: windows-latest
             target: x86_64-pc-windows-msvc
-            expect_file: "x86-64.+Windows"
             expect_cross: false
+            expect_file: "x86-64.+Windows"
+            expect_stripped: true
             can_test: true
 
           - platform_name: macOS-x86_64
             os: macOS-latest
             target: x86_64-apple-darwin
-            expect_file: "Mach-O.+x86_64"
             expect_cross: false
+            expect_file: "Mach-O.+x86_64"
+            expect_stripped: true
             can_test: true
 
           - platform_name: macOS-aarch64
             os: macOS-latest
             target: aarch64-apple-darwin
-            expect_file: "Mach-O.+arm64"
             expect_cross: false
+            expect_file: "Mach-O.+arm64"
+            expect_stripped: true
             can_test: false
 
     runs-on: ${{ matrix.platform.os }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      # This is installed here so we can check for it in $PATH later. This
-      # makes sure that the actions don't overwrite anything in $PATH.
-      - name: Install Protoc
-        uses: arduino/setup-protoc@v1
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Copy test project to root
         shell: bash
         run: |
@@ -171,23 +185,23 @@ jobs:
         with:
           command: both
           target: ${{ matrix.platform.target }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
       - name: Run test command
         uses: "houseabsolute/actions-rust-cross@v0"
         with:
           command: test
           target: ${{ matrix.platform.target }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         if: ${{ matrix.platform.can_test }}
       - name: Run build command
         uses: "houseabsolute/actions-rust-cross@v0"
         with:
           command: build
           target: ${{ matrix.platform.target }}
-      - name: Check for cross on ${{ matrix.platform.platform_name }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          strip: true
+      - name: Check binary and cross on ${{ matrix.platform.platform_name }}
         shell: bash
         run: |
-          tests/check-binary.sh "${{ matrix.platform.target }}" "${{ matrix.platform.expect_cross }}" "${{ matrix.platform.expect_file }}"
-      - name: Check that $PATH is not overwritten
-        shell: bash
-        run: |
-          tests/check-path.sh
+          tests/check-binary.sh "${{ matrix.platform.target }}" "${{ matrix.platform.expect_cross }}" "${{ matrix.platform.expect_file }}" "${{ matrix.platform.expect_stripped }}"

Changes.md

@@ -1,3 +1,25 @@
+## 0.0.6 - 2023-04-21
+
+- When the `strip` parameter was true, stripping binaries could fail if there
+  were both `target/*/debug` and `target/*/release` directories present and
+  the `debug` directory didn't have a binary. Now it will strip all binaries
+  it finds under `target`.
+
+## 0.0.5 - 2023-03-19
+
+- Fix use of `dtolnay/rust-toolchain` action to allow passing a `toolchain`
+  input.
+
+## 0.0.4 - 2023-03-19
+
+- Added a new `toolchain` parameter to allow selecting a Rust toolchain other
+  than stable. This supports picking on of "stable", "beta", or "nightly".
+- Fixed binary stripping to work in more situations. Previously it depended on
+  a very specific setup plus expected to be run in the context of the matrix I
+  use for my own projects.
+- Fixed a reference to a matrix variable that should have referenced an input
+  variable.
+
 ## 0.0.3 - 2023-03-17
 
 - This action now supports running the `build` and `test` commands, or both,

README.md

@@ -55,13 +55,14 @@ jobs:
 
 This action takes the following parameters:
 
-| Key            | Type                                       | Required? | Description                                                                                                                               |
-| -------------- | ------------------------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| `command`      | string (one of `build`, `test`, or `both`) | no        | The command(s) to run. The default is `build`. Running the `test` command will fails with \*BSD targets, non-x86 Windows, and macOS ARM.  |
-| `target`       | string                                     | yes       | The target triple to compile for. This should be one of the targets listed by running `rustup target list`.                               |
-| `GITHUB_TOKEN` | string                                     | no        | Defaults to the value of `${{ github.token }}`.                                                                                           |
-| `args`         | string                                     | no        | A string-separated list of arguments to be passed to `cross build`, like `--release --locked`.                                            |
-| `strip`        | boolean (`true` or `false`)                | no        | If this is true, then the resulting binary will be stripped if possible. This is only possible for binaries which weren't cross-compiled. |
+| Key            | Type                                           | Required? | Description                                                                                                                               |
+| -------------- | ---------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `command`      | string (one of `build`, `test`, or `both`)     | no        | The command(s) to run. The default is `build`. Running the `test` command will fails with \*BSD targets, non-x86 Windows, and macOS ARM.  |
+| `target`       | string                                         | yes       | The target triple to compile for. This should be one of the targets listed by running `rustup target list`.                               |
+| `toolchain`    | string (one of `stable`, `beta`, or `nightly`) | no        | The Rust toolchain version to install. The default is `stable`                                                                            |
+| `GITHUB_TOKEN` | string                                         | no        | Defaults to the value of `${{ github.token }}`.                                                                                           |
+| `args`         | string                                         | no        | A string-separated list of arguments to be passed to `cross build`, like `--release --locked`.                                            |
+| `strip`        | boolean (`true` or `false`)                    | no        | If this is true, then the resulting binary will be stripped if possible. This is only possible for binaries which weren't cross-compiled. |
 
 ## How it Works
 

action.yml

@@ -13,6 +13,10 @@ inputs:
   target:
     description: The target platform
     required: true
+  toolchain:
+    description: |
+      The target toolchain to use (one of "stable", "beta", or "nightly").
+    default: stable
   GITHUB_TOKEN:
     description: |
       A GitHub token, available in the secrets.GITHUB_TOKEN context variable.
@@ -36,9 +40,10 @@ runs:
       shell: bash
       run: set-cross-compile.sh ${{ inputs.target }}
     - name: Install toolchain if not cross-compiling
-      uses: dtolnay/rust-toolchain@stable
+      uses: dtolnay/rust-toolchain@master
       with:
-        targets: ${{ matrix.platform.target }}
+        targets: ${{ inputs.target }}
+        toolchain: ${{ inputs.toolchain }}
       if: ${{ steps.determine-cross-compile.outputs.needs-cross == 'false' }}
     - name: Install cross if cross-compiling (*nix)
       shell: bash
@@ -82,7 +87,6 @@ runs:
       if: ${{ inputs.command != 'test' && runner.os == 'Windows' }}
     - name: Strip binary
       shell: bash
-      run: |
-        strip target/${{ matrix.platform.target }}/release/${{ matrix.platform.bin }}
+      run: strip-binary.sh ${{ inputs.target }}
       # strip doesn't work with cross-arch binaries on Linux or Windows.
       if: ${{ inputs.command != 'test' && inputs.strip == 'true' && steps.determine-cross-compile.outputs.needs-cross == 'false' && inputs.target != 'aarch64-pc-windows-msvc' }}

strip-binary.sh

@@ -0,0 +1,33 @@
+set -e
+set -x
+
+TARGET=$1
+stripped=""
+
+strip_binary () {
+    if [[ $( uname -s ) =~ "Darwin" ]]; then
+        EXE=$( find "$1" -maxdepth 1 -type f -perm +111 )
+    else
+        EXE=$( find "$1" -maxdepth 1 -type f -executable )
+    fi
+
+    if [ -z "$EXE" ]; then
+        echo "Could not find a binary to strip in $1"
+    else
+        strip "$EXE"
+        stripped="$EXE"
+    fi
+}
+
+for type in debug release; do
+    if [ -d "target/$TARGET/$type" ]; then
+        strip_binary "target/$TARGET/$type"
+    elif [ -d "target/$type" ]; then
+        strip_binary "target/$type"
+    fi
+done
+
+if [ -z "$stripped" ]; then
+    echo "No binaries were stripped"
+    exit 1
+fi

tests/check-binary.sh

@@ -4,6 +4,7 @@ set -x
 TARGET=$1
 EXPECT_CROSS=$2
 EXPECT_FILE_RE=$3
+EXPECT_STRIPPED=$4
 
 if [ "$EXPECT_CROSS" == "true" ]; then
     if [ ! -f "$RUNNER_TEMP/cross" ]; then
@@ -24,3 +25,25 @@ else
     echo "file output does not match $EXPECT_FILE_RE"
     exit 2
 fi
+
+if [[ $( uname -s ) =~ "Darwin" ]]; then
+    # File on macOS doesn't report whether the binary is stripped or not.
+    exit 0
+fi
+
+if [[ "$FILE" =~ "not stripped" ]]; then
+    echo "binary was not stripped"
+    GOT_STRIPPED="false"
+elif [[ "$FILE" =~ "stripped" ]]; then
+    echo "binary was stripped"
+    GOT_STRIPPED="true"
+else
+    # On Windows the aarch64 binary's file info doesn't include the word
+    # "stripped" at all.
+    echo "binary was not stripped"
+    GOT_STRIPPED="false"
+fi
+
+if [ "$EXPECT_STRIPPED" != "$GOT_STRIPPED" ]; then
+    exit 3
+fi

tests/check-path.sh

@@ -1,4 +0,0 @@
-set -e
-set -x
-
-which protoc