Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
206 lines (154 loc) · 7.59 KB

CONTRIBUTING.md

File metadata and controls

206 lines (154 loc) · 7.59 KB

Contributing to the PHP Library for MongoDB

Initializing the Repository

Developers who would like to contribute to the library will need to clone it and initialize the project dependencies with Composer:

$ git clone https://github.com/mongodb/mongo-php-library.git
$ cd mongo-php-library
$ composer update

In addition to installing project dependencies, Composer will check that the required extension version is installed. Directions for installing the extension may be found here. Composer will also install the submodule required for running spec tests.

Installation directions for Composer may be found in its Getting Started guide.

Testing

The library's test suite uses PHPUnit, which is installed through the PHPUnit Bridge dependency by Composer.

The test suite may be executed with:

$ composer run test

The phpunit.xml.dist file is used as the default configuration file for the test suite. In addition to various PHPUnit options, it defines environment variables such as MONGODB_URI and MONGODB_DATABASE. You may customize this configuration by creating your own phpunit.xml file based on the phpunit.xml.dist file we provide.

To run tests against a cluster that requires authentication, either include the credentials in the connection string (i.e. MONGODB_URI) or set the MONGODB_USERNAME and MONGODB_PASSWORD environment variables accordingly. Note that MONGODB_USERNAME and MONGODB_PASSWORD will override any credentials present in the connection string.

Environment Variables

The test suite references the following environment variables:

  • MONGODB_DATABASE: Default database to use in tests. Defaults to phplib_test.
  • MONGODB_PASSWORD: If specified, this value will be appended as the password URI option for clients constructed by the test suite, which will override any credentials in the connection string itself.
  • MONGODB_URI: Connection string. Defaults to mongodb://127.0.0.1/, which assumes a MongoDB server is listening on localhost port 27017.
  • MONGODB_USERNAME: If specified, this value will be appended as the username URI option for clients constructed by the test suite, which will override any credentials in the connection string itself.

The following environment variable is used for stable API testing:

  • API_VERSION: If defined, this value will be used to construct a MongoDB\Driver\ServerApi, which will then be specified as the serverApi driver option for clients created by the test suite.

The following environment variables are used for load balancer testing:

  • MONGODB_SINGLE_MONGOS_LB_URI: Connection string to a load balancer backed by a single mongos host.
  • MONGODB_MULTI_MONGOS_LB_URI: Connection string to a load balancer backed by multiple mongos hosts.

The following environment variables are used for CSFLE testing:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_TEMP_ACCESS_KEY_ID
  • AWS_TEMP_SECRET_ACCESS_KEY
  • AWS_TEMP_SESSION_TOKEN
  • AZURE_TENANT_ID
  • AZURE_CLIENT_ID
  • AZURE_CLIENT_SECRET
  • CRYPT_SHARED_LIB_PATH: If defined, this value will be used to set the cryptSharedLibPath autoEncryption driver option for clients created by the test suite.
  • GCP_EMAIL
  • GCP_PRIVATE_KEY
  • KMIP_ENDPOINT
  • KMS_ENDPOINT_EXPIRED
  • KMS_ENDPOINT_WRONG_HOST
  • KMS_ENDPOINT_REQUIRE_CLIENT_CERT
  • KMS_TLS_CA_FILE
  • KMS_TLS_CERTIFICATE_KEY_FILE

Updating spec tests

Tests from the MongoDB Specifications repository are included through a submodule and updated automatically through Dependabot. To update tests manually, switch to the tests/specifications directory and update the repository to the appropriate commit. Remember to commit this change to the library repository.

Handling test failures on updates

Failures on updates can occur for multiple reasons, and the remedy to this will depend on the type of failure. Note that only tests for implemented specifications are run in the test runner.

  • If a specification is not fully implemented (e.g. a recent change to the spec has not been applied yet), skip the test in question with a reference to the ticket that covers the change
  • If a test fails because it uses features not yet implemented in the unified test runner, skip the corresponding test with a reference to the ticket that covers implementing the new features
  • If the test failure points to a bug in the spec, consider the effort required to fix the failure. If it's a small change, commit and push the fix directly to the pull request. Otherwise, skip the test with a reference to a ticket to fix the failing test.

The goal is that the library passes tests with the latest spec version at all times, either by implementing small changes quickly, or by skipping tests as necessary.

Backward compatibility

When submitting a PR, be mindful of our backward compatibility guarantees. Our BC policy follows Symfony's Backward Compatibility Promise.

In short, this means we use semantic versioning and guarantee backward compatibility on all minor releases. For a more detailed definition, refer to the Symfony docs linked above.

Code quality

Before submitting a pull request, please ensure that your code adheres to the coding standards and passes static analysis checks.

$ composer run checks

Coding standards

The library's code is checked using PHP_CodeSniffer, which is installed as a development dependency by Composer. To check the code for style errors, run the phpcs binary:

$ vendor/bin/phpcs

To automatically fix all fixable errors, use the phpcbf binary:

$ vendor/bin/phpcbf

Static analysis

The library uses psalm to run static analysis on the code and ensure an additional level of type safety. New code is expected to adhere to level 1, with a baseline covering existing issues. To run static analysis checks, run the psalm binary:

$ vendor/bin/psalm

To remove fixed errors from the baseline, you can use the update-baseline command-line argument:

$ vendor/bin/psalm --update-baseline

Note that this will not add new errors to the baseline. New errors should be fixed instead of being added to the technical debt, but in case this isn't possible it can be added to the baseline using set-baseline:

$ vendor/bin/psalm --set-baseline=psalm-baseline.xml

Refactoring

The library uses rector to refactor the code for new features. To run automatic refactoring, use the rector command:

$ vendor/bin/rector

New rules can be added to the rector.php configuration file.

Documentation

Documentation for the library is maintained by the MongoDB docs team and is kept in the mongodb/docs-php-library repository.

Releasing

The releases are created by the maintainers of the library. The process is documented in the RELEASING.md file.