Fix validation behavior in RegexFilter (apache#3086)

+ added validation checks to RegexFilter
+ added JVerify nullability annotations to RegexFilter
+ updated javadoc
+ replaced deprecated usages of CompositeFilter#getFilters with CompositeFilter#getFiltersArray in AbstractFilterableTest

Author: JWT007

log4j-core-test/src/test/java/org/apache/logging/log4j/core/filter/AbstractFilterTest.java

@@ -34,7 +34,6 @@ class AbstractFilterTest {
     @Test
     void testUnrolledBackwardsCompatible() {
         final ConcreteFilter filter = new ConcreteFilter();
-        final Filter.Result expected = Filter.Result.DENY;
         verifyMethodsWithUnrolledVarargs(filter, Filter.Result.DENY);
 
         filter.testResult = Filter.Result.ACCEPT;

log4j-core-test/src/test/java/org/apache/logging/log4j/core/filter/AbstractFilterableTest.java

@@ -54,7 +54,7 @@ void testAddMultipleSimpleFilters() {
         // into a CompositeFilter.class
         filterable.addFilter(filter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -67,7 +67,7 @@ void testAddMultipleEqualSimpleFilter() {
         // into a CompositeFilter.class
         filterable.addFilter(filter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -93,7 +93,7 @@ void testAddMultipleCompositeFilters() {
         // into a CompositeFilter.class
         filterable.addFilter(compositeFilter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(6, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(6, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -109,7 +109,7 @@ void testAddSimpleFilterAndCompositeFilter() {
         // into a CompositeFilter.class
         filterable.addFilter(compositeFilter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -125,7 +125,7 @@ void testAddCompositeFilterAndSimpleFilter() {
         // into a CompositeFilter.class
         filterable.addFilter(notInCompositeFilterFilter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(3, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(3, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -170,7 +170,7 @@ void testRemoveSimpleEqualFilterFromMultipleSimpleFilters() {
         filterable.addFilter(filterCopy);
         filterable.removeFilter(filterCopy);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
         filterable.removeFilter(filterCopy);
         assertEquals(filterOriginal, filterable.getFilter());
         filterable.removeFilter(filterOriginal);
@@ -224,7 +224,7 @@ void testRemoveSimpleFilterFromCompositeAndSimpleFilter() {
         // should not remove internal filter of compositeFilter
         filterable.removeFilter(anotherFilter);
         assertInstanceOf(CompositeFilter.class, filterable.getFilter());
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
     }
 
     @Test
@@ -247,9 +247,9 @@ void testRemoveFiltersFromComposite() {
 
         filterable.addFilter(compositeFilter);
         filterable.addFilter(anotherFilter);
-        assertEquals(3, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(3, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
         filterable.removeFilter(filter1);
-        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFilters().size());
+        assertEquals(2, ((CompositeFilter) filterable.getFilter()).getFiltersArray().length);
         filterable.removeFilter(filter2);
         assertSame(anotherFilter, filterable.getFilter());
     }
@@ -274,11 +274,7 @@ public boolean equals(final Object o) {
 
             final EqualFilter that = (EqualFilter) o;
 
-            if (key != null ? !key.equals(that.key) : that.key != null) {
-                return false;
-            }
-
-            return true;
+            return key != null ? key.equals(that.key) : that.key == null;
         }
 
         @Override

log4j-core-test/src/test/java/org/apache/logging/log4j/core/filter/RegexFilterTest.java

@@ -24,7 +24,6 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertSame;
-import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.apache.logging.log4j.Level;
@@ -92,11 +91,10 @@ void testDotAllPattern() throws Exception {
     @Test
     void testNoMsg() {
 
-        final RegexFilter filter =
-            RegexFilter.newBuilder()
-                       .setRegex(".* test .*")
-                       .setUseRawMsg(false)
-                       .build();
+        final RegexFilter filter = RegexFilter.newBuilder()
+                .setRegex(".* test .*")
+                .setUseRawMsg(false)
+                .build();
 
         assertNotNull(filter);
 
@@ -114,26 +112,25 @@ void testParameterizedMsg() {
         final Object[] params = {"foo", "bar"};
 
         // match against raw message
-        final RegexFilter rawFilter =
-            RegexFilter.newBuilder()
-                       .setRegex("params \\{\\} \\{\\}")
-                       .setUseRawMsg(true)
-                       .setOnMatch(Result.ACCEPT)
-                       .setOnMismatch(Result.DENY)
-                       .build();
+        final RegexFilter rawFilter = RegexFilter.newBuilder()
+                .setRegex("params \\{\\} \\{\\}")
+                .setUseRawMsg(true)
+                .setOnMatch(Result.ACCEPT)
+                .setOnMismatch(Result.DENY)
+                .build();
 
         assertNotNull(rawFilter);
 
         final Result rawResult = rawFilter.filter(null, null, null, msg, params);
         assertThat(rawResult, equalTo(Result.ACCEPT));
 
         // match against formatted message
-        final RegexFilter fmtFilter =
-            RegexFilter.newBuilder()
-                       .setRegex("params foo bar")
-                       .setUseRawMsg(false)
-                       .setOnMatch(Result.ACCEPT)
-                       .setOnMismatch(Result.DENY).build();
+        final RegexFilter fmtFilter = RegexFilter.newBuilder()
+                .setRegex("params foo bar")
+                .setUseRawMsg(false)
+                .setOnMatch(Result.ACCEPT)
+                .setOnMismatch(Result.DENY)
+                .build();
 
         assertNotNull(fmtFilter);
 
@@ -149,8 +146,11 @@ void testWithValidRegex() {
 
         final String regex = "^[a-zA-Z0-9_]+$"; // matches alphanumeric with underscores
 
-        final RegexFilter.Builder builder =
-            RegexFilter.newBuilder().setRegex(regex).setUseRawMsg(false).setOnMatch(Result.ACCEPT).setOnMismatch(Result.DENY);
+        final RegexFilter.Builder builder = RegexFilter.newBuilder()
+                .setRegex(regex)
+                .setUseRawMsg(false)
+                .setOnMatch(Result.ACCEPT)
+                .setOnMismatch(Result.DENY);
 
         assertTrue(builder.isValid());
 
@@ -170,13 +170,12 @@ void testRegexFilterGetters() {
 
         final String regex = "^[a-zA-Z0-9_]+$"; // matches alphanumeric with underscores
 
-        final RegexFilter filter =
-            RegexFilter.newBuilder()
-                       .setRegex(regex)
-                       .setUseRawMsg(false)
-                       .setOnMatch(Result.ACCEPT)
-                       .setOnMismatch(Result.DENY)
-                       .build();
+        final RegexFilter filter = RegexFilter.newBuilder()
+                .setRegex(regex)
+                .setUseRawMsg(false)
+                .setOnMatch(Result.ACCEPT)
+                .setOnMismatch(Result.DENY)
+                .build();
 
         assertNotNull(filter);
 
@@ -199,7 +198,6 @@ void testBuilderWithoutRegexNotValid() {
         assertFalse(builder.isValid());
 
         assertNull(builder.build());
-
     }
 
     /**
@@ -215,6 +213,5 @@ void testBuilderWithInvalidRegexNotValid() {
         assertFalse(builder.isValid());
 
         assertNull(builder.build());
-
     }
 }