View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   * 
17   */
18  
19  package org.apache.rat.analysis.license;
20  
21  import static org.junit.jupiter.api.Assertions.assertEquals;
22  import static org.junit.jupiter.api.Assertions.fail;
23  
24  import java.io.BufferedReader;
25  import java.io.File;
26  
27  import org.apache.rat.analysis.HeaderCheckWorker;
28  import org.apache.rat.analysis.IHeaders;
29  import org.apache.rat.license.ILicense;
30  import org.apache.rat.test.utils.Resources;
31  
32  class DirectoryScanner {
33  
34      @SuppressWarnings("boxing") // OK in test code
35      /**
36       * Get list of files in a directory, and scan for license matches
37       * 
38       * @param directory the directory containing the files
39       * @param matcher the license matcher
40       * @param expected the expected result of the each scan
41       * @throws Exception
42       */
43      public static void testFilesInDir(String directory, ILicense license, boolean expected) throws Exception {
44          final File[] resourceFiles = Resources.getResourceFiles(directory);
45          if (resourceFiles.length == 0) {
46              fail("No files found under " + directory);
47          }
48          for (File f : resourceFiles) {
49              try (BufferedReader br = Resources.getBufferedReader(f)) {
50                  IHeaders headers = HeaderCheckWorker.readHeader(br,
51                          HeaderCheckWorker.DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES);
52                  boolean result = license.matches(headers);
53                  assertEquals(expected, result, f.toString());
54              } finally {
55                  license.reset();
56              }
57          }
58      }
59  }