Merge pull request #1216 from SpineEventEngine/expose-query-result

Expose Query result in QueryResultSubject

Author: yuri-sergiichuk

config

@@ -12,7 +12,7 @@ all modules and does not describe the project structure per-subproject.
 
 <groupId>io.spine</groupId>
 <artifactId>spine-core-java</artifactId>
-<version>1.3.0</version>
+<version>1.3.1</version>
 
 <inceptionYear>2015</inceptionYear>
 

license-report.md

@@ -918,16 +918,14 @@ public QueryResultSubject assertQueryResult(Query query) {
      *
      * <p>The method may be used as follows:
      * <pre>
-     *     {@code
-     *         VerifyingCounter updateCounter =
-     *               context.assertSubscriptionUpdates(
-     *                       topic,
-     *                       assertEachReceived -> assertEachReceived.comparingExpectedFieldsOnly()
-     *                                                               .isEqualTo(expected)
-     *               );
-     *         context.receivesCommand(createProject); // Some command creating the `expected`.
-     *         updateCounter.verifyEquals(1);
-     *     }
+     * VerifyingCounter updateCounter =
+     *         context.assertSubscriptionUpdates(
+     *                 topic,
+     *                 assertEachReceived -> assertEachReceived.comparingExpectedFieldsOnly()
+     *                                                         .isEqualTo(expected)
+     *         );
+     * context.receivesCommand(createProject); // Some command creating the `expected`.
+     * updateCounter.verifyEquals(1);
      * </pre>
      *
      * <p>Please note that the return value may be ignored, but then receiving {@code 0} incoming

pom.xml

@@ -52,6 +52,12 @@
  *        .containsExactly(state1, state2);
  * </pre>
  *
+ * <p>If the actual queried messages are required, the subject can return them as follows:
+ * <pre>
+ * context.assertQueryResult(query)
+ *        .actual();
+ * </pre>
+ *
  * <p>There are also convenience methods for checking response {@link Status} and received entity
  * {@linkplain Version versions}, as well as some others.
  *
@@ -80,22 +86,12 @@ public final class QueryResultSubject
      */
     private IterableEntityVersionSubject versionsSubject;
 
-    private final Iterable<EntityState> actual;
+    private final ImmutableList<EntityState> actual;
 
     private QueryResultSubject(FailureMetadata failureMetadata,
                                Iterable<EntityState> entityStates) {
         super(failureMetadata, entityStates);
-        this.actual = entityStates;
-    }
-
-    private void initChildSubjects(QueryResponse queryResponse) {
-        Status status = extractStatus(queryResponse);
-        statusSubject = check("getResponse().getStatus()").about(responseStatus())
-                                                          .that(status);
-
-        Iterable<Version> versions = extractEntityVersions(queryResponse);
-        versionsSubject = check("getEntityVersions()").about(entityVersions())
-                                                      .that(versions);
+        this.actual = ImmutableList.copyOf(entityStates);
     }
 
     /**
@@ -104,8 +100,7 @@ private void initChildSubjects(QueryResponse queryResponse) {
      * <p>Unlike other {@code Subject}s, the {@code QueryResultSubject} does not accept
      * {@code null} arguments, as {@code null} {@code QueryResponse} always indicates an error.
      */
-    public static
-    QueryResultSubject assertQueryResult(QueryResponse queryResponse) {
+    public static QueryResultSubject assertQueryResult(QueryResponse queryResponse) {
         checkNotNull(queryResponse, "`QueryResponse` must never be `null`.");
 
         Iterable<EntityState> entityStates = extractEntityStates(queryResponse);
@@ -114,6 +109,23 @@ QueryResultSubject assertQueryResult(QueryResponse queryResponse) {
         return subject;
     }
 
+    private void initChildSubjects(QueryResponse queryResponse) {
+        Status status = extractStatus(queryResponse);
+        statusSubject = check("getResponse().getStatus()").about(responseStatus())
+                                                          .that(status);
+
+        Iterable<Version> versions = extractEntityVersions(queryResponse);
+        versionsSubject = check("getEntityVersions()").about(entityVersions())
+                                                      .that(versions);
+    }
+
+    /**
+     * Obtains the actually queried entity states.
+     */
+    public ImmutableList<EntityState> actual(){
+        return actual;
+    }
+
     /**
      * Verifies the status of the received {@link QueryResponse}.
      */
@@ -135,8 +147,10 @@ public ResponseStatusSubject hasStatusThat() {
      */
     public ProtoSubject containsSingleEntityStateThat() {
         assertContainsSingleItem();
-        EntityState state = actual.iterator().next();
-        ProtoSubject subject = check("singleEntityState()").about(protos()).that(state);
+        EntityState state = actual.iterator()
+                                  .next();
+        ProtoSubject subject = check("singleEntityState()").about(protos())
+                                                           .that(state);
         return subject;
     }
 
@@ -160,7 +174,7 @@ private void assertContainsSingleItem() {
         hasSize(1);
     }
 
-    private static Iterable<EntityState> extractEntityStates(QueryResponse queryResponse) {
+    private static ImmutableList<EntityState> extractEntityStates(QueryResponse queryResponse) {
         ImmutableList<EntityState> result = ImmutableList.copyOf(queryResponse.states());
         return result;
     }
@@ -170,8 +184,9 @@ private static Collection<Version> extractEntityVersions(QueryResponse queryResp
     }
 
     private static Status extractStatus(QueryResponse queryResponse) {
-        return queryResponse.getResponse()
-                            .getStatus();
+        return queryResponse
+                .getResponse()
+                .getStatus();
     }
 
     static Subject.Factory<QueryResultSubject, Iterable<EntityState>> queryResult() {

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBoxBoundedContext.java

@@ -20,6 +20,7 @@
 
 package io.spine.testing.server.blackbox.verify.query;
 
+import com.google.common.collect.ImmutableList;
 import com.google.common.testing.NullPointerTester;
 import com.google.common.truth.Subject;
 import io.spine.base.EntityState;
@@ -29,6 +30,7 @@
 import org.junit.jupiter.api.Test;
 
 import static com.google.common.truth.ExpectFailure.assertThat;
+import static com.google.common.truth.Truth.assertThat;
 import static io.spine.core.Status.StatusCase.ERROR;
 import static io.spine.core.Status.StatusCase.OK;
 import static io.spine.testing.DisplayNames.NOT_ACCEPT_NULLS;
@@ -80,6 +82,14 @@ void checkResponseStatus() {
                          .isEqualTo(OK.toString());
     }
 
+    @Test
+    @DisplayName("return actual query results")
+    void provideActualResults() {
+        QueryResponse response = responseWithMultipleEntities();
+        ImmutableList<EntityState> actualEntities = assertWithSubjectThat(response).actual();
+        assertThat(actualEntities).hasSize(2);
+    }
+
     @Test
     @DisplayName("provide subject for the response status")
     void provideResponseStatusSubject() {
@@ -117,7 +127,7 @@ void provideEntityStateProtoSubject() {
         expectSomeFailure(
                 () -> assertWithSubjectThat(responseWithSingleEntity())
                         .containsSingleEntityStateThat()
-                .isEqualTo(state2())
+                        .isEqualTo(state2())
         );
     }
 

testutil-server/src/main/java/io/spine/testing/server/blackbox/verify/query/QueryResultSubject.java

@@ -25,15 +25,15 @@
  *  as we want to manage the versions in a single source.
  */
 
-final def spineVersion = '1.3.0'
+final def spineVersion = '1.3.1'
 
 ext {
     // The version of the modules in this project.
     versionToPublish = spineVersion
 
     // Depend on `base` for the general definitions and a model compiler.
-    spineBaseVersion = spineVersion
+    spineBaseVersion = '1.3.0'
 
     // Depend on `time` for `ZoneId`, `ZoneOffset` and other date/time types and utilities.
-    spineTimeVersion = spineVersion
+    spineTimeVersion = '1.3.0'
 }