source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.issue.commonrule;
  21
  22 import java.util.Optional;
  23 import javax.annotation.CheckForNull;
  24 import org.sonar.api.rule.RuleKey;
  25 import org.sonar.ce.task.projectanalysis.component.Component;
  26 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRule;
  27 import org.sonar.ce.task.projectanalysis.qualityprofile.ActiveRulesHolder;
  28 import org.sonar.core.issue.DefaultIssue;
  29
  30 import static org.apache.commons.lang.StringUtils.isNotBlank;
  31 import static org.sonar.server.rule.CommonRuleKeys.commonRepositoryForLang;
  32
  33 public abstract class CommonRule {
  34
  35   private final ActiveRulesHolder activeRulesHolder;
  36   private final String key;
  37
  38   public CommonRule(ActiveRulesHolder activeRulesHolder, String key) {
  39     this.activeRulesHolder = activeRulesHolder;
  40     this.key = key;
  41   }
  42
  43   @CheckForNull
  44   public DefaultIssue processFile(Component file, String fileLanguage) {
  45     DefaultIssue issue = null;
  46     RuleKey ruleKey = RuleKey.of(commonRepositoryForLang(fileLanguage), key);
  47     Optional<ActiveRule> activeRule = activeRulesHolder.get(ruleKey);
  48     if (activeRule.isPresent()) {
  49       CommonRuleIssue cri = doProcessFile(file, activeRule.get());
  50       if (cri != null) {
  51         issue = new DefaultIssue();
  52         issue.setGap(cri.effortToFix);
  53         issue.setMessage(cri.message);
  54         issue.setRuleKey(ruleKey);
  55         issue.setSeverity(activeRule.get().getSeverity());
  56         issue.setLine(null);
  57         issue.setChecksum("");
  58         issue.setIsFromExternalRuleEngine(false);
  59       }
  60     }
  61     return issue;
  62   }
  63
  64   /**
  65    * Implementations must only set the effort to fix and message, so
  66    * using the lite intermediary object {@link CommonRuleIssue}
  67    */
  68   @CheckForNull
  69   protected abstract CommonRuleIssue doProcessFile(Component file, ActiveRule activeRule);
  70
  71   protected static class CommonRuleIssue {
  72     private final double effortToFix;
  73     // FIXME which format ? HTML or MD ?
  74     private final String message;
  75
  76     public CommonRuleIssue(double effortToFix, String message) {
  77       this.effortToFix = effortToFix;
  78       this.message = message;
  79     }
  80   }
  81
  82   protected static double getMinDensityParam(ActiveRule activeRule, String paramKey) {
  83     String s = activeRule.getParams().get(paramKey);
  84     if (isNotBlank(s)) {
  85       double d = Double.parseDouble(s);
  86       if (d < 0.0 || d > 100.0) {
  87         throw new IllegalStateException(String.format("Minimum density of rule [%s] is incorrect. Got [%s] but must be between 0 and 100.", activeRule.getRuleKey(), s));
  88       }
  89       return d;
  90     }
  91     throw new IllegalStateException(String.format("Required parameter [%s] is missing on rule [%s]", paramKey, activeRule.getRuleKey()));
  92   }
  93 }