ai.tock.bot.xray

Class XrayClient

ai.tock.bot.xray.XrayClient

public class XrayClient

Field Detail

INSTANCE

public static XrayClient INSTANCE

Method Detail

getXray

@NotNull
public XrayApi getXray()

getTestPlanTests

@NotNull
public java.util.List<ai.tock.bot.xray.model.XrayTest> getTestPlanTests(@NotNull
                                                                                 java.lang.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.

Returns:

a list of XrayTest to represent all tests of the targeted test plan.

getTests

@NotNull
public java.util.List<ai.tock.bot.xray.model.XrayTest> getTests(@NotNull
                                                                         java.lang.String testKey)

getTestSteps

@NotNull
public java.util.List<ai.tock.bot.xray.model.XrayTestStep> getTestSteps(@NotNull
                                                                                 java.lang.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.

Returns:

a list of steps as a XrayTestStep object.

getKeyOfSearchedIssue

@NotNull
public SearchIssueResult getKeyOfSearchedIssue(@NotNull
                                                        java.lang.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.

Returns:

The identifier of the retrieved issue in String format.

getProjectFromIssue

@NotNull
public JiraTestProject getProjectFromIssue(@NotNull
                                                    java.lang.String issueKey)

createNewTestExecutionIssue

@NotNull
public JiraIssue createNewTestExecutionIssue(@NotNull
                                                      XrayTestExecutionCreation textExectuionFields)

Create a new Test execution issue in Jira.

sendTestExecution

@NotNull
public retrofit2.Response<okhttp3.ResponseBody> sendTestExecution(@NotNull
                                                                           XrayTestExecution execution)

Send the test execution to Jira.

Parameters:

execution - is the result of the test execution.

Returns:

the answer of Jira after the test execution reception.

getAttachmentToString

@NotNull
public java.lang.String getAttachmentToString(@NotNull
                                                       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.

Returns:

the content of the attachment in String format.

createTest

@NotNull
public JiraIssue createTest(@NotNull
                                     JiraTest test)

saveStep

@Nullable
public okhttp3.ResponseBody saveStep(@NotNull
                                               java.lang.String testKey,
                                               @NotNull
                                               XrayBuildTestStep step)

deleteStep

@NotNull
public okhttp3.ResponseBody deleteStep(@NotNull
                                                java.lang.String testKey,
                                                long stepId)

getIssue

@NotNull
public okhttp3.ResponseBody getIssue(@NotNull
                                              java.lang.String issueKey)

addPrecondition

@Nullable
public okhttp3.ResponseBody addPrecondition(@NotNull
                                                      java.lang.String preConditionKey,
                                                      @NotNull
                                                      java.lang.String jiraId)

updateTest

@Nullable
public okhttp3.ResponseBody updateTest(@NotNull
                                                 java.lang.String jiraId,
                                                 @NotNull
                                                 JiraTest test)

uploadAttachment

@NotNull
public JiraAttachment uploadAttachment(@NotNull
                                                java.lang.String issueId,
                                                @NotNull
                                                java.lang.String name,
                                                @NotNull
                                                java.lang.String content)

linkTest

public void linkTest(@NotNull
                     java.lang.String key1,
                     @NotNull
                     java.lang.String key2)

getLabels

@NotNull
public java.util.List<java.lang.String> getLabels(@NotNull
                                                           java.lang.String key)

getLinkedIssues

@NotNull
public java.util.List<java.lang.String> getLinkedIssues(@NotNull
                                                                 java.lang.String key,
                                                                 @NotNull
                                                                 java.lang.String linkedField)

addTestToTestPlan

public retrofit2.Response<okhttp3.ResponseBody> addTestToTestPlan(@NotNull
                                                                  java.lang.String test,
                                                                  @NotNull
                                                                  java.lang.String testPlan)

getProjectTestPlans

@NotNull
public java.util.List<ai.tock.bot.xray.model.XrayTestPlan> getProjectTestPlans(@NotNull
                                                                                        java.lang.String project)