This section describes a sample workflow for making and submitting changes to the project using
This section assumes that a developer has:
- Gotten ONOS source, as described in Getting Started
- Set up their development environment, as described in Development Environment Setup
- Set up their test environment, as described in Cells and ONOS test scripts
A developer should also be relatively comfortable with the shell.
The version control system used by the project is
git. Using git provides a developer with a way to cleanly keep track of and organize their changes, in addition to the ability (among many others) to view and reapply changes made to the code at various points in time. Importantly, git meshes in a way conducive to the ONOS code submission/review process; therefore, it is important for a potential contributor to be fairly comfortable with using it. Those interested in familiarizing themselves with git will find many resources online, including a full book.
As git is extremely rich in features, only the relevant functions will be mentioned where they are needed.
Create and switch to a new branch. A branch is a divergence point from the existing code base. Any changes made in a branch are restricted to the branch.
This creates a new branch named 'myBranch', off of the previous branch that we were in. Replace 'myBranch' with a name that briefly describes the topic of your change. This command will fail if there was already a branch of the same name. The command
git branchcan be used to list all of the branches to check that the name isn't already used. If a branch with the desired name is no longer needed, it may be deleted with
git branch -D <branchName>and the above commands repeated to re-create a new branch.
- Make changes to the code. This can be done in any way - IDE, text editor, whatnot.
- Test the changes. Any changes should be accompanied by unit tests wherever possible and must pass existing unit tests. The project should also be rebuilt and tested against a Mininet network (at the very least).
- The command
mvn testwill run all of the unit tests.
- The utility
onos-start-networkcan be used to launch a Mininet topology that will attempt to connect to the ONOS instances at each VM designated by the OC variables.
- The command
- Commit the changes. Committing creates a snapshot of the changes made to the code so that may be revisited/manipulated later, but only in the branch where the changes were committed. The command
git statusallows one to view the files that were modified.
git add <file>adds a file to the pool to commit. Once all files are added,
git commit -m "<message>"creates a snapshot with <message> as its description.
git logmay be used to list all of the commits that have been made, with the most recent commit at top.
Pull upstream changes. The repository on the development machine should be synchronized with the upstream ONOS source repository.
Upstream changes are always applied to the master branch. We first switch back to master with
git checkout, before pulling downloading the changes in the upstream source repository with
Sync the branch with updated master. The updates pulled to master must be explicitly applied to the branch intended for code review. This is done by switching back to the development branch and using
The default editor will be opened with the list of commits that have been made to the branch locally since its creation. Saving and closing this file causes the changes from the master branch to be incorporated into the branch. Any merge conflicts (e.g. a file modified in both the local and master branch) will interrupt the process. In
git status, the conflicting files will appear under "Unmerged paths" as "both modified". If this happens, the file(s) must be edited and committed before the rebase is continued:
This submits the changes with the branch name as its topic.
Commit and submit this branch only once
If you would like to change your code after submission, please follow the procedure as described in the "Amending Submissions" section below.
git review fails with Traceback
If you're using a Mac and git review command fails with an error traceback like below:Error Traceback
Traceback (most recent call last):
File "/usr/local/bin/git-review", line 11, in <module>
File "/Library/Python/2.7/site-packages/git_review/cmd.py", line 1132, in main
File "/Library/Python/2.7/site-packages/git_review/cmd.py", line 180, in get_version
provider = pkg_resources.get_provider(requirement)
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 197, in get_provider
return working_set.find(moduleOrReq) or require(str(moduleOrReq))
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 666, in require
needed = self.resolve(parse_requirements(requirements))
File "/System/Library/Frameworks/Python.framework/Versions/2.7/Extras/lib/python/pkg_resources.py", line 565, in resolve
raise DistributionNotFound(req) # XXX put more info here
try upgrading the git-review package dependency first.
$ sudo pip install --upgrade setuptools
The review responses, and what they mean:
|-2||There is something fundamentally blocking about this check-in (e.g. style, design). It cannot be merged as is.|
|-1||Some issues require addressing. Please update and submit patchset (amend commit) for re-review.|
|0||A comment, with no opinion on whether or not to accept the change.|
|+1||Change looks good, but someone else must approve.|
|+2||Change looks good, approved.|
(Note that two +1's do not equal a +2)
Typically, if a module owner +2's a review, he/she will also submit (merge) the change also.
As part of the peer review process, an author of a patch submitted to Gerrit may be asked to amend their submission. To amend a patch:
- Find the change number for the patch. This number can be found in the URL of the patch in the Gerrit web interface.
For example, if the URL of the link to the change-set is https://gerrit.onosproject.org/#/c/169/, the change number is 169.
Checkout the change. This creates a new branch for the changeset that represents this patch, with the naming convention review/submitter_name/branch_name.
This needs to be done once for the changeset. If more amendments are needed for the patch later, one can simply check the branch out like any other:
Make changes and commit. Here, we use
git commit --amend, instead of generating a new message.
Becareful with Change-Id:
Gerrit uses the Change-Id: ... in the commit comment to identify which changeset this commit belongs to.
Make sure that you're not modifying the Change-Id: string when you're amending changes to the commit.
If you're squashing multiple commits together into a existing changeset, be sure to leave only the Change-Id: you want to use in the commit comment.
Resubmit. This creates a new patchset on the existing review.
If Gerrit returns an error about a missing Change-Id, make sure that there is a
Change-Id:string at the bottom of the commit message (above the comment blocks):
Once finished and the patch is accepted, the branch can be deleted:
Amending Submissions (Rebase to master and/or apply changes)
This option is useful if there are commits in the master that conflict with your changes.
- Find the checkout. The checkout link can be found on the patch page in the Gerrit web interface. In the top right, there is a Download option. Copy the text in the Checkout field.
Checkout the patchset. This checks out the patch set at the most recent patch number.
Resolve conflicts. Resolve all conflicts related to the rebase
Add files to prepare for commit. If there are additional files you would like to add to this review, they can be added in this step