Behavior-Driven Development of Rails APIs
We'll answer the following questions in this talk.
- Why should you care about testing?
- How do you know what to test?
- What is the purpose of a feature test?
- What is the purpose of a unit test?
Tests limit what we have to debug. For instance, if we have all green, passing tests, we know that when we deploy to Heroku our code isn't the problem, rather an issue with Heroku. Passing tests limits the types of debugging you have to do.
By the end of this lesson, students should be able to:
- Develop a Rails API using outside-in, behavior-driven testing.
- Describe the difference between Behavior and Test Driven Development (BDD vs TDD)
- Drive behavior specification with user stories.
- Write automated CRUD request specs with RSpec.
- Drive routing, model, and controller specs using request specs.
- Write model unit specs for associations and validations.
- Fork and clone this repository.
- Create and checkout to a new branch,
training, for your work.
- Install dependencies with
User Story Discussion
Before diving into testing, let's revisit wireframes and user stories. We've used both of these for our first projects.
Why were they important? What do our user stories do for the scope of our project? How are they useful when wireframing our webapp's layout and UX? How do good user stories and wireframes help with app development?
Behavior Driven vs. Test Driven Development
Tests can be written before or after writing development code. Writing tests after development is called 'backfilling'. Test driven development (TDD) is a specific order of testing and writing code:
- Write a test
- Run the test (it should fail)
- Write code
- Run the test (if it fails, go back to step 3)
- Run the test
It often refers to bottom-up testing, in which unit tests are written first, and features are tested afterwards using integration tests. TDD is a challenge, and if you're feeling up for it, try it! Backfilling tests may be a more attainable goal for your project.
Behavior Driven Development is top-down testing. It can be done either before or after writing code, so BDD can be done as part of TDD, or as backfilling. BDD is about writing a feature (a fancy curl request written in Ruby) and having that initiate an error (a routing error), then writing a unit that shows the same error (a routing unit test), then writing the code that passes it, then running the feature, seeing a new error, etc...
Feature tests are for catching regressions/bugs. Features break less because they're higher level. Features test user experience. Feature tests document workflow within the app. Feature tests tell you what's missing, and drive each step of the development process. Feature tests are driven by user stories.
Unit tests drive implementation and break more often, but they're smaller in scale and faster to execute. Unit tests test developer experience. Unit tests don't break down the problem into smaller pieces, they give you the confidence that the smallest pieces work as expected. Unit tests document your code base.
Both of these tests provide documentation of your code. Writing tests makes refactoring easy because we can change one thing and see how it affects the entire system. After each change in the code we run our unit tests to confirm our expectations.
Use feature tests to drive your unit tests, and your unit tests to drive your code. You'll want to save and commit your work often during development. We suggest commiting:
- After passing unit tests.
- After passing a feature.
- After refactoring and passing all tests.
You can push when you're done passing a feature. You should always run your tests before you commit/push your work.
We'll start with a request spec. Request specs perform a similar job to
they emulate testing your API from the client's point-of-view.
Failing request specs will drive creating routing specs. Routing specs will drive creating controller specs. Finally, controller specs will drive creating model specs. Once we have all these smaller tests (units) passing, the feature spec (request spec) should pass automatically!
Let the tests tell you what to do next, and you'll never have to think about your next task. It helps us get in "the zone"!
GET All Articles
Demo: Feature Test
GET /articles Request Spec
User story: As a user, I want to see a list of articles.
To check our specs, we run
bundle exec rspec spec from the command line.
What output to we get?
Failures: 1) Articles API GET /articles lists all articles Failure/Error: get '/articles' ActionController::RoutingError: No route matches [GET] "/articles" # ./spec/requests/articles_spec.rb:29:in `block (3 levels) in <top (required)>'
This output tells us exactly what went wrong (or more accurately, what did not go as expected), and should be treated as our guide towards working code.
GET /articles Routing Spec
Our test told us that no route matches "/articles". So the next step is to write a test for that route.
What do we expect that route to do?
Let's work on our
GET /articles routing spec in
to ensure that our routes are mapped to the correct controller method.
Now that we have a test, let's create the route! Remember, each time a unit test passes, it's time to commit.
articles#index Controller Spec
bundle exec rspec spec again now that our route test passed.
We get a nice new error:
Failure/Error: get '/articles' AbstractController::ActionNotFound: The action 'index' could not be found for ArticlesController
To wrap up our checks that all articles are correctly returned from our
method, we'll need a passing test for the controller method itself: spec/controllers/articles_spec.rb.
Once the test is written, let's write an
index method on the Article Controller.
Don't forget to commit when your tests pass!
GET One Article
GET /articles/:id Request Spec
User Story: As a user, I want to see a specific article.
In spec/requests/articles_spec.rb, let's make sure our API is returning a single article correctly. Before we write our test, let's think about what our app is supposed to DO when it receives a GET request to this route.
GET /articles/:id Routing Spec
How do we make sure our routes are set to receive GET requests for a single
article? How does routing to
articles#show differ from
articles#show Controller Spec
Working off of our
articles#index, build out the two
GET show tests in
pass. Again, remember how
articles#show differs from
be sure to be testing against that.
User Story: As a user, I want to be able to delete an article.
Based on our
GET request spec, complete a request spec for delete.
What does a request to delete do?
Based on our
GET specs, complete routing
DELETE. What should the route do? Then write a route so that the
test passes. Remember to commit after passing the test!
Continue working in spec/controllers/articles_spec.rb
to create passing tests for the
DELETE controller actions. What does the
DELETE controller action do?
Then write the controller action so that the test passes, and commit.
Code-along: PATCH Request
User Story: As a user, I would like to update an article.
Working together, let's create a feature test for
Lab: PATCH route
Write a test for the
PATCH route, and make it pass.
Code-along: PATCH controller
Now that our route works, we're getting an error about our controller. Let's write a test for that!
User Story: As a user, I would like to create an article.
Write a feature test for post requests. Then, following BDD, write tests for the route and controller.
Comments Resource and Testing Your Models
Now that you've got this far let's keep working, here are the steps you should follow in order to test that your Models are set up correctly.
Follow this link to learn more about Model testing with RSpec.
You not only want to test that the Model is set up correctly for its own data, but that it also knows about relationships it is meant to have with other resources.
For instance, it would be nice if Users could leave Comments on Articles in your application. A Comment should be tied directly to an Article because otherwise it loses its context. For this to work, we'll need a new Comment resource.
For something a bit easier, you can skip the Comments resource for now and just
add a spec for the Article Model from the section below labeled
Iterate over Article Model to Ensure Validations.
Create and run through request, routing, and controller specs for your Comment resource. Follow the same steps that you used for Articles. Remember you can build out a resource independently at first, even if you know that you want it to have a relationship later on.
Once Comments are set up you can move on to setting up the relationship between Comments and Articles, as well as adding the actual Model specs to both resources.
Article Model Spec
User Story As a user, I want to see the comments associated with an article. User Story As a user, I want comments to be deleted when an article is deleted.
In spec/models/article_spec.rb, you will need to write tests to check for the following:
- Articles can have many comments.
- If an article is destroyed, its associated comments must also be destroyed.
Your first step will be to create feature tests to account for these
new requirements. Create a new file:
Write Article Model and Run the Specs
Based on your
Article Model specs, run your specs to complete what is expected
Run one spec at a time until they have all passed.
Test Article Model
In spec/models/article_spec.rb, test to see if you:
- are associating comments to articles
- have set your
- are deleting comments associated to articles when articles are deleted
Iterate over Article Model to Ensure Validations
Using your BDD skills, create tests to check that your Article model is
validating the presence
title. You don't want articles created that are missing
either one of those fields.
You will create your tests first and let those drive you towards an adequately-validated model.
- How I learned to test my Rails Applications, series
- How We Test Rails Applications
- Testing Stripe with Rails and RSpec - Hackernoon
- All content is licensed under a CCBYNCSA 4.0 license.
- All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact firstname.lastname@example.org.