<% content_for :menu do %>
  • Введение в гайдлайны rspec
  • » Описание методов
  • » Использование контекстов
  • » Описания должны быть короткими
  • » Одна проверка на тест
  • » Тестируем все возможные случаи
  • » Используем subject
  • » Используем let и let!
  • » Используем моки (разумно)
  • » Создаем только необходимые данные
  • » Используем фабрики, а не фикстуры
  • » Используем читаемые матчеры
  • » Выносим код в Shared Examples
  • » Тестируем то, что видимо
  • » Не используем should
  • » Прогоняем тесты автоматически
  • » Более быстрые тесты (с предзагрузкой окружения)
  • » Прячем HTTP запросы
  • » Форматируем вывод с пользой
  • Книги
  • Презентации
  • Ресурсы в сети
  • Скринкасты
  • Докуменация
  • Стиль
  • Улучшение Better Specs
  • Благодарности
  • Помогите нам
  • <% end %>

    RSpec - это великолепный инструмент для behavior-driven development (BDD), необходимый для написания читаемых спецификаций (тестов), способных направлять и валидировать процесс разработки.

    В сети существует множество ресурсов, которые могут дать вам полное представление о возможностях RSpec. Но очень мало ресурсов посвящено тому, как писать отличные RSpec тесты.

    Better Specs - это попытка заполнить эту нишу, собрав все возможные "best practices", к которым другие разработчики приходят с годами опыта.

    Описание методов

    Явно указывайте тестируемый метод. К примеру, используйте соглашение, принятое в документации Ruby, об использовании . (или ::) при описании метода класса и # при описании метода экземпляра класса.

    плохо

    describe 'the authenticate method for User' do
    describe 'if the user is an admin' do
    

    хорошо

    describe '.authenticate' do
    describe '#admin?' do
    

    Обсудить рекомендацию →

    Использование контекстов

    Контексты - отличный способ привести тесты в чистоту и порядок. Их использование сохранит Ваши тесты читаемыми в долгосрочной перспективе.

    плохо

    it 'has 200 status code if logged in' do
      expect(response).to respond_with 200
    end
    it 'has 401 status code if not logged in' do
      expect(response).to respond_with 401
    end
    

    хорошо

    context 'when logged in' do
      it { is_expected.to respond_with 200 }
    end
    context 'when logged out' do
      it { is_expected.to respond_with 401 }
    end
    

    При описании контекста, начинайте строку с "when" или "with".

    Обсудить рекомендацию →

    Описания должны быть короткими

    Длина описания спеки не должна быть больше, чем 40 символов. Если такое происходит, то необходимо разделить описание с помощью контекста.

    плохо

    it 'has 422 status code if an unexpected params will be added' do
    

    хорошо

    context 'when not valid' do
      it { is_expected.to respond_with 422 }
    end
    

    В примере мы удалили описание, относящееся к коду статуса, и заменили его на ожидание is_expected. Если прогнать этот тест с помощью rspec filename, результат будет хорошо читаем.

    Вывод

    when not valid
      it should respond with 422
    

    Обсудить рекомендацию →

    Одна проверка на тест

    Каждый тест должен производить только одну проверку. Таким образом становится проще находить возможные ошибки, моментально перемещаясь прямо к упавшему тесту. Также, код попросту становится более читаемым.

    В изолированном юнит-тесте подразумевается, что каждый отдельный пример описывает одну (и только одну) ситуацию. Множество проверок в одном и том же примере сигнализирует о том, что скорее всего Вы описываете сразу несколько ситуаций, что плохо.

    Тем не менее, в тестах которые не являются изолированными (например, в тех, которые интегрированы с БД, внешним сервисом и т.п.), от того, что приходится каждый раз снова и снова производить одну и ту же подготовку для каждого отдельного теста, очень сильно падает производительность. В таких случаях несколько проверок в одном тесте допустимы.

    хорошо (изолированная ситуация)

    it { is_expected.to respond_with_content_type(:json) }
    it { is_expected.to assign_to(:resource) }
    

    хорошо (не изолированная ситуация)

    it 'creates a resource' do
      expect(response).to respond_with_content_type(:json)
      expect(response).to assign_to(:resource)
    end
    
    Обсудить рекомендацию →

    Тестируем все возможные случаи

    Тестирование это хорошо, но если не тестируются все возможные пограничные случаи, оно не принесет пользы. Тестируйте правильный, пограничный и неправильный исходы. К примеру:

    Destroy action

    before_action :find_owned_resources
    before_action :find_resource
    
    def destroy
      render 'show'
      @consumption.destroy
    end

    Довольно частая ошибка состоит в том, что тестируется только ситуация, в которой ресурс был действительно удален. Но здесь возможны как минимум два других исхода: в котором ресурс не найден и в котором он не принадлежит пользователю. Думайте о всех возможных исходах, исходя из собственного опыта, и проверяйте каждый.

    плохо

    it 'shows the resource'
    

    хорошо

    describe '#destroy' do
    
      context 'when resource is found' do
        it 'responds with 200'
        it 'shows the resource'
      end
    
      context 'when resource is not found' do
        it 'responds with 404'
      end
    
      context 'when resource is not owned' do
        it 'responds with 404'
      end
    end
    

    Обсудить рекомендацию →

    Используем subject

    Если несколько тестов относятся к одному и тому же объекту, то использование subject{} позволит избавить код от излишних повторений.

    плохо

    it { expect(assigns('message')).to match /it was born in Belville/ }
    

    хорошо

    subject { assigns('message') }
    it { is_expected.to match /it was born in Billville/ }
    

    В RSpec также есть возможность использовать именованный subject.

    хорошо

    subject(:hero) { Hero.first }
    it "carries a sword" do
      expect(hero.equipment).to include "sword"
    end
    

    Больше информации об использовании subject можно найти в документации.

    Обсудить рекомендацию →

    Используем let и let!

    let дает возможнось ленивой загрузки переменных - код в блоке let исполняется только после первого реального использования переменной в тесте и кешируется до тех пор, пока тест не дойдет до конца. Хорошее и подробное описание возможностей let можно найти в этом ответе на stackoverflow.

    плохо

    describe '#type_id' do
      before { @resource = FactoryBot.create :device }
      before { @type     = Type.find @resource.type_id }
    
      it 'sets the type_id field' do
        expect(@resource.type_id).to equal(@type.id)
      end
    end
    

    хорошо

    describe '#type_id' do
      let(:resource) { FactoryBot.create :device }
      let(:type)     { Type.find resource.type_id }
    
      it 'sets the type_id field' do
        expect(resource.type_id).to equal(type.id)
      end
    end
    

    Используйте let для ленивого выполнения необходимых действий.

    хорошо

    context 'when updates a not existing property value' do
      let(:properties) { { id: Settings.resource_id, value: 'on' } }
    
      def update
        resource.properties = properties
      end
    
      it 'raises a not found error' do
        expect { update }.to raise_error Mongoid::Errors::DocumentNotFound
      end
    end
    

    Еще существует let!, который выполняется сразу после объявления. Это может быть полезным для заполнения базы необходимыми данными, поскольку на момент выполнения теста они гарантированно будут доступны.

    Вот как это все работает.

    хорошо

    # this:
    let(:foo) { Foo.new }
    
    # is very nearly equivalent to this:
    def foo
      @foo ||= Foo.new
    end
    

    Больше информации в документации.

    Обсудить рекомендацию →

    Используем моки (разумно)

    На данный момент в сообществе нет единого мнения о реальной пользе моков. Безусловно, они полезны, но злоупотреблять ими не стоит - там, где это возможно, лучше тестировать реальное поведение системы. Тесты, которые задействуют реальные кейсы, бесценны при рефакторинге.

    хорошо

    # simulate a not found resource
    context "when not found" do
      before do
        allow(Resource).to receive(:where).with(created_from: params[:id])
          .and_return(false)
      end
      it { is_expected.to respond_with 404 }
    end
    

    С моками ваши спеки становятся быстрее, но моки сложны в использовании. Чтобы пользоваться ими с выгодой, нужно в них хорошо разобраться. Можно узнать о них больше из этой статьи.

    Обсудить рекомендацию →

    Создаем только необходимые данные

    Если вы когда-либо работали в проекте среднего размера (да и в маленьком тоже), то вы знаете, что спеки со временем могут стать очень тяжелыми. Чтобы избежать этого, очень важно не создавать данных больше, чем реально необходимо. Если вы считаете, что для теста вам потребуются десятки записей, то скорее всего вы делаете что-то не так.

    хорошо

    describe "User"
      describe ".top" do
        before { FactoryBot.create_list(:user, 3) }
        it { expect(User.top(2)).to have(2).item }
      end
    end
    

    Обсудить рекомендацию →

    Используем фабрики, а не фикстуры

    Это довольно старая тема для обсуждения, но она не теряет актуальности. Не следует использовать фикстуры, потому что их сложно контроллировать. Используйте фабрики вместо них. Это позволит вам писать более лаконичный код.

    плохо

    user = User.create(
      name: 'Genoveffa',
      surname: 'Piccolina',
      city: 'Billyville',
      birth: '17 Agoust 1982',
      active: true
    )
    

    хорошо

    user = FactoryBot.create :user
    

    Важное замечание. Когда речь идет о юнит тестах, то считается, что обоих подходов следует избегать. Выделяйте максимум логики в библиотеки, которые могут быть протестированы без необходимости в сложной и долгой загрузке фабрик либо фикстур. Можно почитать об этом здесь

    Больше информации можно найти на странице Factory Bot.

    Обсудить рекомендацию →

    Используем читаемые матчеры

    Используйте читаемые матчеры и дважды проверяйте, не написаны ли они до вас.

    плохо

    lambda { model.save! }.to raise_error Mongoid::Errors::DocumentNotFound
    

    хорошо

    expect { model.save! }.to raise_error Mongoid::Errors::DocumentNotFound
    

    Обсудить рекомендацию →

    Выносим код в Shared Examples

    Писать тесты хорошо, и день за днем вы становитесь в этом деле все подкованнее. Но спустя некоторое время, вы начнете замечать все больше и больше дублированного кода. Используйте Shared Examples, чтобы избавляться от повторений.

    плохо

    describe 'GET /devices' do
      let!(:resource) { FactoryBot.create :device, created_from: user.id }
      let(:uri) { '/devices' }
    
      context 'when shows all resources' do
        let!(:not_owned) { FactoryBot.create factory }
    
        it 'shows all owned resources' do
          page.driver.get uri
          expect(page.status_code).to be(200)
          contains_owned_resource resource
          does_not_contain_resource not_owned
        end
      end
    
      describe '?start=:uri' do
        it 'shows the next page' do
          page.driver.get uri, start: resource.uri
          expect(page.status_code).to be(200)
          contains_resource resources.first
          expect(page).to_not have_content resource.id.to_s
        end
      end
    end
    

    хорошо

    describe 'GET /devices' do
    
      let!(:resource) { FactoryBot.create :device, created_from: user.id }
      let(:uri)       { '/devices' }
    
      it_behaves_like 'a listable resource'
      it_behaves_like 'a paginable resource'
      it_behaves_like 'a searchable resource'
      it_behaves_like 'a filterable list'
    end
    

    По нашему опыту, shared examples чаще всего используются для контроллеров. В отличие от моделей, чаще всего в них не так много различной логики.

    Почитать об этом можно тут.

    Обсудить рекомендацию →

    Тестируем то, что видимо

    Тщательно тестируйте ваши модели и поведение приложения (интеграционными тестами). Не усложняйте тестовую базу тестами контроллеров.

    Когда я только начинал тестировать свои приложения, я тестировал и контроллеры. Больше я так не делаю. Сейчас я ограничиваюсь интеграционными тестами на RSpec и Capybara. Почему? Потому что я уверен, что тестировать нужно то, что видно глазу, а тестирование контроллеров - это лишний шаг, который на самом деле не нужен. Большинство интеграционных тестов и так заглядывают в модели, к тому же они могут быть легко вынесены в shared example, что дает возможность писать чистые и читаемые тесты.

    В Руби-сообществе ведутся дебаты на эту тему, и у каждой из сторон есть свои хорошие аргументы. Люди, которые выступают за необходимость тестирования контроллеров, скажут вам, что интеграционные тесты не покрывают всех кейсов, а также о том, что эти тесты медленные.

    Обсудить рекомендацию →

    Не используем should

    Не следует использовать should внутри своих тестов. Тексты тестов должны быть написаны в третьем лице, в настоящем времени. А еще лучше - начните использовать новый синтаксис.

    плохо

    it 'should not change timings' do
      consumption.occur_at.should == valid.occur_at
    end
    

    хорошо

    it 'does not change timings' do
      expect(consumption.occur_at).to equal(valid.occur_at)
    end
    

    Обсудить рекомендацию →

    Прогоняем тесты автоматически

    Прогонять все тесты проекта после каждого изменения в коде довольно накладно. Этот процесс занимает много времени и может сбить рабочий темп. Guard поможет вам прогонять только те тесты, которые относятся к только что измененному коду спеки, модели, контроллера или файла, над которым вы работаете.

    хорошо

    bundle exec guard
    
    Вот пример конфигурационного файла (Guardfile) с некоторыми базовыми правилами.

    хорошо

    guard 'rspec', cli: '--drb --format Fuubar --color', version: 2 do
      # run every updated spec file
      watch(%r{^spec/.+_spec\.rb$})
      # run the lib specs when a file in lib/ changes
      watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
      # run the model specs related to the changed model
      watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
      # run the view specs related to the changed view
      watch(%r{^app/(.*)(\.erb|\.haml)$}) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
      # run the integration specs related to the changed controller
      watch(%r{^app/controllers/(.+)\.rb}) { |m| "spec/requests/#{m[1]}_spec.rb" }
      # run all integration tests when application controller change
      watch('app/controllers/application_controller.rb') { "spec/requests" }
    end
    

    Guard - это хороший инструмент, но он, конечно же, не может покрыть сразу все ваши нужды. Иногда продуктивнее всего работа идет в паре с горячими клавишами, которые позволяют запускать только желаемые тесты. А в самом конце, перед коммитом, уже можно прогнать все остальные тесты. Вот настройки для vim.

    Читать больше о guard-rspec.

    Обсудить рекомендацию →

    Более быстрые тесты (с предзагрузкой окружения)

    Для того, чтобы прогнать тесты в Rails, загружается все приложение. Это действие может занять довольно много времени и нарушить рабочий ритм. Для того, чтобы этого не произошло, принято использовать такие инструменты как Zeus, Spin или Spork. Все они будут держать в памяти те библиотеки, которые не нужно перезагружать каждый раз.

    Вот пример spec helper и конфигурации Guardfile для Spork. С этими настройками приложение будет перезагружено полностью только если изменятся определенные файлы (например, config/initializers), а в остальных же случаях вы почувствуете очень-очень большой прирост в скорости прогона спек.

    Есть и подводные камни в использовании таких решений, которые могут всплыть, если вы активно используете monkey-патчинг в коде. Вы можете потерять порядочное количество времени в попытках понять, почему же код не работает. Если у вас есть примеры таких ситуаций, дайте нам знать.

    В сторону подобных решений направлено очень много критики. Эти библиотеки лишь устраняют симптомы более серьезных проблем, которые на самом деле следует решать более качественным проектированием. Можно почитать дискуссии, ведущиеся на этот счет.

    Обсудить рекомендацию →

    Прячем HTTP запросы

    Иногда в тестах вам необходимо получать доступ к внешним сервисам (API). В таких случаях не стоит полагаться на реальный сервис, вместо этого нужно закрывать их стабами при помощи средств вроде webmock.

    хорошо

    context "with unauthorized access" do
      let(:uri) { 'http://api.lelylan.com/types' }
      before    { stub_request(:get, uri).to_return(status: 401, body: fixture('401.json')) }
      it "gets a not authorized notification" do
        page.driver.get uri
        expect(page).to have_content 'Access denied'
      end
    end
    

    Больше информации можно найти на страницах webmock и VCR. Вот хорошая презентация о том, как использовать их вместе.

    Обсудить рекомендацию →

    Форматируем вывод с пользой

    Используйте форматтер, который может сообщить вам полезную информацию о тестах. Лично мне нравится fuubar. Чтобы начать его использовать, добавьте в проект сам гем и установите fuubar в качестве форматтера по умолчанию (внутри Guardfile).

    хорошо

    # Gemfile
    group :development, :test do
      gem 'fuubar'
    

    хорошо

    # Guardfile
    guard 'rspec' do
      # ...
    end
    

    хорошо

    # .rspec
    --drb
    --format Fuubar
    --color
    

    Learn more about fuubar.

    Обсудить рекомендацию →

    Книги

    <%= render "partials/books" %>

    Презентации

    RSpec 2 Best practices from Andrea Reginato

    Ресурсы в сети

    1. Everyday Rails Spec
    2. Eggs on Bread Best Practices
    3. The Carbon Emitter Best Practices
    4. Andy Vanasse Best Practices
    5. Bitfluxx Best Practices
    6. Dmytro Shteflyuk Best Practices
    7. thoughtbot's RSpec Related Reading

    Скринкасты

    1. RSpec on PeepCode
    2. Testing With RSpec Code School course
    3. Spork Railscast
    4. Using Zeus to speed up your tests
    5. Code TV Screencast on Guard and Spork
    6. Many of Destroy All Software screencasts

    Документация

    1. RSpec Documentation
    2. Capybara Documentation
    3. Factory Bot Documentation
    4. Webmock Documentation
    5. Timecop Documentation
    6. Shoulda Matchers
    7. Fuubar Release

    Стиль

    Мы находимся в поиске эталонных гайдлайнов по написанию "читаемых" спек. Сейчас можно с уверенностью брать пример с тестов Mongoid. Они написаны очень чисто и легко читаются, а также соответствуют практически всем правилам, описанным здесь.

    Улучшение Better Specs

    Это опенсорсный проект. Если что-то кажется вам неверным, либо если чего-то не хватает, просто заведите issue для обсуждения. Также, загляните сюда:

    Благодарности

    Этот документ изначально создал Andrea Reginato. Отдельная благодарность Lelylan Team. Документ использует лицензию MIT License. Перевод на русский язык произведен командой Evrone.

    Помогите нам

    Если вы нашли для себя что-то полезное, что помогло вам в вашей работе, то мы будем благодарны за ваше пожертвование. Любое пожертвование будет использовано для того, чтобы сделать этот сайт еще более полным источником информации о качественном тестировании в Руби.