👾 Release 0.1.2

Author: jesperancinha

ReleaseNotes.md

@@ -1,15 +1,21 @@
 # Omni Reporter Commons Release Notes
 
-
-#### Release 0.1.2 - Upcoming
+#### Release 0.1.3 - Upcoming
 
 ###### Features
 
-1. ~~Reports in the same folder are merged and average, (We assume thart if there are different reports in the same folder, it only means that there are different brands in there.)~~ Unfortunately, by doing so, the results may become inconsistent for reports that do not report coverage for certain files. Please make sure not to have different report brands (i.e. Clover and LCov together) for the same files. In that case, line coverage will be reported duplicate.
+1. ~~Reports in the same folder are merged and average, (We assume thart if there are different reports in the same folder, it only means that there are different brands in there.)~~ Unfortunately, by doing so, the results may become inconsistent for reports that do not report coverage for certain
+   files. Please make sure not to have different report brands (i.e. Clover and LCov together) for the same files. In that case, line coverage will be reported duplicate.
 2. Exclude report option (Since the above, may be difficult to manage in some situations, we can then use this option to exclude a report that for some reason we don't want to consider for the overall coverage calculation)
 3. Support for Group Coverage with Branch Coverage (mostly Coveralls)
 4. Source encoding gets automatically chosen unless we configure flag `failOnNoEncoding` to `true`
 
+#### Release 0.1.2 - 2022/01/31
+
+###### Features
+
+1. Create flag `fetchBranchNameFromEnv` to fetch the branch name from environment variables
+
 #### Release 0.1.1 - 2022/01/31
 
 ###### Bugs
@@ -22,6 +28,7 @@
 ###### Features
 
 > !! Breaking Changes !!
+
 1. Support for [CoveragePy](https://coverage.readthedocs.io/)
 2. Support for [LCov](https://wiki.documentfoundation.org/Development/Lcov)
 3. Support for [Jacoco.exec](https://www.jacoco.org/jacoco/) files
@@ -31,11 +38,10 @@
 
 1. Root Path fix for internal elements
 
-
 #### Release 0.0.1 - 2022/01/22
 
-It was found that under certain circumstances (i.e. use of Gradle INFO level), the Http Google Clients lets client logs output go to the console. This represents a security risk because access keys to the coverage API's would be exposed in that way.
-This release covers that and avoids this way of credentials being exposed in the logs.
+It was found that under certain circumstances (i.e. use of Gradle INFO level), the Http Google Clients lets client logs output go to the console. This represents a security risk because access keys to the coverage API's would be exposed in that way. This release covers that and avoids this way of
+credentials being exposed in the logs.
 
 #### Release 0.0.0 - 2022/01/21
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.jesperancinha.plugins</groupId>
     <artifactId>omni-coveragereporter-commons</artifactId>
-    <version>0.1.1</version>
+    <version>0.1.2</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.1</tag>
+        <tag>0.1.2</tag>
     </scm>
     <distributionManagement>
         <snapshotRepository>

src/main/kotlin/org/jesperancinha/plugins/omni/reporter/pipelines/Pipelines.kt

@@ -2,6 +2,7 @@ package org.jesperancinha.plugins.omni.reporter.pipelines
 
 import org.jesperancinha.plugins.omni.reporter.domain.api.CUSTOM
 import org.jesperancinha.plugins.omni.reporter.domain.api.GITLAB
+import org.jesperancinha.plugins.omni.reporter.pipelines.GitHubPipeline.Companion.GITHUB_BASE_REF
 import org.jesperancinha.plugins.omni.reporter.pipelines.GitHubPipeline.Companion.GITHUB_REPOSITORY
 import org.jesperancinha.plugins.omni.reporter.pipelines.GitHubPipeline.Companion.GITHUB_RUN_ID
 import org.jesperancinha.plugins.omni.reporter.pipelines.GitHubPipeline.Companion.GITHUB_RUN_NUMBER
@@ -36,9 +37,10 @@ private val allEnv = listOf(
     CI_EXTERNAL_PULL_REQUEST_ID,
     CI_EXTERNAL_PULL_REQUEST_IID,
 
-    //GitHubs
+    //GitHub
     GITHUB_RUN_NUMBER,
     GITHUB_RUN_ID,
+    GITHUB_BASE_REF,
     GITHUB_SERVER_URL,
     GITHUB_REPOSITORY
 
@@ -54,11 +56,13 @@ interface Pipeline {
     val serviceJobId: String?
     val codecovServiceName: String?
     val buildUrl: String?
+    val fetchBranchNameFromEnv: Boolean
 }
 
 abstract class PipelineImpl(
     override val branchName: String? = null,
-    override val buildUrl: String? = null
+    override val buildUrl: String? = null,
+    override val fetchBranchNameFromEnv: Boolean = false,
 ) : Pipeline {
 
     override fun toString() = "* System Variables\n" +
@@ -68,11 +72,13 @@ abstract class PipelineImpl(
             "- Service Number (Build) = $serviceNumber\n" +
             "- Service Job Id = $serviceJobId"
 
+
     companion object {
-        val currentPipeline: Pipeline = when {
-            environment[GITHUB_RUN_ID] != null -> GitHubPipeline()
-            environment[CI_JOB_ID] != null -> GitLabPipeline()
-            else -> LocalPipeline()
+
+        fun currentPipeline(fetchBranchNameFromEnv: Boolean): Pipeline = when {
+            environment[GITHUB_RUN_ID] != null -> GitHubPipeline(fetchBranchNameFromEnv = fetchBranchNameFromEnv)
+            environment[CI_JOB_ID] != null -> GitLabPipeline(fetchBranchNameFromEnv = fetchBranchNameFromEnv)
+            else -> LocalPipeline(fetchBranchNameFromEnv = fetchBranchNameFromEnv)
         }.also {
             it.toString().lines().forEach { logLine -> logger.info(logLine) }
         }
@@ -104,39 +110,37 @@ class GitHubPipeline(
     override val serviceJobId: String? = findServiceJobId {
         findSystemVariableValue(GITHUB_RUN_ID)
     },
-    override val branchRef: String? = null,
+    override val fetchBranchNameFromEnv: Boolean,
+    override val branchRef: String? = if (fetchBranchNameFromEnv) findSystemVariableValue(GITHUB_BASE_REF) else null,
     override val codecovServiceName: String? = CUSTOM,
     override val buildUrl: String? = "${findSystemVariableValue(GITHUB_SERVER_URL)}/${
         findSystemVariableValue(
             GITHUB_REPOSITORY
         )
-    }/actions/runs/${findSystemVariableValue(GITHUB_RUN_ID)}"
+    }/actions/runs/${findSystemVariableValue(GITHUB_RUN_ID)}",
 ) : PipelineImpl() {
     companion object {
         const val GITHUB_RUN_NUMBER = "GITHUB_RUN_NUMBER"
         const val GITHUB_RUN_ID = "GITHUB_RUN_ID"
+        const val GITHUB_BASE_REF = "GITHUB_BASE_REF"
         const val GITHUB_SERVER_URL = "GITHUB_SERVER_URL"
         const val GITHUB_REPOSITORY = "GITHUB_REPOSITORY"
     }
 }
 
 class GitLabPipeline(
     override val serviceName: String = findServiceName { "gitlab-ci" },
-    override val serviceNumber: String? = findServiceNumber {
-        findSystemVariableValue(CI_CONCURRENT_ID)
-    },
-    override val serviceJobId: String? = findServiceJobId {
-        findSystemVariableValue(CI_JOB_ID)
-    },
-    override val branchRef: String? = null,
+    override val serviceNumber: String? = findServiceNumber { findSystemVariableValue(CI_CONCURRENT_ID) },
+    override val serviceJobId: String? = findServiceJobId { findSystemVariableValue(CI_JOB_ID) },
+    override val fetchBranchNameFromEnv: Boolean,
+    override val branchRef: String? = if (fetchBranchNameFromEnv) findSystemVariableValue(CI_COMMIT_REF_NAME) else null,
     override val branchName: String? = findSystemVariableValue(CI_COMMIT_REF_NAME),
     override val codecovServiceName: String? = GITLAB,
     override val buildUrl: String? = "${findSystemVariableValue(CI_PROJECT_URL)}/-/pipelines/${
         findSystemVariableValue(
             CI_PIPELINE_ID
         )
     }"
-
 ) : PipelineImpl() {
     companion object {
         const val CI_CONCURRENT_ID = "CI_CONCURRENT_ID"
@@ -155,6 +159,7 @@ class LocalPipeline(
     override val serviceJobId: String? = findServiceJobId { null },
     override val branchRef: String? = null,
     override val codecovServiceName: String? = CUSTOM,
+    override val fetchBranchNameFromEnv: Boolean,
 ) : PipelineImpl() {
 
     companion object {

src/test/kotlin/org/jesperancinha/plugins/omni/reporter/domain/CodacyCoverallsSourceFileTest.kt

@@ -50,7 +50,7 @@ internal class CodacyCoverallsSourceFileTest {
         val root = resource.toURI().toPath().toFile()
         JacocoParserToCodacy(
             "",
-            pipeline = GitHubPipeline(),
+            pipeline = GitHubPipeline(fetchBranchNameFromEnv = false),
             root = root,
             failOnUnknown = false,
             language = KOTLIN

src/test/kotlin/org/jesperancinha/plugins/omni/reporter/domain/CoverallsClientTest.kt

@@ -23,7 +23,7 @@ internal class CoverallsClientTest {
         val jacocoReport = resource.toURI().toPath().toFile()
         jacocoReport.shouldNotBeNull()
         val jacocoParser = ReportingParserToCoveralls(
-            token = "token", LocalPipeline(), root,
+            token = "token", LocalPipeline(fetchBranchNameFromEnv = false), root,
             failOnUnknown = false,
             includeBranchCoverage = false,
             useCoverallsCount = false

src/test/kotlin/org/jesperancinha/plugins/omni/reporter/parsers/JacocoParserTest.kt

@@ -14,7 +14,7 @@ import java.io.File
 internal class JacocoParserTest {
     private val jacocoParser = ReportingParserToCoveralls(
         "token",
-        LocalPipeline(),
+        LocalPipeline(fetchBranchNameFromEnv = false),
         root,
         failOnUnknown = false,
         includeBranchCoverage = false,
@@ -81,7 +81,8 @@ internal class JacocoParserTest {
 
         jacocoParser.parseInput(OmniJacocoFileAdapter(jacocoResult, false, root, root), listOf(root))
 
-        val sourceFiles = jacocoParser.parseInput(OmniJacocoFileAdapter(jacocoResult, false, root, root)
+        val sourceFiles = jacocoParser.parseInput(
+            OmniJacocoFileAdapter(jacocoResult, false, root, root)
         ).sourceFiles
 
         sourceFiles.shouldNotBeNull()

src/test/kotlin/org/jesperancinha/plugins/omni/reporter/transformers/AllParserToCodecovTest.kt

@@ -30,7 +30,7 @@ internal class AllParserToCodecovTest {
 
         val parseInput = AllParserToCodecov(
             token = "token",
-            pipeline = GitLabPipeline(),
+            pipeline = GitLabPipeline(fetchBranchNameFromEnv = false),
             root = root,
             failOnUnknown = false
         ).parseInput(