/* * SonarQube * Copyright (C) 2009-2017 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.scanner.rule; import java.io.IOException; import java.io.InputStream; import java.util.HashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; import org.apache.commons.io.IOUtils; import org.sonar.api.rule.RuleKey; import org.sonar.scanner.bootstrap.ScannerWsClient; import org.sonar.scanner.util.ScannerUtils; import org.sonarqube.ws.Rules; import org.sonarqube.ws.Rules.Active; import org.sonarqube.ws.Rules.Active.Param; import org.sonarqube.ws.Rules.ActiveList; import org.sonarqube.ws.Rules.Rule; import org.sonarqube.ws.Rules.SearchResponse; import org.sonarqube.ws.client.GetRequest; import static org.sonar.api.utils.DateUtils.dateToLong; import static org.sonar.api.utils.DateUtils.parseDateTime; public class DefaultActiveRulesLoader implements ActiveRulesLoader { private static final String RULES_SEARCH_URL = "/api/rules/search.protobuf?f=repo,name,severity,lang,internalKey,templateKey,params,actives,createdAt&activation=true"; private final ScannerWsClient wsClient; public DefaultActiveRulesLoader(ScannerWsClient wsClient) { this.wsClient = wsClient; } @Override public List<LoadedActiveRule> load(String qualityProfileKey) { List<LoadedActiveRule> ruleList = new LinkedList<>(); int page = 1; int pageSize = 500; int loaded = 0; while (true) { GetRequest getRequest = new GetRequest(getUrl(qualityProfileKey, page, pageSize)); SearchResponse response = loadFromStream(wsClient.call(getRequest).contentStream()); List<LoadedActiveRule> pageRules = readPage(response); ruleList.addAll(pageRules); loaded += response.getPs(); if (response.getTotal() <= loaded) { break; } page++; } return ruleList; } private static String getUrl(String qualityProfileKey, int page, int pageSize) { StringBuilder builder = new StringBuilder(1024); builder.append(RULES_SEARCH_URL); builder.append("&qprofile=").append(ScannerUtils.encodeForUrl(qualityProfileKey)); builder.append("&p=").append(page); builder.append("&ps=").append(pageSize); return builder.toString(); } private static SearchResponse loadFromStream(InputStream is) { try { return SearchResponse.parseFrom(is); } catch (IOException e) { throw new IllegalStateException("Failed to load quality profiles", e); } finally { IOUtils.closeQuietly(is); } } private static List<LoadedActiveRule> readPage(SearchResponse response) { List<LoadedActiveRule> loadedRules = new LinkedList<>(); List<Rule> rulesList = response.getRulesList(); Map<String, ActiveList> actives = response.getActives().getActives(); for (Rule r : rulesList) { ActiveList activeList = actives.get(r.getKey()); Active active = activeList.getActiveList(0); LoadedActiveRule loadedRule = new LoadedActiveRule(); loadedRule.setRuleKey(RuleKey.parse(r.getKey())); loadedRule.setName(r.getName()); loadedRule.setSeverity(active.getSeverity()); loadedRule.setCreatedAt(dateToLong(parseDateTime(active.getCreatedAt()))); loadedRule.setLanguage(r.getLang()); loadedRule.setInternalKey(r.getInternalKey()); if (r.hasTemplateKey()) { RuleKey templateRuleKey = RuleKey.parse(r.getTemplateKey()); loadedRule.setTemplateRuleKey(templateRuleKey.rule()); } Map<String, String> params = new HashMap<>(); for (Rules.Rule.Param param : r.getParams().getParamsList()) { params.put(param.getKey(), param.getDefaultValue()); } // overrides defaultValue if the key is the same for (Param param : active.getParamsList()) { params.put(param.getKey(), param.getValue()); } loadedRule.setParams(params); loadedRules.add(loadedRule); } return loadedRules; } }