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

Jump to bottom

Prevent StackOverflowException caused by excessive 'or' via PatternMatcher #10330

Merged
merged 2 commits into from Sep 4, 2019
Merged

Prevent StackOverflowException caused by excessive 'or' via PatternMatcher #10330

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
803a137
Add unit tests
snazy Aug 22, 2019
1351cac
Prevent StackOverflowException caused by excessive 'or' via PatternMa…
snazy Aug 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 55 additions & 12 deletions subprojects/files/src/main/java/org/gradle/api/internal/file/pattern/PatternMatcher.java
View file
Open in desktop
Expand Up @@ -16,6 +16,9 @@

package org.gradle.api.internal.file.pattern;

import java.util.ArrayList;
import java.util.List;

public abstract class PatternMatcher {
public static final PatternMatcher MATCH_ALL = new PatternMatcher() {
@Override
Expand All @@ -37,21 +40,11 @@ public PatternMatcher or(PatternMatcher other) {
public abstract boolean test(String[] segments, boolean isFile);

public PatternMatcher and(final PatternMatcher other) {
return new PatternMatcher() {
@Override
public boolean test(String[] segments, boolean isFile) {
return PatternMatcher.this.test(segments, isFile) && other.test(segments, isFile);
}
};
return new And(PatternMatcher.this, other);
}

public PatternMatcher or(final PatternMatcher other) {
return new PatternMatcher() {
@Override
public boolean test(String[] segments, boolean isFile) {
return PatternMatcher.this.test(segments, isFile) || other.test(segments, isFile);
}
};
return new Or(PatternMatcher.this, other);
}

public PatternMatcher negate() {
Expand All @@ -62,4 +55,54 @@ public boolean test(String[] segments, boolean isFile) {
}
};
}

private static final class Or extends PatternMatcher {
private final List<PatternMatcher> parts = new ArrayList<PatternMatcher>();

public Or(PatternMatcher patternMatcher, PatternMatcher other) {
parts.add(patternMatcher);
parts.add(other);
}

@Override
public PatternMatcher or(PatternMatcher other) {
parts.add(other);
return this;
}

@Override
public boolean test(String[] segments, boolean isFile) {
for (PatternMatcher part : parts) {
if (part.test(segments, isFile)) {
return true;
}
}
return false;
}
}

private static final class And extends PatternMatcher {
private final List<PatternMatcher> parts = new ArrayList<PatternMatcher>();

public And(PatternMatcher patternMatcher, PatternMatcher other) {
parts.add(patternMatcher);
parts.add(other);
}

@Override
public PatternMatcher and(PatternMatcher other) {
parts.add(other);
return this;
}

@Override
public boolean test(String[] segments, boolean isFile) {
for (PatternMatcher part : parts) {
if (!part.test(segments, isFile)) {
return false;
}
}
return true;
}
}
}
39 changes: 39 additions & 0 deletions ...files/src/test/groovy/org/gradle/api/internal/file/pattern/PatternMatcherFactoryTest.java
View file
Open in desktop
Expand Up @@ -22,13 +22,52 @@
import org.hamcrest.Matcher;
import org.junit.Test;

import java.util.LinkedHashSet;
import java.util.Set;

import static org.hamcrest.CoreMatchers.instanceOf;
import static org.hamcrest.CoreMatchers.not;
import static org.junit.Assert.assertThat;

public class PatternMatcherFactoryTest {
private PatternMatcher matcher;

@Test public void testNoStackOverflowForManyPatterns() {
// The only reason for this unit test is to verify that no StackOverflowException is being thrown when
// many patterns are passed to getPatternsMatcher. See https://github.com/gradle/gradle/issues/10329
Set<String> manyPatterns = new LinkedHashSet<String>();
for (int i = 0; i < 5000; i++) {
manyPatterns.add("some/package/Some" + i + "ClassName.class");
manyPatterns.add("some/package/Some" + i + "ClassName.java");
manyPatterns.add("some/package/Some" + i + "ClassName.h");
manyPatterns.add("some/package/Some" + i + "ClassName$*.class");
manyPatterns.add("some/package/Some" + i + "ClassName$*.java");
manyPatterns.add("some/package/Some" + i + "ClassName$*.h");
}
matcher = PatternMatcherFactory.getPatternsMatcher(true, true, manyPatterns);
assertThat(matcher, not(matchesFile("some", "package", "SomeClassName.java")));
assertThat(matcher, matchesFile("some", "package", "Some123ClassName.java"));
}

@Test public void testManyOr() {
Set<String> manyPatterns = new LinkedHashSet<String>();
manyPatterns.add("some/package/SomeClassName.class");
manyPatterns.add("some/package/SomeClassName.java");
manyPatterns.add("some/package/SomeClassName.h");
manyPatterns.add("some/package/SomeClassName$*.class");
manyPatterns.add("some/package/SomeClassName$*.java");
manyPatterns.add("some/package/SomeClassName$*.h");
matcher = PatternMatcherFactory.getPatternsMatcher(true, true, manyPatterns);
assertThat(matcher, not(matchesFile()));
assertThat(matcher, matchesFile("some", "package", "SomeClassName.java"));
assertThat(matcher, matchesFile("some", "package", "SomeClassName.class"));
assertThat(matcher, matchesFile("some", "package", "SomeClassName.h"));
assertThat(matcher, matchesFile("some", "package", "SomeClassName$*.java"));
assertThat(matcher, matchesFile("some", "package", "SomeClassName$*.class"));
assertThat(matcher, matchesFile("some", "package", "SomeClassName$*.h"));
assertThat(matcher, not(matchesFile("a")));
}

@Test public void testEmpty() {
matcher = PatternMatcherFactory.getPatternMatcher(true, true, "");
assertThat(matcher, matchesFile());
Expand Down