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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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.batch.bootstrap;
import com.google.common.base.Joiner;
import com.google.common.base.Predicate;
import com.google.common.base.Splitter;
import com.google.common.collect.Lists;
import java.text.MessageFormat;
import java.util.List;
import java.util.Set;
import javax.annotation.Nonnull;
import org.apache.commons.lang.StringUtils;
import org.sonar.api.CoreProperties;
import org.sonar.api.batch.BatchSide;
import org.sonar.api.config.Settings;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import static com.google.common.collect.Sets.newHashSet;
/**
* Filters the plugins to be enabled during analysis
*/
@BatchSide
public class BatchPluginPredicate implements Predicate<String> {
private static final Logger LOG = Loggers.get(BatchPluginPredicate.class);
private static final String BUILDBREAKER_PLUGIN_KEY = "buildbreaker";
private static final String PROPERTY_IS_DEPRECATED_MSG = "Property {0} is deprecated. Please use {1} instead.";
private static final Joiner COMMA_JOINER = Joiner.on(", ");
private final Set<String> whites = newHashSet(), blacks = newHashSet();
private final DefaultAnalysisMode mode;
public BatchPluginPredicate(Settings settings, DefaultAnalysisMode mode) {
this.mode = mode;
if (mode.isPreview()) {
// These default values are not supported by Settings because the class CorePlugin
// is not loaded yet.
if (settings.hasKey(CoreProperties.DRY_RUN_INCLUDE_PLUGINS)) {
LOG.warn(MessageFormat.format(PROPERTY_IS_DEPRECATED_MSG, CoreProperties.DRY_RUN_INCLUDE_PLUGINS, CoreProperties.PREVIEW_INCLUDE_PLUGINS));
whites.addAll(propertyValues(settings,
CoreProperties.DRY_RUN_INCLUDE_PLUGINS, CoreProperties.PREVIEW_INCLUDE_PLUGINS_DEFAULT_VALUE));
} else {
whites.addAll(propertyValues(settings,
CoreProperties.PREVIEW_INCLUDE_PLUGINS, CoreProperties.PREVIEW_INCLUDE_PLUGINS_DEFAULT_VALUE));
}
if (settings.hasKey(CoreProperties.DRY_RUN_EXCLUDE_PLUGINS)) {
LOG.warn(MessageFormat.format(PROPERTY_IS_DEPRECATED_MSG, CoreProperties.DRY_RUN_EXCLUDE_PLUGINS, CoreProperties.PREVIEW_EXCLUDE_PLUGINS));
blacks.addAll(propertyValues(settings,
CoreProperties.DRY_RUN_EXCLUDE_PLUGINS, CoreProperties.PREVIEW_EXCLUDE_PLUGINS_DEFAULT_VALUE));
} else {
blacks.addAll(propertyValues(settings,
CoreProperties.PREVIEW_EXCLUDE_PLUGINS, CoreProperties.PREVIEW_EXCLUDE_PLUGINS_DEFAULT_VALUE));
}
}
if (!whites.isEmpty()) {
LOG.info("Include plugins: " + COMMA_JOINER.join(whites));
}
if (!blacks.isEmpty()) {
LOG.info("Exclude plugins: " + COMMA_JOINER.join(blacks));
}
}
@Override
public boolean apply(@Nonnull String pluginKey) {
if (BUILDBREAKER_PLUGIN_KEY.equals(pluginKey) && mode.isPreview()) {
LOG.info("Build Breaker plugin is no more supported in preview/incremental mode");
return false;
}
if (whites.isEmpty()) {
return blacks.isEmpty() || !blacks.contains(pluginKey);
}
return whites.contains(pluginKey);
}
Set<String> getWhites() {
return whites;
}
Set<String> getBlacks() {
return blacks;
}
private static List<String> propertyValues(Settings settings, String key, String defaultValue) {
String s = StringUtils.defaultIfEmpty(settings.getString(key), defaultValue);
return Lists.newArrayList(Splitter.on(",").trimResults().omitEmptyStrings().split(s));
}
}
|
