Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.teamscale.maven.upload;
import com.google.common.base.Strings;
import com.teamscale.maven.GitCommit;
import com.teamscale.maven.TeamscaleMojoBase;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import shadow.com.teamscale.client.CommitDescriptor;
import shadow.com.teamscale.client.EReportFormat;
import shadow.com.teamscale.client.TeamscaleClient;
import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
/**
* Run this goal after the Jacoco report generation to upload them to a
* configured Teamscale instance. The configuration can be specified in the root
* Maven project. Offers the following functionality:
*
*
Validate Jacoco Maven plugin configuration
*
Locate and upload all reports in one session
*
*
* @see Jacoco
* Plugin
*/
@Mojo(name = "upload-coverage", defaultPhase = LifecyclePhase.VERIFY, requiresDependencyResolution = ResolutionScope.RUNTIME,
threadSafe = true)
public class CoverageUploadMojo extends TeamscaleMojoBase {
private static final String JACOCO_PLUGIN_NAME = "org.jacoco:jacoco-maven-plugin";
private static final String COVERAGE_UPLOAD_MESSAGE = "Coverage upload via Teamscale Maven plugin";
/**
* The Teamscale partition name to which unit test reports will be uploaded.
*/
@Parameter(property = "teamscale.unitTestPartition", defaultValue = "Unit Tests")
public String unitTestPartition;
/**
* The Teamscale partition name to which integration test reports will be
* uploaded.
*/
@Parameter(property = "teamscale.integrationTestPartition", defaultValue = "Integration Tests")
public String integrationTestPartition;
/**
* The Teamscale partition name to which aggregated test reports will be
* uploaded.
*/
@Parameter(property = "teamscale.aggregatedTestPartition", defaultValue = "Aggregated Tests")
public String aggregatedTestPartition;
/**
* The output directory of the testwise coverage reports. Should only be set if
* testwise coverage is uploaded.
*/
@Parameter()
public String testwiseCoverageOutputFolder;
/**
* The Teamscale partition name to which testwise coverage reports will be
* uploaded.
*/
@Parameter(property = "teamscale.testwisePartition", defaultValue = "Testwise Coverage")
public String testwisePartition;
/**
* Paths to all reports generated by subprojects
*
* @see report
*/
private final List reportGoalOutputFiles = new ArrayList<>();
/**
* Paths to all integration reports generated by subprojects
*
* @see report-integration
*/
private final List reportIntegrationGoalOutputFiles = new ArrayList<>();
/**
* The project build directory (usually: {@code ./target}). Provided
* automatically by Maven.
*/
@Parameter(defaultValue = "${project.build.directory}")
public String projectBuildDir;
/**
* Paths to all aggregated reports generated by subprojects
*
* @see report-aggregate
*/
private final List reportAggregateGoalOutputFiles = new ArrayList<>();
/**
* The Teamscale client that is used to upload reports to a Teamscale instance.
*/
private TeamscaleClient teamscaleClient;
@Override
public void execute() throws MojoFailureException {
if (skip) {
getLog().debug("Skipping since skip is set to true");
return;
}
if (!session.getCurrentProject().equals(session.getTopLevelProject())) {
getLog().debug("Skipping since upload should only happen in top project");
return;
}
teamscaleClient = new TeamscaleClient(teamscaleUrl, username, accessToken, projectId);
getLog().debug("Resolving end commit");
resolveEndCommit();
resolveRevision();
getLog().debug("Parsing Jacoco plugin configurations");
parseJacocoConfiguration();
try {
getLog().debug("Uploading coverage reports");
uploadCoverageReports();
} catch (IOException e) {
throw new MojoFailureException(
"Uploading coverage reports failed. No upload to Teamscale was performed. You can try again or upload the XML coverage reports manually, see https://docs.teamscale.com/reference/ui/project/project/#manual-report-upload",
e);
}
}
/**
* Check that Jacoco is set up correctly and read any custom settings that may
* have been set
*
* @throws MojoFailureException
* If Jacoco is not set up correctly
*/
private void parseJacocoConfiguration() throws MojoFailureException {
collectReportOutputDirectory(session.getTopLevelProject(), "report", "jacoco", reportGoalOutputFiles);
collectReportOutputDirectory(session.getTopLevelProject(), "report-integration", "jacoco-it",
reportIntegrationGoalOutputFiles);
collectReportOutputDirectory(session.getTopLevelProject(), "report-aggregate", "jacoco-aggregate",
reportAggregateGoalOutputFiles);
getLog().debug(
String.format("Found %d sub-modules", session.getTopLevelProject().getCollectedProjects().size()));
for (MavenProject subProject : session.getTopLevelProject().getCollectedProjects()) {
collectReportOutputDirectory(subProject, "report", "jacoco", reportGoalOutputFiles);
collectReportOutputDirectory(subProject, "report-integration", "jacoco-it",
reportIntegrationGoalOutputFiles);
collectReportOutputDirectory(subProject, "report-aggregate", "jacoco-aggregate",
reportAggregateGoalOutputFiles);
}
}
/**
* Collect the file locations in which JaCoCo is configured to save the XML
* coverage reports
*
* @param project
* The project
* @param reportGoal
* The JaCoCo report goal
* @param jacocoDirectory
* The name of the directory, matching the JaCoCo goal
* @see Goals
*/
private void collectReportOutputDirectory(MavenProject project, String reportGoal, String jacocoDirectory,
List reportOutputFiles) throws MojoFailureException {
Path defaultOutputDirectory = Paths.get(project.getReporting().getOutputDirectory());
// If a Dom is null it means the execution goal uses default parameters which work correctly
Xpp3Dom reportConfigurationDom = getJacocoGoalExecutionConfiguration(project, reportGoal);
String errorMessage = "Skipping upload for %s as %s is not configured to produce XML reports for goal %s. See https://www.jacoco.org/jacoco/trunk/doc/report-mojo.html#formats";
if (!validateReportFormat(reportConfigurationDom)) {
throw new MojoFailureException(
String.format(errorMessage, project.getName(), JACOCO_PLUGIN_NAME, jacocoDirectory));
}
Path resolvedCoverageFile = getCustomOutputDirectory(reportConfigurationDom).orElse(defaultOutputDirectory)
.resolve(jacocoDirectory).resolve("jacoco.xml");
getLog().debug(String.format("Adding possible report location: %s", resolvedCoverageFile));
reportOutputFiles.add(resolvedCoverageFile);
}
private void uploadCoverageReports() throws IOException {
Path reportPath;
if (Strings.isNullOrEmpty(testwiseCoverageOutputFolder)) {
reportPath = Paths.get(projectBuildDir, "tia", "reports");
} else {
reportPath = Paths.get(testwiseCoverageOutputFolder);
}
File[] files = reportPath.toFile().listFiles(File::isFile);
if (files != null) {
List testwiseCoverageFiles = Arrays.asList(files);
getLog().debug("Uploading testwise coverage to partition " + testwisePartition);
uploadCoverage(testwiseCoverageFiles.stream().map(File::toPath).collect(Collectors.toList()),
testwisePartition, EReportFormat.TESTWISE_COVERAGE);
}
uploadCoverage(reportGoalOutputFiles, unitTestPartition, EReportFormat.JACOCO);
uploadCoverage(reportIntegrationGoalOutputFiles, integrationTestPartition, EReportFormat.JACOCO);
uploadCoverage(reportAggregateGoalOutputFiles, aggregatedTestPartition, EReportFormat.JACOCO);
}
private void uploadCoverage(List reportOutputFiles, String partition, EReportFormat format)
throws IOException {
List reports = new ArrayList<>();
getLog().debug(String.format("Scanning through %d locations for %s...", reportOutputFiles.size(), partition));
for (Path reportPath : reportOutputFiles) {
File report = reportPath.toFile();
if (!report.exists()) {
getLog().debug(String.format("Cannot find %s, skipping...", report.getAbsolutePath()));
continue;
}
if (!report.canRead()) {
getLog().warn(String.format("Cannot read %s, skipping!", report.getAbsolutePath()));
continue;
}
reports.add(report);
}
if (!reports.isEmpty()) {
getLog().info(
String.format("Uploading %d report for project %s to %s", reports.size(), projectId,
partition));
teamscaleClient.uploadReports(format, reports, CommitDescriptor.parse(resolvedCommit), revision, partition,
COVERAGE_UPLOAD_MESSAGE);
} else {
getLog().info(String.format("Found no valid reports for %s", partition));
}
}
/**
* Validates that a configuration Dom is set up to generate XML reports
*
* @param configurationDom
* The configuration Dom of a goal execution
*/
private boolean validateReportFormat(Xpp3Dom configurationDom) {
if (configurationDom == null || configurationDom.getChild("formats") == null) {
return true;
}
for (Xpp3Dom format : configurationDom.getChild("formats").getChildren()) {
if (format.getValue().equals("XML")) {
return true;
}
}
return false;
}
private Optional getCustomOutputDirectory(Xpp3Dom configurationDom) {
if (configurationDom != null && configurationDom.getChild("outputDirectory") != null) {
return Optional.of(Paths.get(configurationDom.getChild("outputDirectory").getValue()));
}
return Optional.empty();
}
private Xpp3Dom getJacocoGoalExecutionConfiguration(MavenProject project, String pluginGoal) {
return super.getExecutionConfigurationDom(project, JACOCO_PLUGIN_NAME, pluginGoal);
}
private void resolveRevision() throws MojoFailureException {
if (StringUtils.isNotBlank(revision)) {
resolvedRevision = revision;
} else {
Path basedir = session.getCurrentProject().getBasedir().toPath();
try {
GitCommit commit = GitCommit.getGitHeadCommitDescriptor(basedir);
resolvedRevision = commit.sha1;
} catch (IOException e) {
throw new MojoFailureException("There is no configured in the pom.xml" +
" and it was not possible to determine the current revision in " + basedir + " from Git", e);
}
}
}
}
