A plug-in for the Gerrit code review system that shows a static class diagram on reviews.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.settings
doc
docker
visualcodereview-gerrit-plugin
.gitignore
.project
LICENSE
README.md
pom.xml

README.md

Overview

This project provides a plug-in for Gerrit code reviews, that adds a UML static class diagram to reviews.

This is an experiment to see if generated diagrams could be useful. The goal is to surface abstractions and bring in context that's not available in a file- and line-based code review system.

You can read more about the experiment here.

Status

This is an experiment. The code makes lots of assumptions, and is not thoroughly tested. Feel free to try it out, but use at your own risk.

Example

Classes included in the Git commit are shown in black, while related types that are not changed in the commit are shown in dark gray.

How It Works

The plug-in consists of two main components:

  • A Gerrit UI extension that adds an HTML image tag to the review screen
  • A servlet to serve up images

The image tag includes the project name and commit hash in the URL. The servlet uses this with JGit to retrieve the content of files in the code review, and parses them using a Java parser. The resulting ASTs are used to create a GraphViz Dot representation of a diagram, which is then sent to a GraphViz server to generate an SVG.

How To Use

Use Maven to build:

$ mvn package

Use Docker to bring up an environment:

$ cd docker
$ docker-compose up

License

Copyright 2018 Tasktop Technologies Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.