The goal of this document is to walk you through the concepts and specifics that should be understood while contributing to OpenStack.
Prior to contributing to an OpenStack source code repository a few steps need to be completed. This document covers the steps that get you started, such as creating a few accounts on required websites, signing a contributor license agreement, uploading an ssh key, and installing git-review.
You’ll need a Launchpad account, since this is how the Web interface for the Gerrit Code Review system will identify you. This is also useful for automatically crediting bug fixes to you when you address them with your code commits.
If you haven’t already, join The OpenStack Foundation (it’s free and currently required for all code contributors, though there is work in progress which may remove this requirement in the future). Your member level needs to be Foundation Member (not Community Member). Among other privileges, this also allows you to vote in elections and run for elected positions within The OpenStack Project. When signing up for Foundation Membership, make sure to give the same email address you’ll use for code contributions, since this will need to match your preferred email address in Gerrit.
Visit https://review.openstack.org/ and click the Sign In link at the top-right corner of the page. Log in with your Launchpad ID.
The first time you sign into OpenStack’s Gerrit (review.openstack.org), you will be prompted to “Select a unique username:”. You can enter your Launchpad username here, or something else if you want. Type carefully, as once set it cannot be changed. This is the username you will eventually use to submit changes to Gerrit and to perform authenticated queries through its API.
Because Gerrit uses Launchpad OpenID single sign-on, you won’t need a separate password for Gerrit, and once you log in to one of Launchpad, Gerrit, or any number of other OpenStack services, you won’t have to enter your password for the others.
You need to have completed all the steps above before you’ll be able to sign an Individual Contributor License Agreement.
Unless you are an U.S. Government Employee (see below), agree to the Individual Contributor License Agreement and provide contact information. The full text of the agreement will be displayed before you can enter “I AGREE” below it, but it’s also anonymously available if you want to preview the OpenStack ICLA now. Your full name and email address will be public (since they also appear in repository commit logs) and the latter needs to match the user.email in your Git configuration. The other contact information (postal address, phone numbers) will be kept confidential and is only used as a fallback record in the unlikely event The OpenStack Foundation needs to reach you directly over code contribution related matters. This contact information can also be easily updated later if desired, but make sure the primary email address always matches the one you set for your OpenStack Foundation Membership – otherwise Gerrit will give you an error message and refuse to accept your contact information.
Employees of the U.S. Government do not sign the Individual CLA. Instead, someone with authority to sign on behalf of your agency should sign the U.S. Government Contributor License Agreement. Please contact the OpenStack Foundation to initiate this process.
If you are contributing on behalf of a company or organization, you still need to sign the ICLA above but someone at your company or organization also needs to sign the Corporate Contributor License Agreement providing a list of people authorized to commit code to OpenStack. If you need a printable copy of the Corporate CLA please email community managers. Check How to update the CCLA to provide changes to such list. A list of current companies and organizations with an existing Corporate CLA is available for your review.
You’ll also want to upload an SSH key to Gerrit at review.openstack.org while you’re at it, so that you’ll be able to commit changes for review later. This is different from adding a key to Launchpad.
Ensure that you have run these steps to let git know about your email address:
git config --global user.name "Firstname Lastname" git config --global user.email "firstname.lastname@example.org"
To check your git configuration:
git config --list
We recommend using the git-review tool which is a git subcommand that handles all the details of working with Gerrit, the code review system used in OpenStack development. Before you start work, make sure you have git-review installed on your system.
On Ubuntu Precise (12.04) and later, git-review is included in the distribution, so install it as any other package:
apt-get install git-review
On Fedora 16 and later, git-review is included into the distribution, so install it as any other package:
yum install git-review
On Red Hat Enterprise Linux, you must first enable the EPEL repository, then install it as any other package:
yum install git-review
On openSUSE 12.2 and later, git-review is included in the distribution under the name python-git-review, so install it as any other package:
zypper in python-git-review
On Mac OS X, or most other Unix-like systems, you may install it with pip:
pip install git-review
If you run into trouble, you can refer to the git-review readme file.
All of git-review’s interactions with Gerrit are sequences of normal git commands. If you want to know more about what it’s doing, just add -v to the options and it will print out all of the commands it’s running.
Clone a repository in the usual way, for example:
git clone https://git.openstack.org/openstack/<projectname>.git
You may want to ask git-review to configure your repository to know about Gerrit at this point. If you don’t, it will do so the first time you submit a change for review, but you probably want to do this ahead of time so the Gerrit Change-Id commit hook gets installed. To do so:
cd <projectname> git review -s
Git-review checks that you can log in to Gerrit with your ssh key. It assumes that your Gerrit/Launchpad user name is the same as the current running user. If that doesn’t work, it asks for your Gerrit/Launchpad user name. You can avoid that question by configuring git to use your Gerrit username, as follows:
git config --global gitreview.username yourgerritusername
If you don’t remember your Gerrit user name go to the settings page on gerrit to check it out (it’s not your email address).
You can verify the SSH host keys for review.openstack.org on https://review.openstack.org/#/settings/ssh-keys
We have a tutorial: Learn the Gerrit Workflow in the Sandbox. If this is your first time contributing to OpenStack, we strongly suggest you follow this tutorial.
Git-review normally communicates with Gerrit using SSH over port 29418 with no further configuration needed. However, if you suspect that ssh over non-standards ports might be blocked (or you need to access the web using https) then you can configure git-review to use an https endpoint instead of ssh. Keep in mind that you will need to generate an HTTP password in Gerrit to use this connection. You should run the following command before “git review -s”:
git remote add gerrit https://<username>@review.openstack.org/<umbrella repository name>/<repository name>.git
In case you had already tried to setup git-review and it failed, it might be necessary to remove the Gerrit remote from git:
git remote rm gerrit
Bug reports for a project are generally tracked on Launchpad at https://bugs.launchpad.net/<projectname>. Contributors may review these reports regularly when looking for work to complete.
There are 4 key tasks with regards to bugs that anyone can do:
- Confirm new bugs: When a bug is filed, it is set to the “New” status. A “New” bug can be marked “Confirmed” once it has been reproduced and is thus confirmed as genuine.
- Solve inconsistencies: Make sure bugs are Confirmed, and if assigned that they are marked “In Progress”
- Review incomplete bugs: See if information that caused them to be marked “Incomplete” has been provided, determine if more information is required and provide reminders to the bug reporter if they haven’t responded after 2-4 weeks.
- Review stale In Progress bugs: Work with assignee of bugs to determine if the bug is still being worked on, if not, unassign them and mark them back to Confirmed or Triaged.
Learn more about working with bugs for various projects at:
Bug statuses are documented here:
If you find a bug that you wish to work on, you may assign it to yourself. When you upload a review, include the bug in the commit message for automatic updates back to Launchpad. The following options are available:
Closes-Bug: ####### Partial-Bug: ####### Related-Bug: #######
Also see the Including external references section of the OpenStack Git Commit Good Practices wiki page.
Many OpenStack project teams have a <projectteam>-specs repository which is used to hold approved design specifications for additions and changes to the project team’s code repositories.
The layout of the repository will typically be something like:
It may also have subdirectories to make clear which specifications are approved and which have already been implemented:
You can typically find an example spec in specs/template.rst.
Check the repository for the project team you’re working on for specifics about repository organization.
Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad. Not all approved blueprints will get fully implemented.
Specifications have to be re-proposed for every release. The review may be quick, but even if something was previously approved, it should be re-reviewed to make sure it still makes sense as written.
Historically, Launchpad blueprints were used to track the implementation of these significant features and changes in OpenStack. For many project teams, these Launchpad blueprints are still used for tracking the current status of a specification. For more information, see the Blueprints wiki page.
View all approved project team’s specifications at http://specs.openstack.org/.
Once your local repository is set up as above, you must use the following workflow.
Make sure you have the latest upstream changes:
git remote update git checkout master git pull --ff-only origin master
Create a topic branch to hold your work and switch to it. If you are working on a blueprint, name your topic branch bp/BLUEPRINT where BLUEPRINT is the name of a blueprint in Launchpad (for example, bp/authentication). The general convention when working on bugs is to name the branch bug/BUG-NUMBER (for example, bug/1234567). Otherwise, give it a meaningful name because it will show up as the topic for your change in Gerrit:
git checkout -b TOPIC-BRANCH
Git commit messages should start with a short 50 character or less summary in a single paragraph. The following paragraph(s) should explain the change in more detail.
If your changes addresses a blueprint or a bug, be sure to mention them in the commit message using the following syntax:
Implements: blueprint BLUEPRINT Closes-Bug: ####### (Partial-Bug or Related-Bug are options)
Adds keystone support ...Long multiline description of the change... Implements: blueprint authentication Closes-Bug: #123456 Change-Id: I4946a16d27f712ae2adf8441ce78e6c0bb0bb657
Note that in most cases the Change-Id line should be automatically added by a Gerrit commit hook installed by git-review. If you already made the commit and the Change-Id was not added, do the Gerrit setup step and run: git commit --amend. The commit hook will automatically add the Change-Id when you finish amending the commit message, even if you don’t actually make any changes. Do not change the Change-Id when amending a change as that will confuse Gerrit.
Make your changes, commit them, and submit them for review:
git commit -a
Do not check in changes on your master branch. Doing so will cause merge commits when you pull new upstream changes, and merge commits will not be accepted by Gerrit.
OpenStack projects do not currently require the use of a Signed-off-by header as a CLA is used, instead. However, you are welcome to include Signed-off-by in your commits. By doing so, you are certifying that the following is true:
Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
A Signed-off-by header takes the following form in a commit message:
Signed-off-by: Full Name <email@example.com>
If you add the -s option to git commit, this header will be added automatically:
git commit -s
Before submitting your change, you should test it. To learn how to run python based unit tests in OpenStack projects see Running Python Unit Tests
Before submitting your change, you should make sure that your change does not contain the files or lines you do not explicitly change:
Once you have committed a change to your local repository, all you need to do to send it to Gerrit for code review is run:
When that completes, automated tests will run on your change and other developers will peer review it.
If the code review process suggests additional changes, make and amend the changes to the existing commit. Leave the existing Change-Id: footer in the commit message as-is. Gerrit knows that this is an updated patchset for an existing change:
git commit -a --amend git review
It’s important to understand how Gerrit handles changes and patch sets. Gerrit combines the Change-Id in the commit message, the project, and the target branch to uniquely identify a change.
A new patch set is determined by any modification in the commit hash. When a change is initially pushed up it only has one patch set. When an update is done for that change, git commit --amend will change the most current commit’s hash because it is essentially a new commit with the changes from the previous state combined with the new changes added. Since it has a new commit hash, once a git review is successfully processed, a new patch set appears in Gerrit.
Since a patch set is determined by a modification in the commit hash, many git commands will cause new patch sets. Three common ones that do this are:
- git commit --amend
- git rebase
- git cherry-pick
As long as you leave the “Change-Id” line in the commit message alone and continue to propose the change to the same target branch, Gerrit will continue to associate the new commit with the already existing change, so that reviewers are able to see how the change evolves in response to comments.
If you have made many small commits, you should squash them so that they do not show up in the public repository. Remember: each commit becomes a change in Gerrit, and must be approved separately. If you are making one “change” to the project, squash your many “checkpoint” commits into one commit for public consumption. Here’s how:
git checkout master git pull origin master git checkout TOPIC-BRANCH git rebase -i master
Use the editor to squash any commits that should not appear in the public history. If you want one change to be submitted to Gerrit, you should only have one “pick” line at the end of this process. After completing this, you can prepare your public commit message(s) in your editor. You start with the commit message from the commit that you picked, and it should have a Change-Id line in the message. Be sure to leave that Change-Id line in place when editing.
Once the commit history in your branch looks correct, run git review to submit your changes to Gerrit.
When you want to start new work that is based on the commit under the review, you can add the commit as a dependency.
Fetch change under review and check out branch based on that change:
git review -d $PARENT_CHANGE_NUMBER git checkout -b $DEV_TOPIC_BRANCH
Edit files, add files to git:
git commit -a git review
git review rebases the existing change (the dependency) and the new commit if there is a conflict against the branch they are being proposed to. Typically this is desired behavior as merging cannot happen until these conflicts are resolved. If you don’t want to deal with new patchsets in the existing change immediately you can pass the -R option to git review in the last step above to prevent rebasing. This requires future rebasing to resolve conflicts.
If the commit your work depends on is updated, and you need to get the latest patchset from the depended commit, you can do the following.
Fetch and checkout the parent change:
git review -d $PARENT_CHANGE_NUMBER
Cherry-pick your commit on top of it:
git review -x $CHILD_CHANGE_NUMBER
Submit rebased change for review:
The note for the previous example applies here as well. Typically you want the rebase behavior in git review. If you would rather postpone resolving merge conflicts you can use git review -R as the last step above.
If your change has a dependency on a change outside of that repository, like a change for another repository or some manual setup, you have to ensure that the change merge at the right time.
For a change depending on a manual setup, mark your change with the “Work in Progress” label until the manual setup is done. A core reviewer might also block an important change with a -2 so that it does not get merged accidentally before the manual setup is done.
If your change has a dependency on a change in another repository, you can use cross-repo dependencies (CRD) in Zuul:
When Zuul sees CRD changes, it serializes them in the usual manner when enqueuing them into a pipeline. This means that if change A depends on B, then when they are added to the gate pipeline, B will appear first and A will follow. If tests for B fail, both B and A will be removed from the pipeline, and it will not be possible for A to merge until B does.
Note that if changes with CRD do not share a change queue (such as the “integrated gate”), then Zuul is unable to enqueue them together, and the first will be required to merge before the second is enqueued.
When changes are enqueued into the check pipeline, all of the related dependencies (both normal git-dependencies that come from parent commits as well as CRD changes) appear in a dependency graph, as in the gate pipeline. This means that even in the check pipeline, your change will be tested with its dependency. So changes that were previously unable to be fully tested until a related change landed in a different repo may now be tested together from the start.
All of the changes are still independent (so you will note that the whole pipeline does not share a graph as in the gate pipeline), but for each change tested, all of its dependencies are visually connected to it, and they are used to construct the git references that Zuul uses when testing. When looking at this graph on the Zuul status page, you will note that the dependencies show up as grey dots, while the actual change tested shows up as red or green. This is to indicate that the grey changes are only there to establish dependencies. Even if one of the dependencies is also being tested, it will show up as a grey dot when used as a dependency, but separately and additionally will appear as its own red or green dot for its test.
A Gerrit change ID may refer to multiple changes (on multiple branches of the same project, or even multiple projects). In these cases, Zuul will treat all of the changes with that change ID as dependencies. So if you say that a tempest change Depends-On a change ID that has changes in nova master and nova stable/juno, then when testing the tempest change, both nova changes will be applied, and when deciding whether the tempest change can merge, both changes must merge ahead of it.
A change may depend on more than one Gerrit change ID as well. So it is possible for a change in tempest to depend on a change in devstack and a change in nova. Simply add more “Depends-On:” lines to the footer.
If a cycle is created by use of CRD, Zuul will abort its work very early. There will be no message in Gerrit and no changes that are part of the cycle will be enqueued into any pipeline. This is to protect Zuul from infinite loops. The developers hope that they can improve this to at least leave a message in Gerrit in the future. But in the meantime, please be cognizant of this and do not create dependency cycles with Depends-On lines.
Keep in mind that these dependencies are dependencies on changes in other repositories. Thus, a Depends-on only enforces an ordering but is not visible otherwise especially in these cases:
Changes for the CI infrastructure like changes openstack-infra/project-config are never tested in a production simulated environment. So, if one of the changes adjusts the job definitions or creates a new job, a Depends-On will not test the new definition, the CI infrastructure change needs to merge to master and be in production to be fully evaluated.
If a test job installs packages from PyPI and not via source, be aware that the package from PyPI will always be used, a Depends-On will not cause a modified package to be used instead of installing from PyPI.
As an example, if you are testing a change in python-novaclient that needs a change in python-keystoneclient, you add a Depends-On in the python-novaclient change. If a python-novaclient job installs python-keystoneclient from PyPI, the Depends-On will not have any effect since the PyPI version is used. If a python-novaclient job installs python-keystoneclient from source, the checked out source will have the change applied.
Do not add a Depends-On an abandoned change, your change will never merge.
If you backport a change to another branch, the gerrit change ID stays the same. If you add a Depends-On using the Gerrit change ID of the patch that subsequently was backported, the patch with the Depends-On is now also dependent on the backported change. This might be desirable for some changes and a surprise for others.
A change that is dependent on another can be approved before the dependent change merges. If the repositories share the gate queue, it will merge automatically after the dependent change merged. But if the repositories do not share the gate queue, it will not merge automatically when the dependent change has merged, even a recheck will not help. Zuul waits for a status change and does not see it. The change needs another approval or a toggle of the approval, toggle means removing the approval and readding it again.
Log in to https://review.openstack.org/ to see proposed changes, and review them.
To provide a review for a proposed change in the Gerrit UI, click on the Review button (it will be next to the buttons that will provide unified or side-by-side diffs in the browser). In the code review, you can add a message, as well as a vote (+1,0,-1).
It’s also possible to add comments to specific lines in the file, for giving context to the comment. For that look at the diff of changes done in the file (click the file name), and click on the line number for which you want to add the inline comment. After you add one or more inline comments, you still have to send the Review message (see above, with or without text and vote). Prior to sending the inline comments in a review comment the inline comments are stored as Drafts in your browser. Other reviewers can only see them after you have submitted them as a comment on the patchset.
Any OpenStack developer may propose or comment on a change (including voting +1/0/-1 on it). OpenStack project teams have a policy requiring two positive reviews from core reviewers. A vote of +2 is allowed from core reviewers, and should be used to indicate that they are a core reviewer and are leaving a vote that should be counted as such.
When a review has two +2 reviews and one of the core team believes it is ready to be merged, he or she should leave a +1 vote in the “Approved” category. You may do so by clicking the “Review” button again, with or without changing your code review vote and optionally leaving a comment. When a +1 Approved review is received, Jenkins will run tests on the change, and if they pass, it will be merged.
A green checkmark indicates that the review has met the requirement for that category. Under “Code-Review”, only one +2 gets the green check.
For more details on reviews in Gerrit, check the Gerrit documentation.
When a new patchset is uploaded to Gerrit, that project’s “check” tests are run on the patchset by Jenkins. Once completed the test results are reported to Gerrit by Jenkins in the form of a Verified: +/-1 vote. After code reviews have been completed and a change receives an Approved: +1 vote that project’s “gate” tests are run on the change by Jenkins. Jenkins reports the results of these tests back to Gerrit in the form of a Verified: +/-2 vote. Code merging will only occur after the gate tests have passed successfully and received a Verified: +2. You can view the state of tests currently being run on the Zuul Status page.
If a change fails tests in Jenkins, please follow the steps below:
- Visit http://status.openstack.org/elastic-recheck/ to see if one of the bugs listed there matches the error you’ve seen. If your error isn’t there, then:
- Identify which project or projects are affected, and search for a related bug on Launchpad. You can search for bugs affecting all OpenStack Projects here: https://bugs.launchpad.net/openstack/ If you do not find an existing bug, file a new one (be sure to include the error message and a link to the logs for the failure). If the problem is due to an infrastructure problem (such as Jenkins or Gerrit), file (or search for) the bug against the openstack-gate project.
A patchset has to be approved to run tests in the gate pipeline. If the patchset has failed in the gate pipeline (it will have been approved to get into the gate pipeline) a recheck will first run the check jobs and if those pass, it will again run the gate jobs. There is no way to only run the gate jobs, the check jobs will first be run again.
More information on debugging automated testing failures can be found in the following recordings:
Anyone can be a reviewer: participating in the review process is a great way to learn about OpenStack social norms and the development processes. Some things are necessary to keep in mind when doing code reviews:
- Learn the best practices for git commit messages.
- Use the “DocImpact” tag on changes that affect documentation.
- Use the “SecurityImpact” tag on changes that should get the attention of the OpenStack Security Group (OSSG) for additional review.
- Use the “UpgradeImpact” tag on changes which require configuration changes to be mentioned in the release notes.
- Use the “APIImpact” tag on changes impacting API stability, this tag will aid in gaining the attention of the OpenStack API Working Group for additional review.
- If the change fixes a bug, it should include the bug number. For example, add the line “Closes-Bug: 1234”.
- If the change implements a feature, it should reference a blueprint. The blueprint should be approved before the change is merged. For example, add the line “Blueprint: my-blueprint.”
Test case implementation (Mock vs. Mox):
About Python 3 compatibility:
The code should comply with the community logging standards.
Review is a conversation that works best when it flows back and forth. Submitters need to be responsive to questions asked in comments, even if the score is +0 from the reviewer. Likewise, reviewers should not use a negative score to elicit a response if they are not sure the patch should be changed before merging.
For example, if there is a patch submitted which a reviewer cannot fully understand because there are changes that aren’t documented in the commit message or code documentation, this is a good time to issue a negative score. Patches need to be clear in their commit message and documentation.
As a counter-example, a patch which is making use of a new library, which the reviewer has never used before, should not elicit a negative score from the reviewer with a question like “Is this library using standard python sockets for communication?” That is a question the reviewer can answer themselves, and which should not hold up the review process while the submitter explains things. Either the author or a reviewer should try to add a review comment answering such questions, unless they indicate a need to better extend the commit message, code comments, docstrings or accompanying documentation files.
In almost all cases, a negative review should be accompanied by clear instructions for the submitter how they might fix the patch.
There may be more specific items to be aware of inside the projects’ documentation for contributors.
Contributors may notice a review that has several +1’s from other reviewers, passes the functional tests, etc. but the code still has not been merged. As only core contributors can approve code for merging, you can help things along by getting a core developer’s attention in IRC (never on the mailing lists) and letting them know there is a changeset with lots of positive reviews and needs final approval.
To get early feedback on a change which is not fully finished yet, you can submit a change to Gerrit and mark it as “Work in Progress” (WIP).
The OpenStack Gerrit system does not support drafts, use “Work in Progress” instead.
To do so, after submitting a change to Gerrit in usual way (git review), You should go to Gerrit, and do Code Review of your own change while setting “Workflow” vote to “-1”, which marks the change as WIP.
This allows others to review the change, while at the same time blocking it from being merged, as you already plan to continue working on it.
After uploading a new patchset, this -1 (WIP) vote disappears. So if you still plan to do additional changes, do not forget to set Workflow to -1 on the new patchset.
Once a change has been approved and passed the gate jobs, Gerrit automatically merges the latest patchset.
Each patchset gets merged to the head of the branch before testing it. If Gerrit cannot merge a patchset, it will give a -1 review and add a comment notifying of merge failure.
Each time a change merges, the “merge-check” pipeline verifies that all open changes on the same project are still mergeable. If any job is not mergeable, Jenkins will give a -1 review and add a comment notifying of merge failure.
After a change is merged, project-specific post jobs are run. Most often the post jobs publish documentation, run coverage, or send strings to the translation server.
Project gating refers to the process of running regression tests before a developer’s patchset is merged. The intent of running regression tests is to validate that new changes submitted against the source code repository will not introduce new bugs. Gating prevents regressions by ensuring that a series of tests pass successfully before allowing a patchset to be merged into the mainline of development.
The system used for gating is Zuul, which listens to the Gerrit event stream and is configured with YAML files to define a series of tests to be run in response to an event.
The jobs in the gate queue are executed once a core reviewer approves a change (using a +1 Workflow vote) and a verified +1 vote exist. When approving, at least one +2 Code-Review vote needs to exist (can be given by core reviewer when approving). The convention is that two +2 Code-Reviews are needed for approving.
Once all of the jobs report success on an approved patchset in the configured gate pipeline, then Gerrit will merge the code into trunk.
Besides running the gate tests, the gate pipeline determines the order of changes to merge across multiple projects. The changes are tested and merged in this order, so that for each change the state of all other repositories can be identified.
Additional information about project gating and Zuul can be found in the Zuul documentation, located at: http://docs.openstack.org/infra/zuul/gating.html