Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use matchMethodDescription method of org.junit.runner.manipulation.Filter class

Best junit code snippet using org.junit.runner.manipulation.Filter.matchMethodDescription

Source:ExampleRunner.java

...910import static com.google.common.collect.Iterables.transform;11import static com.google.common.collect.Lists.newArrayList;12import static org.junit.runner.Description.createTestDescription;13import static org.junit.runner.manipulation.Filter.matchMethodDescription;1415import java.util.Collections;16import java.util.List;1718import org.jnario.runner.internal.ExtensionClass;19import org.jnario.runner.internal.NamedFrameworkMethod;20import org.junit.rules.TestRule;21import org.junit.runner.Description;22import org.junit.runner.Runner;23import org.junit.runner.manipulation.NoTestsRemainException;24import org.junit.runner.notification.RunNotifier;25import org.junit.runners.BlockJUnit4ClassRunner;26import org.junit.runners.model.FrameworkField;27import org.junit.runners.model.FrameworkMethod;28import org.junit.runners.model.InitializationError;29import org.junit.runners.model.Statement;30import org.junit.runners.model.TestClass;3132import com.google.common.base.Function;3334/**35 * A {@link Runner} for executing single examples. 36 * 37 * @author Sebastian Benz - Initial contribution and API38 */39public class ExampleRunner extends BlockJUnit4ClassRunner {4041	private final class MethodNameConverter implements42			Function<FrameworkMethod, FrameworkMethod> {43		public FrameworkMethod apply(final FrameworkMethod from) {44			return new NamedFrameworkMethod(from.getMethod(),45					nameProvider.nameOf(from.getMethod()));46		}47	}4849	private final NameProvider nameProvider;50	private final FrameworkMethod method;51	private SpecCreator testBuilder;52	private List<ExtensionClass> extensions;5354	public ExampleRunner(final Class<?> testClass,55			List<ExtensionClass> extensions, final FrameworkMethod method,56			NameProvider nameProvider, SpecCreator testBuilder)57			throws InitializationError, NoTestsRemainException {58		super(testClass);59		this.extensions = extensions;60		this.method = method;61		this.nameProvider = nameProvider;62		this.testBuilder = testBuilder;63		filter(matchMethodDescription(getDescription()));64	}6566	public ExampleRunner(Class<?> testClass, FrameworkMethod from,67			NameProvider nameProvider, SpecCreator delegate)68			throws InitializationError, NoTestsRemainException {69		this(testClass, Collections.<ExtensionClass> emptyList(), from,70				nameProvider, delegate);71	}7273	@Override74	protected Object createTest() throws Exception {75		Object test = testBuilder.createSpec(getTestClass().getJavaClass());76		initializeSubjects(getTestClass(), test);77		return test;
...

Source:TestClassRequestResolverTests.java

...11import static java.util.Collections.emptyList;12import static java.util.Collections.singletonList;13import static org.assertj.core.api.Assertions.assertThat;14import static org.junit.runner.Description.createTestDescription;15import static org.junit.runner.manipulation.Filter.matchMethodDescription;16import static org.junit.vintage.engine.discovery.RunnerTestDescriptorAwareFilter.adapter;17import java.util.List;18import java.util.logging.Level;19import java.util.logging.LogRecord;20import org.junit.jupiter.api.Test;21import org.junit.jupiter.engine.TrackLogRecords;22import org.junit.platform.commons.logging.LogRecordListener;23import org.junit.vintage.engine.VintageUniqueIdBuilder;24import org.junit.vintage.engine.samples.junit4.IgnoredJUnit4TestCase;25import org.junit.vintage.engine.samples.junit4.IgnoredJUnit4TestCaseWithNotFilterableRunner;26import org.junit.vintage.engine.samples.junit4.NotFilterableRunner;27import org.junit.vintage.engine.samples.junit4.PlainJUnit4TestCaseWithFiveTestMethods;28/**29 * Tests for {@link TestClassRequestResolver}.30 *31 * @since 4.1232 */33@TrackLogRecords34class TestClassRequestResolverTests {35	@Test36	void doesNotLogAnythingForFilterableRunner(LogRecordListener listener) {37		Class<?> testClass = PlainJUnit4TestCaseWithFiveTestMethods.class;38		RunnerTestDescriptorAwareFilter filter = adapter(39			matchMethodDescription(createTestDescription(testClass, "failingTest")));40		resolve(new TestClassRequest(testClass, singletonList(filter)));41		assertThat(listener.stream(TestClassRequestResolver.class)).isEmpty();42	}43	@Test44	void doesNotLogAnythingForNonFilterableRunnerIfNoFiltersAreToBeApplied(LogRecordListener listener) {45		Class<?> testClass = IgnoredJUnit4TestCase.class;46		List<RunnerTestDescriptorAwareFilter> filters = emptyList();47		resolve(new TestClassRequest(testClass, filters));48		assertThat(listener.stream(TestClassRequestResolver.class)).isEmpty();49	}50	@Test51	void logsWarningOnNonFilterableRunner(LogRecordListener listener) {52		Class<?> testClass = IgnoredJUnit4TestCaseWithNotFilterableRunner.class;53		RunnerTestDescriptorAwareFilter filter = adapter(54			matchMethodDescription(createTestDescription(testClass, "failingTest")));55		resolve(new TestClassRequest(testClass, singletonList(filter)));56		// @formatter:off57		assertThat(listener.stream(TestClassRequestResolver.class, Level.WARNING).map(LogRecord::getMessage))58				.containsOnlyOnce("Runner " + NotFilterableRunner.class.getName()59						+ " (used on " + testClass.getName() + ") does not support filtering"60						+ " and will therefore be run completely.");61		// @formatter:on62	}63	private void resolve(TestClassRequest request) {64		TestClassRequestResolver resolver = new TestClassRequestResolver();65		resolver.createRunnerTestDescriptor(request, VintageUniqueIdBuilder.engineId());66	}67}...

Source:Filter.java

...21        }22    };23    public abstract String describe();24    public abstract boolean shouldRun(Description description);25    public static Filter matchMethodDescription(final Description desiredDescription) {26        return new Filter() {27            /* class org.junit.runner.manipulation.Filter.AnonymousClass2 */28            @Override // org.junit.runner.manipulation.Filter29            public boolean shouldRun(Description description) {30                if (description.isTest()) {31                    return Description.this.equals(description);32                }33                Iterator<Description> it = description.getChildren().iterator();34                while (it.hasNext()) {35                    if (shouldRun(it.next())) {36                        return true;37                    }38                }39                return false;...

Source:DelegatingTest.java

...42    public void switchRunner() throws InitializationError, NoTestsRemainException {43        JUnitCore junit = new JUnitCore();44        Description method = Description.createTestDescription(SimpleTestHidden.class, "doNothing");45        ContainerTestRunner runner = new ContainerTestRunner(SimpleTestHidden.class, injector);46        runner.filter(Filter.matchMethodDescription(method));47        Result result = junit.run(runner);48        assertTrue(result.getFailures().isEmpty());49        verify(injector).injectFields(isNotNull());50    }51    @Test52    public void wrapFailingTest() throws Throwable {53        JUnitCore junit = new JUnitCore();54        Description method = Description.createTestDescription(SimpleTestHidden.class,55            "failingTest");56        ContainerTestRunner runner = new ContainerTestRunner(SimpleTestHidden.class, injector);57        runner.filter(Filter.matchMethodDescription(method));58        Result result = junit.run(runner);59        assertEquals(1, result.getFailures().size());60        verify(injector).injectFields(isNotNull());61    }62}

Source:MethodSelectorResolver.java

...27		Class<?> testClass = selector.getJavaClass();28		if (classFilter.test(testClass)) {29			Method testMethod = selector.getJavaMethod();30			Description methodDescription = Description.createTestDescription(testClass, testMethod.getName());31			collector.addFiltered(testClass, adapter(matchMethodDescription(methodDescription)));32		}33	}34	/**35	 * The method {@link Filter#matchMethodDescription(Description)} returns a36	 * filter that does not account for the case when the description is for a37	 * {@link org.junit.runners.Parameterized} runner.38	 */39	private static Filter matchMethodDescription(final Description desiredDescription) {40		return new Filter() {41			@Override42			public boolean shouldRun(Description description) {43				if (description.isTest()) {44					return desiredDescription.equals(description) || isParameterizedMethod(description);45				}46				// explicitly check if any children want to run47				for (Description each : description.getChildren()) {48					if (shouldRun(each)) {49						return true;50					}51				}52				return false;53			}...

Source:SingleMethodRunner.java

...35    private static Runner junitRunnerFor(TestMethodReference reference)36	    throws InitializationError, NoTestsRemainException {37	BlockJUnit4ClassRunner result = new BlockJUnit4ClassRunner(38		reference.getTestClass());39	result.filter(Filter.matchMethodDescription(reference.toDescription()));40	return result;41    }42    @Override43    protected List<Runner> getChildren() {44	return children;45    }46    @Override47    protected Description describeChild(Runner child) {48	return child.getDescription();49    }50    @Override51    protected void runChild(Runner child, RunNotifier notifier) {52	child.run(notifier);53    }...

Source:IsolatedClassLoaderAwareJUnitTestRunner.java

...17		18		try {19			Class<?> testClass = Class.forName(testClassName);		20			jUnitTestAdapter = new JUnit4TestAdapter(testClass);21			jUnitTestAdapter.filter(Filter.matchMethodDescription(Description.createTestDescription(testClass, testMethodName)));	22		} catch (ClassNotFoundException | NoTestsRemainException e) {23			throw new RuntimeException(format("Unable to find test %s.%s() in either reference or faulty version.", testClassName, testMethodName));24		}25	}26	27	private void ensureLoadedInIsolatedClassLoader(Object o) {28		String objectClassLoader = o.getClass().getClassLoader().getClass().getName();29		if (!objectClassLoader.equals(IsolatedURLClassLoader.class.getName())) {30			throw new IllegalStateException(format("Instance of %s not loaded by a IsolatedURLClassLoader (loaded by %s)", o.getClass(), objectClassLoader));31		}32	}	33}
...

Source:TestsRunner.java

...20        {21            final String TEST_CLASS_NAME = args[0];22            final String TEST_METHOD_NAME = args.length > 1 ? args[1] : null;23            Filter filter = Filter24                    .matchMethodDescription(Description.createTestDescription(TEST_CLASS_NAME, TEST_METHOD_NAME));25            request = request.filterWith(filter);26        }27        Result result = junitCore.run(request);28        if (result.wasSuccessful())29        {30            System.exit(0);31        } else32        {33            System.exit(1);34        }35    }36}...

matchMethodDescription

Using AI Code Generation

1import org.junit.runner.JUnitCore;2import org.junit.runner.Request;3import org.junit.runner.manipulation.Filter;4public class JunitFilterExample {5    public static void main(String[] args) {6        Request request = Request.method(JunitFilterExample.class, "testMethod");7        Filter filter = Filter.matchMethodDescription(request.getRunner().getDescription());8        JUnitCore core = new JUnitCore();9        core.addListener(new JunitListener());10        core.run(filter, JunitFilterExample.class);11    }12    public void testMethod() {13        System.out.println("testMethod");14    }15}16OK (1 test)17import org.junit.runner.JUnitCore;18import org.junit.runner.Request;19import org.junit.runner.manipulation.Filter;20public class JunitFilterExample {21    public static void main(String[] args) {22        Request request = Request.method(JunitFilterExample.class, "testMethod");23        Filter filter = Filter.matchMethodDescription(request.getRunner().getDescription());24        JUnitCore core = new JUnitCore();25        core.addListener(new JunitListener());26        core.run(filter, JunitFilterExample.class);27    }28    public void testMethod() {29        System.out.println("testMethod");30    }31}32OK (1 test)

matchMethodDescription

Using AI Code Generation

1import org.junit.runner.manipulation.Filter;2import org.junit.runner.manipulation.NoTestsRemainException;3import org.junit.runner.manipulation.Filterable;4import org.junit.runner.Description;5import org.junit.runner.JUnitCore;6import org.junit.runner.Result;7public class FilterTest {8    public static void main(String[] args) {9        JUnitCore core = new JUnitCore();10        core.addListener(new TestListener());11        Result result = core.run(FilterTestSuite.class);12    }13    private static class TestListener extends RunListener {14        public void testRunStarted(Description description) throws Exception {15            System.out.println("Starting test run...");16            Filterable filterable = (Filterable) description.getRunner();17            Filter filter = new Filter() {18                public boolean shouldRun(Description description) {19                    return description.getMethodName().equals("test2");20                }21                public String describe() {22                    return "Filtering test2 method";23                }24            };25            try {26                filterable.filter(filter);27            } catch (NoTestsRemainException e) {28                e.printStackTrace();29            }30        }31    }32}

matchMethodDescription

Using AI Code Generation

1import org.junit.runner.Description2import org.junit.runner.manipulation.Filter3class MethodNameFilter extends Filter {4    MethodNameFilter(String methodName) {5    }6    boolean shouldRun(Description description) {7    }8    String describe() {9    }10}11import org.junit.runner.Description12import org.junit.runner.manipulation.Filter13class ClassNameFilter extends Filter {14    ClassNameFilter(String className) {15    }16    boolean shouldRun(Description description) {17    }18    String describe() {19    }20}21import org.junit.runner.Description22import org.junit.runner.manipulation.Filter23class MethodNameFilter extends Filter {24    MethodNameFilter(String methodName) {25    }26    boolean shouldRun(Description description) {27    }28    String describe() {29    }30}

matchMethodDescription

Using AI Code Generation

1public void filter() {2    Filter filter = new Filter() {3        public boolean shouldRun(Description description) {4            return matchMethodDescription(description);5        }6        public String describe() {7            return "JUnit filter";8        }9    };10    filter(filter);11}12public void filter() {13    Filter filter = new Filter() {14        public boolean shouldRun(Description description) {15            return matchMethodDescription(description);16        }17        public String describe() {18            return "JUnit filter";19        }20    };21    filter(filter);22}

JUnit Tutorial:

LambdaTest also has a detailed JUnit tutorial explaining its features, importance, advanced use cases, best practices, and more to help you get started with running your automation testing scripts.

JUnit Tutorial Chapters:

Here are the detailed JUnit testing chapters to help you get started:

Importance of Unit testing - Learn why Unit testing is essential during the development phase to identify bugs and errors.
Top Java Unit testing frameworks - Here are the upcoming JUnit automation testing frameworks that you can use in 2023 to boost your unit testing.
What is the JUnit framework
Why is JUnit testing important - Learn the importance and numerous benefits of using the JUnit testing framework.
Features of JUnit - Learn about the numerous features of JUnit and why developers prefer it.
JUnit 5 vs. JUnit 4: Differences - Here is a complete comparison between JUnit 5 and JUnit 4 testing frameworks.
Setting up the JUnit environment - Learn how to set up your JUnit testing environment.
Getting started with JUnit testing - After successfully setting up your JUnit environment, this chapter will help you get started with JUnit testing in no time.
Parallel testing with JUnit - Parallel Testing can be used to reduce test execution time and improve test efficiency. Learn how to perform parallel testing with JUnit.
Annotations in JUnit - When writing automation scripts with JUnit, we can use JUnit annotations to specify the type of methods in our test code. This helps us identify those methods when we run JUnit tests using Selenium WebDriver. Learn in detail what annotations are in JUnit.
Assertions in JUnit - Assertions are used to validate or test that the result of an action/functionality is the same as expected. Learn in detail what assertions are and how to use them while performing JUnit testing.
Parameterization in JUnit - Parameterized Test enables you to run the same automated test scripts with different variables. By collecting data on each method's test parameters, you can minimize time spent on writing tests. Learn how to use parameterization in JUnit.
Nested Tests In JUnit 5 - A nested class is a non-static class contained within another class in a hierarchical structure. It can share the state and setup of the outer class. Learn about nested annotations in JUnit 5 with examples.
Best practices for JUnit testing - Learn about the best practices, such as always testing key methods and classes, integrating JUnit tests with your build, and more to get the best possible results.
Advanced Use Cases for JUnit testing - Take a deep dive into the advanced use cases, such as how to run JUnit tests in Jupiter, how to use JUnit 5 Mockito for Unit testing, and more for JUnit testing.