org.cleartk.test.util.LicenseTestUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cleartk-test-util Show documentation
ClearTK testing infrastructure
The newest version!
/* 
 * Copyright (c) 2007-2011, Regents of the University of Colorado 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
 * Neither the name of the University of Colorado at Boulder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE. 
 */

package org.cleartk.test.util;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.io.filefilter.IOFileFilter;
import org.apache.commons.io.filefilter.SuffixFileFilter;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.apache.uima.util.FileUtils;
import org.junit.Assert;

/**
 * 

 * Copyright (c) 2007-2011, Regents of the University of Colorado 

 * All rights reserved.
 */

public class LicenseTestUtil {

  public static void testDescriptorFiles(String directoryName) throws IOException {
    List filesMissingLicense = new ArrayList();

    File directory = new File(directoryName);
    Iterator files = org.apache.commons.io.FileUtils.iterateFiles(
        directory,
        new SuffixFileFilter(".xml"),
        TrueFileFilter.INSTANCE);

    while (files.hasNext()) {
      File file = (File) files.next();
      String fileText = FileUtils.file2String(file);

      if (fileText.indexOf("Copyright (c) ") == -1
          || fileText.indexOf("THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"") == -1) {

        if (file.getName().equals("GENIAcorpus3.02.articleA.pos.xml"))
          continue;
        if (file.getParent().equals("src/org/cleartk/descriptor".replace('/', File.separatorChar)))
          continue;
        filesMissingLicense.add(file.getPath());
      }
    }

    if (filesMissingLicense.size() > 0) {
      String message = String.format(
          "%d descriptor files with no license. ",
          filesMissingLicense.size());
      System.err.println(message);
      Collections.sort(filesMissingLicense);
      for (String path : filesMissingLicense) {
        System.err.println(path);
      }
      Assert.fail(message);
    }
  }

  public static void testJavaFiles(String directoryName) throws IOException {
    testFiles(directoryName, new SuffixFileFilter(".java"));
  }

  public static void testJavaFiles(
      String directoryName,
      List excludePackageNames,
      List excludeJavaFiles) throws IOException {
    testFiles(directoryName, new SuffixFileFilter(".java"), excludePackageNames, excludeJavaFiles);
  }

  public static void testFiles(String directoryName, IOFileFilter fileFilter) throws IOException {
    List excludePackageNames = Collections.emptyList();
    List excludeFiles = Collections.emptyList();
    testFiles(directoryName, fileFilter, excludePackageNames, excludeFiles);
  }

  public static void testFiles(
      String directoryName,
      IOFileFilter fileFilter,
      List excludePackageNames,
      List excludeFiles) throws IOException {

    List filesMissingLicense = new ArrayList();
    File directory = new File(directoryName);
    Iterator files = org.apache.commons.io.FileUtils.iterateFiles(
        directory,
        fileFilter,
        TrueFileFilter.INSTANCE);

    while (files.hasNext()) {
      File file = (File) files.next();
      String fileText = FileUtils.file2String(file);

      if (excludePackage(file, excludePackageNames)) {
        continue;
      }
      if (excludeFile(file, excludeFiles)) {
        continue;
      }

      if (fileText.indexOf("Copyright (c) ") == -1
          || fileText.indexOf("THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"") == -1) {
        filesMissingLicense.add(file.getPath());
      } else {
        if (fileText.indexOf("Copyright (c) ", 300) == -1)
          filesMissingLicense.add(file.getPath());
      }

    }

    if (filesMissingLicense.size() > 0) {
      String message = String.format(
          "%d source files with no license. ",
          filesMissingLicense.size());
      System.err.println(message);
      Collections.sort(filesMissingLicense);
      for (String path : filesMissingLicense) {
        System.err.println(path);
      }
      Assert.fail(message);
    }

  }

  private static boolean excludeFile(File file, List excludeFiles) {
    String fileName = file.getName();
    return excludeFiles.contains(fileName);
  }

  private static boolean excludePackage(File file, List excludePackageNames) {
    File parent = file.getParentFile();
    while (parent != null) {
      String parentName = parent.getName();
      if (excludePackageNames.contains(parentName)) {
        return true;
      }
      parent = parent.getParentFile();
    }
    return false;
  }

  public static void testJavaFilesGPL(String directoryName) throws IOException {
    testFilesGPL(directoryName, new SuffixFileFilter(".java"));
  }

  public static void testJavaFilesGPL(
      String directoryName,
      List excludePackageNames,
      List excludeFiles) throws IOException {
    testFilesGPL(directoryName, new SuffixFileFilter(".java"), excludePackageNames, excludeFiles);
  }

  public static void testFilesGPL(String directoryName, IOFileFilter fileFilter) throws IOException {
    List excludePackageNames = Collections.emptyList();
    List excludeFiles = Collections.emptyList();
    testFilesGPL(directoryName, fileFilter, excludePackageNames, excludeFiles);
  }

  public static void testFilesGPL(
      String directoryName,
      IOFileFilter fileFilter,
      List excludePackageNames,
      List excludeFiles) throws IOException {

    List filesMissingLicense = new ArrayList();
    File directory = new File(directoryName);
    Iterator files = org.apache.commons.io.FileUtils.iterateFiles(
        directory,
        fileFilter,
        TrueFileFilter.INSTANCE);

    while (files.hasNext()) {
      File file = (File) files.next();
      String fileText = FileUtils.file2String(file);

      if (excludePackage(file, excludePackageNames)) {
        continue;
      }
      if (excludeFile(file, excludeFiles)) {
        continue;
      }

      if (fileText.indexOf("Copyright (c) ") == -1
          || fileText.indexOf("GNU General Public License") == -1) {
        filesMissingLicense.add(file.getPath());
      } else {
        if (fileText.indexOf("Copyright (c) ", 300) == -1)
          filesMissingLicense.add(file.getPath());
      }

    }

    if (filesMissingLicense.size() > 0) {
      String message = String.format(
          "%d source files with no license. ",
          filesMissingLicense.size());
      System.err.println(message);
      Collections.sort(filesMissingLicense);
      for (String path : filesMissingLicense) {
        System.err.println(path);
      }
      Assert.fail(message);
    }

  }

}