View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.checkstyle.exec;
20  
21  import java.io.File;
22  import java.util.HashMap;
23  import java.util.Map;
24  
25  import com.puppycrawl.tools.checkstyle.api.AuditEvent;
26  import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
27  import com.puppycrawl.tools.checkstyle.api.Violation;
28  import junit.framework.TestCase;
29  
30  public class CheckstyleReportListenerMultiSourceTest extends TestCase {
31      private Map<SeverityLevel, CheckstyleCheckerListener> listenerMap;
32  
33      /**
34       * {@inheritDoc}
35       */
36      protected void setUp() throws Exception {
37          listenerMap = new HashMap<>();
38  
39          CheckstyleCheckerListener listener = new CheckstyleCheckerListener(new File("/source/path"));
40          listener.addSourceDirectory(new File("/source/path2"));
41          listener.setSeverityLevelFilter(SeverityLevel.INFO);
42          listenerMap.put(listener.getSeverityLevelFilter(), listener);
43  
44          listener = new CheckstyleCheckerListener(new File("/source/path"));
45          listener.addSourceDirectory(new File("/source/path2"));
46          listener.setSeverityLevelFilter(SeverityLevel.WARNING);
47          listenerMap.put(listener.getSeverityLevelFilter(), listener);
48  
49          listener = new CheckstyleCheckerListener(new File("/source/path"));
50          listener.addSourceDirectory(new File("/source/path2"));
51          listener.setSeverityLevelFilter(SeverityLevel.ERROR);
52          listenerMap.put(listener.getSeverityLevelFilter(), listener);
53  
54          listener = new CheckstyleCheckerListener(new File("/source/path"));
55          listener.addSourceDirectory(new File("/source/path2"));
56          listener.setSeverityLevelFilter(SeverityLevel.IGNORE);
57          listenerMap.put(listener.getSeverityLevelFilter(), listener);
58      }
59  
60      public void testListeners() {
61          fireAuditStarted(null);
62  
63          AuditEvent event = new AuditEvent(this, "/source/path/file1", null);
64          fireFileStarted(event);
65          Violation message = new Violation(0, 0, "", "", null, SeverityLevel.INFO, null, getClass(), null);
66          fireAddError(new AuditEvent(this, "/source/path/file1", message));
67          fireFileFinished(event);
68  
69          event = new AuditEvent(this, "/source/path2/file2", null);
70          fireFileStarted(event);
71          message = new Violation(0, 0, "", "", null, SeverityLevel.WARNING, null, getClass(), null);
72          fireAddError(new AuditEvent(this, "/source/path2/file2", message));
73          fireAddError(new AuditEvent(this, "/source/path2/file2", message));
74          fireFileFinished(event);
75  
76          event = new AuditEvent(this, "/source/path/file3", null);
77          fireFileStarted(event);
78          message = new Violation(0, 0, "", "", null, SeverityLevel.ERROR, null, getClass(), null);
79          fireAddError(new AuditEvent(this, "/source/path/file3", message));
80          fireAddError(new AuditEvent(this, "/source/path/file3", message));
81          fireAddError(new AuditEvent(this, "/source/path/file3", message));
82          fireFileFinished(event);
83  
84          event = new AuditEvent(this, "/source/path2/file4", null);
85          fireFileStarted(event);
86          message = new Violation(0, 0, "", "", null, SeverityLevel.IGNORE, null, getClass(), null);
87          fireAddError(new AuditEvent(this, "/source/path2/file4", message));
88          fireAddError(new AuditEvent(this, "/source/path2/file4", message));
89          fireAddError(new AuditEvent(this, "/source/path2/file4", message));
90          fireAddError(new AuditEvent(this, "/source/path2/file4", message));
91          fireFileFinished(event);
92  
93          fireAuditFinished(null);
94  
95          CheckstyleCheckerListener listener = listenerMap.get(SeverityLevel.INFO);
96          CheckstyleResults results = listener.getResults();
97          assertEquals("Test total files", 4, results.getFiles().size());
98          assertEquals("Test file count", 4, results.getFileCount());
99          assertEquals(
100                 "test file violations", 1, results.getFileViolations("file1").size());
101         assertEquals("test file severities", 1, results.getSeverityCount("file1", SeverityLevel.INFO));
102         assertEquals("test file severities", 0, results.getSeverityCount("file1", SeverityLevel.WARNING));
103         assertEquals("test file severities", 0, results.getSeverityCount("file1", SeverityLevel.ERROR));
104         assertEquals("test file severities", 0, results.getSeverityCount("file1", SeverityLevel.IGNORE));
105 
106         listener = listenerMap.get(SeverityLevel.WARNING);
107         results = listener.getResults();
108         assertEquals("Test total files", 4, results.getFiles().size());
109         assertEquals("Test file count", 4, results.getFileCount());
110         assertEquals(
111                 "test file violations", 2, results.getFileViolations("file2").size());
112         assertEquals("test file severities", 0, results.getSeverityCount("file2", SeverityLevel.INFO));
113         assertEquals("test file severities", 2, results.getSeverityCount("file2", SeverityLevel.WARNING));
114         assertEquals("test file severities", 0, results.getSeverityCount("file2", SeverityLevel.ERROR));
115         assertEquals("test file severities", 0, results.getSeverityCount("file2", SeverityLevel.IGNORE));
116 
117         listener = listenerMap.get(SeverityLevel.ERROR);
118         results = listener.getResults();
119         assertEquals("Test total files", 4, results.getFiles().size());
120         assertEquals("Test file count", 4, results.getFileCount());
121         assertEquals(
122                 "test file violations", 3, results.getFileViolations("file3").size());
123         assertEquals("test file severities", 0, results.getSeverityCount("file3", SeverityLevel.INFO));
124         assertEquals("test file severities", 0, results.getSeverityCount("file3", SeverityLevel.WARNING));
125         assertEquals("test file severities", 3, results.getSeverityCount("file3", SeverityLevel.ERROR));
126         assertEquals("test file severities", 0, results.getSeverityCount("file3", SeverityLevel.IGNORE));
127 
128         listener = listenerMap.get(SeverityLevel.IGNORE);
129         results = listener.getResults();
130         assertEquals("Test total files", 4, results.getFiles().size());
131         assertEquals("Test file count", 4, results.getFileCount());
132         assertEquals(
133                 "test file violations", 0, results.getFileViolations("file4").size());
134         assertEquals("test file severities", 0, results.getSeverityCount("file4", SeverityLevel.INFO));
135         assertEquals("test file severities", 0, results.getSeverityCount("file4", SeverityLevel.WARNING));
136         assertEquals("test file severities", 0, results.getSeverityCount("file4", SeverityLevel.ERROR));
137         assertEquals("test file severities", 0, results.getSeverityCount("file4", SeverityLevel.IGNORE));
138     }
139 
140     private void fireAuditStarted(AuditEvent event) {
141         for (CheckstyleCheckerListener listener : listenerMap.values()) {
142             listener.auditStarted(event);
143         }
144     }
145 
146     private void fireAuditFinished(AuditEvent event) {
147         for (CheckstyleCheckerListener listener : listenerMap.values()) {
148             listener.auditFinished(event);
149         }
150     }
151 
152     private void fireFileStarted(AuditEvent event) {
153         for (CheckstyleCheckerListener listener : listenerMap.values()) {
154             listener.fileStarted(event);
155         }
156     }
157 
158     private void fireFileFinished(AuditEvent event) {
159         for (CheckstyleCheckerListener listener : listenerMap.values()) {
160             listener.fileFinished(event);
161         }
162     }
163 
164     private void fireAddError(AuditEvent event) {
165         for (CheckstyleCheckerListener listener : listenerMap.values()) {
166             listener.addError(event);
167         }
168     }
169 }