Harmony first step

Harmony First Steps

Mining Software Repository with Java

Harmony - Tutorial 1

INSTALL AND RUN


Requirements
Install
• Java 1.7
– http://www.java.com
• Mercurial
– http://mercurial.selenic.com/
• Maven
– http://maven.apache.org/
• H2 (Used in this tuto to open the database)
– http://www.h2database.com/html/main.html


Install & Run
1. Download
hg clone https://code.google.com/p/harmony.harmony/ harmony

2. Install
cd harmony
mvn install compile –DskipTests

3. Run
cd cli
mvn exec:java -Dexec.args="samples/configs/dummy.json
samples/sources/harmony-test.json"


Harmony’s Goal
• Harmony builds a model of a repository.
• Once the model is built, harmony launches analysis
=> The model and the analysis outputs are stored in a database

Harmony Analysis

Harmony Core Harmony Data Base
Versioned Items
(Git, Mercurial, BugZilla)


First Run
cd cli
mvn exec:java -Dexec.args="samples/configs/dummy.json
samples/sources/harmony-test.json"
• dummy.json states that Harmony should
launch the DummyAnalysis
• harmony-test.json states that Harmony
should fetch the HarmonyTest repository

=> /tmp/dummy.h2.db is the returned database


The Harmony Model (Core)
• A Source is a repository
Source • An Item is a versioned
software artefact (a
source code file or a bug)
Event Item • An Event occurs (commit,
merge, new bugs, etc.)
Action • Action is performed on
items (add, change,
delete)
Author • Author executes actions


First Run Model (1/2)
• Launch H2 and open the /tmp/dummy
database

jdbc:h2:file:/tmp/dummy


First Run Model (2/2)

This query returns all
authors


Config: dummy.json
{
"database" : {
"url" : jdbc:h2:/tmp/dummy;LOCK_TIMEOUT=10000",
"user" : "SA",
"password" : "", DataBase
"driver" : "org.h2.Driver",
"dialect" : "org.hibernate.dialect.H2Dialect",
"mappings" : []
},
"create-sources" : {
"threads" : 1,
"timeout" : 100000
Thread Policy
},
"source-analyses" : [
{
"class" : "fr.labri.harmony.analysis.dummy.DummyAnalysis" Analysis
}
]
}

Sources: harmony-test.json

[
{
"url" : "https://code.google.com/p/harmony.harmony-test/", URL
"class" : "fr.labri.harmony.source.vcs.hg.Hg4JAdapter"
}
]

Harmony Adapter


Existing Configs & Sources
• cli/samples contains several configs and sources
• Examples
– Configs
• Compute Source Code Metrics
– /samples/configs/metrics-h2.json
• Compute Bug Metrics for GitHub Bugs
– /samples/configs/git-issues.json
– Sources
• Harmony Source code
– /samples/sources/harmony.json
• GitHub Bugs
– /samples/sources/git-issues-test.json


Let’s Try !
1. Run Harmony DummyAnalysis on harmony
2. Run Harmony DummyAnalysis on a Git
repository
3. Run Harmony MetricsAnalysis on harmony
4. Run Harmony GitHubAnalysis on GitHub test


CUSTOMIZE AN EXISTING ANALYSIS


Analysis
• Each analysis is a development project
– analysis.*
• Artefact, bugCycleCorrelation, cloc, digraph, dummy,
metrics, ownership, etc.
• Each analysis project must have a class that
extends SourceAnalysis
– fr.labri.harmony.analysis.dummy.DummyAnalysis
• Such a class must override the perform method
– public void perform(Source src) throws
WorkspaceException


Customize DummyAnalysis
• Modify the DummyAnalysis class to print
Event native id !
public void perform(Source src) throws WorkspaceException {
for (Event ev : src.getEvents())
System.out.println(ev.getNativeId());
}

• Compile and run !


Let’s Try !
• Change the dummy analysis:
1. to get all authors !
Source.getAuthors
2. To get the first commit !
Event.getParents
3. To get all items that have been modified by
the same author !
4. …

Analysis Output
• Store the result of your analysis whithin the
database
• Have a look at the CLOC analysis to
understand how we use hibernate


CONCLUSION


Harmony is good for
• Repository Mining
• Use existing analysis
• Create your own analysis
• Exploit the output of your analysis

https://code.google.com/p/harmony/


Harmony first step

More Related Content

What's hot (20)

Similar to Harmony first step (20)

Harmony first step