diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index eec88f957..8cd0f11aa 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -143,3 +143,77 @@ jobs: if: ${{ steps.coverage.outputs.value }} with: file: build/coverage.info + + # Supplemental native Arm64 presubmit. Its output is never a release + # artifact; GitLab remains the production artifact chain. + build-arm64-presubmit: + runs-on: windows-11-arm + continue-on-error: true + steps: + - name: Preserve repository line endings + run: git config --global core.autocrlf input + + - uses: actions/checkout@v4 + + - name: Checkout OpenShotAudio + uses: actions/checkout@v4 + with: + repository: ${{ github.event.pull_request.head.repo.owner.login || github.repository_owner }}/libopenshot-audio + ref: ${{ github.event.pull_request.head.ref || github.ref_name }} + path: audio + + - name: Checkout Catch2 + uses: actions/checkout@v4 + with: + repository: catchorg/Catch2 + ref: v3.8.1 + path: Catch2 + + - uses: msys2/setup-msys2@v2 + with: + msystem: CLANGARM64 + update: true + + - name: Install exact CLANGARM64 package versions + shell: msys2 {0} + run: | + mapfile -t packages < <(sed -n '/^[^#[:space:]][^=]*=/s/,[^,]*$//p' ci/windows-arm64-packages.lock) + pacman --noconfirm -S --needed -- "${packages[@]}" + + - name: Build (CLANGARM64, presubmit only) + shell: msys2 {0} + run: | + cmake -B Catch2/build -S Catch2 -G Ninja \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_INSTALL_PREFIX="$PWD/catch2-install" \ + -DCATCH_BUILD_TESTING=OFF \ + -DCATCH_INSTALL_DOCS=OFF + cmake --build Catch2/build + cmake --install Catch2/build + cmake -B audio/build -S audio -G Ninja \ + -DCMAKE_C_COMPILER=clang \ + -DCMAKE_CXX_COMPILER=clang++ \ + -DCMAKE_INSTALL_PREFIX="$PWD/audio/install-arm64" \ + -DCMAKE_BUILD_TYPE=Release \ + -DENABLE_AUDIO_DOCS=OFF + cmake --build audio/build + cmake --install audio/build + cmake -B build -S . -G Ninja \ + -DCMAKE_C_COMPILER=clang \ + -DCMAKE_CXX_COMPILER=clang++ \ + -DUSE_QT6=ON \ + -DOpenShotAudio_ROOT="$PWD/audio/install-arm64" \ + -DCatch2_DIR="$PWD/catch2-install/lib/cmake/Catch2" \ + -DCMAKE_INSTALL_PREFIX="$PWD/install-arm64" \ + -DCMAKE_BUILD_TYPE=Release \ + -DENABLE_LIB_DOCS=OFF + cmake --build build + ctest --test-dir build --output-on-failure -VV + cmake --install build + python -m unittest discover -s ci -p "test_*.py" -v + python ci/validate_arm64_architecture.py \ + --require-native-arm64 \ + --package-lock ci/windows-arm64-packages.lock \ + --payload-root install-arm64 \ + --require-payload \ + --json-report build/arm64-presubmit-report.json diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e8ad920bc..9b4ffa8b6 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -125,6 +125,42 @@ windows-builder-x64: tags: - windows +windows-builder-arm64: + stage: build-libopenshot + artifacts: + expire_in: 6 months + paths: + - build\install-arm64\* + - build\arm64-architecture-report.json + script: + - try { Invoke-WebRequest -Uri "https://gitlab.openshot.org/OpenShot/libopenshot-audio/-/jobs/artifacts/$CI_COMMIT_REF_NAME/download?job=windows-builder-arm64" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" } catch { $_.Exception.Response.StatusCode.Value__ } + - if (-not (Test-Path "artifacts.zip")) { Invoke-WebRequest -Uri "https://gitlab.openshot.org/OpenShot/libopenshot-audio/-/jobs/artifacts/develop/download?job=windows-builder-arm64" -Headers @{"PRIVATE-TOKEN"="$ACCESS_TOKEN"} -OutFile "artifacts.zip" } + - Expand-Archive -Path artifacts.zip -DestinationPath . + - $env:MSYSTEM = "CLANGARM64" + - $env:Path = "C:\msys64\clangarm64\bin;C:\msys64\usr\bin;" + $env:Path; + - cmake -B build -S . -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON -D"CMAKE_C_COMPILER=clang" -D"CMAKE_CXX_COMPILER=clang++" -D"CMAKE_INSTALL_PREFIX:PATH=$CI_PROJECT_DIR\build\install-arm64" -D"OpenShotAudio_ROOT=$CI_PROJECT_DIR\build\install-arm64" -D"PYTHON_MODULE_PATH=python" -D"USE_QT6=ON" -D"OPENSHOT_QT_API=pyqt6" -G Ninja -D"CMAKE_BUILD_TYPE:STRING=Release" + - cmake --build build --parallel $([Environment]::ProcessorCount) + - ctest --test-dir build --output-on-failure -VV + - cmake --install build + - python -m unittest discover -s ci -p "test_*.py" -v + - python ci\validate_arm64_architecture.py --require-native-arm64 --package-lock ci\windows-arm64-packages.lock --payload-root build\install-arm64 --require-payload --json-report build\arm64-architecture-report.json + - $PROJECT_VERSION = (Select-String -Path "CMakeLists.txt" -Pattern '^set\(PROJECT_VERSION_FULL "(.*)\"' | %{$_.Matches.Groups[1].value}) + - $PROJECT_SO = (Select-String -Path "CMakeLists.txt" -Pattern '^set\(PROJECT_SO_VERSION (.*)\)' | %{$_.Matches.Groups[1].value}) + - New-Item -path "build/install-arm64/share/" -Name "$CI_PROJECT_NAME.env" -Value "CI_PROJECT_NAME:$CI_PROJECT_NAME`nCI_COMMIT_REF_NAME:$CI_COMMIT_REF_NAME`nCI_COMMIT_SHA:$CI_COMMIT_SHA`nCI_JOB_ID:$CI_JOB_ID`nCI_PIPELINE_ID:$CI_PIPELINE_ID`nVERSION:$PROJECT_VERSION`nSO:$PROJECT_SO`nTARGET_TRIPLET:aarch64-w64-mingw32`nPE_MACHINE:0xAA64" -ItemType file -force + - $PREV_GIT_LABEL=(git describe --tags --abbrev=0 '@^') + - git log "$PREV_GIT_LABEL..@" --oneline --pretty=format:"- %C(auto,yellow)%h%C(auto,magenta)% %C(auto,blue)%>(12,trunc)%ad %C(auto,green)%<(25,trunc)%aN%C(auto,reset)%s%C(auto,red)% gD% D" --date=short > "build/install-arm64/share/$CI_PROJECT_NAME.log" + when: always + rules: + - if: '$ENABLE_WINDOWS_ARM64 == "1" && $CI_COMMIT_TAG == null' + - when: never + tags: + - windows-arm64 + # Requires PR A's published windows-builder-arm64 artifact/digest and a + # native/virtual Windows Arm64 GitLab runner (design-spec.md + # release-infrastructure surface). Does not weaken or replace the + # existing windows-builder-x64/x86 jobs above. + allow_failure: true + windows-builder-x86: stage: build-libopenshot artifacts: diff --git a/ci/test_validate_arm64_architecture.py b/ci/test_validate_arm64_architecture.py new file mode 100644 index 000000000..ace415d20 --- /dev/null +++ b/ci/test_validate_arm64_architecture.py @@ -0,0 +1,155 @@ +# SPDX-FileCopyrightText: 2026 OpenShot Studios, LLC +# SPDX-License-Identifier: LGPL-3.0-or-later + +import contextlib +import importlib.util +import io +import os +import struct +import sys +import tempfile +import unittest +from unittest import mock + +VALIDATOR_PATH = os.path.join(os.path.dirname(__file__), "validate_arm64_architecture.py") +SPEC = importlib.util.spec_from_file_location("validate_arm64_architecture", VALIDATOR_PATH) +if SPEC is None or SPEC.loader is None: + raise RuntimeError("Unable to load validator from %s" % VALIDATOR_PATH) +validator = importlib.util.module_from_spec(SPEC) +SPEC.loader.exec_module(validator) + + +def write_pe(path, machine): + data = bytearray(0x80) + data[:2] = b"MZ" + struct.pack_into(" + +#if defined(_WIN32) +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#ifndef NOMINMAX +#define NOMINMAX +#endif +#include +#endif + +// This test validates design-amendment-A1's approved native-process oracle +// semantics directly against the running test host: +// - pNativeMachine must equal IMAGE_FILE_MACHINE_ARM64 (0xAA64) for a +// native Arm64 host. +// - pProcessMachine must equal IMAGE_FILE_MACHINE_UNKNOWN (0x0) for a +// process that is running natively (not under WOW64/emulation). +// - Any nonzero pProcessMachine indicates WOW/emulated execution and is +// reported, never silently treated as a pass. +// +// This test intentionally does NOT assert host architecture except in a +// native Arm64 build. It captures observed values for assertion diagnostics: on this +// AMD64 development/CI host it demonstrates the API and reports +// native_machine == AMD64 (not ARM64), which is expected and does not +// constitute an Arm64 release claim. Only on an actual native Arm64 host +// would native_arm64_ok become true. +TEST_CASE( "NativeArm64ProcessOracle_A1", "[libopenshot][windows][arm64]" ) +{ +#if defined(_WIN32) + // IsWow64Process2 requires Windows 10 1809 (build 17763) or later. + HMODULE kernel32 = ::GetModuleHandleW(L"kernel32.dll"); + REQUIRE(kernel32 != nullptr); + + using IsWow64Process2Fn = BOOL (WINAPI*)(HANDLE, USHORT*, USHORT*); + auto pIsWow64Process2 = reinterpret_cast( + ::GetProcAddress(kernel32, "IsWow64Process2")); + + if (!pIsWow64Process2) { + WARN("IsWow64Process2 is unavailable on this Windows build " + "(requires 10.0.17763+); native-process oracle skipped."); + return; + } + + USHORT processMachine = IMAGE_FILE_MACHINE_UNKNOWN; + USHORT nativeMachine = IMAGE_FILE_MACHINE_UNKNOWN; + ::SetLastError(ERROR_SUCCESS); + BOOL ok = pIsWow64Process2(::GetCurrentProcess(), &processMachine, &nativeMachine); + const DWORD lastError = ::GetLastError(); + INFO("GetLastError=" << lastError); + REQUIRE(ok); + + const bool isWowOrEmulated = (processMachine != IMAGE_FILE_MACHINE_UNKNOWN); + const bool nativeArm64Ok = + (nativeMachine == IMAGE_FILE_MACHINE_ARM64) && + (processMachine == IMAGE_FILE_MACHINE_UNKNOWN); + + INFO("process_machine=0x" << std::hex << processMachine); + INFO("native_machine=0x" << std::hex << nativeMachine); + INFO("is_wow_or_emulated=" << isWowOrEmulated); + INFO("native_arm64_ok=" << nativeArm64Ok); + if (isWowOrEmulated) { + WARN("Process is running under WOW/emulation."); + } + // On an Arm64 host, any nonzero process machine is WOW/emulated and must + // fail. Other hosts only prove that they are not native Arm64. + if (nativeMachine == IMAGE_FILE_MACHINE_ARM64) { + REQUIRE_FALSE(isWowOrEmulated); + REQUIRE(nativeArm64Ok); + } else { + CHECK_FALSE(nativeArm64Ok); + } +#else + WARN("IsWow64Process2 is a Windows-only API; native-process oracle skipped on this platform."); +#endif +}