API data stubbing done right

Talk for BrewBox Cremona about the idea behind a better way to stub data and write tests.

Transcript

1. API DATA STUBBING DONE RIGHT Paolo Ferretti Photo by Chris White
2. WHO AM I ➤ Paolo Ferretti ➤ Senior software developer @ R&D team in MailUP ➤ @paoferretti ➤ https://github.com/pferretti
4. WHAT IS AN API DATA STUB?
5. “ Replica or imitation of a real API -Paolo Ferretti
6. Photo by Mike Boening
7. HOW DOES IT WORK TODAY?
8. import responses import requests @responses.activate def test_simple(): responses.add(responses.GET, 'http://twitter.com/api/1/foobar', json={'error': 'not found'}, status=404) resp = requests.get('http://twitter.com/api/1/foobar') assert resp.json() == {"error": "not found"}
9. MY SOFTWARE ARCHITECTURE IS DIFFERENT
10. SEPARATION OF CONCERNS
11. Web Components Microservices Docker containers
12. HOW CAN WE MAKE IT BETTER?
13. Data {} Code
14. FAKE DATA
16. MOCKER ➤ HTTP server ➤ Command line tool ➤ Multiplatform ➤ Useful proxy mode ➤ Built for containers ➤ Fast! Photo by Jim Bahn Available at https://github.com/theghostwhocodes/mocker-go https://hub.docker.com/r/theghostwhocodes/mocker/
17. HOW DOES MOCKER WORK? HTTP GET http://localhost:2626/api/1/foobar /home/paolo/myproject/tests/data/api/1/foobar.GET.json
18. A FIRST EXAMPLE - SIMPLE.GET.JSON { "request": { "method": "GET" }, "response": { "headers": { "Content-Type": ["application/json"] }, "body": { "message": “Hello BrewBox!” }, "status": 200 } }
19. A SECOND EXAMPLE - SIMPLE.POST.JSON { "request": { "method": "POST", "payload": { "param1": ["value1"], "param2": ["value2"] } }, "response": { "headers": { "Content-Type": ["application/json"] }, "body": { "key": "simple.POST.twoparams.json" } } }
20. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json HTTP GET http://localhost:2626/api/1/simple
21. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path HTTP GET http://localhost:2626/api/1/simple
22. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path API path HTTP GET http://localhost:2626/api/1/simple
23. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path API path Resource HTTP GET http://localhost:2626/api/1/simple
24. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path API path Resource HTTP verb HTTP GET http://localhost:2626/api/1/simple
25. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path API path Resource HTTP verb Optional part HTTP GET http://localhost:2626/api/1/simple
26. FILE NAMING CONVENTION /home/paolo/myproject/test/data/api/1/simple.GET.optional.json Data path API path Resource HTTP verb Optional part Extension HTTP GET http://localhost:2626/api/1/simple
27. PROXY MODE HTTP GET http://localhost:2626/api/1/foobar http://twitter.com/api/1/foobar mocker
28. STEP BACK
29. WHY IS IT IMPORTANT TO STUB DATA? ➤ Separation of concerns / decoupling ➤ Software development (thanks to proxy mode) ➤ Consistent data for tests ➤ Safe environments for demo ➤ Stubs are simple text files ➤ Test data more accessible for non technical people
30. THANK YOU That’s all folks! Photo by Ben Smith