/*
    * 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.commons.io.comparator;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.Comparator;
  import java.util.List;
  
  import org.apache.commons.io.FileUtils;
  import org.apache.commons.io.testtools.FileBasedTestCase;
  
  /**
   * Base Test case for Comparator implementations.
   */
  public abstract class ComparatorAbstractTestCase extends FileBasedTestCase {
  
      /** comparator instance */
      protected AbstractFileComparator comparator;
  
      /** reverse comparator instance */
      protected Comparator<File> reverse;
  
      /** File which compares equal to  "equalFile2" */
      protected File equalFile1;
  
      /** File which compares equal to  "equalFile1" */
      protected File equalFile2;
  
      /** File which is less than the "moreFile" */
      protected File lessFile;
  
      /** File which is more than the "lessFile" */
      protected File moreFile;
  
      /**
       * Construct a new test case with the specified name
       * @param name Name of the test
       */
      public ComparatorAbstractTestCase(final String name) {
          super(name);
      }
  
      /** @see junit.framework.TestCase#setUp() */
      @Override
      protected void setUp() throws Exception {
          comparator = (AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR;
          reverse = DefaultFileComparator.DEFAULT_REVERSE;
      }
  
      /** @see junit.framework.TestCase#tearDown() */
      @Override
      protected void tearDown() throws Exception {
          comparator = null;
          reverse = null;
          equalFile1 = null;
          equalFile2 = null;
          lessFile = null;
          moreFile = null;
          FileUtils.deleteDirectory(getTestDirectory());
      }
  
      /**
       * Test the comparator.
       */
      public void testComparator() {
          assertEquals("equal", 0, comparator.compare(equalFile1, equalFile2));
          assertTrue("less",  comparator.compare(lessFile, moreFile) < 0);
          assertTrue("more",  comparator.compare(moreFile, lessFile) > 0);
      }
  
      /**
       * Test the comparator reversed.
       */
      public void testReverseComparator() {
          assertEquals("equal", 0, reverse.compare(equalFile1, equalFile2));
          assertTrue("less",  reverse.compare(moreFile, lessFile) < 0);
          assertTrue("more",  reverse.compare(lessFile, moreFile) > 0);
      }
  
      /**
       * Test comparator array sort is null safe.
       */
      public void testSortArrayNull() {
          assertNull(comparator.sort((File[])null));
     }
 
     /**
      * Test the comparator array sort.
      */
     public void testSortArray() {
         final File[] files = new File[3];
         files[0] = equalFile1;
         files[1] = moreFile;
         files[2] = lessFile;
         comparator.sort(files);
         assertSame("equal", lessFile, files[0]);
         assertSame("less",  equalFile1, files[1]);
         assertSame("more",  moreFile, files[2]);
     }
 
     /**
      * Test the comparator array sort.
      */
     public void testSortList() {
         final List<File> files = new ArrayList<File>();
         files.add(equalFile1);
         files.add(moreFile);
         files.add(lessFile);
         comparator.sort(files);
         assertSame("equal", lessFile, files.get(0));
         assertSame("less",  equalFile1, files.get(1));
         assertSame("more",  moreFile, files.get(2));
     }
 
     /**
      * Test comparator list sort is null safe.
      */
     public void testSortListNull() {
         assertNull(comparator.sort((List<File>)null));
     }
 
     /**
      * Test comparator toString.
      */
     public void testToString() {
         assertNotNull("comparator", comparator.toString());
         assertTrue("reverse", reverse.toString().startsWith("ReverseComparator["));
     }
 }