Continuous Integration & Deployment¶
Bedrock runs a series of automated tests as part of continuous integration workflow and Deployment Pipeline. You can learn more about each of the individual test suites by reading their respective pieces of documentation:
- Python unit tests (see Run the tests).
- Redirect tests (see Testing redirects).
- Functional tests (see Front-end testing).
Tests in the lifecycle of a change¶
Below is an overview of the tests during the lifecycle of a change to bedrock:
The change is developed locally, and all integration tests can be executed against a locally running instance of the application.
Push to master branch¶
Whenever a change is pushed to the master branch, the smoke suite of headless (see Testing redirects) and UI tests (see Smoke tests) are run against Firefox on Linux. If successful, the change is pushed to the dev environment, and the full suite of headless and UI tests are then run against Firefox on Windows 10 using Sauce Labs. This is handled by the pipeline, and is subject to change according to the settings in the master.yml file in the repository.
Push to stage branch¶
Whenever a change is pushed to the stage branch, a production docker image is built, published to Docker Hub, and deployed to a public staging environment. Once the new image is deployed, the full suite of UI tests is run against it with Firefox, Chrome, and Internet Explorer on Windows 10, and the sanity suite is run with IE9.
Push to prod branch (tagged)¶
When a tagged commit is pushed to the prod branch, a production docker image is built and published to Docker Hub if needed (usually this will have already happened as a result of a push to the stage branch), and deployed to each production deployment. After each deployment is complete, the full suite of UI tests is run against Firefox, Chrome and Internet Explorer on Windows 10, and the sanity suite is run against IE9. As with untagged pushes, this is all handled by the pipeline, and is subject to change according to the settings in the prod.yml file in the repository.
Push to prod cheat sheet
- Check out the
- Make sure the
masterbranch is up to date with
- Check that dev deployment is green:
- View deployment pipeline and look at
- View deployment pipeline and look at
- Tag and push the deployment by running
By default the
tag-release.sh script will push to the
origin git remote. If you’d
like for it to push to a different remote name you can either pass in a
--remote argument, or set the
MOZ_GIT_REMOTE environment variable. So the following
$ bin/tag-release.sh --push -r mozilla $ MOZ_GIT_REMOTE=mozilla bin/tag-release.sh --push
And if you’d like to just tag and not push the tag anywhere, you may omit the
Our Jenkinsfile will run the integration tests based on information in our branch-specific YAML files. These files specify various test names per branch that will cause it to use different parameters, allowing it to be called in many different ways to cover the testing needs. The job executes this script, which then runs this Docker image, and ultimately runs another script. The two scripts can also be executed locally to replicate the way Jenkins operates.
During the Test Images stage, the Test Runner job is called without a
BASE_URL. This means
that a local instance of the application will be started, and the URL of this instance
will be used for testing. The
DRIVER parameter is set to
Remote, which causes a
local instance of Selenium Grid to be started in Docker and used for the browser-based
functional UI tests.
The test scripts above will be run once for each properties name specified in the branch-specific YAML files for the branch being built and tested. Pushes to master will run different tests than pushes to prod for example.
Many of the options are configured via environment variables passed from the initial script to the Docker image and onto the final script. Many of these options can be set in the branch-specific YAML files in the repository. In the branch-specific YAML files folder you can copy any file there to match the name of your branch and modify it to set how it should be built by jenkins. Take the following example:
# jenkins/branches/change-all-the-things.yml smoke_tests: true apps: - bedrock-probably-broken
This configuration would cause commits pushed to a branch named
change-all-the-things to have docker
images built for them, have the smoke and unit tests run, and deploy to a deis app named
in our us-west deis cluster. If you’d like it to create the deis app and pre-fill a local database for your app,
you can set
demo: true in the file. Note that if the app already exists it must have the
jenkins user added via the
deis perms:create jenkins -a <your app name> command.
The available branch configuration options are as follows:
smoke_tests: boolean. Set to
trueto cause the unit and smoke test suites run against the docker images.
push_public_registry: boolean. Set to
trueto cause the built images to be pushed to the public docker hub.
require_tag: boolean. Set to
trueto require that the commit being built have a git tag in the format YYYY-MM-DD.X.
regions: list. A list of strings indicating the deployment regions for the set of apps. The valid values are in the
regionsarea of the
jenkins/global.ymlfile. If omitted a deployment to only
apps: list. A list of strings indicating the deis app name(s) to which to deploy. If omitted no deployments will occur.
demo: boolean. Set to
trueto have the deployed app in demo mode, which means it will have a pre-filled local database and the deis app will be created and configured for you if it doesn’t already exist.
integration_tests: list. A list of strings indicating the types of integration tests to run. If omitted no tests will run.
Configure Demo Servers¶
You can also set app configuration environment variables via deployment as well for demos. The default environment variables are set in jenkins/branches/demo/default.env. To modify your app’s settings you can create an env file named after your branch (e.g jenkins/branches/demo/pmac-l10n.env for the branch demo/pmac-l10n.env). The combination of values from demo/default.env, your branch specific env file, and a region specific env file (e.g. jenkins/regions/virginia.env) will be used to configure the app. So you only need to add the variables that differ from the default files to your file, and you can override any values from the default files as well.
Instance Configuration & Switches¶
Beyond setting environment variables in demo instances as described above, we have a separate repo
for configuring our primary instances (dev, stage, and prod). The docs for updating configurations
in that repo are on their own page, but there is a way to tell what version of the configuration is in use on any particular instance of bedrock.
You can go to the
/healthz-cron/ URL on an instance (see prod for example) to see the current
commit of all of the external Git repos in use by the site and how long ago they were updated. The info on that page also includes the latest
version of the database in use, the git revision of the bedrock code, and how long ago the database was updated. If you recently made
a change to one of these repos and are curious if the changes have made it to production, this is the URL you should check.
There are two components for Selenium, which are independently versioned. The first is
the Python client, and this can be updated via the test dependencies. The other
component is the server, which in the pipeline is either provided by a Docker container
or Sauce Labs. The
SELENIUM_VERSION environment variable controls both of these, and
they should ideally use the same version, however it’s possible that availability of
versions may differ. You can check the Selenium Docker versions available. If needed, the global
default can be set and then can be overridden in the individual job configuration.
Adding test runs¶
Test runs can be added by creating a new properties section in the integration tests script with the parameters of the new test run. This is simply a bash script and you can duplicate a clause of the case staement. For example, if you wanted to run tests in Firefox on both Windows 10 and OS X, you could create the following clauses:
case $1 in osx-firefox) BROWSER_NAME=firefox PLATFORM="OS X 10.11" ;; win10-firefox) BROWSER_NAME=firefox PLATFORM="Windows 10" ;;
You can use Sauce Labs platform configurator to help with the parameter values.
If you have commit rights to our Github repo (mozilla/bedrock) you can simply push
your branch to the branch named
run-integration-tests, and the
app will be deployed and all of the integration tests defined in the
file for that branch will be run. Please announce in our IRC channel (#www on irc.mozilla.org)
that you’ll be doing this so that we don’t get conflicts.
Known issues in Jenkins¶
Jenkins stalls after global configuration changes¶
When using the IRC plugin for notifications, global configuration changes can cause Jenkins to become unresponsive. To make such changes it can be necessary to first restart Jenkins, as this issue only appears some time after Jenkins has been started. A bug for the IRC plugin has been raised.