Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 bvm.gemspec
README.md

BVM (Big Visible Metrics)

BVM helps you generate Big Visible Charts of Sonar Code Metrics for your teamspace. It is a simple command line utility that parses the data exposed as XML via the Sonar API. It converts this XML into CSV data that is consumable using Microsoft Treemapper or a tool of your choice.

Installing

Installation is super easy. Just enter:

gem install bvm

Once it is installed, you may also want to install Microsoft Treemapper. Download it from Microsoft's site and follow the installation instructions.

Typical Usage

This sample generates a CSV file ready for Microsoft Treemapper to use against the Apache's Maven source. The size of the box represents the numbers of lines of code (the ncloc metric) in the class and the color reflects the cyclomatic complexity. In this case, a complexity of 50 is the threshold between red and green on the chart.

curl -X GET "http://nemo.sonarsource.org/api/resources?resource=99176&metrics=ncloc,complexity&depth=-1&qualifiers=CLA&format=xml" | bvm --jar maven --color complexity --invert-color --color-adjust 50 > maven-complexity.csv

This generates a similar data set for code coverage. In this case, the coverage threshold is set to 80%.

curl -X GET "http://nemo.sonarsource.org/api/resources?resource=99176&metrics=ncloc,coverage&depth=-1&qualifiers=CLA&format=xml" | bvm --jar maven --color coverage --color-adjust 80 > maven-coverage.csv

The Details

The CSV content that BVM generates consists of the following format:

<size_metric>,<color_metric>,<jar_name>,<package_name>,<class_name>

The size metric is self-explanatory. It's the size of the box to be generated. By default is it set to ncloc and this is probably what you will always want. It can be changed using the --size switch and specifying a different Sonar metric.

The color metric defaults to coverage. You will probably want this to be several different values, depending on the charts you want to generate. It can be specified using the --color switch.

Microsoft Treemapper expects that negative numbers are red and positive numbers are green but our metrics aren't quite so compliant. The --invert-color switch will multiply the specified color metric by -1 to accomodate the charts you are trying to create. Furthermore, the --color-adjust switch can be given a number that will be added to the specified metric before being outputed. This allows us to set thresholds of tolerance for our charts.

The JAR name is really just the project name. If you have multiple JARs in your project (and who doesn't) then the --jar switch will allow you to group them all into one file and generate one enormous view of your entire codebase. It defaults to "jar" and you probably always want to override it.

If you are command line savvy you probably noticed that BVM does not actually operate on files. It reads STDIN and writes STDOUT.

Copyright

Copyright (c) 2012 Guy Royse & Alyssa Diaz & Jacob Dingus. See LICENSE for further details.

Something went wrong with that request. Please try again.