Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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.server.debt;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.server.ServerSide;
import org.xml.sax.InputSource;
/**
* Export characteristics and rule debt definitions to XML
*/
@ServerSide
public class DebtModelXMLExporter {
private static final String ROOT = "sqale";
private static final String DEFAULT_INDENT = "2";
public static final String CHARACTERISTIC = "chc";
public static final String PROPERTY = "prop";
public static final String PROPERTY_KEY = "key";
public static final String PROPERTY_VALUE = "val";
public static final String PROPERTY_TEXT_VALUE = "txt";
public static final String REPOSITORY_KEY = "rule-repo";
public static final String RULE_KEY = "rule-key";
public static final String PROPERTY_FUNCTION = "remediationFunction";
public static final String PROPERTY_COEFFICIENT = "remediationFactor";
public static final String PROPERTY_OFFSET = "offset";
protected String export(List allRules) {
StringBuilder sb = new StringBuilder();
sb.append("<" + ROOT + ">");
for (RuleDebt rule : allRules) {
processRule(rule, sb);
}
sb.append("");
String xml = sb.toString();
xml = prettyFormatXml(xml);
return xml;
}
private static void processRule(RuleDebt rule, StringBuilder xml) {
xml.append("<" + CHARACTERISTIC + ">");
xml.append("<" + REPOSITORY_KEY + ">");
xml.append(StringEscapeUtils.escapeXml(rule.ruleKey().repository()));
xml.append("<" + RULE_KEY + ">");
xml.append(StringEscapeUtils.escapeXml(rule.ruleKey().rule()));
xml.append("");
String coefficient = rule.coefficient();
String offset = rule.offset();
processProperty(PROPERTY_FUNCTION, null, rule.function(), xml);
if (coefficient != null) {
String[] values = getValues(coefficient);
processProperty(PROPERTY_COEFFICIENT, values[0], values[1], xml);
}
if (offset != null) {
String[] values = getValues(offset);
processProperty(PROPERTY_OFFSET, values[0], values[1], xml);
}
xml.append("");
}
private static String[] getValues(String factorOrOffset) {
String[] result = new String[2];
Pattern pattern = Pattern.compile("(\\d+)(\\w+)");
Matcher matcher = pattern.matcher(factorOrOffset);
if (matcher.find()) {
String value = matcher.group(1);
String unit = matcher.group(2);
result[0] = value;
result[1] = unit;
}
return result;
}
private static void processProperty(String key, @Nullable String val, String text, StringBuilder xml) {
xml.append("<" + PROPERTY + "><" + PROPERTY_KEY + ">");
xml.append(StringEscapeUtils.escapeXml(key));
xml.append("");
if (val != null) {
xml.append("<" + PROPERTY_VALUE + ">");
xml.append(val);
xml.append("");
}
if (StringUtils.isNotEmpty(text)) {
xml.append("<" + PROPERTY_TEXT_VALUE + ">");
xml.append(StringEscapeUtils.escapeXml(text));
xml.append("");
}
xml.append("");
}
private static String prettyFormatXml(String xml) {
try {
Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
serializer.setOutputProperty(OutputKeys.INDENT, "yes");
serializer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", DEFAULT_INDENT);
Source xmlSource = new SAXSource(new InputSource(new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8))));
StreamResult res = new StreamResult(new ByteArrayOutputStream());
serializer.transform(xmlSource, res);
return new String(((ByteArrayOutputStream) res.getOutputStream()).toByteArray(), StandardCharsets.UTF_8);
} catch (TransformerException ignored) {
// Ignore, raw XML will be returned
}
return xml;
}
public static class RuleDebt {
private RuleKey ruleKey;
private String function;
private String coefficient;
private String offset;
public RuleKey ruleKey() {
return ruleKey;
}
public RuleDebt setRuleKey(RuleKey ruleKey) {
this.ruleKey = ruleKey;
return this;
}
public String function() {
return function;
}
public RuleDebt setFunction(String function) {
this.function = function;
return this;
}
@CheckForNull
public String coefficient() {
return coefficient;
}
public RuleDebt setCoefficient(@Nullable String coefficient) {
this.coefficient = coefficient;
return this;
}
@CheckForNull
public String offset() {
return offset;
}
public RuleDebt setOffset(@Nullable String offset) {
this.offset = offset;
return this;
}
@Override
public String toString() {
return "RuleDebt{" +
"ruleKey=" + ruleKey +
", function=" + function +
", coefficient='" + coefficient + '\'' +
", offset='" + offset + '\'' +
'}';
}
}
}
