SONAR-15915 Validate project key against forbidden phrases

2 files changed, 25 insertions, 1 deletions

diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectReactorValidator.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectReactorValidator.java
index 6b4f05f9d25..303391ee406 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectReactorValidator.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectReactorValidator.java
@@ -20,7 +20,9 @@
 package org.sonar.scanner.scan;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+import java.util.Set;
 import java.util.stream.Stream;
 import javax.annotation.Nullable;
 import org.sonar.api.batch.bootstrap.ProjectDefinition;
@@ -102,6 +104,11 @@ public class ProjectReactorValidator {
     if (!ComponentKeys.isValidProjectKey(projectDefinition.getKey())) {
       validationMessages.add(format("\"%s\" is not a valid project key. %s.", projectDefinition.getKey(), ALLOWED_CHARACTERS_MESSAGE));
     }
+    Set<String> forbiddenNamePhrases = Set.of(":BRANCH:", ":PULLREQUEST:");
+    if (forbiddenNamePhrases.stream().anyMatch(projectDefinition.getKey()::contains)) {
+      validationMessages.add(format("\"%s\" is not a valid project key. Project key must not contain following phrases [%s]", projectDefinition.getKey(),
+        String.join(", ", forbiddenNamePhrases)));
+    }
   }
 
   private boolean isBranchFeatureAvailable() {
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/scan/ProjectReactorValidatorTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/scan/ProjectReactorValidatorTest.java
index c2476483ef7..7c2ee0b39e9 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scanner/scan/ProjectReactorValidatorTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/scan/ProjectReactorValidatorTest.java
@@ -87,7 +87,7 @@ public class ProjectReactorValidatorTest {
   }
 
   @Test
-  public void failg_when_invalid_key() {
+  public void fail_when_invalid_key() {
     ProjectReactor reactor = createProjectReactor("foo$bar");
 
     assertThatThrownBy(() -> underTest.validate(reactor))
@@ -97,6 +97,23 @@ public class ProjectReactorValidatorTest {
   }
 
   @Test
+  public void fail_when_key_contains_invalid_phrases() {
+    ProjectReactor reactorWithBranchInKey = createProjectReactor("test:BRANCH:test");
+
+    assertThatThrownBy(() -> underTest.validate(reactorWithBranchInKey))
+      .isInstanceOf(MessageException.class)
+      .hasMessageContainingAll("\"test:BRANCH:test\" is not a valid project key. "
+        + "Project key must not contain following phrases", ":BRANCH:", ":PULLREQUEST:");
+
+    ProjectReactor reactorWithPRinKey = createProjectReactor("test:PULLREQUEST:test");
+
+    assertThatThrownBy(() -> underTest.validate(reactorWithPRinKey))
+      .isInstanceOf(MessageException.class)
+      .hasMessageContainingAll("\"test:PULLREQUEST:test\" is not a valid project key. "
+        + "Project key must not contain following phrases", ":BRANCH:", ":PULLREQUEST:");
+  }
+
+  @Test
   public void fail_when_only_digits() {
     ProjectReactor reactor = createProjectReactor("12345");