TRUNK-6252: Conditional resource path should be interpreted as a globs #4830
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
ibacher
changed the title
dkayiwa
reviewed
Nov 14, 2024
| @@ -644,7 +648,15 @@ public Document getConfig() { | |||
| public void setConfig(Document config) { | |||
| this.config = config; | |||
| } | |||
|
|
|||
|
|
|||
| public String getConfigVersion() { | |||
There was a problem hiding this comment.
Can we put @since annotations on these? https://openmrs.atlassian.net/wiki/spaces/docs/pages/25477044/Java+Conventions#New-Public-Methods-and-Classes
dkayiwa
reviewed
Nov 14, 2024
| @@ -405,6 +408,41 @@ static boolean shouldResourceBeIncluded(Module module, URL fileUrl, String openm | |||
| return include; | |||
| } | |||
|
|
|||
| static boolean isMatchingConditionalResource(Module module, URL fileUrl, ModuleConditionalResource conditionalResource) { | |||
There was a problem hiding this comment.
Did you intentionally decide not to make this method private?
There was a problem hiding this comment.
Yes it was intentional, I think it was important to unit test this method separately from shouldResourceBeIncluded to make sure it is returning true/false based on the pattern matching rather than the logic of shouldResourceBeIncluded. I made it package-private for this reason.
…rather than a Regex
wikumChamith
pushed a commit
to wikumChamith/openmrs-core
that referenced
this pull request
Nov 18, 2024
…rather than a Regex (openmrs#4830) (cherry picked from commit fd0685a)
wikumChamith
pushed a commit
to wikumChamith/openmrs-core
that referenced
this pull request
Nov 18, 2024
…rather than a Regex (openmrs#4830) (cherry picked from commit fd0685a)
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.
Description of what I changed
This PR updates the logic to use globs instead of regex when matching conditional resources. This logic is only applied to config versions 2.0 and onwards, earlier config.xml versions will still use regex.
The default pattern is
glob:**/%sto make it agnostic to absolute paths, allowing users to focus on matching relative paths instead.This change also includes adding the config.xml version to the
Moduleclass asconfigVersionto allow us to check if we should use glob or regex logic. This PR also uses theModuleUtil.matchRequiredVersionsfunction as this seems to work well for configVersions that only have two parts like 2.0.I tried to add parameterized tests to cover different glob input patterns and config versions, please let me know if you notice any other patterns that should be included.
Issue I worked on
see https://issues.openmrs.org/browse/TRUNK-6252
Checklist: I completed these to help reviewers :)
My IDE is configured to follow the code style of this project.
No? Unsure? -> configure your IDE, format the code and add the changes with
git add . && git commit --amendI have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)
No? -> write tests and add them to this commit
git add . && git commit --amendI ran
mvn clean packageright before creating this pull request andadded all formatting changes to my commit.
No? -> execute above command
All new and existing tests passed.
No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
My pull request is based on the latest changes of the master branch.
No? Unsure? -> execute command
git pull --rebase upstream master