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
|
////////////////////////////////////////////////////////////////////////////////
// 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.api;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.File;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.SortedSet;
import org.junit.Assert;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class AbstractFileSetCheckTest {
@Test
public void testProcessSequential() throws Exception {
final DummyFileSetCheck check = new DummyFileSetCheck();
check.configure(new DefaultConfiguration("filesetcheck"));
check.setFileExtensions("tmp");
final File firstFile = new File("inputAbstractFileSetCheck.tmp");
final SortedSet<LocalizedMessage> firstFileMessages =
check.process(firstFile, new FileText(firstFile, Collections.emptyList()));
assertEquals("Invalid message", "File should not be empty.",
firstFileMessages.first().getMessage());
final Field field = AbstractFileSetCheck.class.getDeclaredField("MESSAGE_COLLECTOR");
field.setAccessible(true);
@SuppressWarnings("unchecked")
final SortedSet<LocalizedMessage> internalMessages =
((ThreadLocal<SortedSet<LocalizedMessage>>) field.get(null)).get();
assertTrue("Internal message should be empty, but was not", internalMessages.isEmpty());
final File secondFile = new File("inputAbstractFileSetCheck.txt");
final List<String> lines = Arrays.asList("key=value", "ext=tmp");
final SortedSet<LocalizedMessage> secondFileMessages =
check.process(secondFile, new FileText(secondFile, lines));
assertTrue("Message should be empty, but was not", secondFileMessages.isEmpty());
}
@Test
public void testProcessException() throws Exception {
final ExceptionFileSetCheck check = new ExceptionFileSetCheck();
check.configure(new DefaultConfiguration("filesetcheck"));
check.setFileExtensions("tmp");
final File firstFile = new File("inputAbstractFileSetCheck.tmp");
try {
check.process(firstFile, new FileText(firstFile, Collections.emptyList()));
fail("Exception is expected");
}
catch (IllegalArgumentException ex) {
// exception is expected
}
final Field field = AbstractFileSetCheck.class.getDeclaredField("MESSAGE_COLLECTOR");
field.setAccessible(true);
@SuppressWarnings("unchecked")
final SortedSet<LocalizedMessage> internalMessages =
((ThreadLocal<SortedSet<LocalizedMessage>>) field.get(null)).get();
assertEquals("Internal message should only have 1", 1, internalMessages.size());
// again to prove only 1 violation exists
final File secondFile = new File("inputAbstractFileSetCheck.tmp");
try {
check.process(secondFile, new FileText(secondFile, Collections.emptyList()));
fail("Exception is expected");
}
catch (IllegalArgumentException ex) {
// exception is expected
}
@SuppressWarnings("unchecked")
final SortedSet<LocalizedMessage> internalMessages2 =
((ThreadLocal<SortedSet<LocalizedMessage>>) field.get(null)).get();
assertEquals("Internal message should only have 1 again", 1, internalMessages2.size());
}
@Test
public void testGetFileExtention() {
final DummyFileSetCheck check = new DummyFileSetCheck();
check.setFileExtensions("tmp", ".java");
final String[] expectedExtentions = {".tmp", ".java"};
Assert.assertArrayEquals("Invalid extensions",
expectedExtentions, check.getFileExtensions());
}
/**
* This javadoc exists only to suppress Intellij Idea inspection
*/
@Test
public void testSetExtentionThrowsExceptionWhenTheyAreNull() {
final DummyFileSetCheck check = new DummyFileSetCheck();
try {
check.setFileExtensions((String[]) null);
fail("Expected exception.");
}
catch (IllegalArgumentException exception) {
assertEquals("Invalid exception message",
"Extensions array can not be null", exception.getMessage());
}
}
@Test
public void testGetMessageDispatcher() {
final DummyFileSetCheck check = new DummyFileSetCheck();
final Checker checker = new Checker();
check.setMessageDispatcher(checker);
assertEquals("Invalid message dispatcher", checker, check.getMessageDispatcher());
}
private static class DummyFileSetCheck extends AbstractFileSetCheck {
private static final String MSG_KEY = "File should not be empty.";
@Override
protected void processFiltered(File file, FileText fileText) throws CheckstyleException {
if (fileText.size() == 0) {
log(1, MSG_KEY);
}
}
}
private static class ExceptionFileSetCheck extends AbstractFileSetCheck {
private static final String MSG_KEY = "Test.";
private int count = 1;
@Override
protected void processFiltered(File file, FileText fileText) throws CheckstyleException {
log(count, MSG_KEY);
count++;
throw new IllegalArgumentException("Test");
}
}
}
|
