SONAR-7453 Fix rules WS description

diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/SearchAction.java
index 6d64787c07b72508a1c3d7f6f41702af965d0c07..8d622a584d265a9d2a370fd53cd43cc3ab73d377 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/SearchAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/SearchAction.java
@@ -167,10 +167,10 @@ public class SearchAction implements RulesWsAction {
     action.setDescription("Search for a collection of relevant rules matching a specified query.<br/>" +
       "Since 5.5, following fields in the response have been deprecated :" +
       "<ul><li>\"effortToFixDescription\" becomes \"gapDescription\"</li>" +
-      "<li>\"debtRemFnCoeff\" becomes \"debtRemFnGapMultiplier\"</li>" +
-      "<li>\"defaultDebtRemFnCoeff\" becomes \"defaultDebtRemFnGapMultiplier\"</li>" +
-      "<li>\"debtRemFnOffset\" becomes \"debtRemFnBaseEffort\"</li>" +
-      "<li>\"defaultDebtRemFnOffset\" becomes \"defaultDebtRemFnBaseEffort\"</li></ul>")
+      "<li>\"debtRemFnCoeff\" becomes \"remFnGapMultiplier\"</li>" +
+      "<li>\"defaultDebtRemFnCoeff\" becomes \"defaultRemFnGapMultiplier\"</li>" +
+      "<li>\"debtRemFnOffset\" becomes \"remFnBaseEffort\"</li>" +
+      "<li>\"defaultDebtRemFnOffset\" becomes \"defaultRemFnBaseEffort\"</li></ul>")
       .setResponseExample(Resources.getResource(getClass(), "example-search.json"))
       .setSince("4.4")
       .setHandler(this);

diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ShowAction.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ShowAction.java
index 8adc0e03502bebcc494ddda5ad40426499417e68..14a1616fafa7ccc386c9b1da690c7a274dbace4e 100644 (file)
--- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ShowAction.java
+++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/ShowAction.java
@@ -60,7 +60,13 @@ public class ShowAction implements RulesWsAction {
   public void define(WebService.NewController controller) {
     WebService.NewAction action = controller
       .createAction("show")
-      .setDescription("Get detailed information about a rule")
+      .setDescription("Get detailed information about a rule" +
+        "Since 5.5, following fields in the response have been deprecated :" +
+        "<ul><li>\"effortToFixDescription\" becomes \"gapDescription\"</li>" +
+        "<li>\"debtRemFnCoeff\" becomes \"remFnGapMultiplier\"</li>" +
+        "<li>\"defaultDebtRemFnCoeff\" becomes \"defaultRemFnGapMultiplier\"</li>" +
+        "<li>\"debtRemFnOffset\" becomes \"remFnBaseEffort\"</li>" +
+        "<li>\"defaultDebtRemFnOffset\" becomes \"defaultRemFnBaseEffort\"</li></ul>")
       .setSince("4.2")
       .setResponseExample(Resources.getResource(getClass(), "example-show.json"))
       .setHandler(this);

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rule.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rule.json
deleted file mode 100644 (file)
index 0a22112..0000000
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rule.json
+++ /dev/null
@@ -1,37 +0,0 @@
-{"total": 1, "p": 1, "ps": 100, "rules": [
-  {
-    "key": "xoo:x1",
-    "debtChar": "RELIABILITY",
-    "debtCharName": "Reliability",
-    "debtSubChar": "HARD_RELIABILITY",
-    "debtSubCharName": "Hard Reliability",
-    "debtRemFnType": "LINEAR_OFFSET",
-    "debtRemFnCoeff": "1h",
-    "debtRemFnOffset": "15min",
-    "debtOverloaded": false,
-    "defaultDebtChar": "RELIABILITY",
-    "defaultDebtSubChar": "HARD_RELIABILITY",
-    "defaultDebtRemFnType": "LINEAR_OFFSET",
-    "defaultDebtRemFnCoeff": "1h",
-    "defaultDebtRemFnOffset": "15min"
-  }
-],
-"facets": [
-  {
-    "property": "debt_characteristics",
-    "values": [
-      {
-        "val": "RELIABILITY",
-        "count": 1
-      },
-      {
-        "val": "HARD_RELIABILITY",
-        "count": 1
-      },
-      {
-        "val": "NONE",
-        "count": 0
-      }
-    ]
-  }
-]}

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_sticky.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_sticky.json
deleted file mode 100644 (file)
index 59441d3..0000000
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_sticky.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
-  "total": 1,
-  "p": 1,
-  "ps": 100,
-  "rules": [
-    {
-      "key": "xoo:x2",
-      "debtSubCharName": "Soft Reliability",
-      "defaultDebtRemFnType": "LINEAR_OFFSET",
-      "defaultDebtRemFnCoeff": "1h",
-      "defaultDebtRemFnOffset": "15min",
-      "debtChar": "RELIABILITY",
-      "debtOverloaded": true,
-      "debtCharName": "Reliability",
-      "debtRemFnType": "LINEAR_OFFSET",
-      "debtRemFnCoeff": "30min",
-      "debtRemFnOffset": "5min",
-      "debtSubChar": "SOFT_RELIABILITY",
-      "defaultDebtSubChar": "HARD_RELIABILITY",
-      "defaultDebtChar": "RELIABILITY"
-    }
-  ],
-  "facets": [
-    {
-      "property": "debt_characteristics",
-      "values": [
-        {
-          "val": "HARD_RELIABILITY",
-          "count": 1
-        },
-        {
-          "val": "SOFT_RELIABILITY",
-          "count": 1
-        },
-        {
-          "val": "RELIABILITY",
-          "count": 2
-        },
-        {
-          "val": "NONE",
-          "count": 2
-        }
-      ]
-    }
-  ]
-}

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_and_overridden_debt_values.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_and_overridden_debt_values.json
index 1432f14bad4e35fa4be8008a3174e867dbc60ab4..ac69b2e9ea7299e6dc52c75749f979a883234c86 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_and_overridden_debt_values.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_and_overridden_debt_values.json
@@ -1,12 +1,12 @@
 {"total": 1, "p": 1, "ps": 100, "rules": [
   {
     "key": "xoo:x1",
-    "debtRemFnType": "LINEAR_OFFSET",
-    "debtRemFnCoeff": "2h",
-    "debtRemFnOffset": "25min",
+    "remFnType": "LINEAR_OFFSET",
+    "remFnGapMultiplier": "2h",
+    "remFnBaseEffort": "25min",
     "debtOverloaded": true,
-    "defaultDebtRemFnType": "LINEAR_OFFSET",
-    "defaultDebtRemFnCoeff": "1h",
-    "defaultDebtRemFnOffset": "15min"
+    "defaultRemFnType": "LINEAR_OFFSET",
+    "defaultRemFnGapMultiplier": "1h",
+    "defaultRemFnBaseEffort": "15min"
   }
 ]}

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_constant_debt.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_constant_debt.json
index 692b966aceb196e3712c961b08e0cf75156f5494..d744e2ed7da93e01521565d06b71feddc2a5d204 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_constant_debt.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_constant_debt.json
@@ -1,11 +1,11 @@
 {"total": 1, "p": 1, "ps": 100, "rules": [
   {
     "key": "xoo:x1",
-    "debtRemFnType": "CONSTANT_ISSUE",
-    "debtRemFnOffset": "5min",
+    "remFnType": "CONSTANT_ISSUE",
+    "remFnBaseEffort": "5min",
     "debtOverloaded": true,
-    "defaultDebtRemFnType": "LINEAR_OFFSET",
-    "defaultDebtRemFnCoeff": "1h",
-    "defaultDebtRemFnOffset": "15min"
+    "defaultRemFnType": "LINEAR_OFFSET",
+    "defaultRemFnGapMultiplier": "1h",
+    "defaultRemFnBaseEffort": "15min"
   }
 ]}

diff --git a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_linear_debt.json b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_linear_debt.json
index 7268197bced62f36cdb810165fe538a0f309ee2c..27e1e453317aa8388b85687c843fb6446d9f8fed 100644 (file)
--- a/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_linear_debt.json
+++ b/server/sonar-server/src/test/resources/org/sonar/server/rule/ws/SearchActionMediumTest/search_debt_rules_with_default_linear_offset_and_overridden_linear_debt.json
@@ -1,11 +1,11 @@
 {"total": 1, "p": 1, "ps": 100, "rules": [
   {
     "key": "xoo:x1",
-    "debtRemFnType": "LINEAR",
-    "debtRemFnCoeff": "1h",
+    "remFnType": "LINEAR",
+    "remFnGapMultiplier": "1h",
     "debtOverloaded": true,
-    "defaultDebtRemFnType": "LINEAR_OFFSET",
-    "defaultDebtRemFnCoeff": "1h",
-    "defaultDebtRemFnOffset": "15min"
+    "defaultRemFnType": "LINEAR_OFFSET",
+    "defaultRemFnGapMultiplier": "1h",
+    "defaultRemFnBaseEffort": "15min"
   }
 ]}