/*
    * 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.vfs2.provider.test;
  
  import java.util.Arrays;
  import java.util.Collections;
  import java.util.List;
  
  import org.apache.commons.vfs2.FileObject;
  import org.apache.commons.vfs2.FileSystem;
  import org.apache.commons.vfs2.FileSystemException;
  import org.apache.commons.vfs2.VFS;
  import org.junit.Assert;
  import org.junit.BeforeClass;
  import org.junit.Test;
  
  /**
   * Tests FileObject sorting.
   *
   * $Id$
   */
  public class FileObjectSortTestCase {
  
      /**
       * The size of arrays to sort.
       */
      private static final int SIZE = 100;
  
      // Consider @Immutable
      private static FileSystem VfsFileSystem;
  
      // Consider @Immutable
      private static FileObject[] SortedArray;
  
      // Consider @Immutable
      private static FileObject[] UnSortedArray;
  
      private static FileObject resolveFile(final FileSystem fs, final int i) throws FileSystemException {
          return fs.resolveFile(String.format("%010d", i));
      }
  
      @BeforeClass
      public static void setUpClass() throws FileSystemException {
          VfsFileSystem = VFS.getManager().createVirtualFileSystem("vfs://").getFileSystem();
          SortedArray = new FileObject[SIZE];
          for (int i = 0; i < SIZE; i++) {
              SortedArray[i] = FileObjectSortTestCase.resolveFile(VfsFileSystem, i);
          }
          UnSortedArray = new FileObject[SIZE];
          for (int i = 0; i < SIZE; i++) {
              UnSortedArray[i] = FileObjectSortTestCase.resolveFile(VfsFileSystem, SIZE - i - 1);
          }
      }
  
      /**
       * Tests that sorting ignores case.
       *
       * @throws FileSystemException
       */
      @Test
      public void testSortArrayIgnoreCase() throws FileSystemException {
          final FileObject file1 = VfsFileSystem.resolveFile("A1");
          final FileObject file2 = VfsFileSystem.resolveFile("a2");
          final FileObject file3 = VfsFileSystem.resolveFile("A3");
          final FileObject[] actualArray = { file3, file1, file2, file1, file2 };
          final FileObject[] expectedArray = { file1, file1, file2, file2, file3 };
          Arrays.sort(actualArray);
          Assert.assertArrayEquals(expectedArray, actualArray);
      }
  
      /**
       * Tests sorting an array
       *
       * @throws FileSystemException
       */
      @Test
      public void testSortArrayMoveAll() throws FileSystemException {
          final FileObject[] actualArray = UnSortedArray.clone();
          Assert.assertFalse(Arrays.equals(UnSortedArray, SortedArray));
          Arrays.sort(actualArray);
          Assert.assertArrayEquals(SortedArray, actualArray);
      }
  
      /**
       * Tests that sorting an array already in oder does not mess it up.
      *
      * @throws FileSystemException
      */
     @Test
     public void testSortArrayMoveNone() throws FileSystemException {
         final FileObject[] actualArray = SortedArray.clone();
         Arrays.sort(actualArray);
         Assert.assertArrayEquals(SortedArray, actualArray);
     }
 
     /**
      * Tests sorting a list
      *
      * @throws FileSystemException
      */
     @Test
     public void testSortListMoveAll() throws FileSystemException {
         final List<FileObject> actualList = Arrays.asList(UnSortedArray);
         final List<FileObject> expectedSortedList = Arrays.asList(SortedArray);
         Assert.assertNotEquals(actualList, expectedSortedList);
         Collections.sort(actualList);
         Assert.assertEquals(actualList, expectedSortedList);
     }
 
     /**
      * Tests that sorting a list already in oder does not mess it up.
      *
      * @throws FileSystemException
      */
     @Test
     public void testSortListMoveNone() throws FileSystemException {
         final List<FileObject> actualList = Arrays.asList(SortedArray);
         final List<FileObject> expectedSortedList = Arrays.asList(SortedArray);
         Collections.sort(actualList);
         Assert.assertEquals(actualList, expectedSortedList);
     }
 
 }