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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* 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.api.config;
import org.junit.Test;
import org.sonar.api.Properties;
import org.sonar.api.Property;
import org.sonar.api.resources.Qualifiers;
import java.util.Arrays;
import java.util.List;
import static org.fest.assertions.Assertions.assertThat;
public class PropertyDefinitionsTest {
@Test
public void should_build_with_predefined_list_of_definitions() {
List<PropertyDefinition> list = Arrays.asList(
PropertyDefinition.builder("foo").name("Foo").build(),
PropertyDefinition.builder("one").name("One").build(),
PropertyDefinition.builder("two").name("Two").defaultValue("2").build()
);
PropertyDefinitions def = new PropertyDefinitions(list);
assertProperties(def);
}
@Test
public void should_inspect_plugin_objects() {
PropertyDefinitions def = new PropertyDefinitions(
PropertyDefinition.builder("foo").name("Foo").build(),
PropertyDefinition.builder("one").name("One").build(),
PropertyDefinition.builder("two").name("Two").defaultValue("2").build()
);
assertProperties(def);
}
@Test
public void should_inspect_annotation_plugin_objects() {
PropertyDefinitions def = new PropertyDefinitions(new PluginWithProperty(), new PluginWithProperties());
assertProperties(def);
}
@Test
public void should_inspect_plugin_classes() {
PropertyDefinitions def = new PropertyDefinitions(PluginWithProperty.class, PluginWithProperties.class);
assertProperties(def);
}
@Test
public void test_categories() {
PropertyDefinitions def = new PropertyDefinitions(
PropertyDefinition.builder("inCateg").name("In Categ").category("categ").build(),
PropertyDefinition.builder("noCateg").name("No categ").build()
);
assertThat(def.getCategory("inCateg")).isEqualTo("categ");
assertThat(def.getCategory("noCateg")).isEmpty();
}
@Test
public void test_categories_on_annotation_plugin() {
PropertyDefinitions def = new PropertyDefinitions(Categories.class);
assertThat(def.getCategory("inCateg")).isEqualTo("categ");
assertThat(def.getCategory("noCateg")).isEqualTo("");
}
@Test
public void test_default_category() {
PropertyDefinitions def = new PropertyDefinitions();
def.addComponent(PropertyDefinition.builder("inCateg").name("In Categ").category("categ").build(), "default");
def.addComponent(PropertyDefinition.builder("noCateg").name("No categ").build(), "default");
assertThat(def.getCategory("inCateg")).isEqualTo("categ");
assertThat(def.getCategory("noCateg")).isEqualTo("default");
}
@Test
public void test_default_category_on_annotation_plugin() {
PropertyDefinitions def = new PropertyDefinitions();
def.addComponent(Categories.class, "default");
assertThat(def.getCategory("inCateg")).isEqualTo("categ");
assertThat(def.getCategory("noCateg")).isEqualTo("default");
}
@Test
public void should_return_special_categories() {
PropertyDefinitions def = new PropertyDefinitions();
assertThat(def.propertiesByCategory(null).get(new Category("general")).keySet()).containsOnly(new SubCategory("email"));
assertThat(def.propertiesByCategory(null).get(new Category("general")).keySet().iterator().next().isSpecial()).isTrue();
assertThat(def.propertiesByCategory(null).get(new Category("security")).keySet()).containsOnly(new SubCategory("encryption"));
assertThat(def.propertiesByCategory(null).get(new Category("security")).keySet().iterator().next().isSpecial()).isTrue();
assertThat(def.propertiesByCategory(null).get(new Category("licenses")).keySet()).containsOnly(new SubCategory("server_id"));
assertThat(def.propertiesByCategory(null).get(new Category("licenses")).keySet().iterator().next().isSpecial()).isTrue();
}
@Test
public void should_group_by_category() {
PropertyDefinitions def = new PropertyDefinitions(
PropertyDefinition.builder("global1").name("Global1").category("catGlobal1").build(),
PropertyDefinition.builder("global2").name("Global2").category("catGlobal1").build(),
PropertyDefinition.builder("global3").name("Global3").category("catGlobal2").build(),
PropertyDefinition.builder("project").name("Project").category("catProject").onlyOnQualifiers(Qualifiers.PROJECT).build(),
PropertyDefinition.builder("module").name("Module").category("catModule").onlyOnQualifiers(Qualifiers.MODULE).build(),
PropertyDefinition.builder("view").name("View").category("catView").onlyOnQualifiers(Qualifiers.VIEW).build()
);
assertThat(def.propertiesByCategory(null).keySet()).contains(new Category("catGlobal1"), new Category("catGlobal2"));
assertThat(def.propertiesByCategory(Qualifiers.PROJECT).keySet()).containsOnly(new Category("catProject"));
assertThat(def.propertiesByCategory(Qualifiers.MODULE).keySet()).containsOnly(new Category("catModule"));
assertThat(def.propertiesByCategory(Qualifiers.VIEW).keySet()).containsOnly(new Category("catView"));
assertThat(def.propertiesByCategory("Unkown").keySet()).isEmpty();
}
@Test
public void should_group_by_subcategory() {
PropertyDefinitions def = new PropertyDefinitions(
PropertyDefinition.builder("global1").name("Global1").category("catGlobal1").subCategory("sub1").build(),
PropertyDefinition.builder("global2").name("Global2").category("catGlobal1").subCategory("sub2").build(),
PropertyDefinition.builder("global3").name("Global3").category("catGlobal1").build(),
PropertyDefinition.builder("global4").name("Global4").category("catGlobal2").build()
);
assertThat(def.propertiesByCategory(null).get(new Category("catGlobal1")).keySet()).containsOnly(new SubCategory("catGlobal1"), new SubCategory("sub1"),
new SubCategory("sub2"));
assertThat(def.propertiesByCategory(null).get(new Category("catGlobal2")).keySet()).containsOnly(new SubCategory("catGlobal2"));
}
@Test
public void should_group_by_category_on_annotation_plugin() {
PropertyDefinitions def = new PropertyDefinitions(ByCategory.class);
assertThat(def.propertiesByCategory(null).keySet()).contains(new Category("catglobal1"), new Category("catglobal2"));
assertThat(def.propertiesByCategory(Qualifiers.PROJECT).keySet()).containsOnly(new Category("catproject"));
assertThat(def.propertiesByCategory(Qualifiers.MODULE).keySet()).containsOnly(new Category("catmodule"));
}
private void assertProperties(PropertyDefinitions definitions) {
assertThat(definitions.get("foo").name()).isEqualTo("Foo");
assertThat(definitions.get("one").name()).isEqualTo("One");
assertThat(definitions.get("two").name()).isEqualTo("Two");
assertThat(definitions.get("unknown")).isNull();
assertThat(definitions.getDefaultValue("foo")).isNull();
assertThat(definitions.getDefaultValue("two")).isEqualTo("2");
assertThat(definitions.getAll().size()).isEqualTo(3);
}
@Property(key = "foo", name = "Foo")
static final class PluginWithProperty {
}
@Properties({
@Property(key = "one", name = "One"),
@Property(key = "two", name = "Two", defaultValue = "2")
})
static final class PluginWithProperties {
}
@Properties({
@Property(key = "inCateg", name = "In Categ", category = "categ"),
@Property(key = "noCateg", name = "No categ")
})
static final class Categories {
}
@Properties({
@Property(key = "global1", name = "Global1", category = "catGlobal1", global = true, project = false, module = false),
@Property(key = "global2", name = "Global2", category = "catGlobal1", global = true, project = false, module = false),
@Property(key = "global3", name = "Global3", category = "catGlobal2", global = true, project = false, module = false),
@Property(key = "project", name = "Project", category = "catProject", global = false, project = true, module = false),
@Property(key = "module", name = "Module", category = "catModule", global = false, project = false, module = true)
})
static final class ByCategory {
}
}
|
