jackcess/src/test/java/com/healthmarketscience/jackcess/PropertiesTest.java

/*
Copyright (c) 2011 James Ahlborn

Licensed 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 com.healthmarketscience.jackcess;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.UUID;

import static com.healthmarketscience.jackcess.Database.*;
import com.healthmarketscience.jackcess.impl.DatabaseImpl;
import static com.healthmarketscience.jackcess.impl.JetFormatTest.*;
import com.healthmarketscience.jackcess.impl.PropertyMapImpl;
import com.healthmarketscience.jackcess.impl.PropertyMaps;
import com.healthmarketscience.jackcess.impl.TableImpl;
import static com.healthmarketscience.jackcess.TestUtil.*;
import static com.healthmarketscience.jackcess.DatabaseBuilder.*;
import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.Test;

/**
 * @author James Ahlborn
 */
public class PropertiesTest
{
  @Test
  public void testPropertyMaps() throws Exception
  {
    PropertyMaps maps = new PropertyMaps(10, null, null, null);
    assertTrue(maps.isEmpty());
    assertEquals(0, maps.getSize());
    assertFalse(maps.iterator().hasNext());
    assertEquals(10, maps.getObjectId());

    PropertyMapImpl defMap = maps.getDefault();
    assertTrue(defMap.isEmpty());
    assertEquals(0, defMap.getSize());
    assertFalse(defMap.iterator().hasNext());

    PropertyMapImpl colMap = maps.get("testcol");
    assertTrue(colMap.isEmpty());
    assertEquals(0, colMap.getSize());
    assertFalse(colMap.iterator().hasNext());

    assertFalse(maps.isEmpty());
    assertEquals(2, maps.getSize());

    assertSame(defMap, maps.get(PropertyMaps.DEFAULT_NAME));
    assertEquals(PropertyMaps.DEFAULT_NAME, defMap.getName());
    assertSame(colMap, maps.get("TESTCOL"));
    assertEquals("testcol", colMap.getName());

    defMap.put("foo", DataType.TEXT, "bar", false);
    defMap.put("baz", DataType.LONG, 13, true);

    assertFalse(defMap.isEmpty());
    assertEquals(2, defMap.getSize());
    assertFalse(defMap.get("foo").isDdl());
    assertTrue(defMap.get("baz").isDdl());

    colMap.put("buzz", DataType.BOOLEAN, Boolean.TRUE, true);

    assertFalse(colMap.isEmpty());
    assertEquals(1, colMap.getSize());

    assertEquals("bar", defMap.getValue("foo"));
    assertEquals("bar", defMap.getValue("FOO"));
    assertNull(colMap.getValue("foo"));
    assertEquals(13, defMap.get("baz").getValue());
    assertEquals(Boolean.TRUE, colMap.getValue("Buzz"));

    assertEquals("bar", defMap.getValue("foo", "blah"));
    assertEquals("blah", defMap.getValue("bogus", "blah"));

    List<PropertyMap.Property> props = new ArrayList<PropertyMap.Property>();
    for(PropertyMap map : maps) {
      for(PropertyMap.Property prop : map) {
        props.add(prop);
      }
    }

    assertEquals(Arrays.asList(defMap.get("foo"), defMap.get("baz"),
                               colMap.get("buzz")), props);
  }

  @Test
  public void testInferTypes() throws Exception
  {
    PropertyMaps maps = new PropertyMaps(10, null, null, null);
    PropertyMap defMap = maps.getDefault();

    assertEquals(DataType.TEXT,
                 defMap.put(PropertyMap.FORMAT_PROP, null).getType());
    assertEquals(DataType.BOOLEAN,
                 defMap.put(PropertyMap.REQUIRED_PROP, null).getType());

    assertEquals(DataType.TEXT,
                 defMap.put("strprop", "this is a string").getType());
    assertEquals(DataType.BOOLEAN,
                 defMap.put("boolprop", true).getType());
    assertEquals(DataType.LONG,
                 defMap.put("intprop", 37).getType());
  }

  @Test
  public void testReadProperties() throws Exception
  {
    byte[] nameMapBytes = null;

    for(TestDB testDb : SUPPORTED_DBS_TEST_FOR_READ) {
      Database db = open(testDb);

      TableImpl t = (TableImpl)db.getTable("Table1");
      assertEquals(t.getTableDefPageNumber(),
                   t.getPropertyMaps().getObjectId());
      PropertyMap tProps = t.getProperties();
      assertEquals(PropertyMaps.DEFAULT_NAME, tProps.getName());
      int expectedNumProps = 3;
      if(db.getFileFormat() != Database.FileFormat.V1997) {
        assertEquals("{5A29A676-1145-4D1A-AE47-9F5415CDF2F1}",
                     tProps.getValue(PropertyMap.GUID_PROP));
        if(nameMapBytes == null) {
          nameMapBytes = (byte[])tProps.getValue("NameMap");
        } else {
          assertTrue(Arrays.equals(nameMapBytes,
                                   (byte[])tProps.getValue("NameMap")));
        }
        expectedNumProps += 2;
      }
      assertEquals(expectedNumProps, tProps.getSize());
      assertEquals((byte)0, tProps.getValue("Orientation"));
      assertEquals(Boolean.FALSE, tProps.getValue("OrderByOn"));
      assertEquals((byte)2, tProps.getValue("DefaultView"));

      PropertyMap colProps = t.getColumn("A").getProperties();
      assertEquals("A", colProps.getName());
      expectedNumProps = 9;
      if(db.getFileFormat() != Database.FileFormat.V1997) {
        assertEquals("{E9EDD90C-CE55-4151-ABE1-A1ACE1007515}",
                     colProps.getValue(PropertyMap.GUID_PROP));
        ++expectedNumProps;
      }
      assertEquals(expectedNumProps, colProps.getSize());
      assertEquals((short)-1, colProps.getValue("ColumnWidth"));
      assertEquals((short)0, colProps.getValue("ColumnOrder"));
      assertEquals(Boolean.FALSE, colProps.getValue("ColumnHidden"));
      assertEquals(Boolean.FALSE,
                   colProps.getValue(PropertyMap.REQUIRED_PROP));
      assertEquals(Boolean.FALSE,
                   colProps.getValue(PropertyMap.ALLOW_ZERO_LEN_PROP));
      assertEquals((short)109, colProps.getValue("DisplayControl"));
      assertEquals(Boolean.TRUE, colProps.getValue("UnicodeCompression"));
      assertEquals((byte)0, colProps.getValue("IMEMode"));
      assertEquals((byte)3, colProps.getValue("IMESentenceMode"));

      PropertyMap dbProps = db.getDatabaseProperties();
      assertTrue(((String)dbProps.getValue(PropertyMap.ACCESS_VERSION_PROP))
                 .matches("[0-9]{2}[.][0-9]{2}"));

      PropertyMap sumProps = db.getSummaryProperties();
      assertEquals(3, sumProps.getSize());
      assertEquals("test", sumProps.getValue(PropertyMap.TITLE_PROP));
      assertEquals("tmccune", sumProps.getValue(PropertyMap.AUTHOR_PROP));
      assertEquals("Health Market Science", sumProps.getValue(PropertyMap.COMPANY_PROP));

      PropertyMap userProps = db.getUserDefinedProperties();
      assertEquals(1, userProps.getSize());
      assertEquals(Boolean.TRUE, userProps.getValue("ReplicateProject"));

      db.close();
    }
  }

  @Test
  public void testParseProperties() throws Exception
  {
    for(FileFormat ff : SUPPORTED_FILEFORMATS_FOR_READ) {
      File[] dbFiles = new File(DIR_TEST_DATA, ff.name()).listFiles();
      if(dbFiles == null) {
        continue;
      }
      for(File f : dbFiles) {

        if(!f.isFile()) {
          continue;
        }

        Database db = open(ff, f);

        PropertyMap dbProps = db.getDatabaseProperties();
        assertFalse(dbProps.isEmpty());
        assertTrue(((String)dbProps.getValue(PropertyMap.ACCESS_VERSION_PROP))
                   .matches("[0-9]{2}[.][0-9]{2}"));

        for(Row row : ((DatabaseImpl)db).getSystemCatalog()) {
          int id = row.getInt("Id");
          byte[] propBytes = row.getBytes("LvProp");
          PropertyMaps propMaps = ((DatabaseImpl)db).getPropertiesForObject(
              id, null);
          int byteLen = ((propBytes != null) ? propBytes.length : 0);
          if(byteLen == 0) {
            assertTrue(propMaps.isEmpty());
          } else if(propMaps.isEmpty()) {
            assertTrue(byteLen < 80);
          } else {
            assertTrue(byteLen > 0);
          }
        }

        db.close();
      }
    }
  }

  @Test
  public void testWriteProperties() throws Exception
  {
    for(TestDB testDb : SUPPORTED_DBS_TEST) {
      Database db = open(testDb);

      TableImpl t = (TableImpl)db.getTable("Table1");

      PropertyMap tProps = t.getProperties();

      PropertyMaps maps = ((PropertyMapImpl)tProps).getOwner();

      byte[] mapsBytes = maps.write();

      PropertyMaps maps2 = ((DatabaseImpl)db).readProperties(
          mapsBytes, maps.getObjectId(), null);

      Iterator<PropertyMapImpl> iter = maps.iterator();
      Iterator<PropertyMapImpl> iter2 = maps2.iterator();

      while(iter.hasNext() && iter2.hasNext()) {
        PropertyMapImpl propMap = iter.next();
        PropertyMapImpl propMap2 = iter2.next();

        checkProperties(propMap, propMap2);
      }

      assertFalse(iter.hasNext());
      assertFalse(iter2.hasNext());

      db.close();
    }
  }

  @Test
  public void testModifyProperties() throws Exception
  {
    for(TestDB testDb : SUPPORTED_DBS_TEST) {
      Database db = openCopy(testDb);
      File dbFile = db.getFile();

      Table t = db.getTable("Table1");

      // grab originals
      PropertyMap origCProps = t.getColumn("C").getProperties();
      PropertyMap origFProps = t.getColumn("F").getProperties();
      PropertyMap origDProps = t.getColumn("D").getProperties();

      db.close();


      // modify but do not save
      db = open(dbFile);

      t = db.getTable("Table1");

      PropertyMap cProps = t.getColumn("C").getProperties();
      PropertyMap fProps = t.getColumn("F").getProperties();
      PropertyMap dProps = t.getColumn("D").getProperties();

      assertFalse((Boolean)cProps.getValue(PropertyMap.REQUIRED_PROP));
      assertEquals("0", fProps.getValue(PropertyMap.DEFAULT_VALUE_PROP));
      assertEquals((short)109, dProps.getValue("DisplayControl"));

      cProps.put(PropertyMap.REQUIRED_PROP, DataType.BOOLEAN, true);
      fProps.get(PropertyMap.DEFAULT_VALUE_PROP).setValue("42");
      dProps.remove("DisplayControl");

      db.close();


      // modify and save
      db = open(dbFile);

      t = db.getTable("Table1");

      cProps = t.getColumn("C").getProperties();
      fProps = t.getColumn("F").getProperties();
      dProps = t.getColumn("D").getProperties();

      assertFalse((Boolean)cProps.getValue(PropertyMap.REQUIRED_PROP));
      assertEquals("0", fProps.getValue(PropertyMap.DEFAULT_VALUE_PROP));
      assertEquals((short)109, dProps.getValue("DisplayControl"));

      checkProperties(origCProps, cProps);
      checkProperties(origFProps, fProps);
      checkProperties(origDProps, dProps);

      cProps.put(PropertyMap.REQUIRED_PROP, DataType.BOOLEAN, true);
      cProps.save();
      fProps.get(PropertyMap.DEFAULT_VALUE_PROP).setValue("42");
      fProps.save();
      dProps.remove("DisplayControl");
      dProps.save();

      db.close();


      // reload saved props
      db = open(dbFile);

      t = db.getTable("Table1");

      cProps = t.getColumn("C").getProperties();
      fProps = t.getColumn("F").getProperties();
      dProps = t.getColumn("D").getProperties();

      assertTrue((Boolean)cProps.getValue(PropertyMap.REQUIRED_PROP));
      assertEquals("42", fProps.getValue(PropertyMap.DEFAULT_VALUE_PROP));
      assertNull(dProps.getValue("DisplayControl"));

      cProps.put(PropertyMap.REQUIRED_PROP, DataType.BOOLEAN, false);
      fProps.get(PropertyMap.DEFAULT_VALUE_PROP).setValue("0");
      dProps.put("DisplayControl", DataType.INT, (short)109);

      checkProperties(origCProps, cProps);
      checkProperties(origFProps, fProps);
      checkProperties(origDProps, dProps);

      db.close();
    }
  }

  @Test
  public void testCreateDbProperties() throws Exception
  {
    for(FileFormat ff : SUPPORTED_FILEFORMATS) {

      if(ff == FileFormat.GENERIC_JET4) {
        // weirdo format, no properties
        continue;
      }

      File file = TestUtil.createTempFile(false);
      Database db = newDatabase(file)
        .setFileFormat(ff)
        .putUserDefinedProperty("testing", "123")
        .create();

      UUID u1 = UUID.randomUUID();
      UUID u2 = UUID.randomUUID();
      Table t = newTable("Test")
        .putProperty("awesome_table", true)
        .addColumn(newColumn("id", DataType.LONG)
                   .setAutoNumber(true)
                   .putProperty(PropertyMap.REQUIRED_PROP, true)
                   .putProperty(PropertyMap.GUID_PROP, u1))
        .addColumn(newColumn("data", DataType.TEXT)
                   .putProperty(PropertyMap.ALLOW_ZERO_LEN_PROP, false)
                   .putProperty(PropertyMap.GUID_PROP, u2))
        .toTable(db);

      t.addRow(Column.AUTO_NUMBER, "value");

      db.close();

      db = open(file);

      assertEquals("123", db.getUserDefinedProperties().getValue("testing"));

      t = db.getTable("Test");

      assertEquals(Boolean.TRUE,
                   t.getProperties().getValue("awesome_table"));

      Column c = t.getColumn("id");
      assertEquals(Boolean.TRUE,
                   c.getProperties().getValue(PropertyMap.REQUIRED_PROP));
      assertEquals("{" + u1.toString().toUpperCase() + "}",
                   c.getProperties().getValue(PropertyMap.GUID_PROP));

      c = t.getColumn("data");
      assertEquals(Boolean.FALSE,
                   c.getProperties().getValue(PropertyMap.ALLOW_ZERO_LEN_PROP));
      assertEquals("{" + u2.toString().toUpperCase() + "}",
                   c.getProperties().getValue(PropertyMap.GUID_PROP));

    }
  }

  @Test
  public void testEnforceProperties() throws Exception
  {
    for (final FileFormat fileFormat : SUPPORTED_FILEFORMATS)
    {
      try (final Database db = create(fileFormat))
      {
        final Table testReq = newTable("testReq")
                .addColumn(newColumn("id", DataType.LONG)
                        .setAutoNumber(true)
                        .putProperty(PropertyMap.REQUIRED_PROP, true))
                .addColumn(newColumn("value", DataType.TEXT)
                        .putProperty(PropertyMap.REQUIRED_PROP, true))
                .toTable(db);

        testReq.addRow(Column.AUTO_NUMBER, "v1");

        assertThrows(InvalidValueException.class, () -> testReq.addRow(Column.AUTO_NUMBER, null));

        testReq.addRow(Column.AUTO_NUMBER, "");

        List<? extends Map<String, Object>> expectedRows
                = createExpectedTable(
                        createExpectedRow(
                                "id", 1,
                                "value", "v1"),
                        createExpectedRow(
                                "id", 2,
                                "value", ""));
        assertTable(expectedRows, testReq);

        final Table testNz = newTable("testNz")
                .addColumn(newColumn("id", DataType.LONG)
                        .setAutoNumber(true)
                        .putProperty(PropertyMap.REQUIRED_PROP, true))
                .addColumn(newColumn("value", DataType.TEXT)
                        .putProperty(PropertyMap.ALLOW_ZERO_LEN_PROP, false))
                .toTable(db);

        testNz.addRow(Column.AUTO_NUMBER, "v1");

        assertThrows(InvalidValueException.class, () -> testNz.addRow(Column.AUTO_NUMBER, ""));

        testNz.addRow(Column.AUTO_NUMBER, null);

        expectedRows = createExpectedTable(createExpectedRow("id", 1, "value", "v1"),
                                           createExpectedRow("id", 2, "value", null));
        assertTable(expectedRows, testNz);

        final Table testReqNz = newTable("testReqNz")
                .addColumn(newColumn("id", DataType.LONG)
                        .setAutoNumber(true)
                        .putProperty(PropertyMap.REQUIRED_PROP, true))
                .addColumn(newColumn("value", DataType.TEXT))
                .toTable(db);

        Column col = testReqNz.getColumn("value");
        PropertyMap props = col.getProperties();
        props.put(PropertyMap.REQUIRED_PROP, true);
        props.put(PropertyMap.ALLOW_ZERO_LEN_PROP, false);
        props.save();

        testReqNz.addRow(Column.AUTO_NUMBER, "v1");

        assertThrows(InvalidValueException.class, () -> testReqNz.addRow(Column.AUTO_NUMBER, ""));

        assertThrows(InvalidValueException.class, () -> testReqNz.addRow(Column.AUTO_NUMBER, null));

        testReqNz.addRow(Column.AUTO_NUMBER, "v2");

        expectedRows = createExpectedTable(createExpectedRow("id", 1, "value", "v1"),
                                           createExpectedRow("id", 2, "value", "v2"));
        assertTable(expectedRows, testReqNz);

      }
    }
  }

  @Test
  public void testEnumValues() throws Exception
  {
    PropertyMaps maps = new PropertyMaps(10, null, null, null);

    PropertyMapImpl colMap = maps.get("testcol");

    colMap.put(PropertyMap.DISPLAY_CONTROL_PROP,
               PropertyMap.DisplayControl.TEXT_BOX);

    assertEquals(PropertyMap.DisplayControl.TEXT_BOX.getValue(),
                 colMap.getValue(PropertyMap.DISPLAY_CONTROL_PROP));
  }

  private static void checkProperties(PropertyMap propMap1,
                                      PropertyMap propMap2)
  {
    assertEquals(propMap1.getSize(), propMap2.getSize());
    for(PropertyMap.Property prop : propMap1) {
      PropertyMap.Property prop2 = propMap2.get(prop.getName());

      assertEquals(prop.getName(), prop2.getName());
      assertEquals(prop.getType(), prop2.getType());

      Object v1 = prop.getValue();
      Object v2 = prop2.getValue();

      if(v1 instanceof byte[]) {
        assertTrue(Arrays.equals((byte[])v1, (byte[])v2));
      } else {
        assertEquals(v1, v2);
      }
    }
  }

}