CODEWITHSUNDEEP
ruby-on-railscapybara
mirelon
mirelon

Reputation: 4996

Capybara matcher for presence of button or link

Users on web page don't distinguish between "button" and "link styled as button". Is there a way to add check whether a "button or link" is present on page?

For example Capybara has step:

page.should have_button('Click me')

which does not find links styled as buttons.

Upvotes: 37

Views: 31762

Answers (7)

mirelon
mirelon

Reputation: 4996

Updated answer (should matcher is deprecated in RSpec 3.0+):

expect(page).to have_selector(:link_or_button, 'Click me')

Before:

page.should have_selector(:link_or_button, 'Click me')

Followed from click_link_or_button which is defined here: https://github.com/jnicklas/capybara/blob/master/lib/capybara/node/actions.rb#L12

def click_link_or_button(locator)
  find(:link_or_button, locator).click
end
alias_method :click_on, :click_link_or_button

It calls a selector :link_or_button. This selector is defined here: https://github.com/jnicklas/capybara/blob/master/lib/capybara/selector.rb#L143

Capybara.add_selector(:link_or_button) do
  label "link or button"
  xpath { |locator| XPath::HTML.link_or_button(locator) }
end

It calls this method: http://rdoc.info/github/jnicklas/xpath/XPath/HTML#link_or_button-instance_method

# File 'lib/xpath/html.rb', line 33

def link_or_button(locator)
  link(locator) + button(locator)
end

So i tried to check the presence of the selector and it worked:

page.should have_selector(:link_or_button, 'Click me')

Upvotes: 64

Denis repon
Denis repon

Reputation: 33

if html:

<a class="top-menu__item">text123
    <span class="label">
        <span class="label">86</span>
    </span>
</a>

not work:

  assert page.has_selector?(:link_or_button, text: 'text123')
  assert page.should have_selector(:link_or_button, text: 'text123')

Upvotes: 0

port5432
port5432

Reputation: 6371

Using the expect syntax

expect(page).to have_selector(:link_or_button, 'Click me')

This works without needing to define a custom matcher.

Upvotes: 7

Jon Kern
Jon Kern

Reputation: 3235

I had an odd case where some smoke tests marched across various customer-centric login pages that had slight variations on doing the login submit button... Driven by a Cucumber table of user, org, etc.

# A bit of a hack, org_name is normally a subdomain, but sometimes it is the complete domain
def login(user, org_name)
  # Use the below to automatically hit each user's org's server
  if org_name.include? '.com'
    Capybara.app_host = "http://#{org_name}"
  else
    Capybara.app_host = "http://#{org_name}.mydomain.com"
  end

  visit '/'
  fill_in 'username', :with => user
  fill_in 'userpwd', :with => '***'
  begin
    page.find(:link_or_button, 'submit')
    click_on 'submit'
  rescue Capybara::ElementNotFound
    page.find(:link_or_button, 'Log In')
    click_on 'Log In'
    rescue Capybara::ElementNotFound
      pending "Need to determine how to invoke the Login button for #{org_name} near Line ##{__LINE__} of #{__method__} in #{__FILE__} "
  end

  # -----------------------
  # Work-around for modal popup saying SSL is mismatched if you are using actual production URLs
  # The rescue is for cases that do not exhibit the modal pop-up
  page.driver.browser.switch_to.alert.accept rescue Selenium::WebDriver::Error::NoAlertPresentError

  # Ensure that login was successful
  page.should_not have_content 'Login failed'
end

Upvotes: 0

idrinkpabst
idrinkpabst

Reputation: 1838

You can also use a custom matcher

RSpec::Matchers::define :have_link_or_button do |text|
  match do |page|
    Capybara.string(page.body).has_selector?(:link_or_button, text: text)
  end
end

Then do

expect(page).to have_link_or_button('Login')

Upvotes: 2

Dave Oh
Dave Oh

Reputation: 135

Personally I would give your button or link an id and look for that using

page.should have_css('#foo')

This way you can refer to the link or button without worrying about its implementation.

I always find this useful: https://gist.github.com/428105

Upvotes: 1

simonmorley
simonmorley

Reputation: 2804

I think you can use the find button instance method:

(Capybara::Element) find_button(locator)

Using id, name, value.

Or if you want a link

(Capybara::Element) find_link(locator)

From: http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Finders#find_button-instance_method

Upvotes: 0

Related Questions