name: CI on: push: branches: - main pull_request: branches: - main concurrency: group: ci-${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true permissions: contents: read jobs: build-test: name: Build & test (${{ matrix.os }}) runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: - warp-ubuntu-latest-x64-8x - warp-macos-15-arm64-6x - warp-windows-latest-x64-16x steps: - name: Checkout uses: actions/checkout@v4 with: # gpui/ is a git submodule; its crates are workspace members of # their own repo and build as path dependencies of oakapp. submodules: true - name: Install Rust (stable) uses: dtolnay/rust-toolchain@stable # ------------------------------------------------------------------ # System dependencies # ------------------------------------------------------------------ - name: Install system dependencies (Linux) if: runner.os == 'Linux' run: | # Codec/filter libraries for the ffmpeg-sys-next build feature # (see tooling/install-deps.sh). tooling/install-deps.sh # cmake/make for the vendored OpenColorIO build (ocio-sys # `bundled`; Ubuntu's libopencolorio-dev is 2.1, older than the # bridge's API floor) plus the headless test infra gpui needs: # X11, software Mesa Vulkan (lavapipe) and xvfb. sudo apt-get install -y \ cmake \ libpipewire-0.3-dev libspa-0.2-dev libjack-jackd2-dev \ libasound2-dev libpulse-dev libsndfile1-dev \ libgl1-mesa-dev libgl1-mesa-dri mesa-vulkan-drivers \ libvulkan-dev libxkbcommon-dev libxkbcommon-x11-dev xvfb - name: Install system dependencies (macOS) if: runner.os == 'macOS' run: | tooling/install-deps.sh brew install cmake - name: Setup MSYS2 (Windows) if: runner.os == 'Windows' uses: msys2/setup-msys2@v2 with: msystem: UCRT64 update: true # MSYS2's own Rust targets x86_64-pc-windows-gnu by default — # the Windows build is GNU-target (the MSVC linker rejects the # Unix-style link args the build scripts emit). install: >- git mingw-w64-ucrt-x86_64-gcc mingw-w64-ucrt-x86_64-rust - name: Install system dependencies (Windows) if: runner.os == 'Windows' shell: msys2 {0} run: | bash tooling/install-deps.sh pacman -S --needed --noconfirm \ mingw-w64-ucrt-x86_64-cmake \ mingw-w64-ucrt-x86_64-opencolorio # ------------------------------------------------------------------ # Build environment # ------------------------------------------------------------------ # ocio-sys builds a stub bridge unless these are set; the oakcommon # ocioutils tests need the real library (see crates/oakcommon/.cargo/ # config.toml, which only applies to builds run from that directory). # ocio-sys builds its vendored OpenColorIO from source on Linux (the # `bundled` feature; the distro package is too old for the bridge), # so no OCIO_INSTALL_DIR here. macOS/Windows keep the system library. - name: Configure build environment (Linux) if: runner.os == 'Linux' run: | echo "OCIO_RS_ENABLE_REAL=1" >> "$GITHUB_ENV" echo "OCIO_RS_LINK=static" >> "$GITHUB_ENV" - name: Configure build environment (macOS) if: runner.os == 'macOS' run: | # OCIO comes from the ocio-sys vendored source build (same on # every platform); no OCIO_INSTALL_DIR override. echo "OCIO_RS_ENABLE_REAL=1" >> "$GITHUB_ENV" echo "OCIO_RS_LINK=static" >> "$GITHUB_ENV" # Homebrew quirks: lame.pc / snappy / libopenjp2.pc live off the # default pkg-config search paths (see docs/build.md). echo "CFLAGS=-I/opt/homebrew/include" >> "$GITHUB_ENV" echo "LDFLAGS=-L/opt/homebrew/lib" >> "$GITHUB_ENV" echo "PKG_CONFIG_PATH=/opt/homebrew/lib/pkgconfig/openjpeg" >> "$GITHUB_ENV" - name: Configure build environment (Windows) if: runner.os == 'Windows' shell: msys2 {0} run: | # Windows uses the MSYS2 OpenColorIO package (the exact 2.5.2 the # bridge targets; the vendored source needs MSVC-only constructs). # Dynamic here — the CD packages the DLLs next to the binaries. echo "OCIO_RS_ENABLE_REAL=1" >> "$GITHUB_ENV" echo "OCIO_INSTALL_DIR=/ucrt64" >> "$GITHUB_ENV" echo "OCIO_RS_LINK=dynamic" >> "$GITHUB_ENV" # ocio-sys' build.rs force-adds the MSVC + Windows SDK include # dirs on Windows (meant for MSVC hosts); with the GNU toolchain # that drags MSVC-only headers into the g++ compile. Unpack the # crate and gate that block behind OCIO_RS_NO_MSVC_INCLUDES. echo "OCIO_RS_NO_MSVC_INCLUDES=1" >> "$GITHUB_ENV" CH=$(cygpath -u "${CARGO_HOME:-$HOME/.cargo}") cargo fetch --locked for cache in "$CH"/registry/cache/*/; do src="$CH/registry/src/$(basename "$cache")" mkdir -p "$src" [ -f "$cache/ocio-sys-0.2.1.crate" ] && tar xzf "$cache/ocio-sys-0.2.1.crate" -C "$src" done BS=$(ls "$CH"/registry/src/*/ocio-sys-0.2.1/build.rs) grep -q 'OCIO_RS_NO_MSVC_INCLUDES' "$BS" || sed -i \ 's|if cfg!(target_os = "windows") && has_real_ocio {|if cfg!(target_os = "windows") \&\& has_real_ocio \&\& std::env::var_os("OCIO_RS_NO_MSVC_INCLUDES").is_none() {|' \ "$BS" grep -q 'OCIO_RS_NO_MSVC_INCLUDES' "$BS" # ------------------------------------------------------------------ # Caches # ------------------------------------------------------------------ # Covers the whole target/ dir plus ~/.cargo; shared across branches # of the same OS. - name: Cache cargo artifacts uses: Swatinem/rust-cache@v2 with: shared-key: oak-workspace # The project FFmpeg (release/8.0, static, all free codecs + hwaccel) # is built by tooling/ffmpeg/build-ffmpeg.sh — 10-20 min on a cold # cache. It does not depend on the Rust toolchain, so key it on the # script itself and keep it out of rust-cache. - name: Cache project FFmpeg uses: actions/cache@v4 with: path: .cache/ffmpeg key: ffmpeg-${{ runner.os }}-${{ hashFiles('tooling/ffmpeg/build-ffmpeg.sh') }} # ------------------------------------------------------------------ # Project FFmpeg (script + FFMPEG_DIR; see docs/build.md) # ------------------------------------------------------------------ - name: Build project FFmpeg (Linux/macOS) if: runner.os != 'Windows' run: | tooling/ffmpeg/build-ffmpeg.sh echo "FFMPEG_DIR=$PWD/.cache/ffmpeg" >> "$GITHUB_ENV" - name: Build project FFmpeg (Windows) if: runner.os == 'Windows' shell: msys2 {0} run: | bash tooling/ffmpeg/build-ffmpeg.sh echo "FFMPEG_DIR=$(cygpath -m "$PWD/.cache/ffmpeg")" >> "$GITHUB_ENV" # ------------------------------------------------------------------ # Build & test # ------------------------------------------------------------------ - name: Build (Linux) if: runner.os == 'Linux' run: cargo build --workspace --locked - name: Build (macOS) if: runner.os == 'macOS' run: cargo build --workspace --locked - name: Build (Windows) if: runner.os == 'Windows' shell: msys2 {0} run: | # The runner's job hook injects the MSVC INCLUDE/LIB into every # step; clear them in-step (they poison the MinGW compiles with # MSVC SDK headers). unset INCLUDE LIB cargo build --workspace --locked # xvfb + 24-bit screen: the gpui #[gpui::test] tests open real windows # and render through wgpu on Mesa's software Vulkan (lavapipe). - name: Test (Linux) if: runner.os == 'Linux' run: xvfb-run -a -s "-screen 0 1920x1080x24" cargo test --workspace --locked # A crashing (SIGSEGV) test gives no Rust backtrace; rerun the # plugin test binaries under gdb to capture the native stack. - name: Backtrace on test failure (Linux) if: failure() run: | sudo apt-get install -y gdb for name in node_e2e_test suites_test; do BIN=$(ls -t target/debug/deps/$name-* | grep -v '\.d$' | head -1) [ -n "$BIN" ] || continue xvfb-run -a gdb -batch -ex run -ex bt -- "$BIN" --nocapture || true done - name: Test (macOS) if: runner.os == 'macOS' run: cargo test --workspace --locked - name: Test (Windows) if: runner.os == 'Windows' shell: msys2 {0} run: | unset INCLUDE LIB cargo test --workspace --locked # ------------------------------------------------------------------ # OFX plugin discovery end-to-end # ------------------------------------------------------------------ # Build a minimal but real OFX plugin into a .ofx.bundle, point # OFX_PLUGIN_PATH at it and let the scan_probe example run the full # host path (directory scan -> dlopen -> setHost -> load -> describe # -> register). The assertion is the plugin's registration line; CI # machines have no system-wide OFX plugins, so the fixture is the # only discovery. - name: Build OFX fixture plugin (Linux/macOS) if: runner.os != 'Windows' run: crates/oakplugin/tests/fixtures/build_fixture.sh .cache/ofx-fixture - name: Probe OFX plugin discovery (Linux/macOS) if: runner.os != 'Windows' run: | OFX_PLUGIN_PATH="$PWD/.cache/ofx-fixture" \ cargo run --locked -p oakplugin --example scan_probe > probe.log 2>&1 grep -q 'type_id=rs.oak.CiTestPlugin' probe.log # A project carrying a plugin node must survive save/load (the # serializer resolves plugin types via the dynamic factory). OAK_OFX_FIXTURE_DIR="$PWD/.cache/ofx-fixture" \ cargo test --locked -p oakplugin --test ofx_roundtrip