com.qaprosoft.zafira.client

Interface BasicClient

All Known Subinterfaces:

ZafiraClient

All Known Implementing Classes:

BasicClientImpl, ZafiraClientImpl

public interface BasicClient

Method Summary

Modifier and Type	Method and Description
boolean	abortTestRun(long id) Aborts test run.
void	addTestArtifact(TestArtifactType artifact) Attaches test artifact like logs or demo URLs.
HttpClient.Response<JobType>	createJob(JobType job)
HttpClient.Response<WorkItem>	createOrUpdateTestWorkItem(long testId, WorkItem workItem)
HttpClient.Response<TestCaseType>	createTestCase(TestCaseType testCase)
HttpClient.Response<TestCaseType[]>	createTestCases(TestCaseType[] testCases)
HttpClient.Response<TestSuiteType>	createTestSuite(TestSuiteType testSuite)
HttpClient.Response<TestType>	createTestWorkItems(long testId, java.util.List<java.lang.String> workItems)
void	deleteTest(long id)
HttpClient.Response<TestType>	finishTest(TestType test)
HttpClient.Response<TestRunType>	finishTestRun(long id)
java.lang.String	getAuthToken()
AuthTokenType	getAuthTokenType()
java.lang.String	getProject()
HttpClient.Response<ProjectType>	getProjectByName(java.lang.String name) Gets project by name
java.lang.String	getServiceUrl()
HttpClient.Response<TestRunType>	getTestRun(long id)
HttpClient.Response<TestRunType>	getTestRunByCiRunId(java.lang.String ciRunId)
HttpClient.Response<TestType[]>	getTestRunResults(long id)
HttpClient.Response<WorkItem[]>	getTestWorkItems(long testId, WorkItem.Type type)
UserType	getUserOrAnonymousIfNotFound(java.lang.String username) Returns user by username or anonymous if not found.
HttpClient.Response<UserType>	getUserProfile()
HttpClient.Response<UserType>	getUserProfile(java.lang.String username)
java.lang.String	initProject(java.lang.String project) Initializes project context, sets default project if none found in DB.
boolean	isAvailable()
HttpClient.Response<AuthTokenType>	refreshToken(java.lang.String token)
HttpClient.Response<UploadResult>	sendArtifact(java.io.File artifact, java.lang.Long testRunId, java.lang.Long testId, java.lang.String name)
void	sendLogs(java.util.Collection<Log> logs, java.lang.Long testRunId)
HttpClient.Response<UploadResult>	sendScreenshot(byte[] screenshot, java.lang.Long testRunId, java.lang.Long testId, java.lang.Long capturedAt)
void	setAuthData(AuthTokenType authToken)
HttpClient.Response<TestType>	startTest(TestType test)
HttpClient.Response<TestRunType>	startTestRun(TestRunType testRun)
HttpClient.Response<TestRunType>	updateTestRun(TestRunType testRun)

Method Detail

setAuthData

void setAuthData(AuthTokenType authToken)

isAvailable

boolean isAvailable()

getUserProfile

HttpClient.Response<UserType> getUserProfile()

getUserProfile

HttpClient.Response<UserType> getUserProfile(java.lang.String username)

refreshToken

HttpClient.Response<AuthTokenType> refreshToken(java.lang.String token)

createJob

HttpClient.Response<JobType> createJob(JobType job)

createTestSuite

HttpClient.Response<TestSuiteType> createTestSuite(TestSuiteType testSuite)

startTestRun

HttpClient.Response<TestRunType> startTestRun(TestRunType testRun)

updateTestRun

HttpClient.Response<TestRunType> updateTestRun(TestRunType testRun)

finishTestRun

HttpClient.Response<TestRunType> finishTestRun(long id)

getTestRun

HttpClient.Response<TestRunType> getTestRun(long id)

getTestRunByCiRunId

HttpClient.Response<TestRunType> getTestRunByCiRunId(java.lang.String ciRunId)

startTest

HttpClient.Response<TestType> startTest(TestType test)

finishTest

HttpClient.Response<TestType> finishTest(TestType test)

deleteTest

void deleteTest(long id)

createTestWorkItems

HttpClient.Response<TestType> createTestWorkItems(long testId,
                                                  java.util.List<java.lang.String> workItems)

createOrUpdateTestWorkItem

HttpClient.Response<WorkItem> createOrUpdateTestWorkItem(long testId,
                                                         WorkItem workItem)

getTestWorkItems

HttpClient.Response<WorkItem[]> getTestWorkItems(long testId,
                                                 WorkItem.Type type)

addTestArtifact

void addTestArtifact(TestArtifactType artifact)

Attaches test artifact like logs or demo URLs.

Parameters:

artifact - - test artifact

createTestCase

HttpClient.Response<TestCaseType> createTestCase(TestCaseType testCase)

createTestCases

HttpClient.Response<TestCaseType[]> createTestCases(TestCaseType[] testCases)

getTestRunResults

HttpClient.Response<TestType[]> getTestRunResults(long id)

abortTestRun

boolean abortTestRun(long id)

Aborts test run.

Parameters:

id - of test run

Returns:

status

getProjectByName

HttpClient.Response<ProjectType> getProjectByName(java.lang.String name)

Gets project by name

Parameters:

name - of the project

Returns:

project

getProject

java.lang.String getProject()

initProject

java.lang.String initProject(java.lang.String project)

Initializes project context, sets default project if none found in DB.

Parameters:

project - name

Returns:

instance of ZafiraClientImpl

getUserOrAnonymousIfNotFound

UserType getUserOrAnonymousIfNotFound(java.lang.String username)

Returns user by username or anonymous if not found.

Parameters:

username - to find user

Returns:

user from DB

sendLogs

void sendLogs(java.util.Collection<Log> logs,
              java.lang.Long testRunId)

sendScreenshot

HttpClient.Response<UploadResult> sendScreenshot(byte[] screenshot,
                                                 java.lang.Long testRunId,
                                                 java.lang.Long testId,
                                                 java.lang.Long capturedAt)

sendArtifact

HttpClient.Response<UploadResult> sendArtifact(java.io.File artifact,
                                               java.lang.Long testRunId,
                                               java.lang.Long testId,
                                               java.lang.String name)

getServiceUrl

java.lang.String getServiceUrl()

getAuthToken

java.lang.String getAuthToken()

getAuthTokenType

AuthTokenType getAuthTokenType()