/*
* Copyright 2013 - 2014 Felix Müller
*
* This file is part of CodeQ Invest.
*
* CodeQ Invest 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 3 of the License, or
* (at your option) any later version.
*
* CodeQ Invest 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 CodeQ Invest. If not, see <http://www.gnu.org/licenses/>.
*/
package org.codeqinvest.codechanges.scm.svn;
import com.google.common.collect.Maps;
import lombok.extern.slf4j.Slf4j;
import org.codeqinvest.codechanges.scm.CodeChurn;
import org.codeqinvest.codechanges.scm.CodeChurnCalculationException;
import org.codeqinvest.codechanges.scm.CodeChurnCalculator;
import org.codeqinvest.codechanges.scm.DailyCodeChurn;
import org.codeqinvest.codechanges.scm.ScmConnectionEncodingException;
import org.codeqinvest.codechanges.scm.ScmConnectionSettings;
import org.joda.time.LocalDate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.tmatesoft.svn.core.SVNException;
import org.tmatesoft.svn.core.auth.BasicAuthenticationManager;
import org.tmatesoft.svn.core.internal.wc2.ng.SvnDiffGenerator;
import org.tmatesoft.svn.core.wc2.SvnDiff;
import org.tmatesoft.svn.core.wc2.SvnOperationFactory;
import java.io.ByteArrayOutputStream;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
/**
* Calculates the code churn for files in a SVN repository.
*
* @author fmueller
*/
@Slf4j
@Service
public class SvnCodeChurnCalculatorService implements CodeChurnCalculator {
private static final String LINE_SEPARATOR = System.getProperty("line.separator", "\n");
private final SvnRevisionsRetriever revisionsRetrieverService;
private final SvnFileRetrieverService fileRetrieverService;
@Autowired
public SvnCodeChurnCalculatorService(SvnRevisionsRetriever revisionsRetrieverService, SvnFileRetrieverService fileRetrieverService) {
this.revisionsRetrieverService = revisionsRetrieverService;
this.fileRetrieverService = fileRetrieverService;
}
/**
* {@inheritDoc}
*/
@Override
public Collection<DailyCodeChurn> calculateCodeChurn(ScmConnectionSettings connectionSettings, String file, LocalDate startDay, int numberOfDays)
throws CodeChurnCalculationException, ScmConnectionEncodingException {
String currentFilePath = file;
int currentNumberOfDay;
long lastRevision = -1;
Map<LocalDate, DailyCodeChurn> codeChurns = Maps.newHashMap();
for (int i = 0; i <= numberOfDays; i++) {
currentNumberOfDay = i;
final LocalDate day = startDay.minusDays(i);
try {
final Collection<SvnFileRevision> revisions = revisionsRetrieverService.retrieveRevisions(connectionSettings, day).getRevisions(currentFilePath);
List<Double> codeChurnProportions = new ArrayList<Double>(revisions.size());
for (SvnFileRevision revision : revisions) {
if (lastRevision != -1 && revision.getRevision() == lastRevision) {
lastRevision = -1;
continue;
}
codeChurnProportions.add(calculateCodeChurnProportion(connectionSettings, revision));
if (!revision.getOldPath().equalsIgnoreCase(revision.getNewPath())) {
// file was moved or renamed => change the currentFilePath for next revision retrieving requests
currentFilePath = revision.getFilePartOfOldPath(connectionSettings);
// spawn get revisions request afterwards for new file name due it's possible that there are revision for it on the current day
if (existRevisionsForFileOnDay(connectionSettings, currentFilePath, day) && i - 1 == currentNumberOfDay - 1) {
// to prevent that the day index is incremented more than once when there are more renamed revision on the current day
i = currentNumberOfDay - 1;
lastRevision = revision.getRevision();
}
}
}
if (codeChurns.containsKey(day)) {
codeChurns.get(day).addCodeChurnProportions(codeChurnProportions);
} else {
codeChurns.put(day, new DailyCodeChurn(day, codeChurnProportions));
}
} catch (SVNException e) {
log.error("Error with svn server communication occurred!", e);
throw new CodeChurnCalculationException(e);
} catch (UnsupportedEncodingException e) {
log.error("An error with encoding settings of scm connection occurred! (settings: " + connectionSettings.toString() + ")", e);
throw new ScmConnectionEncodingException(e);
}
}
return codeChurns.values();
}
/**
* {@inheritDoc}
*/
@Override
public CodeChurn calculateCodeChurnForLastCommits(ScmConnectionSettings connectionSettings, String file, int numberOfCommits)
throws CodeChurnCalculationException, ScmConnectionEncodingException {
String currentFilePath = file;
try {
final Collection<SvnFileRevision> revisions = revisionsRetrieverService.retrieveRevisions(connectionSettings, numberOfCommits).getRevisions(currentFilePath);
List<Double> codeChurnProportions = new ArrayList<Double>(revisions.size());
for (SvnFileRevision revision : revisions) {
codeChurnProportions.add(calculateCodeChurnProportion(connectionSettings, revision));
if (!revision.getOldPath().equalsIgnoreCase(revision.getNewPath())) {
// file was moved or renamed => change the currentFilePath for next revision retrieving requests
String renamedFile = revision.getFilePartOfOldPath(connectionSettings);
CodeChurn codeChurnOfRenamedFile = calculateCodeChurnForLastCommits(connectionSettings, renamedFile, numberOfCommits);
codeChurnProportions.addAll(codeChurnOfRenamedFile.getCodeChurnProportions());
}
}
return new CodeChurn(codeChurnProportions);
} catch (SVNException e) {
log.error("Error with svn server communication occurred!", e);
throw new CodeChurnCalculationException(e);
} catch (UnsupportedEncodingException e) {
log.error("An error with encoding settings of scm connection occurred! (settings: " + connectionSettings.toString() + ")", e);
throw new ScmConnectionEncodingException(e);
}
}
private double calculateCodeChurnProportion(ScmConnectionSettings connectionSettings, SvnFileRevision revision) throws SVNException, UnsupportedEncodingException {
long codeChurn = retrieveCodeChurn(connectionSettings, revision);
try {
long linesPreviousCommit = fileRetrieverService.getFile(connectionSettings, revision.getOldPath(), revision.getRevision() - 1).countLines();
return codeChurn / (double) linesPreviousCommit;
} catch (SVNException e) {
// file could not be found for revision - 1 which means it was created and that means a code churn proportion of 1.0
return 1.0;
}
}
private boolean existRevisionsForFileOnDay(ScmConnectionSettings connectionSettings, String file, LocalDate day) {
try {
return !revisionsRetrieverService.retrieveRevisions(connectionSettings, day).getRevisions(file).isEmpty();
} catch (SVNException e) {
return false;
}
}
private long retrieveCodeChurn(ScmConnectionSettings connectionSettings, SvnFileRevision fileRevision) throws SVNException, UnsupportedEncodingException {
long codeChurn = 0L;
log.debug("Retrieve code churn for revision {}", fileRevision);
for (String line : retrieveDiffFromSvnServer(connectionSettings, fileRevision).split(LINE_SEPARATOR)) {
if ((line.startsWith("+") && !line.startsWith("+++")) || (line.startsWith("-") && !line.startsWith("---"))) {
codeChurn++;
}
}
return codeChurn;
}
private String retrieveDiffFromSvnServer(ScmConnectionSettings connectionSettings, SvnFileRevision fileRevision) throws SVNException, UnsupportedEncodingException {
SvnOperationFactory operationFactory = null;
try {
operationFactory = new SvnOperationFactory();
if (connectionSettings.hasUsername()) {
operationFactory.setAuthenticationManager(
new BasicAuthenticationManager(connectionSettings.getUsername(), connectionSettings.getPassword()));
}
SvnDiffGenerator diffGenerator = new SvnDiffGenerator();
diffGenerator.setEncoding(connectionSettings.getEncoding());
diffGenerator.setEOL(LINE_SEPARATOR.getBytes(Charset.forName(connectionSettings.getEncoding())));
ByteArrayOutputStream diffOutput = new ByteArrayOutputStream();
SvnDiff diff = operationFactory.createDiff();
diff.setSources(fileRevision.getOldSvnTarget(connectionSettings), fileRevision.getNewSvnTarget(connectionSettings));
diff.setDiffGenerator(diffGenerator);
diff.setOutput(diffOutput);
diff.run();
return new String(diffOutput.toByteArray(), connectionSettings.getEncoding());
} finally {
if (operationFactory != null) {
operationFactory.dispose();
}
}
}
}