From: Guillaume Jambet <guillaume.jambet@sonarsource.com>
Date: Thu, 2 Nov 2017 16:49:34 +0000 (+0100)
Subject: SONAR-10040 add length validation to Rules ws
X-Git-Tag: 7.0-RC1~354
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=26b9f42ff60c043b834c2aad95641c3bccc8fdde;p=sonarqube.git

SONAR-10040 add length validation to Rules ws
---

diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/CreateAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/CreateAction.java
index 9b0a465b258..f745aad7d66 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/CreateAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/CreateAction.java
@@ -59,6 +59,8 @@ public class CreateAction implements RulesWsAction {
   public static final String PARAMS = "params";
 
   public static final String PARAM_PREVENT_REACTIVATION = "prevent_reactivation";
+  static final int KEY_MAXIMUM_LENGTH = 200;
+  static final int NAME_MAXIMUM_LENGTH = 200;
 
   private final DbClient dbClient;
   private final RuleCreator ruleCreator;
@@ -76,19 +78,20 @@ public class CreateAction implements RulesWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller
       .createAction("create")
+      .setPost(true)
       .setDescription("Create a custom rule.<br>" +
         "Requires the 'Administer Quality Profiles' permission")
       .setSince("4.4")
       .setChangelog(
         new Change("5.5", "Creating manual rule is not more possible"))
-      .setPost(true)
       .setHandler(this);
 
     action
       .createParam(PARAM_CUSTOM_KEY)
+      .setRequired(true)
+      .setMaximumLength(KEY_MAXIMUM_LENGTH)
       .setDescription("Key of the custom rule")
-      .setExampleValue("Todo_should_not_be_used")
-      .setRequired(true);
+      .setExampleValue("Todo_should_not_be_used");
 
     action
       .createParam("manual_key")
@@ -103,40 +106,41 @@ public class CreateAction implements RulesWsAction {
 
     action
       .createParam(PARAM_NAME)
-      .setDescription("Rule name")
       .setRequired(true)
+      .setMaximumLength(NAME_MAXIMUM_LENGTH)
+      .setDescription("Rule name")
       .setExampleValue("My custom rule");
 
     action
       .createParam(PARAM_DESCRIPTION)
-      .setDescription("Rule description")
       .setRequired(true)
+      .setDescription("Rule description")
       .setExampleValue("Description of my custom rule");
 
     action
       .createParam(PARAM_SEVERITY)
-      .setDescription("Rule severity")
-      .setPossibleValues(Severity.ALL);
+      .setPossibleValues(Severity.ALL)
+      .setDescription("Rule severity");
 
     action
       .createParam(PARAM_STATUS)
-      .setDescription("Rule status")
+      .setPossibleValues(RuleStatus.values())
       .setDefaultValue(RuleStatus.READY)
-      .setPossibleValues(RuleStatus.values());
+      .setDescription("Rule status");
 
     action.createParam(PARAMS)
       .setDescription("Parameters as semi-colon list of <key>=<value>, for example 'params=key1=v1;key2=v2' (Only for custom rule)");
 
     action
       .createParam(PARAM_PREVENT_REACTIVATION)
-      .setDescription("If set to true and if the rule has been deactivated (status 'REMOVED'), a status 409 will be returned")
+      .setBooleanPossibleValues()
       .setDefaultValue(false)
-      .setBooleanPossibleValues();
+      .setDescription("If set to true and if the rule has been deactivated (status 'REMOVED'), a status 409 will be returned");
 
     action.createParam(PARAM_TYPE)
+      .setPossibleValues(RuleType.names())
       .setDescription("Rule type")
-      .setSince("6.7")
-      .setPossibleValues(RuleType.names());
+      .setSince("6.7");
   }
 
   @Override
diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
index 599ba81c97e..60cedd919c0 100644
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java
@@ -53,6 +53,8 @@ import static java.util.Collections.singletonList;
 import static java.util.Optional.ofNullable;
 import static org.apache.commons.lang.StringUtils.defaultIfEmpty;
 import static org.sonar.db.permission.OrganizationPermission.ADMINISTER_QUALITY_PROFILES;
+import static org.sonar.server.rule.ws.CreateAction.KEY_MAXIMUM_LENGTH;
+import static org.sonar.server.rule.ws.CreateAction.NAME_MAXIMUM_LENGTH;
 import static org.sonar.server.ws.WsUtils.writeProtobuf;
 
 public class UpdateAction implements RulesWsAction {
@@ -100,6 +102,7 @@ public class UpdateAction implements RulesWsAction {
 
     action.createParam(PARAM_KEY)
       .setRequired(true)
+      .setMaximumLength(KEY_MAXIMUM_LENGTH)
       .setDescription("Key of the rule to update")
       .setExampleValue("javascript:NullCheck");
 
@@ -144,6 +147,7 @@ public class UpdateAction implements RulesWsAction {
 
     action
       .createParam(PARAM_NAME)
+      .setMaximumLength(NAME_MAXIMUM_LENGTH)
       .setDescription("Rule name (mandatory for custom rule)")
       .setExampleValue("My custom rule");
 
@@ -159,13 +163,13 @@ public class UpdateAction implements RulesWsAction {
 
     action
       .createParam(PARAM_STATUS)
-      .setDescription("Rule status (Only when updating a custom rule)")
-      .setPossibleValues(RuleStatus.values());
+      .setPossibleValues(RuleStatus.values())
+      .setDescription("Rule status (Only when updating a custom rule)");
 
     action.createParam(PARAM_ORGANIZATION)
-      .setDescription("Organization key")
       .setRequired(false)
       .setInternal(true)
+      .setDescription("Organization key")
       .setExampleValue("my-org")
       .setSince("6.4");