> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

PreFlight

View this plugin on the Plugins site

step([$class: 'PreflightBuilder']): Run PreFlight Test

  • clientId
    (required) Client Id for PreFlight API. You can generate client id and client secret from Account Settings>API under your Preflight account.
    • Type: String
  • clientSecret
    (required) Client Secret for PreFlight API. You can generate client id and client secret from Account Settings>API under your Preflight account.
    • Type: String
  • testId
    (optional) Pass the Test Id to run. If test id or group id are not passed all the tests will be run.
    • Type: String
  • groupId
    (optional) Pass the Group Id to run. If test id or group id are not passed all the tests will be run. You can get it from Test Settings>Groups under your Preflight account.
    • Type: String
  • environmentId
    (optional) Environment ID for your test group. You can get it from Test Settings>Environments under your Preflight account.
    • Type: String
  • platforms
    (optional) Platforms and browsers you want to run your PreFlight tests.
    • Example usage win-chrome.
    • You can pass more than one browser option. Ex. win-chrome,win-firefox
    • Platform options : win
    • Browser options : chrome, ie, edge, firefox
    • Type: String
  • sizes
    (optional) Sizes you want to run your PreFlight tests.
    • Example usage. (WidthxHeight) 1440x900.
    • You can pass more than one size option. Ex. 1920x1080, 1440x900
    • Size options : 1920x1080, 1440x900, 1024x768, 480x640
    • Type: String
  • captureScreenshots
    Capture screenshots enables taking screenshots of the each step.
    • Type: boolean
  • waitResults
    Wait PreFlight test result(s). If you set it as true, your Jenkins build waits your PreFlight test result(s).
    • Type: boolean

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.