Interface TestDescriptor

    • Method Detail

      • getUniqueId

        UniqueId getUniqueId​()
        Get the unique identifier (UID) for this descriptor.

        Uniqueness must be guaranteed across an entire test plan, regardless of how many engines are used behind the scenes.

        the UniqueId for this descriptor; never null
      • getDisplayName

        java.lang.String getDisplayName​()
        Get the display name for this descriptor.

        A display name is a human-readable name for a test or container that is typically used for test reporting in IDEs and build tools. Display names may contain spaces, special characters, and emoji, and the format may be customized by TestEngines or potentially by end users as well. Consequently, display names should never be parsed; rather, they should be used for display purposes only.

        the display name for this descriptor; never null or blank
        See Also:
      • getLegacyReportingName

        default java.lang.String getLegacyReportingName​()
        Get the name of this descriptor in a format that is suitable for legacy reporting infrastructure — for example, for reporting systems built on the Ant-based XML reporting format for JUnit 4.

        The default implementation simply delegates to getDisplayName().

        the legacy reporting name; never null or blank
      • getTags

        java.util.Set<TestTag> getTags​()
        Get the set of tags associated with this descriptor.
        the set of tags associated with this descriptor; never null but potentially empty
        See Also:
      • getSource

        java.util.Optional<TestSource> getSource​()
        Get the source of the test or container described by this descriptor, if available.
        See Also:
      • getParent

        java.util.Optional<TestDescriptor> getParent​()
        Get the parent of this descriptor, if available.
      • setParent

        void setParent​(TestDescriptor parent)
        Set the parent of this descriptor.
        parent - the new parent of this descriptor; may be null.
      • getChildren

        java.util.Set<? extends TestDescriptor> getChildren​()
        Get the immutable set of children of this descriptor.
        the set of children of this descriptor; neither null nor mutable, but potentially empty
        See Also:
      • getDescendants

        default java.util.Set<? extends TestDescriptor> getDescendants​()
        Get the immutable set of all descendants of this descriptor.

        A descendant is a child of this descriptor or a child of one of its children, recursively.

        See Also:
      • addChild

        void addChild​(TestDescriptor descriptor)
        Add a child to this descriptor.
        descriptor - the child to add to this descriptor; never null
      • removeChild

        void removeChild​(TestDescriptor descriptor)
        Remove a child from this descriptor.
        descriptor - the child to remove from this descriptor; never null
      • removeFromHierarchy

        void removeFromHierarchy​()
        Remove this non-root descriptor from its parent and remove all the children from this descriptor.

        If this method is invoked on a root descriptor, this method must throw a JUnitException explaining that a root cannot be removed from the hierarchy.

      • isRoot

        default boolean isRoot​()
        Determine if this descriptor is a root descriptor.

        A root descriptor is a descriptor without a parent.

      • isContainer

        default boolean isContainer​()
        Determine if this descriptor describes a container.

        The default implementation delegates to TestDescriptor.Type.isContainer().

      • isTest

        default boolean isTest​()
        Determine if this descriptor describes a test.

        The default implementation delegates to TestDescriptor.Type.isTest().

      • mayRegisterTests

        default boolean mayRegisterTests​()
        Determine if this descriptor may register dynamic tests during execution.

        The default implementation assumes tests are usually known during discovery and thus returns false.

      • containsTests

        static boolean containsTests​(TestDescriptor testDescriptor)
        Determine if the supplied descriptor or any of its descendants contains any tests.
      • findByUniqueId

        java.util.Optional<? extends TestDescriptor> findByUniqueId​(UniqueId uniqueId)
        Find the descriptor with the supplied unique ID.

        The search algorithm begins with this descriptor and then searches through its descendants.

        uniqueId - the UniqueId to search for; never null
      • accept

        default void accept​(TestDescriptor.Visitor visitor)
        Accept a visitor to the subtree starting with this descriptor.
        visitor - the Visitor to accept; never null