Method Detail

• getTestPlanTests

   final List<XrayTest> getTestPlanTests(String testPlanKey)

  Return all the tests contained in the test plan given in parameter. First of all, the function will gather all tests of the given test plan, and then, it will retrieve the Xray issue for each test.

  Parameters:

  testPlanKey - Identifier of the test plan to obtain its tests.

• getTests

   final List<XrayTest> getTests(String testKey)

• getTestSteps

   final List<XrayTestStep> getTestSteps(String testKey)

  Ask the Jira API for the steps of a given test.

  Parameters:

  testKey - is the identifier of the test to retrieve the steps.

• getKeyOfSearchedIssue

   final SearchIssueResult getKeyOfSearchedIssue(String jql)

  This functions will search for the issue using the JQL query given in parameters and return the identifier of the retrieved issue. This function will return a result only if there is only one issue retrieved by the JQL query.

  Parameters:

  jql - is the query format of Jira to search for issues.

• getProjectFromIssue

   final JiraTestProject getProjectFromIssue(String issueKey)

• createNewTestExecutionIssue

   final JiraIssue createNewTestExecutionIssue(XrayTestExecutionCreation textExectuionFields)

  Create a new Test execution issue in Jira.

• sendTestExecution

   final Response<ResponseBody> sendTestExecution(XrayTestExecution execution)

  Send the test execution to Jira.

  Parameters:

  execution - is the result of the test execution.

• getAttachmentToString

   final String getAttachmentToString(XrayAttachment attachment)

  This function converts an attachment file into a String.

  Parameters:

  attachment - is the attachment stored as an XrayAttachment object linked to a test step.

• createTest

   final JiraIssue createTest(JiraTest test)

• saveStep

   final ResponseBody saveStep(String testKey, XrayBuildTestStep step)

• deleteStep

   final ResponseBody deleteStep(String testKey, Long stepId)

• getIssue

   final ResponseBody getIssue(String issueKey)

• addPrecondition

   final ResponseBody addPrecondition(String preConditionKey, String jiraId)

• updateTest

   final ResponseBody updateTest(String jiraId, JiraTest test)

• uploadAttachment

   final JiraAttachment uploadAttachment(String issueId, String name, String content)

• linkTest

   final Unit linkTest(String key1, String key2)

• getLabels

   final List<String> getLabels(String key)

• getLinkedIssues

   final List<String> getLinkedIssues(String key, String linkedField)

• addTestToTestPlan

   final Response<ResponseBody> addTestToTestPlan(String test, String testPlan)

• getProjectTestPlans

   final List<XrayTestPlan> getProjectTestPlans(String project)

• getXray

   final XrayApi getXray()