Merge pull request #2505 from FOCONIS/refactor-uuid-v1-generator

Refactor UUID generator. Add uuid-property to serverConfig (#57)

ebean-test/src/test/java/io/ebeaninternal/server/idgen/TestUuidGenerator.java

@@ -5,14 +5,26 @@
 package io.ebeaninternal.server.idgen;
 
 import io.ebean.config.dbplatform.PlatformIdGenerator;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
 import java.util.Map;
+import java.util.Properties;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.assertj.core.api.Assertions.within;
 
 /**
  * Run some simple tests for the UUID generator.
@@ -52,12 +64,129 @@ public class TestUuidGenerator {
     }
   }
 
+  private File stateFile;
+
+  @BeforeEach
+  void beforeEach() throws IOException {
+    stateFile = new File("target/" + UUID.randomUUID() + ".state");
+  }
+
+  @AfterEach
+  void afterEach() {
+    stateFile.delete();
+  }
+
+  private void writePropertyFile(String nodeId, String clockSeq, String timestamp) throws IOException {
+    Properties prop = new Properties();
+    prop.setProperty("nodeId", nodeId);
+    prop.setProperty("clockSeq", clockSeq);
+    prop.setProperty("timeStamp", timestamp);
+    try (OutputStream os = new FileOutputStream(stateFile)) {
+      prop.store(os, "ebean uuid state file");
+    }
+  }
+  
+  private Properties readPropertyFile() throws IOException {
+    Properties prop = new Properties();
+    try (InputStream is = new FileInputStream(stateFile)) {
+      prop.load(is);
+    }
+    return prop;
+  }
+  /**
+   * Test takes ~0.3 sec
+   */
+  @Test
+  public void testUuidFixedMac() throws Exception {
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, "01-02-03-04-05-06");
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid.node()).isEqualTo(0x010203040506L);
+    Properties props = readPropertyFile();
+    assertThat(props)
+        .containsEntry("nodeId", "01-02-03-04-05-06")
+        .containsEntry("clockSeq", String.valueOf(uuid.clockSequence()));
+    assertThat(Long.parseLong(props.getProperty("timeStamp")))
+        .isCloseTo(uuid.timestamp(), within(2_000_000L));
+  }
+  
+  @Test
+  public void testUuidInvalidMac() throws Exception {
+    assertThatThrownBy(()-> UuidV1IdGenerator.getInstance(stateFile, "01-02-03-04-05"))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessageContaining("01-02-03-04-05 is invalid. Expected format: xx-xx-xx-xx-xx-xx");
+    assertThatThrownBy(()-> UuidV1IdGenerator.getInstance(stateFile, "01-02-03-04-05-GG"))
+        .isInstanceOf(IllegalArgumentException.class)
+        .hasMessageContaining("01-02-03-04-05-gg is invalid.")
+        .hasRootCauseInstanceOf(NumberFormatException.class)
+        .hasRootCauseMessage("For input string: \"gg\"");
+    assertThat(stateFile).doesNotExist();
+  }
+
+  @Test
+  public void testUuidGenerate() throws Exception {
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, "generate");
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+    assertThat(stateFile).exists();
+  }
+
+  @Test
+  public void testUuidRandom() throws Exception {
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, "random");
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+    assertThat(stateFile).doesNotExist();
+  }
+
+  @Test
+  public void testUuidFile() throws Exception {
+    writePropertyFile("12-34-56-78-90-AB", "4252", "0");
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, "generate");
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid.node()).isEqualTo(0x1234567890ABL);
+    assertThat(uuid.clockSequence()).isEqualTo(4252);
+  }
+
+  @Test
+  public void testUuidFileInvalidNodeId() throws Exception {
+    writePropertyFile("AB-CD-EF-GH-IJ-KL", "4252", "0");
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, "generate");
+    // a error message will be printed
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+  }
+
+  @Test
+  public void testInvalidFileName() throws Exception {
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance("/", null);
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+  }
+
+  @Test
+  public void testInvalidStateFile() throws Exception {
+    writePropertyFile("", "", "");
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, null);
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+  }
+  
+  @Test
+  public void testMacChange() throws Exception {
+    writePropertyFile("01-02-03-04-05", "1234", "1234");
+    UuidV1IdGenerator gen = UuidV1IdGenerator.getInstance(stateFile, null);
+    UUID uuid = gen.nextId(null);
+    assertThat(uuid).isNotNull();
+    // MAC must be updated with HW/ID
+    assertThat(readPropertyFile()).doesNotContainEntry("nodeId", "01-02-03-04-05");
+  }
+
   /**
    * Test takes ~0.3 sec
    */
   @Test
   public void testUuidV1SingleThread() throws Exception {
-    testGenerator(1, 500_000, UuidV1IdGenerator.getInstance("ebean-test-uuid.state"));
+    testGenerator(1, 500_000, UuidV1IdGenerator.getInstance(stateFile, null));
   }
 
   /**
@@ -65,7 +194,7 @@ public class TestUuidGenerator {
    */
   @Test
   public void testUuidV1MultiThread() throws Exception {
-    testGenerator(10, 50_000, UuidV1IdGenerator.getInstance("ebean-test-uuid.state"));
+    testGenerator(10, 50_000, UuidV1IdGenerator.getInstance(stateFile, null));
   }
 
   /**