Back to Repositories

Testing Button Detection and State Validation in Capybara

This test suite validates the button detection and state verification functionality in Capybara, focusing on the has_button? and has_no_button? matchers. The tests ensure accurate button presence detection while handling various button states, ARIA roles, and focus conditions.

Test Coverage Overview

The test suite provides comprehensive coverage for button detection in web applications using Capybara.

Key areas tested include:

Basic button presence verification
Disabled button state handling
ARIA role button support
Button type validation
Focus state detection
Negative matching scenarios

Implementation Analysis

The testing approach employs RSpec-style expectations with Capybara’s session object to validate button presence and states. The implementation uses both positive (has_button?) and negative (has_no_button?) matchers with various options including disabled states, ARIA roles, and focus detection.

Notable patterns include:

Consistent before block setup
Parameter validation testing
State-based assertions
Edge case handling

Technical Details

Testing tools and configuration:

Capybara test framework
RSpec expectation syntax
Session-based testing
Form-specific test environment
Active element support for focus testing
ARIA role configuration options

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Comprehensive state coverage
Clear test case organization
Explicit error validation
Feature isolation
Consistent naming conventions
Thorough edge case handling

teamcapybara/capybara

lib/capybara/spec/session/has_button_spec.rb

            
# frozen_string_literal: true

Capybara::SpecHelper.spec '#has_button?' do
  before do
    @session.visit('/form')
  end

  it 'should be true if the given button is on the page' do
    expect(@session).to have_button('med')
    expect(@session).to have_button('crap321')
    expect(@session).to have_button(:crap321)
    expect(@session).to have_button('button with label element')
    expect(@session).to have_button('button within label element')
  end

  it 'should be true for disabled buttons if disabled: true' do
    expect(@session).to have_button('Disabled button', disabled: true)
  end

  it 'should be false if the given button is not on the page' do
    expect(@session).not_to have_button('monkey')
  end

  it 'should be false for disabled buttons by default' do
    expect(@session).not_to have_button('Disabled button')
  end

  it 'should be false for disabled buttons if disabled: false' do
    expect(@session).not_to have_button('Disabled button', disabled: false)
  end

  it 'should be true for disabled buttons if disabled: :all' do
    expect(@session).to have_button('Disabled button', disabled: :all)
  end

  it 'should be true for enabled buttons if disabled: :all' do
    expect(@session).to have_button('med', disabled: :all)
  end

  it 'can verify button type' do
    expect(@session).to have_button('awe123', type: 'submit')
    expect(@session).not_to have_button('awe123', type: 'reset')
  end

  it 'should be true for role=button when enable_aria_role: true' do
    expect(@session).to have_button('ARIA button', enable_aria_role: true)
  end

  it 'should be false for a role=button within a label when enable_aria_role: true' do
    expect(@session).not_to have_button('role=button within label', enable_aria_role: true)
  end

  it 'should be false for role=button when enable_aria_role: false' do
    expect(@session).not_to have_button('ARIA button', enable_aria_role: false)
  end

  it 'should be false for a role=button within a label when enable_aria_role: false' do
    expect(@session).not_to have_button('role=button within label', enable_aria_role: false)
  end

  it 'should not affect other selectors when enable_aria_role: true' do
    expect(@session).to have_button('Click me!', enable_aria_role: true)
  end

  it 'should not affect other selectors when enable_aria_role: false' do
    expect(@session).to have_button('Click me!', enable_aria_role: false)
  end

  context 'with focused:', requires: [:active_element] do
    it 'should be true if a field has focus when focused: true' do
      @session.send_keys(:tab)

      expect(@session).to have_button('A Button', focused: true)
    end

    it 'should be true if a field does not have focus when focused: false' do
      expect(@session).to have_button('A Button', focused: false)
    end
  end

  it 'should raise an error if an invalid option is passed' do
    expect do
      expect(@session).to have_button('A Button', invalid: true)
    end.to raise_error(ArgumentError, 'Invalid option(s) :invalid, should be one of :above, :below, :left_of, :right_of, :near, :count, :minimum, :maximum, :between, :text, :id, :class, :style, :visible, :obscured, :exact, :exact_text, :normalize_ws, :match, :wait, :filter_set, :focused, :disabled, :name, :value, :title, :type')
  end
end

Capybara::SpecHelper.spec '#has_no_button?' do
  before do
    @session.visit('/form')
  end

  it 'should be true if the given button is on the page' do
    expect(@session).not_to have_no_button('med')
    expect(@session).not_to have_no_button('crap321')
  end

  it 'should be true for disabled buttons if disabled: true' do
    expect(@session).not_to have_no_button('Disabled button', disabled: true)
  end

  it 'should be false if the given button is not on the page' do
    expect(@session).to have_no_button('monkey')
  end

  it 'should be false for disabled buttons by default' do
    expect(@session).to have_no_button('Disabled button')
  end

  it 'should be false for disabled buttons if disabled: false' do
    expect(@session).to have_no_button('Disabled button', disabled: false)
  end

  it 'should be true for role=button when enable_aria_role: false' do
    expect(@session).to have_no_button('ARIA button', enable_aria_role: false)
  end

  it 'should be true for role=button within a label when enable_aria_role: false' do
    expect(@session).to have_no_button('role=button within label', enable_aria_role: false)
  end

  it 'should be false for role=button when enable_aria_role: true' do
    expect(@session).not_to have_no_button('ARIA button', enable_aria_role: true)
  end

  it 'should be true for a role=button within a label when enable_aria_role: true' do
    # label element does not associate with aria button
    expect(@session).to have_no_button('role=button within label', enable_aria_role: true)
  end

  it 'should not affect other selectors when enable_aria_role: true' do
    expect(@session).to have_no_button('Junk button that does not exist', enable_aria_role: true)
  end

  it 'should not affect other selectors when enable_aria_role: false' do
    expect(@session).to have_no_button('Junk button that does not exist', enable_aria_role: false)
  end

  context 'with focused:', requires: [:active_element] do
    it 'should be true if a button does not have focus when focused: true' do
      expect(@session).to have_no_button('A Button', focused: true)
    end

    it 'should be false if a button has focus when focused: false' do
      @session.send_keys(:tab)

      expect(@session).to have_no_button('A Button', focused: false)
    end
  end
end