SCANJLIB-263 Don't let people use the region value 'global'

Author: henryju

lib/src/main/java/org/sonarsource/scanner/lib/internal/endpoint/OfficialSonarQubeCloudInstance.java

@@ -24,6 +24,7 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import javax.annotation.Nullable;
 import org.apache.commons.lang3.StringUtils;
 
@@ -38,16 +39,28 @@ public enum OfficialSonarQubeCloudInstance {
     this.endpoint = new ScannerEndpoint(webEndpoint, apiEndpoint, true);
   }
 
-  public static Set<String> getRegionCodes() {
-    return Arrays.stream(OfficialSonarQubeCloudInstance.values()).filter(r -> r != GLOBAL).map(Enum::name).map(s -> s.toLowerCase(Locale.ENGLISH)).collect(Collectors.toSet());
+  public static Set<String> getRegionCodesWithoutGlobal() {
+    return getRegionsWithoutGlobal().map(Enum::name).map(s -> s.toLowerCase(Locale.ENGLISH)).collect(Collectors.toSet());
+  }
+
+  /**
+   * For now, we are not sure the default region will be called "global" so don't let users use this enum value
+   */
+  private static Stream<OfficialSonarQubeCloudInstance> getRegionsWithoutGlobal() {
+    return Arrays.stream(OfficialSonarQubeCloudInstance.values()).filter(r -> r != GLOBAL);
   }
 
   public static Optional<OfficialSonarQubeCloudInstance> fromRegionCode(@Nullable String regionCode) {
     if (StringUtils.isBlank(regionCode)) {
       return Optional.of(GLOBAL);
     }
     try {
-      return Optional.of(OfficialSonarQubeCloudInstance.valueOf(regionCode.toUpperCase(Locale.ENGLISH)));
+      var value = OfficialSonarQubeCloudInstance.valueOf(regionCode.toUpperCase(Locale.ENGLISH));
+      if (value == GLOBAL) {
+        // For now, we are not sure the default region will be called "global" so don't let users use this enum value
+        return Optional.empty();
+      }
+      return Optional.of(value);
     } catch (IllegalArgumentException e) {
       return Optional.empty();
     }

lib/src/main/java/org/sonarsource/scanner/lib/internal/endpoint/ScannerEndpointResolver.java

@@ -51,7 +51,7 @@ private static ScannerEndpoint resolveSonarQubeCloudEndpoint(Map<String, String>
     return OfficialSonarQubeCloudInstance.fromRegionCode(regionCode)
       .orElseThrow(() -> new MessageException(
         format("Invalid region '%s'. Valid regions are: %s. Please check the '%s' property or the '%s' environment variable.",
-          regionCode, StringUtils.join(OfficialSonarQubeCloudInstance.getRegionCodes().stream().map(r -> "'" + r + "'").collect(toList()), ", "),
+          regionCode, StringUtils.join(OfficialSonarQubeCloudInstance.getRegionCodesWithoutGlobal().stream().map(r -> "'" + r + "'").collect(toList()), ", "),
           ScannerProperties.SONAR_REGION, EnvironmentConfig.REGION_ENV_VARIABLE)))
       .getEndpoint();
   }

lib/src/test/java/org/sonarsource/scanner/lib/internal/endpoint/OfficialSonarQubeCloudInstanceTest.java

@@ -27,7 +27,7 @@ class OfficialSonarQubeCloudInstanceTest {
 
   @Test
   void shouldListRegionsCodes() {
-    assertThat(OfficialSonarQubeCloudInstance.getRegionCodes()).containsExactlyInAnyOrder("us");
+    assertThat(OfficialSonarQubeCloudInstance.getRegionCodesWithoutGlobal()).containsExactlyInAnyOrder("us");
   }
 
   @Test
@@ -37,6 +37,8 @@ void shouldGetInstanceFromRegionCodeIgnoringCase() {
     assertThat(OfficialSonarQubeCloudInstance.fromRegionCode("")).contains(OfficialSonarQubeCloudInstance.GLOBAL);
     assertThat(OfficialSonarQubeCloudInstance.fromRegionCode(null)).contains(OfficialSonarQubeCloudInstance.GLOBAL);
     assertThat(OfficialSonarQubeCloudInstance.fromRegionCode("foo")).isEmpty();
+    // For now, we are not sure the default region will be called "global" so don't let users use this enum value
+    assertThat(OfficialSonarQubeCloudInstance.fromRegionCode("global")).isEmpty();
   }
 
   @Test