Make QA service configurable [ECR-3869] (#1237)

dmitry-timofeev · web-flow · commit 9adb4b92a364 · 2019-12-03T16:34:38.000+02:00
The integration tests are not added, as they require some dependencies (and it isn't definite if it make sense to create supervisor transactions here). The original test remains available in 015d820.
diff --git a/exonum-java-binding/qa-service/src/main/java/com/exonum/binding/qaservice/QaService.java b/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
diff --git a/exonum-java-binding/qa-service/src/main/java/com/exonum/binding/qaservice/QaServiceImpl.java b/exonum-java-binding/qa-service/src/main/java/com/exonum/binding/qaservice/QaServiceImpl.java
@@ -36,7 +36,7 @@
 import com.exonum.binding.core.storage.indices.EntryIndexProxy;
 import com.exonum.binding.core.storage.indices.MapIndex;
 import com.exonum.binding.core.transaction.RawTransaction;
-import com.exonum.binding.qaservice.Config.InitialConfiguration;
+import com.exonum.binding.qaservice.Config.QaConfiguration;
 import com.exonum.binding.qaservice.transactions.IncrementCounterTx;
 import com.exonum.binding.qaservice.transactions.UnknownTx;
 import com.exonum.binding.time.TimeSchema;
@@ -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) {
+    QaConfiguration config = configuration.getAsMessage(QaConfiguration.class);
+    checkConfiguration(config);
+  }
+
+  @Override
+  public void applyConfiguration(Fork fork, Configuration configuration) {
+    updateTimeOracle(fork, configuration);
+  }
+
+  private void checkConfiguration(QaConfiguration 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);
+    QaConfiguration config = configuration.getAsMessage(QaConfiguration.class);
+
+    // Verify the configuration
+    checkConfiguration(config);
+
+    // Save the configuration
+    String timeOracleName = config.getTimeOracleName();
+    schema.timeOracleName().set(timeOracleName);
+  }
 }
diff --git a/exonum-java-binding/qa-service/src/main/proto/config.proto b/exonum-java-binding/qa-service/src/main/proto/config.proto
@@ -4,7 +4,8 @@ package exonum.qa;
 
 option java_package = "com.exonum.binding.qaservice";
 
-message InitialConfiguration {
+// QA service configuration parameters.
+message QaConfiguration {
   // The name of a time oracle service instance to use.
   string time_oracle_name = 1;
 }
diff --git a/exonum-java-binding/qa-service/src/test/java/com/exonum/binding/qaservice/QaArtifactInfo.java b/exonum-java-binding/qa-service/src/test/java/com/exonum/binding/qaservice/QaArtifactInfo.java
@@ -19,7 +19,7 @@
 import static com.google.common.base.Preconditions.checkState;
 
 import com.exonum.binding.core.runtime.ServiceArtifactId;
-import com.exonum.binding.qaservice.Config.InitialConfiguration;
+import com.exonum.binding.qaservice.Config.QaConfiguration;
 import com.exonum.binding.testkit.TestKit;
 import com.exonum.binding.testkit.TestKit.Builder;
 import com.exonum.binding.testkit.TimeProvider;
@@ -40,8 +40,8 @@ public final class QaArtifactInfo {
   public static final int TIME_SERVICE_ID = 100;
   public static final String QA_SERVICE_NAME = "qa";
   public static final int QA_SERVICE_ID = 101;
-  public static final InitialConfiguration QA_SERVICE_INITIAL_CONFIG =
-      InitialConfiguration.newBuilder()
+  public static final QaConfiguration QA_SERVICE_INITIAL_CONFIG =
+      QaConfiguration.newBuilder()
           .setTimeOracleName(TIME_SERVICE_NAME)
           .build();
 
diff --git a/exonum-java-binding/qa-service/src/test/java/com/exonum/binding/qaservice/QaServiceImplTest.java b/exonum-java-binding/qa-service/src/test/java/com/exonum/binding/qaservice/QaServiceImplTest.java
@@ -45,7 +45,7 @@
 import com.exonum.binding.core.blockchain.Blockchain;
 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.Config.QaConfiguration;
 import com.exonum.binding.testkit.EmulatedNode;
 import com.exonum.binding.testkit.FakeTimeProvider;
 import com.exonum.binding.testkit.TestKit;
@@ -96,7 +96,7 @@ void initialize() {
         .withArtifactsDirectory(QaArtifactInfo.ARTIFACT_DIR)
         .withDeployedArtifact(QaArtifactInfo.ARTIFACT_ID, QaArtifactInfo.ARTIFACT_FILENAME)
         .withService(QaArtifactInfo.ARTIFACT_ID, serviceName, 1,
-            InitialConfiguration.newBuilder()
+            QaConfiguration.newBuilder()
                 .setTimeOracleName(timeServiceName)
                 .build())
         .withTimeService(timeServiceName, 2, TimeProvider.systemTime())
@@ -130,7 +130,7 @@ void initializeBadConfig() {
         .withArtifactsDirectory(QaArtifactInfo.ARTIFACT_DIR)
         .withDeployedArtifact(QaArtifactInfo.ARTIFACT_ID, QaArtifactInfo.ARTIFACT_FILENAME)
         .withService(QaArtifactInfo.ARTIFACT_ID, serviceName, 1,
-            InitialConfiguration.newBuilder()
+            QaConfiguration.newBuilder()
                 .setTimeOracleName(timeServiceName)
                 .build());
 

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@ package exonum.qa;`
`4`	`4`
`5`	`5`	`option java_package = "com.exonum.binding.qaservice";`
`6`	`6`
`7`		`-message InitialConfiguration {`
	`7`	`+// QA service configuration parameters.`
	`8`	`+message QaConfiguration {`
`8`	`9`	`// The name of a time oracle service instance to use.`
`9`	`10`	`string time_oracle_name = 1;`
`10`	`11`	`}`