Merged pull request mongodb#764

Author: derickr

.appveyor.yml

@@ -0,0 +1,61 @@
+image: Visual Studio 2015
+version: '{branch}.{build}'
+
+cache:
+  - c:\build-cache -> .appveyor.yml, .appveyor\*.cmd
+
+environment:
+  PHP_BUILD_CACHE_BASE_DIR: c:\build-cache
+  PHP_BUILD_OBJ_DIR: c:\obj
+  PHP_BUILD_CACHE_SDK_DIR: c:\build-cache\sdk
+  PHP_BUILD_SDK_BRANCH: php-sdk-2.1.1
+  SDK_REMOTE: https://github.com/OSTC/php-sdk-binary-tools.git
+  SDK_BRANCH: php-sdk-2.1.1
+
+  matrix:
+    - PHP_REL: 7.2
+      ARCHITECTURE: x64
+      ZTS_STATE: enable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
+      PHP_BUILD_CRT: vc15
+    - PHP_REL: 7.2
+      ARCHITECTURE: x64
+      ZTS_STATE: disable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
+      PHP_BUILD_CRT: vc15
+    - PHP_REL: 7.2
+      ARCHITECTURE: x86
+      ZTS_STATE: enable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
+      PHP_BUILD_CRT: vc15
+    - PHP_REL: 7.2
+      ARCHITECTURE: x86
+      ZTS_STATE: disable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
+      PHP_BUILD_CRT: vc15
+    - PHP_REL: 7.1
+      ARCHITECTURE: x64
+      ZTS_STATE: enable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
+      PHP_BUILD_CRT: vc14
+    - PHP_REL: 7.1
+      ARCHITECTURE: x86
+      ZTS_STATE: disable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
+      PHP_BUILD_CRT: vc14
+    - PHP_REL: 7.0
+      ARCHITECTURE: x64
+      ZTS_STATE: disable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
+      PHP_BUILD_CRT: vc14
+    - PHP_REL: 7.0
+      ARCHITECTURE: x86
+      ZTS_STATE: enable
+      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
+      PHP_BUILD_CRT: vc14
+
+install:
+  - .appveyor\install.cmd
+
+build_script:
+  - .appveyor\build.cmd

.appveyor/build.cmd

@@ -0,0 +1,15 @@
+@echo off
+
+setlocal enableextensions enabledelayedexpansion
+	set SDK_RUNNER=%PHP_BUILD_CACHE_SDK_DIR%\phpsdk-%PHP_BUILD_CRT%-%ARCHITECTURE%.bat
+	if not exist "!SDK_RUNNER!" (
+		echo "!SDK_RUNNER!" doesn't exist
+		exit /b 3
+	)
+
+	cmd /c !SDK_RUNNER! -t %APPVEYOR_BUILD_FOLDER%\.appveyor\build_task.cmd
+
+	if %errorlevel% neq 0 exit /b 3
+endlocal
+
+exit /b 0

.appveyor/build_task.cmd

@@ -0,0 +1,73 @@
+@echo off
+setlocal enableextensions enabledelayedexpansion
+
+	cd /D %APPVEYOR_BUILD_FOLDER%
+	if %errorlevel% neq 0 exit /b 3
+
+	set STABILITY=staging
+	set DEPS_DIR=%PHP_BUILD_CACHE_BASE_DIR%\deps-%PHP_REL%-%PHP_SDK_VC%-%PHP_SDK_ARCH%
+	rem SDK is cached, deps info is cached as well
+	echo Updating dependencies in %DEPS_DIR%
+	cmd /c phpsdk_deps --update --no-backup --branch %PHP_REL% --stability %STABILITY% --deps %DEPS_DIR%
+	if %errorlevel% neq 0 exit /b 3
+
+	rem Something went wrong, most likely when concurrent builds were to fetch deps
+	rem updates. It might be, that some locking mechanism is needed.
+	if not exist "%DEPS_DIR%" (
+		cmd /c phpsdk_deps --update --force --no-backup --branch %PHP_REL% --stability %STABILITY% --deps %DEPS_DIR%
+	)
+	if %errorlevel% neq 0 exit /b 3
+
+	if "%ZTS_STATE%"=="enable" set ZTS_SHORT=ts
+	if "%ZTS_STATE%"=="disable" set ZTS_SHORT=nts
+	if "%ZTS_STATE%"=="enable" set ZTS_IN_FILENAME=
+	if "%ZTS_STATE%"=="disable" set ZTS_IN_FILENAME=-nts
+	if "%PHP_SDK_ARCH%"=="x86" set ARCH_IN_FILENAME=
+	if "%PHP_SDK_ARCH%"=="x64" set ARCH_IN_FILENAME=-x86_64
+
+	cd /d C:\projects\php-src
+
+	cmd /c buildconf.bat --force
+
+	if %errorlevel% neq 0 exit /b 3
+
+	cmd /c configure.bat --disable-all --with-mp=auto --enable-cli --%ZTS_STATE%-zts --enable-json --with-openssl --enable-mongodb=shared --enable-object-out-dir=%PHP_BUILD_OBJ_DIR% --with-config-file-scan-dir=%APPVEYOR_BUILD_FOLDER%\build\modules.d --with-prefix=%APPVEYOR_BUILD_FOLDER%\build --with-php-build=%DEPS_DIR%
+
+	if %errorlevel% neq 0 exit /b 3
+
+	nmake /NOLOGO
+	if %errorlevel% neq 0 exit /b 3
+
+	nmake install
+
+	if %errorlevel% neq 0 exit /b 3
+
+	mkdir c:\tests_tmp
+	set TEST_PHP_EXECUTABLE=%APPVEYOR_BUILD_FOLDER%\build\php.exe
+	set TEST_PHP_JUNIT=c:\tests_tmp\tests-junit.xml
+	if "%OPCACHE%" equ "1" set TEST_PHP_ARGS=!TEST_PHP_ARGS! -d extension=%APPVEYOR_BUILD_FOLDER%\build\ext\php_opcache.so -d opcache.enable=1 -d opcache.enable_cli=1
+	set TEST_PHP_ARGS=-n -d -foo=1 -d extension=%APPVEYOR_BUILD_FOLDER%\build\ext\php_mongodb.dll -dxdebug.remote_enable=1
+	set SKIP_SLOW_TESTS=1
+	set SKIP_DBGP_TESTS=1
+	set SKIP_IPV6_TESTS=1
+	set REPORT_EXIT_STATUS=1
+	echo !TEST_PHP_EXECUTABLE! !TEST_PHP_ARGS! -v
+	echo !TEST_PHP_EXECUTABLE! -n run-tests.php -q -x --show-diff --show-slow 1000 --set-timeout 120 -g FAIL,XFAIL,BORK,WARN,LEAK,SKIP --temp-source c:\tests_tmp --temp-target c:\tests_tmp %APPVEYOR_BUILD_FOLDER%\tests
+	!TEST_PHP_EXECUTABLE! !TEST_PHP_ARGS! -v
+	!TEST_PHP_EXECUTABLE! -n run-tests.php -q -x --show-diff %APPVEYOR_BUILD_FOLDER%\tests
+
+	set EXIT_CODE=%errorlevel%
+	powershell -Command "$wc = New-Object 'System.Net.WebClient'; $wc.UploadFile('https://ci.appveyor.com/api/testresults/junit/%APPVEYOR_JOB_ID%', 'c:\tests_tmp\tests-junit.xml')"
+
+	rem We have run the tests, but we're *not* making that fail the build — yet
+	rem if %EXIT_CODE% neq 0 exit /b 3
+
+	cd /d %APPVEYOR_BUILD_FOLDER%
+
+	if not exist "%APPVEYOR_BUILD_FOLDER%\build\ext\php_mongodb.dll" exit /b 3
+
+	xcopy %APPVEYOR_BUILD_FOLDER%\LICENSE %APPVEYOR_BUILD_FOLDER%\php_mongodb-%PHP_REL%-!ZTS_SHORT!-%PHP_BUILD_CRT%-%PHP_SDK_ARCH%\ /y /f
+	echo F|xcopy %APPVEYOR_BUILD_FOLDER%\build\ext\php_mongodb.dll %APPVEYOR_BUILD_FOLDER%\php_mongodb-%PHP_REL%-!ZTS_SHORT!-%PHP_BUILD_CRT%-%PHP_SDK_ARCH%\php_mongodb-%APPVEYOR_REPO_TAG_NAME%-%PHP_REL%-%PHP_BUILD_CRT%!ZTS_IN_FILENAME!!ARCH_IN_FILENAME!.dll /y /f
+	7z a php_mongodb-%APPVEYOR_REPO_TAG_NAME%-%PHP_REL%-%PHP_BUILD_CRT%!ZTS_IN_FILENAME!!ARCH_IN_FILENAME!.zip %APPVEYOR_BUILD_FOLDER%\php_mongodb-%PHP_REL%-!ZTS_SHORT!-%PHP_BUILD_CRT%-%PHP_SDK_ARCH%\*
+	appveyor PushArtifact php_mongodb-%APPVEYOR_REPO_TAG_NAME%-%PHP_REL%-%PHP_BUILD_CRT%!ZTS_IN_FILENAME!!ARCH_IN_FILENAME!.zip -FileName php_mongodb-%APPVEYOR_REPO_TAG_NAME%-%PHP_REL%-%PHP_BUILD_CRT%!ZTS_IN_FILENAME!!ARCH_IN_FILENAME!.zip
+endlocal

.appveyor/install.cmd

@@ -0,0 +1,63 @@
+@echo off
+setlocal enableextensions enabledelayedexpansion
+	cinst wget
+
+	if not exist "%PHP_BUILD_CACHE_BASE_DIR%" (
+		echo Creating %PHP_BUILD_CACHE_BASE_DIR%
+		mkdir "%PHP_BUILD_CACHE_BASE_DIR%"
+	)
+
+	if not exist "%PHP_BUILD_OBJ_DIR%" (
+		echo Creating %PHP_BUILD_OBJ_DIR%
+		mkdir "%PHP_BUILD_OBJ_DIR%"
+	)
+
+	if not exist "%PHP_BUILD_CACHE_SDK_DIR%" (
+		echo Cloning remote SDK repository
+		git clone -q --depth=1 --branch %SDK_BRANCH% %SDK_REMOTE% "%PHP_BUILD_CACHE_SDK_DIR%"
+	) else (
+		echo Fetching remote SDK repository
+		git --git-dir="%PHP_BUILD_CACHE_SDK_DIR%\.git" --work-tree="%PHP_BUILD_CACHE_SDK_DIR%" fetch --prune origin 2>&1
+		echo Checkout SDK repository branch
+		git --git-dir="%PHP_BUILD_CACHE_SDK_DIR%\.git" --work-tree="%PHP_BUILD_CACHE_SDK_DIR%" checkout --force %SDK_BRANCH%
+	)
+
+	if "%PHP_REL%"=="master" (
+		echo Cloning PHP master repository
+		git clone -q --depth=1 --branch=%PHP_REL% https://github.com/php/php-src C:\projects\php-src
+	) else (
+		echo Cloning PHP %PHP_REL% repository
+		git clone -q --depth=1 --branch=PHP-%PHP_REL% https://github.com/php/php-src C:\projects\php-src
+	)
+
+	echo "Runnning sub-module fetch"
+	git submodule update --init --recursive
+
+	xcopy %APPVEYOR_BUILD_FOLDER% C:\projects\php-src\ext\mongodb\ /s /e /y /q
+
+	xcopy %APPVEYOR_BUILD_FOLDER%\LICENSE %APPVEYOR_BUILD_FOLDER%\artifacts\ /y /f /q
+
+	if "%APPVEYOR%" equ "True" rmdir /s /q C:\cygwin >NUL 2>NUL
+	if %errorlevel% neq 0 exit /b 3
+	if "%APPVEYOR%" equ "True" rmdir /s /q C:\cygwin64 >NUL 2>NUL
+	if %errorlevel% neq 0 exit /b 3
+	if "%APPVEYOR%" equ "True" rmdir /s /q C:\mingw >NUL 2>NUL
+	if %errorlevel% neq 0 exit /b 3
+	if "%APPVEYOR%" equ "True" rmdir /s /q C:\mingw-w64 >NUL 2>NUL
+	if %errorlevel% neq 0 exit /b 3
+
+	if "%APPVEYOR_REPO_TAG_NAME%"=="" (
+		set APPVEYOR_REPO_TAG_NAME=%APPVEYOR_REPO_BRANCH%-%APPVEYOR_REPO_COMMIT:~0,8%
+		for /f "delims=" %%l in (phongo_version.h) do (
+			if not "%%l"=="" (
+				set line=%%l
+				if "!line:~8,20!"=="PHP_MONGODB_VERSION " (
+					set APPVEYOR_REPO_TAG_NAME=!line:~29,-1!-%APPVEYOR_REPO_BRANCH%-%APPVEYOR_REPO_COMMIT:~0,8%
+				)
+			)
+		)
+		echo Final repo tag name: !APPVEYOR_REPO_TAG_NAME!
+
+		appveyor SetVariable -Name APPVEYOR_REPO_TAG_NAME -Value !APPVEYOR_REPO_TAG_NAME!
+	)
+endlocal

CONTRIBUTING.md

@@ -150,31 +150,36 @@ changes in this maintenance branch. This is important because we will later
 merge the ensuing release commits up to master with `--strategy=ours`, which
 will ignore changes from the merged commits.
 
-Update the version and stability constants in `php_phongo.h`. This should entail
-removing the version's "-dev" suffix and changing the stability to "stable":
+Update the version and stability constants in `phongo_version.h`. This should
+entail removing the version's "-dev" suffix, changing the stability to
+"stable", and increasing the last digit for `PHP_MONGO_VERSION_DESC`:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8-dev"
 #define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,0
 ```
 
 The above would be changed to:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8"
 #define PHP_MONGODB_STABILITY "stable"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,1
 ```
 
 The Makefile targets for creating the PECL package depend on these constants, so
-you must rebuild the extension after updating `php_phongo.h`.
+you must rebuild the extension after updating `phongo_version.h`.
 
 > **Note:** If this is an alpha or beta release, the version string should
 > include the X.Y.Z version followed by the stability and an increment. For
 > instance, the first beta release in the 1.4.0 series would be "1.4.0beta1".
 > Alpha and beta releases use "alpha" and "beta" stability strings,
 > respectively. Release candidates (e.g. "1.4.0RC1") also use "beta" stability.
 > See [Documenting release stability and API stability](https://pear.php.net/manual/en/guide.developers.package2.stability.php)
-> for more information.
+> for more information. For each change to the suffixes of
+> `PHP_MONGODB_VERSION`, increment the last digit of
+> `PHP_MONGODB_VERSION_DESC`.
 
 ### Publish PECL package
 
@@ -195,10 +200,10 @@ one chance to confirm the package information after uploading.
 
 ### Commit version update and release notes
 
-Commit the modified `php_phongo.h` file as "Package X.Y.Z"
+Commit the modified `phongo_version.h` file as "Package X.Y.Z"
 
 ```
-$ git add php_phongo.h
+$ git add phongo_version.h
 $ git commit -m "Package X.Y.Z"
 ```
 
@@ -212,25 +217,27 @@ $ git tag -a -m "Release X.Y.Z" X.Y.Z
 
 ### Update version info back to dev
 
-After tagging, the version and stability constants in `php_phongo.h` should be
+After tagging, the version and stability constants in `phongo_version.h` should be
 updated back to development status.
 
 ```
 #define PHP_MONGODB_VERSION "1.1.8"
 #define PHP_MONGODB_STABILITY "stable"
+#define PHP_MONGODB_VERSION_DESC 1,1,8,1
 ```
 
 The above would be changed to:
 
 ```
 #define PHP_MONGODB_VERSION "1.1.9-dev"
 #define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,1,9,0
 ```
 
 Commit this change:
 
 ```
-$ git commit -m "Back to -dev" php_phongo.h
+$ git commit -m "Back to -dev" phongo_version.h
 ```
 
 > **Note:** If this is an alpha, beta, or RC release, the version string should

CREDITS

@@ -1,2 +1,2 @@
 MongoDB Driver for PHP
-Hannes Magnusson, Jeremy Mikola, Derick Rethans
+Hannes Magnusson, Jeremy Mikola, Derick Rethans, Katherine Walker

phongo_version.h

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2014-2018 MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef PHONGO_VERSION_H
+#define PHONGO_VERSION_H
+
+#define PHP_MONGODB_VERSION "1.5.0-dev"
+#define PHP_MONGODB_STABILITY "devel"
+#define PHP_MONGODB_VERSION_DESC 1,5,0,0
+
+#endif  /* PHONGO_VERSION_H */

php_phongo.h

@@ -21,16 +21,13 @@
 #include "bson.h"
 #include "mongoc.h"
 
+#include "phongo_version.h"
 #include "phongo_compat.h"
 #include "php_phongo_classes.h"
 
 #define phpext_mongodb_ptr &mongodb_module_entry
 extern zend_module_entry mongodb_module_entry;
 
-/* FIXME: Its annoying to bump version. Move into phongo_version.h.in */
-#define PHP_MONGODB_VERSION "1.5.0-dev"
-#define PHP_MONGODB_STABILITY "devel"
-
 /* Structure for persisted libmongoc clients. The PID is included to ensure that
  * processes do not destroy clients created by other processes (relevant for
  * forking). We avoid using pid_t for Windows compatibility. */