RFC: Test that example plugins build stand-alone

buildSrc/build.gradle

@@ -166,6 +166,13 @@ if (project != rootProject) {
     testClassesDirs = sourceSets.test.output.classesDirs
     classpath = sourceSets.test.runtimeClasspath
     inputs.dir(file("src/testKit"))
+    // tell BuildExamplePluginsIT where to find the example plugins
+    systemProperty (
+            'test.build-tools.plugin.examples',
+            files(
+                    project(':example-plugins').subprojects.collect { it.projectDir }
+            ).asPath
+    )
   }
   check.dependsOn(integTest)
 

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy

@@ -25,7 +25,6 @@ import org.elasticsearch.gradle.NoticeTask
 import org.elasticsearch.gradle.test.RestIntegTestTask
 import org.elasticsearch.gradle.test.RunTask
 import org.gradle.api.InvalidUserDataException
-import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.XmlProvider
@@ -39,7 +38,6 @@ import java.nio.file.Path
 import java.nio.file.StandardCopyOption
 import java.util.regex.Matcher
 import java.util.regex.Pattern
-
 /**
  * Encapsulates build configuration for an Elasticsearch plugin.
  */

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginPropertiesExtension.groovy

@@ -56,17 +56,38 @@ class PluginPropertiesExtension {
 
     /** A license file that should be included in the built plugin zip. */
     @Input
-    File licenseFile = null
+    private File licenseFile = null
 
     /**
      * A notice file that should be included in the built plugin zip. This will be
      * extended with notices from the {@code licenses/} directory.
      */
     @Input
-    File noticeFile = null
+    private File noticeFile = null
+
+    Project project = null
 
     PluginPropertiesExtension(Project project) {
         name = project.name
         version = project.version
+        this.project = project
+    }
+
+    File getLicenseFile() {
+        return licenseFile
+    }
+
+    void setLicenseFile(File licenseFile) {
+        project.ext.licenseFile = licenseFile
+        this.licenseFile = licenseFile
+    }
+
+    File getNoticeFile() {
+        return noticeFile
+    }
+
+    void setNoticeFile(File noticeFile) {
+        project.ext.noticeFile = noticeFile
+        this.noticeFile = noticeFile
     }
 }

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginPropertiesTask.groovy

@@ -23,7 +23,6 @@ import org.gradle.api.InvalidUserDataException
 import org.gradle.api.Task
 import org.gradle.api.tasks.Copy
 import org.gradle.api.tasks.OutputFile
-
 /**
  * Creates a plugin descriptor.
  */

buildSrc/src/main/groovy/org/elasticsearch/gradle/test/RestIntegTestTask.groovy

@@ -31,6 +31,7 @@ import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Copy
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.TaskState
+import org.gradle.plugins.ide.idea.IdeaPlugin
 
 import java.nio.charset.StandardCharsets
 import java.nio.file.Files
@@ -243,10 +244,12 @@ public class RestIntegTestTask extends DefaultTask {
                 }
             }
         }
-        project.idea {
-            module {
-                if (scopes.TEST != null) {
-                    scopes.TEST.plus.add(project.configurations.restSpec)
+        if (project.plugins.hasPlugin(IdeaPlugin)) {
+            project.idea {
+                module {
+                    if (scopes.TEST != null) {
+                        scopes.TEST.plus.add(project.configurations.restSpec)
+                    }
                 }
             }
         }

buildSrc/src/test/java/org/elasticsearch/gradle/BuildExamplePluginsIT.java

@@ -0,0 +1,124 @@
+/*
+ * Licensed to Elasticsearch under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.gradle;
+
+import org.apache.commons.io.FileUtils;
+import org.elasticsearch.gradle.test.GradleIntegrationTestCase;
+import org.gradle.testkit.runner.GradleRunner;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.rules.TemporaryFolder;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.StandardOpenOption;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
+public class BuildExamplePluginsIT extends GradleIntegrationTestCase {
+
+    private static List<File> EXTERNAL_PROJECTS = Arrays.stream(
+        Objects.requireNonNull(System.getProperty("test.build-tools.plugin.examples"))
+            .split(File.pathSeparator)
+    ).map(File::new).collect(Collectors.toList());
+
+    @Rule
+    public TemporaryFolder tmpDir = new TemporaryFolder();
+
+    @BeforeClass
+    public static void assertProjectsExist() {
+        List<File> existing = EXTERNAL_PROJECTS.stream().filter(File::exists).collect(Collectors.toList());
+        assertEquals(EXTERNAL_PROJECTS, existing);
+    }
+
+    @AfterClass
+    public static void assertEverythingTested() {
+        assertEquals(
+            "Some example plugins are not tested: " + EXTERNAL_PROJECTS,
+            0, EXTERNAL_PROJECTS.size()
+        );
+    }
+
+    public void testCustomSettings() throws IOException {
+        runAndRemove("custom-settings");
+    }
+
+    public void testPainlessWhitelist() throws IOException {
+        runAndRemove("painless-whitelist");
+    }
+
+    public void testRescore() throws IOException {
+        runAndRemove("rescore");
+    }
+
+    public void testRestHandler() throws IOException {
+        runAndRemove("rest-handler");
+    }
+
+    public void testScriptExpertScoring() throws IOException {
+        runAndRemove("script-expert-scoring");
+    }
+
+    private void runAndRemove(String name) throws IOException {
+        List<File> matches = EXTERNAL_PROJECTS.stream().filter(each -> each.getAbsolutePath().contains(name))
+            .collect(Collectors.toList());
+        assertEquals(
+            "Expected a single project folder to match `" + name + "` but got: " + matches,
+            1, matches.size()
+        );
+
+        EXTERNAL_PROJECTS.remove(matches.get(0));
+
+        FileUtils.copyDirectory(matches.get(0), tmpDir.getRoot());
+        // just get rid of deprecation warnings from now
+        Files.write(
+            tmpDir.newFile("settings.gradle").toPath(), "enableFeaturePreview('STABLE_PUBLISHING')\n".getBytes(StandardCharsets.UTF_8)
+        );
+        // Add a repositories section to be able to resolve from snapshots.
+        // !NOTE! that the plugin build will use be using stale artifacts, not the ones produced in the current build
+        Files.write(
+            new File(tmpDir.getRoot(), "build.gradle").toPath(),
+            ("\n" +
+                "repositories {\n" +
+                "  maven {\n" +
+                "    url \"https://snapshots.elastic.co/maven\"\n" +
+                "    mavenLocal()\n" +
+                "  }\n" +
+                "}\n").getBytes(StandardCharsets.UTF_8),
+            StandardOpenOption.APPEND
+        );
+        Files.write(
+            tmpDir.newFile("NOTICE.txt").toPath(),
+            "dummy test nottice".getBytes(StandardCharsets.UTF_8)
+        );
+
+        GradleRunner.create()
+            // Todo make a copy, write a settings file enabling stable publishing
+            .withProjectDir(tmpDir.getRoot())
+            .withArguments("clean", "check", "-s", "-i", "--warning-mode=all")
+            .withPluginClasspath()
+            .build();
+    }
+
+}

plugins/examples/custom-settings/build.gradle

@@ -17,15 +17,21 @@
  * under the License.
  */
 
-apply plugin: 'elasticsearch.esplugin'
+plugins {
+  id 'elasticsearch.esplugin'
+}
 
 esplugin {
   name 'custom-settings'
   description 'An example plugin showing how to register custom settings'
   classname 'org.elasticsearch.example.customsettings.ExampleCustomSettingsPlugin'
+  licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt')
+  noticeFile rootProject.file('NOTICE.txt')
 }
 
 integTestCluster {
   // Adds a setting in the Elasticsearch keystore before running the integration tests
   keystoreSetting 'custom.secured', 'password'
-}
+}
+
+

plugins/examples/painless-whitelist/build.gradle

@@ -16,14 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-apply plugin: 'elasticsearch.esplugin'
+plugins {
+  id 'elasticsearch.esplugin'
+}
 
 esplugin {
   name 'painless-whitelist'
   description 'An example whitelisting additional classes and methods in painless'
   classname 'org.elasticsearch.example.painlesswhitelist.MyWhitelistPlugin'
   extendedPlugins = ['lang-painless']
+  licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt')
+  noticeFile rootProject.file('NOTICE.txt')
 }
 
 dependencies {

plugins/examples/rescore/build.gradle

@@ -16,11 +16,15 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-apply plugin: 'elasticsearch.esplugin'
+plugins {
+  id 'elasticsearch.esplugin'
+}
 
 esplugin {
   name 'example-rescore'
   description 'An example plugin implementing rescore and verifying that plugins *can* implement rescore'
   classname 'org.elasticsearch.example.rescore.ExampleRescorePlugin'
+  licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt')
+  noticeFile rootProject.file('NOTICE.txt')
 }
+

plugins/examples/rest-handler/build.gradle

@@ -16,13 +16,16 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-apply plugin: 'elasticsearch.esplugin'
+plugins {
+  id 'elasticsearch.esplugin'
+}
 
 esplugin {
   name 'rest-handler'
   description 'An example plugin showing how to register a REST handler'
   classname 'org.elasticsearch.example.resthandler.ExampleRestHandlerPlugin'
+  licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt')
+  noticeFile rootProject.file('NOTICE.txt')
 }
 
 // No unit tests in this example
@@ -40,4 +43,4 @@ integTestCluster {
 }
 integTestRunner {
   systemProperty 'external.address', "${ -> exampleFixture.addressAndPort }"
-}
+}

plugins/examples/script-expert-scoring/build.gradle

@@ -16,13 +16,17 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-
-apply plugin: 'elasticsearch.esplugin'
+plugins {
+  id 'elasticsearch.esplugin'
+}
 
 esplugin {
   name 'script-expert-scoring'
   description 'An example script engine to use low level Lucene internals for expert scoring'
   classname 'org.elasticsearch.example.expertscript.ExpertScriptPlugin'
+  licenseFile rootProject.file('licenses/APACHE-LICENSE-2.0.txt')
+  noticeFile rootProject.file('NOTICE.txt')
 }
 
 test.enabled = false
+