Add contributing task (#605)

* Move check new libraries task into a separate package

* Register contributing task

* Collect information and generate stubs

* Replace stubs with implemented tests

* Generate user-code-filter.json

* Copy resources required for tests

* Add additional dependencies to build.gradle

* Add agent block in build.gradle

* Perform agent run

* Update native build tools version

* Move generated metadata to metadata location

* Collect pull request info and add colored output

* Add command invocation with list of args

* Add required docker images

* Don't use absolute path for detecting tests and metadata directories

* Add check for packages in java files

* Invoke metadataCopy from the command line

* Make scaffold task able to update existing libraries with newer versions

* Move contributing questions into a separate file

* Use template for agent block in build.gradle file

* Enable github pr creation

* Fix broken collecting of default answer

* Remove empty config files and trim metadata/index.json

* Fix yes/no question not waiting for input

* Enable PR creation

* Fix latest label updates

* Remove allowed packages that scaffold generates

* Skip adding new entry when the same entry already exists

* Fail when user wants to provided metadata for already existing library version

* Use gradle wrapper for invoking commands

* Extract check for empty config files

* Ask for permission to delete files

* Ensure metadata files belongs to project

* Use FileSystemOperations

* Use object mapper instead of ConfigurationStringBuilder

* Add contributing task guide

* Avoid deleting in contributing task

* Add custom exception for user errors in contribute task

* Extract recuring questions mechanism into a function

* Minor refactoring

* Use project layout instead of getProject

Author: dnestoro

CONTRIBUTING.md

@@ -21,6 +21,24 @@ Then, point to the local repository in the configuration of either
 
 ## Contribute Metadata
 
+The suggested way to contribute to Reachability metadata repository is by using the `contribute` task.
+Before you start the task, you should have your tests implemented somewhere locally on your machine (please verify that tests are working on Java).
+
+In order to start this task, run (we suggest using `--console=plain` to reduce amount of gradle logging):
+
+```shell
+./gradlew contribute --console=plain
+```
+
+When started, the task will ask you few simple questions (like: where are your tests implemented, do your tests need resources, do your tests need docker images...). 
+In case you don't understand the question, just type "help".
+
+After it collects your answers, the task will:
+- generate necessary boilerplate code
+- copy your tests to the proper location
+- generate metadata and store it in the proper location
+- ask you if you want to create a pull request, or you want to keep working on it locally
+
 ### Checklist
 In order to ensure that all contributions follow the same standards of quality we have devised a following list of requirements for each new added library.
 `org.example:library` project is also included as a template for new libraries.

tests/src/index.json

@@ -179,28 +179,28 @@
     "versions" : [ "2.16.11" ]
   } ]
 }, {
-  "test-project-path" : "io.netty/netty-common/4.1.80.Final",
+  "test-project-path" : "io.netty/netty-common/4.1.115.Final",
   "libraries" : [ {
     "name" : "io.netty:netty-common",
-    "versions" : [ "4.1.80.Final" ]
+    "versions" : [ "4.1.115.Final" ]
   } ]
 }, {
-  "test-project-path" : "io.netty/netty-transport/4.1.80.Final",
+  "test-project-path" : "io.netty/netty-common/4.1.80.Final",
   "libraries" : [ {
-    "name" : "io.netty:netty-transport",
+    "name" : "io.netty:netty-common",
     "versions" : [ "4.1.80.Final" ]
   } ]
 }, {
-  "test-project-path" : "io.netty/netty-common/4.1.115.Final",
+  "test-project-path" : "io.netty/netty-transport/4.1.115.Final",
   "libraries" : [ {
-    "name" : "io.netty:netty-common",
+    "name" : "io.netty:netty-transport",
     "versions" : [ "4.1.115.Final" ]
   } ]
 }, {
-  "test-project-path" : "io.netty/netty-transport/4.1.115.Final",
+  "test-project-path" : "io.netty/netty-transport/4.1.80.Final",
   "libraries" : [ {
     "name" : "io.netty:netty-transport",
-    "versions" : [ "4.1.115.Final" ]
+    "versions" : [ "4.1.80.Final" ]
   } ]
 }, {
   "test-project-path" : "io.opentelemetry/opentelemetry-exporter-jaeger/1.19.0",
@@ -449,16 +449,16 @@
     "versions" : [ "10.15.0" ]
   } ]
 }, {
-  "test-project-path": "org.flywaydb/flyway-core/10.20.0",
-  "libraries": [ {
-        "name": "org.flywaydb:flyway-core",
-        "versions": [ "10.20.0" ]
+  "test-project-path" : "org.flywaydb/flyway-core/10.20.0",
+  "libraries" : [ {
+    "name" : "org.flywaydb:flyway-core",
+    "versions" : [ "10.20.0" ]
   } ]
 }, {
-  "test-project-path": "org.flywaydb/flyway-core/10.20.1",
-  "libraries": [ {
-    "name": "org.flywaydb:flyway-core",
-    "versions": [ "10.20.1" ]
+  "test-project-path" : "org.flywaydb/flyway-core/10.20.1",
+  "libraries" : [ {
+    "name" : "org.flywaydb:flyway-core",
+    "versions" : [ "10.20.1" ]
   } ]
 }, {
   "test-project-path" : "org.flywaydb/flyway-core/9.0.1",
@@ -700,4 +700,4 @@
     "name" : "samples:docker",
     "versions" : [ "image-pull" ]
   } ]
-} ]
+} ]

tests/tck-build-logic/src/main/groovy/org.graalvm.internal.tck-harness.gradle

@@ -10,14 +10,15 @@ plugins {
 }
 
 import groovy.json.JsonOutput
+import org.graalvm.internal.tck.ContributionTask
 import org.graalvm.internal.tck.DockerTask
 import org.graalvm.internal.tck.ConfigFilesChecker
 import org.graalvm.internal.tck.ScaffoldTask
 import org.graalvm.internal.tck.GrypeTask
 import org.graalvm.internal.tck.TestedVersionUpdaterTask
 import org.graalvm.internal.tck.harness.tasks.CheckstyleInvocationTask
-import org.graalvm.internal.tck.harness.tasks.FetchExistingLibrariesWithNewerVersionsTask
-import org.graalvm.internal.tck.harness.tasks.GroupUnsupportedLibraries
+import org.graalvm.internal.tck.updaters.FetchExistingLibrariesWithNewerVersionsTask
+import org.graalvm.internal.tck.updaters.GroupUnsupportedLibraries
 import org.graalvm.internal.tck.harness.tasks.TestInvocationTask
 
 
@@ -164,7 +165,7 @@ Provider<Task> generateMatrixDiffCoordinates = tasks.register("generateMatrixDif
     }
 }
 
-// groovy tasks
+// new library version updaters tasks
 tasks.register("fetchExistingLibrariesWithNewerVersions", FetchExistingLibrariesWithNewerVersionsTask.class) { task ->
     task.setGroup(METADATA_GROUP)
     task.setDescription("Returns list of all libraries coordinates")
@@ -176,7 +177,13 @@ tasks.register("groupLibrariesByName", GroupUnsupportedLibraries.class) { task -
     task.setDescription("Extracts groups of libraries from github comments provided in a form of string.")
 }
 
-// java tasks
+
+tasks.register("addTestedVersion", TestedVersionUpdaterTask.class) { task ->
+    task.setDescription("Updates list of tested versions.")
+    task.setGroup(METADATA_GROUP)
+}
+
+// docker tasks
 tasks.register("checkAllowedDockerImages", GrypeTask.class) { task ->
     task.setDescription("Returns list of allowed docker images")
     task.setGroup(METADATA_GROUP)
@@ -187,19 +194,21 @@ tasks.register("pullAllowedDockerImages", DockerTask.class) { task ->
     task.setGroup(METADATA_GROUP)
 }
 
+
+// contributing tasks
 tasks.register("scaffold", ScaffoldTask.class) { task ->
     task.setDescription("Creates a metadata and test scaffold for the given coordindates")
     task.setGroup(METADATA_GROUP)
     // Format JSON after task has been run
     task.finalizedBy("spotlessApply")
 }
 
-tasks.register("checkConfigFiles", ConfigFilesChecker.class) { task ->
-    task.setDescription("Checks content of config files for a new library.")
+tasks.register("contribute", ContributionTask.class) { task ->
+    task.setDescription("Generates metadata and prepares pull request for contibuting on metadata repository based on provided tests.")
     task.setGroup(METADATA_GROUP)
 }
 
-tasks.register("addTestedVersion", TestedVersionUpdaterTask.class) { task ->
-    task.setDescription("Updates list of tested versions.")
+tasks.register("checkConfigFiles", ConfigFilesChecker.class) { task ->
+    task.setDescription("Checks content of config files for a new library.")
     task.setGroup(METADATA_GROUP)
 }

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/TckExtension.java

@@ -18,11 +18,9 @@
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
 import org.gradle.process.ExecOperations;
-import org.gradle.util.internal.VersionNumber;
 
 import javax.inject.Inject;
 import java.io.ByteArrayOutputStream;
-import java.io.File;
 import java.io.IOException;
 import java.net.URI;
 import java.nio.charset.StandardCharsets;

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/tasks/FetchExistingLibrariesWithNewerVersionsTask.groovy renamed to tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/updaters/FetchExistingLibrariesWithNewerVersionsTask.groovy

@@ -1,4 +1,4 @@
-package org.graalvm.internal.tck.harness.tasks
+package org.graalvm.internal.tck.updaters
 
 
 import com.fasterxml.jackson.annotation.JsonInclude

tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/harness/tasks/GroupUnsupportedLibraries.groovy renamed to tests/tck-build-logic/src/main/groovy/org/graalvm/internal/tck/updaters/GroupUnsupportedLibraries.groovy

@@ -1,4 +1,4 @@
-package org.graalvm.internal.tck.harness.tasks
+package org.graalvm.internal.tck.updaters
 
 import org.gradle.api.DefaultTask
 import org.gradle.api.provider.Property