Merge pull request #122 from SpineEventEngine/proto-messages-validation

Proto command messages validation

Author: AlexanderLitus

client/build.gradle

@@ -4,7 +4,7 @@ buildscript {
         resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
     }
     dependencies {
-        classpath group: 'org.spine3.tools', name: 'proto-lookup-plugin', version: '1.1', changing: true
+        classpath group: 'org.spine3.tools', name: 'protobuf-plugin', version: '1.2', changing: true
     }
 }
 
@@ -13,7 +13,7 @@ dependencies {
     testCompile project (path: ":testutil", configuration: 'testArtifacts')
 }
 
-apply plugin: 'org.spine3.tools.protolookup';
+apply plugin: 'org.spine3.tools.protobuf-plugin';
 
 sourceSets {
     main {

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

@@ -21,8 +21,10 @@
 package org.spine3.base;
 
 import com.google.common.base.Predicate;
+import com.google.protobuf.Descriptors.FileDescriptor;
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
+import org.spine3.protobuf.EntityPackagesMap;
 import org.spine3.protobuf.Messages;
 import org.spine3.protobuf.Timestamps;
 import org.spine3.time.ZoneOffset;
@@ -45,6 +47,13 @@
  */
 public class Commands {
 
+    /**
+     * A substring which the {@code .proto} file containing commands must have in its name.
+     */
+    public static final String COMMANDS_FILE_SUBSTRING = "commands";
+
+    private static final char PROTO_FILE_SEPARATOR = '/';
+
     private Commands() {}
 
     /**
@@ -179,4 +188,32 @@ public static String formatMessageTypeAndId(String format, Message commandMessag
         final String result = String.format(format, commandType, id);
         return result;
     }
+
+    /**
+     * Checks if the file is for commands.
+     *
+     * @param file a descriptor of a {@code .proto} file to check
+     * @return {@code true} if the file name contains {@link #COMMANDS_FILE_SUBSTRING} substring, {@code false} otherwise
+     */
+    public static boolean isCommandsFile(FileDescriptor file) {
+        final String fqn = file.getName();
+        final int startIndexOfFileName = fqn.lastIndexOf(PROTO_FILE_SEPARATOR) + 1;
+        final String fileName = fqn.substring(startIndexOfFileName);
+        final boolean isCommandsFile = fileName.contains(COMMANDS_FILE_SUBSTRING);
+        return isCommandsFile;
+    }
+
+    /**
+     * Checks if the file belongs to an entity.
+     *
+     * <p>See {@link EntityPackagesMap} for more info.
+     *
+     * @param file a descriptor of a {@code .proto} file to check
+     * @return {@code true} if the file belongs to an entity, {@code false} otherwise
+     */
+    public static boolean isEntityFile(FileDescriptor file) {
+        final String protoPackage = file.getPackage();
+        final boolean isCommandForEntity = EntityPackagesMap.contains(protoPackage);
+        return isCommandForEntity;
+    }
 }

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

@@ -31,7 +31,6 @@
 import com.google.protobuf.UInt32Value;
 import com.google.protobuf.UInt64Value;
 import com.google.protobuf.util.TimeUtil;
-import org.spine3.protobuf.Messages;
 
 import javax.annotation.Nullable;
 import java.util.Collection;
@@ -45,6 +44,8 @@
 import static com.google.common.collect.Maps.newHashMap;
 import static com.google.protobuf.TextFormat.shortDebugString;
 import static org.spine3.protobuf.Messages.fromAny;
+import static org.spine3.protobuf.Messages.toAny;
+import static org.spine3.protobuf.Values.newStringValue;
 
 /**
  * This class manages conversion of identifies to/from string.
@@ -189,16 +190,16 @@ public static <I> Any idToAny(I id) {
         //noinspection IfStatementWithTooManyBranches,ChainOfInstanceofChecks
         if (id instanceof Message) {
             final Message message = (Message) id;
-            anyId = Messages.toAny(message);
+            anyId = toAny(message);
         } else if (id instanceof String) {
             final String strValue = (String) id;
-            anyId = Messages.toAny(StringValue.newBuilder().setValue(strValue).build());
+            anyId = toAny(newStringValue(strValue));
         } else if (id instanceof Integer) {
             final Integer intValue = (Integer) id;
-            anyId = Messages.toAny(UInt32Value.newBuilder().setValue(intValue).build());
+            anyId = toAny(UInt32Value.newBuilder().setValue(intValue).build());
         } else if (id instanceof Long) {
             final Long longValue = (Long) id;
-            anyId = Messages.toAny(UInt64Value.newBuilder().setValue(longValue).build());
+            anyId = toAny(UInt64Value.newBuilder().setValue(longValue).build());
         } else {
             throw unsupportedIdType(id);
         }

client/src/main/java/org/spine3/io/IoUtil.java

@@ -21,28 +21,89 @@
 package org.spine3.io;
 
 import com.google.common.collect.FluentIterable;
+import com.google.common.collect.ImmutableSet;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.spine3.Internal;
 
 import javax.annotation.Nullable;
 import java.io.Closeable;
 import java.io.Flushable;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.URL;
+import java.util.Enumeration;
+import java.util.Properties;
 
 import static com.google.common.base.Throwables.propagate;
 
 /**
- * Utility class working with I/O: streams etc.
+ * A utility class working with I/O: streams, resources, etc.
  *
  * @author Alexander Litus
  */
+@Internal
 public class IoUtil {
 
     private static final String ERROR_MESSAGE = "Exception while closing:";
 
     private IoUtil() {}
 
+    /**
+     * Loads all data from {@code .properties} file(s) into memory.
+     *
+     * <p>Logs {@link IOException} if it occurs.
+     *
+     * @param propsFilePath the path of the {@code .properties} file to load
+     */
+    public static ImmutableSet<Properties> loadAllProperties(String propsFilePath) {
+        final ImmutableSet.Builder<Properties> result = ImmutableSet.builder();
+        final Enumeration<URL> resources = getResources(propsFilePath);
+        if (resources == null) {
+            return result.build();
+        }
+        while (resources.hasMoreElements()) {
+            final URL resourceUrl = resources.nextElement();
+            final Properties properties = loadPropertiesFile(resourceUrl);
+            result.add(properties);
+        }
+        return result.build();
+    }
+
+    private static Enumeration<URL> getResources(String propsFilePath) {
+        final ClassLoader classLoader = getContextClassLoader();
+        Enumeration<URL> resources = null;
+        try {
+            resources = classLoader.getResources(propsFilePath);
+        } catch (IOException e) {
+            if (log().isWarnEnabled()) {
+                log().warn("Failed to load resources: " + propsFilePath, e);
+            }
+        }
+        return resources;
+    }
+
+    private static Properties loadPropertiesFile(URL resourceUrl) {
+        final Properties properties = new Properties();
+        InputStream inputStream = null;
+        try {
+            inputStream = resourceUrl.openStream();
+            properties.load(inputStream);
+        } catch (IOException e) {
+            if (log().isWarnEnabled()) {
+                log().warn("Failed to load properties file.", e);
+            }
+        } finally {
+            close(inputStream);
+        }
+        return properties;
+    }
+
+    private static ClassLoader getContextClassLoader() {
+        return Thread.currentThread().getContextClassLoader();
+    }
+
     /**
      * Closes passed closeables one by one.
      *

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

@@ -0,0 +1,123 @@
+/*
+ * Copyright 2016, TeamDev Ltd. All rights reserved.
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.spine3.protobuf;
+
+import com.google.common.collect.ImmutableSet;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.spine3.Internal;
+import org.spine3.client.EntityType;
+
+import javax.annotation.Nullable;
+import java.util.Map;
+import java.util.Properties;
+import java.util.Set;
+
+import static com.google.common.collect.Maps.newHashMap;
+import static org.spine3.io.IoUtil.loadAllProperties;
+
+/**
+ * A map from Protobuf package to {@link EntityType} (the package contains files for this entity type (aggregate, etc)).
+ *
+ * <p>If there is a {@code state_of} option in the entity state Protobuf message definition,
+ * all files in the current package are considered belonging to the specified type of the entity
+ * (containing entity state, commands, events, etc).
+ *
+ * <p>This information is needed when validating a command to check if it is sent to an entity
+ * (to check entity ID field in the command message).
+ *
+ * @author Alexander Litus
+ */
+@Internal
+public class EntityPackagesMap {
+
+    /**
+     * A path to a file which contains Protobuf packages and appropriate {@link EntityType}s.
+     * Is generated by Gradle during build process.
+     */
+    private static final String PROPS_FILE_PATH = "entities.properties";
+
+    /**
+     * A map from Protobuf package to {@link EntityType}.
+     * The package contains files for this type of entity (aggregate, etc).
+     *
+     * <p>Example:
+     * <p>{@code com.example.order} - {@code AGGREGATE}
+     */
+    private static final Map<String, EntityType> PACKAGES_MAP = buildPackagesMap();
+
+    private EntityPackagesMap() {}
+
+    /**
+     * Returns an entity type for the Protobuf package.
+     *
+     * @param protoPackage a protobuf package name where entity files are located
+     * @return a type of the entity to which the package belongs
+     */
+    @Nullable
+    public static EntityType get(String protoPackage) {
+        final EntityType result = PACKAGES_MAP.get(protoPackage);
+        return result;
+    }
+
+    /**
+     * Returns {@code true} if the map contains an entity type for a Protobuf package, {@code false} otherwise.
+     *
+     * @param protoPackage a protobuf package name where entity files are located
+     * @return {@code true} if the package belongs to an entity
+     */
+    public static boolean contains(String protoPackage) {
+        final EntityType result = get(protoPackage);
+        final boolean contains = result != null;
+        return contains;
+    }
+
+    private static Map<String, EntityType> buildPackagesMap() {
+        final Map<String, EntityType> result = newHashMap();
+        final ImmutableSet<Properties> propertiesSet = loadAllProperties(PROPS_FILE_PATH);
+        for (Properties properties : propertiesSet) {
+            putTo(result, properties);
+        }
+        if (log().isDebugEnabled()) {
+            log().debug("Entry count in EntityPackagesMap: " + result.size());
+        }
+        return result;
+    }
+
+    private static void putTo(Map<String, EntityType> result, Properties properties) {
+        final Set<String> protoPackages = properties.stringPropertyNames();
+        for (String protoPackage : protoPackages) {
+            final String entityTypeStr = properties.getProperty(protoPackage);
+            final EntityType entityType = EntityType.valueOf(entityTypeStr);
+            result.put(protoPackage, entityType);
+        }
+    }
+
+    private enum LogSingleton {
+        INSTANCE;
+        @SuppressWarnings("NonSerializableFieldInSerializableClass")
+        private final Logger value = LoggerFactory.getLogger(EntityPackagesMap.class);
+    }
+
+    private static Logger log() {
+        return LogSingleton.INSTANCE.value;
+    }
+}

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

@@ -208,5 +208,4 @@ public static Descriptors.GenericDescriptor getClassDescriptor(Class<? extends M
             throw new MissingDescriptorException(clazz, e.getCause());
         }
     }
-
 }