RegexURLFilterBaseTest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nutch.urlfilter.api;

// JDK imports
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;

// JUnit imports
import junit.framework.TestCase;

// Commons Logging imports
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

// Nutch imports
import org.apache.nutch.net.URLFilter;


/**
 * JUnit based test of class <code>RegexURLFilterBase</code>.
 *
 * @author Jérôme Charron
 */
public abstract class RegexURLFilterBaseTest extends TestCase {
  
  /** My logger */
  protected static final Log LOG = LogFactory.getLog(RegexURLFilterBaseTest.class);  

  private final static String SEPARATOR = System.getProperty("file.separator");  
  private final static String SAMPLES = System.getProperty("test.data", ".");
  
  public RegexURLFilterBaseTest(String testName) {
    super(testName);
  }
  
  protected abstract URLFilter getURLFilter(Reader rules);

  protected void bench(int loops, String file) {
    try {
      bench(loops,
            new FileReader(SAMPLES + SEPARATOR + file + ".rules"),
            new FileReader(SAMPLES + SEPARATOR + file + ".urls"));
    } catch (Exception e) {
      fail(e.toString());
    }
  }
  
  protected void bench(int loops, Reader rules, Reader urls) {
    long start = System.currentTimeMillis();
    try {
      URLFilter filter = getURLFilter(rules);
      FilteredURL[] expected = readURLFile(urls);
      for (int i=0; i<loops; i++) {
        test(filter, expected);
      }
    } catch (Exception e) {
      fail(e.toString());
    }
    LOG.info("bench time (" + loops + ") " +
             (System.currentTimeMillis()-start) + "ms");
  }
  
  protected void test(String file) {
    try {
      test(new FileReader(SAMPLES + SEPARATOR + file + ".rules"),
           new FileReader(SAMPLES + SEPARATOR + file + ".urls"));
    } catch (Exception e) {
      fail(e.toString());
    }
  }
  
  protected void test(Reader rules, Reader urls) {
    try {
      test(getURLFilter(rules), readURLFile(urls));
    } catch (Exception e) {
      fail(e.toString());
    }
  }
  
  protected void test(URLFilter filter, FilteredURL[] expected) {
    for (int i=0; i<expected.length; i++) {
      String result = filter.filter(expected[i].url);
      if (result != null) {
        assertTrue(expected[i].url, expected[i].sign);
      } else {
        assertFalse(expected[i].url, expected[i].sign);
      }
    }
  }
  
  private static FilteredURL[] readURLFile(Reader reader) throws IOException {
    BufferedReader in = new BufferedReader(reader);
    List list = new ArrayList();
    String line;
    while((line=in.readLine()) != null) {
      if (line.length() != 0) {
        list.add(new FilteredURL(line));
      }
    }
    return (FilteredURL[]) list.toArray(new FilteredURL[list.size()]);
  }
    
  private static class FilteredURL {
  
    boolean sign;
    String url;

    FilteredURL(String line) {
      switch (line.charAt(0)) {
      case '+' : 
        sign = true;
        break;
      case '-' :
        sign = false;
        break;
      default :
        // Simply ignore...
      }
      url = line.substring(1);
    }
  }
  
}