]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-18879 add documentation URL for SCIM errors
authorAurelien Poscia <aurelien.poscia@sonarsource.com>
Fri, 31 Mar 2023 12:22:18 +0000 (14:22 +0200)
committersonartech <sonartech@sonarsource.com>
Fri, 31 Mar 2023 20:03:27 +0000 (20:03 +0000)
server/sonar-db-migration/src/main/java/org/sonar/server/platform/db/migration/version/v100/LogMessageIfSonarScimEnabledPresentProperty.java
server/sonar-db-migration/src/test/java/org/sonar/server/platform/db/migration/version/v100/LogMessageIfSonarScimEnabledPresentPropertyTest.java

index 2888982640dff251aecb979d83db35c484745381..58a3ba3e6a7094d674112b10a4d97cca6029ad66 100644 (file)
@@ -29,6 +29,7 @@ public class LogMessageIfSonarScimEnabledPresentProperty extends DataChange {
 
   private static final Logger LOG = Loggers.get(LogMessageIfSonarScimEnabledPresentProperty.class);
   public static final String SONAR_SCIM_ENABLED = "sonar.scim.enabled";
+  private static final String SCIM_DOC_URL = "https://docs.sonarqube.org/10.1/instance-administration/authentication/saml/scim/overview/";
 
   public LogMessageIfSonarScimEnabledPresentProperty(Database db) {
     super(db);
@@ -40,6 +41,7 @@ public class LogMessageIfSonarScimEnabledPresentProperty extends DataChange {
       .setString(1, SONAR_SCIM_ENABLED)
       .scroll(row -> LOG.warn("'{}' property is defined but not read anymore." +
         " Please read the upgrade notes for the instruction to upgrade. User provisioning is deactivated until reactivated" +
-        " from the SonarQube Administration Interface (\"General->Authentication\").", SONAR_SCIM_ENABLED));
+        " from the SonarQube Administration Interface (\"General->Authentication\"). See documentation: {}", SONAR_SCIM_ENABLED,
+        SCIM_DOC_URL));
   }
 }
index cf71c218aac2a900bfc5adfee9a9a7d79cadb060..7bd3a481880948270c7bed47588e13fdb13d3869 100644 (file)
@@ -61,7 +61,8 @@ public class LogMessageIfSonarScimEnabledPresentPropertyTest {
       .hasSize(1)
       .containsExactly("'" + SONAR_SCIM_ENABLED + "' property is defined but not read anymore. Please read the upgrade notes" +
         " for the instruction to upgrade. User provisioning is deactivated until reactivated from the SonarQube" +
-        " Administration Interface (\"General->Authentication\").");
+        " Administration Interface (\"General->Authentication\"). "
+        + "See documentation: https://docs.sonarqube.org/10.1/instance-administration/authentication/saml/scim/overview/");
   }
 
   @Test
@@ -87,4 +88,4 @@ public class LogMessageIfSonarScimEnabledPresentPropertyTest {
 
     assertThat(logger.logs(LoggerLevel.WARN)).hasSize(2);
   }
-}
\ No newline at end of file
+}