Add a SQL schema and DAO for KmsSecretRevision (#840)

* Add a SQL schema and DAO for KmsSecretRevision

The dual-object nature of KmsSecret and KmsSecretRevision will not be
necessary once we have moved to SQL. In that world, the only object will
be the one now called KmsSecretRevision. KmsSecretRevision already
stores its parent so all we need to do is convert that key to the String
secretName (or from the secretName to the key, if loading from SQL) and
select the max revision ID for a given secret name.

In a future PR, we will add a dual-writing DAO to these objects and
perform the dual writes, similar to how ReservedList functions.

* Regenerate diagram

* Rename revisionId and cryptoKeyVersionName

* Fix SQL files and diagram

core/src/main/java/google/registry/model/server/KmsSecret.java

@@ -16,6 +16,7 @@ package google.registry.model.server;
 
 import static google.registry.model.common.EntityGroupRoot.getCrossTldKey;
 
+import com.google.common.collect.ImmutableList;
 import com.googlecode.objectify.Key;
 import com.googlecode.objectify.annotation.Entity;
 import com.googlecode.objectify.annotation.Id;
@@ -23,11 +24,13 @@ import com.googlecode.objectify.annotation.Parent;
 import google.registry.model.ImmutableObject;
 import google.registry.model.annotations.ReportedOn;
 import google.registry.model.common.EntityGroupRoot;
+import google.registry.schema.replay.DatastoreEntity;
+import google.registry.schema.replay.SqlEntity;
 
 /** Pointer to the latest {@link KmsSecretRevision}. */
 @Entity
 @ReportedOn
-public class KmsSecret extends ImmutableObject {
+public class KmsSecret extends ImmutableObject implements DatastoreEntity {
 
   /** The unique name of this {@link KmsSecret}. */
   @Id String name;
@@ -45,6 +48,11 @@ public class KmsSecret extends ImmutableObject {
     return latestRevision;
   }
 
+  @Override
+  public ImmutableList<SqlEntity> toSqlEntities() {
+    return ImmutableList.of(); // not persisted in SQL
+  }
+
   public static KmsSecret create(String name, KmsSecretRevision latestRevision) {
     KmsSecret instance = new KmsSecret();
     instance.name = name;

core/src/main/java/google/registry/model/server/KmsSecretRevision.java

@@ -17,14 +17,24 @@ package google.registry.model.server;
 import static com.google.common.base.Preconditions.checkArgument;
 import static google.registry.model.common.EntityGroupRoot.getCrossTldKey;
 
+import com.google.common.collect.ImmutableList;
 import com.googlecode.objectify.Key;
 import com.googlecode.objectify.annotation.Entity;
 import com.googlecode.objectify.annotation.Id;
+import com.googlecode.objectify.annotation.Ignore;
+import com.googlecode.objectify.annotation.OnLoad;
 import com.googlecode.objectify.annotation.Parent;
 import google.registry.model.Buildable;
 import google.registry.model.CreateAutoTimestamp;
 import google.registry.model.ImmutableObject;
 import google.registry.model.annotations.ReportedOn;
+import google.registry.schema.replay.DatastoreEntity;
+import google.registry.schema.replay.SqlEntity;
+import javax.persistence.Column;
+import javax.persistence.Index;
+import javax.persistence.PostLoad;
+import javax.persistence.Table;
+import javax.persistence.Transient;
 
 /**
  * An encrypted value.
@@ -35,13 +45,22 @@ import google.registry.model.annotations.ReportedOn;
  *
  * <p>The value can be encrypted and decrypted using Cloud KMS.
  *
+ * <p>Note that the primary key of this entity is {@link #revisionKey}, which is auto-generated by
+ * the database. So, if a retry of insertion happens after the previous attempt unexpectedly
+ * succeeds, we will end up with having two exact same revisions that differ only by revisionKey.
+ * This is fine though, because we only use the revision with the highest revisionKey.
+ *
+ * <p>TODO: remove Datastore-specific fields post-Registry-3.0-migration and rename to KmsSecret.
+ *
  * @see <a href="https://cloud.google.com/kms/docs/">Google Cloud Key Management Service
  *     Documentation</a>
  * @see google.registry.keyring.kms.KmsKeyring
  */
 @Entity
 @ReportedOn
-public class KmsSecretRevision extends ImmutableObject {
+@javax.persistence.Entity(name = "KmsSecret")
+@Table(indexes = {@Index(columnList = "secretName")})
+public class KmsSecretRevision extends ImmutableObject implements DatastoreEntity, SqlEntity {
 
   /**
    * The maximum allowable secret size. Although Datastore allows entities up to 1 MB in size,
@@ -49,18 +68,31 @@ public class KmsSecretRevision extends ImmutableObject {
    */
   private static final int MAX_SECRET_SIZE_BYTES = 64 * 1024 * 1024;
 
-  /** The revision of this secret. */
-  @Id long revisionKey;
+  /**
+   * The revision of this secret.
+   *
+   * <p>TODO: change name of the variable to revisionId once we're off Datastore
+   */
+  @Id
+  @javax.persistence.Id
+  @Column(name = "revisionId")
+  long revisionKey;
 
   /** The parent {@link KmsSecret} which contains metadata about this {@link KmsSecretRevision}. */
-  @Parent Key<KmsSecret> parent;
+  @Parent @Transient Key<KmsSecret> parent;
+  @Column(nullable = false)
+  @Ignore
+  String secretName;
 
   /**
    * The name of the {@code cryptoKeyVersion} associated with this {@link KmsSecretRevision}.
    *
+   * <p>TODO: change name of the variable to cryptoKeyVersionName once we're off Datastore
+   *
    * @see <a
    *     href="https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions">projects.locations.keyRings.cryptoKeys.cryptoKeyVersions</a>
    */
+  @Column(nullable = false, name = "cryptoKeyVersionName")
   String kmsCryptoKeyVersionName;
 
   /**
@@ -70,9 +102,11 @@ public class KmsSecretRevision extends ImmutableObject {
    * @see <a
    *     href="https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys/encrypt">projects.locations.keyRings.cryptoKeys.encrypt</a>
    */
+  @Column(nullable = false)
   String encryptedValue;
 
   /** An automatically managed creation timestamp. */
+  @Column(nullable = false)
   CreateAutoTimestamp creationTime = CreateAutoTimestamp.create(null);
 
   public String getKmsCryptoKeyVersionName() {
@@ -83,6 +117,28 @@ public class KmsSecretRevision extends ImmutableObject {
     return encryptedValue;
   }
 
+  // When loading from SQL, fill out the Datastore-specific field
+  @PostLoad
+  void postLoad() {
+    parent = Key.create(getCrossTldKey(), KmsSecret.class, secretName);
+  }
+
+  // When loading from Datastore, fill out the SQL-specific field
+  @OnLoad
+  void onLoad() {
+    secretName = parent.getName();
+  }
+
+  @Override
+  public ImmutableList<SqlEntity> toSqlEntities() {
+    return ImmutableList.of(); // This is dually-written, as we do not care about history
+  }
+
+  @Override
+  public ImmutableList<DatastoreEntity> toDatastoreEntities() {
+    return ImmutableList.of(); // This is dually-written, as we do not care about history
+  }
+
   /** A builder for constructing {@link KmsSecretRevision} entities, since they are immutable. */
   public static class Builder extends Buildable.Builder<KmsSecretRevision> {
 
@@ -108,6 +164,7 @@ public class KmsSecretRevision extends ImmutableObject {
      */
     public Builder setParent(String secretName) {
       getInstance().parent = Key.create(getCrossTldKey(), KmsSecret.class, secretName);
+      getInstance().secretName = secretName;
       return this;
     }
   }

core/src/main/java/google/registry/model/server/KmsSecretRevisionSqlDao.java

@@ -0,0 +1,54 @@
+// 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.server;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static google.registry.persistence.transaction.TransactionManagerFactory.jpaTm;
+import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
+
+import java.util.Optional;
+
+/**
+ * A {@link KmsSecretRevision} DAO for Cloud SQL.
+ *
+ * <p>TODO: Rename this class to KmsSecretDao after migrating to Cloud SQL.
+ */
+public class KmsSecretRevisionSqlDao {
+
+  private KmsSecretRevisionSqlDao() {}
+
+  /** Saves the given KMS secret revision. */
+  public static void save(KmsSecretRevision kmsSecretRevision) {
+    checkArgumentNotNull(kmsSecretRevision, "kmsSecretRevision cannot be null");
+    jpaTm().assertInTransaction();
+    jpaTm().put(kmsSecretRevision);
+  }
+
+  /** Returns the latest revision for the secret name given, or absent if nonexistent. */
+  public static Optional<KmsSecretRevision> getLatestRevision(String secretName) {
+    checkArgument(!isNullOrEmpty(secretName), "secretName cannot be null or empty");
+    jpaTm().assertInTransaction();
+    return jpaTm()
+        .getEntityManager()
+        .createQuery(
+            "FROM KmsSecret ks WHERE ks.revisionKey IN (SELECT MAX(revisionKey) FROM "
+                + "KmsSecret subKs WHERE subKs.secretName = :secretName)",
+            KmsSecretRevision.class)
+        .setParameter("secretName", secretName)
+        .getResultStream()
+        .findFirst();
+  }
+}

core/src/main/resources/META-INF/persistence.xml

@@ -62,6 +62,7 @@
     <class>google.registry.model.registry.Registry</class>
     <class>google.registry.model.reporting.DomainTransactionRecord</class>
     <class>google.registry.model.reporting.Spec11ThreatMatch</class>
+    <class>google.registry.model.server.KmsSecretRevision</class>
     <class>google.registry.model.smd.SignedMarkRevocationList</class>
     <class>google.registry.model.tmch.ClaimsListShard</class>
     <class>google.registry.persistence.transaction.TransactionEntity</class>

core/src/test/java/google/registry/model/server/KmsSecretRevisionSqlDaoTest.java

@@ -0,0 +1,86 @@
+// 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.server;
+
+import static com.google.common.truth.Truth.assertThat;
+import static google.registry.model.ImmutableObjectSubject.assertAboutImmutableObjects;
+import static google.registry.persistence.transaction.TransactionManagerFactory.jpaTm;
+
+import google.registry.persistence.transaction.JpaTestRules;
+import google.registry.persistence.transaction.JpaTestRules.JpaIntegrationWithCoverageExtension;
+import google.registry.testing.DatastoreEntityExtension;
+import google.registry.testing.FakeClock;
+import java.util.Optional;
+import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+/** Tests for {@link google.registry.model.server.KmsSecretRevisionSqlDao}. */
+public class KmsSecretRevisionSqlDaoTest {
+
+  private final FakeClock fakeClock = new FakeClock();
+
+  @RegisterExtension
+  @Order(value = 1)
+  DatastoreEntityExtension datastoreEntityExtension = new DatastoreEntityExtension();
+
+  @RegisterExtension
+  JpaIntegrationWithCoverageExtension jpa =
+      new JpaTestRules.Builder().withClock(fakeClock).buildIntegrationWithCoverageExtension();
+
+  @Test
+  void testSaveAndRetrieve() {
+    KmsSecretRevision revision = createRevision();
+    jpaTm().transact(() -> KmsSecretRevisionSqlDao.save(revision));
+    Optional<KmsSecretRevision> fromSql =
+        jpaTm().transact(() -> KmsSecretRevisionSqlDao.getLatestRevision("secretName"));
+    assertThat(fromSql.isPresent()).isTrue();
+    assertAboutImmutableObjects().that(revision).isEqualExceptFields(fromSql.get(), "creationTime");
+  }
+
+  @Test
+  void testMultipleRevisions() {
+    KmsSecretRevision revision = createRevision();
+    jpaTm().transact(() -> KmsSecretRevisionSqlDao.save(revision));
+
+    KmsSecretRevision secondRevision = createRevision();
+    secondRevision.encryptedValue = "someOtherValue";
+    jpaTm().transact(() -> KmsSecretRevisionSqlDao.save(secondRevision));
+
+    Optional<KmsSecretRevision> fromSql =
+        jpaTm().transact(() -> KmsSecretRevisionSqlDao.getLatestRevision("secretName"));
+    assertThat(fromSql.isPresent()).isTrue();
+    assertThat(fromSql.get().getEncryptedValue()).isEqualTo("someOtherValue");
+  }
+
+  @Test
+  void testNonexistent() {
+    KmsSecretRevision revision = createRevision();
+    jpaTm().transact(() -> KmsSecretRevisionSqlDao.save(revision));
+    assertThat(
+            jpaTm()
+                .transact(() -> KmsSecretRevisionSqlDao.getLatestRevision("someOtherSecretName"))
+                .isPresent())
+        .isFalse();
+  }
+
+  private KmsSecretRevision createRevision() {
+    return new KmsSecretRevision.Builder()
+        .setEncryptedValue("encrypted")
+        .setKmsCryptoKeyVersionName("version")
+        .setParent("secretName")
+        .build();
+  }
+}

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

@@ -29,6 +29,7 @@ import google.registry.model.registry.RegistryLockDaoTest;
 import google.registry.model.registry.RegistryTest;
 import google.registry.model.registry.label.ReservedListSqlDaoTest;
 import google.registry.model.reporting.Spec11ThreatMatchTest;
+import google.registry.model.server.KmsSecretRevisionSqlDaoTest;
 import google.registry.model.smd.SignedMarkRevocationListDaoTest;
 import google.registry.model.tmch.ClaimsListDaoTest;
 import google.registry.persistence.transaction.JpaEntityCoverageExtension;
@@ -85,6 +86,7 @@ import org.junit.runner.RunWith;
   DomainBaseSqlTest.class,
   DomainHistoryTest.class,
   HostHistoryTest.class,
+  KmsSecretRevisionSqlDaoTest.class,
   LockDaoTest.class,
   PollMessageTest.class,
   PremiumListDaoTest.class,