Testing RESTful Webservices using the REST-assured framework
16 likes•45,949 views
The document provides a comprehensive guide on testing RESTful web services using the Rest-Assured framework. It covers prerequisites, setup, making GET requests, verifying JSON and XML responses, handling authentication, and more advanced features like file uploads and custom parsers. Additionally, the document includes various test examples and links to further resources for readers to explore.
Testing RESTful Webservices using the REST-assured framework
- 1. Testing RESTful Webservices using the REST-assured Framework
- 2. Table of Contents Prerequisites
- 4. Verify JSON via GET
- 5. JsonPath
- 6. Groovy Closures – The JSON
- 7. Groovy Closures – The Test
- 8. Verifying XML, Xpath, Schema
- 10. Status Codes, Headers Handling Basic Authentication
- 13. Setting Cookies
- 15. File Uploads
- 18. Tutorial Sources
- 19. Prerequisites We’re going to need a JDK and Maven .. nothing more …
- 20. Java Development Kit >= 6
- 21. Maven 3
- 22. The full tutorial and the RESTful Webservice to test can be found at my blog www.hascode.com
- 23. REST-assured and Maven Only one dependency needed:
- 24. <dependency>
- 29. </dependency>
- 30. Verify JSON via GET { "email":"[email protected]", "firstName":"Tim", "id":"1", "lastName":"Testerman" } @Test public void testGetSingleUser() { expect(). statusCode(200). body( "email", equalTo("[email protected]"), "firstName", equalTo("Tim"), "lastName", equalTo("Testerman"), "id", equalTo("1")). when(). get("/service/single-user"); }
- 31. JsonPath { "email":"[email protected]", "firstName":"Tim", "id":"1", "lastName":"Testerman" } @Test public void testGetSingleUserProgrammatic() { Response res = get("/service/single-user"); assertEquals(200, res.getStatusCode()); String json = res.asString(); JsonPath jp = new JsonPath(json); assertEquals("[email protected]", jp.get("email")); assertEquals("Tim", jp.get("firstName")); assertEquals("Testerman", jp.get("lastName")); assertEquals("1", jp.get("id")); }
- 32. Groovy Closures – The JSON { "person":[ { "@id":"1", "email":"[email protected]", "firstName":"Tim", "lastName":"Testerman" },{ "@id":"20", "email":"[email protected]", "firstName":"Sara", "lastName":"Stevens" },{ "@id":"11", "email":"[email protected]", "firstName":"Mark", "lastName":"Mustache" } ] }
- 33. Groovy Closures – The Test @Test public void testFindUsingGroovyClosure() { String json = get("/service/persons/json").asString(); JsonPath jp = new JsonPath(json); jp.setRoot("person"); Map person = jp.get("find {e -> e.email =~ /test@/}"); assertEquals("[email protected]", person.get("email")); assertEquals("Tim", person.get("firstName")); assertEquals("Testerman", person.get("lastName")); }
- 34. Verifying XML – The XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user> <email>[email protected]</email> <firstName>Tim</firstName> <id>1</id> <lastName>Testerman</lastName> </user>
- 35. Verifying XML – The Test @Test public void testGetSingleUserAsXml() { expect(). statusCode(200). body( "user.email", equalTo("[email protected]"), "user.firstName", equalTo("Tim"), "user.lastName", equalTo("Testerman"), "user.id", equalTo("1")). when(). get("/service/single-user/xml"); }
- 36. Verifying using Xpath – The XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <people> <person id="1"> <email>[email protected]</email> <firstName>Tim</firstName> <lastName>Testerman</lastName> </person> <person id="20"> <email>[email protected]</email> <firstName>Sara</firstName> <lastName>Stevens</lastName> </person> <person id="11"> <email>[email protected]</email> <firstName>Mark</firstName> <lastName>Mustache</lastName> </person> </people>
- 37. Verifying using XPath – the Test @Test public void testGetPersons() { expect(). statusCode(200). body( hasXPath("//person[@id='1']/email[.='[email protected]'] and firstName='Tim' and lastName='Testerman'"), hasXPath("//person[@id='20']/email[.='[email protected]'] and firstName='Sara' and lastName='Stevens'"), hasXPath("//person[@id='1']/email[.='[email protected]'] and firstName='Mark' and lastName='Mustache'")). when(). get("/service/persons/xml"); }
- 38. Verify using Schema – The XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user> <email>[email protected]</email> <firstName>Tim</firstName> <id>1</id> <lastName>Testerman</lastName> </user>
- 39. Verifying using Schema – The XSD <?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema"> <element name="user"> <complexType> <sequence> <element name="email"> <simpleType> <restriction base="string"> <pattern value=".+@.+"></pattern> </restriction> </simpleType> </element> <element name="firstName" type="string"></element> <element name="id" type="int"></element> <element name="lastName" type="string"></element> </sequence> </complexType> </element> </schema>
- 40. Verifying using Schema – The Test @Test public void testGetSingleUserAgainstSchema() { InputStream xsd = getClass().getResourceAsStream("/user.xsd"); assertNotNull(xsd); expect(). statusCode(200). body( matchesXsd(xsd)). when(). get("/service/single-user/xml"); }
- 41. Handling Request Parameters @Test public void testCreateuser() { final String email = "[email protected]"; final String firstName = "Tim"; final String lastName = "Tester"; given(). parameters( "email", email, "firstName", firstName, "lastName", lastName). expect(). body("email", equalTo(email)). body("firstName", equalTo(firstName)). body("lastName", equalTo(lastName)). when(). get("/service/user/create"); }
- 42. Verifying HTTP Status Codes @Test public void testStatusNotFound() { expect(). statusCode(404). when(). get("/service/status/notfound"); }
- 43. Handling Basic Authentication @Test public void testAuthenticationWorking() { // we're not authenticated, service returns "401 Unauthorized" expect(). statusCode(401). when(). get("/service/secure/person"); // with authentication it is working expect(). statusCode(200). when(). with(). authentication().basic("admin", "admin"). get("/service/secure/person"); }
- 44. Setting HTTP Headers @Test public void testSetRequestHeaders() { expect(). body(equalTo("TEST")). when(). with(). header("myparam", "TEST"). get("/service/header/print"); expect(). body(equalTo("foo")). when(). with(). header("myparam", "foo"). get("/service/header/print"); }
- 45. Verifying HTTP Header @Test public void testReturnedHeaders() { expect(). headers("customHeader1", "foo", "anotherHeader", "bar"). when(). get("/service/header/multiple"); }
- 46. Setting Cookies @Test public void testAccessSecuredByCookie() { expect(). statusCode(403). when(). get("/service/access/cookie-token-secured"); given(). cookie("authtoken", "abcdef"). expect(). statusCode(200). when(). get("/service/access/cookie-token-secured"); }
- 47. Verifying Cookies @Test public void testModifyCookie() { expect(). cookie("userName", equalTo("Ted")). when(). with().param("name", "Ted"). get("/service/cookie/modify"); expect(). cookie("userName", equalTo("Bill")). when(). with().param("name", "Bill"). get("/service/cookie/modify"); }
- 48. File Uploads @Test public void testFileUpload() { final File file = new File(getClass().getClassLoader() .getResource("test.txt").getFile()); assertNotNull(file); assertTrue(file.canRead()); given(). multiPart(file). expect(). body(equalTo("This is an uploaded test file.")). when(). post("/service/file/upload"); }
- 49. Registering Custom Parsers @Test public void testRegisterParserForUnknownContentType() { RestAssured.registerParser("text/json", Parser.JSON); expect(). body("test", equalTo(true)). when(). get("/service/detail/json"); }
- 50. Specification Reuse @Test public void testSpecReuse() { ResponseSpecBuilder builder = new ResponseSpecBuilder(); builder.expectStatusCode(200); builder.expectBody("email", equalTo("[email protected]")); builder.expectBody("firstName", equalTo("Tim")); builder.expectBody("lastName", equalTo("Testerman")); builder.expectBody("id", equalTo("1")); ResponseSpecification responseSpec = builder.build(); // now we're able to use this specification for this test expect(). spec(responseSpec). when(). get("/service/single-user"); // now re-use for another test that returns similar data .. you may // extend the specification with further tests as you wish final String email = "[email protected]"; final String firstName = "Tim"; final String lastName = "Testerman"; expect(). spec(responseSpec). when(). with(). parameters( "email", email, "firstName", firstName, "lastName",lastName). get("/service/user/create"); }
- 51. Tutorial Sources On Bitbucket: http://bitbucket.org/hascode
- 52. Clone with Mercurial: hg clone https://bitbucket.org/hascode/rest-assured-sample
- 53. The End Thank you for your audience :)
- 54. Please feel free to read further tutorials of mine on www.hascode.com
- 55. I'm also on Twitter: http://twitter.com/hascode