Test driven APIs with Laravel
Download as PPTX, PDF0 likes349 views
This document summarizes a presentation about testing APIs built with Laravel. It discusses testing API concepts in Laravel, including testing models, database interactions, HTTP requests, responses, and validation. It provides examples of building an API for user groups, events, and venues using Laravel resources, requests, and testing methods like assertStatus and assertJson. The goal is to gradually build out the API with tests to ensure functionality without using an API client.
Test driven APIs with Laravel
- 1. Test Driven APIs with Laravel @michaelpeacock
- 2. Whatâs in store? âą Look at API concepts within Laravel âą Look at testing concepts within Laravel âą How we can gradually build an API with confidence in its functionality, without ever opening an API client
- 3. @michaelpeacock âą Organiser of PHP North East âą Occasional author and speaker âą Freelance developer âą Consultant CTO for early stage SaaS start-ups
- 4. Laravel APIs
- 5. Lots for free âą Models & Collections > JSON Responses automatically âą Validation Failures > JSON Responses automatically âą Automatic handling of request and response headers (content-type, etc)
- 6. Lots to of power to customise âą API Resources âą API Routing âą Resource Controllers âą API Resource Controllers
- 8. Database interaction âą RefreshDatabase: calls migrate:fresh (drops all tables and re-migrates) âą DatabaseTransactions: wraps test db calls in a transaction
- 9. HTTP Tests
- 10. Sample project âą API for user group âą Events âą Venues âą Talks
- 12. Model integration tests âą A good starting point âą Give us confidence that models, migrations, relations and factories are setup correctly âą Especially important if we are providing custom field names for relations, or working with models outside of the root app directory âą Factories are important for API tests, so its good that we test the basis setup before we move onto that. âą Inspired by Amo Chohan: 12 tried and tested top tips for better testing
- 13. Key things to test initially âą We can instantiate the class âą Any relations
- 18. Migrations
- 19. Tip: Name your migrations well
- 21. Models
- 22. Factories
- 24. API Setup
- 25. Making requests âą $this->json(method, uri, data, headers) âą $this->getJson / postJson / patchJson / deleteJson âą $this->get(url, headers) âą $this->post(url, data, headers)
- 26. Testing responses: Status Codes âą $response->assertStatus(status code) âą $response->assertSuccessful() âą $response->assertOk() âą $response->assertNotFound() âą $response->assertNotFound() âą $response->assertForbidden()
- 27. GET /talks
- 29. API Controllers php artisan make:controller Api/EventsController --model=Event --api
- 30. API Routing
- 33. Testing response data âą $response->assertExactJson(array) âą $response->assertJson(array) âą $response->assertJsonCount(array) âą $response->assertJsonFragment(array) âą $response->assertJsonMissing(array) âą $response->assertJsonMissingExact(array) âą $response->assertJsonStructure(array)
- 34. Testing headers âą $response->assertHeader(header, value) âą $response->assertHeaderMissing(header) âą $response->assertLocation(url) // Location header
- 35. Lets check we get a JSON responseâŠ
- 40. Better responses âą Venue name and description should be included âą Event id should not be included âą Start and end date should be formatted a specific way
- 45. Now we get some failing (not erroring) tests
- 46. Resources php artisan make:resource Event php artisan make:resource Venue
- 50. POST /events âą We now want to test creating an event
- 51. A test helper to build valid request data
- 54. Saving a new event
- 55. Status codes and Resources
- 57. Testing Validation âą $response->assertJsonMissingValidationErrors(array) âą $response->assertJsonValidationErrors()
- 59. Creating a new request php artisan make:request CreateEventRequest
- 61. Use the request
- 63. Authenticating
- 64. actingAs
Editor's Notes
- #8: Support for unit, browser, HTTP, console tests.
- #10: Discuss how these work, and the impact on database transactions (i.e. how that works)
- #16: Explain about the relationships first, putting thought into the modelling of the app. Emphasise how many times I've been caught out by a migration where it was linked to the wrong FK because I copy and pasted a migration!
- #23: We can then iterate between tests and code, adding in the relationships that we need, until we get passing tests.
- #38: Returning a collection or a model, combined with API request headers, results in the data being converted to JSON
- #39: By default the JSON response includes all fields in the model, we can test that we have some fields that we want
- #45: Error: date fields are not cast as dates, fix that, then get failing tests.
- #47: Resources: transformers for our eloquent models
- #54: Failing test because nothing is created, its an error not a fail as such because we called findOrFail, in our test, so our test has thrown an exception