Tweet
Tweet

Slide 1

Slide 1 text

mocking for fun and profit APIs #confoo 2020 @ruyadorno

Slide 2

Slide 2 text

Ruy Adorno OSS Dev @ @ruyadorno

Slide 3

Slide 3 text

#confoo 2020 @ruyadorno ToC 1. Naming 2. Testing 3. Microservices 4. Front-End 5. Tooling

Slide 4

Slide 4 text

so, about naming… MOCKS == STUBS #confoo 2020 @ruyadorno in the context of this talk:

Slide 5

Slide 5 text

before we #confoo 2020 @ruyadorno start

Slide 6

Slide 6 text

Have you been mocking lately? #confoo 2020 @ruyadorno

Slide 7

Slide 7 text

#confoo 2020 @ruyadorno How many people back-end work in an env with front-end teams? separated

Slide 8

Slide 8 text

TESTS #confoo 2020 @ruyadorno

Slide 9

Slide 9 text

Mocks are most popular for their usage within tests #confoo 2020 @ruyadorno

Slide 10

Slide 10 text

•Abstract away complexity •System-specific APIs •Help coverage Mocks in the context of tests: #confoo 2020 @ruyadorno

Slide 11

Slide 11 text

#confoo 2020 @ruyadorno Talking about abstracting away complexity…

Slide 12

Slide 12 text

#confoo 2020 @ruyadorno

Slide 13

Slide 13 text

#confoo 2020 @ruyadorno

Slide 14

Slide 14 text

#confoo 2020 @ruyadorno

Slide 15

Slide 15 text

Mocking APIs sounds like a Great idea! #confoo 2020 @ruyadorno

Slide 16

Slide 16 text

#confoo 2020 @ruyadorno Test framework example…

Slide 17

Slide 17 text

Patch APIs #confoo 2020 @ruyadorno import { API } from './api' it(‘retrieves API data', () => { API.get = () => ({ data: ‘12345’ }) API.get(‘something’) .then(res => { expect(res.data) .toEqual(‘12345') }) })

Slide 18

Slide 18 text

npm.im/jest #confoo 2020 @ruyadorno import { API } from './api' jest.mock(‘./api’, () => { API: () => ({ data: ‘12345’ }) } it(‘retrieves API data', () => { API.get(‘something’) .then(res => { expect(res.data) .toEqual(‘12345') }) })

Slide 19

Slide 19 text

npm.im/jest-fetch-mock #confoo 2020 @ruyadorno import { API } from './api' it(‘retrieves API data', () => { fetch.mockResponseOnce( JSON.stringify({ data: ‘12345' }) ) API.get(‘something’) .then(res => { expect(res.data) .toEqual(‘12345') }) })

Slide 20

Slide 20 text

npm.im/nock #confoo 2020 @ruyadorno import { API } from './api' const nock = require('nock') it(‘retrieves API data', () => { nock('http://www.example.com') .get('/something') .reply(200, '12345') API.get(‘something’) .then(res => { expect(res.data) .toEqual(‘12345') }) })

Slide 21

Slide 21 text

moving beyond tests #confoo 2020 @ruyadorno

Slide 22

Slide 22 text

MICROSERVICES #confoo 2020 @ruyadorno

Slide 23

Slide 23 text

#confoo 2020 @ruyadorno In the microservices world, folks are more used to mocking services

Slide 24

Slide 24 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 25

Slide 25 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 26

Slide 26 text

#confoo 2020 @ruyadorno Given a typical microservices architecture… MOCK

Slide 27

Slide 27 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 28

Slide 28 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 29

Slide 29 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 30

Slide 30 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 31

Slide 31 text

#confoo 2020 @ruyadorno Given a typical microservices architecture…

Slide 32

Slide 32 text

#confoo 2020 @ruyadorno Given a typical microservices architecture… OR

Slide 33

Slide 33 text

#confoo 2020 @ruyadorno Given a typical microservices architecture… OR

Slide 34

Slide 34 text

#confoo 2020 @ruyadorno Given a typical microservices architecture… OR

Slide 35

Slide 35 text

#confoo 2020 @ruyadorno now we know how to use mocks for tests

Slide 36

Slide 36 text

#confoo 2020 @ruyadorno we’ve seen how they’re used in microservices for local development

Slide 37

Slide 37 text

FRONT-END #confoo 2020 @ruyadorno

Slide 38

Slide 38 text

#confoo 2020 @ruyadorno SUMMER 2017

Slide 39

Slide 39 text

• Great library of reusable components • Good test setup with decent coverage • Awesome colleagues #confoo 2020 @ruyadorno

Slide 40

Slide 40 text

#confoo 2020 @ruyadorno but

Slide 41

Slide 41 text

• Microservices architecture • Impossible to run all services locally #confoo 2020 @ruyadorno

Slide 42

Slide 42 text

#confoo 2020 @ruyadorno Staging environment: • Needs to be always online • Unstable, QA keeps breaking stuff • No easy way to easily change API responses

Slide 43

Slide 43 text

#confoo 2020 @ruyadorno

Slide 44

Slide 44 text

#confoo 2020 @ruyadorno

Slide 45

Slide 45 text

#confoo 2020 @ruyadorno

Slide 46

Slide 46 text

#confoo 2020 @ruyadorno

Slide 47

Slide 47 text

#confoo 2020 @ruyadorno

Slide 48

Slide 48 text

#confoo 2020 @ruyadorno let’s mock our way out

Slide 49

Slide 49 text

#confoo 2020 @ruyadorno until you make it fake

Slide 50

Slide 50 text

#confoo 2020 @ruyadorno The plan: • Mock all API responses using a static server • Bundle this mock server along with the front-end local dev environment

Slide 51

Slide 51 text

#confoo 2020 @ruyadorno Mocked server •Allows for abstracting away the complexities of back-end envs •Lowers the barrier of joining the team

Slide 52

Slide 52 text

#confoo 2020 @ruyadorno Mocked server •Allows for abstracting away the complexities of back-end envs •Lowers the barrier of joining the team

Slide 53

Slide 53 text

#confoo 2020 @ruyadorno Mocked server •Allows for abstracting away the complexities of back-end envs •Lowers the barrier of joining the team •Makes it extra easy to change or tweak APIs

Slide 54

Slide 54 text

#confoo 2020 @ruyadorno Trade-off, complexity is switched to maintaining these up-to-date mocks

Slide 55

Slide 55 text

#confoo 2020 @ruyadorno

Slide 56

Slide 56 text

#confoo 2020 @ruyadorno Where did we ended up?

Slide 57

Slide 57 text

#confoo 2020 @ruyadorno •Development was much faster and predictable •Completely decoupled from back-end deliverables Pros

Slide 58

Slide 58 text

#confoo 2020 @ruyadorno •Integration period was difficult •Maintaining the mocks updated could sometimes be very annoying Cons

Slide 59

Slide 59 text

#confoo 2020 @ruyadorno It ended up influencing the way we work: • Smaller PRs, faster deliverables • More tests written

Slide 60

Slide 60 text

#confoo 2020 @ruyadorno Hybrid system • Portable dev environment • Kept staging env around

Slide 61

Slide 61 text

TOOLING #confoo 2020 @ruyadorno

Slide 62

Slide 62 text

TOOLING #confoo 2020 @ruyadorno npm.im/create-react-app

Slide 63

Slide 63 text

TOOLING #confoo 2020 @ruyadorno npm.im/create-react-app npm.im/webpack-dev-server

Slide 64

Slide 64 text

TOOLING #confoo 2020 @ruyadorno npm.im/create-react-app npm.im/webpack-dev-server npm.im/npm-run-all

Slide 65

Slide 65 text

TOOLING #confoo 2020 @ruyadorno

Slide 66

Slide 66 text

TOOLING #confoo 2020 @ruyadorno

Slide 67

Slide 67 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 68

Slide 68 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 69

Slide 69 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 70

Slide 70 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 71

Slide 71 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 72

Slide 72 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 73

Slide 73 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 74

Slide 74 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 75

Slide 75 text

TOOLING #confoo 2020 @ruyadorno npm.im/snapstub

Slide 76

Slide 76 text

TOOLING #confoo 2020 @ruyadorno

Slide 77

Slide 77 text

#confoo 2020 @ruyadorno all the things! mock

Slide 78

Slide 78 text

Ruy Adorno Thanks! @ruyadorno ruyadorno.com

Slide 79

Slide 79 text

#confoo 2020 @ruyadorno References • https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview • https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol • http://www.websiteoptimization.com/secrets/metrics/10-21-http-request.html • https://www.geeksforgeeks.org/tcp-3-way-handshake-process/ • https://martinfowler.com/articles/practical-test-pyramid.html • https://martinfowler.com/articles/mocksArentStubs.html • https://circleci.com/blog/how-to-test-software-part-i-mocking-stubbing-and-contract-testing/ • https://medium.com/@kapil.aggarwal1/api-mocks-and-why-should-we-care-418b24c35c25 • https://stoplight.io/blog/mock-api-test/ • https://openapi.tools/#mock • https://github.com/cdimascio/express-openapi-validator • https://graphql.org/blog/mocking-with-graphql/ • https://www.npmjs.com/package/jest • https://www.npmjs.com/package/jest-fetch-mock • https://www.npmjs.com/package/nock • https://www.npmjs.com/package/open-api-mocker • https://www.npmjs.com/package/create-react-app • https://www.npmjs.com/package/webpack-dev-server • https://www.npmjs.com/package/npm-run-all • https://www.npmjs.com/package/snapstub

Slide 80

Slide 80 text

#confoo 2020 @ruyadorno Photo Credits • simple colored background: Photo by Andrej Lišakov on Unsplash • Vintage Document - Writing on Reverse: Photo by Andrew Buchanan on Unsplash • middle earth map: Photo by Liam Truong on Unsplash • Alphabet, letters, typography: Photo by Annie Spratt on Unsplash • brown wooden wall: Photo by karl on Unsplash • blank sketch book: Photo by Mike Tinnion on Unsplash • Coffee&Paper: Photo by Ivan Gromov on Unsplash • vintage letter: Photo by Mat Reding on Unsplash • Paper and Pencil with hand: Photo by Kelly Sikkema on Unsplash • Blank spiral notebook: Photo by Kelly Sikkema on Unsplash • When inspiration strikes: Photo by Tim Arterbury on Unsplash • Blank Paper and Pencil: Photo by Kelly Sikkema on Unsplash • Scattered white paper: Photo by Brandi Redd on Unsplash • simple coloured background: Photo by Andrej Lišakov on Unsplash • Typesetting in wood: Photo by Raphael Schaller on Unsplash • white block toy: Photo by Elodie Oudot on Unsplash • The Lost Art of Writing: Photo by Kelly Sikkema on Unsplash • yellow, black, green, and orange digital wallpaper: Photo by Hamed Daram on Unsplash • Minimal pencils on yellow: Photo by Joanna Kosinska on Unsplash • assorted-color paper and brown wooden pencil: Photo by Joanna Kosinska on Unsplash • Another photo from my visit to Czechowice-Dziedzice: Photo by Paweł Czerwiński on Unsplash • Feminine Paper Flat Lay: Photo by Kelly Sikkema on Unsplash • yellow painted wall: Photo by Janita Sumeiko on Unsplash • assorted-color coloring pencils: Photo by Plush Design Studio on Unsplash • pink metal board: Photo by Ryan Stone on Unsplash