From: Julien Lancelot Date: Fri, 6 Jan 2017 15:15:04 +0000 (+0100) Subject: SONAR-7297 Rename file examples of issues WS X-Git-Tag: 6.3-RC1~610 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=bfe73724ce82737b302daee77f9d0c36c165d2b5;p=sonarqube.git SONAR-7297 Rename file examples of issues WS --- diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/AuthorsAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/AuthorsAction.java index 29c9c164725..e932c9dd93f 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/AuthorsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/AuthorsAction.java @@ -60,7 +60,7 @@ public class AuthorsAction implements IssuesWsAction { NewAction action = controller.createAction(ACTION_AUTHORS) .setSince("5.1") .setDescription("Search SCM accounts which match a given query") - .setResponseExample(Resources.getResource(this.getClass(), "example-authors.json")) + .setResponseExample(Resources.getResource(this.getClass(), "authors-example.json")) .setHandler(this); action.createParam(Param.TEXT_QUERY) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ChangelogAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ChangelogAction.java index 6709d3b866a..b7d63fec1e7 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ChangelogAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ChangelogAction.java @@ -73,7 +73,7 @@ public class ChangelogAction implements IssuesWsAction { "Since 6.3, changes on effort are returning raw value in minutes, it doesn't return anymore the duration.") .setSince("4.1") .setHandler(this) - .setResponseExample(Resources.getResource(IssuesWs.class, "example-changelog.json")); + .setResponseExample(Resources.getResource(IssuesWs.class, "changelog-example.json")); action.createParam(PARAM_ISSUE) .setDescription("Issue key") .setRequired(true) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ComponentTagsAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ComponentTagsAction.java index 4286621abb3..1e6ce038359 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ComponentTagsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/ComponentTagsAction.java @@ -59,7 +59,7 @@ public class ComponentTagsAction implements IssuesWsAction { .setSince("5.1") .setInternal(true) .setDescription("List tags for the issues under a given component (including issues on the descendants of the component)") - .setResponseExample(Resources.getResource(getClass(), "example-component-tags.json")); + .setResponseExample(Resources.getResource(getClass(), "component-tags-example.json")); action.createParam(PARAM_COMPONENT_UUID) .setDescription("A component UUID") .setRequired(true) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java index a781d229366..52dfde6a0b3 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/SearchAction.java @@ -128,7 +128,7 @@ public class SearchAction implements IssuesWsAction { "Since 5.5, response field 'reporter' has been removed, as manual issue feature has been dropped.", PARAM_COMPONENT_KEYS, PARAM_COMPONENT_UUIDS, PARAM_COMPONENTS, PARAM_COMPONENT_ROOT_UUIDS, PARAM_COMPONENT_ROOTS) .setSince("3.6") - .setResponseExample(getClass().getResource("example-search.json")); + .setResponseExample(getClass().getResource("search-example.json")); action.addPagingParams(100, MAX_LIMIT); action.createParam(Param.FACETS) diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/TagsAction.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/TagsAction.java index f486d2fe0ca..da5fd97cf46 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/TagsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/TagsAction.java @@ -46,7 +46,7 @@ public class TagsAction implements IssuesWsAction { .setHandler(this) .setSince("5.1") .setDescription("List tags matching a given query") - .setResponseExample(Resources.getResource(getClass(), "example-tags.json")); + .setResponseExample(Resources.getResource(getClass(), "tags-example.json")); action.createParam(Param.TEXT_QUERY) .setDescription("A pattern to match tags against") .setExampleValue("misra"); diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/authors-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/authors-example.json new file mode 100644 index 00000000000..77500549a82 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/authors-example.json @@ -0,0 +1,15 @@ +{ + "authors": { + "more": true, + "results": [ + { + "key": "leia.organa", + "text": "leia.organa" + }, + { + "key": "luke@skywalker.name", + "text": "luke@skywalker.name" + } + ] + } +} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/changelog-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/changelog-example.json new file mode 100644 index 00000000000..7d962cbb001 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/changelog-example.json @@ -0,0 +1,17 @@ +{ + "changelog": [ + { + "user": "john.smith", + "userName": "John Smith", + "email": "john@smith.com", + "creationDate": "2014-03-04T23:03:44+0100", + "diffs": [ + { + "key": "severity", + "newValue": "BLOCKER", + "oldValue": "MAJOR" + } + ] + } + ] +} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/component-tags-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/component-tags-example.json new file mode 100644 index 00000000000..3e00535cb05 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/component-tags-example.json @@ -0,0 +1,7 @@ +{ + "tags": [ + { key: "convention", value: 42 }, + { key: "cwe", value: 12 }, + { key: "security", value: 5 } + ] +} \ No newline at end of file diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-authors.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-authors.json deleted file mode 100644 index 77500549a82..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-authors.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "authors": { - "more": true, - "results": [ - { - "key": "leia.organa", - "text": "leia.organa" - }, - { - "key": "luke@skywalker.name", - "text": "luke@skywalker.name" - } - ] - } -} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-changelog.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-changelog.json deleted file mode 100644 index 7d962cbb001..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-changelog.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "changelog": [ - { - "user": "john.smith", - "userName": "John Smith", - "email": "john@smith.com", - "creationDate": "2014-03-04T23:03:44+0100", - "diffs": [ - { - "key": "severity", - "newValue": "BLOCKER", - "oldValue": "MAJOR" - } - ] - } - ] -} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-component-tags.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-component-tags.json deleted file mode 100644 index 3e00535cb05..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-component-tags.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "tags": [ - { key: "convention", value: 42 }, - { key: "cwe", value: 12 }, - { key: "security", value: 5 } - ] -} \ No newline at end of file diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-search.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-search.json deleted file mode 100644 index 2bb9d5fc008..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-search.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "paging": { - "pageIndex": 1, - "pageSize": 100, - "total": 1 - }, - "issues": [ - { - "key": "01fc972e-2a3c-433e-bcae-0bd7f88f5123", - "component": "com.github.kevinsawicki:http-request:com.github.kevinsawicki.http.HttpRequest", - "project": "com.github.kevinsawicki:http-request", - "rule": "checkstyle:com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck", - "status": "RESOLVED", - "resolution": "FALSE-POSITIVE", - "severity": "MINOR", - "message": "'3' is a magic number.", - "line": 530, - "textRange": { - "startLine": 81, - "endLine": 81, - "startOffset": 0, - "endOffset": 134 - }, - "author": "Developer 1", - "effort": "2h1min", - "creationDate": "2013-05-13T17:55:39+0200", - "updateDate": "2013-05-13T17:55:39+0200", - "tags": ["bug"], - "type": "RELIABILITY", - "comments": [ - { - "key": "7d7c56f5-7b5a-41b9-87f8-36fa70caa5ba", - "login": "john.smith", - "htmlText": "Must be "final"!", - "markdown": "Must be \"final\"!", - "updatable": false, - "createdAt": "2013-05-13T18:08:34+0200" - } - ], - "attr": { - "jira-issue-key": "SONAR-1234" - }, - "transitions": [ - "unconfirm", - "resolve", - "falsepositive" - ], - "actions": [ - "comment" - ] - } - ], - "components": [ - { - "key": "com.github.kevinsawicki:http-request:src/main/java/com/github/kevinsawicki/http/HttpRequest.java", - "enabled": true, - "qualifier": "FIL", - "name": "HttpRequest.java", - "longName": "src/main/java/com/github/kevinsawicki/http/HttpRequest.java", - "path": "src/main/java/com/github/kevinsawicki/http/HttpRequest.java" - }, - { - "key": "com.github.kevinsawicki:http-request", - "enabled": true, - "qualifier": "TRK", - "name": "http-request", - "longName": "http-request" - } - ], - "rules": [ - { - "key": "checkstyle:com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck", - "name": "Magic Number", - "status": "READY", - "lang": "java", - "langName": "Java" - } - ], - "users": [ - { - "login": "admin", - "name": "Administrator", - "active": true, - "email": "admin@sonarqube.org" - } - ] - -} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-tags.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-tags.json deleted file mode 100644 index 4b25b0ce852..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-tags.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "tags": ["convention", "security", "cwe"] -} \ No newline at end of file diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-transitions.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-transitions.json deleted file mode 100644 index fcee98bfcee..00000000000 --- a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/example-transitions.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "transitions": ["confirm", "resolve", "falsepositive"] -} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/search-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/search-example.json new file mode 100644 index 00000000000..2bb9d5fc008 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/search-example.json @@ -0,0 +1,88 @@ +{ + "paging": { + "pageIndex": 1, + "pageSize": 100, + "total": 1 + }, + "issues": [ + { + "key": "01fc972e-2a3c-433e-bcae-0bd7f88f5123", + "component": "com.github.kevinsawicki:http-request:com.github.kevinsawicki.http.HttpRequest", + "project": "com.github.kevinsawicki:http-request", + "rule": "checkstyle:com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck", + "status": "RESOLVED", + "resolution": "FALSE-POSITIVE", + "severity": "MINOR", + "message": "'3' is a magic number.", + "line": 530, + "textRange": { + "startLine": 81, + "endLine": 81, + "startOffset": 0, + "endOffset": 134 + }, + "author": "Developer 1", + "effort": "2h1min", + "creationDate": "2013-05-13T17:55:39+0200", + "updateDate": "2013-05-13T17:55:39+0200", + "tags": ["bug"], + "type": "RELIABILITY", + "comments": [ + { + "key": "7d7c56f5-7b5a-41b9-87f8-36fa70caa5ba", + "login": "john.smith", + "htmlText": "Must be "final"!", + "markdown": "Must be \"final\"!", + "updatable": false, + "createdAt": "2013-05-13T18:08:34+0200" + } + ], + "attr": { + "jira-issue-key": "SONAR-1234" + }, + "transitions": [ + "unconfirm", + "resolve", + "falsepositive" + ], + "actions": [ + "comment" + ] + } + ], + "components": [ + { + "key": "com.github.kevinsawicki:http-request:src/main/java/com/github/kevinsawicki/http/HttpRequest.java", + "enabled": true, + "qualifier": "FIL", + "name": "HttpRequest.java", + "longName": "src/main/java/com/github/kevinsawicki/http/HttpRequest.java", + "path": "src/main/java/com/github/kevinsawicki/http/HttpRequest.java" + }, + { + "key": "com.github.kevinsawicki:http-request", + "enabled": true, + "qualifier": "TRK", + "name": "http-request", + "longName": "http-request" + } + ], + "rules": [ + { + "key": "checkstyle:com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck", + "name": "Magic Number", + "status": "READY", + "lang": "java", + "langName": "Java" + } + ], + "users": [ + { + "login": "admin", + "name": "Administrator", + "active": true, + "email": "admin@sonarqube.org" + } + ] + +} diff --git a/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/tags-example.json b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/tags-example.json new file mode 100644 index 00000000000..4b25b0ce852 --- /dev/null +++ b/server/sonar-server/src/main/resources/org/sonar/server/issue/ws/tags-example.json @@ -0,0 +1,3 @@ +{ + "tags": ["convention", "security", "cwe"] +} \ No newline at end of file diff --git a/server/sonar-server/src/test/java/org/sonar/server/issue/ws/ChangelogActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/issue/ws/ChangelogActionTest.java index bc79be09e33..9783a0d9c79 100644 --- a/server/sonar-server/src/test/java/org/sonar/server/issue/ws/ChangelogActionTest.java +++ b/server/sonar-server/src/test/java/org/sonar/server/issue/ws/ChangelogActionTest.java @@ -261,7 +261,7 @@ public class ChangelogActionTest { String result = tester.newRequest().setParam("issue", issueDto.getKey()).execute().getInput(); - assertJson(result).isSimilarTo(getClass().getResource("example-changelog.json")); + assertJson(result).isSimilarTo(getClass().getResource("changelog-example.json")); } @Test