Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<!--suppress XmlUnresolvedReference -->
<skipChecks>${skipTests}</skipChecks>

<unusedPropertyRule.suppressions>junit.version,kept-for-compat.version</unusedPropertyRule.suppressions>
<pmd.version>7.22.0</pmd.version>
<junit.version>6.0.3</junit.version>
</properties>
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/com/solubris/enforcer/UnusedPropertyRule.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@

import javax.inject.Inject;
import javax.inject.Named;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.atomic.LongAdder;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
Expand All @@ -28,6 +30,7 @@
@Named("unusedPropertyRule")
public class UnusedPropertyRule extends AbstractEnforcerRule {
private static final Pattern PROPERTY_PATTERN = Pattern.compile("\\$\\{([^}]+)\\}");
protected static final String SUPPRESSIONS_PROPERTY = "unusedPropertyRule.suppressions";

private final Model originalModel;
private final Model effectiveModel;
Expand Down Expand Up @@ -66,8 +69,12 @@ protected Stream<String> scanProperties() {
// .filter(artifact -> !isExcluded(artifact.getVersion()))
.collect(groupingBy(ArtifactV2::getVersion, toList()));

String property = originalModel.getProperties().getProperty(SUPPRESSIONS_PROPERTY);
Set<String> suppressed = parseSuppressedPropertyList(property);

return originalModel.getProperties().entrySet().stream()
.filter(UnusedPropertyRule::isVersionProperty) // only check properties that look like versions
.filter(e -> !suppressed.contains(e.getKey().toString()))
.map(e -> {
String propName = e.getKey().toString();
String propValue = e.getValue() != null ? e.getValue().toString() : "";
Expand All @@ -76,6 +83,14 @@ protected Stream<String> scanProperties() {
}).filter(Objects::nonNull);
}

private static Set<String> parseSuppressedPropertyList(String raw) {
if (raw == null || raw.isBlank()) return Collections.emptySet();
return Arrays.stream(raw.split("[,\\s]+"))
.map(String::trim)
.filter(s -> !s.isEmpty())
.collect(Collectors.toSet());
}

private static boolean isVersionProperty(Map.Entry<Object, Object> e) {
return e.getKey().toString().endsWith(".version");
}
Expand Down
11 changes: 11 additions & 0 deletions src/test/java/com/solubris/enforcer/UnusedPropertyRuleTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import static com.solubris.enforcer.ModelStubber.extensionOf;
import static com.solubris.enforcer.ModelStubber.pluginOf;
import static com.solubris.enforcer.ModelStubber.reportPluginOf;
import static com.solubris.enforcer.UnusedPropertyRule.SUPPRESSIONS_PROPERTY;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNoException;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
Expand Down Expand Up @@ -148,6 +149,16 @@ void unusedVersionPropertyFails() {
.contains("unused");
}

@Test
void suppressedUnusedPropertyIsIgnored() {
originalModel.addProperty(SUPPRESSIONS_PROPERTY, "old-lib.version, kept-for-compat.version");
originalModel.addProperty("old-lib.version", "2.0.0");

Stream<String> violations = rule.scanProperties();

assertThat(violations).isEmpty();
}

@Test
void nonVersionPropertyIsIgnored() {
originalModel.addProperty("project.build.sourceEncoding", "UTF-8");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mock-maker-subclass