Add git support for compatibility checker #17684
Open
+111
−0
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
github-actions
bot
added
tools
build
cmccabe
reviewed
Nov 5, 2024
| * @param contents The path to read the file from. | ||
| * @return The MessageSpec. | ||
| */ | ||
| static MessageSpec readMessageSpecFromString(String contents) { |
There was a problem hiding this comment.
we don't need to create a file to translate a string to a MessageSpec, we can do this directly.
cmccabe
reviewed
Nov 5, 2024
| * @param fileCheckMetadata The file to read from remote git repo. | ||
| * @return The file contents. | ||
| */ | ||
| static String GetDataFromGit(String fileCheckMetadata) throws IOException { |
There was a problem hiding this comment.
I don't understand why the parameter is named fileCheckMetadata, can you explain?
cmccabe
reviewed
Nov 5, 2024
| try (TreeWalk treeWalk = new TreeWalk(repository)) { | ||
| treeWalk.addTree(tree); | ||
| treeWalk.setRecursive(true); | ||
| treeWalk.setFilter(PathFilter.create(String.valueOf(Paths.get("metadata/src/main/resources/common/metadata/" + fileCheckMetadata)))); |
There was a problem hiding this comment.
please use a constant for metadata/src/main/resources/common/metadata
cmccabe
reviewed
Nov 5, 2024
| @@ -56,6 +73,11 @@ public static void run( | |||
| evolutionVerifierParser.addArgument("--path2", "-2"). | |||
| required(true). | |||
| help("The final schema JSON path."); | |||
| Subparser evolutionGitVerifierParser = subparsers.addParser("verify-evolution-git"). | |||
| help(" Verify that an evolution of a JSon file is valid using git. "); | |||
cmccabe
reviewed
Nov 5, 2024
| String fileCheckMetadata = namespace.getString("file"); | ||
| String gitContent = GetDataFromGit(fileCheckMetadata); | ||
| EvolutionVerifier verifier = new EvolutionVerifier( | ||
| CheckerUtils.readMessageSpecFromFile(Paths.get("").toAbsolutePath().getParent() + "/metadata/src/main/resources/common/metadata/" + fileCheckMetadata), |
There was a problem hiding this comment.
in general I don't understand what the strategy is here for paths. if you are using a relative path, you need to document what directory we need to be in. how are we locating the git repository root?
cmccabe
reviewed
Nov 5, 2024
| @@ -37,6 +37,8 @@ | |||
|
|
|||
| import static net.sourceforge.argparse4j.impl.Arguments.store; | |||
|
|
|||
| import org.eclipse.jgit.api.Git; | |||
There was a problem hiding this comment.
why is this import needed here?
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.
Add git support for schema compatibility checker. Pulls in valid schema from remote git trunk branch to check with edited schema in local branch. Adds new option for command line
verify-evolution-gitwhich takes in a required file name