Package org.junit.platform.runner

Class JUnitPlatform

  • All Implemented Interfaces:
    org.junit.runner.Describable, org.junit.runner.manipulation.Filterable
    @API(status=STABLE,
     since="1.0")
public class JUnitPlatform
extends org.junit.runner.Runner
implements org.junit.runner.manipulation.Filterable
    JUnit 4 based Runner which runs tests on the JUnit Platform in a JUnit 4 environment.

    Annotating a class with @RunWith(JUnitPlatform.class) allows it to be run with IDEs and build systems that support JUnit 4 but do not yet support the JUnit Platform directly.

    Please note that test classes and suites annotated with @RunWith(JUnitPlatform.class) cannot be executed directly on the JUnit Platform (or as a "JUnit 5" test as documented in some IDEs). Such classes and suites can only be executed using JUnit 4 infrastructure.

    Consult the various annotations in the org.junit.platform.suite.api package for configuration options.

    If you do not use any configuration annotations from the org.junit.platform.suite.api package, you can simply use this runner on a test class whose programming model is supported on the JUnit Platform — for example, a JUnit Jupiter test class. Note, however, that any test class run with this runner must be public in order to be picked up by IDEs and build tools.

    When used on a class that serves as a test suite and the @IncludeClassNamePatterns annotation is not present, the default include pattern "^(Test.*|.+[.$]Test.*|.*Tests?)$" will be used in order to avoid loading classes unnecessarily (see ClassNameFilter#STANDARD_INCLUDE_PATTERN).

    Since:
    1.0
    See Also:
    SuiteDisplayName, UseTechnicalNames, SelectPackages, SelectClasses, IncludeClassNamePatterns, ExcludeClassNamePatterns, IncludePackages, ExcludePackages, IncludeTags, ExcludeTags, IncludeEngines, ExcludeEngines

    • Constructor Summary

      Constructors 
      Constructor Description
      JUnitPlatform​(java.lang.Class<?> testClass)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void filter​(org.junit.runner.manipulation.Filter filter)  
      org.junit.runner.Description getDescription()  
      void run​(org.junit.runner.notification.RunNotifier notifier)  

      • Methods inherited from class org.junit.runner.Runner

        testCount

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JUnitPlatform

        public JUnitPlatform​(java.lang.Class<?> testClass)

    • Method Detail

      • getDescription

        public org.junit.runner.Description getDescription()
        Specified by:
        getDescription in interface org.junit.runner.Describable
        Specified by:
        getDescription in class org.junit.runner.Runner

      • run

        public void run​(org.junit.runner.notification.RunNotifier notifier)
        Specified by:
        run in class org.junit.runner.Runner

      • filter

        public void filter​(org.junit.runner.manipulation.Filter filter)
            throws org.junit.runner.manipulation.NoTestsRemainException
        Specified by:
        filter in interface org.junit.runner.manipulation.Filterable
        Throws:
        org.junit.runner.manipulation.NoTestsRemainException