mumrah commented on code in PR #17725: URL: https://github.com/apache/kafka/pull/17725#discussion_r1846911260
########## test-common/test-common-runtime/src/main/java/org/apache/kafka/common/test/junit/QuarantinedPostDiscoveryFilter.java: ########## @@ -0,0 +1,84 @@ +/* + * 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.kafka.common.test.junit; + +import org.junit.platform.engine.Filter; +import org.junit.platform.engine.FilterResult; +import org.junit.platform.engine.TestDescriptor; +import org.junit.platform.engine.TestTag; +import org.junit.platform.launcher.PostDiscoveryFilter; + +/** + * A JUnit test filter which can include or exclude discovered tests before + * they are sent off to the test engine for execution. The behavior of this + * filter is controlled by the system property "kafka.test.run.quarantined". + * If the property is set to "true", then only auto-quarantined and explicitly + * "@Flaky" tests will be included. If the property is set to "false", then + * only non-quarantined tests will be run. + * <p> + * This filter is registered with JUnit using SPI. The test-common-runtime module + * includes a META-INF/services/org.junit.platform.launcher.PostDiscoveryFilter + * service file which registers this class. + */ +public class QuarantinedPostDiscoveryFilter implements PostDiscoveryFilter { + + private static final TestTag FLAKY_TEST_TAG = TestTag.create("flaky"); + + public static final String RUN_QUARANTINED_PROP = "kafka.test.run.quarantined"; + + public static final String CATALOG_FILE_PROP = "kafka.test.catalog.file"; + + private final Filter<TestDescriptor> autoQuarantinedFilter; + private final boolean runQuarantined; + + // No-arg constructor for SPI + public QuarantinedPostDiscoveryFilter() { + runQuarantined = System.getProperty(RUN_QUARANTINED_PROP, "false") + .equalsIgnoreCase("true"); + + String testCatalogFileName = System.getProperty(CATALOG_FILE_PROP); + autoQuarantinedFilter = AutoQuarantinedTestFilter.create(testCatalogFileName, runQuarantined); + } + + // Visible for tests + QuarantinedPostDiscoveryFilter(Filter<TestDescriptor> autoQuarantinedFilter, boolean runQuarantined) { + this.autoQuarantinedFilter = autoQuarantinedFilter; + this.runQuarantined = runQuarantined; + } + + @Override + public FilterResult apply(TestDescriptor testDescriptor) { + boolean hasTag = testDescriptor.getTags().contains(FLAKY_TEST_TAG); + FilterResult result = autoQuarantinedFilter.apply(testDescriptor); + if (runQuarantined) { + // If selecting quarantined tests, we include auto-quarantined tests and flaky tests + if (result.excluded() && hasTag) { Review Comment: Good catch. I messed up this logic when rewriting the filter recently. I've fixed it and added a test -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
