Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Async testing Koa with Jest

Sponsored · SiteGround - Reliable hosting with speed, security, and support you can count on. →
Robin Pokorny
October 17, 2017

Async testing Koa with Jest

Robin Pokorny

October 17, 2017

Transcript

53 slides
  1. KOA JEST with Async testing Node.js Meetup Berlin 17 October

    2017 @robinpokorny bit.ly/jest-koa Slides accompany a talk. Here, the talk is missing. I wrote a transcript which can substitute the talk. Find it on this link: INFO
  2. WHAT IS KOA next generation web framework Express' spiritual successor

    using ES2017 async/await (no callback hell, yay!) http:/ /koajs.com/
  3. WHAT IS JEST delightful, zero configuration testing platform Jasmine’s and

    Expect’s (spiritual) successor first-class mocking, snapshots, async testing http:/ /facebook.github.io/jest/
  4. const greetings = async (ctx, next) => { ctx.body =

    'Hello.' await next() ctx.body += ' Remember to subscribe.' } const app = new Koa() app.use(greetings) app.listen(3000)
  5. const greetings = async (ctx, next) => { ctx.body =

    'Hello.' await next() ctx.body += ' Remember to subscribe.' } const app = new Koa() app.use(greetings) app.listen(3000)
  6. const greetings = async (ctx, next) => { ctx.body =

    'Hello.' await next() ctx.body += ' Remember to subscribe.' } const app = new Koa() app.use(greetings) app.listen(3000)
  7. const greetings = async (ctx, next) => { ctx.body =

    'Hello.' await next() ctx.body += ' Remember to subscribe.' } const app = new Koa() app.use(greetings) app.listen(3000)
  8. const greetings = async (ctx, next) => { ctx.body =

    'Hello.' await next() ctx.body += ' Remember to subscribe.' } const app = new Koa() app.use(greetings) app.listen(3000)
  9. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  10. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  11. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  12. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  13. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  14. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  15. SIMPLE
 TEST const greetings = async (ctx, next) => {

    ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works', async () => { const ctx = {} await greetings(ctx, () => {}) expect(ctx.body).toBe( 'Hello. Remember to subscribe.' ) })
  16. BEFORE- AND- AFTER TEST const greetings = async (ctx, next)

    => { ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works in order', async () => { const ctx = {}
 const next = jest.fn(() => { expect(ctx.body).toBe('Hello.') ctx.body += ' I am content.' }) await greetings(ctx, next) expect(next).toHaveBeenCalledTimes(1) expect(ctx.body).toBe( 'Hello. I am content. Remember to subscribe.' ) })
  17. BEFORE- AND- AFTER TEST const greetings = async (ctx, next)

    => { ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works in order', async () => { const ctx = {}
 const next = jest.fn(() => { expect(ctx.body).toBe('Hello.') ctx.body += ' I am content.' }) await greetings(ctx, next) expect(next).toHaveBeenCalledTimes(1) expect(ctx.body).toBe( 'Hello. I am content. Remember to subscribe.' ) }) ← before
  18. BEFORE- AND- AFTER TEST const greetings = async (ctx, next)

    => { ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works in order', async () => { const ctx = {}
 const next = jest.fn(() => { expect(ctx.body).toBe('Hello.') ctx.body += ' I am content.' }) await greetings(ctx, next) expect(next).toHaveBeenCalledTimes(1) expect(ctx.body).toBe( 'Hello. I am content. Remember to subscribe.' ) }) ← before ← after
  19. BEFORE- AND- AFTER TEST const greetings = async (ctx, next)

    => { ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works in order', async () => { const ctx = {}
 const next = jest.fn(() => { expect(ctx.body).toBe('Hello.') ctx.body += ' I am content.' }) await greetings(ctx, next) expect(next).toHaveBeenCalledTimes(1) expect(ctx.body).toBe( 'Hello. I am content. Remember to subscribe.' ) }) ← before ← after
  20. BEFORE- AND- AFTER TEST const greetings = async (ctx, next)

    => { ctx.body = 'Hello.' await next() ctx.body += ' Remember to subscribe.' } test('greetings works in order', async () => { const ctx = {}
 const next = jest.fn(() => { expect(ctx.body).toBe('Hello.') ctx.body += ' I am content.' }) await greetings(ctx, next) expect(next).toHaveBeenCalledTimes(1) expect(ctx.body).toBe( 'Hello. I am content. Remember to subscribe.' ) }) ← before ← after
  21. COMPLETE TEST test('greetings works complete', async () => { const

    ctx = { response: { set: jest.fn() } /* ADD OTHER MOCKS */ } const next = jest.fn(() => { expect(ctx).toMatchSnapshot() }) await expect(greetings(ctx, next)) .resolves.toBeUndefined() expect(next).toHaveBeenCalledTimes(1) expect(ctx).toMatchSnapshot() expect(ctx.response.set.mock.calls).toMatchSnapshot() })
  22. COMPLETE TEST test('greetings works complete', async () => { const

    ctx = { response: { set: jest.fn() } /* ADD OTHER MOCKS */ } const next = jest.fn(() => { expect(ctx).toMatchSnapshot() }) await expect(greetings(ctx, next)) .resolves.toBeUndefined() expect(next).toHaveBeenCalledTimes(1) expect(ctx).toMatchSnapshot() expect(ctx.response.set.mock.calls).toMatchSnapshot() })
  23. SNAPSHOT // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`greetings works complete 1`]

    = ` Object { "body": “Hello.", "response": Object { "set": [Function], }, } `; exports[`greetings works complete 2`] = ` … `;
  24. COMPLETE TEST test('greetings works complete', async () => { const

    ctx = { response: { set: jest.fn() } /* ADD OTHER MOCKS */ } const next = jest.fn(() => { expect(ctx).toMatchSnapshot() }) await expect(greetings(ctx, next)) .resolves.toBeUndefined() expect(next).toHaveBeenCalledTimes(1) expect(ctx).toMatchSnapshot() expect(ctx.response.set.mock.calls).toMatchSnapshot() })
  25. COMPLETE TEST test('greetings works complete', async () => { const

    ctx = { response: { set: jest.fn() } /* ADD OTHER MOCKS */ } const next = jest.fn(() => { expect(ctx).toMatchSnapshot() }) await expect(greetings(ctx, next)) .resolves.toBeUndefined() expect(next).toHaveBeenCalledTimes(1) expect(ctx).toMatchSnapshot() expect(ctx.response.set.mock.calls).toMatchSnapshot() })
  26. MORE THAN SUM App ≠ compose(app.middleware) Koa wraps the native

    response and request API testing, HTTP assertions
  27. A CLEAR AND CONCISE INTRODUCTION TO TESTING KOA
 WITH JEST

    AND SUPERTEST https:/ /www.valentinog.com/blog/testing-api-koa-jest/ Valentino Gagliardi
  28. SAMPLE APP // server/index.js const app = new Koa() const

    router = new Router() router.get('/', async ctx => { ctx.body = { data: 'Sending some JSON', person: { name: ‘Ferdinand', lastname: 'Vaněk', role: 'Brewery worker’, age: 42 } } }) app.use(router.routes()) module.exports = app
  29. app.listen(3000) app.callback() Supertest will open and close the server for

    us. creates server need to close after each test ✖
  30. TEST BOILERPLATE // test/root.spec.js const request = require('supertest') const app

    = require(‘ ../server') test('root route', async () => { const response = await request(app.callback()).get(‘/'); expect(response).toBeDefined() // @TODO })
  31. TEST BOILERPLATE // test/root.spec.js const request = require('supertest') const app

    = require(‘ ../server') test('root route', async () => { const response = await request(app.callback()).get(‘/'); expect(response).toBeDefined() // @TODO })
  32. TEST BOILERPLATE // test/root.spec.js const request = require('supertest') const app

    = require(‘ ../server') test('root route', async () => { const response = await request(app.callback()).get(‘/'); expect(response).toBeDefined() // @TODO })
  33. OBJECT EQUALITY expect(response.body).toEqual( expect.objectContaining({ person: { name: expect.anything(), lastname: expect.any(String),

    role: expect.stringMatching(/^Brewery/), age: expect.any(Number) } }) ) expect.objectContaining({ x: 1 }) ✖ { x: 1 }
  34. SNAPSHOTS expect(response.body).toMatchSnapshot() // test/ __snapshots __/root.spec.js.snap exports[`root route with object

    equality 1`] = ` Object { "data": "Sending some JSON", "person": Object { "age": 42, "lastname": "Vaněk", "name": "Ferdinand", "role": "Brewery worker", }, } `;
  35. NOT ONLY KOA applies to other frameworks API testing -

    no change convenient for refactoring
  36. RELATED • A clear and concise introduction to testing Koa

    with Jest and Supertest • An Introduction to Building TDD RESTful APIs with Koa 2, Mocha and Chai • both by Valentino Gagliardi • API testing with Jest by Koen van Gilst • Testing async/await middleware? (GitHub Issue) • Async testing in Jest (recording of presentation) • Snapshot Testing APIs with Jest by Dave Ceddia • Snapshot testing in Jest (recording of presentation)

More Decks by Robin Pokorny

Other Decks in Technology