Avoid deleting in contributing task

Author: dnestoro

CONTRIBUTING.md

@@ -21,7 +21,7 @@ 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 `contributing` task.
+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):
@@ -34,7 +34,7 @@ When started, the task will ask you few simple questions (like: where are your t
 In case you don't understand the question, just type "help".
 
 After it collects your answers, the task will:
-- generate necessary infrastructure
+- 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

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",
@@ -443,16 +443,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",
@@ -622,6 +622,12 @@
     "name" : "org.mockito:mockito-core",
     "versions" : [ "5.0.0" ]
   } ]
+}, {
+  "test-project-path" : "org.mockito/mockito-core/5.1.0",
+  "libraries" : [ {
+    "name" : "org.mockito:mockito-core",
+    "versions" : [ "5.1.0" ]
+  } ]
 }, {
   "test-project-path" : "org.opengauss/opengauss-jdbc/3.1.0-og",
   "libraries" : [ {
@@ -688,4 +694,4 @@
     "name" : "samples:docker",
     "versions" : [ "image-pull" ]
   } ]
-} ]
+} ]

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/ContributionTask.java

@@ -7,10 +7,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import org.graalvm.internal.tck.model.MetadataIndexEntry;
-import org.graalvm.internal.tck.model.contributing.PredefinedClassesConfigModel;
-import org.graalvm.internal.tck.model.contributing.ResourceConfigModel;
 import org.graalvm.internal.tck.model.contributing.Question;
-import org.graalvm.internal.tck.model.contributing.SerializationConfigModel;
 import org.graalvm.internal.tck.utils.ConfigurationStringBuilder;
 import org.graalvm.internal.tck.utils.FilesUtils;
 import org.graalvm.internal.tck.utils.InteractiveTaskUtils;
@@ -112,9 +109,6 @@ void run() throws IOException {
         // run agent in conditional mode
         collectMetadata();
 
-        // remove empty files
-        removeEmptyConfigFiles();
-
         // create a PR
         boolean shouldCreatePR = shouldCreatePullRequest();
         if (shouldCreatePR) {
@@ -285,13 +279,13 @@ private List<Coordinates> getAdditionalDependencies() {
     private void createStubs(boolean shouldUpdate){
         InteractiveTaskUtils.printUserInfo("Generating stubs for: " + coordinates );
         if (shouldUpdate) {
-            invokeCommand(gradlew + " scaffold --coordinates " + coordinates + " --update", "Cannot generate stubs for: " + coordinates);
+            invokeCommand(gradlew + " scaffold --coordinates " + coordinates + " --skipTests --update ", "Cannot generate stubs for: " + coordinates);
         } else {
-            invokeCommand(gradlew + " scaffold --coordinates " + coordinates, "Cannot generate stubs for: " + coordinates);
+            invokeCommand(gradlew + " scaffold --coordinates " + coordinates + " --skipTests", "Cannot generate stubs for: " + coordinates);
         }
     }
 
-    private void updateAllowedPackages(List<String> allowedPackages, boolean isAlreadyExistingLibrary) throws IOException {
+    private void updateAllowedPackages(List<String> allowedPackages, boolean libraryAlreadyExists) throws IOException {
         InteractiveTaskUtils.printUserInfo("Updating allowed packages in: " + METADATA_INDEX);
         File metadataIndex = getProject().file(METADATA_INDEX);
 
@@ -307,7 +301,7 @@ private void updateAllowedPackages(List<String> allowedPackages, boolean isAlrea
             Set<String> extendedAllowedPackages = new HashSet<>();
             MetadataIndexEntry replacedEntry = entries.remove(replaceEntryIndex);
 
-            if (isAlreadyExistingLibrary) {
+            if (libraryAlreadyExists) {
                 // we don't want to break existing tests, so we must add existing allowed packages
                 extendedAllowedPackages.addAll(replacedEntry.allowedPackages());
             }
@@ -329,14 +323,6 @@ private void addTests(Path originalTestsLocation){
         Path allTests = originalTestsLocation.resolve(".");
 
         ensureFileBelongsToProject(destination);
-        InteractiveTaskUtils.printUserInfo("Removing dummy test stubs");
-        boolean shouldDelete = InteractiveTaskUtils.askForDeletePermission(destination);
-        if (!shouldDelete) {
-            throw new RuntimeException("The task didn't get permission to delete dummy stubs. Cannot proceed with the task execution");
-        }
-
-        getFileSystemOperations().delete(deleteSpec -> deleteSpec.delete(destination));
-
         InteractiveTaskUtils.printUserInfo("Copying tests from: " + originalTestsLocation + " to " + destination);
         getFileSystemOperations().copy(copySpec -> {
             copySpec.from(allTests);
@@ -350,6 +336,8 @@ private void addResources(Path originalResourcesDirectory){
         }
 
         Path destination = testsDirectory.resolve("src").resolve("test").resolve("resources");
+        ensureFileBelongsToProject(destination);
+
         InteractiveTaskUtils.printUserInfo("Copying resources from: " + originalResourcesDirectory + " to " + destination);
         getFileSystemOperations().copy(copySpec -> {
            copySpec.from(originalResourcesDirectory);
@@ -364,6 +352,8 @@ private void addDockerImages(List<String> images) throws IOException {
 
         InteractiveTaskUtils.printUserInfo("Adding following docker images to " + REQUIRED_DOCKER_IMAGES_FILE + ": " + images);
         Path destination = testsDirectory.resolve(REQUIRED_DOCKER_IMAGES_FILE);
+        ensureFileBelongsToProject(destination);
+
         if (!Files.exists(destination)) {
             Files.createFile(destination);
         }
@@ -428,7 +418,6 @@ private void addAgentConfigBlock() {
             throw new RuntimeException("Cannot add agent block to " + buildFilePath + ". Please check if a " + BUILD_FILE + " exists on that location.");
         }
 
-
         try(InputStream stream = ContributionTask.class.getResourceAsStream("/contributing/agent.template")) {
             if (stream == null) {
                 throw new RuntimeException("Cannot find template for the graalvm configuration block");
@@ -449,101 +438,6 @@ private void collectMetadata() {
         invokeCommand(gradlew + " metadataCopy --task test --dir " + metadataDirectory, "Cannot perform metadata copy", testsDirectory);
     }
 
-    private enum CONFIG_FILES {
-        RESOURCE("resource-config.json"),
-        REFLECTION("reflect-config.json"),
-        SERIALIZATION("serialization-config.json"),
-        JNI("jni-config.json"),
-        PROXY("proxy-config.json"),
-        PREDEFINED_CLASSES("predefined-classes-config.json");
-
-        private final String value;
-        public String get() {
-            return value;
-        }
-
-        CONFIG_FILES(String val) {
-            this.value = val;
-        }
-    }
-
-    private void removeEmptyConfigFiles() throws IOException {
-        Path indexFile = metadataDirectory.resolve("index.json");
-        List<CONFIG_FILES> remainingFiles = new LinkedList<>(Arrays.asList(CONFIG_FILES.values()));
-
-        Path resourceConfigPath = metadataDirectory.resolve(CONFIG_FILES.RESOURCE.get());
-        ResourceConfigModel resourceConfig = objectMapper.readValue(resourceConfigPath.toFile(), new TypeReference<>() {});
-        if (resourceConfig.isEmpty()) {
-            removeConfigFile(resourceConfigPath, CONFIG_FILES.RESOURCE, remainingFiles);
-        }
-
-        Path serializationConfigPath = metadataDirectory.resolve(CONFIG_FILES.SERIALIZATION.get());
-        SerializationConfigModel serializationConfig = objectMapper.readValue(serializationConfigPath.toFile(), new TypeReference<>() {});
-        if (serializationConfig.isEmpty()) {
-            removeConfigFile(serializationConfigPath, CONFIG_FILES.SERIALIZATION, remainingFiles);
-        }
-
-        Path jniConfigPath = metadataDirectory.resolve(CONFIG_FILES.JNI.get());
-        List<Object> jniConfig = objectMapper.readValue(jniConfigPath.toFile(), new TypeReference<>() {});
-        if (jniConfig.isEmpty()) {
-            removeConfigFile(jniConfigPath, CONFIG_FILES.JNI, remainingFiles);
-        }
-
-        Path proxyConfigPath = metadataDirectory.resolve(CONFIG_FILES.PROXY.get());
-        List<Object> proxyConfig = objectMapper.readValue(proxyConfigPath.toFile(), new TypeReference<>() {});
-        if (proxyConfig.isEmpty()) {
-            removeConfigFile(proxyConfigPath, CONFIG_FILES.PROXY, remainingFiles);
-        }
-
-        Path reflectConfigPath = metadataDirectory.resolve(CONFIG_FILES.REFLECTION.get());
-        List<Object> reflectConfig = objectMapper.readValue(reflectConfigPath.toFile(), new TypeReference<>() {});
-        if (reflectConfig.isEmpty()) {
-            removeConfigFile(reflectConfigPath, CONFIG_FILES.REFLECTION, remainingFiles);
-        }
-
-        Path predefinedClassesConfigPath = metadataDirectory.resolve(CONFIG_FILES.PREDEFINED_CLASSES.get());
-        List<PredefinedClassesConfigModel> predefinedClassesConfig = objectMapper.readValue(predefinedClassesConfigPath.toFile(), new TypeReference<>() {});
-        if (predefinedClassesConfig.size() == 1) {
-            if (predefinedClassesConfig.get(0).isEmpty()) {
-                removeConfigFile(predefinedClassesConfigPath, CONFIG_FILES.PREDEFINED_CLASSES, remainingFiles);
-            }
-        }
-
-        Path agentExtractedPredefinedClasses = metadataDirectory.resolve("agent-extracted-predefined-classes");
-        if (Files.exists(agentExtractedPredefinedClasses)) {
-            File[] extractedPredefinedClasses = agentExtractedPredefinedClasses.toFile().listFiles();
-            if (extractedPredefinedClasses == null || extractedPredefinedClasses.length == 0) {
-                ensureFileBelongsToProject(agentExtractedPredefinedClasses);
-
-                InteractiveTaskUtils.printUserInfo("Removing empty: agent-extracted-predefined-classes");
-                boolean canDelete = InteractiveTaskUtils.askForDeletePermission(agentExtractedPredefinedClasses);
-                if (canDelete) {
-                    getFileSystemOperations().delete(deleteSpec -> deleteSpec.delete(agentExtractedPredefinedClasses));
-                }
-            }
-        }
-
-        trimIndexFile(indexFile, remainingFiles);
-    }
-
-    private void removeConfigFile(Path path, CONFIG_FILES file, List<CONFIG_FILES> remainingFiles) {
-        ensureFileBelongsToProject(path);
-
-        InteractiveTaskUtils.printUserInfo("Removing empty: " + file.get());
-        boolean canDelete = InteractiveTaskUtils.askForDeletePermission(path);
-        if (canDelete) {
-            getFileSystemOperations().delete(deleteSpec -> deleteSpec.delete(path));
-            remainingFiles.remove(file);
-        }
-    }
-
-    private void trimIndexFile(Path index, List<CONFIG_FILES> remainingFiles) throws IOException {
-        InteractiveTaskUtils.printUserInfo("Removing sufficient entries from: " + index);
-        DefaultPrettyPrinter prettyPrinter = new DefaultPrettyPrinter();
-        prettyPrinter.indentArraysWith(DefaultIndenter.SYSTEM_LINEFEED_INSTANCE);
-        objectMapper.writer(prettyPrinter).writeValue(index.toFile(), remainingFiles.stream().map(CONFIG_FILES::get).toList());
-    }
-
     private boolean shouldCreatePullRequest() {
         ContributingQuestion question = questions.get("shouldCreatePullRequest");
         return InteractiveTaskUtils.askYesNoQuestion(question.question(), question.help(), true);

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/ScaffoldTask.java

@@ -39,6 +39,7 @@ class ScaffoldTask extends DefaultTask {
 
     private boolean force;
     private boolean update;
+    private boolean skipTests;
 
     public ScaffoldTask() {
     }
@@ -64,6 +65,11 @@ void setUpdate(boolean update) {
         this.update = update;
     }
 
+    @Option(option = "skipTests", description = "Skip adding test stubs")
+    void setSkipTests(boolean skip) {
+        this.skipTests = skip;
+    }
+
     @TaskAction
     void run() throws IOException {
         Coordinates coordinates = Coordinates.parse(this.coordinates);
@@ -196,10 +202,12 @@ private void writeTestScaffold(Path coordinatesTestRoot, Coordinates coordinates
         );
 
         // src/test/java/
-        writeToFile(
-                coordinatesTestRoot.resolve(CoordinateUtils.replace("src/test/java/$sanitizedGroup$/$sanitizedArtifact$/$capitalizedSanitizedArtifact$Test.java", coordinates)),
-                CoordinateUtils.replace(loadResource("/scaffold/Test.java.template"), coordinates)
-        );
+        if (!skipTests) {
+            writeToFile(
+                    coordinatesTestRoot.resolve(CoordinateUtils.replace("src/test/java/$sanitizedGroup$/$sanitizedArtifact$/$capitalizedSanitizedArtifact$Test.java", coordinates)),
+                    CoordinateUtils.replace(loadResource("/scaffold/Test.java.template"), coordinates)
+            );
+        }
     }
 
     private void writeCoordinatesMetadataVersionJsons(Path metadataVersionRoot, Coordinates coordinates) throws IOException {

tests/tck-build-logic/src/main/java/org/graalvm/internal/tck/model/contributing/PredefinedClassesConfigModel.java

@@ -1,6 +1,5 @@
 package org.graalvm.internal.tck.utils;
 
-import java.nio.file.Path;
 import java.util.Scanner;
 import java.util.function.Function;
 
@@ -53,15 +52,6 @@ public static boolean askYesNoQuestion(String question, String helpMessage, bool
         }
     }
 
-    public static boolean askForDeletePermission(Path file) {
-        String question = "The contributing task would like to delete following file: " + file +
-                ". If this file is not generated by the task, please report the error on the metadata repository. " +
-                "Do you confirm that contributing task can delete this file? [y/N]";
-        String help = "The task should only remove dummy files generated in the previous step. Please verify that the following file can be removed: " + file;
-
-        return askYesNoQuestion(question, help, false);
-    }
-
     public static void closeSection() {
         ColoredOutput.println("------------------------------------------------------------------------------------------", ColoredOutput.OUTPUT_COLOR.BLUE);
     }