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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
* 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 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.profiles.RulesProfile;
import org.sonar.api.rules.ActiveRule;
import org.sonar.api.rules.Rule;
import org.sonar.api.utils.SonarException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
/**
* This wrapper is used to try to preserve backward compatibility for plugins that used to
* depends on {@link org.sonar.api.profiles.RulesProfile}
*
* @since 4.2
*/
public class RulesProfileWrapper extends RulesProfile {
private static final Logger LOG = LoggerFactory.getLogger(RulesProfileWrapper.class);
private static final String DEPRECATED_USAGE_MESSAGE = "Please update your plugin to support multi-language analysis";
private final Collection<RulesProfile> profiles;
private final RulesProfile singleLanguageProfile;
public RulesProfileWrapper(Collection<RulesProfile> profiles) {
this.profiles = profiles;
this.singleLanguageProfile = null;
}
public RulesProfileWrapper(RulesProfile profile) {
this.profiles = Collections.singletonList(profile);
this.singleLanguageProfile = profile;
}
@Override
public Integer getId() {
return getSingleProfileOrFail().getId();
}
private RulesProfile getSingleProfileOrFail() {
if (singleLanguageProfile == null) {
throw new IllegalStateException(DEPRECATED_USAGE_MESSAGE);
}
return singleLanguageProfile;
}
@Override
public String getName() {
return singleLanguageProfile != null ? singleLanguageProfile.getName() : "SonarQube";
}
@Override
public String getLanguage() {
if (singleLanguageProfile == null) {
// Multi-languages module
// This is a hack for CommonChecksDecorator that call this method in its constructor
LOG.debug(DEPRECATED_USAGE_MESSAGE, new SonarException(DEPRECATED_USAGE_MESSAGE));
return "";
}
return singleLanguageProfile.getLanguage();
}
@Override
public List<ActiveRule> getActiveRules() {
List<ActiveRule> activeRules = new ArrayList<>();
for (RulesProfile profile : profiles) {
activeRules.addAll(profile.getActiveRules());
}
return activeRules;
}
@Override
public ActiveRule getActiveRule(String repositoryKey, String ruleKey) {
for (RulesProfile profile : profiles) {
ActiveRule activeRule = profile.getActiveRule(repositoryKey, ruleKey);
if (activeRule != null) {
return activeRule;
}
}
return null;
}
@Override
public List<ActiveRule> getActiveRulesByRepository(String repositoryKey) {
List<ActiveRule> activeRules = new ArrayList<>();
for (RulesProfile profile : profiles) {
activeRules.addAll(profile.getActiveRulesByRepository(repositoryKey));
}
return activeRules;
}
@Override
public List<ActiveRule> getActiveRules(boolean acceptDisabledRules) {
List<ActiveRule> activeRules = new ArrayList<>();
for (RulesProfile profile : profiles) {
activeRules.addAll(profile.getActiveRules(acceptDisabledRules));
}
return activeRules;
}
@Override
public ActiveRule getActiveRule(Rule rule) {
for (RulesProfile profile : profiles) {
ActiveRule activeRule = profile.getActiveRule(rule);
if (activeRule != null) {
return activeRule;
}
}
return null;
}
@Override
public Boolean getDefaultProfile() {
return getSingleProfileOrFail().getDefaultProfile();
}
}
|
