Merge pull request #753 from pq-code-package/ci_expand

CI: Add further Windows and MacOS tests
pq-code-package · Feb 6, 2025 · 94c8b47 · 94c8b47 · oqs-bot · Feb 6, 2025
2 parents e16cf03 + 668c1fb
commit 94c8b47
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 10 deletions.
diff --git a/.github/actions/setup-brew/action.yml b/.github/actions/setup-brew/action.yml
@@ -0,0 +1,30 @@
+# SPDX-License-Identifier: Apache-2.0
+
+name: Dependencies (apt)
+description: Install dependencies via brew
+
+inputs:
+  packages:
+    description: Space-separated list of additional packages to install
+    required: false
+    default: ''
+  sudo:
+    required: false
+    default: 'sudo'
+
+runs:
+  using: composite
+  steps:
+    - name: Update package repository
+      shell: bash
+      run: |
+        brew update
+    - name: Install base packages
+      shell: bash
+      run: |
+        brew install make python3
+    - name: Install additional packages
+      if: ${{ inputs.packages != ''}}
+      shell: bash
+      run: |
+        brew install ${{ inputs.packages }}
diff --git a/.github/actions/setup-os/action.yml b/.github/actions/setup-os/action.yml
@@ -20,6 +20,8 @@ runs:
       run: |
         if (which yum > /dev/null); then
            echo PKG="yum" >> $GITHUB_ENV
+        elif (which brew > /dev/null); then
+           echo PKG="brew" >> $GITHUB_ENV
         elif (which apt > /dev/null); then
            echo PKG="apt" >> $GITHUB_ENV
         fi
@@ -35,3 +37,9 @@ runs:
       with:
         packages: ${{ inputs.packages }}
         sudo: ${{ inputs.sudo }}
+    - name: Setup via brew
+      if: ${{ env.PKG == 'brew' }}
+      uses: ./.github/actions/setup-brew
+      with:
+        packages: ${{ inputs.packages }}
+        sudo: ${{ inputs.sudo }}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -46,6 +46,10 @@ jobs:
            name: 'aarch64'
          - runner: ubuntu-latest
            name: 'x86_64'
+         - runner: macos-latest
+           name: 'macos (aarch64)'
+         - runner: macos-13
+           name: 'macos (x86_64)'
         exclude:
           - {external: true,
              target: {
@@ -61,7 +65,7 @@ jobs:
           OPT=0 make quickcheck
           make clean >/dev/null
           OPT=1 make quickcheck
-      - uses: ./.github/actions/setup-apt
+      - uses: ./.github/actions/setup-os
       - name: tests func
         run: |
           ./scripts/tests func
@@ -114,8 +118,12 @@ jobs:
         run: |
           ./scripts/check-namespace
   quickcheck-windows:
-    name: Quickcheck windows-latest
-    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        system: [windows-latest, windows-2022, windows-2019]
+    name: Quickcheck ${{ matrix.system }}
+    runs-on: ${{ matrix.system }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
@@ -129,7 +137,7 @@ jobs:
     name: Quickcheck lib
     strategy:
       matrix:
-        system: [macos-latest, ubuntu-latest, pqcp-arm64]
+        system: [macos-latest, macos-13, ubuntu-latest, pqcp-arm64]
     runs-on: ${{ matrix.system }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -140,7 +148,7 @@ jobs:
     name: Examples
     strategy:
       matrix:
-        system: [macos-latest, ubuntu-latest, pqcp-arm64]
+        system: [macos-latest, macos-13, ubuntu-latest, pqcp-arm64]
     runs-on: ${{ matrix.system }}
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -218,7 +226,11 @@ jobs:
          - ${{ github.repository_owner != 'pq-code-package' }}
         target:
          - runner: macos-latest
-           name: 'MacOS'
+           name: 'MacOS (aarch64)'
+           arch: mac
+           mode: native
+         - runner: macos-13
+           name: 'MacOS (x86_64)'
            arch: mac
            mode: native
          - runner: pqcp-arm64

diff --git a/Makefile.Microsoft_nmake b/Makefile.Microsoft_nmake
@@ -3,16 +3,19 @@
 CFLAGS = /nologo /O2 /Imlkem /Imlkem/fips202 /Imlkem/fips202/native /Imlkem/sys /Imlkem/native
 
 OBJ_FILES = .\mlkem\*.obj \
-            .\mlkem\fips202\*.obj \
+            .\mlkem\fips202\*.obj
 
 BUILD_DIR = test\build
 MLKEM512_BUILD_DIR = $(BUILD_DIR)\mlkem512
 MLKEM768_BUILD_DIR = $(BUILD_DIR)\mlkem768
 MLKEM1024_BUILD_DIR = $(BUILD_DIR)\mlkem1024
 
-OBJ_FILES_512 = $(subst .\,$(MLKEM512_BUILD_DIR)\,$(OBJ_FILES))
-OBJ_FILES_768 = $(subst .\,$(MLKEM768_BUILD_DIR)\,$(OBJ_FILES))
-OBJ_FILES_1024 = $(subst .\,$(MLKEM1024_BUILD_DIR)\,$(OBJ_FILES))
+OBJ_FILES_512 = $(MLKEM512_BUILD_DIR)\mlkem\*.obj \
+                $(MLKEM512_BUILD_DIR)\mlkem\fips202\*.obj
+OBJ_FILES_768 = $(MLKEM768_BUILD_DIR)\mlkem\*.obj \
+                $(MLKEM768_BUILD_DIR)\mlkem\fips202\*.obj
+OBJ_FILES_1024 = $(MLKEM1024_BUILD_DIR)\mlkem\*.obj \
+                 $(MLKEM1024_BUILD_DIR)\mlkem\fips202\*.obj
 
 # NOTE: We currently only build code for non-opt code, as we haven't yet made the assembly compatible on Windows
 !IFNDEF OPT
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`28965` cycles	`28966` cycles	`1.00`
`ML-KEM-512 encaps`	`34252` cycles	`34252` cycles	`1`
`ML-KEM-512 decaps`	`44728` cycles	`44728` cycles	`1`
`ML-KEM-768 keypair`	`49307` cycles	`49307` cycles	`1`
`ML-KEM-768 encaps`	`54571` cycles	`54569` cycles	`1.00`
`ML-KEM-768 decaps`	`69426` cycles	`69425` cycles	`1.00`
`ML-KEM-1024 keypair`	`71915` cycles	`71914` cycles	`1.00`
`ML-KEM-1024 encaps`	`80618` cycles	`80609` cycles	`1.00`
`ML-KEM-1024 decaps`	`100358` cycles	`100360` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`9314` cycles	`9292` cycles	`1.00`
`ML-KEM-512 encaps`	`10833` cycles	`10772` cycles	`1.01`
`ML-KEM-512 decaps`	`14762` cycles	`14728` cycles	`1.00`
`ML-KEM-768 keypair`	`16125` cycles	`15936` cycles	`1.01`
`ML-KEM-768 encaps`	`17222` cycles	`17258` cycles	`1.00`
`ML-KEM-768 decaps`	`23277` cycles	`22956` cycles	`1.01`
`ML-KEM-1024 keypair`	`21371` cycles	`21323` cycles	`1.00`
`ML-KEM-1024 encaps`	`23306` cycles	`23257` cycles	`1.00`
`ML-KEM-1024 decaps`	`30896` cycles	`30776` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`29371` cycles	`29630` cycles	`0.99`
`ML-KEM-512 encaps`	`34937` cycles	`35307` cycles	`0.99`
`ML-KEM-512 decaps`	`45404` cycles	`45941` cycles	`0.99`
`ML-KEM-768 keypair`	`47083` cycles	`47097` cycles	`1.00`
`ML-KEM-768 encaps`	`55467` cycles	`55511` cycles	`1.00`
`ML-KEM-768 decaps`	`67463` cycles	`67551` cycles	`1.00`
`ML-KEM-1024 keypair`	`71606` cycles	`71741` cycles	`1.00`
`ML-KEM-1024 encaps`	`81980` cycles	`82085` cycles	`1.00`
`ML-KEM-1024 decaps`	`99279` cycles	`99388` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`15930` cycles	`15923` cycles	`1.00`
`ML-KEM-512 encaps`	`18001` cycles	`18002` cycles	`1.00`
`ML-KEM-512 decaps`	`24514` cycles	`24513` cycles	`1.00`
`ML-KEM-768 keypair`	`27359` cycles	`27356` cycles	`1.00`
`ML-KEM-768 encaps`	`28918` cycles	`28916` cycles	`1.00`
`ML-KEM-768 decaps`	`38352` cycles	`38328` cycles	`1.00`
`ML-KEM-1024 keypair`	`36955` cycles	`36971` cycles	`1.00`
`ML-KEM-1024 encaps`	`39871` cycles	`39900` cycles	`1.00`
`ML-KEM-1024 decaps`	`52380` cycles	`52416` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`17730` cycles	`17729` cycles	`1.00`
`ML-KEM-512 encaps`	`20979` cycles	`20981` cycles	`1.00`
`ML-KEM-512 decaps`	`27658` cycles	`27658` cycles	`1`
`ML-KEM-768 keypair`	`30519` cycles	`30516` cycles	`1.00`
`ML-KEM-768 encaps`	`33426` cycles	`33423` cycles	`1.00`
`ML-KEM-768 decaps`	`42976` cycles	`42976` cycles	`1`
`ML-KEM-1024 keypair`	`44139` cycles	`44139` cycles	`1`
`ML-KEM-1024 encaps`	`49439` cycles	`49443` cycles	`1.00`
`ML-KEM-1024 decaps`	`62362` cycles	`62362` cycles	`1`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`16960` cycles	`16965` cycles	`1.00`
`ML-KEM-512 encaps`	`18692` cycles	`18662` cycles	`1.00`
`ML-KEM-512 decaps`	`24036` cycles	`24081` cycles	`1.00`
`ML-KEM-768 keypair`	`28708` cycles	`28717` cycles	`1.00`
`ML-KEM-768 encaps`	`29783` cycles	`29802` cycles	`1.00`
`ML-KEM-768 decaps`	`37567` cycles	`37586` cycles	`1.00`
`ML-KEM-1024 keypair`	`41708` cycles	`41789` cycles	`1.00`
`ML-KEM-1024 encaps`	`43976` cycles	`44072` cycles	`1.00`
`ML-KEM-1024 decaps`	`54287` cycles	`54297` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`11282` cycles	`11301` cycles	`1.00`
`ML-KEM-512 encaps`	`12844` cycles	`12847` cycles	`1.00`
`ML-KEM-512 decaps`	`17668` cycles	`17674` cycles	`1.00`
`ML-KEM-768 keypair`	`19634` cycles	`19643` cycles	`1.00`
`ML-KEM-768 encaps`	`20625` cycles	`20592` cycles	`1.00`
`ML-KEM-768 decaps`	`27639` cycles	`27657` cycles	`1.00`
`ML-KEM-1024 keypair`	`26296` cycles	`26289` cycles	`1.00`
`ML-KEM-1024 encaps`	`28183` cycles	`28177` cycles	`1.00`
`ML-KEM-1024 decaps`	`37611` cycles	`37610` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`35503` cycles	`35508` cycles	`1.00`
`ML-KEM-512 encaps`	`40647` cycles	`40646` cycles	`1.00`
`ML-KEM-512 decaps`	`51644` cycles	`51642` cycles	`1.00`
`ML-KEM-768 keypair`	`58480` cycles	`58486` cycles	`1.00`
`ML-KEM-768 encaps`	`65246` cycles	`65245` cycles	`1.00`
`ML-KEM-768 decaps`	`80462` cycles	`80460` cycles	`1.00`
`ML-KEM-1024 keypair`	`88186` cycles	`88191` cycles	`1.00`
`ML-KEM-1024 encaps`	`96964` cycles	`96961` cycles	`1.00`
`ML-KEM-1024 decaps`	`116641` cycles	`116638` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`46437` cycles	`46469` cycles	`1.00`
`ML-KEM-512 encaps`	`54623` cycles	`54663` cycles	`1.00`
`ML-KEM-512 decaps`	`70298` cycles	`70389` cycles	`1.00`
`ML-KEM-768 keypair`	`76666` cycles	`76685` cycles	`1.00`
`ML-KEM-768 encaps`	`87243` cycles	`87366` cycles	`1.00`
`ML-KEM-768 decaps`	`107715` cycles	`107873` cycles	`1.00`
`ML-KEM-1024 keypair`	`112111` cycles	`112167` cycles	`1.00`
`ML-KEM-1024 encaps`	`126070` cycles	`126095` cycles	`1.00`
`ML-KEM-1024 decaps`	`152172` cycles	`152295` cycles	`1.00`
Benchmark suite	Current: `94c8b47`	Previous: `e16cf03`	Ratio
`ML-KEM-512 keypair`	`39593` cycles	`39488` cycles	`1.00`
`ML-KEM-512 encaps`	`47505` cycles	`47517` cycles	`1.00`
`ML-KEM-512 decaps`	`61785` cycles	`61796` cycles	`1.00`
`ML-KEM-768 keypair`	`63996` cycles	`63918` cycles	`1.00`
`ML-KEM-768 encaps`	`75296` cycles	`75275` cycles	`1.00`
`ML-KEM-768 decaps`	`93787` cycles	`94145` cycles	`1.00`
`ML-KEM-1024 keypair`	`95491` cycles	`95481` cycles	`1.00`
`ML-KEM-1024 encaps`	`108990` cycles	`108989` cycles	`1.00`
`ML-KEM-1024 decaps`	`132483` cycles	`132485` cycles	`1.00`