Update artifact id representation [ECR-4041] (#1349)

Added version to artifact id, to match the ArtifactId used
in core.

Author: bullet-tooth

exonum-java-binding/CHANGELOG.md

@@ -49,6 +49,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   to require throwing `ExecutionException` instead of
   `IllegalArgumentException`.
 - Transaction index in block type changed from `long` to `int`. (#1348)
+- Extracted artifact version to the separate field from the artifact name.
+  Artifact name format is `groupId/artifactId` now.
+  PluginId format is `runtimeId:artifactName:artifactVersion` now. (#1349) 
 
 ### Removed
 - Classes supporting no longer used tree-like list proof representation.

exonum-java-binding/core/rust/exonum-java/qa-service.yml

@@ -18,12 +18,14 @@ plugins:
 artifacts:
   qa-service:
     runtime: java
-    name: "com.exonum.binding:exonum-java-binding-qa-service:0.10.0-SNAPSHOT"
+    name: "com.exonum.binding/exonum-java-binding-qa-service"
+    version: "0.10.0-SNAPSHOT"
     spec:
       artifact_filename: "exonum-java-binding-qa-service-0.10.0-SNAPSHOT-artifact.jar"
   time:
     runtime: rust
-    name: "exonum-time:0.13.0-rc.2"
+    name: "exonum-time"
+    version: "0.13.0-rc.2"
 
 instances:
   qa-service:

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/JavaArtifactNames.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2019 The Exonum Team
+ *
+ * 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 com.exonum.binding.core.runtime;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+final class JavaArtifactUtils {
+  private static final Pattern FORBIDDEN_CHARS_PATTERN = Pattern.compile("[\\s]");
+
+  /**
+   * Validates the string representation of the artifact id for forbidden characters.
+   * @throws IllegalArgumentException if any forbidden characters found
+   */
+  static void checkNoForbiddenChars(String artifactId) {
+    Matcher matcher = FORBIDDEN_CHARS_PATTERN.matcher(artifactId);
+    if (matcher.find()) {
+      throw new IllegalArgumentException(String.format("'%s' must not have any forbidden "
+              + "characters, but there is '%s' at index %d",
+          artifactId, matcher.group(), matcher.start()));
+    }
+  }
+
+  private JavaArtifactUtils() {
+  }
+}

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/JavaArtifactUtils.java

@@ -16,6 +16,7 @@
 
 package com.exonum.binding.core.runtime;
 
+import static com.exonum.binding.core.runtime.RuntimeId.JAVA;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.base.Preconditions.checkState;
@@ -48,7 +49,8 @@ final class Pf4jServiceLoader implements ServiceLoader {
 
   private static final Comparator<ServiceArtifactId> SERVICE_ID_COMPARATOR =
       // No need to compare id — it is always Java
-      Comparator.comparing(ServiceArtifactId::getName);
+      Comparator.comparing(ServiceArtifactId::getName)
+          .thenComparing(ServiceArtifactId::getVersion);
 
   private final PluginManager pluginManager;
   private final ClassLoadingScopeChecker classLoadingChecker;
@@ -131,8 +133,11 @@ private LoadedServiceDefinition loadDefinition(String pluginId) throws ServiceLo
   private static ServiceArtifactId extractServiceId(String pluginId)
       throws ServiceLoadingException {
     try {
-      JavaArtifactNames.checkArtifactName(pluginId);
-      return ServiceArtifactId.newJavaId(pluginId);
+      ServiceArtifactId serviceArtifactId = ServiceArtifactId.parseFrom(pluginId);
+      checkArgument(serviceArtifactId.getRuntimeId() == JAVA.getId(),
+          "Required Java (%s) runtime id, but actually was %s",
+          JAVA.getId(), serviceArtifactId.getRuntimeId());
+      return serviceArtifactId;
     } catch (IllegalArgumentException e) {
       String message = String.format(
           "Invalid plugin id (%s) is specified in service artifact metadata", pluginId);
@@ -189,8 +194,7 @@ public Optional<LoadedServiceDefinition> findService(ServiceArtifactId artifactI
   @Override
   public void unloadService(ServiceArtifactId artifactId) {
     checkArgument(loadedServices.containsKey(artifactId), "No such artifactId: %s", artifactId);
-
-    String pluginId = artifactId.getName();
+    String pluginId = artifactId.toString();
     try {
       boolean stopped = pluginManager.unloadPlugin(pluginId);
       // The docs don't say why it may fail to stop the plugin.
@@ -210,7 +214,7 @@ public void unloadAll() {
     // Unload the plugins
     List<Exception> errors = new ArrayList<>();
     for (ServiceArtifactId artifactId : loadedServices.keySet()) {
-      String pluginId = artifactId.getName();
+      String pluginId = artifactId.toString();
       try {
         unloadPlugin(pluginId);
       } catch (Exception e) {

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/Pf4jServiceLoader.java

@@ -21,53 +21,65 @@
 import static java.lang.Integer.parseInt;
 import static org.apache.logging.log4j.util.Strings.isNotBlank;
 
+import com.exonum.core.messages.Runtime.ArtifactId;
 import com.google.auto.value.AutoValue;
 
 /**
  * A service artifact identifier. It consists of the runtime id in which the service shall be
- * deployed and the service artifact name. The name of Java artifacts usually contains the three
- * coordinates identifying any Java artifact: groupId, artifactId and version.
+ * deployed, the service artifact name and its version.
  *
  * <p>The extensions of this class must be immutable and hence thread-safe.
  */
 @AutoValue
 public abstract class ServiceArtifactId {
 
   private static final String DELIMITER = ":";
-  private static final int NUM_FIELDS = 2;
+  private static final int KEEP_EMPTY = -1;
 
   /**
    * Returns the runtime id in which the service shall be deployed.
    */
   public abstract int getRuntimeId();
 
   /**
-   * Returns the full artifact name of this service (e.g., "com.acme:land-registry:1.2.0").
+   * Returns the artifact name of this service.
+   * The name of Java artifacts usually (but not necessary) contains the two coordinates:
+   * groupId and artifactId separated by "/" (e.g., "com.acme/land-registry").
    */
   public abstract String getName();
 
   /**
-   * Parses a service id in format "runtimeId:serviceName" as {@link #toString()} produces.
+   * Returns the artifact version of this service (e.g., "1.2.0").
+   */
+  public abstract String getVersion();
+
+  /**
+   * Parses a service id in format "runtimeId:serviceName:version" as {@link #toString()} produces.
    *
-   * @param serviceArtifactId a string in format "runtimeId:serviceName". Whitespace
+   * @param serviceArtifactId a string in format "runtimeId:serviceName:version". Whitespace
    *     characters, including preceding and trailing, are not allowed
    * @return a ServiceArtifactId with the given coordinates
    * @throws IllegalArgumentException if the format is not correct
    */
   public static ServiceArtifactId parseFrom(String serviceArtifactId) {
-    String[] coordinates = serviceArtifactId.split(DELIMITER, NUM_FIELDS);
+    JavaArtifactUtils.checkNoForbiddenChars(serviceArtifactId);
+    String[] coordinates = serviceArtifactId.split(DELIMITER, KEEP_EMPTY);
+    checkArgument(coordinates.length == 3,
+        "Invalid artifact id (%s), must have 'runtimeId:artifactName:version' format",
+        serviceArtifactId);
     int runtimeId = parseInt(coordinates[0]);
     String name = coordinates[1];
-    return valueOf(runtimeId, name);
+    String version = coordinates[2];
+    return valueOf(runtimeId, name, version);
   }
 
   /**
    * Creates a new service artifact id of a Java artifact.
    *
    * @param name the name of the service; must not be blank
    */
-  public static ServiceArtifactId newJavaId(String name) {
-    return valueOf(JAVA.getId(), name);
+  public static ServiceArtifactId newJavaId(String name, String version) {
+    return valueOf(JAVA.getId(), name, version);
   }
 
   /**
@@ -76,16 +88,24 @@ public static ServiceArtifactId newJavaId(String name) {
    * @param runtimeId the runtime id in which the service shall be deployed
    * @param name the name of the service; must not be blank
    */
-  public static ServiceArtifactId valueOf(int runtimeId, String name) {
+  public static ServiceArtifactId valueOf(int runtimeId, String name, String version) {
     checkArgument(isNotBlank(name), "name is blank: '%s'", name);
-    return new AutoValue_ServiceArtifactId(runtimeId, name);
+    checkArgument(isNotBlank(version), "version is blank: '%s'", version);
+    return new AutoValue_ServiceArtifactId(runtimeId, name, version);
+  }
+
+  /**
+   * Creates a new service artifact from the given artifact id message.
+   */
+  public static ServiceArtifactId fromProto(ArtifactId artifactId) {
+    return valueOf(artifactId.getRuntimeId(), artifactId.getName(), artifactId.getVersion());
   }
 
   /**
-   * Returns an artifact id in the following format: "runtimeId:serviceName".
+   * Returns an artifact id in the following format: "runtimeId:serviceName:version".
    */
   @Override
   public final String toString() {
-    return getRuntimeId() + DELIMITER + getName();
+    return getRuntimeId() + DELIMITER + getName() + DELIMITER + getVersion();
   }
 }

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceArtifactId.java

@@ -75,36 +75,51 @@ void initialize(long nodeNativeHandle) {
   /**
    * Deploys the Java service artifact.
    *
-   * @param name the Java service artifact name in format "groupId:artifactId:version"
+   * @param artifactId bytes representation of the Java service artifact id as a serialized message
    * @param deploySpec the deploy specification as a serialized
    *     {@link com.exonum.binding.core.runtime.DeployArguments}
    *     protobuf message
    * @throws IllegalArgumentException if the deploy specification or id are not valid
    * @throws ServiceLoadingException if the runtime failed to load the service or it is not correct
    * @see ServiceRuntime#deployArtifact(ServiceArtifactId, String)
    */
-  void deployArtifact(String name, byte[] deploySpec) throws ServiceLoadingException {
-    DeployArguments deployArguments = parseDeployArgs(name, deploySpec);
+  void deployArtifact(byte[] artifactId, byte[] deploySpec) throws ServiceLoadingException {
+    ArtifactId artifact = parseArtifact(artifactId);
+    ServiceArtifactId javaArtifactId = ServiceArtifactId.fromProto(artifact);
+
+    DeployArguments deployArguments = parseDeployArgs(javaArtifactId, deploySpec);
     String artifactFilename = deployArguments.getArtifactFilename();
 
-    serviceRuntime.deployArtifact(ServiceArtifactId.newJavaId(name), artifactFilename);
+    serviceRuntime.deployArtifact(javaArtifactId, artifactFilename);
   }
 
   /**
    * Returns true if the artifact with the given name is deployed in this runtime;
    * false — otherwise.
-   * @param name the service artifact name in format "groupId:artifactId:version"
+   * @param artifactId bytes representation of the service artifact
    */
-  boolean isArtifactDeployed(String name) {
-    ServiceArtifactId artifactId = ServiceArtifactId.newJavaId(name);
-    return serviceRuntime.isArtifactDeployed(artifactId);
+  boolean isArtifactDeployed(byte[] artifactId) {
+    ArtifactId artifact = parseArtifact(artifactId);
+    ServiceArtifactId serviceArtifact = ServiceArtifactId.newJavaId(
+        artifact.getName(), artifact.getVersion());
+    return serviceRuntime.isArtifactDeployed(serviceArtifact);
   }
 
-  private static DeployArguments parseDeployArgs(String name, byte[] deploySpec) {
+  private static DeployArguments parseDeployArgs(ServiceArtifactId artifact, byte[] deploySpec) {
     try {
       return DeployArguments.parseFrom(deploySpec);
     } catch (InvalidProtocolBufferException e) {
-      String message = "Invalid deploy specification for " + name;
+      String message = "Invalid deploy specification for artifact " + artifact;
+      logger.error(message, e);
+      throw new IllegalArgumentException(message, e);
+    }
+  }
+
+  private static ArtifactId parseArtifact(byte[] artifactId) {
+    try {
+      return ArtifactId.parseFrom(artifactId);
+    } catch (InvalidProtocolBufferException e) {
+      String message = "Invalid artifact";
       logger.error(message, e);
       throw new IllegalArgumentException(message, e);
     }
@@ -156,8 +171,7 @@ private static ServiceInstanceSpec parseInstanceSpec(byte[] instanceSpec) {
     try {
       InstanceSpec spec = InstanceSpec.parseFrom(instanceSpec);
       ArtifactId artifact = spec.getArtifact();
-      ServiceArtifactId artifactId = ServiceArtifactId.valueOf(artifact.getRuntimeId(),
-          artifact.getName());
+      ServiceArtifactId artifactId = ServiceArtifactId.fromProto(artifact);
       return ServiceInstanceSpec.newInstance(spec.getName(), spec.getId(), artifactId);
     } catch (InvalidProtocolBufferException e) {
       logger.error(e);

exonum-java-binding/core/src/main/java/com/exonum/binding/core/runtime/ServiceRuntimeAdapter.java

@@ -45,7 +45,7 @@ void setUp() {
 
   @Test
   void createService() {
-    ServiceArtifactId artifactId = ServiceArtifactId.newJavaId("com.acme:foo-service:1.0.0");
+    ServiceArtifactId artifactId = ServiceArtifactId.newJavaId("com.acme/foo-service", "1.0.0");
     LoadedServiceDefinition serviceDefinition = LoadedServiceDefinition
         .newInstance(artifactId, TestServiceModule::new);
     ServiceInstanceSpec instanceSpec = ServiceInstanceSpec.newInstance(TEST_NAME,
@@ -62,7 +62,8 @@ void createService() {
 
   @Test
   void createServiceFailsIfNoServiceBindingsInModule() {
-    ServiceArtifactId artifactId = ServiceArtifactId.newJavaId("com.acme:incomplete-service:1.0.0");
+    ServiceArtifactId artifactId = ServiceArtifactId
+        .newJavaId("com.acme/incomplete-service", "1.0.0");
     LoadedServiceDefinition serviceDefinition = LoadedServiceDefinition
         .newInstance(artifactId, IncompleteServiceModule::new);
     ServiceInstanceSpec instanceSpec = ServiceInstanceSpec.newInstance(TEST_NAME,