rough implementation

pantheon/build.gradle

@@ -32,6 +32,7 @@ dependencies {
   implementation project(':consensus:clique')
   implementation project(':consensus:ibft')
   implementation project(':consensus:ibftlegacy')
+  implementation project(':enclave')
   implementation project(':ethereum:blockcreation')
   implementation project(':ethereum:core')
   implementation project(':ethereum:eth')
@@ -40,8 +41,8 @@ dependencies {
   implementation project(':ethereum:permissioning')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
+  implementation project(':plugins')
   implementation project(':metrics:core')
-  implementation project(':enclave')
   implementation project(':services:kvstore')
 
   implementation 'com.graphql-java:graphql-java'

pantheon/src/main/java/tech/pegasys/pantheon/Pantheon.java

@@ -18,6 +18,7 @@
 import tech.pegasys.pantheon.controller.PantheonController;
 import tech.pegasys.pantheon.ethereum.eth.EthereumWireProtocolConfiguration;
 import tech.pegasys.pantheon.ethereum.eth.sync.SynchronizerConfiguration;
+import tech.pegasys.pantheon.plugins.internal.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;
 
@@ -37,7 +38,8 @@ public static void main(final String... args) {
             new PantheonController.Builder(),
             new SynchronizerConfiguration.Builder(),
             EthereumWireProtocolConfiguration.builder(),
-            new RocksDbConfiguration.Builder());
+            new RocksDbConfiguration.Builder(),
+            new PantheonPluginContextImpl());
 
     pantheonCommand.parse(
         new RunLast().andExit(SUCCESS_EXIT_CODE),

pantheon/src/main/java/tech/pegasys/pantheon/cli/PantheonCommand.java

@@ -64,6 +64,8 @@
 import tech.pegasys.pantheon.metrics.prometheus.MetricsConfiguration;
 import tech.pegasys.pantheon.metrics.prometheus.PrometheusMetricsSystem;
 import tech.pegasys.pantheon.metrics.vertx.VertxMetricsAdapterFactory;
+import tech.pegasys.pantheon.plugins.internal.PantheonPluginContextImpl;
+import tech.pegasys.pantheon.plugins.services.PicoCLIOptions;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;
 import tech.pegasys.pantheon.util.InvalidConfigurationException;
@@ -134,6 +136,7 @@ public class PantheonCommand implements DefaultCommandValues, Runnable {
   private final RocksDbConfiguration.Builder rocksDbConfigurationBuilder;
   private final RunnerBuilder runnerBuilder;
   private final PantheonController.Builder controllerBuilderFactory;
+  private final PantheonPluginContextImpl pantheonPluginContext;
 
   protected KeyLoader getKeyLoader() {
     return KeyPairUtil::loadKeyPair;
@@ -564,14 +567,16 @@ public PantheonCommand(
       final PantheonController.Builder controllerBuilderFactory,
       final SynchronizerConfiguration.Builder synchronizerConfigurationBuilder,
       final EthereumWireProtocolConfiguration.Builder ethereumWireConfigurationBuilder,
-      final RocksDbConfiguration.Builder rocksDbConfigurationBuilder) {
+      final RocksDbConfiguration.Builder rocksDbConfigurationBuilder,
+      final PantheonPluginContextImpl pantheonPluginContext) {
     this.logger = logger;
     this.blockImporter = blockImporter;
     this.runnerBuilder = runnerBuilder;
     this.controllerBuilderFactory = controllerBuilderFactory;
     this.synchronizerConfigurationBuilder = synchronizerConfigurationBuilder;
     this.ethereumWireConfigurationBuilder = ethereumWireConfigurationBuilder;
     this.rocksDbConfigurationBuilder = rocksDbConfigurationBuilder;
+    this.pantheonPluginContext = pantheonPluginContext;
   }
 
   private StandaloneCommand standaloneCommands;
@@ -621,6 +626,13 @@ public void parse(
             "Ethereum Wire Protocol",
             ethereumWireConfigurationBuilder));
 
+    pantheonPluginContext.addService(
+        PicoCLIOptions.class,
+        (PicoCLIOptions)
+            (namespace, optionObject) ->
+                commandLine.addMixin("pantheonplugin-" + namespace, optionObject));
+    pantheonPluginContext.registerPlugins();
+
     // Create a handler that will search for a config file option and use it for
     // default values
     // and eventually it will run regular parsing of the remaining options.
@@ -697,6 +709,8 @@ public void run() {
                   ensureAllNodesAreInWhitelist(
                       staticNodes.stream().map(EnodeURL::toURI).collect(Collectors.toList()), p));
 
+      pantheonPluginContext.startPlugins();
+
       synchronize(
           buildController(),
           p2pEnabled,
@@ -1059,8 +1073,8 @@ private void addShutdownHook(final Runner runner) {
             new Thread(
                 () -> {
                   try {
+                    pantheonPluginContext.stopPlugins();
                     runner.close();
-
                     LogManager.shutdown();
                   } catch (final Exception e) {
                     logger.error("Failed to stop Pantheon");

pantheon/src/test/java/tech/pegasys/pantheon/cli/CommandTestAbstract.java

@@ -32,6 +32,7 @@
 import tech.pegasys.pantheon.ethereum.jsonrpc.websocket.WebSocketConfiguration;
 import tech.pegasys.pantheon.ethereum.permissioning.PermissioningConfiguration;
 import tech.pegasys.pantheon.metrics.prometheus.MetricsConfiguration;
+import tech.pegasys.pantheon.plugins.internal.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;
 
@@ -84,6 +85,7 @@ public abstract class CommandTestAbstract {
   @Mock PantheonController<Object> mockController;
   @Mock BlockImporter mockBlockImporter;
   @Mock Logger mockLogger;
+  @Mock PantheonPluginContextImpl mockPantheonPluginContext;
 
   @Captor ArgumentCaptor<Collection<String>> stringListArgumentCaptor;
   @Captor ArgumentCaptor<Path> pathArgumentCaptor;
@@ -195,7 +197,8 @@ private CommandLine.Model.CommandSpec parseCommand(
             mockSyncConfBuilder,
             mockEthereumWireProtocolConfigurationBuilder,
             mockRocksDbConfBuilder,
-            keyLoader);
+            keyLoader,
+            mockPantheonPluginContext);
 
     // parse using Ansi.OFF to be able to assert on non formatted output results
     pantheonCommand.parse(
@@ -224,15 +227,17 @@ protected KeyLoader getKeyLoader() {
         final SynchronizerConfiguration.Builder mockSyncConfBuilder,
         final EthereumWireProtocolConfiguration.Builder mockEthereumConfigurationMockBuilder,
         final RocksDbConfiguration.Builder mockRocksDbConfBuilder,
-        final KeyLoader keyLoader) {
+        final KeyLoader keyLoader,
+        final PantheonPluginContextImpl pantheonPluginContext) {
       super(
           mockLogger,
           mockBlockImporter,
           mockRunnerBuilder,
           controllerBuilderFactory,
           mockSyncConfBuilder,
           mockEthereumConfigurationMockBuilder,
-          mockRocksDbConfBuilder);
+          mockRocksDbConfBuilder,
+          pantheonPluginContext);
       this.keyLoader = keyLoader;
     }
   }

plugins/build.gradle

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2018 ConsenSys AG.
+ *
+ * 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.
+ */
+
+apply plugin: 'java-library'
+
+jar {
+  baseName 'pantheon-plugins'
+  manifest {
+    attributes(
+      'Specification-Title': baseName,
+      'Specification-Version': project.version,
+      'Implementation-Title': baseName,
+      'Implementation-Version': calculateVersion()
+      )
+  }
+}
+
+dependencies { implementation('com.google.guava:guava') }

plugins/src/main/java/tech/pegasys/pantheon/plugins/PantheonContext.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * 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 tech.pegasys.pantheon.plugins;
+
+import java.util.Optional;
+
+public interface PantheonContext {
+
+  <T> Optional<T> getService(Class<T> serviceType);
+}

plugins/src/main/java/tech/pegasys/pantheon/plugins/PantheonPlugin.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * 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 tech.pegasys.pantheon.plugins;
+
+public interface PantheonPlugin {
+
+  void register(PantheonContext context);
+
+  void start();
+
+  void stop();
+}

plugins/src/main/java/tech/pegasys/pantheon/plugins/internal/PantheonPluginContextImpl.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * 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 tech.pegasys.pantheon.plugins.internal;
+
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
+
+import tech.pegasys.pantheon.plugins.PantheonContext;
+import tech.pegasys.pantheon.plugins.PantheonPlugin;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+import java.util.ServiceLoader;
+
+public class PantheonPluginContextImpl implements PantheonContext {
+
+  private enum Lifecycle {
+    UNINITIALZED,
+    REGISTERING,
+    REGISTERED,
+    STARTING,
+    STARTED,
+    STOPPING,
+    STOPPED
+  }
+
+  private Lifecycle state = Lifecycle.UNINITIALZED;
+  private final Map<Class<?>, ? super Object> serviceRegistry = new HashMap<>();
+  private ServiceLoader<PantheonPlugin> plugins;
+
+  public void addService(final Class<?> serviceType, final Object service) {
+    checkArgument(serviceType.isInterface(), "Services must be Java interfaces.");
+    checkArgument(
+        serviceType.isInstance(service),
+        "The service registered with a type must implement that type");
+    serviceRegistry.put(serviceType, service);
+  }
+
+  @SuppressWarnings("unchecked")
+  @Override
+  public <T> Optional<T> getService(final Class<T> serviceType) {
+    return (Optional<T>) Optional.ofNullable((Map<Class<T>, T>) serviceRegistry.get(serviceType));
+  }
+
+  public void registerPlugins() {
+    checkState(state == Lifecycle.UNINITIALZED, "PantheonContext has already beein registered.");
+    state = Lifecycle.REGISTERING;
+    plugins = ServiceLoader.load(PantheonPlugin.class);
+    for (final PantheonPlugin plugin : plugins) {
+      plugin.register(this);
+    }
+    state = Lifecycle.REGISTERED;
+  }
+
+  public void startPlugins() {
+    checkState(
+        state == Lifecycle.REGISTERED,
+        "PantheonContext should be in state %s but it was in %s",
+        Lifecycle.REGISTERED,
+        state);
+    state = Lifecycle.STARTING;
+    plugins = ServiceLoader.load(PantheonPlugin.class);
+    for (final PantheonPlugin plugin : plugins) {
+      plugin.start();
+    }
+    state = Lifecycle.STARTED;
+  }
+
+  public void stopPlugins() {
+    checkState(
+        state == Lifecycle.STARTED,
+        "PantheonContext should be in state %s but it was in %s",
+        Lifecycle.STARTED,
+        state);
+    state = Lifecycle.STARTING;
+    plugins = ServiceLoader.load(PantheonPlugin.class);
+    for (final PantheonPlugin plugin : plugins) {
+      plugin.stop();
+    }
+    state = Lifecycle.STARTED;
+  }
+}

plugins/src/main/java/tech/pegasys/pantheon/plugins/internal/package-info.java

@@ -0,0 +1,2 @@
+/** This package will be hidden from external users once Pantheon migrates to Java 11. */
+package tech.pegasys.pantheon.plugins.internal;

plugins/src/main/java/tech/pegasys/pantheon/plugins/services/PantheonEvents.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * 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 tech.pegasys.pantheon.plugins.services;
+
+import java.util.function.Consumer;
+
+public interface PantheonEvents {
+
+  /**
+   * Returns the raw RLP of a block that Pantheon has receieved and that has passed basic validation
+   * checks.
+   *
+   * @param blockJSONListener The listener that will accept a JSON string as the event.
+   * @return an object to be used as an identifier when de-registering the event.
+   */
+  Object addBlockAddedListener(Consumer<String> blockJSONListener);
+
+  /**
+   * Remove the blockAdded listener from pantheon notifications.
+   *
+   * @param listenerIdentifier The instance that was returned from addBlockAddedListener;
+   */
+  void removeBlockAddedObserver(Object listenerIdentifier);
+}

plugins/src/main/java/tech/pegasys/pantheon/plugins/services/PicoCLIOptions.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 ConsenSys AG.
+ *
+ * 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 tech.pegasys.pantheon.plugins.services;
+
+/** This service will be available during the registration callbacks. */
+public interface PicoCLIOptions {
+
+  /**
+   * During the registration callback plugins can register CLI options that should be added to
+   * Pantheon's CLI startup.
+   *
+   * @param namespace A namespace prefix. All registered options must start with this prefix
+   * @param optionObject The instance of the object to be inspected. PicoCLI will reflect the fields
+   *     of this object to extract the CLI options.
+   */
+  void addPicoCLIOptions(String namespace, Object optionObject);
+}

settings.gradle

@@ -35,6 +35,7 @@ include 'ethereum:trie'
 include 'metrics:core'
 include 'metrics:rocksdb'
 include 'pantheon'
+include 'plugins'
 include 'services:kvstore'
 include 'services:pipeline'
 include 'services:tasks'