Package io.jenkins.plugins.coverage.metrics.steps

Class CoverageReportScanner

java.lang.Object

jenkins.MasterToSlaveFileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<T>>

io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.coverage.ModuleNode>

io.jenkins.plugins.coverage.metrics.steps.CoverageReportScanner

All Implemented Interfaces:

FilePath.FileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<edu.hm.hafner.coverage.ModuleNode>>, Serializable, ControllerToAgentFileCallable<io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<edu.hm.hafner.coverage.ModuleNode>>, org.jenkinsci.remoting.RoleSensitive

public class CoverageReportScanner
extends io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.coverage.ModuleNode>

Scans the workspace for coverage reports that match a specified Ant file pattern and parse these files with the specified parser. Creates a new ModuleNode for each parsed file. For files that cannot be read, an empty module node will be returned.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.util.AgentFileVisitor

io.jenkins.plugins.util.AgentFileVisitor.FileVisitorResult<T extends Serializable>

Constructor Summary

Constructors

Constructor	Description
CoverageReportScanner(CoverageTool.Parser parser, String filePattern, String encoding, boolean followSymbolicLinks, edu.hm.hafner.coverage.CoverageParser.ProcessingMode processingMode)	Creates a new instance of CoverageReportScanner.

Method Summary

Modifier and Type	Method	Description
protected Optional<edu.hm.hafner.coverage.ModuleNode>	processFile(Path file, Charset charset, edu.hm.hafner.util.FilteredLog log)

Methods inherited from class io.jenkins.plugins.util.AgentFileVisitor

invoke, plural

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jenkins.agents.ControllerToAgentFileCallable

checkRoles

Constructor Details

CoverageReportScanner

public CoverageReportScanner(CoverageTool.Parser parser,
 String filePattern,
 String encoding,
 boolean followSymbolicLinks,
 edu.hm.hafner.coverage.CoverageParser.ProcessingMode processingMode)

Creates a new instance of CoverageReportScanner.

Parameters:

parser - the parser to use

filePattern - ant file-set pattern to scan for files to parse

encoding - encoding of the files to parse

followSymbolicLinks - if the scanner should traverse symbolic links

processingMode - determines whether to ignore errors

Method Details

processFile

protected Optional<edu.hm.hafner.coverage.ModuleNode> processFile(Path file,
 Charset charset,
 edu.hm.hafner.util.FilteredLog log)

Specified by:

processFile in class io.jenkins.plugins.util.AgentFileVisitor<edu.hm.hafner.coverage.ModuleNode>