When using Laravel Passport in a project that uses Travis for continuous integration, it is important to make sure that the testing environment on travis is configured properly, otherwise you may encounter errors that will prevent your build from passing.
The .travis.yml file
After some trial and error, I have come up with a working .travis.yml configuration.
| 1 | language: php |
| 2 | |
| 3 | php: |
| 4 | - 7.1 |
| 5 | - 7.2 |
| 6 | |
| 7 | before_script: |
| 8 | - travis_retry composer self-update |
| 9 | - travis_retry composer install --prefer-source --no-interaction --no-suggest |
| 10 | - cp .env.travis .env |
| 11 | - php artisan key:generate |
| 12 | - php artisan migrate |
| 13 | - php artisan passport:keys |
| 14 | |
| 15 | script: |
| 16 | - vendor/bin/phpunit |
| 17 | |
| 18 | sudo: false |
The first two sections are self-explanatory. We are going to be testing a PHP project, and we want Travis to test our code against PHP 7.1 and 7.2.
The before_script section is where we outline how we want the testing environment to be prepared before the tests are run. Lets break this down line by line:
-
travis_retry composer self-update
Here we are ensuring that we have the latest version of composer available to us in our testing container. -
travis_retry composer install --prefer-source --no-interaction --no-suggest
Here we install the package dependencies outlined in thecomposer.lockfile that lives in our project repo. -
cp .env.travis .env
We will use a specially crafted.envfile to ensure that the application being tested is configured correctly for this testing environment. See below for more details. -
php artisan key:generate
Here we will generate a hashing key that will be used for the lifetime of this test run. The Laravel framework uses this value internally, so you should always generate a key even if you are not explicitly creating hashes in your application. -
php artisan migrate
Here we are running the database migrations to create the DB structure that the application is expecting. I opted to publish the Passport migrations directly to mydatabase/migrationsfolder, rather than registering them separately. Regardless, these migrations include the tables that Passport uses to store its client data. It is also important to note that the project has been configured to use an in-memory sqlite database, which is why we don't have to create an empty database during these provisioning steps. -
php artisan passport:keys
This is the most important step. Here we are asking Passport to generate the RSA keys that it uses to generate its grants. By default these keys are stored in thestorage/directory.
The script section is where we tell Travis how to run our tests. Note that I am specifying that I want travis to use the version of PHPUnit that was installed via Composer, rather than the global version that it makes available to us in the container. This way I can always know for sure exactly which version of PHPUnit I am running, and we can run a newer version if we want to.
The last section, sudo: false, is how we tell Travis to run our tests in a containerized environment. This often means that our tests will run faster (though not always.). The downside is that we don't have sudo available to us when provisioning. If we were to need that option we would have to use the slower, non-container environment that Travis offers.
The .env configuration file
This is the special .env.travis file I used to specify application specific testing configuration:
| 1 | APP_NAME=ExampleLaravelApplication |
| 2 | APP_ENV=local |
| 3 | APP_KEY= |
| 4 | APP_DEBUG=true |
| 5 | APP_LOG_LEVEL=debug |
| 6 | APP_URL=http://localhost |
| 7 | |
| 8 | DB_CONNECTION=sqlite |
| 9 | DB_DATABASE=:memory: |
| 10 | DB_USERNAME=homestead |
| 11 | DB_PASSWORD=secret |
| 12 | |
| 13 | BROADCAST_DRIVER=log |
| 14 | CACHE_DRIVER=file |
| 15 | SESSION_DRIVER=file |
| 16 | SESSION_LIFETIME=120 |
| 17 | QUEUE_DRIVER=sync |
| 18 | |
| 19 | REDIS_HOST=127.0.0.1 |
| 20 | REDIS_PASSWORD=null |
| 21 | REDIS_PORT=6379 |
| 22 | |
| 23 | MAIL_DRIVER=log |
| 24 | MAIL_HOST=smtp.mailtrap.io |
| 25 | MAIL_PORT=2525 |
| 26 | MAIL_USERNAME=null |
| 27 | MAIL_PASSWORD=null |
| 28 | MAIL_ENCRYPTION=null |
The most important option here is the DB_DATABASE=:memory: option. This tells the application that we want to use an in-memory sqlite database. Even though the APP_ENV is "local" here, it will be over-written by the ENV values specified in the phpunit.xml file. This is where we set the application environment to "testing" for the lifetime of the test run.
The phpunit.xml file
We also set some importan environment variables in the phpunit.xml file:
| 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <phpunit backupGlobals="false" |
| 3 | backupStaticAttributes="false" |
| 4 | bootstrap="vendor/autoload.php" |
| 5 | colors="true" |
| 6 | convertErrorsToExceptions="true" |
| 7 | convertNoticesToExceptions="true" |
| 8 | convertWarningsToExceptions="true" |
| 9 | processIsolation="false" |
| 10 | stopOnFailure="false"> |
| 11 | <testsuites> |
| 12 | <testsuite name="Feature"> |
| 13 | <directory suffix="Test.php">./tests/Feature</directory> |
| 14 | </testsuite> |
| 15 | |
| 16 | <testsuite name="Unit"> |
| 17 | <directory suffix="Test.php">./tests/Unit</directory> |
| 18 | </testsuite> |
| 19 | </testsuites> |
| 20 | <filter> |
| 21 | <whitelist processUncoveredFilesFromWhitelist="true"> |
| 22 | <directory suffix=".php">./app</directory> |
| 23 | </whitelist> |
| 24 | </filter> |
| 25 | <php> |
| 26 | <env name="APP_ENV" value="testing"/> |
| 27 | <env name="CACHE_DRIVER" value="array"/> |
| 28 | <env name="SESSION_DRIVER" value="array"/> |
| 29 | <env name="QUEUE_DRIVER" value="sync"/> |
| 30 | <env name="DB_CONNECTION" value="testing" /> |
| 31 | <env name="PASSPORT_CLIENT_SECRET" value="Dtg9myGAIsTUbTck2kxrxeZ5TDnE1qbVvTeYIuPN" /> |
| 32 | </php> |
| 33 | </phpunit> |
There are two important things to note about this file:
- We set the
APP_ENVenvironment variable to "testing". This puts our Laravel application into testing mode, which disables certain features like CSRF checks; which can be annoying to deal with when testing. - Secondly, we are setting a random value as our
PASSPORT_CLIENT_SECRETvalue. This value matches the oauth secret used in our test fixtures when we create simulated Password Clients for our authentication tests. The application I am testing uses an environment variable to store the ID of the password grant client we use to decode Json Web Tokens; we want to simulate that in our testing environment. You may not need to do this if you are using Passport differently.
Thats it! Once you understand how the pieces fit together it is not as complex as it first seems.
