mirror of
https://github.com/microsoft/regorus.git
synced 2026-08-05 02:16:11 +00:00
- split the xtask crate into structured modules for - bindings - ci - dev - util - no-std - Adding commands for - ci-release/ci-debug - MUSL/no-std - per- binding language smoke tests - developer tasks (fmt, clippy, pre-commit, pre-push) - refresh Cargo manifests/locks, binding readmes, and shared FFI helpers so every binding reuses the same preparation steps - refactor GitHub Actions (release/debug, extensions, CodeQL, clippy, bindings) to call the new xtask commands - Use rust-cache in ci workflows (microsoft qdk also does this) - extend README with a contributor workflow section describing how xtask mirrors CI expectations - update pre-commit and pre-push hooks to use the xtask dev commands WORKAROUND: When dotnet is run from an xtask, codeql tracer intercepts it an routes to a nonexistent binary. Therefore in codeql workflow, xtask is not used for c# and instead dotnet is directly invoked. Tracked by #545 closes #475 Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>
191 lines
6.0 KiB
YAML
191 lines
6.0 KiB
YAML
name: "CodeQL Security Analysis"
|
|
|
|
on:
|
|
schedule:
|
|
# Run weekly on Wednesdays at 3:17 AM UTC
|
|
- cron: '17 3 * * 3'
|
|
workflow_dispatch:
|
|
# Allow manual triggering
|
|
push:
|
|
branches: [ "main" ]
|
|
pull_request:
|
|
branches: [ "main" ]
|
|
|
|
jobs:
|
|
analyze:
|
|
name: Analyze (${{ matrix.language }})
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 60
|
|
permissions:
|
|
# required for all workflows
|
|
security-events: write
|
|
# required to fetch internal or private CodeQL packs
|
|
packages: read
|
|
# only required for workflows in private repositories
|
|
actions: read
|
|
contents: read
|
|
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
include:
|
|
# Rust analysis for main crate and Rust-based bindings
|
|
- language: rust
|
|
build-mode: none
|
|
working-directory: .
|
|
# C/C++ analysis for FFI bindings
|
|
- language: c-cpp
|
|
build-mode: manual
|
|
working-directory: bindings/ffi
|
|
# Python analysis for Python bindings
|
|
- language: python
|
|
build-mode: none
|
|
working-directory: bindings/python
|
|
# Java analysis for Java bindings
|
|
- language: java-kotlin
|
|
build-mode: manual
|
|
working-directory: bindings/java
|
|
# Go analysis for Go bindings
|
|
- language: go
|
|
build-mode: manual
|
|
working-directory: bindings/go
|
|
# C# analysis for C# bindings
|
|
- language: csharp
|
|
build-mode: manual
|
|
working-directory: bindings/csharp
|
|
# JavaScript analysis for WASM bindings
|
|
- language: javascript-typescript
|
|
build-mode: none
|
|
working-directory: bindings/wasm
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v4
|
|
|
|
# Setup language-specific dependencies BEFORE CodeQL init for proper tracing setup
|
|
- name: Setup Rust
|
|
uses: ./.github/actions/toolchains/rust
|
|
|
|
- name: Cache cargo
|
|
uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2
|
|
with:
|
|
shared-key: ${{ runner.os }}-regorus
|
|
|
|
- name: Fetch workspace dependencies
|
|
run: cargo fetch --locked
|
|
|
|
- name: Fetch FFI crate dependencies
|
|
if: matrix.language == 'c-cpp' || matrix.language == 'go' || matrix.language == 'csharp'
|
|
run: cargo fetch --locked --manifest-path bindings/ffi/Cargo.toml
|
|
|
|
- name: Fetch Java crate dependencies
|
|
if: matrix.language == 'java-kotlin'
|
|
run: cargo fetch --locked --manifest-path bindings/java/Cargo.toml
|
|
|
|
- name: Setup Python
|
|
if: matrix.language == 'python'
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.10'
|
|
|
|
- name: Setup Java
|
|
if: matrix.language == 'java-kotlin'
|
|
uses: actions/setup-java@v4
|
|
with:
|
|
distribution: 'corretto'
|
|
java-version: '8'
|
|
|
|
- name: Setup Go
|
|
if: matrix.language == 'go'
|
|
uses: actions/setup-go@v5
|
|
with:
|
|
go-version: '1.21'
|
|
|
|
- name: Setup .NET
|
|
if: matrix.language == 'csharp'
|
|
uses: actions/setup-dotnet@v4
|
|
with:
|
|
global-json-file: ./bindings/csharp/global.json
|
|
|
|
- name: Invoke dotnet directly
|
|
if: matrix.language == 'csharp'
|
|
run: dotnet --info
|
|
|
|
- name: Setup Node.js
|
|
if: matrix.language == 'javascript-typescript'
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: '18'
|
|
|
|
- name: Initialize CodeQL
|
|
uses: github/codeql-action/init@v3
|
|
with:
|
|
languages: ${{ matrix.language }}
|
|
build-mode: ${{ matrix.build-mode }}
|
|
|
|
# Install additional build dependencies
|
|
- name: Install system dependencies
|
|
if: matrix.language == 'rust' || matrix.language == 'c-cpp'
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y build-essential cmake
|
|
|
|
- name: Install Python build dependencies
|
|
if: matrix.language == 'python'
|
|
working-directory: ${{ matrix.working-directory }}
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install maturin[patchelf] pytest
|
|
|
|
- name: Setup Ruby
|
|
if: matrix.language == 'rust' && contains(matrix.working-directory, 'ruby')
|
|
uses: ruby/setup-ruby@v1
|
|
with:
|
|
ruby-version: '3.4.2'
|
|
bundler-cache: true
|
|
working-directory: bindings/ruby
|
|
|
|
- name: Install WASM build dependencies
|
|
if: matrix.language == 'javascript-typescript'
|
|
run: |
|
|
cargo install wasm-pack
|
|
|
|
# Manual build steps for different languages
|
|
- name: Build C/C++ bindings via xtask
|
|
if: matrix.language == 'c-cpp'
|
|
run: |
|
|
cargo xtask test-c --release --frozen
|
|
cargo xtask test-cpp --release --frozen --skip-ffi
|
|
cargo xtask test-c-no-std --release --frozen --skip-ffi
|
|
|
|
- name: Build Java bindings via xtask
|
|
if: matrix.language == 'java-kotlin'
|
|
run: cargo xtask test-java --release --frozen
|
|
|
|
- name: Build Go bindings via xtask
|
|
if: matrix.language == 'go'
|
|
run: cargo xtask test-go --release --frozen
|
|
|
|
- name: Build C# bindings manually
|
|
if: matrix.language == 'csharp'
|
|
working-directory: ${{ matrix.working-directory }}
|
|
run: |
|
|
# Temporary workaround: CodeQL's tracer replaces dotnet with a missing shim when cargo xtask test-csharp runs,
|
|
# so invoke dotnet directly here until the upstream fix lands.
|
|
# Ideal command once fixed: cargo xtask test-csharp --release
|
|
# Build the FFI library that C# bindings access via P/Invoke
|
|
cd ../ffi
|
|
cargo build --release --locked
|
|
cd ../csharp
|
|
# Restore NuGet packages and build .NET assemblies in release mode
|
|
dotnet restore Regorus/Regorus.csproj
|
|
dotnet build Regorus/Regorus.csproj --no-restore /p:Configuration=Release /p:IgnoreMissingArtifacts=true
|
|
|
|
- name: Build WASM bindings via xtask
|
|
if: matrix.language == 'javascript-typescript'
|
|
run: cargo xtask build-wasm --release
|
|
|
|
- name: Perform CodeQL Analysis
|
|
uses: github/codeql-action/analyze@v3
|
|
with:
|
|
category: "/language:${{matrix.language}}" |