WriteUTFTest.java

//
// WriteUTFTest.java
//

/*
LOCI Common package: utilities for I/O, reflection and miscellaneous tasks.
Copyright (C) 2005-@year@ Melissa Linkert and Curtis Rueden.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

package loci.common.utests;

import static org.testng.AssertJUnit.assertEquals;

import java.io.IOException;

import loci.common.IRandomAccess;
import loci.common.utests.providers.IRandomAccessProvider;
import loci.common.utests.providers.IRandomAccessProviderFactory;

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

/**
 * Tests for writing bytes to a loci.common.IRandomAccess.
 *
 * <dl><dt><b>Source code:</b></dt>
 * <dd><a href="http://trac.openmicroscopy.org.uk/ome/browser/bioformats.git/components/common/test/loci/common/utests/WriteUTFTest.java">Trac</a>,
 * <a href="http://git.openmicroscopy.org/?p=bioformats.git;a=blob;f=components/common/test/loci/common/utests/WriteUTFTest.java;hb=HEAD">Gitweb</a></dd></dl>
 *
 * @see loci.common.IRandomAccess
 */
@Test(groups="writeTests")
public class WriteUTFTest {

  private static final byte[] PAGE = new byte[] {
    (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00,
    (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00,
    (byte) 0x00, (byte) 0x00
  };

  private static final String MODE = "rw";

  private static final int BUFFER_SIZE = 1024;

  private IRandomAccess fileHandle;

  // Unused right now.
  //private boolean checkGrowth;

  @Parameters({"provider", "checkGrowth"})
  @BeforeMethod
  public void setUp(String provider, @Optional("false") String checkGrowth)
    throws IOException {
    // Unused right now.
    //this.checkGrowth = Boolean.parseBoolean(checkGrowth);
    IRandomAccessProviderFactory factory = new IRandomAccessProviderFactory();
    IRandomAccessProvider instance = factory.getInstance(provider);
    fileHandle = instance.createMock(PAGE, MODE, BUFFER_SIZE);
  }

  @Test(groups="initialLengthTest")
  public void testLength() throws IOException {
    assertEquals(10, fileHandle.length());
  }
  
  @Test
  public void testWriteSequential() throws IOException {
    fileHandle.writeUTF("\u00A9");  // Copyright sign (2 bytes)
    fileHandle.writeUTF("\u2260");  // Not equal to (3 bytes)
    fileHandle.writeUTF("\u00A9");  // Copyright sign (2 bytes)
    fileHandle.writeUTF("\u2260");  // Not equal to (3 bytes)
    fileHandle.seek(0);
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x02, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x03, fileHandle.readByte());
    assertEquals((byte) 0xE2, fileHandle.readByte());
    assertEquals((byte) 0x89, fileHandle.readByte());
    assertEquals((byte) 0xA0, fileHandle.readByte());
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x02, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x03, fileHandle.readByte());
    assertEquals((byte) 0xE2, fileHandle.readByte());
    assertEquals((byte) 0x89, fileHandle.readByte());
    assertEquals((byte) 0xA0, fileHandle.readByte());
    fileHandle.seek(0);
    assertEquals("\u00A9", fileHandle.readUTF());
    assertEquals("\u2260", fileHandle.readUTF());
    assertEquals("\u00A9", fileHandle.readUTF());
    assertEquals("\u2260", fileHandle.readUTF());
  }

  @Test
  public void testWrite() throws IOException {
    fileHandle.writeUTF("\u00A9\n");  // Copyright sign (2 bytes)
    assertEquals(5, fileHandle.getFilePointer());
    fileHandle.seek(0);
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x03, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    fileHandle.seek(0);
    assertEquals("\u00A9\n", fileHandle.readUTF());
  }

  @Test
  public void testWriteTwoCharacters() throws IOException {
    fileHandle.seek(0);
    fileHandle.writeUTF("\u00A9\u2260");
    assertEquals(7, fileHandle.getFilePointer());
    fileHandle.seek(0);
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x05, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    fileHandle.seek(0);
    assertEquals("\u00A9\u2260", fileHandle.readUTF());
  }

  @Test
  public void testWriteOffEnd() throws IOException {
    fileHandle.seek(10);
    fileHandle.writeUTF("\u00A9");  // Copyright sign (2 bytes)
    assertEquals(14, fileHandle.getFilePointer());
    assertEquals(14, fileHandle.length());
    fileHandle.seek(10);
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x02, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    fileHandle.seek(10);
    assertEquals("\u00A9", fileHandle.readUTF());
  }

  @Test
  public void testWriteTwiceOffEnd() throws IOException {
    fileHandle.seek(10);
    fileHandle.writeUTF("\u00A9");  // Copyright sign (2 bytes)
    fileHandle.writeUTF("\u2260");  // Not equal to (3 bytes)
    assertEquals(19, fileHandle.getFilePointer());
    assertEquals(19, fileHandle.length());
    fileHandle.seek(10);
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x02, fileHandle.readByte());
    assertEquals((byte) 0xC2, fileHandle.readByte());
    assertEquals((byte) 0xA9, fileHandle.readByte());
    assertEquals((byte) 0x00, fileHandle.readByte());
    assertEquals((byte) 0x03, fileHandle.readByte());
    assertEquals((byte) 0xE2, fileHandle.readByte());
    assertEquals((byte) 0x89, fileHandle.readByte());
    assertEquals((byte) 0xA0, fileHandle.readByte());
    fileHandle.seek(10);
    assertEquals("\u00A9", fileHandle.readUTF());
    assertEquals("\u2260", fileHandle.readUTF());
  }

}