Refactor DomainBase into DomainContent and create DomainHistory (#668)

* Refactor DomainBase into DomainContent and create DomainHistory

This is similar to #587 and #634, but for domains.

One caveat is that we refactor some of the Domain* instance methods to
be static so that they can be called either on DomainBase or
DomainContent, returning the appropriate type each time.

Note that we set DomainHistory to use the same revision ID sequence as
HostHistory and ContactHistory.

In addition, we refactor the tests to the History objects a bit to
reduce duplicate code and because we cannot guarantee yet that the
SQL-stored VKeys are symmetrical -- the ofy keys are not persisted at
the moment.

In addition, rename the DomainHost table to the default Domain_nsHosts so that it automatically creates two separate nsHosts tables for us -- one foreign-keyed on the domain repo ID, and one foreign-keyed on the history revision ID

* Use access hackery to allow manual names for nsHosts tables

* Clean up post merge artifacts

* Add unused setters that Hibernate requires

* Fix the tests and semantic merge conflicts

* Change ns_hosts to ns_host everywhere

* Rename ns_host to host_repo_id

* V42 -> V44

core/src/test/java/google/registry/model/history/ContactHistoryTest.java

@@ -1,4 +1,4 @@
-// Copyright 2017 The Nomulus Authors. All Rights Reserved.
+// Copyright 2020 The Nomulus Authors. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,7 +15,9 @@
 package google.registry.model.history;
 
 import static com.google.common.truth.Truth.assertThat;
+import static google.registry.model.ImmutableObjectSubject.assertAboutImmutableObjects;
 import static google.registry.persistence.transaction.TransactionManagerFactory.jpaTm;
+import static google.registry.testing.DatastoreHelper.newContactResourceWithRoid;
 import static google.registry.testing.SqlHelper.saveRegistrar;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -24,7 +26,6 @@ import google.registry.model.contact.ContactHistory;
 import google.registry.model.contact.ContactResource;
 import google.registry.model.eppcommon.Trid;
 import google.registry.model.reporting.HistoryEntry;
-import google.registry.model.transfer.ContactTransferData;
 import google.registry.persistence.VKey;
 import org.junit.jupiter.api.Test;
 
@@ -37,26 +38,18 @@ public class ContactHistoryTest extends EntityTestCase {
 
   @Test
   void testPersistence() {
-    saveRegistrar("registrar1");
-
-    ContactResource contact =
-        new ContactResource.Builder()
-            .setRepoId("contact1")
-            .setContactId("contactId")
-            .setCreationClientId("registrar1")
-            .setPersistedCurrentSponsorClientId("registrar1")
-            .setTransferData(new ContactTransferData.Builder().build())
-            .build();
+    saveRegistrar("TheRegistrar");
 
+    ContactResource contact = newContactResourceWithRoid("contactId", "contact1");
     jpaTm().transact(() -> jpaTm().saveNew(contact));
-    VKey<ContactResource> contactVKey = VKey.createSql(ContactResource.class, "contact1");
+    VKey<ContactResource> contactVKey = contact.createVKey();
     ContactResource contactFromDb = jpaTm().transact(() -> jpaTm().load(contactVKey));
     ContactHistory contactHistory =
         new ContactHistory.Builder()
             .setType(HistoryEntry.Type.HOST_CREATE)
             .setXmlBytes("<xml></xml>".getBytes(UTF_8))
             .setModificationTime(fakeClock.nowUtc())
-            .setClientId("registrar1")
+            .setClientId("TheRegistrar")
             .setTrid(Trid.create("ABC-123", "server-trid"))
             .setBySuperuser(false)
             .setReason("reason")
@@ -70,18 +63,15 @@ public class ContactHistoryTest extends EntityTestCase {
             () -> {
               ContactHistory fromDatabase = jpaTm().load(VKey.createSql(ContactHistory.class, 1L));
               assertContactHistoriesEqual(fromDatabase, contactHistory);
+              assertThat(fromDatabase.getContactRepoId().getSqlKey())
+                  .isEqualTo(contactHistory.getContactRepoId().getSqlKey());
             });
   }
 
-  private void assertContactHistoriesEqual(ContactHistory one, ContactHistory two) {
-    // enough of the fields get changed during serialization that we can't depend on .equals()
-    assertThat(one.getClientId()).isEqualTo(two.getClientId());
-    assertThat(one.getContactRepoId()).isEqualTo(two.getContactRepoId());
-    assertThat(one.getBySuperuser()).isEqualTo(two.getBySuperuser());
-    assertThat(one.getRequestedByRegistrar()).isEqualTo(two.getRequestedByRegistrar());
-    assertThat(one.getReason()).isEqualTo(two.getReason());
-    assertThat(one.getTrid()).isEqualTo(two.getTrid());
-    assertThat(one.getType()).isEqualTo(two.getType());
-    assertThat(one.getContactBase().getContactId()).isEqualTo(two.getContactBase().getContactId());
+  static void assertContactHistoriesEqual(ContactHistory one, ContactHistory two) {
+    assertAboutImmutableObjects().that(one)
+        .isEqualExceptFields(two, "contactBase", "contactRepoId", "parent");
+    assertAboutImmutableObjects().that(one.getContactBase())
+        .isEqualExceptFields(two.getContactBase(), "repoId");
   }
 }

core/src/test/java/google/registry/model/history/DomainHistoryTest.java

@@ -0,0 +1,89 @@
+// Copyright 2020 The Nomulus Authors. All Rights Reserved.
+//
+// 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 google.registry.model.history;
+
+import static com.google.common.truth.Truth.assertThat;
+import static google.registry.model.ImmutableObjectSubject.assertAboutImmutableObjects;
+import static google.registry.persistence.transaction.TransactionManagerFactory.jpaTm;
+import static google.registry.testing.DatastoreHelper.newContactResourceWithRoid;
+import static google.registry.testing.DatastoreHelper.newDomainBase;
+import static google.registry.testing.DatastoreHelper.newHostResourceWithRoid;
+import static google.registry.testing.SqlHelper.saveRegistrar;
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+import google.registry.model.EntityTestCase;
+import google.registry.model.contact.ContactResource;
+import google.registry.model.domain.DomainBase;
+import google.registry.model.domain.DomainHistory;
+import google.registry.model.eppcommon.Trid;
+import google.registry.model.host.HostResource;
+import google.registry.model.reporting.HistoryEntry;
+import google.registry.persistence.VKey;
+import org.junit.jupiter.api.Test;
+
+/** Tests for {@link DomainHistory}. */
+public class DomainHistoryTest extends EntityTestCase {
+
+  public DomainHistoryTest() {
+    super(JpaEntityCoverageCheck.ENABLED);
+  }
+
+  @Test
+  public void testPersistence() {
+    saveRegistrar("TheRegistrar");
+
+    HostResource host = newHostResourceWithRoid("ns1.example.com", "host1");
+    jpaTm().transact(() -> jpaTm().saveNew(host));
+    ContactResource contact = newContactResourceWithRoid("contactId", "contact1");
+    jpaTm().transact(() -> jpaTm().saveNew(contact));
+
+    DomainBase domain =
+        newDomainBase("example.tld", "domainRepoId", contact)
+            .asBuilder()
+            .setNameservers(host.createVKey())
+            .build();
+    jpaTm().transact(() -> jpaTm().saveNew(domain));
+
+    DomainHistory domainHistory =
+        new DomainHistory.Builder()
+            .setType(HistoryEntry.Type.DOMAIN_CREATE)
+            .setXmlBytes("<xml></xml>".getBytes(UTF_8))
+            .setModificationTime(fakeClock.nowUtc())
+            .setClientId("TheRegistrar")
+            .setTrid(Trid.create("ABC-123", "server-trid"))
+            .setBySuperuser(false)
+            .setReason("reason")
+            .setRequestedByRegistrar(true)
+            .setDomainContent(domain)
+            .setDomainRepoId(domain.createVKey())
+            .build();
+    jpaTm().transact(() -> jpaTm().saveNew(domainHistory));
+
+    jpaTm()
+        .transact(
+            () -> {
+              DomainHistory fromDatabase =
+                  jpaTm().load(VKey.createSql(DomainHistory.class, domainHistory.getId()));
+              assertDomainHistoriesEqual(fromDatabase, domainHistory);
+              assertThat(fromDatabase.getDomainRepoId().getSqlKey())
+                  .isEqualTo(domainHistory.getDomainRepoId().getSqlKey());
+            });
+  }
+
+  static void assertDomainHistoriesEqual(DomainHistory one, DomainHistory two) {
+    assertAboutImmutableObjects().that(one)
+        .isEqualExceptFields(two, "domainContent", "domainRepoId", "parent");
+  }
+}

core/src/test/java/google/registry/model/history/HostHistoryTest.java

@@ -14,12 +14,13 @@
 
 package google.registry.model.history;
 
+import static com.google.common.truth.Truth.assertThat;
 import static google.registry.model.ImmutableObjectSubject.assertAboutImmutableObjects;
 import static google.registry.persistence.transaction.TransactionManagerFactory.jpaTm;
+import static google.registry.testing.DatastoreHelper.newHostResourceWithRoid;
 import static google.registry.testing.SqlHelper.saveRegistrar;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
-import com.google.common.collect.ImmutableSet;
 import google.registry.model.EntityTestCase;
 import google.registry.model.eppcommon.Trid;
 import google.registry.model.host.HostHistory;
@@ -37,16 +38,9 @@ public class HostHistoryTest extends EntityTestCase {
 
   @Test
   void testPersistence() {
-    saveRegistrar("registrar1");
+    saveRegistrar("TheRegistrar");
 
-    HostResource host =
-        new HostResource.Builder()
-            .setRepoId("host1")
-            .setHostName("ns1.example.com")
-            .setCreationClientId("TheRegistrar")
-            .setPersistedCurrentSponsorClientId("TheRegistrar")
-            .setInetAddresses(ImmutableSet.of())
-            .build();
+    HostResource host = newHostResourceWithRoid("ns1.example.com", "host1");
     jpaTm().transact(() -> jpaTm().saveNew(host));
     VKey<HostResource> hostVKey = VKey.createSql(HostResource.class, "host1");
     HostResource hostFromDb = jpaTm().transact(() -> jpaTm().load(hostVKey));
@@ -55,7 +49,7 @@ public class HostHistoryTest extends EntityTestCase {
             .setType(HistoryEntry.Type.HOST_CREATE)
             .setXmlBytes("<xml></xml>".getBytes(UTF_8))
             .setModificationTime(fakeClock.nowUtc())
-            .setClientId("registrar1")
+            .setClientId("TheRegistrar")
             .setTrid(Trid.create("ABC-123", "server-trid"))
             .setBySuperuser(false)
             .setReason("reason")
@@ -70,6 +64,8 @@ public class HostHistoryTest extends EntityTestCase {
               HostHistory fromDatabase =
                   jpaTm().load(VKey.createSql(HostHistory.class, hostHistory.getId()));
               assertHostHistoriesEqual(fromDatabase, hostHistory);
+              assertThat(fromDatabase.getHostRepoId().getSqlKey())
+                  .isEqualTo(hostHistory.getHostRepoId().getSqlKey());
             });
   }
 

core/src/test/java/google/registry/schema/integration/SqlIntegrationTestSuite.java

@@ -20,6 +20,7 @@ import google.registry.model.billing.BillingEventTest;
 import google.registry.model.contact.ContactResourceTest;
 import google.registry.model.domain.DomainBaseSqlTest;
 import google.registry.model.history.ContactHistoryTest;
+import google.registry.model.history.DomainHistoryTest;
 import google.registry.model.history.HostHistoryTest;
 import google.registry.model.poll.PollMessageTest;
 import google.registry.model.registry.RegistryLockDaoTest;
@@ -77,6 +78,7 @@ import org.junit.runner.RunWith;
   ContactResourceTest.class,
   CursorDaoTest.class,
   DomainBaseSqlTest.class,
+  DomainHistoryTest.class,
   HostHistoryTest.class,
   LockDaoTest.class,
   PollMessageTest.class,

core/src/test/java/google/registry/testing/DatastoreHelper.java

@@ -119,12 +119,16 @@ public class DatastoreHelper {
                   String.class));
 
   public static HostResource newHostResource(String hostName) {
+    return newHostResourceWithRoid(hostName, generateNewContactHostRoid());
+  }
+
+  public static HostResource newHostResourceWithRoid(String hostName, String repoId) {
     return new HostResource.Builder()
         .setHostName(hostName)
         .setCreationClientId("TheRegistrar")
         .setPersistedCurrentSponsorClientId("TheRegistrar")
         .setCreationTimeForTest(START_OF_TIME)
-        .setRepoId(generateNewContactHostRoid())
+        .setRepoId(repoId)
         .build();
   }