Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SONAR-6017 Add api/rules/repositories action to list rule repositorie…
…s (with criteria)
- Loading branch information
1 parent
b3a9a07
commit 0d24e18
Showing
22 changed files
with
353 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
server/sonar-server/src/main/java/org/sonar/server/rule/ws/RepositoriesAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * SonarQube, open source software quality management tool. | ||
| * Copyright (C) 2008-2014 SonarSource | ||
| * mailto:contact AT sonarsource DOT com | ||
| * | ||
| * SonarQube 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. | ||
| * | ||
| * SonarQube 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.server.rule.ws; | ||
|
|
||
| import com.google.common.collect.Lists; | ||
| import com.google.common.collect.Maps; | ||
| import com.google.common.io.Resources; | ||
| import org.sonar.api.server.ws.Request; | ||
| import org.sonar.api.server.ws.Response; | ||
| import org.sonar.api.server.ws.WebService; | ||
| import org.sonar.api.server.ws.WebService.NewAction; | ||
| import org.sonar.api.utils.text.JsonWriter; | ||
| import org.sonar.server.rule.RuleRepositories; | ||
| import org.sonar.server.rule.RuleRepositories.Repository; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.List; | ||
| import java.util.SortedMap; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| /** | ||
| * @since 5.1 | ||
| */ | ||
| public class RepositoriesAction implements RulesAction { | ||
|
|
||
| private static final String MATCH_ALL = ".*"; | ||
| private final RuleRepositories repositories; | ||
|
|
||
| public RepositoriesAction(RuleRepositories repositories) { | ||
| this.repositories = repositories; | ||
| } | ||
|
|
||
| @Override | ||
| public void handle(Request request, Response response) throws Exception { | ||
| String query = request.param("q"); | ||
| String languageKey = request.param("language"); | ||
| int pageSize = request.mandatoryParamAsInt("ps"); | ||
|
|
||
| JsonWriter json = response.newJsonWriter().beginObject().name("repositories").beginArray(); | ||
| for (Repository repo : listMatchingRepositories(query, languageKey, pageSize)) { | ||
| json.beginObject().prop("key", repo.key()).prop("name", repo.name()).prop("language", repo.language()).endObject(); | ||
| } | ||
| json.endArray().endObject().close(); | ||
| } | ||
|
|
||
| private Collection<Repository> listMatchingRepositories(@Nullable String query, @Nullable String languageKey, int pageSize) { | ||
| Pattern pattern = Pattern.compile(query == null ? MATCH_ALL : MATCH_ALL + query + MATCH_ALL, Pattern.CASE_INSENSITIVE); | ||
|
|
||
| SortedMap<String, Repository> reposByName = Maps.newTreeMap(); | ||
| Collection<Repository> repos = languageKey == null ? repositories.repositories() : repositories.repositoriesForLang(languageKey); | ||
|
|
||
| for (Repository repo : repos) { | ||
| if (pattern.matcher(repo.key()).matches() || pattern.matcher(repo.name()).matches()) { | ||
| reposByName.put(repo.name() + " -- " + repo.language(), repo); | ||
| } | ||
| } | ||
| List<Repository> result = Lists.newArrayList(reposByName.values()); | ||
| if (pageSize > 0 && pageSize < result.size()) { | ||
| result = result.subList(0, pageSize); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| @Override | ||
| public void define(WebService.NewController controller) { | ||
| NewAction action = controller.createAction("repositories") | ||
| .setDescription("List available rule repositories") | ||
| .setHandler(this) | ||
| .setResponseExample(Resources.getResource(getClass(), "example-repositories.json")); | ||
|
|
||
| action.createParam("q") | ||
| .setDescription("A pattern to match repository keys/names against") | ||
| .setExampleValue("squid"); | ||
| action.createParam("language") | ||
| .setDescription("A language key; if provided, only repositories for the given language will be returned") | ||
| .setExampleValue("java"); | ||
| action.createParam("ps") | ||
| .setDescription("The size of the list to return, 0 for all repositories") | ||
| .setExampleValue("25") | ||
| .setDefaultValue("0"); | ||
| } | ||
|
|
||
| } |
33 changes: 33 additions & 0 deletions
33
server/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * SonarQube, open source software quality management tool. | ||
| * Copyright (C) 2008-2014 SonarSource | ||
| * mailto:contact AT sonarsource DOT com | ||
| * | ||
| * SonarQube 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. | ||
| * | ||
| * SonarQube 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.server.rule.ws; | ||
|
|
||
| import org.sonar.api.server.ws.RequestHandler; | ||
| import org.sonar.api.server.ws.WebService; | ||
|
|
||
| /** | ||
| * Marker interface for coding rule related actions | ||
| * @author jblievremont | ||
| * | ||
| */ | ||
| interface RulesAction extends RequestHandler { | ||
|
|
||
| void define(WebService.NewController controller); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
27 changes: 27 additions & 0 deletions
27
server/sonar-server/src/main/resources/org/sonar/server/rule/ws/example-repositories.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "repositories": [ | ||
| {"key": "clirr", "name": "Clirr", "language": "java"}, | ||
| {"key": "common-c", "name": "Common SonarQube", "language": "c"}, | ||
| {"key": "common-cpp", "name": "Common SonarQube", "language": "cpp"}, | ||
| {"key": "common-cs", "name": "Common SonarQube", "language": "cs"}, | ||
| {"key": "common-java", "name": "Common SonarQube", "language": "java"}, | ||
| {"key": "common-js", "name": "Common SonarQube", "language": "js"}, | ||
| {"key": "common-objc", "name": "Common SonarQube", "language": "objc"}, | ||
| {"key": "common-php", "name": "Common SonarQube", "language": "php"}, | ||
| {"key": "c-cppcheck", "name": "Cppcheck", "language": "c"}, | ||
| {"key": "cpp-cppcheck", "name": "Cppcheck", "language": "cpp"}, | ||
| {"key": "fb-contrib", "name": "fb-contrib", "language": "java"}, | ||
| {"key": "findbugs", "name": "FindBugs", "language": "java"}, | ||
| {"key": "fxcop", "name": "FxCop / Code Analysis", "language": "cs"}, | ||
| {"key": "resharper-cs", "name": "ReSharper", "language": "cs"}, | ||
| {"key": "resharper-vbnet", "name": "ReSharper", "language": "vbnet"}, | ||
| {"key": "c", "name": "SonarQube", "language": "c"}, | ||
| {"key": "cpp", "name": "SonarQube", "language": "cpp"}, | ||
| {"key": "csharpsquid", "name": "SonarQube", "language": "cs"}, | ||
| {"key": "javascript", "name": "SonarQube", "language": "js"}, | ||
| {"key": "objc", "name": "SonarQube", "language": "objc"}, | ||
| {"key": "php", "name": "SonarQube", "language": "php"}, | ||
| {"key": "squid", "name": "SonarQube", "language": "java"}, | ||
| {"key": "stylecop", "name": "StyleCop", "language": "cs"} | ||
| ] | ||
| } |
Oops, something went wrong.