ThumberTest

package com.atlassian.core.util.thumbnail;

import com.atlassian.core.util.ImageInfo;
import com.google.common.base.Predicates;
import junit.framework.TestCase;
import org.apache.log4j.Appender;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.spi.LoggingEvent;
import org.mockito.ArgumentCaptor;

import javax.imageio.ImageIO;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;

/**
 * This tests vary on the level of abstraction tested.
 * The reason is that I did not want to change public interface (method visibility) of Thumber class (in order to
 * keep clients compatible).
 * Thus sometimes higher level methods are tested and the test are not really unit -> e.g. testing
 * {@link com.atlassian.core.util.thumbnail.Thumber#retrieveOrCreateThumbNail(java.io.InputStream, String, java.io.File, int, int, long)}
 */
public class ThumberTest extends TestCase
{
	private static final String[] CMYK_IMAGES = new String[] {
			"/cmyk/CMYK Coated FOGRA27 (ISO 12647-2-2004).jpg",
			"/cmyk/CMYK Coated FOGRA39 (ISO 12647-2-2004).jpg",
			"/cmyk/CMYK Euroscale Coated v2.jpg",
			"/cmyk/CMYK Euroscale Uncoated v2.jpg",
			"/cmyk/CMYK Generic Profile.jpg",
			"/cmyk/CMYK Japan Color 2001 Coated.jpg",
			"/cmyk/CMYK Japan Color 2001 Uncoated.jpg",
			"/cmyk/CMYK Japan Color 2002 Newspaper.jpg",
			"/cmyk/CMYK Japan Web Coated (Ad).jpg",
			"/cmyk/CMYK No Profile.jpg",
			"/cmyk/CMYK Uncoated FOGRA29 (ISO 12647-2-2004).jpg",
			"/cmyk/CMYK US Sheetfed Coated v2.jpg",
			"/cmyk/CMYK US Sheetfed Uncoated v2.jpg",
			"/cmyk/CMYK US Web Coated (SWOP) v2.jpg",
			"/cmyk/CMYK US Web Uncoated v2.jpg",
			"/cmyk/CMYK Web Coated FOGRA28 (ISO 12647-2-2004).jpg",
	};

    private static final int MAX_WIDTH = 300;
    private static final int MAX_HEIGHT = 400;
    private final File tempFile;
    private static final String TEST_FILE_NAME = "mypicture.png";

    public ThumberTest() throws IOException
    {
        tempFile = File.createTempFile("atlassian-core-thumbnail", "test");
    }

    @Override
    protected void setUp() throws Exception
    {
        //noinspection ResultOfMethodCallIgnored
        tempFile.delete(); // this file must not exist, other wise thumber won't try to scale the image
    }

    @Override
    protected void tearDown() throws Exception
    {
        //noinspection ResultOfMethodCallIgnored
        tempFile.delete();
    }

    public void testRetrieveOrCreateThumbnailTransparentPng() throws IOException
    {
        Thumber thumber = new Thumber(Thumbnail.MimeType.PNG);
        testRetrieveOrCreateThumbnail(thumber, "/transparent-png.png", Transparency.TRANSLUCENT, ImageInfo.FORMAT_PNG);
    }

    public void testRetrieveOrCreateThumbnailBrokenGif() throws IOException
    {
        Appender appender = mock(Appender.class);
        Logger.getRootLogger().addAppender(appender);
        try
        {
            ArgumentCaptor arguments = ArgumentCaptor.forClass(LoggingEvent.class);
            Thumber thumber = spy(new Thumber());
            //broken.gif is no longer broken for Thumber - JAI has high tolerance for broken files, read some text file instead!
            assertNull(thumber.retrieveOrCreateThumbNail(getClass().getResourceAsStream("/NotAnImage.jpg"), TEST_FILE_NAME, tempFile, MAX_WIDTH, MAX_HEIGHT, 1));
            verify(appender).doAppend((LoggingEvent) arguments.capture());

            final LoggingEvent loggingEvent = (LoggingEvent) arguments.getValue();
            assertEquals(Level.ERROR, loggingEvent.getLevel());
            assertEquals("com.atlassian.core.util.thumbnail.Thumber", loggingEvent.categoryName);
            assertEquals("Unable to create thumbnail image for id 1", loggingEvent.getMessage());
        }
        finally
        {
            Logger.getRootLogger().removeAppender(appender);
        }
    }

    public void testRetrieveOrCreateThumbnailOpaqueGif() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnail(thumber, "/opaque-gif.gif", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailOpaqueGifAsStream() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnailAsStream(thumber, "/opaque-gif.gif", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailOpaquePng() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnail(thumber, "/opaque-png.png", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailOpaquePngAsStream() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnailAsStream(thumber, "/opaque-png.png", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailJpg() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnail(thumber, "/test-jpg.jpg", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailJpgAsStream() throws IOException
    {
        Thumber thumber = new Thumber();
        testRetrieveOrCreateThumbnailAsStream(thumber, "/test-jpg.jpg", Transparency.OPAQUE, ImageInfo.FORMAT_JPEG);
    }

    public void testRetrieveOrCreateThumbnailTransparentGif() throws IOException
    {
        Thumber thumber = new Thumber(Thumbnail.MimeType.PNG);
        testRetrieveOrCreateThumbnail(thumber, "/transparent-gif.gif", Transparency.TRANSLUCENT, ImageInfo.FORMAT_PNG);
    }

    public void testRetrieveOrCreateThumbnailTransparentGifAsStream() throws IOException
    {
        Thumber thumber = new Thumber(Thumbnail.MimeType.PNG);
        //Streaming git image changes the transparency
        testRetrieveOrCreateThumbnailAsStream(thumber, "/transparent-gif.gif", Transparency.BITMASK, ImageInfo.FORMAT_PNG);
    }

    public void testRetrieveOrCreateThumbnailCMYKJpg() throws IOException {
        Thumber thumber = new Thumber();

        final Thumbnail thumbnail = thumber.retrieveOrCreateThumbNail(
                getClass().getResourceAsStream("/cmyk.jpg"), TEST_FILE_NAME,
                tempFile, MAX_WIDTH, MAX_HEIGHT, 1);

        //Cannot use: testRetrieveOrCreateThumbnail, because ImageIO cannot read CMYK images
        //Passing hardcoded test image width and height
        assertThumbnail(thumbnail, Transparency.OPAQUE, ImageInfo.FORMAT_JPEG,
				MAX_WIDTH, MAX_WIDTH * 1134 / 1134);
    }

	public void testAllCmykImagesShouldBeLoaded() throws Exception {
		Thumber thumber = new Thumber();

		for (String cmykImage : CMYK_IMAGES) {
			final Thumbnail thumbnail = thumber.retrieveOrCreateThumbNail(
					getClass().getResourceAsStream(cmykImage), TEST_FILE_NAME,
					tempFile, MAX_WIDTH, MAX_HEIGHT, 1);
			assertNotNull(thumbnail);
		}
	}

    public void testScaleImageForNonBufferedImage()
    {
        // this should normally produce ToolkitImage
        final Image image = Toolkit.getDefaultToolkit().getImage(getClass().getResource("/opaque-gif.gif"));
        final BufferedImage thumbnail = new Thumber().scaleImage(image,
                new Thumber.WidthHeightHelper(MAX_WIDTH, MAX_HEIGHT));

        // scaleImage ignores aspect ratio -> always produces desired with & height
        assertEquals(MAX_WIDTH, thumbnail.getWidth());
        assertEquals(MAX_HEIGHT, thumbnail.getHeight());
        assertEquals(Transparency.OPAQUE, thumbnail.getTransparency());
    }

    public void testScaleImageForNonBufferedImageTransparentGif()
    {
        // this should normally produce ToolkitImage
        final Image image = Toolkit.getDefaultToolkit().getImage(getClass().getResource("/transparent-gif.gif"));
        final BufferedImage thumbnail = new Thumber().scaleImage(image,
                new Thumber.WidthHeightHelper(MAX_WIDTH, MAX_HEIGHT));

        // scaleImage ignores aspect ratio -> always produces desired with & height
        assertEquals(MAX_WIDTH, thumbnail.getWidth());
        assertEquals(MAX_HEIGHT, thumbnail.getHeight());
        assertEquals(Transparency.TRANSLUCENT, thumbnail.getTransparency());
    }

    public void testUpscalingShouldReturnOriginalSize() throws IOException
    {
        final String resourceName = "/opaque-png.png";
        final BufferedImage image = ImageIO.read(getClass().getResourceAsStream(resourceName));
        final int width = image.getWidth();
        final int height = image.getHeight();
        final Thumbnail thumbnail = new Thumber().retrieveOrCreateThumbNail(
                getClass().getResourceAsStream(resourceName), TEST_FILE_NAME,
                tempFile, width * 3, height * 3, 1);

        assertThumbnail(thumbnail, Transparency.OPAQUE, ImageInfo.FORMAT_JPEG, width, height);
    }

    public void testScaleImageUpscaling() throws IOException
    {
        final String resourceName = "/opaque-png.png";
        final BufferedImage image = ImageIO.read(getClass().getResourceAsStream(resourceName));
        final int width = image.getWidth();
        final int height = image.getHeight();
        assertScaleImage(image, width * 3, height * 3);
        assertScaleImage(image, width - 10, height + 100);
        assertScaleImage(image, width + 100, height - 20);
    }

    public void testScaleImageWithInvalidParams() throws IOException
    {
        final String resourceName = "/opaque-png.png";
        final BufferedImage image = ImageIO.read(getClass().getResourceAsStream(resourceName));
        try
        {
            assertScaleImage(image, -30, -20);
            fail(IllegalArgumentException.class.getName() + " expected");
        }
        catch (IllegalArgumentException ignore)
        {
            // this is expected
        }
    }

    private void assertScaleImage(final BufferedImage image, int aWidth, int aHeight)
    {
        final BufferedImage thumbnail = new Thumber().scaleImage(image, new Thumber.WidthHeightHelper(aWidth,
                aHeight));
        assertEquals(aWidth, thumbnail.getWidth());
        assertEquals(aHeight, thumbnail.getHeight());
        assertEquals(image.getTransparency(), thumbnail.getTransparency());
    }

    private void testRetrieveOrCreateThumbnail(Thumber thumber, String imageResourceName, int expectedTransparency, int expectedFormat) throws IOException
    {
        final Thumbnail thumbnail = thumber.retrieveOrCreateThumbNail(
                getClass().getResourceAsStream(imageResourceName), TEST_FILE_NAME,
                tempFile, MAX_WIDTH, MAX_HEIGHT, 1);

        assertNotNull(thumbnail);
        final BufferedImage image = ImageIO.read(getClass().getResourceAsStream(imageResourceName));

        assertThumbnail(thumbnail, expectedTransparency, expectedFormat,
                MAX_WIDTH, MAX_WIDTH * image.getHeight() / image.getWidth());
    }

    private void testRetrieveOrCreateThumbnailAsStream(Thumber thumber, String imageResourceName, int expectedTransparency, int expectedFormat) throws IOException
    {
        final Thumbnail thumbnail = thumber.retrieveOrCreateThumbNail(
                getClass().getResourceAsStream(imageResourceName), TEST_FILE_NAME,
                tempFile, MAX_WIDTH, MAX_HEIGHT, 1, Predicates.<Dimensions>alwaysFalse());

        assertNotNull(thumbnail);
        final BufferedImage image = ImageIO.read(getClass().getResourceAsStream(imageResourceName));

        assertThumbnail(thumbnail, expectedTransparency, expectedFormat,
                MAX_WIDTH, MAX_WIDTH * image.getHeight() / image.getWidth());
    }

    private void assertThumbnail(final Thumbnail thumbnail, final int expectedTransparency, final int expectedFormat,
            int expectedWidth, int expectedHeight) throws IOException
    {
        assertEquals(expectedWidth, thumbnail.getWidth());
        assertEquals(expectedHeight, thumbnail.getHeight());
        assertEquals(TEST_FILE_NAME, thumbnail.getFilename());

        final BufferedImage thumbnailImage = ImageIO.read(tempFile);
        assertEquals(expectedWidth, thumbnailImage.getWidth());
        assertEquals(expectedHeight, thumbnailImage.getHeight());
        assertEquals(expectedTransparency, thumbnailImage.getTransparency());
        assertImageType(tempFile, expectedFormat);
    }


    private void assertImageType(final File tempFile, int format) throws IOException
    {
        final ImageInfo imageInfo = new ImageInfo();
        final FileInputStream fis = new FileInputStream(tempFile);
        imageInfo.setInput(fis);
        assertTrue(imageInfo.check());
        assertEquals(format, imageInfo.getFormat());
        fis.close();
    }
}