Cucumber and Capybara setup

Author: blacksmith-welder

.gitignore

@@ -0,0 +1 @@
+3.2.0

.ruby-version

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'byebug'
+gem 'capybara'
+gem 'cucumber'
+gem 'selenium-webdriver'

Gemfile

@@ -0,0 +1,84 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    byebug (11.1.3)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    cucumber (9.2.0)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 13, < 14)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 28)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.2)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (13.0.3)
+      cucumber-gherkin (>= 27, < 28)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (> 5, < 7)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (27.0.0)
+      cucumber-messages (>= 19.1.4, < 23)
+    cucumber-html-formatter (21.6.0)
+      cucumber-messages (> 19, < 25)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (6.1.0)
+    diff-lcs (1.5.1)
+    ffi (1.17.0-x86_64-linux-gnu)
+    logger (1.6.0)
+    matrix (0.4.2)
+    mini_mime (1.1.5)
+    multi_test (1.1.0)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    regexp_parser (2.9.2)
+    rexml (3.3.4)
+      strscan
+    rubyzip (2.3.2)
+    selenium-webdriver (4.23.0)
+      base64 (~> 0.2)
+      logger (~> 1.4)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    strscan (3.1.0)
+    sys-uname (1.3.0)
+      ffi (~> 1.1)
+    websocket (1.2.11)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  capybara
+  cucumber
+  selenium-webdriver
+
+BUNDLED WITH
+   2.4.1

Gemfile.lock

@@ -0,0 +1,8 @@
+default: |
+  staff-features
+  --publish-quiet
+  --format pretty
+  --color
+  --require env.rb
+  --require helpers
+  --require staff-features

cucumber.yml

@@ -0,0 +1,15 @@
+require 'capybara/cucumber'
+require 'selenium-webdriver'
+
+BASE_URL = 'https://e2e.archivesspace.org'
+PUBLIC_URL = BASE_URL
+STAFF_URL = "#{BASE_URL}/staff"
+
+Capybara.register_driver :firefox do |app|
+  options = Selenium::WebDriver::Firefox::Options.new
+
+  Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
+end
+
+Capybara.default_driver = :firefox
+Capybara.default_max_wait_time = 10

env.rb

@@ -0,0 +1,19 @@
+def expect_record_to_be_in_search_results(search_term)
+  fill_in 'global-search-box', with: search_term
+  find('#global-search-button').click
+
+  search_result_rows = all('#tabledSearchResults tbody tr')
+
+  expect(search_result_rows.length).to eq 1
+  expect(search_result_rows[0].text).to include search_term
+end
+
+def expect_record_to_not_be_in_search_results(search_term)
+  fill_in 'global-search-box', with: search_term
+  find('#global-search-button').click
+
+  search_result_rows = all('#tabledSearchResults tbody tr')
+
+  expect(search_result_rows.length).to eq 0
+  expect(find('.alert.alert-info.with-hide-alert').text).to eq 'No records found'
+end

helpers/helpers.rb

@@ -0,0 +1,13 @@
+Feature: Accession Create
+  Background:
+    Given the user is logged in as admin
+  Scenario: Accession is successfully created
+    Given the web browser is on the create accession page
+    When the user fills in all the required fields
+    When the user clicks on Save
+    Then a new accession is created
+  Scenario: Accession fails to be created
+    Given the web browser is on the create accession page
+    When the user does not fill in all the required fields
+    When the user clicks on Save
+    Then a new accession is not created

staff-features/accessions/accession-create.feature

@@ -0,0 +1,32 @@
+Given('the web browser is on the create accession page') do
+  @uuid = SecureRandom.uuid
+
+  click_on 'Create'
+  click_on 'Accession'
+end
+
+When('the user fills in all the required fields') do
+  fill_in 'accession_id_0_', with: "Accession #{@uuid}"
+end
+
+When('the user does not fill in all the required fields') do
+  fill_in 'accession_id_0_', with: ''
+end
+
+When('the user clicks on Save') do
+  click_button 'Save'
+end
+
+Then('a new accession is created') do
+  expect(find('h2').text).to eq "Accession #{@uuid} Accession"
+  expect(find('.alert.alert-success.with-hide-alert').text).to eq 'Accession created'
+
+  expect_record_to_be_in_search_results(@uuid)
+end
+
+Then('a new accession is not created') do
+  expect(find('h2').text).to eq 'New Accession Accession'
+  expect(find('.alert.alert-danger.with-hide-alert').text).to eq 'Identifier - Property is required but was missing'
+
+  expect_record_to_not_be_in_search_results(@uuid)
+end

staff-features/accessions/accession-create.rb

@@ -0,0 +1,13 @@
+Given 'the user is logged in as admin' do
+  visit STAFF_URL
+
+  fill_in "username", with: 'admin'
+  fill_in "password", with: 'admin'
+
+  click_on 'Sign In'
+
+  expect(page).to have_content 'Welcome to ArchivesSpace'
+  expect(page).to have_content 'Your friendly archives management tool.'
+  element = find('.global-header .user-container')
+  expect(element.text.strip).to eq 'admin'
+end