001 /*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2014 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
019 */
020 package org.sonar.batch.qualitygate;
021
022 import com.google.common.annotations.VisibleForTesting;
023 import com.google.gson.JsonElement;
024 import com.google.gson.JsonObject;
025 import com.google.gson.JsonParser;
026 import org.picocontainer.injectors.ProviderAdapter;
027 import org.slf4j.Logger;
028 import org.slf4j.LoggerFactory;
029 import org.sonar.api.config.Settings;
030 import org.sonar.api.measures.MetricFinder;
031 import org.sonar.api.utils.HttpDownloader;
032 import org.sonar.api.utils.MessageException;
033 import org.sonar.batch.bootstrap.ServerClient;
034
035 import java.net.HttpURLConnection;
036
037 public class QualityGateProvider extends ProviderAdapter {
038
039
040 private static final Logger LOG = LoggerFactory.getLogger(QualityGateProvider.class);
041
042 private static final String PROPERTY_QUALITY_GATE = "sonar.qualitygate";
043
044 private static final String SHOW_URL = "/api/qualitygates/show";
045
046 private static final String ATTRIBUTE_CONDITIONS = "conditions";
047
048 private QualityGate instance;
049
050 public QualityGate provide(Settings settings, ServerClient client, MetricFinder metricFinder) {
051 if (instance == null) {
052 instance = init(settings, client, metricFinder, LOG);
053 }
054 return instance;
055 }
056
057 @VisibleForTesting
058 QualityGate init(Settings settings, ServerClient client, MetricFinder metricFinder, Logger logger) {
059 QualityGate result = QualityGate.disabled();
060 String qualityGateSetting = settings.getString(PROPERTY_QUALITY_GATE);
061 if (qualityGateSetting == null) {
062 logger.info("No quality gate is configured.");
063 } else {
064 result = load(qualityGateSetting, client, metricFinder);
065 logger.info("Loaded quality gate '{}'", result.name());
066 }
067 return result;
068 }
069
070 private QualityGate load(String qualityGateSetting, ServerClient client, MetricFinder metricFinder) {
071 QualityGate configuredGate = null;
072 try {
073 configuredGate = fetch(qualityGateSetting, client, metricFinder);
074 } catch (HttpDownloader.HttpException serverError) {
075 if (serverError.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
076 throw MessageException.of("Quality gate '" + qualityGateSetting + "' was not found.");
077 } else {
078 throw serverError;
079 }
080 }
081
082 return configuredGate;
083 }
084
085 private QualityGate fetch(String qualityGateSetting, ServerClient client, MetricFinder metricFinder) {
086 String jsonText = null;
087 try {
088 long qGateId = Long.valueOf(qualityGateSetting);
089 jsonText = client.request(SHOW_URL + "?id="+qGateId, false);
090 } catch(NumberFormatException configIsNameInsteadOfId) {
091 jsonText = client.request(SHOW_URL + "?name="+qualityGateSetting, false);
092 }
093
094 JsonParser parser = new JsonParser();
095 JsonObject root = parser.parse(jsonText).getAsJsonObject();
096
097 QualityGate configuredGate = new QualityGate(root.get("name").getAsString());
098
099 if (root.has(ATTRIBUTE_CONDITIONS)) {
100 for (JsonElement condition: root.get(ATTRIBUTE_CONDITIONS).getAsJsonArray()) {
101 JsonObject conditionObject = condition.getAsJsonObject();
102 configuredGate.add(new ResolvedCondition(conditionObject, metricFinder.findByKey(conditionObject.get("metric").getAsString())));
103 }
104 }
105
106 return configuredGate;
107 }
108 }