/*
    * 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.tar;
  
  import static org.apache.commons.vfs2.VfsTestUtils.getTestResource;
  
  import junit.framework.Test;
  
  import org.apache.commons.vfs2.AbstractProviderTestConfig;
  import org.apache.commons.vfs2.FileObject;
  import org.apache.commons.vfs2.FileSystemManager;
  import org.apache.commons.vfs2.FileSystemOptions;
  import org.apache.commons.vfs2.ProviderTestSuite;
  import org.apache.commons.vfs2.auth.StaticUserAuthenticator;
  import org.apache.commons.vfs2.impl.DefaultFileSystemConfigBuilder;
  import org.apache.commons.vfs2.impl.DefaultFileSystemManager;
  
  /**
   * Tests for the Tar file system, using a tar file nested inside another tar file.
   */
  public class NestedTarTestCase extends AbstractProviderTestConfig {
  
      /**
       * Creates the test suite for nested tar files.
       */
      public static Test suite() throws Exception {
          return new ProviderTestSuite(new NestedTarTestCase(), true);
      }
  
      /**
       * Returns the base folder for tests.
       */
      @Override
      public FileObject getBaseTestFolder(final FileSystemManager manager) throws Exception {
          // We test with non-empty FS options to make sure they are propagated
          final FileSystemOptions opts = new FileSystemOptions();
          DefaultFileSystemConfigBuilder.getInstance().setUserAuthenticator(opts,
                  new StaticUserAuthenticator("domain", null, null));
  
          // Locate the base Tar file
          final String tarFilePath = getTestResource("nested.tar").getAbsolutePath();
  
          // Now build the nested file system
          final String uri = "tar:file:" + tarFilePath + "!/test.tar";
          final FileObject tarFile = manager.resolveFile(uri, opts);
          final FileObject nestedFS = manager.createFileSystem(tarFile);
          return nestedFS.resolveFile("/");
      }
  
      /**
       * Prepares the file system manager.
       */
      @Override
      public void prepare(final DefaultFileSystemManager manager) throws Exception {
          manager.addProvider("tar", new TarFileProvider());
          manager.addExtensionMap("tar", "tar");
          manager.addMimeTypeMap(MIME_TYPE_APPLICATION_X_TAR, "tar");
      }
  
  }