Sample Projects
The samples directory in Glean has a set of properties files to configure
Glean for a number of sample projects. If you are looking for what a project configuration
might look like, these can give you a start.
To run Glean using these sample configurations, you will need to download the source
(links included in the table below), and in most cases build them.
See the instructions that come with
each of them, but it is usually a case of running "ant" from the command line).
You will also likely need to update the configuration to define project.root
for the location where you installed the project.
Once you have the sample's source installed, you can run the script, passing to
Glean an additional property telling it where your sample is rooted.
Alternatively, you can edit the sample property file and put the full path in there.
For example, here is how you would run the commons-lang sample if
you unpacked the source in /path/to/samples/root.
ant -Dfeedback.properties=samples/commons-lang.feedback.properties \
-Dsamples.home=/path/to/samples/root.
| Tool | Apache Ant 1.6.5 | Jakarta Commons-Lang 2.3 | Petstore Main | Petstore Supplier | Petstore Webapp Framework | JDOM | Spring PetClinic Sample App | Struts Cookbook Sample App |
|---|---|---|---|---|---|---|---|---|
| beandoc | x | |||||||
| checkstyle | x | x | x | |||||
| ckjm | x | x | ||||||
| classycle | x | |||||||
| cobertura | x | x | ||||||
| cpd | x | x | x | x | ||||
| dashboard | x | x | x | |||||
| dbdoclet | x | |||||||
| depfind | x | x | ||||||
| doccheck | x | |||||||
| emma | x | |||||||
| findbugs | x | x | ||||||
| jaranalyzer | x | x | ||||||
| java2html14 | x | x | x | x | x | x | x | |
| java2html15 | x | |||||||
| javadoc | x | x | x | x | x | |||
| javancss | x | x | x | x | x | x | x | |
| jcsc | x | |||||||
| jdepend | x | x | x | x | ||||
| junitpdfreport | x | |||||||
| junitreport | x | x | ||||||
| linguine-ant | x | |||||||
| linguine-hbm | ||||||||
| pmd | x | x | x | x | x | x | x | |
| qalab | x | |||||||
| schemaspy | ||||||||
| statcvs | x | |||||||
| statsvn | x | |||||||
| umlgraph-doc | x | |||||||
| umlgraph-views | ||||||||
| xradar | x | x |
Notes on the sample projects
JDOM
In order for StatCVS to work, it needs to have a checked out working copy of the code. So rather than download a source bundle, you should get the source using the instructions for anonymous CVS access to the JDOM repository.
The JDOM source does not come with the unit tests, so in order to get the Emma or Cobertura reports, you will also need to download the test bundle as well.
Commons-lang
Like with StatCVS, in order for StatSVN to work, it needs a checked out working copy of the code. To run the Commons-lang sample, then, grab the source through their anonymous Subversion access.
Java Petstore
Sun's Petstore application is large and multi-faceted. Gathering feedback from this code is an example of how you might set Glean up for a project with multiple components. In this case, the single application is broken up into multiple feedback builds, one for each component source tree.
Struts Sample Application
The Struts Cookbook sample application is a standard MVC application, and therefore likely to be recognizable for many groups. However, Struts has moved to Maven as its build platform, so the source distribution may not be buildable by everyone. For Glean, that simply means that only tools that rely just on source code can be used; others that rely on class files (for example, JDepend) or executable unit tests (Emma and Cobertura) can't be used.
If you have Maven, though, and are able to build the sample application, you can
update the struts-cookbook.feedback.properties file to run whichever
tools you like against it.