aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-scanner-engine/src/main/java/org/sonar/scanner/externalissue/sarif/RuleMapper.java
blob: 172ab70f19da96fbf1cec4b2c3559a76b7b25578 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
 * SonarQube
 * Copyright (C) 2009-2025 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.externalissue.sarif;

import javax.annotation.Nullable;
import org.apache.commons.lang3.StringUtils;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.api.batch.sensor.rule.NewAdHocRule;
import org.sonar.api.scanner.ScannerSide;
import org.sonar.sarif.pojo.ReportingDescriptor;
import org.sonar.sarif.pojo.Result;

import static java.lang.String.join;

@ScannerSide
public class RuleMapper {

  private final SensorContext sensorContext;

  public RuleMapper(SensorContext sensorContext) {
    this.sensorContext = sensorContext;
  }

  NewAdHocRule mapRule(ReportingDescriptor rule, String driverName, @Nullable Result.Level ruleSeverity, @Nullable Result.Level ruleSeverityForNewTaxonomy) {

    NewAdHocRule newAdHocRule = sensorContext.newAdHocRule()
      .severity(ResultMapper.toSonarQubeSeverity(ruleSeverity))
      .type(ResultMapper.DEFAULT_TYPE)
      .ruleId(rule.getId())
      .engineId(driverName)
      .cleanCodeAttribute(ResultMapper.DEFAULT_CLEAN_CODE_ATTRIBUTE)
      .addDefaultImpact(ResultMapper.DEFAULT_SOFTWARE_QUALITY, ResultMapper.toSonarQubeImpactSeverity(ruleSeverityForNewTaxonomy));

    if (rule.getShortDescription() != null && !StringUtils.isBlank(rule.getShortDescription().getText())) {
      newAdHocRule.name(rule.getShortDescription().getText());
    } else {
      newAdHocRule.name(join(":", driverName, rule.getId()));
    }

    if (rule.getFullDescription() != null && !StringUtils.isBlank(rule.getFullDescription().getText())) {
      newAdHocRule.description(rule.getFullDescription().getText());
    }

    return newAdHocRule;
  }
}