Merge pull request #378 from codacy/skip-commit-uuid-validation

Skip commit UUID validation

Author: franciscodua

README.md

@@ -211,6 +211,7 @@ Found [Clone] 7 duplicated lines with 10 tokens:
     * `--output` - Send the output results to a file
     * `--format` [default: text] - Change the output format (e.g. json)
     * `--commit-uuid` [default: latest commit of current git branch] - Set the commit UUID that will receive the results on Codacy
+    * `--skip-commit-uuid-validation` [default: false] - Force using a commit UUID even if it doesn't belong to the current git branch.
     * `--upload` [default: false] - Request to push results to Codacy
     * `--parallel` [default: 2] - Number of tools to run in parallel
     * `--max-allowed-issues` [default: 0] - Maximum number of issues allowed for the analysis to succeed

cli/src/main/scala/com/codacy/analysis/cli/command/AnalyseCommand.scala

@@ -119,7 +119,7 @@ class AnalyseCommand(analyze: Analyze,
         { repository =>
           for {
             _ <- validateNoUncommitedChanges(repository, configuration.upload.upload)
-            _ <- validateGitCommitUuid(repository, analyze.commitUuid)
+            _ <- validateGitCommitUuid(repository, analyze.commitUuid, analyze.skipCommitUuidValidationValue)
           } yield ()
         })
   }
@@ -146,11 +146,12 @@ class AnalyseCommand(analyze: Analyze,
   }
 
   private def validateGitCommitUuid(repository: Repository,
-                                    commitUuidOpt: Option[Commit.Uuid]): Either[CLIError, Unit] = {
+                                    commitUuidOpt: Option[Commit.Uuid],
+                                    skipCommitUuidValidationValue: Boolean): Either[CLIError, Unit] = {
     (for {
       gitCommit <- repository.latestCommit.toOption
       paramCommitUuid <- commitUuidOpt
-      if gitCommit.commitUuid != paramCommitUuid
+      if (!skipCommitUuidValidationValue && gitCommit.commitUuid != paramCommitUuid)
     } yield {
       val error = CLIError.CommitUuidsDoNotMatch(paramCommitUuid, gitCommit.commitUuid)
       logger.error(error.message)

cli/src/main/scala/com/codacy/analysis/cli/command/CLIApp.scala

@@ -142,6 +142,8 @@ final case class Analyze(
   output: Option[File] = Option.empty,
   @ExtraName("c") @ValueDescription("The commit UUID of the commit that will be analysed")
   commitUuid: Option[Commit.Uuid] = Option.empty,
+  @ExtraName("s") @ValueDescription("[default: false] - Force using a commit UUID")
+  skipCommitUuidValidation: Int @@ Counter = Tag.of(0),
   @ExtraName("u") @ValueDescription("If the results should be uploaded to the API")
   upload: Int @@ Counter = Tag.of(0),
   @ExtraName("p") @ValueDescription("The number of tools to run in parallel")
@@ -172,6 +174,8 @@ final case class Analyze(
   val allowNetworkValue: Boolean = allowNetwork.## > 0
   val forceFilePermissionsValue: Boolean = forceFilePermissions.## > 0
   val ghCodeScanningCompatValue: Boolean = ghCodeScanningCompat.## > 0
+  val skipCommitUuidValidationValue: Boolean = skipCommitUuidValidation.## > 0
+
 }
 
 final case class ValidateConfiguration(@Recurse

cli/src/test/scala/com/codacy/analysis/cli/CLISpec.scala

@@ -347,6 +347,26 @@ class CLISpec extends Specification with NoLanguageFeatures with FileMatchers {
       }
     }
 
+    "does not fail when the uuid of the current commit of the git project does not match the one provided by parameter but fails for other reason" in {
+      withTemporaryGitRepo { directory =>
+        (for {
+          _ <- File.temporaryFile(parent = Some(directory))
+        } yield {
+          val analyze = Analyze(
+            options = CommonOptions(),
+            api = APIOptions(projectToken = Some("hey, im a token"), codacyApiBaseUrl = Some("https://codacy.com")),
+            tool = None,
+            directory = Option(directory),
+            upload = Tag.of(0),
+            extras = ExtraOptions(),
+            commitUuid = Option(Commit.Uuid("Aw geez Rick, this isnt the commit uuid!")),
+            skipCommitUuidValidation = Tag.of(1),
+            toolTimeout = None)
+          cli.run(analyze) must beEqualTo(ExitStatus.ExitCodes.failedAnalysis)
+        }).get
+      }
+    }
+
     "cleanup config files after cli run" in {
       (for {
         directory <- File.temporaryDirectory()