PLUGINAPI-43 added the concept of characteristic from the Clean Code Taxonomy

Author: lukasz-jarocki-sonarsource

plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/ExternalIssue.java

@@ -20,8 +20,10 @@
 package org.sonar.api.batch.sensor.issue;
 
 import javax.annotation.CheckForNull;
+import org.sonar.api.Beta;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 
 /**
@@ -53,4 +55,12 @@ public interface ExternalIssue extends IIssue {
    */
   RuleType type();
 
+  /**
+   * Characteristic of the issue according to Clean Code Taxonomy.
+   * @since 9.16
+   */
+  @Beta
+  @CheckForNull
+  CodeCharacteristic characteristic();
+
 }

plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewExternalIssue.java

@@ -20,9 +20,11 @@
 package org.sonar.api.batch.sensor.issue;
 
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 
 /**
@@ -52,10 +54,19 @@ public interface NewExternalIssue {
   NewExternalIssue ruleId(String ruleId);
 
   /**
-   * Type of issue.
+   * Type of the issue.
    */
   NewExternalIssue type(RuleType type);
 
+  /**
+   * Characteristic of the issue according to Clean Code Taxonomy.
+   * Providing it is optional for now but will become mandatory in the future.
+   *
+   * @since 9.16
+   */
+  @Beta
+  NewExternalIssue characteristic(CodeCharacteristic characteristic);
+
   /**
    * Effort to fix the issue, in minutes.
    */

plugin-api/src/main/java/org/sonar/api/batch/sensor/rule/AdHocRule.java

@@ -20,8 +20,10 @@
 package org.sonar.api.batch.sensor.rule;
 
 import javax.annotation.CheckForNull;
+import org.sonar.api.Beta;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 
 /**
@@ -61,4 +63,13 @@ public interface AdHocRule {
    */
   RuleType type();
 
+  /**
+   * Characteristic of the rule according to Clean Code Taxonomy.
+   *
+   * @since 9.16
+   */
+  @Beta
+  @CheckForNull
+  CodeCharacteristic characteristic();
+
 }

plugin-api/src/main/java/org/sonar/api/batch/sensor/rule/NewAdHocRule.java

@@ -20,8 +20,10 @@
 package org.sonar.api.batch.sensor.rule;
 
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 
 /**
@@ -58,6 +60,15 @@ public interface NewAdHocRule {
    */
   NewAdHocRule type(RuleType type);
 
+  /**
+   * Characteristic of the rule according to Clean Code Taxonomy.
+   * Providing it is optional for now but will become mandatory in the future.
+   *
+   * @since 9.16
+   */
+  @Beta
+  NewAdHocRule characteristic(CodeCharacteristic characteristic);
+
   /**
    * Set the severity of the rule.
    */

plugin-api/src/main/java/org/sonar/api/ce/measure/Issue.java

@@ -20,7 +20,9 @@
 package org.sonar.api.ce.measure;
 
 import javax.annotation.CheckForNull;
+import org.sonar.api.Beta;
 import org.sonar.api.rule.RuleKey;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 import org.sonar.api.utils.Duration;
 
@@ -59,4 +61,12 @@ public interface Issue {
 
   RuleType type();
 
+  /**
+   * Characteristic of the issue according to Clean Code Taxonomy.
+   * @since 9.16
+   */
+  @Beta
+  @CheckForNull
+  CodeCharacteristic characteristic();
+
 }

plugin-api/src/main/java/org/sonar/api/ce/measure/test/TestIssue.java

@@ -25,6 +25,7 @@
 import org.sonar.api.ce.measure.Issue;
 import org.sonar.api.rule.RuleKey;
 import org.sonar.api.rule.Severity;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 import org.sonar.api.utils.Duration;
 
@@ -34,13 +35,14 @@
 @Immutable
 public class TestIssue implements Issue {
 
-  private String key;
-  private String status;
-  private String resolution;
-  private String severity;
-  private RuleKey ruleKey;
-  private Duration effort;
-  private RuleType type;
+  private final String key;
+  private final String status;
+  private final String resolution;
+  private final String severity;
+  private final RuleKey ruleKey;
+  private final Duration effort;
+  private final RuleType type;
+  private final CodeCharacteristic characteristic;
 
   private TestIssue(Builder builder) {
     this.key = builder.key;
@@ -50,6 +52,7 @@ private TestIssue(Builder builder) {
     this.ruleKey = builder.ruleKey;
     this.effort = builder.effort;
     this.type = builder.type;
+    this.characteristic = builder.characteristic;
   }
 
   @Override
@@ -94,6 +97,14 @@ public RuleType type() {
     return type;
   }
 
+  /**
+   * @since 9.16
+   */
+  @Override
+  public CodeCharacteristic characteristic() {
+    return characteristic;
+  }
+
   public static class Builder {
     private String key;
     private String status;
@@ -102,6 +113,7 @@ public static class Builder {
     private RuleKey ruleKey;
     private Duration effort;
     private RuleType type;
+    private CodeCharacteristic characteristic;
 
     public Builder setKey(String key) {
       this.key = validateKey(key);
@@ -144,6 +156,15 @@ public Builder setType(RuleType type) {
       return this;
     }
 
+    /**
+     * @since 9.16
+     */
+    public Builder setCharacteristic(CodeCharacteristic characteristic) {
+      requireNonNull(characteristic, "Characteristic cannot be null");
+      this.characteristic = characteristic;
+      return this;
+    }
+
     private static String validateKey(String key) {
       requireNonNull(key, "key cannot be null");
       return key;

plugin-api/src/main/java/org/sonar/api/code/CharacteristicsCategory.java

@@ -0,0 +1,27 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-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.api.code;
+
+import org.sonar.api.Beta;
+
+@Beta
+public enum CharacteristicsCategory {
+  DEVELOPMENT, PRODUCTION
+}

plugin-api/src/main/java/org/sonar/api/code/CodeCharacteristic.java

@@ -0,0 +1,49 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-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.api.code;
+
+import org.sonar.api.Beta;
+import org.sonar.api.rules.RuleType;
+
+import static org.sonar.api.code.CharacteristicsCategory.*;
+
+/**
+ * Enum that represents Characteristic according to the new Clean Code Taxonomy. Should be used instead of {@link RuleType} as it will
+ * become mandatory in the future to provide it.
+ *
+ * @since 9.16
+ */
+@Beta
+public enum CodeCharacteristic {
+
+  CLEAR(DEVELOPMENT), CONSISTENT(DEVELOPMENT), STRUCTURED(DEVELOPMENT), TESTED(DEVELOPMENT),
+
+  ROBUST(PRODUCTION), SECURE(PRODUCTION), PORTABLE(PRODUCTION), COMPLIANT(PRODUCTION);
+
+  private final CharacteristicsCategory characteristicsCategory;
+
+  CodeCharacteristic(CharacteristicsCategory characteristicsCategory) {
+    this.characteristicsCategory = characteristicsCategory;
+  }
+
+  public CharacteristicsCategory getCharacteristicsCategory() {
+    return characteristicsCategory;
+  }
+}

plugin-api/src/main/java/org/sonar/api/rules/RuleType.java

@@ -22,12 +22,16 @@
 import java.util.LinkedHashSet;
 import java.util.Set;
 import javax.annotation.CheckForNull;
+import org.sonar.api.code.CodeCharacteristic;
 
 import static java.lang.String.format;
 import static java.util.Arrays.stream;
 import static java.util.Collections.unmodifiableSet;
 import static java.util.stream.Collectors.toList;
 
+/**
+ * Type of the rule. It is strongly recommended using {@link CodeCharacteristic} alongside as it will become mandatory in the future.
+ */
 public enum RuleType {
   CODE_SMELL(1), BUG(2), VULNERABILITY(3), SECURITY_HOTSPOT(4);
 

plugin-api/src/main/java/org/sonar/api/server/rule/RulesDefinition.java

@@ -29,11 +29,13 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
+import org.sonar.api.Beta;
 import org.sonar.api.ExtensionPoint;
 import org.sonar.api.ce.ComputeEngineSide;
 import org.sonar.api.rule.RuleKey;
 import org.sonar.api.rule.RuleScope;
 import org.sonar.api.rule.RuleStatus;
+import org.sonar.api.code.CodeCharacteristic;
 import org.sonar.api.rules.RuleType;
 import org.sonar.api.server.ServerSide;
 import org.sonar.api.server.debt.DebtRemediationFunction;
@@ -421,6 +423,16 @@ abstract class NewRule {
      */
     public abstract NewRule setType(RuleType t);
 
+
+    /**
+     * The characteristic of the rule according to Clean Code Taxonomy.
+     *
+     * Providing it is optional for now but will become mandatory in the future.
+     * @since 9.16
+     */
+    @Beta
+    public abstract NewRule setCharacteristic(CodeCharacteristic codeCharacteristic);
+
     /**
      * Add a rule description section. The sections must be added in the right order.
      * For backward compatibility, one of the old method {@link #setHtmlDescription(String)} or {@link #setHtmlDescription(URL)} still
@@ -589,6 +601,14 @@ abstract class Rule {
      */
     public abstract RuleType type();
 
+    /**
+     * @see NewRule#setCharacteristic(CodeCharacteristic)
+     * @since 9.16
+     */
+    @CheckForNull
+    @Beta
+    public abstract CodeCharacteristic characteristic();
+
     public abstract String severity();
 
     /**