🗄 Release 0.1.5 0.1.2

Author: jesperancinha

ReleaseNotes.md

@@ -1,12 +1,16 @@
 # Omni Reporter Commons Release Notes
 
+#### Release 0.1.6 - Upcoming
 
-#### Release 0.1.5 - Upcoming
+1. Support for Group Coverage with Branch Coverage (mostly Coveralls)
+2. Source encoding gets automatically chosen unless we configure flag `failOnNoEncoding` to `true`
+
+#### Release 0.1.5 - 2022/02/22
 
 ###### Features
 
-1. Support for Group Coverage with Branch Coverage (mostly Coveralls)
-2. Source encoding gets automatically chosen unless we configure flag `failOnNoEncoding` to `true`
+1. Remove possibility to send unknown reports in Omni to Codecov. Unfortunately Codecov crashes with unknown reports. The only way to check the correct format of the report is essentially to provide the implementation to do that. In this way report sending to Codecov becomes restricted to the known formats to Omni.
+2. Remove banned file name list - Since the algorithm no longer relies on the filename, it doesn't make sense anymore to keep doing that. Therefore, the banned list is removed.
 
 ###### Bugs
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.jesperancinha.plugins</groupId>
     <artifactId>omni-coveragereporter-commons</artifactId>
-    <version>0.1.4</version>
+    <version>0.1.5</version>
 
     <packaging>jar</packaging>
 
@@ -36,7 +36,7 @@
         <connection>scm:git:git://github.com/JEsperancinhaOrg.git</connection>
         <developerConnection>scm:git:git://github.com/JEsperancinhaOrg.git</developerConnection>
         <url>https://github.com/JEsperancinhaOrg/omni-reporter-commons</url>
-        <tag>0.1.4</tag>
+        <tag>0.1.5</tag>
     </scm>
     <distributionManagement>
         <snapshotRepository>
@@ -89,7 +89,7 @@
         <coverage-parser_2.12.version>4.4.2</coverage-parser_2.12.version>
         <codacy-coverage-reporter.version>7.1.0</codacy-coverage-reporter.version>
         <logback-classic.version>1.3.0-alpha13</logback-classic.version>
-        <omni-coveragereporter-maven-plugin.version>0.1.4</omni-coveragereporter-maven-plugin.version>
+        <omni-coveragereporter-maven-plugin.version>0.1.5</omni-coveragereporter-maven-plugin.version>
     </properties>
 
     <dependencies>

src/main/kotlin/org/jesperancinha/plugins/omni/reporter/domain/reports/OmniFileAdapters.kt

@@ -6,6 +6,7 @@ import org.jesperancinha.plugins.omni.reporter.domain.api.TEMP_DIR_VARIABLE
 import org.jesperancinha.plugins.omni.reporter.parsers.readXmlValue
 import org.jesperancinha.plugins.omni.reporter.parsers.snakeCaseJsonObjectMapper
 import org.jesperancinha.plugins.omni.reporter.parsers.xmlObjectMapper
+import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import java.io.File
 import java.nio.file.Path
@@ -92,31 +93,41 @@ class OmniJacocoExecFileAdapter(
 
     private val xmlReport = File(System.getProperty(TEMP_DIR_VARIABLE), "jacoco-${UUID.randomUUID()}.xml")
 
-    override fun getParentAdapter(): OmniReportParentFileAdapter {
+    private val innerParsedReport = OmniJacocoReportParserCommand(
+        execFiles = listOf(report),
+        classFiles = jarFile?.run { listOf(jarFile) } ?: emptyList(),
+        xmlReport = xmlReport
+    ).parse()
 
-        return OmniJacocoReportParserCommand(
-            execFiles = listOf(report),
-            classFiles = jarFile?.run { listOf(jarFile) } ?: emptyList(),
-            xmlReport = xmlReport
-        ).parse().let {
-            OmniJacocoReportParentFileAdapter(
-                it,
-                root,
-                includeBranchCoverage,
-            )
-        }
+    override fun getParentAdapter(): OmniReportParentFileAdapter {
+        logger.info("- Found jar file ${jarFile?.absolutePath} for jacoco exec file ${report.absolutePath}")
+        return OmniJacocoReportParentFileAdapter(
+            innerParsedReport,
+            root,
+            includeBranchCoverage,
+        )
     }
 
     override fun generatePayload(failOnUnknown: Boolean, compiledSourcesDirs: List<File>): String {
         val reportObject: Report = readXmlValue(xmlReport.inputStream())
-        val copy = reportObject.copy(
+        if (reportObject.packages.isEmpty()) {
+            logger.warn("- Jacoco Report XML generated file ${xmlReport.absolutePath} appears to be empty!")
+            logger.warn("- Actual file content is: ${xmlReport.readText()}")
+        }
+        val reportWithCorrectedPAths = reportObject.copy(
             packages = reportObject.packages.mapNotNull { p: Package ->
                 val newName = findNewPackageName(root, p, compiledSourcesDirs)
                 newName?.let { p.copy(name = newName) }
                     ?: if (failOnUnknown) throw CodecovPackageNotFoundException(p.name) else null
             }
         )
-        return xmlObjectMapper.writeValueAsString(copy)
+        val generatedReport = xmlObjectMapper.writeValueAsString(reportWithCorrectedPAths)
+        logger.debug("- Report payload of corrected generated Jacoco File ${xmlReport.absolutePath} is $generatedReport")
+        return generatedReport
+    }
+
+    companion object {
+        val logger: Logger = LoggerFactory.getLogger(OmniJacocoExecFileAdapter::class.java)
     }
 }
 

src/main/kotlin/org/jesperancinha/plugins/omni/reporter/domain/reports/OmniJacocoExecDomain.kt

@@ -44,7 +44,9 @@ class OmniJacocoReportParserCommand(
         visitor.visitInfo(loader.sessionInfoStore.infos, loader.executionDataStore.contents)
         visitor.visitBundle(bundle, MultiSourceFileLocator(4))
         visitor.visitEnd()
-        return this.xmlReport.inputStream().readJacocoReport(failOnXmlParseError)
+        val readJacocoReport = this.xmlReport.inputStream().readJacocoReport(failOnXmlParseError)
+        logger.debug("- Generated XML Jacoco report with content ${this.xmlReport.readText()}")
+        return readJacocoReport
     }
 
     companion object {

src/main/kotlin/org/jesperancinha/plugins/omni/reporter/processors/CodacyProcessor.kt

@@ -52,7 +52,7 @@ class CodacyProcessor(
                             token = token,
                             apiToken = apiToken,
                             pipeline = currentPipeline,
-                            root = projectBaseDir ?: throw ProjectDirectoryNotFoundException(),
+                            root = projectBaseDir,
                             failOnUnknown = failOnUnknown,
                             failOnXmlParseError = failOnXmlParseError,
                             language = language

src/main/kotlin/org/jesperancinha/plugins/omni/reporter/processors/Processor.kt

@@ -5,27 +5,9 @@ import org.jesperancinha.plugins.omni.reporter.ProjectDirectoryNotFoundException
 import org.jesperancinha.plugins.omni.reporter.domain.reports.*
 import java.io.File
 
-private val CODECOV_SUPPORTED_REPORTS = arrayOf(
-    "jacoco" to "xml",
-    "lcov" to "txt",
-    "lcov" to "info",
-    "gcov" to "txt",
-    "golang" to "txt",
-    "lcov" to "txt",
-    "coverage" to "xml",
-    "coverage" to "json",
-    "cobertura" to "xml",
-    "clover" to "xml"
-)
-
-
 private val KNOWN_TEST_DIRECTORIES = arrayOf(
     "test-classes"
 )
-private val CODECOV_UNSUPPORTED_REPORTS = arrayOf(
-    "coverage-final" to "json"
-)
-
 
 /**
  * Created by jofisaes on 05/01/2022
@@ -192,17 +174,15 @@ internal fun List<OmniProject?>.toAllCodecovSupportedFiles(
                 .filter { !reportRejectList.contains(it.name) }
                 .filter { report ->
                     report.isFile
-                            && CODECOV_SUPPORTED_REPORTS.any { (name, ext) -> report.name.startsWith(name) && report.extension == ext }
-                            && !CODECOV_UNSUPPORTED_REPORTS.any { (name, ext) -> report.name.startsWith(name) && report.extension == ext }
                             && project.build?.let { build ->
                         supportedPredicate(
                             build.testOutputDirectory,
                             report
                         )
                     } ?: false
                 }
-                .map { report ->
-                    mapReportFile(report, project, supportedPredicate, false, root) ?: OmniGenericFileAdapter(report)
+                .mapNotNull { report ->
+                    mapReportFile(report, project, supportedPredicate, false, root)
                 }
                 .distinct()
         }.distinct()