Package de.qytera.qtaf.xray.config

Class XrayConfigHelper

java.lang.Object
de.qytera.qtaf.xray.config.XrayConfigHelper
public class XrayConfigHelper extends Object
Xray configuration helper

  • Field Details

  • Method Details

    • getAuthenticationXrayBearerToken

      public static String getAuthenticationXrayBearerToken()
      Returns the bearer token for authenticating against Xray server.
      Returns:
      the bearer token or null if undefined

    • getAuthenticationXrayClientId

      public static String getAuthenticationXrayClientId()
      Returns the client id for authenticating against Xray cloud.
      Returns:
      the client id or null if undefined

    • getAuthenticationXrayClientSecret

      public static String getAuthenticationXrayClientSecret()
      Returns the client secret for authenticating against Xray cloud.
      Returns:
      the client secret or null if undefined

    • getAuthenticationJiraUsername

      public static String getAuthenticationJiraUsername()
      Returns the username for authenticating against the Jira instance's REST API.
      Returns:
      the username or null if undefined

    • getAuthenticationJiraAPIToken

      public static String getAuthenticationJiraAPIToken()
      Returns the API token used during authentication against the Jira instance's REST API.
      Returns:
      the API token or null if undefined

    • getServerUrl

      public static String getServerUrl()
      Get Xray server URL
      Returns:
      Xray server URL

    • getJiraUrl

      public static String getJiraUrl()
      Returns the URL of the underlying Jira instance.
      Returns:
      the Jira URL or null if undefined

    • getTestStatusPassed

      public static String getTestStatusPassed()
      Get Xray status name for passed tests.
      Returns:
      the status name if configured, otherwise null

    • getTestStatusFailed

      public static String getTestStatusFailed()
      Get Xray status name for failed tests.
      Returns:
      the status name if configured, otherwise null

    • getTestStatusPending

      public static String getTestStatusPending()
      Get Xray status name for pending tests.
      Returns:
      the status name if configured, otherwise null

    • getTestStatusSkipped

      public static String getTestStatusSkipped()
      Get Xray status name for skipped tests.
      Returns:
      the status name if configured, otherwise null

    • getStepStatusPassed

      public static String getStepStatusPassed()
      Get Xray status name for passed test steps.
      Returns:
      the status name if configured, otherwise null

    • getStepStatusFailed

      public static String getStepStatusFailed()
      Get Xray status name for failed test steps.
      Returns:
      the status name if configured, otherwise null

    • getStepStatusPending

      public static String getStepStatusPending()
      Get Xray status name for pending test steps.
      Returns:
      the status name if configured, otherwise null

    • getStepStatusSkipped

      public static String getStepStatusSkipped()
      Get Xray status name for skipped test steps.
      Returns:
      the status name if configured, otherwise null

    • getStepStatusUndefined

      public static String getStepStatusUndefined()
      Get Xray status name for undefined test steps.
      Returns:
      the status name if configured, otherwise null

    • getXrayService

      public static String getXrayService()
      Get xray service (cloud | server)
      Returns:
      xray service (cloud | server)

    • isXrayServerService

      public static boolean isXrayServerService()
      Check if Xray server is enabled
      Returns:
      true if enabled, false otherwise

    • isXrayCloudService

      public static boolean isXrayCloudService()
      Check if Xray cloud is enabled
      Returns:
      true if enabled, false otherwise

    • isScenarioReportEvidenceEnabled

      public static boolean isScenarioReportEvidenceEnabled()
      Check if HTML report should be attached as evidence to Xray test execution import
      Returns:
      true if enabled, false otherwise

    • isScenarioImageEvidenceEnabled

      public static boolean isScenarioImageEvidenceEnabled()
      Check if images should be attached as evidence to Xray test execution import
      Returns:
      true if enabled, false otherwise

    • getTestsIterationsParametersNameMaxLength

      public static Integer getTestsIterationsParametersNameMaxLength()
      Returns the maximum allowed length of iteration parameter names.
      Returns:
      the maximum length or null if there is no maximum length

    • getTestsIterationsParametersValueMaxLength

      public static Integer getTestsIterationsParametersValueMaxLength()
      Returns the maximum allowed length of iteration parameter values.
      Returns:
      the maximum length or null if there is no maximum length

    • shouldResultsUploadTestsInfoStepsMerge

      public static boolean shouldResultsUploadTestsInfoStepsMerge()
      Returns whether test issue steps should be merged into a single step during results upload.
      Returns:
      whether they should be merged

    • shouldResultsUploadTestsInfoStepsUpdate

      public static boolean shouldResultsUploadTestsInfoStepsUpdate()
      Returns whether test issue steps should be updated during results upload of tests.
      Returns:
      whether they should be updated

    • shouldResultsUploadTestsInfoKeepJiraSummary

      public static boolean shouldResultsUploadTestsInfoKeepJiraSummary()
      Returns whether test issue summaries should be kept as they are in Jira instead of replacing them using Test.testName() during results upload.
      Returns:
      whether summaries should be kept

    • getProjectKey

      public static String getProjectKey()
      Returns the project key.
      Returns:
      the configured project key

    • getResultsUploadTestPlanKey

      public static String getResultsUploadTestPlanKey()
      Returns the test plan key to attach execution results to.
      Returns:
      the configured test plan key or null if no test plan has been defined