URLHandleTest.java

/*
 * #%L
 * Common package for I/O and related utilities
 * %%
 * Copyright (C) 2005 - 2015 Open Microscopy Environment:
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 *   - University of Dundee
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package loci.common.utests;

import static org.testng.AssertJUnit.assertEquals;

import java.io.EOFException;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;

import loci.common.Constants;
import loci.common.HandleException;
import loci.common.URLHandle;

import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

/**
 * Unit tests for the loci.common.URLHandle class.
 *
 * @see loci.common.URLHandle
 */
public class URLHandleTest {

  // -- Fields --

  private URLHandle fileHandle;
  private static final boolean IS_WINDOWS = System.getProperty("os.name").startsWith("Windows");

  // -- Setup methods --

  @BeforeMethod
  public void setup() throws IOException {
    File tmpFile = File.createTempFile("urlhandle", "tmp");
    tmpFile.deleteOnExit();
    FileOutputStream out = new FileOutputStream(tmpFile);
    out.write("hello, world!\n".getBytes(Constants.ENCODING));
    out.close();
    String path = tmpFile.getAbsolutePath();
    fileHandle = new URLHandle((IS_WINDOWS ? "file:/" : "file://") + path);
  }

  // -- Test methods --

  @Test
  public void testLength() throws IOException {
    assertEquals(14, fileHandle.length());
  }

  @Test
  public void testSequentialReadByte() throws IOException {
    fileHandle.seek(0);
    assertEquals(0x68, fileHandle.readByte());
    assertEquals(0x65, fileHandle.readByte());
    assertEquals(0x6c, fileHandle.readByte());
    assertEquals(0x6c, fileHandle.readByte());
    assertEquals(0x6f, fileHandle.readByte());
    assertEquals(0x2c, fileHandle.readByte());
    assertEquals(0x20, fileHandle.readByte());
    assertEquals(0x77, fileHandle.readByte());
    assertEquals(0x6f, fileHandle.readByte());
    assertEquals(0x72, fileHandle.readByte());
    assertEquals(0x6c, fileHandle.readByte());
    assertEquals(0x64, fileHandle.readByte());
    assertEquals(0x21, fileHandle.readByte());
    assertEquals(0x0a, fileHandle.readByte());
  }

  @Test
  public void testSequentialReadShort() throws IOException {
    fileHandle.seek(0);
    assertEquals(0x6865, fileHandle.readShort());
    assertEquals(0x6c6c, fileHandle.readShort());
    assertEquals(0x6f2c, fileHandle.readShort());
    assertEquals(0x2077, fileHandle.readShort());
    assertEquals(0x6f72, fileHandle.readShort());
    assertEquals(0x6c64, fileHandle.readShort());
    assertEquals(0x210a, fileHandle.readShort());
  }

  @Test
  public void testSequentialReadInt() throws IOException {
    fileHandle.seek(0);
    assertEquals(0x68656c6c, fileHandle.readInt());
    assertEquals(0x6f2c2077, fileHandle.readInt());
    assertEquals(0x6f726c64, fileHandle.readInt());
  }

  @Test
  public void testSequentialReadLong() throws IOException {
    fileHandle.seek(0);
    assertEquals(0x68656c6c6f2c2077L, fileHandle.readLong());
  }

  @Test
  public void testSeekForwardReadByte() throws IOException {
    fileHandle.seek(5);
    assertEquals(0x2c, fileHandle.readByte());
  }

  @Test
  public void testSeekForwardReadShort() throws IOException {
    fileHandle.seek(5);
    assertEquals(0x2c20, fileHandle.readShort());
  }

  @Test
  public void testSeekForwardReadInt() throws IOException {
    fileHandle.seek(5);
    assertEquals(0x2c20776f, fileHandle.readInt());
  }

  @Test
  public void testSeekForwardReadLong() throws IOException {
    fileHandle.seek(5);
    assertEquals(0x2c20776f726c6421L, fileHandle.readLong());
  }

  @Test
  public void testSeekBackReadByte() throws IOException {
    fileHandle.seek(13);
    fileHandle.seek(7);
    assertEquals(0x77, fileHandle.readByte());
  }

  @Test
  public void testSeekBackReadShort() throws IOException {
    fileHandle.seek(13);
    fileHandle.seek(7);
    assertEquals(0x776f, fileHandle.readShort());
  }

  @Test
  public void testSeekBackReadInt() throws IOException {
    fileHandle.seek(13);
    fileHandle.seek(7);
    assertEquals(0x776f726c, fileHandle.readInt());
  }

  @Test
  public void testSeekBackReadLong() throws IOException {
    fileHandle.seek(13);
    fileHandle.seek(5);
    assertEquals(0x2c20776f726c6421L, fileHandle.readLong());
  }

  @Test (expectedExceptions = {EOFException.class})
  public void testEOF() throws IOException {
    fileHandle.seek(16);
    fileHandle.readByte();
  }

  @Test (expectedExceptions = {HandleException.class})
  public void testWrite() throws IOException {
    fileHandle.write(0);
  }

}