Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix line ending problems in FreezingArchRule #516

Merged
merged 2 commits into from
Jan 27, 2021
Merged

fix line ending problems in FreezingArchRule #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7f6a59
fix typo in "The Library API" in user guide
codecholeric Jan 27, 2021
762d76d
fix line ending problems in FreezingArchRule
codecholeric Jan 23, 2021
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
85 changes: 76 additions & 9 deletions archunit/src/main/java/com/tngtech/archunit/library/freeze/FreezingArchRule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.Set;

import com.tngtech.archunit.ArchConfiguration;
Expand All @@ -27,6 +28,7 @@
import com.tngtech.archunit.core.domain.JavaClasses;
import com.tngtech.archunit.lang.ArchRule;
import com.tngtech.archunit.lang.EvaluationResult;
import com.tngtech.archunit.lang.Priority;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -73,12 +75,16 @@ public final class FreezingArchRule implements ArchRule {
private static final Logger log = LoggerFactory.getLogger(FreezingArchRule.class);

private final ArchRule delegate;
private final ViolationStore store;
private final ViolationStoreLineBreakAdapter store;
private final ViolationLineMatcher matcher;

private FreezingArchRule(ArchRule delegate, ViolationStore store, ViolationLineMatcher matcher) {
this(delegate, new ViolationStoreLineBreakAdapter(store), matcher);
}

private FreezingArchRule(ArchRule delegate, ViolationStoreLineBreakAdapter store, ViolationLineMatcher matcher) {
this.delegate = checkNotNull(delegate);
this.store = checkNotNull(store);
this.store = store;
this.matcher = checkNotNull(matcher);
}

Expand All @@ -105,21 +111,21 @@ public FreezingArchRule as(String newDescription) {
public EvaluationResult evaluate(JavaClasses classes) {
store.initialize(ArchConfiguration.get().getSubProperties(FREEZE_STORE_PROPERTY_NAME));

EvaluationResult result = delegate.evaluate(classes);
EvaluationResultLineBreakAdapter result = new EvaluationResultLineBreakAdapter(delegate.evaluate(classes));
if (!store.contains(delegate)) {
return storeViolationsAndReturnSuccess(result);
} else {
return removeObsoleteViolationsFromStoreAndReturnNewViolations(result);
}
}

private EvaluationResult storeViolationsAndReturnSuccess(EvaluationResult result) {
private EvaluationResult storeViolationsAndReturnSuccess(EvaluationResultLineBreakAdapter result) {
log.debug("No results present for rule '{}'. Freezing rule result...", delegate.getDescription());
store.save(delegate, result.getFailureReport().getDetails());
store.save(delegate, result.getViolations());
return new EvaluationResult(delegate, result.getPriority());
}

private EvaluationResult removeObsoleteViolationsFromStoreAndReturnNewViolations(EvaluationResult result) {
private EvaluationResult removeObsoleteViolationsFromStoreAndReturnNewViolations(EvaluationResultLineBreakAdapter result) {
log.debug("Found frozen result for rule '{}'", delegate.getDescription());
final List<String> knownViolations = store.getViolations(delegate);
CategorizedViolations categorizedViolations = new CategorizedViolations(matcher, result, knownViolations);
Expand All @@ -135,7 +141,7 @@ private void removeObsoleteViolationsFromStore(CategorizedViolations categorized
}
}

private EvaluationResult filterOutKnownViolations(EvaluationResult result, final Set<String> knownActualViolations) {
private EvaluationResult filterOutKnownViolations(EvaluationResultLineBreakAdapter result, final Set<String> knownActualViolations) {
log.debug("Filtering out known violations: {}", knownActualViolations);
return result.filterDescriptionsMatching(new Predicate<String>() {
@Override
Expand Down Expand Up @@ -196,14 +202,26 @@ public static FreezingArchRule freeze(ArchRule rule) {
return new FreezingArchRule(rule, ViolationStoreFactory.create(), ViolationLineMatcherFactory.create());
}

static String ensureUnixLineBreaks(String string) {
return string.replaceAll("\r\n", "\n");
}

private static List<String> ensureUnixLineBreaks(List<String> strings) {
List<String> result = new ArrayList<>();
for (String string : strings) {
result.add(ensureUnixLineBreaks(string));
}
return result;
}

private static class CategorizedViolations {
private final Set<String> knownActualViolations = new HashSet<>();
private final List<String> storedSolvedViolations;
private final List<String> storedUnsolvedViolations = new ArrayList<>();

CategorizedViolations(ViolationLineMatcher matcher, EvaluationResult actualResult, List<String> storedViolations) {
CategorizedViolations(ViolationLineMatcher matcher, EvaluationResultLineBreakAdapter actualResult, List<String> storedViolations) {
List<String> storedViolationsLeft = new ArrayList<>(storedViolations);
for (String actualViolation : actualResult.getFailureReport().getDetails()) {
for (String actualViolation : actualResult.getViolations()) {
for (Iterator<String> iterator = storedViolationsLeft.iterator(); iterator.hasNext(); ) {
String storedViolation = iterator.next();
if (matcher.matches(actualViolation, storedViolation)) {
Expand All @@ -230,4 +248,53 @@ List<String> getStoredUnsolvedViolations() {
return storedUnsolvedViolations;
}
}

private static class ViolationStoreLineBreakAdapter {
private final ViolationStore store;

ViolationStoreLineBreakAdapter(ViolationStore store) {
this.store = checkNotNull(store);
}

void initialize(Properties properties) {
store.initialize(properties);
}

boolean contains(ArchRule rule) {
return store.contains(rule);
}

List<String> getViolations(ArchRule rule) {
return ensureUnixLineBreaks(store.getViolations(rule));
}

void save(ArchRule rule, List<String> violations) {
store.save(rule, ensureUnixLineBreaks(violations));
}
}

private static class EvaluationResultLineBreakAdapter {
private final EvaluationResult result;

private EvaluationResultLineBreakAdapter(EvaluationResult result) {
this.result = checkNotNull(result);
}

List<String> getViolations() {
return ensureUnixLineBreaks(result.getFailureReport().getDetails());
}

Priority getPriority() {
return result.getPriority();
}

EvaluationResult filterDescriptionsMatching(final Predicate<String> predicate) {
return result.filterDescriptionsMatching(new Predicate<String>() {
@Override
public boolean apply(String input) {
return predicate.apply(ensureUnixLineBreaks(input));
}
});
}
}
}
11 changes: 4 additions & 7 deletions archunit/src/main/java/com/tngtech/archunit/library/freeze/ViolationStoreFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.io.Files.toByteArray;
import static com.tngtech.archunit.base.ReflectionUtils.newInstanceOf;
import static com.tngtech.archunit.library.freeze.FreezingArchRule.ensureUnixLineBreaks;
import static java.nio.charset.StandardCharsets.UTF_8;

class ViolationStoreFactory {
Expand Down Expand Up @@ -196,10 +197,6 @@ private String readStoreFile(String fileName) {
}
}

private String ensureUnixLineBreaks(String string) {
return string.replaceAll("\r\n", "\n");
}

private static class FileSyncedProperties {
private final File propertiesFile;
private final Properties loadedProperties;
Expand Down Expand Up @@ -234,15 +231,15 @@ private Properties loadRulesFrom(File file) {
}

boolean containsKey(String propertyName) {
return loadedProperties.containsKey(propertyName);
return loadedProperties.containsKey(ensureUnixLineBreaks(propertyName));
}

String getProperty(String propertyName) {
return loadedProperties.getProperty(propertyName);
return loadedProperties.getProperty(ensureUnixLineBreaks(propertyName));
}

void setProperty(String propertyName, String value) {
loadedProperties.setProperty(propertyName, value);
loadedProperties.setProperty(ensureUnixLineBreaks(propertyName), ensureUnixLineBreaks(value));
syncFileSystem();
}

Expand Down
Loading