Use external pantheon-plugin-api library (#1505)

* Use the external jars to provide the plugin libraries.
* Add mavenLocal to local repositories to aid development
* Remove the :plugins project
* Move the PantheonPluginContextImpl into :pantheon
* rename a few files

acceptance-tests/build.gradle

@@ -31,9 +31,8 @@ dependencies {
   testImplementation project(':ethereum:permissioning')
   testImplementation project(':ethereum:rlp')
   testImplementation project(':metrics:core')
-  testImplementation project(':plugins')
-  testImplementation project(path: ':plugins', configuration: 'testArtifacts')
   testImplementation project(':pantheon')
+  testImplementation project(path: ':pantheon', configuration: 'testArtifacts')
   testImplementation project(':services:kvstore')
   testImplementation project(':testutil')
   testImplementation project(':util')
@@ -52,15 +51,16 @@ dependencies {
   testImplementation 'org.web3j:abi'
   testImplementation 'org.web3j:core'
   testImplementation 'org.web3j:crypto'
+  testImplementation 'tech.pegasys.pantheon:plugin-api'
 }
 
 test.enabled = false
 
 sourceSets {
-  test { resources {  srcDirs "${rootDir}/plugins/build/libs" } }
+  test { resources {  srcDirs "${rootDir}/pantheon/build/libs" } }
 }
 
-processTestResources.dependsOn(':plugins:testJar')
+processTestResources.dependsOn(':pantheon:testJar')
 
 task acceptanceTest(type: Test) {
   dependsOn(rootProject.installDist)

acceptance-tests/src/test/java/tech/pegasys/pantheon/tests/acceptance/dsl/node/ThreadPantheonNodeRunner.java

@@ -26,10 +26,10 @@
 import tech.pegasys.pantheon.ethereum.graphql.GraphQLConfiguration;
 import tech.pegasys.pantheon.metrics.MetricsSystem;
 import tech.pegasys.pantheon.metrics.noop.NoOpMetricsSystem;
-import tech.pegasys.pantheon.plugins.internal.PantheonPluginContextImpl;
-import tech.pegasys.pantheon.plugins.services.PantheonEvents;
-import tech.pegasys.pantheon.plugins.services.PicoCLIOptions;
+import tech.pegasys.pantheon.plugin.services.PantheonEvents;
+import tech.pegasys.pantheon.plugin.services.PicoCLIOptions;
 import tech.pegasys.pantheon.services.PantheonEventsImpl;
+import tech.pegasys.pantheon.services.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.PicoCLIOptionsImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.enode.EnodeURL;

acceptance-tests/src/test/java/tech/pegasys/pantheon/tests/acceptance/plugins/PantheonEventsPluginTest.java

@@ -35,7 +35,7 @@ public void setUp() throws Exception {
     minerNode = pantheon.createMinerNode("minerNode");
     pluginNode =
         pantheon.createPluginsNode(
-            "node1", Collections.singletonList("testPlugin"), Collections.emptyList());
+            "node1", Collections.singletonList("testPlugins"), Collections.emptyList());
     cluster.start(pluginNode, minerNode);
   }
 

acceptance-tests/src/test/java/tech/pegasys/pantheon/tests/acceptance/plugins/PicoCLIOptionsPluginTest.java

@@ -41,14 +41,15 @@ public void setUp() throws Exception {
     node =
         pantheon.createPluginsNode(
             "node1",
-            Collections.singletonList("testPlugin"),
+            Collections.singletonList("testPlugins"),
             Collections.singletonList("--Xtest-option=" + MAGIC_WORDS));
     cluster.start(node);
   }
 
   @Test
   public void shouldRegister() throws IOException {
-    final Path registrationFile = node.homeDirectory().resolve("plugins/testPlugin.registered");
+    final Path registrationFile =
+        node.homeDirectory().resolve("plugins/pluginLifecycle.registered");
     waitForFile(registrationFile);
 
     // this assert is false as CLI will not be parsed at this point
@@ -58,7 +59,7 @@ public void shouldRegister() throws IOException {
 
   @Test
   public void shouldStart() throws IOException {
-    final Path registrationFile = node.homeDirectory().resolve("plugins/testPlugin.started");
+    final Path registrationFile = node.homeDirectory().resolve("plugins/pluginLifecycle.started");
     waitForFile(registrationFile);
 
     // this assert is true as CLI will be parsed at this point
@@ -70,7 +71,7 @@ public void shouldStart() throws IOException {
   @Ignore("No way to do a graceful shutdown of Pantheon at the moment.")
   public void shouldStop() {
     cluster.stopNode(node);
-    waitForFile(node.homeDirectory().resolve("plugins/testPlugin.stopped"));
+    waitForFile(node.homeDirectory().resolve("plugins/pluginLifecycle.stopped"));
   }
 
   private void waitForFile(final Path path) {

build.gradle

@@ -89,6 +89,7 @@ allprojects {
     } else {
       jcenter()
       mavenCentral()
+      mavenLocal()
       maven { url  "https://consensys.bintray.com/pegasys-repo" }
     }
   }

gradle/versions.gradle

@@ -84,5 +84,7 @@ dependencyManagement {
     dependency 'org.web3j:crypto:4.3.0'
 
     dependency 'org.xerial.snappy:snappy-java:1.1.7.3'
+
+    dependency "tech.pegasys.pantheon:plugin-api:${rootProject.version}"
   }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip

pantheon/build.gradle

@@ -41,7 +41,6 @@ dependencies {
   implementation project(':ethereum:permissioning')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
-  implementation project(':plugins')
   implementation project(':metrics:core')
   implementation project(':services:kvstore')
 
@@ -53,6 +52,7 @@ dependencies {
   implementation 'net.consensys.cava:cava-toml'
   implementation 'org.apache.logging.log4j:log4j-api'
   implementation 'org.springframework.security:spring-security-crypto'
+  implementation 'tech.pegasys.pantheon:plugin-api'
 
   runtime 'org.apache.logging.log4j:log4j-core'
   runtime 'org.apache.logging.log4j:log4j-slf4j-impl'
@@ -61,6 +61,7 @@ dependencies {
   testImplementation project(path: ':ethereum:core', configuration: 'testSupportArtifacts')
 
   testImplementation 'com.squareup.okhttp3:okhttp'
+  testImplementation 'com.google.auto.service:auto-service'
   testImplementation 'junit:junit'
   testImplementation 'org.assertj:assertj-core'
   testImplementation 'org.awaitility:awaitility'
@@ -75,3 +76,21 @@ task writeInfoFile(type: ProjectPropertiesFile) {
 }
 
 compileJava.dependsOn(writeInfoFile)
+
+task testJar(type: Jar) {
+  archiveName 'testPlugins.jar'
+  manifest {
+    attributes(
+      'Specification-Title': baseName,
+      'Specification-Version': project.version,
+      'Implementation-Title': baseName,
+      'Implementation-Version': calculateVersion()
+      )
+  }
+  archiveClassifier = 'tests'
+  from sourceSets.test.output
+}
+
+configurations { testArtifacts }
+
+artifacts { testArtifacts testJar }

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

@@ -18,7 +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.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;
 

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

@@ -65,10 +65,10 @@
 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.PantheonEvents;
-import tech.pegasys.pantheon.plugins.services.PicoCLIOptions;
+import tech.pegasys.pantheon.plugin.services.PantheonEvents;
+import tech.pegasys.pantheon.plugin.services.PicoCLIOptions;
 import tech.pegasys.pantheon.services.PantheonEventsImpl;
+import tech.pegasys.pantheon.services.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.PicoCLIOptionsImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;

pantheon/src/main/java/tech/pegasys/pantheon/services/PantheonEventsImpl.java

@@ -14,7 +14,7 @@
 
 import tech.pegasys.pantheon.ethereum.core.Block;
 import tech.pegasys.pantheon.ethereum.eth.sync.BlockBroadcaster;
-import tech.pegasys.pantheon.plugins.services.PantheonEvents;
+import tech.pegasys.pantheon.plugin.services.PantheonEvents;
 
 import com.google.common.collect.ImmutableMap;
 import io.vertx.core.json.Json;

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

@@ -10,13 +10,13 @@
  * 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;
+package tech.pegasys.pantheon.services;
 
 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 tech.pegasys.pantheon.plugin.PantheonContext;
+import tech.pegasys.pantheon.plugin.PantheonPlugin;
 
 import java.io.IOException;
 import java.net.MalformedURLException;

pantheon/src/main/java/tech/pegasys/pantheon/services/PicoCLIOptionsImpl.java

@@ -12,7 +12,7 @@
  */
 package tech.pegasys.pantheon.services;
 
-import tech.pegasys.pantheon.plugins.services.PicoCLIOptions;
+import tech.pegasys.pantheon.plugin.services.PicoCLIOptions;
 
 import picocli.CommandLine;
 

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

@@ -34,7 +34,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.PantheonPluginContextImpl;
 import tech.pegasys.pantheon.services.kvstore.RocksDbConfiguration;
 import tech.pegasys.pantheon.util.BlockImporter;
 import tech.pegasys.pantheon.util.bytes.BytesValue;

plugins/src/test/java/tech/pegasys/pantheon/plugins/TestPantheonEventsPlugin.java → pantheon/src/test/java/tech/pegasys/pantheon/plugins/TestPantheonEventsPlugin.java

@@ -12,7 +12,9 @@
  */
 package tech.pegasys.pantheon.plugins;
 
-import tech.pegasys.pantheon.plugins.services.PantheonEvents;
+import tech.pegasys.pantheon.plugin.PantheonContext;
+import tech.pegasys.pantheon.plugin.PantheonPlugin;
+import tech.pegasys.pantheon.plugin.services.PantheonEvents;
 
 import java.io.File;
 import java.io.IOException;

plugins/src/test/java/tech/pegasys/pantheon/plugins/TestPicoCLIPlugin.java → pantheon/src/test/java/tech/pegasys/pantheon/plugins/TestPicoCLIPlugin.java

@@ -12,7 +12,9 @@
  */
 package tech.pegasys.pantheon.plugins;
 
-import tech.pegasys.pantheon.plugins.services.PicoCLIOptions;
+import tech.pegasys.pantheon.plugin.PantheonContext;
+import tech.pegasys.pantheon.plugin.PantheonPlugin;
+import tech.pegasys.pantheon.plugin.services.PicoCLIOptions;
 
 import java.io.File;
 import java.io.IOException;
@@ -91,7 +93,7 @@ public String getState() {
   /** This is used to signal to the acceptance test that certain tasks were completed. */
   private void writeSignal(final String signal) {
     try {
-      final File callbackFile = new File(callbackDir, "testPlugin." + signal);
+      final File callbackFile = new File(callbackDir, "pluginLifecycle." + signal);
       if (!callbackFile.getParentFile().exists()) {
         callbackFile.getParentFile().mkdirs();
         callbackFile.getParentFile().deleteOnExit();

plugins/src/test/java/tech/pegasys/pantheon/plugins/internal/PantheonPluginContextImplTest.java → pantheon/src/test/java/tech/pegasys/pantheon/services/PantheonPluginContextImplTest.java

@@ -10,12 +10,12 @@
  * 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;
+package tech.pegasys.pantheon.services;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 
-import tech.pegasys.pantheon.plugins.PantheonPlugin;
+import tech.pegasys.pantheon.plugin.PantheonPlugin;
 import tech.pegasys.pantheon.plugins.TestPicoCLIPlugin;
 
 import java.io.File;