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

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import junit.framework.TestCase;

import org.apache.commons.imaging.ImageReadException;
import org.apache.commons.imaging.Imaging;
import org.apache.commons.imaging.ImagingConstants;
import org.apache.commons.imaging.test.util.FileSystemTraversal;
import org.apache.commons.imaging.util.Debug;

public abstract class ImagingTest extends TestCase implements
        ImagingTestConstants, ImagingConstants {

    protected File createTempFile(final String prefix, final String suffix)
            throws IOException {
        final File tempFolder = new File("tmp");
        if (!tempFolder.exists()) {
            tempFolder.mkdirs();
        }
        assertTrue(tempFolder.isDirectory());

        final File result = File.createTempFile(prefix, suffix, tempFolder);
        result.deleteOnExit();
        return result;
    }

    public void compareByteArrays(final byte a[], final byte b[]) {
        assertTrue(a.length == b.length);
        for (int i = 0; i < b.length; i++) {
            assertTrue(b[i] == a[i]);
        }
    }

    protected void purgeMemory() {
        try {
            System.gc();
            Thread.sleep(50);
            System.runFinalization();
            Thread.sleep(50);
        } catch (final Exception e) {
            Debug.debug(e);
        }
    }

    protected boolean isPhilHarveyTestImage(final File file) {
        // Debug.debug("isPhilHarveyTestImage file", file.getAbsolutePath());
        // Debug.debug("isPhilHarveyTestImage folder",
        // PHIL_HARVEY_TEST_IMAGE_FOLDER.getAbsolutePath());
        return file.getAbsolutePath().startsWith(
                PHIL_HARVEY_TEST_IMAGE_FOLDER.getAbsolutePath());
    }

    public static interface ImageFilter {
        public boolean accept(File file) throws IOException, ImageReadException;
    }

    protected File getTestImage() throws IOException, ImageReadException {
        return getTestImage(null);
    }

    protected File getTestImageByName(final String filename)
            throws IOException, ImageReadException {
        return getTestImage(new ImageFilter() {
            public boolean accept(final File file) throws IOException,
                    ImageReadException {
                return file.getName().equals(filename);
            }
        });
    }

    protected File getTestImage(final ImageFilter filter) throws IOException,
            ImageReadException {
        final List<File> images = getTestImages(filter, 1);

        assertTrue(images.size() > 0);

        return images.get(0);
    }

    protected List<File> getTestImages() throws IOException, ImageReadException {
        return getTestImages(null, -1);
    }

    protected List<File> getTestImages(final ImageFilter filter) throws IOException,
            ImageReadException {
        return getTestImages(filter, -1);
    }

    private static final List<File> ALL_IMAGES = new ArrayList<File>();

    static {
        File imagesFolder = TEST_IMAGE_FOLDER;

        // imagesFolder = new File(
        // "C:\\personal\\apache\\imaging\\src\\test\\data\\images\\bmp\\2");

        imagesFolder = imagesFolder.getAbsoluteFile();

        Debug.debug("imagesFolder", imagesFolder);
        assertTrue(imagesFolder.exists());

        final FileSystemTraversal.Visitor visitor = new FileSystemTraversal.Visitor() {

            public boolean visit(final File file, final double progressEstimate) {
                if (!Imaging.hasImageFileExtension(file)) {
                    return true;
                }
                ALL_IMAGES.add(file);
                return true;
            }
        };
        new FileSystemTraversal().traverseFiles(imagesFolder, visitor);
    }

    protected List<File> getTestImages(final ImageFilter filter, final int max)
            throws IOException, ImageReadException {
        final List<File> images = new ArrayList<File>();
        int counter = 0;

        for (int i = 0; i < ALL_IMAGES.size(); i++) {
            final File file = ALL_IMAGES.get(i);

            if (!Imaging.hasImageFileExtension(file)) {
                continue;
            }

            if (counter++ % 10 == 0) {
                Debug.purgeMemory();
            }

            if (file.getParentFile().getName().toLowerCase().equals("@broken")) {
                continue;
            }

            if (filter != null && !filter.accept(file)) {
                continue;
            }

            images.add(file);

            if (max > 0 && images.size() >= max) {
                break;
            }
        }

        assertTrue(images.size() > 0);

        return images;
    }

    protected boolean isInvalidPNGTestFile(final File file) {
        return (file.getParentFile().getName().equalsIgnoreCase("pngsuite") && file
                .getName().toLowerCase().startsWith("x"));
    }
}