Move the columns of StgProject to GivenStorageProject and update naming.

Introduce another set of API endpoints in `GivenStorageProject` which treat it as an Entity state.

Author: armiol

server/src/test/java/io/spine/server/storage/given/GivenStorageProject.java

@@ -26,13 +26,24 @@
 
 package io.spine.server.storage.given;
 
+import com.google.protobuf.Any;
 import com.google.protobuf.Timestamp;
 import com.google.protobuf.util.Durations;
 import com.google.protobuf.util.Timestamps;
+import io.spine.base.Identifier;
+import io.spine.protobuf.AnyPacker;
+import io.spine.query.Columns;
+import io.spine.query.RecordColumn;
+import io.spine.query.RecordColumns;
+import io.spine.server.entity.EntityRecord;
+import io.spine.server.entity.storage.SpecScanner;
+import io.spine.server.storage.MessageRecordSpec;
+import io.spine.server.storage.RecordWithColumns;
 import io.spine.test.storage.StgProject;
 import io.spine.test.storage.StgProject.Status;
 import io.spine.test.storage.StgProjectId;
 import io.spine.test.storage.StgTask;
+import io.spine.testing.core.given.GivenVersion;
 
 import static io.spine.base.Identifier.newUuid;
 import static io.spine.base.Time.currentTime;
@@ -41,6 +52,15 @@
 
 public final class GivenStorageProject {
 
+    private static final MessageRecordSpec<StgProjectId, StgProject> messageSpec =
+            new MessageRecordSpec<>(StgProjectId.class,
+                                    StgProject.class,
+                                    StgProject::getId,
+                                    StgProjectColumns.definitions());
+
+    private static final MessageRecordSpec<StgProjectId, EntityRecord> entityRecordSpec =
+            SpecScanner.scan(StgProjectId.class, StgProject.class);
+
     /**
      * Prevents this utility from instantiation.
      */
@@ -108,4 +128,55 @@ public static StgProject newState() {
         var id = newId();
         return newState(id);
     }
+
+    /**
+     * Returns the record specification for {@code StgProject}.
+     */
+    public static MessageRecordSpec<StgProjectId, StgProject> projectMessageSpec() {
+        return messageSpec;
+    }
+
+    /**
+     * Generates a new {@code StgProject} as Entity,
+     * and wraps it into a {@code RecordWithColumns}.
+     */
+    public static RecordWithColumns<StgProjectId, EntityRecord> newEntityRecord() {
+        var project = newState();
+        var record = EntityRecord.newBuilder()
+                .setEntityId(Identifier.pack(project.getId()))
+                .setVersion(GivenVersion.withNumber(7))
+                .setState(AnyPacker.pack(project))
+                .build();
+        var result = RecordWithColumns.create(record, entityRecordSpec);
+        return result;
+    }
+
+    /**
+     * Columns of {@code StgProject} stored as record.
+     */
+    @RecordColumns(ofType = StgProject.class)
+    public static final class StgProjectColumns {
+
+        private StgProjectColumns() {
+        }
+
+        public static final RecordColumn<StgProject, String> name =
+                RecordColumn.create("name", String.class, StgProject::getName);
+
+        public static final RecordColumn<StgProject, Timestamp> due_date =
+                RecordColumn.create("due_date", Timestamp.class, StgProject::getDueDate);
+
+        public static final RecordColumn<StgProject, Any> state_as_any =
+                RecordColumn.create("state_as_any", Any.class, AnyPacker::pack);
+
+        public static final RecordColumn<StgProject, String> random_non_stored_column =
+                RecordColumn.create("random_non_stored_column", String.class, (p) -> "31415926");
+
+        /**
+         * Returns all the column definitions.
+         */
+        public static Columns<StgProject> definitions() {
+            return Columns.of(name, due_date, state_as_any);
+        }
+    }
 }

server/src/test/java/io/spine/server/storage/memory/RecordQueryMatcherTest.java

@@ -27,18 +27,19 @@
 package io.spine.server.storage.memory;
 
 import io.spine.server.storage.RecordWithColumns;
-import io.spine.server.storage.memory.given.RecordQueryMatcherTestEnv;
-import io.spine.server.storage.memory.given.RecordQueryMatcherTestEnv.StgProjectColumns;
+import io.spine.server.storage.given.GivenStorageProject.StgProjectColumns;
+import io.spine.test.storage.StgProject;
 import io.spine.test.storage.StgProjectId;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import static com.google.common.truth.Truth.assertThat;
 import static io.spine.protobuf.AnyPacker.pack;
 import static io.spine.server.storage.given.GivenStorageProject.newState;
+import static io.spine.server.storage.given.GivenStorageProject.projectMessageSpec;
 import static io.spine.server.storage.memory.given.RecordQueryMatcherTestEnv.newBuilder;
 import static io.spine.server.storage.memory.given.RecordQueryMatcherTestEnv.recordSubject;
-import static io.spine.server.storage.memory.given.RecordQueryMatcherTestEnv.projectSpec;
 import static io.spine.testdata.Sample.messageOfType;
 import static io.spine.testing.TestValues.nullRef;
 
@@ -53,7 +54,7 @@ void matchEverythingToEmpty() {
 
         assertThat(matcher.test(nullRef()))
                 .isFalse();
-        assertThat(matcher.test(RecordWithColumns.create(newState(), projectSpec())))
+        assertThat(matcher.test(asRecord(newState())))
                 .isTrue();
     }
 
@@ -67,8 +68,8 @@ void matchIds() {
         var matcher = new RecordQueryMatcher<>(subject);
         var matching = newState(matchingId);
         var nonMatching = newState(nonMatchingId);
-        var matchingRecord = RecordWithColumns.create(matching, projectSpec());
-        var nonMatchingRecord = RecordWithColumns.create(nonMatching, projectSpec());
+        var matchingRecord = asRecord(matching);
+        var nonMatchingRecord = asRecord(nonMatching);
         assertThat(matcher.test(matchingRecord))
                 .isTrue();
         assertThat(matcher.test(nonMatchingRecord))
@@ -82,23 +83,28 @@ void matchColumns() {
         var matchingName = matchingState.getName();
         var query = newBuilder().where(StgProjectColumns.name).is(matchingName).build();
         var matcher = new RecordQueryMatcher<>(query.subject());
-        var matchingRecord = RecordWithColumns.create(matchingState, projectSpec());
+        var matchingRecord = asRecord(matchingState);
         var nonMatching = newState();
-        var nonMatchingRecord = RecordWithColumns.create(nonMatching, projectSpec());
+        var nonMatchingRecord = asRecord(nonMatching);
 
         assertThat(matcher.test(matchingRecord))
                 .isTrue();
         assertThat(matcher.test(nonMatchingRecord))
                 .isFalse();
     }
 
+    @NonNull
+    private static RecordWithColumns<StgProjectId, StgProject> asRecord(StgProject state) {
+        return RecordWithColumns.create(state, projectMessageSpec());
+    }
+
     @Test
     @DisplayName("match `Any` instances")
     void matchAnyInstances() {
         var matchingState = newState();
         var queryValue = pack(matchingState);
-        var matchingRecord = RecordWithColumns.create(matchingState, projectSpec());
-        var nonMatchingRecord = RecordWithColumns.create(newState(), projectSpec());
+        var matchingRecord = asRecord(matchingState);
+        var nonMatchingRecord = asRecord(newState());
 
         var query = newBuilder()
                 .where(StgProjectColumns.state_as_any).is(queryValue).build();
@@ -117,7 +123,7 @@ void notMatchByWrongField() {
                 .build();
         var matcher = new RecordQueryMatcher<>(query);
 
-        var recordWithColumns = RecordWithColumns.create(newState(), projectSpec());
+        var recordWithColumns = asRecord(newState());
         assertThat(matcher.test(recordWithColumns))
                 .isFalse();
     }

server/src/test/java/io/spine/server/storage/memory/given/RecordQueryMatcherTestEnv.java

@@ -26,45 +26,22 @@
 
 package io.spine.server.storage.memory.given;
 
-import com.google.protobuf.Any;
-import com.google.protobuf.Timestamp;
-import io.spine.protobuf.AnyPacker;
-import io.spine.query.Columns;
-import io.spine.query.RecordColumn;
-import io.spine.query.RecordColumns;
 import io.spine.query.RecordQuery;
 import io.spine.query.RecordQueryBuilder;
 import io.spine.query.Subject;
-import io.spine.server.storage.MessageRecordSpec;
 import io.spine.test.storage.StgProject;
 import io.spine.test.storage.StgProjectId;
 
 /**
  * The test environment for {@link io.spine.server.storage.memory.RecordQueryMatcher} tests.
- *
- * <p>Provides various types of {@linkplain RecordColumn record columns}
- * that can be used to emulate a client-side query.
  */
 @SuppressWarnings("BadImport")       // `create` looks fine in this context.
 public final class RecordQueryMatcherTestEnv {
 
-    private static final MessageRecordSpec<StgProjectId, StgProject> spec =
-            new MessageRecordSpec<>(StgProjectId.class,
-                                    StgProject.class,
-                                    StgProject::getId,
-                                    StgProjectColumns.definitions());
-
     /** Prevents instantiation of this test env class. */
     private RecordQueryMatcherTestEnv() {
     }
 
-    /**
-     * Returns the record specification for {@code StgProject}.
-     */
-    public static MessageRecordSpec<StgProjectId, StgProject> projectSpec() {
-        return spec;
-    }
-
     /**
      * Creates an empty {@code Subject} for the {@code StgProject}.
      */
@@ -95,33 +72,4 @@ private static <I> Class<I> parameterizedClsOf(I id) {
     public static RecordQueryBuilder<StgProjectId, StgProject> newBuilder() {
         return RecordQuery.newBuilder(StgProjectId.class, StgProject.class);
     }
-
-    /**
-     * Columns of {@code StgProject} stored as record.
-     */
-    @RecordColumns(ofType = StgProject.class)
-    public static final class StgProjectColumns {
-
-        private StgProjectColumns() {
-        }
-
-        public static final RecordColumn<StgProject, String> name =
-                RecordColumn.create("name", String.class, StgProject::getName);
-
-        public static final RecordColumn<StgProject, Timestamp> due_date =
-                RecordColumn.create("due_date", Timestamp.class, StgProject::getDueDate);
-
-        public static final RecordColumn<StgProject, Any> state_as_any =
-                RecordColumn.create("state_as_any", Any.class, AnyPacker::pack);
-
-        public static final RecordColumn<StgProject, String> random_non_stored_column =
-                RecordColumn.create("random_non_stored_column", String.class, (p) -> "31415926");
-
-        /**
-         * Returns all the column definitions.
-         */
-        public static Columns<StgProject> definitions() {
-            return Columns.of(name, due_date, state_as_any);
-        }
-    }
 }