Developers who would like to contribute to the driver will need to build it from source. The repository may be initialized with:
$ git clone https://github.com/mongodb/mongo-php-driver.git
$ cd mongo-php-driver
$ git submodule update --init
The following script may be used to build the driver:
#!/bin/sh
phpize > /dev/null && \
./configure --enable-mongodb-developer-flags > /dev/null && \
make clean > /dev/null && make all > /dev/null && make install
The extension's test use the PHPT format from PHP internals. This format is documented in the following links:
Generally, most tests will be based on the following template:
--TEST--
Description of API or JIRA issue being tested
--SKIPIF--
<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
<?php /* One or more skip functions */ ?>
--FILE--
<?php
require_once __DIR__ . "/../utils/basic.inc";
// Test code
?>
===DONE===
<?php exit(0); ?>
--EXPECT--
===DONE===
The basic-skipif.inc and basic.inc files contain utility functions for the
SKIPIF and FILE sections, respectively. If those functions are not needed
(e.g. skip logic only depends on checking the PHP_INT_SIZE constant), the test
should not include the file. When it doubt, keep it simple.
The skipif.php file defines various helper functions
for use within a test's SKIPIF
section. When multiple functions are used in a single SKIPIF section, they
should be logically ordered:
- Any PHP environment requirements should be checked first. For example, if a
test requires a 64-bit architecture, start by checking
PHP_INT_SIZEbefore anything else. - Any extension build requirements (e.g.
skip_if_not_libmongoc_crypto()) or test environment requirements (e.g.skip_if_auth()) should then be checked. These functions only examine local information, such asphpinfo()output or the structure of theURIconstant, and do not interact with a remote MongoDB server. - Any remote server requirements should then be checked. A general integration
test that requires any type of remote server to be accessible might use
skip_if_not_live()while a test requiring a replica set would preferskip_if_not_replica_set(). - After requiring a remote server to be accessible (optionally with a specific type), you can enforce requirements about that server. This includes checking its server version, storage engine, availability of test commands, etc.
- Finally, use
skip_if_not_clean()if needed to ensure that the collection(s) under test are dropped before the test runs.
As a rule of thumb, your SKIPIF logic should be written to allow the test to
run in as many environments as possible. To paraphrase the
robustness principal:
Be conservative in what/how you test, and liberal in what environment you require
Consider that a well-crafted EXPECTF section may allow a SKIPIF section to
be less restrictive.
The test suite depends on Mongo Orchestration. Mongo Orchestration is an HTTP server that provides a REST API for maintaining MongoDB configurations. These configurations are provided by the drivers-evergreen-tools repository. These configurations can be run locally. Alternatively, you can use the GitHub Actions workflow if you don't want to set up a local development environment.
Mongo Orchestration expects that the mongod (and mongos) binaries are
available in the PATH.
Once installed, Mongo Orchestration can be started with
~/.local/bin/mongo-orchestration start --no-fork --enable-majority-read-concern
The test suite uses the MONGODB_URI environment variable as connection
string to run all tests. If not set, tests assume MongoDB is listening on the
default MongoDB port (27017) on localhost.
With this set-up, the tests can be run with make test.
If Mongo Orchestration is running on non-default settings, the
MONGO_ORCHESTRATION_URI environment variable can be used to specify where
mongo-orchestration is listening:
MONGO_ORCHESTRATION_URI=http://localhost:1234/v1 make test
The PHP driver can use either system libraries or bundled versions of libmongoc, libbson, and libmongocrypt. If a new version of either library is available, the submodule and build configuration will need to be updated to reflect the new sources and/or package version.
$ cd src/libmongoc
$ git fetch
$ git checkout 1.15.0
The build process for Autotools and Windows rely on
src/LIBMONGOC_VERSION_CURRENT to infer version information for libmongoc and
libbson. This file can be regenerated using the following Makefile target:
$ make libmongoc-version-current
Alternatively, the build/calc_release_version.py script in libmongoc can be
executed directly.
The Autotools and Windows build configurations (config.m4 and config.w32,
respectively) define several variables (e.g. PHP_MONGODB_MONGOC_SOURCES) that
collectively enumerate all of the the sources within the libmongoc submodule to
include in a bundled build.
These variables should each have a shell command in a preceding comment, which should be run to regenerate that particular list of source files. In the event that either libmongoc or libbson introduce a new source directory, that will need to be manually added (follow prior art).
The Autotools configuration additionally includes some pkg-config commands for
using libmongoc and libbson as system libraries (in lieu of a bundled build).
When bumping the libmongoc version, be sure to update the version check and
error message in the pkg-config blocks for both libmongoc and libbson.
For example, the following lines might be updated for libmongoc:
if $PKG_CONFIG libmongoc-1.0 --atleast-version 1.15.0; then
...
AC_MSG_ERROR(system libmongoc must be upgraded to version >= 1.15.0)
Evergreen tests against multiple versions of libmongoc. When updating to a newer
libmongoc version, make sure to update the libmongoc-version build axis in
.evergreen/config.yml. In general, we test against two additional versions of
libmongoc:
- The upcoming patch release of the current libmongoc minor version (e.g. the
r1.xbranch) - The upcoming minor release of libmongoc (e.g. the
masterbranch)
If either libmongoc or libbson introduce a new source directory, that may also
require updating the glob patterns in the bin/prep-release.php script to
ensure new source files will be included in any generated PECL package.
Verify that the upgrade was successful by ensuring that the driver can compile using both the bundled sources and system libraries for libmongoc and libbson, and by ensuring that the test suite passes. Once done, commit the changes to all of the above files/paths. For example:
$ git commit -m "Bump libmongoc to 1.15.0" config.m4 config.w32 src/libmongoc src/LIBMONGOC_VERSION_CURRENT
To update libmongocrypt, the steps are similar to the above:
$ cd src/libmongocrypt
$ git fetch
$ git checkout 1.0.1
$ make libmongocrypt-version-current
Package dependencies in config.m4 must also be updated, as do the sources in
the PECL 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 that the extension compiles on PHP 5.6 through the latest PHP 7.x release. Be sure to test both ZTS and non-ZTS builds for PHP 5.x.
PECL will create Windows DLLs for new releases; however, you must ensure that the extension successfully builds on Windows before releasing. Note that PHP 5.6 requires VS2012, while PHP 7.x requires VS2015.
Given the following assumptions:
- Build directory is
C:\php-sdk\ - Compiling for PHP 5.6 (VS2012 x86 Native Tools Command Prompt is running)
- Extension branch checked out in
C:\php-sdk\phpdev\vc11\x86\pecl\mongodb
The build process will resemble:
cd c:\php-sdk\
bin\phpsdk_setvars.bat
cd C:\php-sdk\phpdev\vc11\x86\php-5.6.12-src
nmake clean
buildconf --force
configure --disable-all --with-openssl --enable-cli --enable-json --enable-mongodb=shared --with-mongodb-sasl=yes --with-mongodb-client-side-encryption=yes
nmake
If the extension was successfully compiled, a php_mongodb.dll file should be
generated in the build directory (e.g. Release_TS). You should then verify
that the extension loads and executes properly:
cd Release_TS
php.exe -d extension=./php_mongodb.dll -m
php.exe -d extension=./php_mongodb.dll -r "var_dump(new MongoDB\Driver\Manager);"
See the internals wiki for more information.
All issues associated with the release version should be in the "Closed" state and have a resolution of "Fixed". Issues with other resolutions (e.g. "Duplicate", "Works as Designed") should be removed from the release version so that they do not appear in the release notes.
Check the corresponding ".x" fix version to see if it contains any issues that are resolved as "Fixed" and should be included in this release version.
Update the version's release date and status from the Manage Versions page.
The PHP driver uses semantic versioning. Do not break backwards compatibility in a non-major release or your users will kill you.
Before proceeding, ensure that the master branch is up-to-date with all code
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 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 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 for more information. For each change to the suffixes of
PHP_MONGODB_VERSION, increment the last digit ofPHP_MONGODB_VERSION_DESC.
Create the PECL package description file with make package.xml. This creates
a package.xml file from a template. Version, author, and file information will
be filled in, but release notes must be copied manually from JIRA.
After copying release notes, use make package to create the package file (e.g.
mongodb-X.Y.Z.tgz) and ensure that it can be successfully installed:
$ pecl install -f mongodb-X.Y.Z.tgz
Commit the modified phongo_version.h file as "Package X.Y.Z"
$ git add phongo_version.h
$ git commit -m "Package X.Y.Z"
The previous commit will be the target for our release tag:
$ git tag -a -m "Release X.Y.Z" X.Y.Z
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" phongo_version.h
Note: If this is an alpha, beta, or RC release, the version string should increment the stability sequence instead of the patch version. For example, if the constants were originally "1.4.0-dev" and "devel" and then changed to "1.4.0beta1" and "beta" for the first beta release, this step would see them ultimately changed to "1.4.0beta2-dev" and "devel".
$ git push
$ git push --tags
The PECL package may be published via the Release Upload form. You will have one chance to confirm the package information after uploading.
$ git checkout master
$ git merge vX.Y --strategy=ours
$ git push
The --strategy=ours option ensures that all changes from the merged commits
will be ignored.
The following template should be used for creating GitHub release notes via this form. The PECL package may also be attached to the release notes.
The PHP team is happy to announce that version X.Y.Z of the [mongodb](http://pecl.php.net/package/mongodb) PHP extension is now available on PECL.
**Release Highlights**
<one or more paragraphs describing important changes in this release>
A complete list of resolved issues in this release may be found at:
$JIRA_URL
**Documentation**
Documentation is available on PHP.net:
http://php.net/set.mongodb
**Feedback**
We would appreciate any feedback you might have on the project:
https://jira.mongodb.org/secure/CreateIssue.jspa?pid=12484&issuetype=6
**Installation**
You can either download and install the source manually, or you can install the extension with:
pecl install mongodb
or update with:
pecl upgrade mongodb
Windows binaries are available on PECL:
http://pecl.php.net/package/mongodb
Note: If this is an alpha or beta release, the installation examples should refer to the exact version (e.g. "mongodb-1.8.0beta2"). This is necessary because PECL prioritizes recent, stable releases over any stability preferences (e.g. "mongodb-beta").
The URL for the list of resolved JIRA issues will need to be updated with each release. You may obtain the list from this form.
If commits from community contributors were included in this release, append the following section:
**Thanks**
Thanks for our community contributors for X.Y.Z:
* [$CONTRIBUTOR_NAME](https://github.com/$GITHUB_USERNAME)
Release announcements should also be sent to the MongoDB Product & Driver Announcements.
Consider announcing each release on Twitter. Significant releases should also be announced via @MongoDB as well.
For minor releases, create a DOCSP ticket indicating whether there are changes to MongoDB Server or PHP version compatibility. The compatibility tables in the MongoDB documentation must be updated to account for new releases. Make sure to update both MongoDB and Language compatibility tables, as shown in this pull request.