PHPC-2143: Build Windows DLLs with GitHub Actions (#1380)

jmikola · web-flow · commit 51f0dd539940 · 2022-11-21T10:09:46.000-05:00
* Fix APM and CSFLE tests for Windows CI

* Add Windows to GitHub CI and build DLLs for releases

* Add --enable-debug-pack configure opt to generate PDB files

* Reminder to check for Windows build artifacts before publishing releases

* Revise advice on publicizing releases
diff --git a/.github/workflows/get-build-dir.bat b/.github/workflows/get-build-dir.bat
@@ -0,0 +1,2 @@
+@ECHO OFF
+grep "BUILD_DIR=" Makefile | sed 's/BUILD_DIR=//g' | awk '{$1=$1};1'
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -51,7 +51,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: "actions/checkout@v2"
+        uses: "actions/checkout@v3"
         with:
           fetch-depth: 2
           submodules: true
@@ -78,3 +78,89 @@ jobs:
         run: TEST_PHP_ARGS="-q -x --show-diff -g FAIL,XFAIL,BORK,WARN,LEAK,SKIP" make test
         env:
           MONGODB_URI: ${{ steps.setup-mongodb.outputs.cluster-uri }}
+
+  windows-tests:
+    name: "Windows Tests"
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: cmd
+
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ windows-2019, windows-2022 ]
+        php: [ "7.2", "7.3", "8.0", "8.1", "8.2" ]
+        arch: [ x64, x86 ]
+        ts: [ ts, nts ]
+        exclude:
+          - { os: windows-2019, php: "8.2" }
+          - { os: windows-2019, php: "8.1" }
+          - { os: windows-2019, php: "8.0" }
+          - { os: windows-2019, php: "7.4" }
+          - { os: windows-2019, php: "7.3" }
+          - { os: windows-2022, php: "7.2" }
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: true
+
+      - name: Setup PHP SDK
+        id: setup-php
+        uses: cmb69/setup-php-sdk@v0.6
+        with:
+          version: ${{ matrix.php }}
+          arch: ${{ matrix.arch }}
+          ts: ${{ matrix.ts }}
+          deps: openssl
+
+      - name: Enable Developer Command Prompt
+        uses: ilammy/msvc-dev-cmd@v1
+        with:
+          arch: ${{ matrix.arch }}
+          toolset: ${{ steps.setup-php.outputs.toolset }}
+
+      - name: phpize
+        run: phpize
+
+      - name: configure
+        run: configure --enable-mongodb --with-mongodb-sasl=yes --with-mongodb-client-side-encryption=yes --enable-debug-pack --with-prefix=${{ steps.setup-php.outputs.prefix }}
+
+      - name: nmake
+        run: nmake /nologo
+
+      - name: Start MongoDB
+        run: |
+          sc config MongoDB start= auto
+          sc start MongoDB
+
+      - name: Wait until MongoDB is available
+        run: .github/workflows/wait-for-mongodb.bat
+
+      - name: Run Tests
+        run: nmake /nologo test
+        env:
+          NO_INTERACTION: 1
+          REPORT_EXIT_STATUS: 1
+          TESTS: --show-diff
+
+      - name: Copy DLL and PDB files to CWD
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          cp .github/workflows/get-build-dir.bat .
+          for /F "usebackq tokens=*" %%i in (`get-build-dir.bat`) do set BUILD_DIR=%%i
+          echo BUILD_DIR=%BUILD_DIR%
+          cp %BUILD_DIR%\php_mongodb.dll .
+          cp %BUILD_DIR%\php_mongodb.pdb .
+
+      - name: Upload DLL and PDB files as build artifacts
+        if: ${{ github.event_name == 'push' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: php_mongodb-${{ github.sha }}-${{ matrix.php }}-${{ matrix.ts }}-${{ matrix.arch }}
+          path: |
+            php_mongodb.dll
+            php_mongodb.pdb
+          retention-days: 3
diff --git a/.github/workflows/wait-for-mongodb.bat b/.github/workflows/wait-for-mongodb.bat
@@ -0,0 +1,4 @@
+@ECHO OFF
+:repeat
+powershell -nop -c "& {sleep 1}"
+mongo --quiet --eval 'db.runCommand({ping:1})' || goto :repeat
diff --git a/.github/workflows/windows-release-build.yml b/.github/workflows/windows-release-build.yml
@@ -0,0 +1,37 @@
+name: "Windows Release Build"
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  windows-release-build:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Note: keep this in sync with the Windows matrix in tests.yml
+        php: [ "7.2", "7.3", "8.0", "8.1", "8.2" ]
+        arch: [ x64, x86 ]
+        ts: [ ts, nts ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Download DLL and PDB files
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          workflow: tests.yml
+          workflow_conclusion: success
+          commit: ${{ github.sha }}
+          # Note: keep this in sync with the uploaded artifact name in tests.yml
+          name: php_mongodb-${{ github.sha }}-${{ matrix.php }}-${{ matrix.ts }}-${{ matrix.arch }}
+
+      - name: Create and attach release archive
+        run: |
+          ARCHIVE=php_mongodb-${{ github.ref_name }}-${{ matrix.php }}-${{ matrix.ts }}-${{ matrix.arch }}.zip
+          zip $ARCHIVE php_mongodb.dll php_mongodb.pdb CREDITS CONTRIBUTING.md LICENSE README.md THIRD_PARTY_NOTICES
+          hub release edit -a $ARCHIVE -m "" $GITHUB_REF_NAME
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -284,19 +284,6 @@ generation script.
 The follow steps outline the release process for a maintenance branch (e.g.
 releasing the `vX.Y` branch as X.Y.Z).
 
-### Ensure PHP version compatibility
-
-Ensure that the library test suite completes on supported versions of PHP.
-
-### Ensure Windows compatibility
-
-PECL will create Windows DLLs for new releases; however, you must ensure that
-the extension successfully builds on Windows before releasing. Windows builds
-are tested by [AppVeyor](.appveyor.yml).
-
-See the [internals wiki](https://wiki.php.net/internals/windows/stepbystepbuild)
-for more information.
-
 ### Transition JIRA issues and version
 
 All issues associated with the release version should be in the "Closed" state
@@ -420,6 +407,21 @@ $ git push
 $ git push --tags
 ```
 
+### Ensure Windows build artifacts exist
+
+Windows builds are tested by GitHub Actions. Each successful build for a pushed
+commit will produce a build artifact consisting of DLL and PDB files for that
+environment (e.g. 8.0-nts-x64). These build artifacts are later used to create
+release assets (see:
+[windows-release-build.yml])(.github/workflows/windows-release-build.yml).
+Before publishing a release in GitHub, ensure that all Windows builds for the
+tag's commit have succeeded and that the necessary build artifacts have been
+created.
+
+Note: the "published" event applies to both releases and pre-releases. See
+[Events that trigger workflows: release](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release)
+for more details.
+
 ### Release PECL package
 
 The PECL package may be published via the
@@ -468,8 +470,7 @@ or update with:
 
     pecl upgrade mongodb-X.Y.Z
 
-Windows binaries are available on PECL:
-https://pecl.php.net/package/mongodb
+Windows binaries are attached to the GitHub release notes.
 ```
 
 > **Note:** If this is an alpha or beta release, the installation examples
@@ -492,7 +493,8 @@ Thanks for our community contributors for X.Y.Z:
  * [$CONTRIBUTOR_NAME](https://github.com/$GITHUB_USERNAME)
 ```
 
-Release announcements should also be posted in the [MongoDB Product & Driver Announcements: Driver Releases](https://www.mongodb.com/community/forums/tags/c/announcements/driver-releases/110/php) forum and shared on Twitter.
+Significant release announcements should also be posted in the
+[MongoDB Product & Driver Announcements: Driver Releases](https://www.mongodb.com/community/forums/tags/c/announcements/driver-releases/110/php) forum.
 
 ### Update compatibility tables in MongoDB docs
 
diff --git a/tests/apm/commandFailedEvent-001.phpt b/tests/apm/commandFailedEvent-001.phpt
@@ -2,7 +2,6 @@
 MongoDB\Driver\Monitoring\CommandFailedEvent
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php skip_if_appveyor(); /* TODO: PHPC-1613 */ ?>
 <?php skip_if_not_live(); ?>
 <?php skip_if_not_clean(); ?>
 --FILE--
@@ -16,6 +15,13 @@ class MySubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
     public function commandStarted( \MongoDB\Driver\Monitoring\CommandStartedEvent $event ): void
     {
         echo "started: ", $event->getCommandName(), "\n";
+
+        /* bson_get_monotonic_time() may only have 10-16 millisecond precision
+         * on Windows. Sleep to ensure that a non-zero value is reported for
+         * CommandFailedEvent's duration. */
+        if (PHP_OS_FAMILY === 'Windows') {
+            usleep(25000);
+        }
     }
 
     public function commandSucceeded( \MongoDB\Driver\Monitoring\CommandSucceededEvent $event ): void
diff --git a/tests/apm/commandSucceededEvent-001.phpt b/tests/apm/commandSucceededEvent-001.phpt
@@ -2,7 +2,6 @@
 MongoDB\Driver\Monitoring\CommandSucceededEvent
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php skip_if_appveyor(); /* TODO: PHPC-1613 */ ?>
 <?php skip_if_not_live(); ?>
 <?php skip_if_not_clean(); ?>
 --FILE--
@@ -16,6 +15,13 @@ class MySubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
     public function commandStarted( \MongoDB\Driver\Monitoring\CommandStartedEvent $event ): void
     {
         echo "started: ", $event->getCommandName(), "\n";
+
+        /* bson_get_monotonic_time() may only have 10-16 millisecond precision
+         * on Windows. Sleep to ensure that a non-zero value is reported for
+         * CommandSucceededEvent's duration. */
+        if (PHP_OS_FAMILY === 'Windows') {
+            usleep(25000);
+        }
     }
 
     public function commandSucceeded( \MongoDB\Driver\Monitoring\CommandSucceededEvent $event ): void
diff --git a/tests/manager/manager-ctor-auto_encryption-001.phpt b/tests/manager/manager-ctor-auto_encryption-001.phpt
@@ -2,7 +2,6 @@
 MongoDB\Driver\Manager::__construct(): autoEncryption options
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php skip_if_appveyor(); /* AppVeyor does not have mongocryptd installed */ ?>
 <?php skip_if_not_libmongocrypt(); ?>
 --FILE--
 <?php
@@ -12,6 +11,10 @@ require_once __DIR__ . '/../utils/basic.inc';
 $baseOptions = [
     'keyVaultNamespace' => CSFLE_KEY_VAULT_NS,
     'kmsProviders' => ['local' => ['key' => new MongoDB\BSON\Binary(CSFLE_LOCAL_KEY, 0)]],
+    /* Testing the schemaMap option requires either crypt_shared or mongocryptd
+     * for automatic encryption. Disable mongocryptd spawning to avoid a test
+     * failure if crypt_shared and mongocryptd are both unavailable. */
+    'extraOptions' => ['mongocryptdBypassSpawn' => true],
 ];
 
 $tests = [
@@ -40,7 +43,6 @@ $tests = [
             'bsonType' => 'object',
         ],
     ]],
-    ['extraOptions' => ['mongocryptdBypassSpawn' => true]],
 ];
 
 foreach ($tests as $autoEncryptionOptions) {
diff --git a/tests/utils/skipif.php b/tests/utils/skipif.php
@@ -479,13 +479,6 @@ function skip_if_no_mongo_orchestration()
     }
 }
 
-function skip_if_appveyor()
-{
-    if (getenv('APPVEYOR')) {
-        exit('skip Test cannot be run on AppVeyor');
-    }
-}
-
 function skip_if_crypt_shared()
 {
     // Intentionally ignore empty values for CRYPT_SHARED_LIB_PATH

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+@ECHO OFF`
	`2`	`+grep "BUILD_DIR=" Makefile \| sed 's/BUILD_DIR=//g' \| awk '{$1=$1};1'`
Original file line number	Diff line number	Diff line change
`@@ -479,13 +479,6 @@ function skip_if_no_mongo_orchestration()`
`479`	`479`	`}`
`480`	`480`	`}`
`481`	`481`
`482`		`-function skip_if_appveyor()`
`483`		`-{`
`484`		`- if (getenv('APPVEYOR')) {`
`485`		`- exit('skip Test cannot be run on AppVeyor');`
`486`		`- }`
`487`		`-}`
`488`		`-`
`489`	`482`	`function skip_if_crypt_shared()`
`490`	`483`	`{`
`491`	`484`	`// Intentionally ignore empty values for CRYPT_SHARED_LIB_PATH`