[PRIV-41] Refactor PrivacyParameters config to use builder pattern (#…

…1226) * [PRIV-41] Use metrics system for private state db - Use PrivacyParametersBuilder to build PrivacyParameters - refactor PrivacyParameters to expose default options - refactor test builders to use PrivacyParameters.DEFAULT - Use URI in Enclave * Fix: enclave tests from bad merge * Fix privacy acceptance tests after db configuration changes * Switch to use nested class for PrivacyParametersBuilder
PegaSysEng · Apr 9, 2019 · 99b610d · 99b610d
1 parent bfc5647
commit 99b610d
Show file tree

Hide file tree

Showing 44 changed files with 240 additions and 172 deletions.
diff --git a/acceptance-tests/build.gradle b/acceptance-tests/build.gradle
@@ -20,6 +20,7 @@ dependencies {
   testImplementation project(':consensus:clique')
   testImplementation project(':consensus:ibft')
   testImplementation project(':crypto')
+  testImplementation project(':enclave')
   testImplementation project(':ethereum:eth')
   testImplementation project(':ethereum:core')
   testImplementation project(':ethereum:blockcreation')
@@ -28,9 +29,9 @@ dependencies {
   testImplementation project(':ethereum:rlp')
   testImplementation project(':metrics')
   testImplementation project(':pantheon')
+  testImplementation project(':services:kvstore')
   testImplementation project(':testutil')
   testImplementation project(':util')
-  testImplementation project(':enclave')
   testImplementation project(path: ':ethereum:core', configuration: 'testSupportArtifacts')
 
   testImplementation 'com.google.guava:guava'

diff --git a/.../test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ProcessPantheonNodeRunner.java b/.../test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ProcessPantheonNodeRunner.java
@@ -85,7 +85,7 @@ public void startNode(final PantheonNode node) {
     if (node.getPrivacyParameters().isEnabled()) {
       params.add("--privacy-enabled");
       params.add("--privacy-url");
-      params.add(node.getPrivacyParameters().getUrl());
+      params.add(node.getPrivacyParameters().getEnclaveUri().toString());
       params.add("--privacy-public-key-file");
       params.add(node.getPrivacyParameters().getEnclavePublicKeyFile().getAbsolutePath());
       params.add("--privacy-precompiled-address");

diff --git a/...c/test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ThreadPantheonNodeRunner.java b/...c/test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ThreadPantheonNodeRunner.java
@@ -24,8 +24,10 @@
 import tech.pegasys.pantheon.ethereum.eth.sync.SynchronizerConfiguration;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
 import tech.pegasys.pantheon.metrics.noop.NoOpMetricsSystem;
+import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 
 import java.io.IOException;
+import java.nio.file.Path;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -34,6 +36,7 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 
+import com.google.common.io.Files;
 import io.vertx.core.Vertx;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -57,6 +60,7 @@ public void startNode(final PantheonNode node) {
             .setBootNodes(node.getConfiguration().bootnodes());
     node.getConfiguration().getGenesisConfig().ifPresent(networkConfigBuilder::setGenesisConfig);
     final EthNetworkConfig ethNetworkConfig = networkConfigBuilder.build();
+    final Path tempDir = Files.createTempDir().toPath();
 
     final PantheonController<?> pantheonController;
     try {
@@ -71,6 +75,7 @@ public void startNode(final PantheonNode node) {
               .nodePrivateKeyFile(KeyPairUtil.getDefaultKeyFile(node.homeDirectory()))
               .metricsSystem(noOpMetricsSystem)
               .maxPendingTransactions(PendingTransactions.MAX_PENDING_TRANSACTIONS)
+              .rocksDbConfiguration(new RocksDbConfiguration.Builder().databaseDir(tempDir).build())
               .build();
     } catch (final IOException e) {
       throw new RuntimeException("Error building PantheonController", e);

diff --git a/...gasys/pantheon/tests/acceptance/dsl/node/factory/PantheonFactoryConfigurationBuilder.java b/...gasys/pantheon/tests/acceptance/dsl/node/factory/PantheonFactoryConfigurationBuilder.java
@@ -34,7 +34,7 @@ public class PantheonFactoryConfigurationBuilder {
   private String name;
   private MiningParameters miningParameters =
       new MiningParametersTestBuilder().enabled(false).build();
-  private PrivacyParameters privacyParameters = PrivacyParameters.noPrivacy();
+  private PrivacyParameters privacyParameters = PrivacyParameters.DEFAULT;
   private JsonRpcConfiguration jsonRpcConfiguration = JsonRpcConfiguration.createDefault();
   private WebSocketConfiguration webSocketConfiguration = WebSocketConfiguration.createDefault();
   private MetricsConfiguration metricsConfiguration = MetricsConfiguration.createDefault();

diff --git a/...ts/src/test/java/tech/pegasys/pantheon/tests/web3j/privacy/PrivateAcceptanceTestBase.java b/...ts/src/test/java/tech/pegasys/pantheon/tests/web3j/privacy/PrivateAcceptanceTestBase.java
@@ -120,13 +120,11 @@ public String build(final TransactionType type) {
   }
 
   static PrivacyParameters getPrivacyParams(final OrionTestHarness testHarness) throws IOException {
-    final PrivacyParameters privacyParameters = new PrivacyParameters();
-    privacyParameters.setEnabled(true);
-    privacyParameters.setUrl(testHarness.clientUrl());
-    privacyParameters.setPrivacyAddress(Address.PRIVACY);
-    privacyParameters.setEnclavePublicKeyUsingFile(
-        testHarness.getConfig().publicKeys().get(0).toFile());
-    privacyParameters.enablePrivateDB(privacy.newFolder().toPath());
-    return privacyParameters;
+    return new PrivacyParameters.Builder()
+        .setEnabled(true)
+        .setEnclaveUrl(testHarness.clientUrl())
+        .setEnclavePublicKeyUsingFile(testHarness.getConfig().publicKeys().get(0).toFile())
+        .setDataDir(privacy.newFolder().toPath())
+        .build();
   }
 }
diff --git a/...s/clique/src/main/java/tech/pegasys/pantheon/consensus/clique/CliqueProtocolSchedule.java b/...s/clique/src/main/java/tech/pegasys/pantheon/consensus/clique/CliqueProtocolSchedule.java
@@ -54,6 +54,11 @@ public static ProtocolSchedule<CliqueContext> create(
         .createProtocolSchedule();
   }
 
+  public static ProtocolSchedule<CliqueContext> create(
+      final GenesisConfigOptions config, final KeyPair nodeKeys) {
+    return create(config, nodeKeys, PrivacyParameters.DEFAULT);
+  }
+
   private static ProtocolSpecBuilder<CliqueContext> applyCliqueSpecificModifications(
       final EpochManager epochManager,
       final long secondsBetweenBlocks,

diff --git a/...ique/src/test/java/tech/pegasys/pantheon/consensus/clique/CliqueProtocolScheduleTest.java b/...ique/src/test/java/tech/pegasys/pantheon/consensus/clique/CliqueProtocolScheduleTest.java
@@ -17,7 +17,6 @@
 import tech.pegasys.pantheon.config.GenesisConfigFile;
 import tech.pegasys.pantheon.config.GenesisConfigOptions;
 import tech.pegasys.pantheon.crypto.SECP256K1.KeyPair;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.ethereum.mainnet.ProtocolSchedule;
 import tech.pegasys.pantheon.ethereum.mainnet.ProtocolSpec;
@@ -42,7 +41,7 @@ public void protocolSpecsAreCreatedAtBlockDefinedInJson() {
 
     final GenesisConfigOptions config = GenesisConfigFile.fromConfig(jsonInput).getConfigOptions();
     final ProtocolSchedule<CliqueContext> protocolSchedule =
-        CliqueProtocolSchedule.create(config, NODE_KEYS, PrivacyParameters.noPrivacy());
+        CliqueProtocolSchedule.create(config, NODE_KEYS);
 
     final ProtocolSpec<CliqueContext> homesteadSpec = protocolSchedule.getByBlockNumber(1);
     final ProtocolSpec<CliqueContext> tangerineWhistleSpec = protocolSchedule.getByBlockNumber(2);
@@ -57,10 +56,7 @@ public void protocolSpecsAreCreatedAtBlockDefinedInJson() {
   @Test
   public void parametersAlignWithMainnetWithAdjustments() {
     final ProtocolSpec<CliqueContext> homestead =
-        CliqueProtocolSchedule.create(
-                GenesisConfigFile.DEFAULT.getConfigOptions(),
-                NODE_KEYS,
-                PrivacyParameters.noPrivacy())
+        CliqueProtocolSchedule.create(GenesisConfigFile.DEFAULT.getConfigOptions(), NODE_KEYS)
             .getByBlockNumber(0);
 
     assertThat(homestead.getName()).isEqualTo("Frontier");

diff --git a/...est/java/tech/pegasys/pantheon/consensus/clique/blockcreation/CliqueBlockCreatorTest.java b/...est/java/tech/pegasys/pantheon/consensus/clique/blockcreation/CliqueBlockCreatorTest.java
@@ -40,7 +40,6 @@
 import tech.pegasys.pantheon.ethereum.core.BlockBody;
 import tech.pegasys.pantheon.ethereum.core.BlockHeaderTestFixture;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Util;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.ethereum.mainnet.ProtocolSchedule;
@@ -76,9 +75,7 @@ public class CliqueBlockCreatorTest {
   public void setup() {
     protocolSchedule =
         CliqueProtocolSchedule.create(
-            GenesisConfigFile.DEFAULT.getConfigOptions(),
-            proposerKeyPair,
-            PrivacyParameters.noPrivacy());
+            GenesisConfigFile.DEFAULT.getConfigOptions(), proposerKeyPair);
 
     final Address otherAddress = Util.publicKeyToAddress(otherKeyPair.getPublicKey());
     validatorList.add(otherAddress);

diff --git a/...st/java/tech/pegasys/pantheon/consensus/clique/blockcreation/CliqueMinerExecutorTest.java b/...st/java/tech/pegasys/pantheon/consensus/clique/blockcreation/CliqueMinerExecutorTest.java
@@ -34,7 +34,6 @@
 import tech.pegasys.pantheon.ethereum.core.BlockHeaderTestFixture;
 import tech.pegasys.pantheon.ethereum.core.MiningParameters;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Util;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
@@ -90,8 +89,7 @@ public void extraDataCreatedOnEpochBlocksContainsValidators() {
         new CliqueMinerExecutor(
             cliqueProtocolContext,
             Executors.newSingleThreadExecutor(),
-            CliqueProtocolSchedule.create(
-                GENESIS_CONFIG_OPTIONS, proposerKeyPair, PrivacyParameters.noPrivacy()),
+            CliqueProtocolSchedule.create(GENESIS_CONFIG_OPTIONS, proposerKeyPair),
             new PendingTransactions(1, TestClock.fixed(), metricsSystem),
             proposerKeyPair,
             new MiningParameters(AddressHelpers.ofValue(1), Wei.ZERO, wrappedVanityData, false),
@@ -121,8 +119,7 @@ public void extraDataForNonEpochBlocksDoesNotContainValidaors() {
         new CliqueMinerExecutor(
             cliqueProtocolContext,
             Executors.newSingleThreadExecutor(),
-            CliqueProtocolSchedule.create(
-                GENESIS_CONFIG_OPTIONS, proposerKeyPair, PrivacyParameters.noPrivacy()),
+            CliqueProtocolSchedule.create(GENESIS_CONFIG_OPTIONS, proposerKeyPair),
             new PendingTransactions(1, TestClock.fixed(), metricsSystem),
             proposerKeyPair,
             new MiningParameters(AddressHelpers.ofValue(1), Wei.ZERO, wrappedVanityData, false),

diff --git a/...ntegration-test/java/tech/pegasys/pantheon/consensus/ibft/support/TestContextBuilder.java b/...ntegration-test/java/tech/pegasys/pantheon/consensus/ibft/support/TestContextBuilder.java
@@ -60,7 +60,6 @@
 import tech.pegasys.pantheon.ethereum.core.Hash;
 import tech.pegasys.pantheon.ethereum.core.MiningParameters;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Util;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.ethereum.mainnet.ProtocolSchedule;
@@ -262,7 +261,7 @@ private static ControllerAndState createControllerAndFinalState(
     genesisConfigOptions.byzantiumBlock(0);
 
     final ProtocolSchedule<IbftContext> protocolSchedule =
-        IbftProtocolSchedule.create(genesisConfigOptions, PrivacyParameters.noPrivacy());
+        IbftProtocolSchedule.create(genesisConfigOptions);
 
     /////////////////////////////////////////////////////////////////////////////////////
     // From here down is BASICALLY taken from IbftPantheonController

diff --git a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/IbftProtocolSchedule.java b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/IbftProtocolSchedule.java
@@ -45,6 +45,10 @@ public static ProtocolSchedule<IbftContext> create(
         .createProtocolSchedule();
   }
 
+  public static ProtocolSchedule<IbftContext> create(final GenesisConfigOptions config) {
+    return create(config, PrivacyParameters.DEFAULT);
+  }
+
   private static ProtocolSpecBuilder<IbftContext> applyIbftChanges(
       final long secondsBetweenBlocks, final ProtocolSpecBuilder<Void> builder) {
     return builder

diff --git a/...rc/test/java/tech/pegasys/pantheon/consensus/ibft/blockcreation/IbftBlockCreatorTest.java b/...rc/test/java/tech/pegasys/pantheon/consensus/ibft/blockcreation/IbftBlockCreatorTest.java
@@ -33,7 +33,6 @@
 import tech.pegasys.pantheon.ethereum.core.BlockHeader;
 import tech.pegasys.pantheon.ethereum.core.BlockHeaderTestFixture;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.ethereum.mainnet.BlockHeaderValidator;
 import tech.pegasys.pantheon.ethereum.mainnet.HeaderValidationMode;
@@ -75,8 +74,7 @@ public void createdBlockPassesValidationRulesAndHasAppropriateHashAndMixHash() {
     final ProtocolSchedule<IbftContext> protocolSchedule =
         IbftProtocolSchedule.create(
             GenesisConfigFile.fromConfig("{\"config\": {\"spuriousDragonBlock\":0}}")
-                .getConfigOptions(),
-            PrivacyParameters.noPrivacy());
+                .getConfigOptions());
     final ProtocolContext<IbftContext> protContext =
         new ProtocolContext<>(
             blockchain,

diff --git a/...legacy/src/main/java/tech/pegasys/pantheon/consensus/ibftlegacy/IbftProtocolSchedule.java b/...legacy/src/main/java/tech/pegasys/pantheon/consensus/ibftlegacy/IbftProtocolSchedule.java
@@ -46,6 +46,10 @@ public static ProtocolSchedule<IbftContext> create(
         .createProtocolSchedule();
   }
 
+  public static ProtocolSchedule<IbftContext> create(final GenesisConfigOptions config) {
+    return create(config, PrivacyParameters.DEFAULT);
+  }
+
   private static ProtocolSpecBuilder<IbftContext> applyIbftChanges(
       final long secondsBetweenBlocks, final ProtocolSpecBuilder<Void> builder) {
     return builder

diff --git a/...t/java/tech/pegasys/pantheon/consensus/ibftlegacy/blockcreation/IbftBlockCreatorTest.java b/...t/java/tech/pegasys/pantheon/consensus/ibftlegacy/blockcreation/IbftBlockCreatorTest.java
@@ -33,7 +33,6 @@
 import tech.pegasys.pantheon.ethereum.core.BlockHeaderTestFixture;
 import tech.pegasys.pantheon.ethereum.core.Hash;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.Wei;
 import tech.pegasys.pantheon.ethereum.mainnet.BlockHeaderValidator;
 import tech.pegasys.pantheon.ethereum.mainnet.HeaderValidationMode;
@@ -81,8 +80,7 @@ public void headerProducedPassesValidationRules() {
     final ProtocolSchedule<IbftContext> protocolSchedule =
         IbftProtocolSchedule.create(
             GenesisConfigFile.fromConfig("{\"config\": {\"spuriousDragonBlock\":0}}")
-                .getConfigOptions(),
-            PrivacyParameters.noPrivacy());
+                .getConfigOptions());
     final ProtocolContext<IbftContext> protContext =
         new ProtocolContext<>(
             blockchain,

diff --git a/enclave/src/integration-test/java/tech/pegasys/pantheon/enclave/EnclaveTest.java b/enclave/src/integration-test/java/tech/pegasys/pantheon/enclave/EnclaveTest.java
@@ -25,6 +25,7 @@
 import tech.pegasys.pantheon.enclave.types.SendResponse;
 
 import java.io.IOException;
+import java.net.URI;
 import java.util.List;
 
 import com.google.common.collect.Lists;
@@ -81,7 +82,7 @@ public void testSendAndReceive() throws IOException {
 
   @Test(expected = IOException.class)
   public void whenUpCheckFailsThrows() throws IOException {
-    Enclave broken = new Enclave("http:");
+    Enclave broken = new Enclave(URI.create("http://null"));
 
     broken.upCheck();
   }

diff --git a/enclave/src/main/java/tech/pegasys/pantheon/enclave/Enclave.java b/enclave/src/main/java/tech/pegasys/pantheon/enclave/Enclave.java
@@ -18,6 +18,7 @@
 import tech.pegasys.pantheon.enclave.types.SendResponse;
 
 import java.io.IOException;
+import java.net.URI;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import okhttp3.MediaType;
@@ -34,16 +35,17 @@ public class Enclave {
   private static final MediaType JSON = MediaType.parse("application/json");
   private static final MediaType ORION = MediaType.get("application/vnd.orion.v1+json");
 
-  private final String url;
+  private final URI enclaveUri;
   private final OkHttpClient client;
 
-  public Enclave(final String enclaveUrl) {
-    this.url = enclaveUrl;
+  public Enclave(final URI enclaveUri) {
+    this.enclaveUri = enclaveUri;
     this.client = new OkHttpClient();
   }
 
   public Boolean upCheck() throws IOException {
-    Request request = new Request.Builder().url(url + "/upcheck").get().build();
+    String url = enclaveUri.resolve("/upcheck").toString();
+    Request request = new Request.Builder().url(url).get().build();
 
     try (Response response = client.newCall(request).execute()) {
       return response.isSuccessful();
@@ -55,7 +57,6 @@ public Boolean upCheck() throws IOException {
 
   public SendResponse send(final SendRequest content) throws IOException {
     Request request = buildPostRequest(JSON, content, "/send");
-
     return executePost(request, SendResponse.class);
   }
 
@@ -67,7 +68,8 @@ public ReceiveResponse receive(final ReceiveRequest content) throws IOException
   private Request buildPostRequest(
       final MediaType mediaType, final Object content, final String endpoint) throws IOException {
     RequestBody body = RequestBody.create(mediaType, objectMapper.writeValueAsString(content));
-    return new Request.Builder().url(url + endpoint).post(body).build();
+    String url = enclaveUri.resolve(endpoint).toString();
+    return new Request.Builder().url(url).post(body).build();
   }
 
   private <T> T executePost(final Request request, final Class<T> responseType) throws IOException {

diff --git a/.../test/java/tech/pegasys/pantheon/ethereum/blockcreation/BlockTransactionSelectorTest.java b/.../test/java/tech/pegasys/pantheon/ethereum/blockcreation/BlockTransactionSelectorTest.java
@@ -28,7 +28,6 @@
 import tech.pegasys.pantheon.ethereum.core.Hash;
 import tech.pegasys.pantheon.ethereum.core.LogSeries;
 import tech.pegasys.pantheon.ethereum.core.PendingTransactions;
-import tech.pegasys.pantheon.ethereum.core.PrivacyParameters;
 import tech.pegasys.pantheon.ethereum.core.ProcessableBlockHeader;
 import tech.pegasys.pantheon.ethereum.core.Transaction;
 import tech.pegasys.pantheon.ethereum.core.TransactionReceipt;
@@ -68,8 +67,7 @@ public class BlockTransactionSelectorTest {
   @Test
   public void emptyPendingTransactionsResultsInEmptyVettingResult() {
     final ProtocolSchedule<Void> protocolSchedule =
-        FixedDifficultyProtocolSchedule.create(
-            GenesisConfigFile.development().getConfigOptions(), PrivacyParameters.noPrivacy());
+        FixedDifficultyProtocolSchedule.create(GenesisConfigFile.development().getConfigOptions());
     final Blockchain blockchain = new TestBlockchain();
     final TransactionProcessor transactionProcessor =
         protocolSchedule.getByBlockNumber(0).getTransactionProcessor();

diff --git a/...n/src/test/java/tech/pegasys/pantheon/ethereum/blockcreation/EthHashBlockCreatorTest.java b/...n/src/test/java/tech/pegasys/pantheon/ethereum/blockcreation/EthHashBlockCreatorTest.java
@@ -55,7 +55,7 @@ public class EthHashBlockCreatorTest {
                       GenesisConfigFile.DEFAULT.getConfigOptions(),
                       42,
                       Function.identity(),
-                      PrivacyParameters.noPrivacy())
+                      PrivacyParameters.DEFAULT)
                   .createProtocolSchedule())
           .build();