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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.filters;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertTrue;
import org.junit.Before;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.TreeWalkerTest;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import nl.jqno.equalsverifier.EqualsVerifier;
import nl.jqno.equalsverifier.Warning;
public class SuppressElementTest {
private SuppressElement filter;
@Before
public void setUp() {
filter = new SuppressElement("Test", "Test", null, null, null, null);
}
@Test
public void testDecideDefault() {
final AuditEvent ev = new AuditEvent(this, "Test.java");
assertTrue(ev.getFileName(), filter.accept(ev));
}
@Test
public void testDecideLocalizedMessage() {
final LocalizedMessage message =
new LocalizedMessage(0, 0, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
//deny because there are matches on file and check names
assertFalse("Names match", filter.accept(ev));
}
@Test
public void testDecideByMessage() {
final LocalizedMessage message =
new LocalizedMessage(0, 0, "", "", null, null, getClass(), "Test");
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement filter1 =
new SuppressElement(null, null, "Test", null, null, null);
final SuppressElement filter2 =
new SuppressElement(null, null, "Bad", null, null, null);
assertFalse("Message match", filter1.accept(ev));
assertTrue("Message not match", filter2.accept(ev));
}
@Test
public void testDecideByLine() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement filter1 =
new SuppressElement("Test", "Test", null, null, "1-10", null);
final SuppressElement filter2 =
new SuppressElement("Test", "Test", null, null, "1-9, 11", null);
final SuppressElement filter3 =
new SuppressElement("Test", "Test", null, null, null, null);
//deny because there are matches on file name, check name, and line
assertFalse("In range 1-10", filter1.accept(ev));
assertTrue("Not in 1-9, 11", filter2.accept(ev));
assertFalse("none", filter3.accept(ev));
}
@Test
public void testDecideByColumn() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement filter1 =
new SuppressElement("Test", "Test", null, null, null, "1-10");
final SuppressElement filter2 =
new SuppressElement("Test", "Test", null, null, null, "1-9, 11");
//deny because there are matches on file name, check name, and column
assertFalse("In range 1-10", filter1.accept(ev));
assertTrue("Not in 1-9, 1)", filter2.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingFileNameNull() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, null, message);
assertTrue("Filter should accept valid event", filter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingMessageNull() {
final AuditEvent ev = new AuditEvent(this, "ATest.java", null);
assertTrue("Filter should accept valid event", filter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingModuleNull() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, "MyModule", getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
assertFalse("Filter should not accept invalid event", filter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingModuleEqual() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, "MyModule", getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement myFilter =
new SuppressElement("Test", "Test", null, "MyModule", null, null);
assertFalse("Filter should not accept invalid event", myFilter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingModuleNotEqual() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, "TheirModule", getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement myFilter =
new SuppressElement("Test", "Test", null, "MyModule", null, null);
assertTrue("Filter should accept valid event", myFilter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingRegExpNotMatch() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "T1est", message);
assertTrue("Filter should accept valid event", filter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingRegExpMatch() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "TestSUFFIX", message);
final SuppressElement myFilter =
new SuppressElement("Test", null, null, null, null, null);
assertFalse("Filter should not accept invalid event", myFilter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingCheckRegExpNotMatch() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement myFilter =
new SuppressElement("Test", "NON_EXISTENT_CHECK", null, "MyModule", null, null);
assertTrue("Filter should accept valid event", myFilter.accept(ev));
}
@Test
public void testDecideByFileNameAndModuleMatchingCheckRegExpMatch() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement myFilter =
new SuppressElement("Test", getClass().getCanonicalName(), null, null, null, null);
assertFalse("Filter should not accept invalid event", myFilter.accept(ev));
}
@Test
public void testDecideByFileNameAndSourceNameCheckRegExpNotMatch() {
final LocalizedMessage message =
new LocalizedMessage(10, 10, "", "", null, null, getClass(), null);
final AuditEvent ev = new AuditEvent(this, "ATest.java", message);
final SuppressElement myFilter =
new SuppressElement("Test", TreeWalkerTest.class.getCanonicalName(),
null, null, null, null);
assertTrue("Filter should not accept invalid event", myFilter.accept(ev));
}
@Test
public void testEquals() {
// filterBased is used instead of filter field only to satisfy IntelliJ Idea Inspection
// Inspection "Arguments to assertEquals() in wrong order "
final SuppressElement filterBased =
new SuppressElement("Test", "Test", null, null, null, null);
final SuppressElement filter2 =
new SuppressElement("Test", "Test", null, null, null, null);
assertEquals("filter, filter2", filterBased, filter2);
final SuppressElement filter3 =
new SuppressElement("Test", "Test3", null, null, null, null);
assertNotEquals("filter, filter3", filterBased, filter3);
final SuppressElement filterBased1 =
new SuppressElement("Test", "Test", null, null, null, "1-10");
assertNotEquals("filter, filter2", filterBased1, filter2);
final SuppressElement filter22 =
new SuppressElement("Test", "Test", null, null, null, "1-10");
assertEquals("filter, filter2", filterBased1, filter22);
assertNotEquals("filter, filter2", filterBased1, filter2);
final SuppressElement filterBased2 =
new SuppressElement("Test", "Test", null, null, "3,4", null);
assertNotEquals("filter, filter2", filterBased2, filter2);
final SuppressElement filter23 =
new SuppressElement("Test", "Test", null, null, "3,4", null);
assertEquals("filter, filter2", filterBased2, filter23);
assertNotEquals("filter, filter2", filterBased2, filter2);
assertEquals("filter, filter2", filterBased2, filter23);
}
@Test
public void testEqualsAndHashCode() {
EqualsVerifier.forClass(SuppressElement.class)
.usingGetClass()
.withIgnoredFields("fileRegexp", "checkRegexp", "messageRegexp", "columnFilter",
"lineFilter")
.suppress(Warning.NONFINAL_FIELDS)
.verify();
}
}
|
