raise error for empty violation store and delete empty rule file #1405
+139
−2
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
maxxkia
force-pushed
the
extension-for-empty-frozen-rule
branch
5 times, most recently
from
a833065 to
90c5338
Compare
maxxkia
commented
Jan 19, 2025
| @@ -73,11 +73,17 @@ public final class TextFileBasedViolationStore implements ViolationStore { | |||
| private static final String ALLOW_STORE_CREATION_DEFAULT = "false"; | |||
| private static final String ALLOW_STORE_UPDATE_PROPERTY_NAME = "default.allowStoreUpdate"; | |||
| private static final String ALLOW_STORE_UPDATE_DEFAULT = "true"; | |||
| private static final String DELETE_EMPTY_RULE_VIOLATION_PROPERTY_NAME = "default.deleteEmptyRuleViolation"; | |||
| private static final String DELETE_EMPTY_RULE_VIOLATION_DEFAULT = "false"; | |||
There was a problem hiding this comment.
we can discuss the above default value. I would prefer to have default true here, but I'd like to first hear the opinions from the maintainers.
maxxkia
commented
Jan 19, 2025
| @@ -140,15 +148,38 @@ public boolean contains(ArchRule rule) { | |||
| @Override | |||
| public void save(ArchRule rule, List<String> violations) { | |||
| log.trace("Storing evaluated rule '{}' with {} violations: {}", rule.getDescription(), violations.size(), violations); | |||
| if (violations.isEmpty() && warnEmptyRuleViolation) { | |||
There was a problem hiding this comment.
this check has to be placed here at the top, because for empty frozen rule violations you don't necessarily need to update the store. By seeing such warning the developer could change the test to non-freezing rather than decide to update the store.
maxxkia
changed the title
These changes introduce two new features for FreezingRule default store * Raise error when a freezing rule has zero violations. This can be enabled by setting the property `default.warnEmptyRuleViolation=true`. For backward compatibility it is disabled by default. * Skip rule violation file creation or delete if it already exists, when there are zero violations. This can be enabled by setting the property `default.deleteEmptyRuleViolation=true`, it is disabled by default. Signed-off-by: Masoud Kiaeeha <[email protected]> Resolves TNG#1264
maxxkia
force-pushed
the
extension-for-empty-frozen-rule
branch
from
90c5338 to
60de7ab
Compare
maxxkia
commented
Jan 19, 2025
| throw new StoreEmptyException(String.format("Saving empty violations for freezing rule is disabled (enable by configuration %s.%s=true)", | ||
| ViolationStoreFactory.FREEZE_STORE_PROPERTY_NAME, WARN_EMPTY_RULE_VIOLATION_PROPERTY_NAME)); | ||
| } | ||
| if (violations.isEmpty() && deleteEmptyRule && !contains(rule)) { |
There was a problem hiding this comment.
another way to write this check would be
Suggested change
| if (violations.isEmpty() && deleteEmptyRule && !contains(rule)) { | |
| if (violations.isEmpty() && (deleteEmptyRule || skipEmptyRule) && !contains(rule)) { |
where skipEmptyRule condition is only used for skipping creation of empty rule file. To keep the configuration simple, I decided to use deleteEmptyRule for both skipping file creation and deleting the empty file.
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.
These changes introduce two new features for FreezingRule default store
default.warnEmptyRuleViolation=true. For backward compatibility it is disabled by default.default.deleteEmptyRuleViolation=true, it is disabled by default.Signed-off-by: Masoud Kiaeeha [email protected]
Resolves #1264