src/test/java/org/apache/commons/compress/AbstractTestCase.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.commons.compress;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Iterator;
import java.util.List;

import junit.framework.TestCase;

import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.ArchiveInputStream;
import org.apache.commons.compress.archivers.ArchiveOutputStream;
import org.apache.commons.compress.archivers.ArchiveStreamFactory;
import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
import org.apache.commons.compress.utils.IOUtils;

public abstract class AbstractTestCase extends TestCase {

    protected File dir;
    protected File resultDir;

    private File archive;

    protected void setUp() throws Exception {
        dir = mkdir("dir");
        resultDir = mkdir("dir-result");
        archive = null;
    }

    protected static File mkdir(String name) throws IOException {
        File f = File.createTempFile(name, "");
        f.delete();
        f.mkdir();
        return f;
    }

    protected File getFile(String path) {
        return new File("src/test/resources", path);
    }

    protected void tearDown() throws Exception {
        rmdir(dir);
        rmdir(resultDir);
        dir = resultDir = null;
        if (archive != null) {
            if (!archive.delete()){
                throw new Exception("Could not delete "+archive.getPath());
            }
        }
    }

    protected static void rmdir(File f) {
        String[] s = f.list();
        if (s != null) {
            for (int i = 0; i < s.length; i++) {
                final File file = new File(f, s[i]);
                if (file.isDirectory()){
                    rmdir(file);
                }
                boolean ok = file.delete();
                if (!ok && file.exists()){
                    System.out.println("Failed to delete "+s[i]+" in "+f.getPath());
                }
            }
        }
        if (!f.delete()){
            throw new Error("Failed to delete "+f.getPath());
        }
    }

    /**
     * Creates an archive of 5 textbased files in several directories. The
     * archivername is the factory identifier for the archiver, for example zip,
     * tar, cpio, jar, ar. The archive is created as a temp file.
     * 
     * The archive contains the following files:
     * <ul>
     * <li>testdata/test1.xml</li>
     * <li>testdata/test2.xml</li>
     * <li>test/test3.xml</li>
     * <li>bla/test4.xml</li>
     * <li>test.txt</li>
     * <li>something/bla</li>
     * <li>test with spaces.txt</li>
     * </ul>
     * 
     * @param archivename
     *            the identifier of this archive
     * @return the newly created file
     * @throws Exception
     *             in case something goes wrong
     */
    protected File createArchive(String archivename) throws Exception {
        ArchiveOutputStream out = null;
        OutputStream stream = null;
        try {
            archive = File.createTempFile("test", "." + archivename);

            stream = new FileOutputStream(archive);
            out = new ArchiveStreamFactory().createArchiveOutputStream(
                    archivename, stream);

            final File file1 = getFile("test1.xml");
            final File file2 = getFile("test2.xml");
            final File file3 = getFile("test3.xml");
            final File file4 = getFile("test4.xml");
            final File file5 = getFile("test.txt");
            final File file6 = getFile("test with spaces.txt");

            ZipArchiveEntry entry = new ZipArchiveEntry("testdata/test1.xml");
            entry.setSize(file1.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file1), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("testdata/test2.xml");
            entry.setSize(file2.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file2), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("test/test3.xml");
            entry.setSize(file3.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file3), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("bla/test4.xml");
            entry.setSize(file4.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file4), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("bla/test5.xml");
            entry.setSize(file4.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file4), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("bla/blubber/test6.xml");
            entry.setSize(file4.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file4), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("test.txt");
            entry.setSize(file5.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file5), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("something/bla");
            entry.setSize(file6.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file6), out);
            out.closeArchiveEntry();

            entry = new ZipArchiveEntry("test with spaces.txt");
            entry.setSize(file6.length());
            out.putArchiveEntry(entry);
            IOUtils.copy(new FileInputStream(file6), out);
            out.closeArchiveEntry();

            return archive;
        } finally {
            if (out != null) {
                out.close();
            } else if (stream != null) {
                stream.close();
            }
        }
    }

    /**
     * Checks if an archive contains all expected files.
     * 
     * @param archive
     *            the archive to check
     * @param expected
     *            a list with expected string filenames
     * @throws Exception
     */
    protected void checkArchiveContent(File archive, List expected)
            throws Exception {
        final InputStream is = new FileInputStream(archive);
        try {
            final BufferedInputStream buf = new BufferedInputStream(is);
            final ArchiveInputStream in = new ArchiveStreamFactory()
                .createArchiveInputStream(buf);
            this.checkArchiveContent(in, expected);
        } finally {
            is.close();
        }
    }

    protected void checkArchiveContent(ArchiveInputStream in, List expected)
            throws Exception {
        File result = File.createTempFile("dir-result", "");
        result.delete();
        result.mkdir();

        ArchiveEntry entry = null;
        while ((entry = in.getNextEntry()) != null) {
            File outfile = new File(result.getCanonicalPath() + "/result/"
                    + entry.getName());
            outfile.getParentFile().mkdirs();
            OutputStream out = new FileOutputStream(outfile);
            long copied=0;
            try {
                copied=IOUtils.copy(in, out);
            } finally {
                out.close();
            }

            if (entry.getSize() != -1) {// some test cases don't set the size
                assertEquals(entry.getSize(), copied);
            }

            if (!outfile.exists()) {
                fail("extraction failed: " + entry.getName());
            }
            if (!expected.remove(entry.getName())) {
                fail("unexpected entry: " + entry.getName());
            }
        }
        in.close();
        if (expected.size() > 0) {
            for (Iterator iterator = expected.iterator(); iterator.hasNext();) {
                String name = (String) iterator.next();
                fail("Expected entry: " + name);
            }
        }
        assertEquals(0, expected.size());
        rmdir(result);
    }
}