-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement the test coverage feature (#1637)
- Jacoco is used to provide test coverage Support. Signed-off-by: Sheng Chen <[email protected]>
- Loading branch information
Showing
24 changed files
with
854 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
198 changes: 198 additions & 0 deletions
198
...va.test.plugin/src/main/java/com/microsoft/java/test/plugin/coverage/CoverageHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Microsoft Corporation and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package com.microsoft.java.test.plugin.coverage; | ||
|
|
||
| import com.microsoft.java.test.plugin.coverage.model.BranchCoverage; | ||
| import com.microsoft.java.test.plugin.coverage.model.LineCoverage; | ||
| import com.microsoft.java.test.plugin.coverage.model.MethodCoverage; | ||
| import com.microsoft.java.test.plugin.coverage.model.SourceFileCoverage; | ||
| import com.microsoft.java.test.plugin.util.JUnitPlugin; | ||
| import com.microsoft.java.test.plugin.util.ProjectTestUtils; | ||
|
|
||
| import org.eclipse.core.runtime.IPath; | ||
| import org.eclipse.core.runtime.IProgressMonitor; | ||
| import org.eclipse.jdt.core.IClasspathEntry; | ||
| import org.eclipse.jdt.core.IJavaProject; | ||
| import org.eclipse.jdt.core.JavaModelException; | ||
| import org.eclipse.jdt.internal.core.ClasspathEntry; | ||
| import org.eclipse.jdt.ls.core.internal.managers.ProjectsManager; | ||
| import org.jacoco.core.analysis.Analyzer; | ||
| import org.jacoco.core.analysis.CoverageBuilder; | ||
| import org.jacoco.core.analysis.IClassCoverage; | ||
| import org.jacoco.core.analysis.ICounter; | ||
| import org.jacoco.core.analysis.ILine; | ||
| import org.jacoco.core.analysis.IMethodCoverage; | ||
| import org.jacoco.core.analysis.ISourceFileCoverage; | ||
| import org.jacoco.core.analysis.ISourceNode; | ||
| import org.jacoco.core.tools.ExecFileLoader; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.net.URI; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.LinkedList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| public class CoverageHandler { | ||
|
|
||
| private IJavaProject javaProject; | ||
| private Path reportBasePath; | ||
|
|
||
| /** | ||
| * The Jacoco data file name | ||
| */ | ||
| private static final String JACOCO_EXEC = "jacoco.exec"; | ||
|
|
||
| public CoverageHandler(IJavaProject javaProject, String basePath) { | ||
| this.javaProject = javaProject; | ||
| reportBasePath = Paths.get(basePath); | ||
| } | ||
|
|
||
| public List<SourceFileCoverage> getCoverageDetail(IProgressMonitor monitor) throws JavaModelException, IOException { | ||
| if (ProjectsManager.DEFAULT_PROJECT_NAME.equals(javaProject.getProject().getName())) { | ||
| return Collections.emptyList(); | ||
| } | ||
| final List<SourceFileCoverage> coverage = new LinkedList<>(); | ||
| final Map<IPath, List<IPath>> outputToSourcePaths = getOutputToSourcePathsMapping(); | ||
|
|
||
| final File executionDataFile = reportBasePath.resolve(JACOCO_EXEC).toFile(); | ||
| final ExecFileLoader execFileLoader = new ExecFileLoader(); | ||
| execFileLoader.load(executionDataFile); | ||
| for (final Map.Entry<IPath, List<IPath>> entry : outputToSourcePaths.entrySet()) { | ||
| final CoverageBuilder coverageBuilder = new CoverageBuilder(); | ||
| final Analyzer analyzer = new Analyzer( | ||
| execFileLoader.getExecutionDataStore(), coverageBuilder); | ||
| final File outputDirectory = getFileForFs(javaProject, entry.getKey()); | ||
| analyzer.analyzeAll(outputDirectory); | ||
| final Map<String, Collection<IClassCoverage>> classCoverageBySourceFilePath = | ||
| groupClassCoverageBySourceFilePath(coverageBuilder.getClasses()); | ||
| for (final ISourceFileCoverage sourceFileCoverage : coverageBuilder.getSourceFiles()) { | ||
| if (monitor.isCanceled()) { | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| if (sourceFileCoverage.getFirstLine() == ISourceNode.UNKNOWN_LINE) { | ||
| JUnitPlugin.logError("Missing debug information for file: " + sourceFileCoverage.getName()); | ||
| continue; // no debug information | ||
| } | ||
| final File sourceFile = getSourceFile(entry.getValue(), sourceFileCoverage); | ||
| if (sourceFile == null) { | ||
| JUnitPlugin.logError("Cannot find file: " + sourceFileCoverage.getName()); | ||
| continue; | ||
| } | ||
|
|
||
| final URI uri = sourceFile.toURI(); | ||
| final List<LineCoverage> lineCoverages = getLineCoverages(sourceFileCoverage); | ||
| final String sourcePath = sourceFileCoverage.getPackageName() + "/" + | ||
| sourceFileCoverage.getName(); | ||
| final List<MethodCoverage> methodCoverages = getMethodCoverages( | ||
| classCoverageBySourceFilePath.get(sourcePath), sourceFileCoverage); | ||
| coverage.add(new SourceFileCoverage(uri.toString(), lineCoverages, methodCoverages)); | ||
| } | ||
| } | ||
| return coverage; | ||
| } | ||
|
|
||
| private Map<IPath, List<IPath>> getOutputToSourcePathsMapping() throws JavaModelException { | ||
| final Map<IPath, List<IPath>> outputToSourcePaths = new HashMap<>(); | ||
| for (final IClasspathEntry entry : javaProject.getRawClasspath()) { | ||
| if (entry.getEntryKind() != ClasspathEntry.CPE_SOURCE || | ||
| ProjectTestUtils.isTestEntry(entry)) { | ||
| continue; | ||
| } | ||
|
|
||
| final IPath sourceRelativePath = entry.getPath().makeRelativeTo(javaProject.getProject().getFullPath()); | ||
| IPath outputLocation = entry.getOutputLocation(); | ||
| if (outputLocation == null) { | ||
| outputLocation = javaProject.getOutputLocation(); | ||
| } | ||
| final IPath outputRelativePath = outputLocation.makeRelativeTo(javaProject.getProject().getFullPath()); | ||
| outputToSourcePaths.computeIfAbsent(outputRelativePath, k -> new LinkedList<>()).add(sourceRelativePath); | ||
| } | ||
| return outputToSourcePaths; | ||
| } | ||
|
|
||
| private Map<String, Collection<IClassCoverage>> groupClassCoverageBySourceFilePath( | ||
| final Collection<IClassCoverage> classCoverages) { | ||
| final Map<String, Collection<IClassCoverage>> result = new HashMap<>(); | ||
| for (final IClassCoverage classCoverage : classCoverages) { | ||
| final String key = classCoverage.getPackageName() + "/" + classCoverage.getSourceFileName(); | ||
| result.computeIfAbsent(key, k -> new LinkedList<>()).add(classCoverage); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| /** | ||
| * Infer the source file for the given {@link ISourceFileCoverage}. If no file found, return <code>null</code>. | ||
| */ | ||
| private File getSourceFile(List<IPath> sourceRoots, ISourceFileCoverage sourceFileCoverage) { | ||
| final String packagePath = sourceFileCoverage.getPackageName().replace(".", "/"); | ||
| final IPath sourceRelativePath = new org.eclipse.core.runtime.Path(packagePath) | ||
| .append(sourceFileCoverage.getName()); | ||
| for (final IPath sourceRoot : sourceRoots) { | ||
| final IPath relativePath = sourceRoot.append(sourceRelativePath); | ||
| final File sourceFile = getFileForFs(javaProject, relativePath); | ||
| if (sourceFile.exists()) { | ||
| return sourceFile; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private static File getFileForFs(IJavaProject javaProject, IPath path) { | ||
| return javaProject.getProject().getLocation().append(path).toFile(); | ||
| } | ||
|
|
||
| private List<LineCoverage> getLineCoverages(final ISourceFileCoverage sourceFileCoverage) { | ||
| final List<LineCoverage> lineCoverages = new LinkedList<>(); | ||
| final int last = sourceFileCoverage.getLastLine(); | ||
| for (int nr = sourceFileCoverage.getFirstLine(); nr <= last; nr++) { | ||
| final ILine line = sourceFileCoverage.getLine(nr); | ||
| if (line.getStatus() != ICounter.EMPTY) { | ||
| final List<BranchCoverage> branchCoverages = new LinkedList<>(); | ||
| for (int i = 0; i < line.getBranchCounter().getTotalCount(); i++) { | ||
| branchCoverages.add(new BranchCoverage( | ||
| i < line.getBranchCounter().getCoveredCount() ? 1 : 0)); | ||
| } | ||
| lineCoverages.add(new LineCoverage( | ||
| nr, | ||
| line.getInstructionCounter().getCoveredCount(), | ||
| branchCoverages | ||
| )); | ||
| } | ||
| } | ||
| return lineCoverages; | ||
| } | ||
|
|
||
| private List<MethodCoverage> getMethodCoverages(final Collection<IClassCoverage> classCoverages, | ||
| final ISourceFileCoverage sourceFileCoverage) { | ||
| if (classCoverages == null || classCoverages.isEmpty()) { | ||
| return Collections.emptyList(); | ||
| } | ||
| final List<MethodCoverage> methodCoverages = new LinkedList<>(); | ||
| for (final IClassCoverage classCoverage : classCoverages) { | ||
| for (final IMethodCoverage methodCoverage : classCoverage.getMethods()) { | ||
| methodCoverages.add(new MethodCoverage( | ||
| methodCoverage.getFirstLine(), | ||
| methodCoverage.getMethodCounter().getCoveredCount() > 0 ? 1 : 0, | ||
| methodCoverage.getName() | ||
| )); | ||
| } | ||
| } | ||
| return methodCoverages; | ||
| } | ||
| } |
20 changes: 20 additions & 0 deletions
20
...st.plugin/src/main/java/com/microsoft/java/test/plugin/coverage/model/BranchCoverage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Microsoft Corporation and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package com.microsoft.java.test.plugin.coverage.model; | ||
|
|
||
| public class BranchCoverage { | ||
| int hit; | ||
|
|
||
| public BranchCoverage(int hit) { | ||
| this.hit = hit; | ||
| } | ||
| } |
26 changes: 26 additions & 0 deletions
26
...test.plugin/src/main/java/com/microsoft/java/test/plugin/coverage/model/LineCoverage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Microsoft Corporation and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package com.microsoft.java.test.plugin.coverage.model; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| public class LineCoverage { | ||
| int lineNumber; | ||
| int hit; | ||
| List<BranchCoverage> branchCoverages; | ||
|
|
||
| public LineCoverage(int lineNumber, int hit, List<BranchCoverage> branchCoverages) { | ||
| this.lineNumber = lineNumber; | ||
| this.hit = hit; | ||
| this.branchCoverages = branchCoverages; | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...st.plugin/src/main/java/com/microsoft/java/test/plugin/coverage/model/MethodCoverage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Microsoft Corporation and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package com.microsoft.java.test.plugin.coverage.model; | ||
|
|
||
| public class MethodCoverage { | ||
| int lineNumber; | ||
| int hit; | ||
| String name; | ||
|
|
||
| public MethodCoverage(int lineNumber, int hit, String name) { | ||
| this.lineNumber = lineNumber; | ||
| this.hit = hit; | ||
| this.name = name; | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
...lugin/src/main/java/com/microsoft/java/test/plugin/coverage/model/SourceFileCoverage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Microsoft Corporation and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package com.microsoft.java.test.plugin.coverage.model; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| public class SourceFileCoverage { | ||
| String uriString; | ||
| List<LineCoverage> lineCoverages; | ||
| List<MethodCoverage> methodCoverages; | ||
|
|
||
| public SourceFileCoverage(String uriString, List<LineCoverage> lineCoverages, | ||
| List<MethodCoverage> methodCoverages) { | ||
| this.uriString = uriString; | ||
| this.lineCoverages = lineCoverages; | ||
| this.methodCoverages = methodCoverages; | ||
| } | ||
| } |
Oops, something went wrong.