Merge pull request #1 from godot-rust/master

update

Author: hapenia

.github/composite/godot-install/action.yml

@@ -10,7 +10,7 @@ inputs:
     required: true
     description: "Name of the compiled Godot artifact to download"
 
-  binary-filename:
+  godot-binary:
     required: true
     description: "Filename of the Godot executable"
 
@@ -25,7 +25,7 @@ runs:
       run: |
         runnerDir=$(echo "${{ runner.temp }}" | sed "s!\\\\!/!")
         echo "RUNNER_DIR=$runnerDir" >> $GITHUB_ENV
-        echo "GODOT4_BIN=$runnerDir/godot_bin/${{ inputs.binary-filename }}" >> $GITHUB_ENV
+        echo "GODOT4_BIN=$runnerDir/godot_bin/${{ inputs.godot-binary }}" >> $GITHUB_ENV
       shell: bash
 
 #    - name: "Check cache for installed Godot version"

.github/composite/godot-itest/action.yml

@@ -10,10 +10,15 @@ inputs:
     required: true
     description: "Name of the compiled Godot artifact to download"
 
-  binary-filename:
+  godot-binary:
     required: true
     description: "Filename of the Godot executable"
 
+  godot-args:
+    required: false
+    default: ''
+    description: "Command-line arguments passed to Godot"
+
   rust-toolchain:
     required: false
     default: 'stable'
@@ -24,10 +29,15 @@ inputs:
     default: ''
     description: "Extra command line arguments for 'cargo build', e.g. features"
 
+  rust-env-rustflags:
+    required: false
+    default: ''
+    description: "Extra values for the RUSTFLAGS env var"
+
   with-llvm:
     required: false
-    description: "Set to 'true' if LLVM should be installed"
     default: ''
+    description: "Set to 'true' if LLVM should be installed"
 
 
 runs:
@@ -39,7 +49,7 @@ runs:
       uses: ./.github/composite/godot-install
       with:
         artifact-name: ${{ inputs.artifact-name }}
-        binary-filename: ${{ inputs.binary-filename }}
+        godot-binary: ${{ inputs.godot-binary }}
 
     # The chmod seems still necessary, although applied before uploading artifact. Possibly modes are not preserved.
     # The `| xargs` pattern trims the output, since printed version may contain extra newline, which causes problems in env vars.
@@ -83,6 +93,8 @@ runs:
       run: |
         cargo build -p itest ${{ inputs.rust-extra-args }}
       shell: bash
+      env:
+        RUSTFLAGS: ${{ inputs.rust-env-rustflags }}
 
     - name: "Run Godot integration tests"
       # Aborts immediately if Godot outputs certain keywords (would otherwise stall until CI runner times out).
@@ -94,7 +106,7 @@ runs:
       run: |
         cd itest/godot
         echo "OUTCOME=itest" >> $GITHUB_ENV
-        $GODOT4_BIN --headless 2>&1 | tee "${{ runner.temp }}/log.txt" | tee >(grep "SCRIPT ERROR:" -q && {
+        $GODOT4_BIN --headless ${{ inputs.godot-args }} 2>&1 | tee "${{ runner.temp }}/log.txt" | tee >(grep "SCRIPT ERROR:" -q && {
         	printf "\n -- Godot engine encountered error, abort...\n";
         	pkill godot
             echo "OUTCOME=godot-runtime" >> $GITHUB_ENV

.github/composite/rust/action.yml

@@ -32,6 +32,7 @@ runs:
     - name: "Configure"
       id: configure
       run: |
+        echo "Rust cache shared-key: '${{ runner.os }}-${{ inputs.rust }}${{ inputs.cache-key }}'"
         echo "components=$( for c in ${cs//,/ }; do echo -n ' --component' $c; done )" >> $GITHUB_OUTPUT
       env:
         cs: ${{ inputs.components }}
@@ -46,7 +47,18 @@ runs:
     - name: "Reuse cached dependencies"
       uses: Swatinem/rust-cache@v2
       with:
-        shared-key: ${{ inputs.cache-key }}
+        # A cache key that is used instead of the automatic `job`-based key, and is stable over multiple jobs.
+        # default: empty
+        shared-key: "${{ runner.os }}-${{ inputs.rust }}${{ inputs.cache-key }}"
+
+        # An additional cache key that is added alongside the automatic `job`-based
+        # cache key and can be used to further differentiate jobs.
+        # default: empty
+        key: ${{ inputs.cache-key }}
+
+        # Determines if the cache should be saved even when the workflow has failed.
+        # default: "false"
+        cache-on-failure: true
 
     - name: "Install LLVM"
       uses: ./.github/composite/llvm

.github/workflows/full-ci.yml

@@ -18,6 +18,12 @@ env:
 #  GDEXT_FEATURES: '--features crate/feature'
 #  GDEXT_CRATE_ARGS: '-p godot-codegen -p godot-ffi -p godot-core -p godot-macros -p godot'
 
+  # LSan options: https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer
+  # * report_objects: list individual leaked objects when running LeakSanitizer
+  LSAN_OPTIONS: report_objects=1
+
+  # ASan options: https://github.com/google/sanitizers/wiki/AddressSanitizerFlags
+
 defaults:
   run:
     shell: bash
@@ -44,7 +50,20 @@ jobs:
 
 
   clippy:
+    name: clippy (${{ matrix.name }})
     runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include: 
+          - name: linux
+            rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.x86_64
+          
+          - name: linux-double
+            rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
+            rust-extra-args: --features double-precision
     steps:
       - uses: actions/checkout@v3
 
@@ -56,13 +75,14 @@ jobs:
       - name: "Install Godot"
         uses: ./.github/composite/godot-install
         with:
-          artifact-name: godot-linux
-          binary-filename: godot.linuxbsd.editor.dev.x86_64
+          artifact-name: godot-${{ matrix.name }}
+          godot-binary: ${{ matrix.godot-binary }}
 
       - name: "Check clippy"
         run: |
-          cargo clippy --all-targets $GDEXT_FEATURES -- -D clippy::suspicious -D clippy::style -D clippy::complexity -D clippy::perf \
-          -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented -D warnings
+          cargo clippy --all-targets $GDEXT_FEATURES ${{ matrix.rust-extra-args }} -- \
+          -D clippy::suspicious -D clippy::style -D clippy::complexity -D clippy::perf \
+          -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented -D warnings 
 
 
   unit-test:
@@ -80,6 +100,7 @@ jobs:
             os: macos-11
             rust-toolchain: stable
             godot-binary: godot.macos.editor.dev.x86_64
+            with-llvm: true
 
           - name: windows
             os: windows-latest
@@ -98,16 +119,16 @@ jobs:
             rust-toolchain: stable
             rust-special: -minimal-deps
             godot-binary: godot.linuxbsd.editor.dev.x86_64
-
+          
     steps:
       - uses: actions/checkout@v3
 
       - name: "Install Rust"
         uses: ./.github/composite/rust
         with:
           rust: stable
-          cache-key: ${{ matrix.rust-special }} # 'minimal-deps' or empty/not defined
-          with-llvm: ${{ matrix.name == 'macos' }}
+          cache-key: ${{ matrix.rust-special }} # '-minimal-deps' or empty/not defined
+          with-llvm: ${{ matrix.with-llvm }}
 
       - name: "Install Rust nightly (minimal deps)"
         uses: ./.github/composite/rust
@@ -126,20 +147,19 @@ jobs:
         uses: ./.github/composite/godot-install
         with:
           artifact-name: godot-${{ matrix.name }}
-          binary-filename: ${{ matrix.godot-binary }}
+          godot-binary: ${{ matrix.godot-binary }}
 
       - name: "Compile tests"
-        run: cargo test $GDEXT_FEATURES --no-run
+        run: cargo test $GDEXT_FEATURES --no-run ${{ matrix.rust-extra-args }}
 
       - name: "Test"
-        run: cargo test $GDEXT_FEATURES
+        run: cargo test $GDEXT_FEATURES ${{ matrix.rust-extra-args }}
 
 
   godot-itest:
     name: godot-itest (${{ matrix.name }})
     runs-on: ${{ matrix.os }}
-    # TODO: continue-on-error: false, as soon as memory errors are fixed
-    continue-on-error: ${{ contains(matrix.name, 'memcheck') }}
+    continue-on-error: false
     timeout-minutes: 24
     strategy:
       fail-fast: false # cancel all jobs as soon as one fails?
@@ -152,28 +172,58 @@ jobs:
             os: macos-12
             rust-toolchain: stable
             godot-binary: godot.macos.editor.dev.x86_64
+            with-llvm: true
+          
+          - name: macos-double
+            os: macos-12
+            rust-toolchain: stable
+            godot-binary: godot.macos.editor.dev.double.x86_64
+            rust-extra-args: --features double-precision
+            with-llvm: true
 
           - name: windows
             os: windows-latest
             rust-toolchain: stable-x86_64-pc-windows-msvc
             godot-binary: godot.windows.editor.dev.x86_64.exe
 
+          - name: windows-double
+            os: windows-latest
+            rust-toolchain: stable-x86_64-pc-windows-msvc
+            godot-binary: godot.windows.editor.dev.double.x86_64.exe
+            rust-extra-args: --features double-precision
+
           # Don't use latest Ubuntu (22.04) as it breaks lots of ecosystem compatibility.
           # If ever moving to ubuntu-latest, need to manually install libtinfo5 for LLVM.
           - name: linux
             os: ubuntu-20.04
             rust-toolchain: stable
             godot-binary: godot.linuxbsd.editor.dev.x86_64
 
-          - name: linux-memcheck-gcc
+          - name: linux-double
             os: ubuntu-20.04
             rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
+            rust-extra-args: --features double-precision
+
+          # Special Godot binaries compiled with AddressSanitizer/LeakSanitizer to detect UB/leaks.
+          # Additionally, the Godot source is patched to make dlclose() a no-op, as unloading dynamic libraries loses stacktrace and
+          # cause false positives like println!. See https://github.com/google/sanitizers/issues/89.
+          # The gcc version can possibly be removed later, as it is slower and needs a larger artifact than the clang one.
+
+          # --disallow-focus: fail if #[itest(focus)] is encountered, to prevent running only a few tests for full CI
+          - name: linux-memcheck-gcc
+            os: ubuntu-20.04
             godot-binary: godot.linuxbsd.editor.dev.x86_64.san
+            godot-args: -- --disallow-focus
+            rust-toolchain: nightly
+            rust-env-rustflags: -Zrandomize-layout
 
           - name: linux-memcheck-clang
             os: ubuntu-20.04
-            rust-toolchain: stable
             godot-binary: godot.linuxbsd.editor.dev.x86_64.llvm.san
+            godot-args: -- --disallow-focus
+            rust-toolchain: nightly
+            rust-env-rustflags: -Zrandomize-layout
 
     steps:
       - uses: actions/checkout@v3
@@ -182,8 +232,12 @@ jobs:
         uses: ./.github/composite/godot-itest
         with:
           artifact-name: godot-${{ matrix.name }}
-          binary-filename: ${{ matrix.godot-binary }}
-          with-llvm: ${{ matrix.name == 'macos' }}
+          godot-binary: ${{ matrix.godot-binary }}
+          godot-args: ${{ matrix.godot-args }}
+          rust-extra-args: ${{ matrix.rust-extra-args }}
+          rust-toolchain: ${{ matrix.rust-toolchain }}
+          rust-env-rustflags: ${{ matrix.rust-env-rustflags }}
+          with-llvm: ${{ matrix.with-llvm }}
 
 
   license-guard:

.github/workflows/minimal-ci.yml

@@ -44,7 +44,20 @@ jobs:
 
 
   clippy:
+    name: clippy (${{ matrix.name }})
     runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include: 
+          - name: linux
+            rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.x86_64
+          
+          - name: linux-double
+            rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
+            rust-extra-args: --features double-precision
     steps:
       - uses: actions/checkout@v3
 
@@ -56,12 +69,13 @@ jobs:
       - name: "Install Godot"
         uses: ./.github/composite/godot-install
         with:
-          artifact-name: godot-linux
-          binary-filename: godot.linuxbsd.editor.dev.x86_64
+          artifact-name: godot-${{ matrix.name }}
+          godot-binary: ${{ matrix.godot-binary }}
 
       - name: "Check clippy"
         run: |
-          cargo clippy --all-targets $GDEXT_FEATURES -- -D clippy::suspicious -D clippy::style -D clippy::complexity -D clippy::perf \
+          cargo clippy --all-targets $GDEXT_FEATURES ${{ matrix.rust-extra-args }} -- \
+          -D clippy::suspicious -D clippy::style -D clippy::complexity -D clippy::perf \
           -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented -D warnings
 
 
@@ -78,7 +92,7 @@ jobs:
         uses: ./.github/composite/godot-install
         with:
           artifact-name: godot-linux
-          binary-filename: godot.linuxbsd.editor.dev.x86_64
+          godot-binary: godot.linuxbsd.editor.dev.x86_64
 
       - name: "Compile tests"
         run: cargo test $GDEXT_FEATURES --no-run
@@ -98,7 +112,7 @@ jobs:
         uses: ./.github/composite/godot-itest
         with:
           artifact-name: godot-linux
-          binary-filename: godot.linuxbsd.editor.dev.x86_64
+          godot-binary: godot.linuxbsd.editor.dev.x86_64
           #godot_ver: ${{ matrix.godot }}
 
 

.gitignore

@@ -8,8 +8,10 @@ target
 Cargo.lock
 
 # Godot
-**/.import/
+# .godot needs to be a pattern like this and not a directory, otherwise the negative statements below don't apply
 **/.godot/**
+*.import
+
 # Needed to run projects without having to open the editor first.
 !**/.godot/extension_list.cfg
 !**/.godot/global_script_class_cache.cfg