com.qaprosoft.zafira.client.impl

Class ZafiraClientImpl

java.lang.Object

com.qaprosoft.zafira.client.impl.ZafiraClientImpl

All Implemented Interfaces:

BasicClient, ExtendedClient, ZafiraClient

public class ZafiraClientImpl
extends java.lang.Object
implements ZafiraClient

Constructor Summary

Constructors

Constructor and Description
ZafiraClientImpl(java.lang.String serviceUrl)

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()
BasicClient	getClient()
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)
JobType	registerJob(java.lang.String jobUrl, java.lang.Long userId) Registers job in Zafira, it may be a new one or existing returned by service.
TestCaseType	registerTestCase(java.lang.Long suiteId, java.lang.Long primaryOwnerId, java.lang.Long secondaryOwnerId, java.lang.String testClass, java.lang.String testMethod) Registers test case in Zafira, it may be a new one or existing returned by service.
TestType	registerTestRestart(TestType test) Registers test re-run in Zafira.
TestRunType	registerTestRun(java.lang.Long testSuiteId, java.lang.Long userId, java.lang.String configXML, java.lang.Long jobId, java.lang.Long parentJobId, CiConfig ciConfig, java.lang.String workItem) Registers new test run
TestRunType	registerTestRunByHUMAN(java.lang.Long testSuiteId, java.lang.Long userId, java.lang.String configXML, java.lang.Long jobId, CiConfig ciConfig, Initiator startedBy, java.lang.String workItem) Registers new test run triggered by human.
TestRunType	registerTestRunBySCHEDULER(java.lang.Long testSuiteId, java.lang.String configXML, java.lang.Long jobId, CiConfig ciConfig, Initiator startedBy, java.lang.String workItem) Registers new test run triggered by scheduler.
TestRunType	registerTestRunResults(TestRunType testRun) Finalizes test run calculating test results.
TestRunType	registerTestRunUPSTREAM_JOB(java.lang.Long testSuiteId, java.lang.String configXML, java.lang.Long jobId, java.lang.Long parentJobId, CiConfig ciConfig, Initiator startedBy, java.lang.String workItem) Registers new test run triggered by upstream job.
TestType	registerTestStart(java.lang.String name, java.lang.String group, Status status, java.lang.String testArgs, java.lang.Long testRunId, java.lang.Long testCaseId, int retryCount, java.lang.String configXML, java.lang.String[] dependsOnMethods, java.lang.String ciTestId, java.util.Set<TagType> tags) Registers test run in Zafira.
TestSuiteType	registerTestSuite(java.lang.String suiteName, java.lang.String fileName, java.lang.Long userId) Registers test suite in Zafira, it may be a new one or existing returned by service.
WorkItem	registerWorkItem(java.lang.Long testId, WorkItem workItem)
TestType	registerWorkItems(java.lang.Long testId, java.util.List<java.lang.String> workItems) Registers test work items.
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 authTokenType)
HttpClient.Response<TestType>	startTest(TestType test)
HttpClient.Response<TestRunType>	startTestRun(TestRunType testRun)
HttpClient.Response<TestRunType>	updateTestRun(TestRunType testRun)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZafiraClientImpl

public ZafiraClientImpl(java.lang.String serviceUrl)

Method Detail

setAuthData

public void setAuthData(AuthTokenType authTokenType)

Specified by:

setAuthData in interface BasicClient

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface BasicClient

getUserProfile

public HttpClient.Response<UserType> getUserProfile()

Specified by:

getUserProfile in interface BasicClient

getUserProfile

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

Specified by:

getUserProfile in interface BasicClient

refreshToken

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

Specified by:

refreshToken in interface BasicClient

createJob

public HttpClient.Response<JobType> createJob(JobType job)

Specified by:

createJob in interface BasicClient

createTestSuite

public HttpClient.Response<TestSuiteType> createTestSuite(TestSuiteType testSuite)

Specified by:

createTestSuite in interface BasicClient

startTestRun

public HttpClient.Response<TestRunType> startTestRun(TestRunType testRun)

Specified by:

startTestRun in interface BasicClient

updateTestRun

public HttpClient.Response<TestRunType> updateTestRun(TestRunType testRun)

Specified by:

updateTestRun in interface BasicClient

finishTestRun

public HttpClient.Response<TestRunType> finishTestRun(long id)

Specified by:

finishTestRun in interface BasicClient

getTestRun

public HttpClient.Response<TestRunType> getTestRun(long id)

Specified by:

getTestRun in interface BasicClient

getTestRunByCiRunId

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

Specified by:

getTestRunByCiRunId in interface BasicClient

startTest

public HttpClient.Response<TestType> startTest(TestType test)

Specified by:

startTest in interface BasicClient

finishTest

public HttpClient.Response<TestType> finishTest(TestType test)

Specified by:

finishTest in interface BasicClient

deleteTest

public void deleteTest(long id)

Specified by:

deleteTest in interface BasicClient

createTestWorkItems

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

Specified by:

createTestWorkItems in interface BasicClient

createOrUpdateTestWorkItem

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

Specified by:

createOrUpdateTestWorkItem in interface BasicClient

getTestWorkItems

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

Specified by:

getTestWorkItems in interface BasicClient

addTestArtifact

public void addTestArtifact(TestArtifactType artifact)

Description copied from interface: BasicClient

Attaches test artifact like logs or demo URLs.

Specified by:

addTestArtifact in interface BasicClient

Parameters:

artifact - - test artifact

createTestCase

public HttpClient.Response<TestCaseType> createTestCase(TestCaseType testCase)

Specified by:

createTestCase in interface BasicClient

createTestCases

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

Specified by:

createTestCases in interface BasicClient

getTestRunResults

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

Specified by:

getTestRunResults in interface BasicClient

abortTestRun

public boolean abortTestRun(long id)

Description copied from interface: BasicClient

Aborts test run.

Specified by:

abortTestRun in interface BasicClient

Parameters:

id - of test run

Returns:

status

getProjectByName

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

Description copied from interface: BasicClient

Gets project by name

Specified by:

getProjectByName in interface BasicClient

Parameters:

name - of the project

Returns:

project

getProject

public java.lang.String getProject()

Specified by:

getProject in interface BasicClient

initProject

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

Description copied from interface: BasicClient

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

Specified by:

initProject in interface BasicClient

Parameters:

project - name

Returns:

instance of ZafiraClientImpl

getUserOrAnonymousIfNotFound

public UserType getUserOrAnonymousIfNotFound(java.lang.String username)

Description copied from interface: BasicClient

Returns user by username or anonymous if not found.

Specified by:

getUserOrAnonymousIfNotFound in interface BasicClient

Parameters:

username - to find user

Returns:

user from DB

sendLogs

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

Specified by:

sendLogs in interface BasicClient

sendScreenshot

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

Specified by:

sendScreenshot in interface BasicClient

sendArtifact

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

Specified by:

sendArtifact in interface BasicClient

getServiceUrl

public java.lang.String getServiceUrl()

Specified by:

getServiceUrl in interface BasicClient

getAuthToken

public java.lang.String getAuthToken()

Specified by:

getAuthToken in interface BasicClient

registerTestCase

public TestCaseType registerTestCase(java.lang.Long suiteId,
                                     java.lang.Long primaryOwnerId,
                                     java.lang.Long secondaryOwnerId,
                                     java.lang.String testClass,
                                     java.lang.String testMethod)

Description copied from interface: ExtendedClient

Registers test case in Zafira, it may be a new one or existing returned by service.

Specified by:

registerTestCase in interface ExtendedClient

Returns:

registered test case

registerWorkItems

public TestType registerWorkItems(java.lang.Long testId,
                                  java.util.List<java.lang.String> workItems)

Description copied from interface: ExtendedClient

Registers test work items.

Specified by:

registerWorkItems in interface ExtendedClient

Returns:

test for which we registers work items

registerWorkItem

public WorkItem registerWorkItem(java.lang.Long testId,
                                 WorkItem workItem)

Specified by:

registerWorkItem in interface ExtendedClient

registerTestSuite

public TestSuiteType registerTestSuite(java.lang.String suiteName,
                                       java.lang.String fileName,
                                       java.lang.Long userId)

Description copied from interface: ExtendedClient

Registers test suite in Zafira, it may be a new one or existing returned by service.

Specified by:

registerTestSuite in interface ExtendedClient

Parameters:

suiteName - - test suite name

fileName - - TestNG xml file name

userId - - suite owner user id

Returns:

created test suite

registerJob

public JobType registerJob(java.lang.String jobUrl,
                           java.lang.Long userId)

Description copied from interface: ExtendedClient

Registers job in Zafira, it may be a new one or existing returned by service.

Specified by:

registerJob in interface ExtendedClient

Parameters:

jobUrl - - CI job URL

userId - - job owner user id

Returns:

created job

registerTestRun

public TestRunType registerTestRun(java.lang.Long testSuiteId,
                                   java.lang.Long userId,
                                   java.lang.String configXML,
                                   java.lang.Long jobId,
                                   java.lang.Long parentJobId,
                                   CiConfig ciConfig,
                                   java.lang.String workItem)

Description copied from interface: ExtendedClient

Registers new test run

Specified by:

registerTestRun in interface ExtendedClient

Returns:

created test run

registerTestRunByHUMAN

public TestRunType registerTestRunByHUMAN(java.lang.Long testSuiteId,
                                          java.lang.Long userId,
                                          java.lang.String configXML,
                                          java.lang.Long jobId,
                                          CiConfig ciConfig,
                                          Initiator startedBy,
                                          java.lang.String workItem)

Description copied from interface: ExtendedClient

Registers new test run triggered by human.

Specified by:

registerTestRunByHUMAN in interface ExtendedClient

Returns:

created test run

registerTestRunBySCHEDULER

public TestRunType registerTestRunBySCHEDULER(java.lang.Long testSuiteId,
                                              java.lang.String configXML,
                                              java.lang.Long jobId,
                                              CiConfig ciConfig,
                                              Initiator startedBy,
                                              java.lang.String workItem)

Description copied from interface: ExtendedClient

Registers new test run triggered by scheduler.

Specified by:

registerTestRunBySCHEDULER in interface ExtendedClient

Returns:

created test run

registerTestRunUPSTREAM_JOB

public TestRunType registerTestRunUPSTREAM_JOB(java.lang.Long testSuiteId,
                                               java.lang.String configXML,
                                               java.lang.Long jobId,
                                               java.lang.Long parentJobId,
                                               CiConfig ciConfig,
                                               Initiator startedBy,
                                               java.lang.String workItem)

Description copied from interface: ExtendedClient

Registers new test run triggered by upstream job.

Specified by:

registerTestRunUPSTREAM_JOB in interface ExtendedClient

Returns:

created test run

registerTestRunResults

public TestRunType registerTestRunResults(TestRunType testRun)

Description copied from interface: ExtendedClient

Finalizes test run calculating test results.

Specified by:

registerTestRunResults in interface ExtendedClient

Parameters:

testRun - - test run object

Returns:

updated test run

registerTestStart

public TestType registerTestStart(java.lang.String name,
                                  java.lang.String group,
                                  Status status,
                                  java.lang.String testArgs,
                                  java.lang.Long testRunId,
                                  java.lang.Long testCaseId,
                                  int retryCount,
                                  java.lang.String configXML,
                                  java.lang.String[] dependsOnMethods,
                                  java.lang.String ciTestId,
                                  java.util.Set<TagType> tags)

Description copied from interface: ExtendedClient

Registers test run in Zafira.

Specified by:

registerTestStart in interface ExtendedClient

Returns:

registered test

registerTestRestart

public TestType registerTestRestart(TestType test)

Description copied from interface: ExtendedClient

Registers test re-run in Zafira.

Specified by:

registerTestRestart in interface ExtendedClient

Parameters:

test - - test object

Returns:

registered test

getClient

public BasicClient getClient()

Specified by:

getClient in interface ZafiraClient

getAuthTokenType

public AuthTokenType getAuthTokenType()

Specified by:

getAuthTokenType in interface BasicClient