В данном докладе мы на реальном примере рассмотрим, как можно организовать автоматизацию тестирования вебсервисов с помощью до боли знакомого всем паттерна Page Object. Казалось бы, причем тут он?..

1. Adjusting Page-Object approach
for Web Services Test Automation
by Sergey Poritskiy

2. Presenter
Sergey Poritskiy
Test automation engineer
in EPAM from 2015
projects: Parallels, Datalex
sergey_poritskiy@epam.com
skype: sergey.poritskiy

3. What should you know before (or should have heard about)
- Test automation
- Basic TA framework layers
- Page object pattern/approach
- Web services (SOAP/REST)
- XML
- XPath
- BDD approach and Gherkin language (Cucumber, JBehave)

4. The goals
After this presentation you will have one more (of first one) practical example
of implementing test automation framework for testing web services, that:
- is easy to implement
- is easy to understand by newcomers
- was implemented on practice and have shown good results

5. Starting conditions
- No test automation on a stream (sub-project)
- Need to test SOAP services, air travel domain
- A LOT of business objects and entities
- Customer wants Cucumber
- Junior newcomers are planned

6. The questions will TA Engineers have
- How to automate SOAP services testing?
- Let’s google it! Em… SoapUI?.. Is it something else?
- How to operate requests/responses?
- Object model?
- Write all the objects?
- Generate them?

7. What sounds more familiar for all of us
!!!

8. ’Classic’ test framework structure in UI test automation
Test scripts
Services/steps
Page-objects
WebDriver
Utils
Loggers
Stuff

9. ’Classic’ page-object example
public class LoginPage extends Page {
private static final By INPUT_LOGIN_LOCATOR = By.xpath("//input[@name='login']");
private static final By INPUT_PASSWORD_LOCATOR = By.xpath("//input[@name='passwd']");
private static final By BUTTON_SUBMIT_LOCATOR = By.xpath("//span/button[@type='submit']");
public void open() {
driver.get(URL);
}
public void typeUserName(String userName) {
driver.findElement(INPUT_LOGIN_LOCATOR).sendKeys(userName);
}
public void typePassword(String password) {
driver.findElement(INPUT_PASSWORD_LOCATOR).sendKeys(password);
}
public void clickSubmit() {
driver.findElement(BUTTON_SUBMIT_LOCATOR).click();
}
}

10. Our test framework layers
Test scripts
Step definitions
Rx-objects
Xml Modifier
Utils
Loggers
Stuff

11. What is 'RxObject'?
Request / Response
->
Rq / Rs
->
Rx!

12. Layer 1
Test scripts
Step definitions
Rx-objects
Xml Modifier

13. Scenarios (Cucumber) – make your own DSL
Scenario Outline: Scenario 1 - AirAvailabilityRQ request can be successfully processed
Given User sends FlightSearchRQ request with following parameters
| Origin | Destination | Date | AdtQty | ChildQty | InfQty | ClientId |
| <Origin> | <Destination> | 15 | <AdtQty> | <ChildQty> | <InfQty> | <ClientId> |
And User gets successful FlightSearchRS response
And Flight results in FlightSearchRS are not empty
When User sends BookingRQ request with OfferId from FlightSearchRS response
Then User gets successful BookingRS response
@smoke
Examples:
| Origin | Destination | AdtQty | ChildQty | InfQty | ClientId |
| NYC | FRA | 1 | 0 | 0 | LH_A-NYC |
@regression
Examples:
| Origin | Destination | AdtQty | ChildQty | InfQty | ClientId |
| NYC | FRA | 1 | 2 | 0 | LH_A-NYC |
| FRA | AMS | 1 | 1 | 1 | LH_A-FRA |
| DXB | NYC | 2 | 1 | 1 | LH_A-DXB |

14. Layer 2
Test scripts
Step definitions
Rx-objects
Xml Modifier

15. Step definitions
public class CommonTestSteps {
@Given("^User sends(sw+|)(sw+RQ) request$")
public void userSendsRequest(String rqNumber, String requestType){
Request request = RequestFactory.createRequest(requestType);
store.putRequest(request.getType(), request);
Response response = request.send();
store.putResponse(response.getType(), response, rqNumber);
}
@And("^User gets successful(sw+|) (w+RS)?(?: response|)$")
public void userGetsSuccessResponse(String rsNumber, String responseType) {
Response response = store.getResponse(responseType, rsNumber);
Assert.assertTrue(response.isSuccessful(), response.getType() + "was not successful!");
}
@And("^(w+) results in(sw+)? (w+RS)(?: response|) are not empty$")
public void resultsNotEmpty(String resultsType, String rsNumber, String responseType) {
Response response = store.getResponse(responseType, rsNumber);
Assert.assertTrue(response.isResultPresent(resultsType), resultsType + " results are empty!");
}

16. Layer 3
Test scripts
Step definitions
Rx-objects
Xml Modifier

17. Rx objects hierarchy
RxObject
(has type and body)
Request
(modifies its body)
FlightSearchRequest
Response
(read-only)
FlightSearchResponse… … … … …

18. RxObject
public class RxObject {
private String type;
private Document body;
public RxObject(String type, Document body) {
this.type = type;
this.body = body;
}
public String getType() {
return type;
}
public Document getBody() {
return body;
}
public String getNodeValue(String nodeLocator){
return XmlHelper.getNodeText(body, nodeLocator);
}
public boolean isNodePresent(String nodeLocator){
return XmlHelper.isNodePresent(body, nodeLocator);
}
public int getNodesCount(String nodeLocator) {
return XmlHelper.getCountNodesInDocument(body, nodeLocator);
}
...
}

19. Request Object
public abstract class Request extends RxObject {
public Request(String requestType) {
super(requestType, XmlHelper.createDocFromFile(NameHelper.getSampleFilePath(requestType)));
}
public abstract void setRequestParameterValue(String nameOfParam, String valueOfParam);
public abstract Response send() throws RequestSendException;
public void changeNodeValue(String locator, String value) {
XmlHelper.changeNodeInDocument(getBody(), locator, value);
}
public void duplicateNode(String locator) {
XmlHelper.duplicateNodeInDocument(getBody(), locator);
}
public void deleteNode(String locator) {
XmlHelper.removeNodeFromDocument(getBody(), locator);
}
...
}

20. Request Object - example
public class FunctionalCacheRequest extends Request {
private static final String KEY_LOCATOR = "//Key/text()";
private static final String PRICE_LOCATOR = "//PriceOption/@RateTotalAmount";
public void increaseOfferPrice(int priceToAdd) {
double newPrice = priceToAdd + getPrice();
setPrice(String.valueOf(newPrice));
}
public void setPrice(String value) {
changeNodeValue(PRICE_LOCATOR, value);
}
public void setKey(String key) {
changeNodeValue(KEY_LOCATOR, key);
}
public double getPrice() {
return Double.parseDoube(XmlHelper.getNodeText(getBody(), PRICE_LOCATOR));
}
@Override
public FunctionalCacheResponse send() {
return new FunctionalCacheResponse(SoapSender.sendRequest(this));
}

21. Request body - dummy (sample)

22. Response Object
public abstract class Response extends RxObject {
public Response(String type, Document body) {
super(type, body);
}
public abstract boolean isSuccessfull();
public abstract boolean isResultPresent(String resultsType);
public abstract String getOfferId();
...
}

23. Response Object - example
public class FunctionalCacheResponse extends Response implements HavingOfferPrice {
private static final String MESSAGE_LOCATOR = "//Message/text()";
private static final String ERROR_LOCATOR = "//Error/text()";
private static final String PRICE_LOCATOR = "//PriceOption/@RateTotalAmount";
private static final String OFFER_ID_LOCATOR = "//OfferId";
public String getMessageText() {
return getNodeValue(MESSAGE_LOCATOR);
}
public String getErrorText() {
return getNodeValue(ERROR_LOCATOR);
}
public double getOfferPrice() {
return Double.parseDouble(getNodeValue(PRICE_LOCATOR));
}
public String getOfferId() {
return getNodeValue(OFFER_ID_LOCATOR);
}
}

24. Layer 4
Test scripts
Step definitions
Rx-objects
Xml Modifier

25. XmlHelper
public class XmlHelper {
private static final String NODE_NAME_REGEX =
"(?<!['"][w/-]{1,255})(?<=[(/[:]|(and|or)s)[a-z_]+b(?![(':-])";
private static final String FORMATTING_PATTERN = "*[local-name()='%s']";
private static String makeXpathLocatorNameSpaceIgnoring(String xpathLocator) {…}
private static NodeList getNodeListByXpath(Document doc, String locator) {…}
private static Node getNodeByXpath(Document doc, String locator) {…}
public static boolean isNodePresent(Document doc, String locator) {…}
public static String getNodeText(Document doc, String locator) {…}
public static void changeNodeInDocument(Document doc, String locator, String value) {…}
public static int countNodesInDocument(Document doc, String locator) {…}
public static void removeNodeFromDocument(Document doc, String locator) {…}
public static void duplicateNodeInDocument(Document doc, String locator) {…}
...
...
...

26. Benefits of this approach
- very simple to understand, read and write tests (pure KISS principle)
- has lower entrance level
- friendly for automation engineers without experience in web services testing
- can be good option when you have a lot of business objects and entities
- was successfully implemented on real project and shows good results

27. Can we use RxObject for testing REST services?
In theory – yes.
public class RxObject {
private String type;
private Something body;
private String format;
private String responseFormat;
private String httpMethod;
...
...
...
}
But this will be more complicated.
Also you can take Rest Assured or other rest-automating framework.

28. Questions, contacts
Questions?
sergey_poritskiy@epam.com
skype: sergey.poritskiy

29. MY CONTACTS
Sergey_Poritskiy@epam.com
sergey.poritskiy

30. Thanks!

31. Thanks!

32. Thanks!

33. Secret page