CSC/ECE 517 Fall 2013/ch1 1w08 cc
Code review tools are used to aid and automate existing peer code review practices in order to simplify and guide the review work flow. In general, code review is a systematic analysis of source code by a peer to find bugs which may have been missed by the original coder. <ref> GoogleTalksArchive "Mondrian Code Review on the Web" </ref>. The code review tools discussed here are collaborative tools designed for multiple users to easily share, review, and comment on one another's code to speed up the debugging process. Key features of code review tools include email notifications, syntax highlighted color diffs, commenting, reports, and subversion integration.
Code Review Tools
There are many code review tools in use today. Which tools one chooses to use depends on the individual needs since every tool is different. Below are some popular code review tools in use today along with their background and features.
Agile Review
Agile Review is an open source code review tool that is an Eclipse Plugin. <ref>Agile Review [1]</ref>
Cost: Free
Features
- Refactoring Safety
- Highlighted Comments
- SCM (Source Control Management) Integration
Barkeep
Barkeep is a code review system developed in Ruby by the company Ooyala <ref> GitHub "Comparing barkeep to other code review tools" </ref>. Although written in Ruby Barkeep is not language specific and may be used for code review of any language. Barkeep is standalone and the end user is responsible for hosting it. One of the key features that Barkeep prides itself on is it hackable nature. Since Barkeep is hosted by the user and they provide their “small codebase” it allows users to add on new features and make modifications as they see fit for their needs. So even if Barkeep doesn’t have a feature someone needs it is very feasible for the user to add it.
Cost: Free
Features
- Email Notifications
- Syntax Highlighted Color Diffs
- Hackable
- Commits Searching
- Review Requests
- Comments
- Inline Code Snippets
- Stats
- Most Active Reviewers
- Most Commented Commits
- Review Coverage
- Top Approvers
Collaborator
Collaborator is a code review tool built on CodeCollaborator by SmartBear. Unlike many other code review tools collaborator also doubles as a peer review tool allowing review of not only code but documents and other project deliverables such as user stories, test plans and user documentation. Companies such as Intel, Southwest Airlines, Cisco and Walmart have used Collaborator. <ref> SmartBear "Code & Document Review - Collaborator" </ref>
Cost: Paid
Features
- Real-time Chat
- Syntax Highlighted Color Diffs
- Comments
- IDE & SCM (Source Control Management) Integrations
- Reports
- Pending Code Reviews
- Code Review Performance
- Many more…
- Customizable and Automated Workflows
- Defect Tracking & Management
- Review Checklists
Code Striker
Code Stricker is a collaborative code reviewing web application written in cross-platform Perl. Code Stricker is open source and located on Sourceforge.<ref>Sourceforge "What is Codestriker?"</ref>
Cost: Free
Features
- Email Notifications
- Commenting
- Per-line Comments
- SCM (Source Control Management) Integration
- Syntax Highlighted Color Diffs
- Bug Tracking System Integration
Crucible
Crucible is collaborative peer code review software developed by Atlassian. <ref> Atlassian "Collaborative peer code review" </ref>
Cost: Paid
Features
- Commenting
- Threaded Inline Discussions
- Iterative Reviews
- Auditing of Review Activity
- Email and RSS Notifications
- Support to Review code before Check-In
- Review Reminders
- Dashboard & Reporting
- Review Coverage Reports
- Activity Streams
- Progress Indicators
- Syntax Highlighted Color Diffs
- SCM (Source Control Management) Integration
FlexPmd
Gerrit
Groogle
Groogle is an open source collaborative code review tool which is available as a cross-platform web interface <ref> Groogle "About Groogle"</ref>. The distinct value of the tool is its ability to adapt to and enforce existing workflows rather than making workflows adapt to the code review tool <ref> sourceforge.net "Groogle: A sensible source code review tool" </ref>. The customization factor makes it extremely user friendly.
Cost: Free
Features: <ref> Groogle "About Groogle"</ref>
- Cross-platform Web app
- SCM (Source Control Management) Integration
- File upload support for formats: zip, tar, gzip, and bzip2
- Pre/Post commit support
- 100 language syntax highlighting
- Syntax highlighting color diffs
- Repository tree change comparison
- Email notifications
- Asynchronous repository checkouts
- Security features
JCode Review
Jupiter
Malevich
Perforce
Rietveld
Rietveld is an open source web application for code reviews. Rietveld was inspired by Mondrian a internal web application at Google used for code reviews. Mondrian is heavily used inside Google and a developer of Mondrian always wanted to release it as an open source tool but due to its popularity within the company was unable to. Rietveld came about from the inspiration of Mondrian and was released to the open source Python community. <ref>Google Developers "An Open Source App: Rietveld Code Review Tool" </ref>
Cost: Free
Features
- Email Notifications
- Syntax Highlighted Color Diffs
- Hackable
- Inline Comment
Review Board
Review Board is a free web-based code review tool which was originally developed by Christian Hammond and David Trowbridge from VMWare <ref> Gavin Terrill "Review Board - Online Code Review Tool". Feb 12, 2008 </ref>. It focuses on combining everything needed for a code review to a central dashboard, and using emails as only the notification system instead of the full support for passing code between users. <ref> Jake Edge "Making code reviews easier with Review Board" January 16, 2008 </ref>
Cost: Free
Features: <ref> Review Board[2] </ref>
- Track review requests
- Syntax-highlighted color diffs
- Inter-revision diff
- Diff any file, not only source code
- Commenting on multiple lines
- Open item to-do list
- Development history
- Extensible
Comparison
Functionality
| Tool | Developer | Maintainer | License | Developed In | Available For | Desktop Client vs Web App | Cost |
| Agile Review | |||||||
| Barkeep | |||||||
| Collaborator | |||||||
| Code Striker | |||||||
| Crucible | |||||||
| FlexPmd | |||||||
| Gerrit | |||||||
| Groogle | Web App | ||||||
| JCode Review | |||||||
| Jupiter | |||||||
| Malevich | |||||||
| Perforce | |||||||
| Rietveld | |||||||
| Review Board | Web App |
| Tool | Developer | Maintainer | License | Developed In | Available For | Desktop Client vs Web App | Cost |
|---|---|---|---|---|---|---|---|
| Agile Review | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Free |
| Barkeep | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Free |
| Collaborator | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Paid |
| Code Striker | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Free |
| Crucible | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Paid |
| FlexPmd | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Gerrit | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Groogle | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| JCode Review | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Jupiter | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Malevich | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Perforce | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
| Rietveld | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Free |
| Review Board | Cell 2 | Cell 3 | Cell 4 | Cell 5 | Cell 6 | Cell 7 | Cell 8 |
Features
"*" denotes a feature.
| Column heading 1 | Column heading 2 | Column heading 3 |
|---|---|---|
| Row heading 1 | Cell 2 | Cell 3 |
| Row heading A | Cell B | Cell C |
References
<references/>