Package io.jpostman.annotations

Annotation Type JPostman.Runner

    • Element Detail

      • id

        String id
        Optional annotation id used by dependsOn = "#id".
        Returns:
        annotation id
        Default:
        ""

      • tags

        String[] tags
        Tags used to select this runner.
        Returns:
        tags
        Default:
        {}

      • namespace

        String namespace
        Runner namespace.
        Returns:
        namespace
        Default:
        ""

      • folder

        String[] folder
        Collection folder path from the collection root to the target folder.

        Each value represents one folder level. An empty value selects requests from the collection root. 

         folder = "Products"
 folder = { "level1", "level2", "level3" }
        Returns:
        folder path levels from parent to child
        Default:
        {""}

      • include

        String[] include
        Request names to include.
        Returns:
        included request names
        Default:
        {}

      • exclude

        String[] exclude
        Request names to exclude.
        Returns:
        excluded request names
        Default:
        {}

      • rule

        String rule
        Rules section name.
        Returns:
        rule name
        Default:
        ""

      • filter

        String[] filter
        Fields to keep in the context.
        Returns:
        filter fields
        Default:
        {}

      • dependsOn

        String[] dependsOn
        Dependency method names.

        For runner launcher methods, a single runner dependency such as dependsOn = "#testRunner" can reuse the referenced runner body with this annotation's tags when this runner does not define its own folder, include/exclude, executor, rule, filter, data, asserts, verify, soft, or lifecycle settings.

        Returns:
        dependency method names
        Default:
        {}

      • verify

        int verify
        Expected HTTP status code.
        Returns:
        expected HTTP status code, -1 to use the context default, or 0 to skip status code verification for this runner
        Default:
        -1

      • executor

        String executor
        Executor id.
        Returns:
        executor id
        Default:
        ""

      • log

        String log
        Local automatic JPostman failure output mode. Values are single-choice; use one value only.
        • none - print only the minimum failure message and the first useful user-code stack frame.
        • debug - print the configured debug output and use minimum failure output when debug is none.
        • error - print the failure message and include the trace.
        Returns:
        local automatic failure output mode
        Default:
        "debug"

      • soft

        boolean soft
        Enables soft assertion mode.
        Returns:
        true to collect assertion failures
        Default:
        false

      • lifecycle

        boolean lifecycle
        Enables request/response runner lifecycle callbacks.

        The default false invokes blank-request @JPostman.Request dependencies once for each selected collection request after that request is prepared, then invokes the runner method body after the response. Set this to true to keep dependencies as one-time runner setup and enable the before-request/response lifecycle used by jpostman.runner().start(...), jpostman.runner().request(...), or jpostman.runner().response(...).

        Returns:
        true to enable before-request and response lifecycle callbacks
        Default:
        false

      • data

        String data
        Data section name.
        Returns:
        data section
        Default:
        ""

      • asserts

        String[] asserts
        Assertion section names.
        Returns:
        assertion sections
        Default:
        {}

      • enabled

        boolean enabled
        Returns:
        true to run this runner even when context skipAll is enabled
        Default:
        false

      • skip

        boolean skip
        Returns:
        true to skip this runner/test execution
        Default:
        false