Merge pull request #186 from SpineEventEngine/enrichment-enhancement

Enhancements for testing

Author: alexander-yevsyukov

build.gradle

@@ -54,7 +54,7 @@ allprojects {
     apply plugin: 'idea'
 
     group = 'org.spine3'
-    version = '0.5.9-SNAPSHOT'
+    version = '0.5.18-SNAPSHOT'
 }
 
 ext {

client/src/main/java/org/spine3/base/Mismatch.java

@@ -20,16 +20,19 @@
 
 package org.spine3.base;
 
-import com.google.protobuf.Any;
 import com.google.protobuf.Message;
 import org.spine3.protobuf.AnyPacker;
 
 import javax.annotation.Nullable;
 
 import static org.spine3.protobuf.Values.pack;
 
-
-/** Factories for constructing {@link ValueMismatch} instances for different types of attributes. */
+/**
+ * Factories for constructing {@link ValueMismatch} instances for different types of attributes.
+ *
+ * @author Alexander Yevsyukov
+ * @author Andrey Lavrov
+ */
 public class Mismatch {
 
     private Mismatch() {
@@ -38,148 +41,120 @@ private Mismatch() {
     /**
      * Creates a {@link ValueMismatch} instance for a string attribute.
      *
-     * @param expected  the value expected by a command, or {@code null} if the command expects not populated field
-     * @param actual     the value found in an entity, or {@code null} if the value is not set
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command, or {@code null} if the command expects not populated field
+     * @param actual   the value found in an entity, or {@code null} if the value is not set
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(@Nullable String expected, @Nullable String actual, String requested, int version) {
+    public static ValueMismatch of(@Nullable String expected, @Nullable String actual, int version) {
         final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
         if (expected != null) {
             builder.setExpected(pack(expected));
         }
-
         if (actual != null) {
             builder.setActual(pack(actual));
         }
-
-        builder.setRequested(pack(requested));
         builder.setVersion(version);
-
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a integer attribute.
      *
-     * @param expected  the value expected by a command
-     * @param actual     the value actual in an entity
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command
+     * @param actual   the value actual in an entity
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(int expected, int actual, int requested, int version) {
-        final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-        builder.setExpected(pack(expected));
-        builder.setActual(pack(actual));
-        builder.setRequested(pack(requested));
-        builder.setVersion(version);
-
+    public static ValueMismatch of(int expected, int actual, int version) {
+        final ValueMismatch.Builder builder = ValueMismatch.newBuilder()
+                                                           .setExpected(pack(expected))
+                                                           .setActual(pack(actual))
+                                                           .setVersion(version);
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a long integer attribute.
      *
-     * @param expected  the value expected by a command
-     * @param actual     the value actual in an entity
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command
+     * @param actual   the value actual in an entity
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(long expected, long actual, long requested, int version) {
-        final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-        builder.setExpected(pack(expected));
-        builder.setActual(pack(actual));
-        builder.setRequested(pack(requested));
-        builder.setVersion(version);
-
+    public static ValueMismatch of(long expected, long actual, int version) {
+        final ValueMismatch.Builder builder = ValueMismatch.newBuilder()
+                                                           .setExpected(pack(expected))
+                                                           .setActual(pack(actual))
+                                                           .setVersion(version);
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a float attribute.
      *
-     * @param expected  the value expected by a command
-     * @param actual     the value actual in an entity
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command
+     * @param actual   the value actual in an entity
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(float expected, float actual, float requested, int version) {
-        final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-        builder.setExpected(pack(expected));
-        builder.setActual(pack(actual));
-        builder.setRequested(pack(requested));
-        builder.setVersion(version);
-
+    public static ValueMismatch of(float expected, float actual, int version) {
+        final ValueMismatch.Builder builder = ValueMismatch.newBuilder()
+                                                           .setExpected(pack(expected))
+                                                           .setActual(pack(actual))
+                                                           .setVersion(version);
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a double attribute.
      *
-     * @param expected  the value expected by a command
-     * @param actual     the value actual in an entity
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command
+     * @param actual   the value actual in an entity
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(double expected, double actual, double requested, int version) {
-        final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-        builder.setExpected(pack(expected));
-        builder.setActual(pack(actual));
-        builder.setRequested(pack(requested));
-        builder.setVersion(version);
-
+    public static ValueMismatch of(double expected, double actual, int version) {
+        final ValueMismatch.Builder builder = ValueMismatch.newBuilder()
+                                                           .setExpected(pack(expected))
+                                                           .setActual(pack(actual))
+                                                           .setVersion(version);
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a boolean attribute.
      *
-     * @param expected  the value expected by a command
-     * @param actual     the value actual in an entity
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command
+     * @param actual   the value actual in an entity
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(boolean expected, boolean actual, boolean requested, int version) {
-        final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-        builder.setExpected(pack(expected));
-        builder.setActual(pack(actual));
-        builder.setRequested(pack(requested));
-        builder.setVersion(version);
-
+    public static ValueMismatch of(boolean expected, boolean actual, int version) {
+        final ValueMismatch.Builder builder = ValueMismatch.newBuilder()
+                                                           .setExpected(pack(expected))
+                                                           .setActual(pack(actual))
+                                                           .setVersion(version);
         return builder.build();
     }
 
     /**
      * Creates a {@link ValueMismatch} instance for a Message attribute.
      *
-     * @param expected  the value expected by a command, or {@code null} if the command expects not populated field
-     * @param actual     the value actual in an entity, or {@code null} if the value is not set
-     * @param requested the value requested as new one in the original command
-     * @param version   the current version of the entity
+     * @param expected the value expected by a command, or {@code null} if the command expects not populated field
+     * @param actual   the value actual in an entity, or {@code null} if the value is not set
+     * @param version  the current version of the entity
      * @return info on the mismatch
      */
-    public static ValueMismatch of(@Nullable Message expected, @Nullable Message actual, Message requested, int version) {
+    public static ValueMismatch of(@Nullable Message expected, @Nullable Message actual, int version) {
         final ValueMismatch.Builder builder = ValueMismatch.newBuilder();
-
         if (expected != null) {
             builder.setExpected(AnyPacker.pack(expected));
         }
-
         if (actual != null) {
             builder.setActual(AnyPacker.pack(actual));
         }
-
-        final Any requestedAny = AnyPacker.pack(requested);
-
-        builder.setRequested(requestedAny);
         builder.setVersion(version);
-
         return builder.build();
     }
 }

client/src/main/java/org/spine3/protobuf/Timestamps.java

@@ -109,6 +109,17 @@ public static Timestamp getCurrentTime() {
         return result;
     }
 
+    /**
+     * Obtains system time.
+     *
+     * <p>Unlike {@link #getCurrentTime()} this method <strong>always</strong> uses system time millis.
+     *
+     * @return current system time
+     */
+    public static Timestamp systemTime() {
+        return com.google.protobuf.util.Timestamps.fromMillis(System.currentTimeMillis());
+    }
+
     /**
      * The provider of the current time.
      *
@@ -133,6 +144,13 @@ public static void setProvider(Provider provider) {
         timeProvider.set(checkNotNull(provider));
     }
 
+    /**
+     * Sets the default current time provider that obtains current time from system millis.
+     */
+    public static void resetProvider() {
+        timeProvider.set(new SystemTimeProvider());
+    }
+
     /**
      * Default implementation of current time provider based on {@link System#currentTimeMillis()}.
      *

client/src/main/proto/spine/base/command.proto

@@ -32,6 +32,7 @@ import "google/protobuf/duration.proto";
 import "google/protobuf/any.proto";
 
 import "spine/annotations.proto";
+import "spine/validate.proto";
 import "spine/users/user_id.proto";
 import "spine/users/tenant_id.proto";
 import "spine/time/zone_offset.proto";
@@ -57,32 +58,38 @@ message CommandId {
 // There should be <strong>one and only one</strong> command handler associated with the type of the command.
 //
 message Command {
+
     // The message of the command wrapped into `Any`.
-    google.protobuf.Any message = 1;
+    google.protobuf.Any message = 1 [(required).value = true];
 
     // Service information about the environment in which the command was created.
-    CommandContext context = 2;
+    CommandContext context = 2 [(required).value = true];
 }
 
 // Meta-information about the command and the environment, which generated the command.
 message CommandContext {
+
     // The id of the command.
-    CommandId command_id = 1;
+    CommandId command_id = 1 [(required).value = true];
 
     // The user who created the command.
-    users.UserId actor = 2;
+    users.UserId actor = 2 [(required).value = true];
 
     // The time when the command was created.
-    google.protobuf.Timestamp timestamp = 3;
+    google.protobuf.Timestamp timestamp = 3 [(required).value = true];
 
     // The zone offset from which the command is made.
-    time.ZoneOffset zone_offset = 4;
+    time.ZoneOffset zone_offset = 4 [(required).value = true];
 
     // The ID of a tenant in a multitenant application.
+    //
+    // This field is not populated in single-tenant applications.
+    //
     users.TenantId tenant_id = 5;
 
     // A command may be scheduled. This type defines scheduling options.
     message Schedule {
+
         // The delay between the moment of receiving a command at the server and its delivery to the target.
         google.protobuf.Duration delay = 1;
 
@@ -101,12 +108,15 @@ message CommandContext {
     Schedule schedule = 6;
 
     // The version of the entity for which this command is intended.
+    //
     // A client app may not fill in this attribute if the command applies to any version of the entity.
+    //
     int32 target_version = 7;
 }
 
 // Enumeration of possible failures when validating a command.
 enum CommandValidationError {
+
     // Reserved value.
     UNKNOWN = 0;
 
@@ -122,6 +132,7 @@ enum CommandValidationError {
 
 // This enumeration defines possible statuses of command processing.
 enum CommandStatus {
+
     // Reserved value.
     UNDEFINED = 0;
 

client/src/main/proto/spine/base/failure.proto

@@ -32,6 +32,7 @@ import "google/protobuf/timestamp.proto";
 import "google/protobuf/struct.proto";
 
 import "spine/annotations.proto";
+import "spine/validate.proto";
 
 // A business failure is a condition in business, which does not allow to
 // satisfy a request or perform an operation.
@@ -41,33 +42,37 @@ import "spine/annotations.proto";
 // See `spine.base.Error` for definition of a technical error.
 //
 message Failure {
+
     // The instance of the failure generated by an aggregate or another part of business logic code.
-    google.protobuf.Any instance = 1;
+    google.protobuf.Any instance = 1 [(required).value = true];
 
     // A stacktrace of from the code, which generated the failure instance (if available).
     string stacktrace = 2;
 
     // The moment when the failure instance (not this message) was created.
-    google.protobuf.Timestamp timestamp = 3;
+    google.protobuf.Timestamp timestamp = 3 [(required).value = true];
 
     // Additional information on the failure.
     map<string, google.protobuf.Value> attributes = 4;
 }
 
-// A failure to handle a command because an entity contains a value different than requested in a command.
+// A failure to handle a command because an entity contains a value different than expected in a command.
 message ValueMismatch {
-    // An expected value.
+
+    option (required_field) = "expected|actual";
+
+    // A value which a command expected in an entity field.
+    //
     // This field is not populated if the command expects to initialize the attribute.
+    //
     google.protobuf.Any expected = 1;
 
     // An actual value in the entity.
+    //
     // This field is not populated if the entity does not have the attribute set.
+    //
     google.protobuf.Any actual = 2;
 
-    // An optional attribute that may contain a value requested as the replacement
-    // for the `expected` value in the failed command.
-    google.protobuf.Any requested = 3;
-
-    // A version of the entity, which generated the failure.
-    int32 version = 4;
-}
+    // A version of the entity which generated the failure.
+    int32 version = 3 [(required).value = true];
+}