SONARTEXT-14 Create generator to generate Java classes for every rule (#162)

Author: jonas-wielage-sonarsource

sonar-text-plugin/src/main/java/org/sonar/plugins/secrets/SecretsRulesDefinition.java

@@ -51,8 +51,8 @@ public static List<Class<?>> checks() {
     return List.of(
       AlibabaCloudAccessKeyCheck.class,
       AwsCheck.class,
-      CommonKeyCheck.class,
       AzureStorageAccountKeyCheck.class,
+      CommonKeyCheck.class,
       GoogleApiKeyCheck.class,
       GoogleCloudAccountKeyCheck.class,
       IbmApiKeyCheck.class,

sonar-text-plugin/src/main/java/org/sonar/plugins/secrets/SecretsSpecificationFilesDefinition.java

@@ -0,0 +1,61 @@
+/*
+ * SonarQube Text Plugin
+ * Copyright (C) 2021-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.secrets;
+
+import java.util.Set;
+
+public class SecretsSpecificationFilesDefinition {
+
+  private SecretsSpecificationFilesDefinition() {
+
+  }
+
+  public static Set<String> existingSecretSpecifications() {
+    return Set.of(
+      "alibaba.yaml",
+      "aws.yaml",
+      "azure.yaml",
+      "clarifai.yaml",
+      "django.yaml",
+      "facebook.yaml",
+      "gcp.yaml",
+      "github.yaml",
+      "gitlab.yaml",
+      "google-api.yaml",
+      "google-oauth2.yaml",
+      "google-recaptcha.yaml",
+      "ibm.yaml",
+      "mongodb.yaml",
+      "mws.yaml",
+      "mysql.yaml",
+      "odbc.yaml",
+      "openweathermap.yaml",
+      "postgresql.yaml",
+      "pubkey-crypto.yaml",
+      "rapidapi.yaml",
+      "riot.yaml",
+      "sendgrid.yaml",
+      "sonarqube.yaml",
+      "spotify.yaml",
+      "ssh.yaml",
+      "telegram.yaml",
+      "wechat.yaml");
+  }
+}

sonar-text-plugin/src/main/java/org/sonar/plugins/secrets/api/SpecificationLoader.java

@@ -34,14 +34,16 @@
 import org.sonar.plugins.secrets.configuration.model.Specification;
 import org.sonar.plugins.secrets.configuration.validation.SchemaValidationException;
 
+import static org.sonar.plugins.secrets.SecretsSpecificationFilesDefinition.existingSecretSpecifications;
+
 public class SpecificationLoader {
   private static final Logger LOG = Loggers.get(SpecificationLoader.class);
 
   public static final String DEFAULT_SPECIFICATION_LOCATION = "org/sonar/plugins/secrets/configuration/";
   private final Map<String, List<Rule>> rulesMappedToKey;
 
   public SpecificationLoader() {
-    this(DEFAULT_SPECIFICATION_LOCATION, defaultSpecifications());
+    this(DEFAULT_SPECIFICATION_LOCATION, existingSecretSpecifications());
   }
 
   public SpecificationLoader(String specificationLocation, Set<String> specifications) {
@@ -77,39 +79,7 @@ public List<Rule> getRulesForKey(String key) {
     return rulesMappedToKey.getOrDefault(key, new ArrayList<>());
   }
 
-  Map<String, List<Rule>> getRulesMappedToKey() {
+  public Map<String, List<Rule>> getRulesMappedToKey() {
     return rulesMappedToKey;
   }
-
-  public static Set<String> defaultSpecifications() {
-    return Set.of(
-      "alibaba.yaml",
-      "aws.yaml",
-      "azure.yaml",
-      "clarifai.yaml",
-      "django.yaml",
-      "facebook.yaml",
-      "gcp.yaml",
-      "github.yaml",
-      "gitlab.yaml",
-      "google-api.yaml",
-      "google-oauth2.yaml",
-      "google-recaptcha.yaml",
-      "ibm.yaml",
-      "mongodb.yaml",
-      "mws.yaml",
-      "mysql.yaml",
-      "odbc.yaml",
-      "openweathermap.yaml",
-      "postgresql.yaml",
-      "pubkey-crypto.yaml",
-      "rapidapi.yaml",
-      "riot.yaml",
-      "sendgrid.yaml",
-      "sonarqube.yaml",
-      "spotify.yaml",
-      "ssh.yaml",
-      "telegram.yaml",
-      "wechat.yaml");
-  }
 }

sonar-text-plugin/src/test/java/org/sonar/plugins/secrets/SecretsSpecificationFilesDefinitionTest.java

@@ -0,0 +1,32 @@
+/*
+ * SonarQube Text Plugin
+ * Copyright (C) 2021-2023 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.secrets;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SecretsSpecificationFilesDefinitionTest {
+
+  @Test
+  void e() {
+    assertThat(SecretsSpecificationFilesDefinition.existingSecretSpecifications()).hasSizeGreaterThanOrEqualTo(28);
+  }
+}

sonar-text-plugin/src/test/java/org/sonar/plugins/secrets/api/SpecificationLoaderTest.java

@@ -43,7 +43,6 @@ void shouldLoadRulesWithoutErrors() {
     Map<String, List<Rule>> rulesMappedToKey = specificationLoader.getRulesMappedToKey();
 
     assertThat(rulesMappedToKey.values()).hasSize(SecretsRulesDefinition.checks().size());
-    assertThat(rulesMappedToKey.values().stream().flatMap(Collection::stream)).hasSize(67);
     assertThat(logTester.getLogs()).isEmpty();
   }