Integrate with confidence

Transcription

1 Integrate with confidence Testing and verifying API integrations Andrew

2 Andrew

3 Pact?

4

5 Fat clients

6

7 The return of Fat

8

9 Connected = dependent

10 Dependencies on a service Web service HTTP Single page web app ios App Android app

11 Dependencies on a service 6 months later Web service Android app v2 Single page web app ios App v1 Android app v1 ios App v2 ios App v3

12 I want to change the API!

13 A shared language POST /the-goods

14 A shared language How do we even know we still speak the same language? POST /the-goods 404 didn t you get the memo?

15 How can we test this dependency?

16 A shared language How do we even know we still speak the same language? Manual testing? Integration tests? Unit tests?

17 Integration tests? How do we even know we still speak the same language?

18 Integration tests? How do we even know we still speak the same language? Complicated setup

19 Integration tests? How do we even know we still speak the same language? Complicated setup Slow

20 Integration tests? How do we even know we still speak the same language? Complicated setup Slow Fragile

21 Integration tests? How do we even know we still speak the same language? Complicated setup Slow Fragile Hard to diagnose errors

22 Integration tests? How do we even know we still speak the same language? Complicated setup Slow Fragile Hard to diagnose errors Need to run for each supported client version

23 Unit tests? How do we even know we still speak the same language? Test one small part of code e.g. A single method

24 Unit tests? How do we even know we still speak the same language? Test one small part of code e.g. A single method let cat = Cat(name: "Bob") expect(cat.tojson()).to(equal("{\"name\":\"bob\""))

25 Unit tests? How do we even know we still speak the same language? Simple setup

26 Unit tests? How do we even know we still speak the same language? Simple setup Fast feedback

27 Unit tests? How do we even know we still speak the same language? Simple setup Fast feedback Stable

28 Unit tests? How do we even know we still speak the same language? Simple setup Fast feedback Stable Easier to diagnose errors

29 Unit tests? How do we even know we still speak the same language? A B mock mock

30 Pact!

31 Pact How it works CA BP PactMockServer pact

32 Pact tests Unit test Fast feedback Stable Easier to diagnose errors

33 Pact tests Given some state exists When I Receive a GET request With these headers / query param Responds with 200 OK And some data

34 Pact tests Given User A exists When I Receive A GET request for A Responds with 200 OK And User A s details

35 Pact tests Given User A does not exist When I Receive A GET request for A Responds with 404 Not Found

36 A simple example - ios

37 An example - CatKit HTTP GET CatKit service

38 An example - CatKit HTTP Response { message : Meow!, status : happy

39 CatKitClient public class CatKitClient { private let baseurl: String public init(baseurl : String) { self.baseurl = baseurl public func feedme(feedmeresponse: (String) -> Void) { Alamofire.request(.GET, \(baseurl)/feed-me").responsejson { (result) in if let json = result as? Dictionary<String, String> { feedmeresponse(json["message"]!, json["status"]!)

40 CatKitClient public class CatKitClient { private let baseurl: String public init(baseurl : String) { self.baseurl = baseurl public func feedme(feedmeresponse: (String) -> Void) { Alamofire.request(.GET, \(baseurl)/feed-me").responsejson { (result) in if let json = result as? Dictionary<String, String> { feedmeresponse(json["message"]!, json["status"]!)

41 CatKitClient public class CatKitClient { private let baseurl: String public init(baseurl : String) { self.baseurl = baseurl public func feedme(feedmeresponse: (String, String) -> Void) { Alamofire.request(.GET, \(baseurl)/feed-me").responsejson { (result) in if let json = result as? Dictionary<String, String> { feedmeresponse(json["message"]!, json["status"]!)

42 CatKitClient public class CatKitClient { private let baseurl: String public init(baseurl : String) { self.baseurl = baseurl public func feedme(feedmeresponse: (String, String) -> Void) { Alamofire.request(.GET, \(baseurl)/feed-me").responsejson { (result) in if let json = result as? Dictionary<String, String> { feedmeresponse(json["message"]!, json["status"]!)

43 CatKitClient public class CatKitClient { private let baseurl: String public init(baseurl : String) { self.baseurl = baseurl public func feedme(feedmeresponse: (String, String) -> Void) { Alamofire.request(.GET, \(baseurl)/feed-me ).responsejson { (result) in if let json = result as? Dictionary<String, String> { feedmeresponse(json["message"]!, json["status"]!)

44 Writing the test

45 UnitTest The setup - request expectations catkitmockservice = MockService(provider: "CatKit Service", consumer: "CatKit ios App") catkitmockservice.uponreceiving("a request for feeding").withrequest( method:.get, path: /feed-me", headers: ["Accept": "application/json"]).willrespondwith( status: 200, headers: ["Content-Type": "application/json"], body: ["message": "Meow!", "status": "happy"])

46 UnitTest The setup - request expectations catkitmockservice = MockService(provider: "CatKit Service", consumer: "CatKit ios App") catkitmockservice.uponreceiving("a request for feeding").withrequest( method:.get, path: /feed-me", headers: ["Accept": "application/json"]).willrespondwith( status: 200, headers: ["Content-Type": "application/json"], body: ["message": "Meow!", "status": "happy"])

47 UnitTest The setup - request expectations catkitmockservice = MockService(provider: "CatKit Service", consumer: "CatKit ios App") catkitmockservice.uponreceiving("a request for feeding").withrequest( method:.get, path: /feed-me", headers: ["Accept": "application/json"]).willrespondwith( status: 200, headers: ["Content-Type": "application/json"], body: ["message": "Meow!", "status": "happy"])

48 UnitTest Execute client code catkitclient = CatKitClient(baseUrl: catkitmockservice!.baseurl) catkitmockservice.run { (testcomplete) -> Void in catkitclient.feedme { (message, status) -> Void in expect(status).to(equal("happy")) expect(message).to(equal("meow!")) testcomplete()

49 UnitTest Execute client code catkitclient = CatKitClient(baseUrl: catkitmockservice!.baseurl) catkitmockservice.run { (testcomplete) -> Void in catkitclient.feedme { (message, status) -> Void in expect(status).to(equal("happy")) expect(message).to(equal("meow!")) testcomplete()

50 UnitTest Execute client code catkitclient = CatKitClient(baseUrl: catkitmockservice!.baseurl) catkitmockservice.run { (testcomplete) -> Void in catkitclient.feedme { (message, status) -> Void in expect(status).to(equal("happy")) expect(message).to(equal("meow!")) testcomplete()

51 UnitTest Assert response is processed correctly catkitclient = CatKitClient(baseUrl: catkitmockservice!.baseurl) catkitmockservice.run { (testcomplete) -> Void in catkitclient.feedme { (message, status) -> Void in expect(status).to(equal("happy")) expect(message).to(equal("meow!")) testcomplete()

52 UnitTest Assert response is processed correctly catkitclient = CatKitClient(baseUrl: catkitmockservice!.baseurl) catkitmockservice.run { (testcomplete) -> Void in catkitclient.feedme { (message, status) -> Void in expect(status).to(equal("happy")) expect(message).to(equal("meow!")) testcomplete()

53 { "consumer": { "name": "CatKit ios App", "provider": { "name": "CatKit Service", "interactions": [ { "description": "a request for feeding", "request": { "method": "get", "path": /feed-me, "headers": { "Accept": "application/json", "response": { "status": 200, "headers": { "Content-Type": "application/json", "body": { "message": Meow!, status : happy ], "metadata": { "pactspecificationversion": "1.0.0"

54 Testing against the server

55 Service verification i.e. verify we speak the same language Pact.service_provider "CatKit Service" do end honours_pact_with 'CatKit ios App' do pact_uri './pacts/ios-app/catkit_ios_app-catkit_service-v1.0.json' end

56 Service verification i.e. verify we speak the same language Pact.service_provider "CatKit Service" do end honours_pact_with 'CatKit ios App' do pact_uri './pacts/ios-app/catkit_ios_app-catkit_service-v1.0.json' end

57 Service verification i.e. verify we speak the same language catkit-server (master) $ rake pact:verify Reading pact at./pacts/ios-app/catkit_ios_app-catkit_service-v1.0.json Verifying a pact between CatKit ios App and CatKit Service A request for feeding with GET /feed-me returns a response which has status code 200 (FAILED - 1) has a matching body (FAILED - 2) includes headers "Content-Type" with value "application/json" (FAILED - 3)

58 Service verification i.e. verify we speak the same language catkit-server (master) $ rake pact:verify Reading pact at./pacts/ios-app/catkit_ios_app-catkit_service-v1.0.json Verifying a pact between CatKit ios App and CatKit Service A request for feeding with GET /feed-me returns a response which has status code 200 has a matching body includes headers "Content-Type" with value "application/json"

59

60 Some time in the future Fail - contract broken catkit-server (master) $ rake pact:verify Reading pact at./pacts/ios-app/catkit_ios_app-catkit_service-v1.0.json Verifying a pact between CatKit ios App and CatKit Service A request for feeding with GET /feedme returns a response which has status code 200 has a matching body (FAILED - 1) includes headers "Content-Type" with value "application/json"

61 Some time in the future Fail - contract broken -{ - "message": Meow!, - status" : "happy" - +[ + { + "message": Meow!" + "status": "happy" + +]

62 API changes can quickly be verified against each client we have a pact contract file for

63 Remember this hairy situation? Web service Android app v2 Single page web app ios App v1 Android app v1 ios App v2 ios App v3

64 Using Pact, we can create

65 Using Pact, we can create a repository of API usage

66 Using Pact, we can create a repository of API usage for each client

67 Using Pact, we can create a repository of API usage for each client over time

68 Repository of API usage Web service Android app v2 android-v2.0.json Single page web app js-v1.0.json ios App v1 ios-v1.0.json Android app v1 android-v1.0.json ios App v2 ios App v3 ios-v2.0.json ios-v3.0.json

69 Pact broker

70 Pact broker

71 Pact broker

72 Pact verification Ruby JVM Javascript Go.NET

73 ? Questions

74 Pact! github.com/dius/pact-consumer-swift github.com/dius/pact-jvm github.com/andrewspinks/pact-mobile-preso Andrew Spinks