JWT007 commented on code in PR #3510: URL: https://github.com/apache/logging-log4j2/pull/3510#discussion_r1978214026
########## log4j-core-test/src/test/java/org/apache/logging/log4j/core/filter/StringMatchFilterTest.java: ########## @@ -0,0 +1,103 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to you under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.logging.log4j.core.filter; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; + +import org.apache.logging.log4j.core.Filter; +import org.apache.logging.log4j.core.config.Configuration; +import org.apache.logging.log4j.core.test.junit.LoggerContextSource; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; + +/** + * Unit tests for {@link StringMatchFilter}. + */ +class StringMatchFilterTest { + + /** + * Test the normal valid programmatic instantiation of a {@link StringMatchFilter} via its builder. + */ + @Test + void testFilterBuilderOK() { + StringMatchFilter.Builder stringMatchFilterBuilder = StringMatchFilter.newBuilder(); + stringMatchFilterBuilder.setText("foo"); + StringMatchFilter stringMatchFilter = stringMatchFilterBuilder.build(); + assertNotNull(stringMatchFilter, "The filter should not be null."); + assertEquals("foo", stringMatchFilter.getText()); + } + + /** + * Test that if no match-string is set on the builder, the '{@link StringMatchFilter.Builder#build()}' returns + * {@code null}. + */ + @Test + void testFilterBuilderFailsWithNullText() { + StringMatchFilter.Builder stringMatchFilterBuilder = StringMatchFilter.newBuilder(); + Assertions.assertNull(stringMatchFilterBuilder.build()); + } + + /** + * Test that if a {@code null} string is set as a match-pattern, an {@code IllegalArgumentExeption} is thrown. + */ + @Test + @SuppressWarnings({"DataFlowIssue" // invalid null parameter explicitly being tested + }) + void testFilterBuilderFailsWithExceptionOnNullText() { + StringMatchFilter.Builder stringMatchFilterBuilder = StringMatchFilter.newBuilder(); + Assertions.assertThrows(IllegalArgumentException.class, () -> stringMatchFilterBuilder.setText(null)); + } + + /** + * Test that if an empty ({@code ""}) string is set as a match-pattern, an {@code IllegalArgumentException} is thrown. + */ + @Test + void testFilterBuilderFailsWithExceptionOnEmptyText() { + StringMatchFilter.Builder stringMatchFilterBuilder = StringMatchFilter.newBuilder(); + Assertions.assertThrows(IllegalArgumentException.class, () -> stringMatchFilterBuilder.setText("")); + } + + /** + * Test that if a {@link StringMatchFilter} is specified with a 'text' attribute it is correctly instantiated. + * + * @param configuration the configuration + */ + @Test + @LoggerContextSource("log4j2-stringmatchfilter-3153-ok.xml") + void testConfigurationWithTextPOS(final Configuration configuration) { + final Filter filter = configuration.getFilter(); + assertNotNull(filter, "The filter should not be null."); + assertInstanceOf( + StringMatchFilter.class, filter, "Expected a StringMatchFilter, but got: " + filter.getClass()); + assertEquals("FooBar", ((StringMatchFilter) filter).getText()); + } + + /** + * Test that if a {@link StringMatchFilter} is specified without a 'text' attribute it is not instantiated. + * + * @param configuration the configuration + */ + @Test + @LoggerContextSource("log4j2-stringmatchfilter-3153-nok.xml") + void testConfigurationWithTextNEG(final Configuration configuration) { + final Filter filter = configuration.getFilter(); + assertNull(filter, "The filter should be null."); + } Review Comment: this simply tests that a misconfigured (or not at all) fails on build and returns null I think. A "<StringMooFilter>" invalid name would throw in an entirely different locattion I think - unresolved plugin type. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@logging.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
