WIP Make QA service configurable [ECR-3869]

[skip ci]

Author: dmitry-timofeev

exonum-java-binding/qa-service/pom.xml

@@ -172,6 +172,7 @@
           <execution>
             <goals>
               <goal>compile</goal>
+              <goal>test-compile</goal>
             </goals>
             <configuration>
               <protocArtifact>

exonum-java-binding/qa-service/src/main/java/com/exonum/binding/qaservice/QaService.java

@@ -18,6 +18,7 @@
 
 import com.exonum.binding.common.crypto.PublicKey;
 import com.exonum.binding.common.hash.HashCode;
+import com.exonum.binding.core.service.Configurable;
 import com.exonum.binding.core.service.Node;
 import com.exonum.binding.core.service.Service;
 import com.exonum.binding.core.transaction.RawTransaction;
@@ -29,7 +30,7 @@
 /**
  * A simple service for QA purposes.
  */
-public interface QaService extends Service {
+public interface QaService extends Service, Configurable {
 
   /**
    * Creates a new self-signed 'increment counter' transaction and submits

exonum-java-binding/qa-service/src/main/java/com/exonum/binding/qaservice/QaServiceImpl.java

@@ -101,7 +101,7 @@ public List<HashCode> getStateHashes(Snapshot snapshot) {
   @Override
   public void initialize(Fork fork, Configuration configuration) {
     // Init the time oracle
-    initTimeOracle(fork, configuration);
+    updateTimeOracle(fork, configuration);
 
     // Add a default counter to the blockchain.
     createCounter(DEFAULT_COUNTER_NAME, fork);
@@ -110,20 +110,6 @@ public void initialize(Fork fork, Configuration configuration) {
     createCounter(AFTER_COMMIT_COUNTER_NAME, fork);
   }
 
-  private void initTimeOracle(Fork fork, Configuration configuration) {
-    QaSchema schema = createDataSchema(fork);
-    InitialConfiguration config = configuration.getAsMessage(InitialConfiguration.class);
-    String timeOracleName = config.getTimeOracleName();
-    // Check the time oracle name is non-empty.
-    // We do *not* check if the time oracle is active to (a) allow running this service with
-    // reduced read functionality without time oracle; (b) testing time schema when it is not
-    // active.
-    checkArgument(!Strings.isNullOrEmpty(timeOracleName), "Empty time oracle name: %s",
-        timeOracleName);
-    // Save the configuration
-    schema.timeOracleName().set(timeOracleName);
-  }
-
   private void createCounter(String name, Fork fork) {
     QaSchema schema = createDataSchema(fork);
     MapIndex<HashCode, Long> counters = schema.counters();
@@ -231,4 +217,37 @@ private HashCode submitTransaction(RawTransaction rawTransaction) {
   private void checkBlockchainInitialized() {
     checkState(node != null, "Service has not been fully initialized yet");
   }
+
+  @Override
+  public void verifyConfiguration(Fork fork, Configuration configuration) {
+    InitialConfiguration config = configuration.getAsMessage(InitialConfiguration.class);
+    checkConfiguration(config);
+  }
+
+  @Override
+  public void applyConfiguration(Fork fork, Configuration configuration) {
+    updateTimeOracle(fork, configuration);
+  }
+
+  private void checkConfiguration(InitialConfiguration config) {
+    String timeOracleName = config.getTimeOracleName();
+    // Check the time oracle name is non-empty.
+    // We do *not* check if the time oracle is active to (a) allow running this service with
+    // reduced read functionality without time oracle; (b) testing time schema when it is not
+    // active.
+    checkArgument(!Strings.isNullOrEmpty(timeOracleName), "Empty time oracle name: %s",
+        timeOracleName);
+  }
+
+  private void updateTimeOracle(Fork fork, Configuration configuration) {
+    QaSchema schema = createDataSchema(fork);
+    InitialConfiguration config = configuration.getAsMessage(InitialConfiguration.class);
+
+    // Verify the configuration
+    checkConfiguration(config);
+
+    // Save the configuration
+    String timeOracleName = config.getTimeOracleName();
+    schema.timeOracleName().set(timeOracleName);
+  }
 }

exonum-java-binding/qa-service/src/test/java/com/exonum/binding/qaservice/QaServiceImplTest.java

@@ -38,6 +38,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import com.exonum.binding.common.blockchain.ExecutionStatuses;
 import com.exonum.binding.common.crypto.KeyPair;
 import com.exonum.binding.common.crypto.PublicKey;
 import com.exonum.binding.common.hash.HashCode;
@@ -46,12 +47,16 @@
 import com.exonum.binding.core.storage.database.Snapshot;
 import com.exonum.binding.core.storage.indices.MapIndex;
 import com.exonum.binding.qaservice.Config.InitialConfiguration;
+import com.exonum.binding.qaservice.Service.ConfigChange;
+import com.exonum.binding.qaservice.Service.ConfigPropose;
+import com.exonum.binding.qaservice.Service.ServiceConfig;
 import com.exonum.binding.testkit.EmulatedNode;
 import com.exonum.binding.testkit.FakeTimeProvider;
 import com.exonum.binding.testkit.TestKit;
 import com.exonum.binding.testkit.TestKitExtension;
 import com.exonum.binding.testkit.TimeProvider;
 import com.exonum.core.messages.Blockchain.Config;
+import com.exonum.core.messages.Runtime.ExecutionStatus;
 import com.google.common.collect.ImmutableMap;
 import com.google.gson.reflect.TypeToken;
 import io.vertx.core.MultiMap;
@@ -137,6 +142,47 @@ void initializeBadConfig() {
     assertThrows(RuntimeException.class, testKitBuilder::build);
   }
 
+  @Test
+  void reconfigureService(TestKit testKit) {
+    KeyPair serviceKeyPair = testKit.getEmulatedNode().getServiceKeyPair();
+    // Determine the config application height
+    long nextHeight = 1 + testKit.applySnapshot(s -> Blockchain.newInstance(s)
+        .getHeight());
+
+    // Propose the config change
+    String newTimeOracleName = "mars-time";
+    ConfigPropose propose = ConfigPropose.newBuilder()
+        .setActualFrom(nextHeight)
+        .addChanges(ConfigChange.newBuilder()
+            .setService(ServiceConfig.newBuilder()
+                .setInstanceId(QA_SERVICE_ID)
+                .setParams(InitialConfiguration.newBuilder()
+                    .setTimeOracleName(newTimeOracleName)
+                    .build()
+                    .toByteString())
+                .build())
+            .build())
+        .build();
+    TransactionMessage proposeTx = TransactionMessage.builder()
+        // fixme: constants
+        .serviceId(0)
+        .transactionId(2)
+        .payload(propose.toByteArray())
+        .sign(serviceKeyPair);
+    testKit.createBlockWithTransactions(proposeTx);
+
+    // Check the proposal status
+    Snapshot s = testKit.getSnapshot();
+    Optional<ExecutionStatus> proposalStatus = Blockchain.newInstance(s)
+        .getTxResult(proposeTx.hash());
+    assertThat(proposalStatus).hasValue(ExecutionStatuses.success());
+
+    // Check the application status
+    QaSchema qaSchema = new QaSchema(s, QA_SERVICE_NAME);
+    Optional<String> actualTimeOracle = qaSchema.timeOracleName().toOptional();
+    assertThat(actualTimeOracle).hasValue(newTimeOracleName);
+  }
+
   @Test
   void afterCommit(TestKit testKit) {
     // Create a block so that the transaction, submitted in after commit handler,

exonum-java-binding/qa-service/src/test/proto/service.proto

@@ -0,0 +1,90 @@
+// 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.
+
+syntax = "proto3";
+
+package exonum.supervisor;
+
+option java_package = "com.exonum.binding.qaservice";
+
+import "types.proto";
+import "runtime.proto";
+import "blockchain.proto";
+
+// Transactions
+
+// Request for the artifact deployment.
+message DeployRequest {
+  // Artifact identifier.
+  exonum.runtime.ArtifactId artifact = 1;
+  // Additional information for Runtime to deploy.
+  bytes spec = 2;
+  // The height until which the deployment procedure should be completed.
+  uint64 deadline_height = 3;
+}
+
+// Confirmation that the artifact was successfully deployed by the validator.
+message DeployConfirmation {
+  // Artifact identifier.
+  exonum.runtime.ArtifactId artifact = 1;
+}
+
+// Request for the start service instance
+message StartService {
+  // Artifact identifier.
+  exonum.runtime.ArtifactId artifact = 1;
+  // Instance name.
+  string name = 2;
+  // Instance configuration.
+  bytes config = 3;
+}
+
+// Configuration parameters of the certain service instance.
+message ServiceConfig {
+  // Corresponding service instance ID.
+  uint32 instance_id = 1;
+  // Raw bytes representation of service configuration parameters.
+  bytes params = 2;
+}
+
+// This message contains one atomic configuration change.
+message ConfigChange {
+  oneof message {
+    // New consensus config.
+    exonum.Config consensus = 1;
+    // New service instance config.
+    ServiceConfig service = 2;
+    // New service instance start request.
+    StartService start_service = 3;
+  }
+}
+
+// Request for the configuration change
+message ConfigPropose {
+  // The height until which the update configuration procedure should be completed.
+  uint64 actual_from = 1;
+  // New configuration proposition.
+  repeated ConfigChange changes = 2;
+  // Configuration proposal number to avoid conflicting proposals.
+  // For every proposal, this field should be equal to the amount of
+  // valid processed proposals (no matter accepted or not).
+  // Appropriate value for this field can be obtained via "configuration-number" API endpoint.
+  uint64 configuration_number = 3;
+}
+
+// Confirmation vote for the configuration change
+message ConfigVote {
+  // Hash of configuration proposition.
+  exonum.crypto.Hash propose_hash = 1;
+}

exonum-java-binding/testkit/src/main/java/com/exonum/binding/testkit/TestKit.java

@@ -238,7 +238,7 @@ private void checkTransaction(TransactionMessage transactionMessage) {
     // As transactions of time service might be submitted in TestKit that has this service
     // activated, those transactions should be considered valid, as time service is not
     // contained in Java runtime
-    if (serviceId.equals(timeServiceId)) {
+    if (serviceId.equals(timeServiceId) || serviceId == 0 /* fixme */) {
       return;
     }
     try {