Add contributing task #605
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhalbritter
reviewed
Mar 21, 2025
| @TaskAction | ||
| void run() throws IOException { | ||
| InteractiveTaskUtils.printUserInfo("Hello! This task will help you contributing to metadata repository." + | ||
| " Please answer the following contributingQuestions. In case you don't know the answer on the question, type \"help\" for more information"); |
There was a problem hiding this comment.
Please answer the following contributingQuestions
I would reword that to: "Please answer the following questions".
|
Okay, after cleaning up some empty directories it now continues, but then crashes with: I'm using |
|
Okay, i retried with a GraalVM 17, and now it looks better. One thing to note: I first added metadata for 2.12, and then for 2.11. Now the metadata index.json looks like this: [ {
"metadata-version" : "2.12",
"tested-versions" : [ "2.12" ],
"module" : "de.mkammerer:argon2-jvm"
}, {
"metadata-version" : "2.11",
"tested-versions" : [ "2.11" ],
"latest" : true,
"module" : "de.mkammerer:argon2-jvm"
} ]I don't think the |
|
I also noticed in the {
"allowed-packages" : [ "de.mkammerer.argon2", "de.mkammerer" ],
"directory" : "de.mkammerer/argon2-jvm",
"module" : "de.mkammerer:argon2-jvm"
}I get where the |
|
Now I've tried to add tests which not only need JUnit, but also some more dependencies (in this case In the first run, I've omitted Awaitility just to see what happens, and it breaks (which I guess is expected): Then i reran [ {
"metadata-version" : "2.12",
"tested-versions" : [ "2.12" ],
"module" : "de.mkammerer:argon2-jvm"
}, {
"metadata-version" : "2.12",
"tested-versions" : [ "2.12" ],
"latest" : true,
"module" : "de.mkammerer:argon2-jvm"
} ]The first |
mhalbritter
reviewed
Mar 21, 2025
| private void createStubs(boolean shouldUpdate){ | ||
| InteractiveTaskUtils.printUserInfo("Generating stubs for: " + coordinates ); | ||
| if (shouldUpdate) { | ||
| invokeCommand("gradle scaffold --coordinates " + coordinates + " --update", "Cannot generate stubs for: " + coordinates); |
There was a problem hiding this comment.
I'd use the gradle wrapper here, as using the global gradle can lead to all sort of problems if the versions don't match.
| Path allTests = originalTestsLocation.resolve("."); | ||
|
|
||
| InteractiveTaskUtils.printUserInfo("Removing dummy test stubs"); | ||
| invokeCommand("rm -r " + destination, "Cannot delete files from: " + destination); |
There was a problem hiding this comment.
This won't work under Windows. And please make sure that the destination are really the tests (maybe by double-checking that the destination is under the project dir), as this could be dangerous.
There was a problem hiding this comment.
I added additional check that the absolute path (of the file we want to delete) starts with the absolute path of the project (see this). The check is now used in the following places: here and here.
Besides that, the task now also asks user for explicit confirmation that it can delete certain file. Check this
There was a problem hiding this comment.
Replaced with:
ensureFileBelongsToProject(destination);
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");
}
InteractiveTaskUtils.printUserInfo("Removing dummy test stubs");
getFileSystemOperations().delete(deleteSpec -> deleteSpec.delete(destination));
Which first checks that the destination path begins with the project path and then asks user for explicit confirmation that a file on the given location can be removed (@mhalbritter do you think that it makes sense, or you have a suggestion for some additional check?)
For Windows support, I am now using built in gradle FileSystemOperations. cc @melix
| invokeCommand("rm -r " + destination, "Cannot delete files from: " + destination); | ||
|
|
||
| InteractiveTaskUtils.printUserInfo("Copying tests from: " + originalTestsLocation + " to " + destination); | ||
| invokeCommand("cp -a " + allTests + " " + destination, "Cannot copy files to: " + destination); |
There was a problem hiding this comment.
Won't work under windows.
There was a problem hiding this comment.
Replaced with Gradle's FileSystemOperations:
getFileSystemOperations().copy(copySpec -> {
copySpec.from(allTests);
copySpec.into(destination);
})
| Path destination = testsDirectory.resolve("src").resolve("test"); | ||
| InteractiveTaskUtils.printUserInfo("Copying resources from: " + originalResourcesDirectory + " to " + destination); | ||
|
|
||
| invokeCommand("cp -r " + originalResourcesDirectory + " " + destination, "Cannot copy files to: " + destination); |
There was a problem hiding this comment.
Won't work under Windows.
There was a problem hiding this comment.
Replaced with Gradle's FileSystemOperations:
getFileSystemOperations().copy(copySpec -> {
copySpec.from(originalResourcesDirectory);
copySpec.into(destination);
});
| private void addUserCodeFilterFile(List<String> packages) throws IOException { | ||
| InteractiveTaskUtils.printUserInfo("Generating " + USER_CODE_FILTER_FILE); | ||
|
|
||
| ConfigurationStringBuilder sb = new ConfigurationStringBuilder(); |
There was a problem hiding this comment.
Wouldn't be an object which is then written to JSON via the ObjectMapper better here?
| invokeCommand("git", List.of("commit", "-m", "Add metadata for " + coordinates), "Cannot commit changes", null); | ||
|
|
||
| InteractiveTaskUtils.printUserInfo("Pushing changes"); | ||
| invokeCommand("git push origin " + branch, "Cannot push to origin"); |
There was a problem hiding this comment.
This assumes you are working on a fork, right? Because that would fail if a user just cloned the reachability repo and doesn't have write privileges to the repo.
There was a problem hiding this comment.
No, I think that you don't need any privileges to push branch directly to metadata repo. We have many branches open directly on the repo.
| public class FilesUtils { | ||
|
|
||
| public static void findJavaFiles(Path root, List<Path> result) { | ||
| if (Files.exists(root) && Files.isRegularFile(root) && root.toString().endsWith(".java")) { |
There was a problem hiding this comment.
This could also be implemented with java.nio.file.Files#walkFileTree().
| }, | ||
| { | ||
| "question-key": "testsLocation", | ||
| "question": "Where are your tests implemented? Absolute path to the directory containing java packages where you implemented tests: ", |
There was a problem hiding this comment.
I'd reword that. It wasn't clear to me that those are the existing tests for the library I want to add.
| { | ||
| "question-key": "additionalDependencies", | ||
| "question": "What additional testImplementation dependencies you want to include? Enter the next dependency (to stop type \"-\")", | ||
| "help": "Enter the testImplementation dependencies (pres enter after each dependency) you want to include use in tests. Provide dependencies in form of Maven coordinates. Maven coordinates consist of three parts in the following format \"groupId:artifactId:version\". For more information visit: https://maven.apache.org/repositories/artifacts.html When you finish adding dependencies, type \"-\" to terminate the inclusion process" |
There was a problem hiding this comment.
Typo: "pres" instead of "press".
| { | ||
| "question-key": "shouldCreatePullRequest", | ||
| "question": "Do you want to create a pull request to the reachability metadata repository [Y/n]:", | ||
| "help": "In case you want to open a pull request to Reachability metadata repository automatically, type \"y\". This way the task will create a new branch for you, commit changes with a proper message, and push the branch remotly. At the end, the task will give you a link to the Github repository where you should fill in a pull request checkslist and complete the process." |
this issue is already reported here |
It came from the |
@mhalbritter I am now throwing an exception in case you want to provide support for the library + same version of it, if it already exists. See this |
melix
reviewed
Mar 24, 2025
There was a problem hiding this comment.
I didn't take a look yet, just something that was obvious in the first place: you are invoking CLI in many places, but you shouldn't do this. You are running as a Gradle plugin, so you should use the Gradle constructs which are cross platform, e.g FileSystemOperations.
|
@melix @mhalbritter thanks for the feedback. I will refactor the PR to avoid using CLI, and ping you again when the PR is ready for review again. Until then, I will move this PR into a draft state, so please ignore incoming changes and don't test it until I finish refactoring |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds interactive task that helps users to contribute to the metadata repository. The user only needs to provide path to tests and answer few questions in order to make a fully usable pull request.
For reviewers: