Skip to content

Latest commit

 

History

History

testing-rspec

README.md

Testing with RSpec

  • Avoid the private keyword in specs.
  • Avoid checking boolean equality directly. Instead, write predicate methods and use appropriate matchers. Example.
  • Prefer eq to == in RSpec.
  • Separate setup, exercise, verification, and teardown phases with newlines.
  • Use RSpec's expect syntax.
  • Use RSpec's allow syntax for method stubs.
  • Use not_to instead of to_not in RSpec expectations.
  • Prefer the have_css matcher to the have_selector matcher in Capybara assertions.
  • Avoid any_instance in rspec-mocks and mocha; Prefer dependency injection.
  • Avoid its, specify, and before in RSpec.
  • Avoid let (or let!) in RSpec. Prefer extracting helper methods, but do not re-implement the functionality of let. Example.
  • Avoid using subject explicitly inside of an RSpec it block. Example.
  • Avoid using instance variables in tests.
  • Disable real HTTP requests to external services with WebMock.disable_net_connect!.
  • Don't test private methods.
  • Test background jobs with a Delayed::Job matcher.
  • Use stubs and spies (not mocks) in isolated tests.
  • Use a single level of abstraction within it examples.
  • Use an it example or test method for each execution path through the method.
  • Use assertions about state for incoming messages.
  • Use stubs and spies to assert you sent outgoing messages.
  • Use a Fake to stub requests to external services.
  • Use integration tests to execute the entire app.
  • Use non-SUT methods in expectations when possible.

Acceptance Tests

Sample

  • Use the most specific selectors available.
  • Don't locate elements with CSS selectors or [id] attributes.
  • Use accessible names and descriptions to locate elements, to interact with form controls, buttons, and links, or to scope blocks of actions and assertions.
  • Avoid it block descriptions that add no information, such as "successfully."
  • Avoid it block descriptions that repeat the top-level describe block description.
  • Place helper methods for system specs directly in a top-level System module.
  • Use names like ROLE_ACTION_spec.rb, such as user_changes_password_spec.rb, for system spec file names.
  • Use only one describe block per system spec file.
  • Use it block descriptions that describe the success and failure paths.
  • Use spec/system directory to store system specs.
  • Use spec/support/system for support code related to system specs.
  • Don't assert an element's state with [class] or [data-*] attributes.
  • Use WAI-ARIA States and Properties (i.e. [role] or [aria-*] attributes) when asserting an element's state.
  • Prefer assertions about implicit semantics and built-in attributes (e.g. an <input type="checkbox"> element and [checked], an <option> element and [selected]) over WAI-ARIA States and Properties (e.g. a <button> element and [aria-checked="true"], a <div> element and [aria-selected="true"]).

system specs were previously called feature specs and lived in spec/features

Factories

  • Order factories.rb contents: sequences, traits, factory definitions.
  • Order factory attributes: implicit attributes, explicit attributes, child factory definitions. Each section's attributes are alphabetical.
  • Order factory definitions alphabetically by factory name.

Unit Tests

Sample

  • Don't prefix it block descriptions with should. Use Imperative mood instead.
  • Use subject blocks to define objects for use in one-line specs. Example.
  • Put one-liner specs at the beginning of the outer describe blocks.
  • Use .method to describe class methods and #method to describe instance methods.
  • Use context to describe testing preconditions.
  • Use describe '#method_name' to group tests by method-under-test
  • Use a single, top-level describe ClassName block.
  • Order validation, association, and method tests in the same order that they appear in the class.