org.squashtest.tm.service.testautomation.spi

Interface TestAutomationConnector

public interface TestAutomationConnector

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkCredentials(org.squashtest.tm.domain.testautomation.TestAutomationServer server) Checks that the given server configuration (including credentials) actually works.
void	executeParameterizedTests(Collection<org.squashtest.tm.core.foundation.lang.Couple<org.squashtest.tm.domain.testautomation.AutomatedExecutionExtender,Map<String,Object>>> tests, String externalId, TestAutomationCallbackService securedCallback) Given a bunch of tests, must tell the remote server to execute them.
URL	findTestAutomationProjectURL(org.squashtest.tm.domain.testautomation.TestAutomationProject testAutomationProject) Will build and return the URL to access to the given test automation project's.
String	getConnectorKind() A String indicating which kind of connector it is
Collection<org.squashtest.tm.domain.testautomation.TestAutomationProject>	listProjectsOnServer(org.squashtest.tm.domain.testautomation.TestAutomationServer server) Given a server (that contains everything you need to connect it), returns the collection of TestAutomationProject that it hosts.
Collection<org.squashtest.tm.domain.testautomation.AutomatedTest>	listTestsInProject(org.squashtest.tm.domain.testautomation.TestAutomationProject project) Given a project (that contains everything you need to connect it), returns the collection of AutomatedTest that it contains
boolean	testListIsOrderGuaranteed(Collection<org.squashtest.tm.domain.testautomation.AutomatedTest> tests) Will say, depending on the tests ecosystems if the execution order of the given test list is guaranteed.

Method Detail

getConnectorKind

String getConnectorKind()

A String indicating which kind of connector it is

Returns:

checkCredentials

boolean checkCredentials(org.squashtest.tm.domain.testautomation.TestAutomationServer server)

Checks that the given server configuration (including credentials) actually works.

Parameters:

server -

Returns:

true if the credentials work, false otherwise

listProjectsOnServer

Collection<org.squashtest.tm.domain.testautomation.TestAutomationProject> listProjectsOnServer(org.squashtest.tm.domain.testautomation.TestAutomationServer server)
                                                                                               throws ServerConnectionFailed,
                                                                                                      AccessDenied,
                                                                                                      UnreadableResponseException,
                                                                                                      NotFoundException,
                                                                                                      BadConfiguration,
                                                                                                      TestAutomationException

Given a server (that contains everything you need to connect it), returns the collection of TestAutomationProject that it hosts.

Parameters:

server -

Returns:

a Collection that may never be null if success

Throws:

ServerConnectionFailed - if could not connect to the server

AccessDenied - if the server was reached but the used user could log in

UnreadableResponseException - if the server replied something that is not suitable for a response or otherwise replied not nicely

NotFoundException - if the server could not find its projects

TestAutomationException - for anything that doesn't fit the exceptions above.

BadConfiguration

listTestsInProject

Collection<org.squashtest.tm.domain.testautomation.AutomatedTest> listTestsInProject(org.squashtest.tm.domain.testautomation.TestAutomationProject project)
                                                                                     throws ServerConnectionFailed,
                                                                                            AccessDenied,
                                                                                            UnreadableResponseException,
                                                                                            NotFoundException,
                                                                                            BadConfiguration,
                                                                                            TestAutomationException

Given a project (that contains everything you need to connect it), returns the collection of AutomatedTest that it contains

Parameters:

project -

Returns:

a Collection possibly empty but never null of TestAutomationTest if success

Throws:

ServerConnectionFailed - if could not connect to the server

AccessDenied - if the server was reached but the used user could log in

UnreadableResponseException - if the server replied something that is not suitable for a response or otherwise was rude to you

NotFoundException - if the tests in that project cannot be found

TestAutomationException - for anything that doesn't fit the exceptions above.

BadConfiguration

executeParameterizedTests

void executeParameterizedTests(Collection<org.squashtest.tm.core.foundation.lang.Couple<org.squashtest.tm.domain.testautomation.AutomatedExecutionExtender,Map<String,Object>>> tests,
                             String externalId,
                             TestAutomationCallbackService securedCallback)

Given a bunch of tests, must tell the remote server to execute them. These particular executions of those tests are grouped and must be identifiable by a reference.

That method must return immediately after initiating the test start sequence, it must not wait for their completion. However it may possibly start a background task to oversee the remote executions from here.

Parameters:

tests - the tests that must be executed

externalId - a reference that index the resulting executions of those tests

Throws:

ServerConnectionFailed - if could not connect to the server

AccessDenied - if the server was reached but the used user could log in

UnreadableResponseException - if the server replied something that is not suitable for a response or otherwise thrown garbages at you

NotFoundException - if the tests in that project cannot be found

TestAutomationException - for anything that doesn't fit the exceptions above.

findTestAutomationProjectURL

URL findTestAutomationProjectURL(org.squashtest.tm.domain.testautomation.TestAutomationProject testAutomationProject)

Will build and return the URL to access to the given test automation project's.

Parameters:

testAutomationProject - : the TestAutomationProject we want the URL of

Returns:

: the URL for the given TestAutomationProject

Throws:

SE

testListIsOrderGuaranteed

boolean testListIsOrderGuaranteed(Collection<org.squashtest.tm.domain.testautomation.AutomatedTest> tests)

Will say, depending on the tests ecosystems if the execution order of the given test list is guaranteed.

Parameters:

tests -

Returns:

true if the test list execution order is guaranteed.