/*
* This program is copyright (c) 2007 Hortis-GRC SA.
*
* This file is part of Sonar.
* Sonar is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Sonar is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
package ch.hortis.sonar.mvn;
import ch.hortis.sonar.jpa.Persistence;
import ch.hortis.sonar.jpa.Persistence.CreationException;
import ch.hortis.sonar.jpa.Persistence.ModelException;
import ch.hortis.sonar.model.*;
import ch.hortis.sonar.mvn.mc.MetricData;
import ch.hortis.sonar.mvn.mc.MetricsCollector;
import ch.hortis.sonar.service.MavenProjectService;
import ch.hortis.sonar.service.MetricService;
import ch.hortis.sonar.service.SnapshotGroupService;
import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import javax.persistence.EntityManager;
import javax.persistence.NoResultException;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
/**
* Main sonar plugin reports for plugins metrics parsing and historic generation
*
* @goal sonar
* @execute goal="prepare"
*/
public class SonarMojo extends AbstractMojo {
public static boolean firstCall = false;
/**
* The maven project running this plugin
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private org.apache.maven.project.MavenProject mavenProject;
/**
* JDBC URL
*
* @parameter expression="${sonar.jdbc.url}" default-value="jdbc:mysql://localhost:3306/sonar" alias="sonar.jdbc.url"
*/
private String jdbcURL;
/**
* JDBC driver class
*
* @parameter expression="${sonar.jdbc.driver}" default-value="com.mysql.jdbc.Driver" alias="sonar.jdbc.driver"
*/
private String jdbcDriverClassName;
/**
* JDBC user name
*
* @parameter expression="${sonar.jdbc.username}" default-value="sonar" alias="sonar.jdbc.username"
*/
private String jdbcUserName;
/**
* JDBC password
*
* @parameter expression="${sonar.jdbc.password}" default-value="sonar" alias="sonar.jdbc.password"
*/
private String jdbcPassword;
/**
* Project branch
*
* @parameter alias="branch" default-value="HEAD" expression="${branch}"
*/
private String branch;
private EntityManager manager;
private Date runDate;
public void setJdbcURL(String jdbcURL) {
this.jdbcURL = jdbcURL;
}
public void setJdbcDriverClassName(String jdbcDriverClassName) {
this.jdbcDriverClassName = jdbcDriverClassName;
}
public void setJdbcUserName(String jdbcUserName) {
this.jdbcUserName = jdbcUserName;
}
public void setJdbcPassword(String jdbcPassword) {
this.jdbcPassword = jdbcPassword;
}
public String getBranch() {
return branch;
}
public void setBranch(String branch) {
this.branch = branch;
}
public JdbcData getJdbcData() {
return new JdbcData(jdbcURL, jdbcDriverClassName, jdbcUserName, jdbcPassword);
}
public Integer getMavenRunSnapshotGroup() {
try {
String group = System.getProperty(SonarMojo.class.getName() + "snaphsotGroupId");
if (group != null) {
return new Integer(group);
}
} catch (SecurityException ex) {
}
return null;
}
private void setMavenRunSnapshotGroup(Integer snapshotGroup) {
try {
System.setProperty(SonarMojo.class.getName() + "snaphsotGroupId", snapshotGroup.toString());
} catch (SecurityException ex) {
}
}
public void execute() throws MojoExecutionException {
boolean externalManager = manager != null;
runDate = new Date();
if ( !externalManager ) {
manager = getPersistence().getManager();
}
MavenProject sonarProject;
try {
manager.getTransaction().begin();
sonarProject = saveMavenProject(mavenProject, null);
manager.getTransaction().commit();
} catch (Exception ex) {
manager.getTransaction().rollback();
throw new MojoExecutionException("Error occured during maven project DB persistance", ex);
}
if ( firstCall && sonarProject.getParent() != null ) {
MavenProject top = sonarProject.getParent();
while ( top.getParent() != null ) {
top = top.getParent();
}
getLog().info( "Sonar plugin cannot be called from child module " +
sonarProject.getGroupId() + ":" + sonarProject.getArtifactId() +
", please run it from the " + top.getGroupId() + ":" + top.getArtifactId() + " project POM" );
return;
}
firstCall = false;
Collection<ProjectMetricMeasure> measures = new ArrayList<ProjectMetricMeasure>();
try {
if (!mavenProject.getPackaging().equals("pom")) {
for (Report report : Report.getReports()) {
Collection<ProjectMetricMeasure> tmp = collectMeasures(report);
measures.addAll(tmp);
}
}
persistMeasures(measures, sonarProject);
} finally {
if ( !externalManager ) {
manager.close();
manager = null;
}
runDate = null;
}
}
private Persistence getPersistence() throws MojoExecutionException {
Persistence persistence;
try {
persistence = Persistence.create(getJdbcData());
} catch (ModelException e) {
throw new MojoExecutionException("DB model exception occured", e);
} catch (CreationException e) {
throw new MojoExecutionException("DB model creation error occured", e);
}
return persistence;
}
private Collection<ProjectMetricMeasure> collectMeasures(Report report) throws MojoExecutionException {
if (mavenProject.getParent() != null) {
getLog().info("Parent module : " + mavenProject.getParent().getGroupId() + ":" + mavenProject.getParent().getArtifactId());
}
getLog().info("Collecting information for plugin " + report);
MetricsCollector collector = report.getMetricsCollector();
collector.enableLogging(getLog());
Collection<ProjectMetricMeasure> measures = new ArrayList<ProjectMetricMeasure>();
if (collector.initialize(mavenProject)) {
Collection<MetricData> metricsData = collector.collectMeasures();
measures = getMetrics( metricsData );
}
return measures;
}
private Collection<ProjectMetricMeasure> getMetrics( Collection<MetricData> metricsData ) {
MetricService service = new MetricService(manager);
Collection<ProjectMetricMeasure> measures = new ArrayList<ProjectMetricMeasure>();
for (MetricData metricData : metricsData ) {
Metric metric = service.getMetric( metricData.getMetric().getName(), metricData.getMetric().getGroupId(), metricData.getMetric().getArtifactId() );
ProjectMetricMeasure measure = new ProjectMetricMeasure();
measure.setMetric( metric );
measure.setValue( metricData.getValue() );
measures.add(measure);
}
return measures;
}
private void persistMeasures(Collection<ProjectMetricMeasure> collectedMeasures, MavenProject sonarProject) throws MojoExecutionException {
ProjectSnapshot snapshot = new ProjectSnapshot();
snapshot.setDate(runDate);
snapshot.setProjectMetricMeasures(collectedMeasures);
createSnapshotLinks(mavenProject.getVersion(), snapshot, sonarProject);
manager.getTransaction().begin();
SnapshotGroup snapshotGroup;
try {
if (sonarProject.getParent() == null) {
snapshotGroup = new SnapshotGroup();
snapshotGroup.setDate(runDate);
snapshotGroup.setMavenProject(sonarProject);
manager.persist(snapshotGroup);
setMavenRunSnapshotGroup(snapshotGroup.getId());
} else {
Integer groupId = getMavenRunSnapshotGroup();
if (groupId != null) {
snapshotGroup = manager.find(SnapshotGroup.class, groupId);
if (snapshotGroup == null) {
throw new NoResultException();
}
} else {
SnapshotGroupService service = new SnapshotGroupService(manager);
MavenProject parent = sonarProject.getParent();
int maxDept = 100;
while (maxDept > 0) {
if (parent.getParent() == null) {
break;
}
parent = parent.getParent();
maxDept--;
}
// look for the last snapshot group created within the last 60 mins
snapshotGroup = service.getLastUnprocessedGroup(parent.getId(), (long) 60 * 60 * 1000, runDate.getTime());
}
}
} catch (NoResultException e) {
throw new MojoExecutionException("Unable to find the last snapshot group");
}
snapshot.setSnapshotGroup(snapshotGroup);
manager.persist(snapshot);
manager.getTransaction().commit();
}
private void createSnapshotLinks(String version, ProjectSnapshot snapshot, ch.hortis.sonar.model.MavenProject mvnProject) {
snapshot.setId(null);
snapshot.setMavenProject(mvnProject);
snapshot.setVersion(version);
for (ProjectMetricMeasure metrics : snapshot.getProjectMetricMeasures()) {
metrics.setId(null);
metrics.setProjectSnapshot(snapshot);
}
}
public void setProject(org.apache.maven.project.MavenProject mavenProject) {
this.mavenProject = mavenProject;
}
private MavenProject saveMavenProject(org.apache.maven.project.MavenProject mavenProject, MavenProject parentProjet)
throws XmlPullParserException, IOException {
MavenProjectService service = new MavenProjectService(manager);
MavenProject sonarProject;
try {
sonarProject = service.getMavenProject(mavenProject.getGroupId(), mavenProject.getArtifactId(), getBranch());
updateMavenProject(sonarProject, mavenProject, parentProjet);
manager.merge(sonarProject);
} catch (NoResultException e) {
sonarProject = new MavenProject();
sonarProject.setArtifactId(mavenProject.getArtifactId());
sonarProject.setGroupId(mavenProject.getGroupId());
sonarProject.setBranch(getBranch());
updateMavenProject(sonarProject, mavenProject, parentProjet);
manager.persist(sonarProject);
}
saveModules(sonarProject, mavenProject);
return sonarProject;
}
private void updateMavenProject(MavenProject sonarProject, org.apache.maven.project.MavenProject mavenProject, MavenProject parentProjet) {
sonarProject.setSiteURL(mavenProject.getUrl());
sonarProject.setName(mavenProject.getName());
sonarProject.setDescription(mavenProject.getDescription());
if (parentProjet != null) {
sonarProject.setParent(parentProjet);
}
}
private void saveModules(MavenProject sonarProject, org.apache.maven.project.MavenProject mavenProject) throws IOException,
XmlPullParserException {
for (Object o : mavenProject.getModules()) {
String moduleName = (String) o;
MavenXpp3Reader pomReader = new MavenXpp3Reader();
File moduleFile = new File(mavenProject.getBasedir() + "/" + moduleName + "/pom.xml");
Model model = pomReader.read(new FileReader(moduleFile));
org.apache.maven.project.MavenProject module = new org.apache.maven.project.MavenProject(model);
if (module.getBasedir() == null) {
module.setFile(moduleFile);
}
saveMavenProject(module, sonarProject);
}
}
protected void setManager( EntityManager manager ) {
this.manager = manager;
}
}