org.apache.maven.dotnet.SrcMonCommandGenerator Maven / Gradle / Ivy
Go to download
A plugin that provides general build and test facilities for .Net projects and solutions
The newest version!
/*
* Maven and Sonar plugin for .Net
* Copyright (C) 2010 Jose Chillan and Alexandre Victoor
* mailto: [email protected] or [email protected]
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
/*
* Created on Apr 7, 2009
*/
package org.apache.maven.dotnet;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.GregorianCalendar;
import java.util.List;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.PropertyException;
import javax.xml.datatype.DatatypeConfigurationException;
import javax.xml.datatype.DatatypeFactory;
import javax.xml.datatype.XMLGregorianCalendar;
import org.apache.maven.dotnet.metrics.xml.Command;
import org.apache.maven.dotnet.metrics.xml.Configuration;
import org.apache.maven.dotnet.metrics.xml.Export;
import org.apache.maven.dotnet.metrics.xml.SourceSubdirectoryList;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Generates the command file for SourceMonitor to be applied to a C# project or
* solution.
*
* @author Jose CHILLAN Apr 7, 2009
*/
public class SrcMonCommandGenerator {
private final static Logger logger = LoggerFactory.getLogger(SrcMonCommandGenerator.class);
private File workDirectory;
/**
* Path of the source monitor executable.
*/
private String sourceMonitorPath;
private String projectFile;
private String checkPointName;
private String sourcePath;
private List excludedDirectories;
private List excludedExtensions;
private String generatedFile;
public SrcMonCommandGenerator() {
this.excludedDirectories = new ArrayList();
this.excludedExtensions = new ArrayList();
}
/**
* Launches the report generation.
*
* @throws Exception
*/
public void launch() throws Exception {
logger.info("Launching Source Monitor on the project");
File commandFile = generateCommandFile();
String[] cmdArray = new String[] { sourceMonitorPath, "/C",
commandFile.getAbsolutePath() };
logger.debug(("Executing command: " + Arrays.toString(cmdArray)));
Process process = Runtime.getRuntime().exec(cmdArray, null, workDirectory);
// We wait for the execution
process.waitFor();
}
/**
* @return
* @throws JAXBException
* @throws PropertyException
* @throws FileNotFoundException
*/
protected File generateCommandFile() throws JAXBException, PropertyException,
FileNotFoundException {
Configuration configuration = new Configuration();
configuration.setLog(true);
Command command = new Command();
command.setProjectFile(projectFile);
command.setProjectLanguage("C#");
StringBuilder extensions = new StringBuilder("*.cs");
if ((excludedExtensions != null) && (!excludedDirectories.isEmpty())) {
extensions.append("|");
boolean isFirst = true;
for (String exclusion : excludedExtensions) {
if (isFirst) {
isFirst = false;
} else {
extensions.append(",");
}
extensions.append(exclusion.trim());
}
}
command.setFileExtensions(extensions.toString());
command.setSourceDirectory(sourcePath);
command.setCheckPointName(checkPointName);
command.setIgnoreHeaderFooters(false);
command.setIncludeSubdirectories(true);
try {
DatatypeFactory factory = DatatypeFactory.newInstance();
XMLGregorianCalendar calendar = factory
.newXMLGregorianCalendar(new GregorianCalendar());
command.setCheckPointDate(calendar.toXMLFormat().substring(0, 19));
} catch (DatatypeConfigurationException e) {
// should not happen
logger.debug("datat type error", e);
}
logger.debug("Code Metrics report :");
logger.debug((" - OutputType Project File : " + projectFile));
logger.debug((" - Source Directory : " + sourcePath));
logger.debug((" - Source Monitor path : " + sourceMonitorPath));
logger.debug((" - Generated report : " + generatedFile));
SourceSubdirectoryList sourceSubdirectoryList = new SourceSubdirectoryList();
sourceSubdirectoryList.setExcludeSubdirectories(true);
// .replace('/', '\\')
String[] excludedArray = new String[excludedDirectories.size()];
// We build the list of excluded directory
for (int idxDirectory = 0; idxDirectory < excludedArray.length; idxDirectory++) {
String directory = excludedDirectories.get(idxDirectory);
excludedArray[idxDirectory] = directory.replace('/', '\\');
}
sourceSubdirectoryList.setSourceSubdirectory(new String[] { "obj\\debug",
"obj\\release" });
sourceSubdirectoryList.setSourceSubTree(excludedArray);
command.setSubdirectoryList(sourceSubdirectoryList);
Export export = new Export();
export.setFile(generatedFile);
export.setType("2");
command.setExport(export);
configuration.setCommands(Collections.singletonList(command));
// Establish a JAXB context
Class serializedType = Configuration.class;
JAXBContext jc = JAXBContext.newInstance(serializedType);
// Get a marshaller
Marshaller marshaller = jc.createMarshaller();
// Enable formatted xml output
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
// Defines additional properties
// marshaller.setProperty("com.sun.xml.bind.indentString", " ");
// Marshal to system output: java to xml
if (!workDirectory.exists()) {
// We create the directory if necessary
workDirectory.mkdir();
}
File commandFile = new File(workDirectory, "source-monitor-command.xml");
OutputStream stream = new FileOutputStream(commandFile);
marshaller.marshal(configuration, stream);
logger.debug(("Source Monitor command file generated : " + commandFile));
return commandFile;
}
/**
* Returns the workDirectory.
*
* @return The workDirectory to return.
*/
public File getWorkDirectory() {
return this.workDirectory;
}
/**
* Sets the workDirectory.
*
* @param workDirectory
* The workDirectory to set.
*/
public void setWorkDirectory(File workDirectory) {
this.workDirectory = workDirectory;
}
/**
* Returns the sourceMonitorPath.
*
* @return The sourceMonitorPath to return.
*/
public String getSourceMonitorPath() {
return this.sourceMonitorPath;
}
/**
* Sets the sourceMonitorPath.
*
* @param sourceMonitorPath
* The sourceMonitorPath to set.
*/
public void setSourceMonitorPath(String sourceMonitorPath) {
this.sourceMonitorPath = sourceMonitorPath;
}
/**
* Returns the checkPointName.
*
* @return The checkPointName to return.
*/
public String getCheckPointName() {
return this.checkPointName;
}
/**
* Sets the checkPointName.
*
* @param checkPointName
* The checkPointName to set.
*/
public void setCheckPointName(String checkPointName) {
this.checkPointName = checkPointName;
}
/**
* Returns the sourcePath.
*
* @return The sourcePath to return.
*/
public String getSourcePath() {
return this.sourcePath;
}
/**
* Sets the sourcePath.
*
* @param sourcePath
* The sourcePath to set.
*/
public void setSourcePath(String sourcePath) {
this.sourcePath = sourcePath;
}
/**
* Returns the excludedDirectories.
*
* @return The excludedDirectories to return.
*/
public List getExcludedDirectories() {
return this.excludedDirectories;
}
/**
* Sets the excludedDirectories.
*
* @param excludedDirectories
* The excludedDirectories to set.
*/
public void setExcludedDirectories(List excludedDirectories) {
this.excludedDirectories = excludedDirectories;
}
/**
* Add a new directory to exclude (and all its subdirectories)
*
* @param directory
*/
public void addExcludedDirectory(String directory) {
excludedDirectories.add(directory);
}
/**
* Adds a new extension to exclude.
*
* @param extension
*/
public void addExcludedExtension(String extension) {
excludedExtensions.add(extension);
}
/**
* Returns the generatedFile.
*
* @return The generatedFile to return.
*/
public String getGeneratedFile() {
return this.generatedFile;
}
/**
* Sets the generatedFile.
*
* @param generatedFile
* The generatedFile to set.
*/
public void setGeneratedFile(String generatedFile) {
this.generatedFile = generatedFile;
}
/**
* Returns the projectFile.
*
* @return The projectFile to return.
*/
public String getProjectFile() {
return this.projectFile;
}
/**
* Sets the projectFile.
*
* @param projectFile
* The projectFile to set.
*/
public void setProjectFile(String projectFile) {
this.projectFile = projectFile;
}
public List getExcludedExtensions() {
return this.excludedExtensions;
}
public void setExcludedExtensions(List excludedExtensions) {
this.excludedExtensions = excludedExtensions;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy