testcentricity 2.4.1 → 3.0.0

data/lib/testcentricity.rb

@@ -1,49 +1,14 @@
-require 'capybara/cucumber'
 require 'test/unit'
-require 'capybara/poltergeist'
+require 'appium_lib'
+require 'testcentricity_web'
 
-require 'testcentricity/world_extensions'
-require 'testcentricity/exception_queue_helper'
-require 'testcentricity/utility_helpers'
 require 'testcentricity/version'
-require 'testcentricity/browser_helper'
-
-require 'testcentricity/web_core/drag_drop_helper'
-require 'testcentricity/web_core/page_objects_helper'
-require 'testcentricity/web_core/page_sections_helper'
-require 'testcentricity/web_core/webdriver_helper'
-
-require 'testcentricity/data_objects/data_objects_helper'
 require 'testcentricity/data_objects/environment'
-require 'testcentricity/data_objects/excel_helper'
 
-require 'testcentricity/web_elements/ui_elements_helper'
-require 'testcentricity/web_elements/siebel_open_ui_helper'
-require 'testcentricity/web_elements/button'
-require 'testcentricity/web_elements/checkbox'
-require 'testcentricity/web_elements/file_field'
-require 'testcentricity/web_elements/image'
-require 'testcentricity/web_elements/label'
-require 'testcentricity/web_elements/link'
-require 'testcentricity/web_elements/radio'
-require 'testcentricity/web_elements/select_list'
-require 'testcentricity/web_elements/list'
-require 'testcentricity/web_elements/table'
-require 'testcentricity/web_elements/textfield'
-require 'testcentricity/web_elements/cell_element'
-require 'testcentricity/web_elements/cell_button'
-require 'testcentricity/web_elements/cell_checkbox'
-require 'testcentricity/web_elements/cell_radio'
-require 'testcentricity/web_elements/cell_image'
-require 'testcentricity/web_elements/list_element'
-require 'testcentricity/web_elements/list_button'
-require 'testcentricity/web_elements/list_checkbox'
-require 'testcentricity/web_elements/list_radio'
-
-require 'testcentricity/app_core/appium_server'
 require 'testcentricity/app_core/appium_connect_helper'
 require 'testcentricity/app_core/screen_objects_helper'
-require 'testcentricity/app_core/screen_sections_helper'
+require 'testcentricity/app_core/screen_object'
+require 'testcentricity/app_core/screen_section'
 
 require 'testcentricity/app_elements/app_element_helper'
 require 'testcentricity/app_elements/button'
@@ -55,93 +20,3 @@ require 'testcentricity/app_elements/list'
 require 'testcentricity/app_elements/image'
 require 'testcentricity/app_elements/select_list'
 require 'testcentricity/app_elements/alert'
-
-
-module TestCentricity
-  class PageManager
-    attr_accessor :current_page
-
-    @page_objects = {}
-
-    def self.register_page_objects(pages)
-      result = ''
-      pages.each do |page_object, page_class|
-        obj = page_class.new
-        @page_objects[page_object] = obj unless @page_objects.has_key?(page_object)
-        page_names = obj.page_name
-        page_names = Array(page_names) if page_names.is_a? String
-        page_names.each do |name|
-          page_key = name.gsub(/\s+/, '').downcase.to_sym
-          if page_key != page_object
-            @page_objects[page_key] = obj unless @page_objects.has_key?(page_key)
-          end
-          result = "#{result}def #{page_object};@#{page_object} ||= TestCentricity::PageManager.find_page(:#{page_object});end;"
-        end
-      end
-      result
-    end
-
-    # Have all PageObjects been registered?
-    #
-    # @return [Boolean] true if all PageObjects have been registered
-    # @example
-    #   TestCentricity::PageManager.loaded?
-    #
-    def self.loaded?
-      !@page_objects.empty?
-    end
-
-    def self.find_page(page_name)
-      (page_name.is_a? String) ? page_id = page_name.gsub(/\s+/, '').downcase.to_sym : page_id = page_name
-      @page_objects[page_id]
-    end
-
-    # Get the currently active PageObject
-    #
-    # @return [PageObject]
-    # @example
-    #   active_page = TestCentricity::PageManager.current_page
-    #
-    def self.current_page
-      @current_page
-    end
-
-    # Sets the currently active PageObject
-    #
-    # @param page [PageObject] Reference to the active PageObject
-    # @example
-    #   TestCentricity::PageManager.current_page = product_search_page
-    #
-    def self.current_page=(page)
-      @current_page = page
-    end
-  end
-
-
-  class DataManager
-    @data_objects = {}
-
-    def self.register_data_objects(data)
-      result = ''
-      data.each do |data_type, data_class|
-        @data_objects[data_type] = data_class.new unless @data_objects.has_key?(data_type)
-        result = "#{result}def #{data_type};@#{data_type} ||= TestCentricity::DataManager.find_data_object(:#{data_type});end;"
-      end
-      result
-    end
-
-    def self.find_data_object(data_object)
-      @data_objects[data_object]
-    end
-
-    # Have all DataObjects been registered?
-    #
-    # @return [Boolean] true if all DataObjects have been registered
-    # @example
-    #   TestCentricity::DataManager.loaded?
-    #
-    def self.loaded?
-      !@data_objects.empty?
-    end
-  end
-end

data/reports/.keep

@@ -0,0 +1 @@
+Placeholder file to allow the reports folder to be saved to repository. This folder is required for Jenkins test jobs using the Cucumber Reporting plug-in.

data/spec/fixtures/page_object.rb

@@ -0,0 +1,22 @@
+class TestPage < TestCentricity::PageObject
+  trait(:page_name)    { 'Basic Test Page' }
+  trait(:page_url)     { '/basic_test_page.html' }
+  trait(:page_locator) { 'form#HTMLFormElements' }
+
+  elements    element1: 'div#element1'
+  buttons     button1:  'button#button1'
+  textfields  field1:   'input#field1'
+  links       link1:    'a#link1'
+  ranges      range1:   'input#range1'
+  images      image1:   'img#image1'
+  radios      radio1:   'input#radio1'
+  checkboxes  check1:   'input#check1'
+  filefields  file1:    'input#file1'
+  labels      label1:   'label#label1'
+  tables      table1:   'table#table1'
+  selectlists select1:  'select#select1'
+  lists       list1:    'ul#list1'
+  videos      video1:   'video#video1'
+  audios      audio1:   'audio#audio1'
+  sections    section1: TestPageSection
+end

data/spec/fixtures/page_section_object.rb

@@ -0,0 +1,21 @@
+class TestPageSection < TestCentricity::PageSection
+  trait(:section_locator) { 'div#section' }
+  trait(:section_name)    { 'Basic Test Section' }
+
+  elements    element1: 'div#element1'
+  buttons     button1:  'button#button1'
+  textfields  field1:   'input#field1'
+  links       link1:    'a#link1'
+  ranges      range1:   'input#range1'
+  images      image1:   'img#image1'
+  radios      radio1:   'input#radio1'
+  checkboxes  check1:   'input#check1'
+  filefields  file1:    'input#file1'
+  labels      label1:   'label#label1'
+  tables      table1:   'table#table1'
+  selectlists select1:  'select#select1'
+  lists       list1:    'ul#list1'
+  videos      video1:   'video#video1'
+  audios      audio1:   'audio#audio1'
+  sections    section2: TestPageSection
+end

data/spec/fixtures/screen_object.rb

@@ -0,0 +1,16 @@
+class TestScreen < TestCentricity::ScreenObject
+  trait(:page_name)    { 'Basic Test Screen' }
+  trait(:page_locator) { { accessibility_id: 'test screen' } }
+
+  elements    element1:    { accessibility_id: 'element 1' }
+  buttons     button1:     { accessibility_id: 'button 1' }
+  textfields  field1:      { accessibility_id: 'text input 1' }
+  checkboxes  check1:      { accessibility_id: 'checkbox 1' }
+  labels      label1:      { accessibility_id: 'label 1' }
+  images      image1:      { accessibility_id: 'image 1' }
+  switches    switch1:     { accessibility_id: 'switch 1' }
+  lists       list1:       { accessibility_id: 'list 1' }
+  selectlists selectlist1: { accessibility_id: 'selectlist 1' }
+  alerts      alert1:      { accessibility_id: 'alert 1' }
+  sections    section1:    TestScreenSection
+end

data/spec/fixtures/screen_section_object.rb

@@ -0,0 +1,16 @@
+class TestScreenSection < TestCentricity::ScreenSection
+  trait(:section_locator) { { accessibility_id: 'test section' } }
+  trait(:section_name)    { 'Basic Test Section' }
+
+  elements    element1:    { accessibility_id: 'element 1' }
+  buttons     button1:     { accessibility_id: 'button 1' }
+  textfields  field1:      { accessibility_id: 'text input 1' }
+  checkboxes  check1:      { accessibility_id: 'checkbox 1' }
+  labels      label1:      { accessibility_id: 'label 1' }
+  images      image1:      { accessibility_id: 'image 1' }
+  switches    switch1:     { accessibility_id: 'switch 1' }
+  lists       list1:       { accessibility_id: 'list 1' }
+  selectlists selectlist1: { accessibility_id: 'selectlist 1' }
+  alert       :alert1,     { accessibility_id: 'alert 1' }
+  sections    section2:    TestScreenSection
+end

data/spec/spec_helper.rb

@@ -1,14 +1,33 @@
-require "bundler/setup"
-require "testcentricity"
+# frozen_string_literal: true
 
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
+require 'capybara/rspec'
+require 'require_all'
+require 'simplecov'
+require 'testcentricity'
+require 'testcentricity_web'
+
+require_rel 'fixtures'
+
+include TestCentricity
+
+SimpleCov.command_name("RSpec-#{Time.now.strftime('%Y%m%d%H%M%S')}")
 
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
+$LOAD_PATH << './lib'
 
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
+# set the default locale and auto load all translations from config/locales/*.rb,yml.
+ENV['LOCALE'] = 'en-US' unless ENV['LOCALE']
+I18n.load_path += Dir['config/locales/*.{rb,yml}']
+I18n.default_locale = 'en-US'
+I18n.locale = ENV['LOCALE']
+Faker::Config.locale = ENV['LOCALE']
+
+# prevent Test::Unit's AutoRunner from executing during RSpec's rake task
+Test::Unit.run = true if defined?(Test::Unit) && Test::Unit.respond_to?(:run=)
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.allow_message_expectations_on_nil = true
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
   end
 end

data/spec/testcentricity/elements/button_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppButton, required: true do
+  subject(:test_button) { described_class.new(:test_button, self, { accessibility_id: 'button 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_button.class).to eql TestCentricity::AppButton
+  end
+
+  it 'registers with type button' do
+    expect(test_button.get_object_type).to eql :button
+  end
+
+  it 'should click the button' do
+    expect(test_button).to receive(:click)
+    test_button.click
+  end
+end

data/spec/testcentricity/elements/checkbox_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppCheckBox, required: true do
+  subject(:test_check) { described_class.new(:test_check, self, { accessibility_id: 'check 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_check.class).to eql TestCentricity::AppCheckBox
+  end
+
+  it 'registers with type checkbox' do
+    expect(test_check.get_object_type).to eql :checkbox
+  end
+
+  it 'should check the checkbox' do
+    expect(test_check).to receive(:check)
+    test_check.check
+  end
+
+  it 'should uncheck the checkbox' do
+    expect(test_check).to receive(:uncheck)
+    test_check.uncheck
+  end
+
+  it 'should know if checkbox is checked' do
+    allow(test_check).to receive(:checked?).and_return(true)
+    expect(test_check.checked?).to eq(true)
+  end
+end

data/spec/testcentricity/elements/image_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppImage, required: true do
+  subject(:test_image) { described_class.new(:test_image, self, { accessibility_id: 'image 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_image.class).to eql TestCentricity::AppImage
+  end
+
+  it 'registers with type image' do
+    expect(test_image.get_object_type).to eql :image
+  end
+end

data/spec/testcentricity/elements/label_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppLabel, required: true do
+  subject(:test_label) { described_class.new(:test_label, self, { accessibility_id: 'label 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_label.class).to eql TestCentricity::AppLabel
+  end
+
+  it 'registers with type label' do
+    expect(test_label.get_object_type).to eql :label
+  end
+
+  it 'returns caption' do
+    allow(test_label).to receive(:caption).and_return('caption')
+    expect(test_label.caption).to eql 'caption'
+  end
+end

data/spec/testcentricity/elements/list_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppList, required: true do
+  subject(:test_list) { described_class.new(:test_list, self, { accessibility_id: 'list 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_list.class).to eql TestCentricity::AppList
+  end
+
+  it 'registers with type list' do
+    expect(test_list.get_object_type).to eql :list
+  end
+end

data/spec/testcentricity/elements/ui_element_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppUIElement, required: true do
+  subject(:test_element) { described_class.new(:test_element, self, { accessibility_id: 'element 1' }, :page) }
+
+  it 'returns class' do
+    expect(test_element.class).to eql described_class
+  end
+
+  it 'returns name' do
+    expect(test_element.get_name).to eql :test_element
+  end
+
+  it 'returns locator' do
+    expect(test_element.get_locator).to eql({ accessibility_id: 'element 1'})
+  end
+
+  it 'should click the element' do
+    allow(test_element).to receive(:click)
+    test_element.click
+  end
+
+  it 'should tap the element' do
+    allow(test_element).to receive(:tap)
+    test_element.tap
+  end
+
+  it 'should double tap the element' do
+    allow(test_element).to receive(:double_tap)
+    test_element.double_tap
+  end
+
+  it 'should know if element is visible' do
+    allow(test_element).to receive(:visible?).and_return(false)
+    expect(test_element.visible?).to eq(false)
+  end
+
+  it 'should know if element is hidden' do
+    allow(test_element).to receive(:hidden?).and_return(true)
+    expect(test_element.hidden?).to eq(true)
+  end
+
+  it 'should know if element exists' do
+    allow(test_element).to receive(:exists?).and_return(true)
+    expect(test_element.exists?).to be true
+  end
+
+  it 'should know if element is enabled' do
+    allow(test_element).to receive(:enabled?).and_return(true)
+    expect(test_element.enabled?).to eq(true)
+  end
+
+  it 'should know if element is disabled' do
+    allow(test_element).to receive(:disabled?).and_return(true)
+    expect(test_element.disabled?).to eq(true)
+  end
+
+  it 'should know if element is selected' do
+    allow(test_element).to receive(:selected?).and_return(true)
+    expect(test_element.selected?).to eq(true)
+  end
+
+  it 'returns value' do
+    allow(test_element).to receive(:value).and_return('value')
+    expect(test_element.value).to eql 'value'
+  end
+
+  it 'should send keys' do
+    allow(test_element).to receive(:send_keys).with('foo bar')
+    test_element.send_keys('foo bar')
+  end
+end

data/spec/testcentricity/mobile/appium_connect_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+describe TestCentricity::AppiumConnect, required: true do
+  before(:context) do
+    # instantiate local test environment
+    @environs ||= EnvironData
+    @environs.find_environ('LOCAL', :yaml)
+    ENV['SELENIUM'] = ''
+    ENV['WEB_BROWSER'] = 'appium'
+    ENV['DEVICE_TYPE'] = 'phone'
+    ENV['LOCALE'] = 'en-US'
+    ENV['LANGUAGE'] = 'en'
+    # start Appium server
+    $server = TestCentricity::AppiumServer.new
+    $server.start
+  end
+
+  context 'Mobile device simulator' do
+    it 'connects to iOS Simulator using environment variables' do
+      ENV['AUTOMATION_ENGINE'] = 'XCUITest'
+      ENV['APP_PLATFORM_NAME'] = 'ios'
+      ENV['APP_VERSION'] = '15.4'
+      ENV['APP_DEVICE'] = 'iPhone 13 Pro Max'
+      ENV['APP'] = Environ.current.ios_app_path
+      AppiumConnect.initialize_appium
+      AppiumConnect.start_driver
+      expect(Environ.browser).to eq(:appium)
+      expect(Environ.platform).to eq(:mobile)
+      expect(Environ.driver).to eq(:appium)
+      expect(Environ.device).to eq(:simulator)
+      expect(Environ.device_name).to eq('iPhone 13 Pro Max')
+      expect(Environ.device_os).to eq(:ios)
+      expect(Environ.device_type).to eq(:phone)
+      expect(Environ.device_os_version).to eq('15.4')
+      expect(Environ.is_ios?).to eq(true)
+    end
+
+    it 'connects to iOS Simulator using desired_capabilities hash' do
+      ENV['APP_PLATFORM_NAME'] = 'ios'
+      ENV['APP_VERSION'] = '15.4'
+      ENV['APP_DEVICE'] = 'iPhone 13 Pro Max'
+
+      capabilities = {
+        platformName: 'ios',
+        platformVersion: '15.4',
+        deviceName: 'iPhone 13 Pro Max',
+        automationName: 'XCUITest',
+        app: Environ.current.ios_app_path
+      }
+      AppiumConnect.initialize_appium(capabilities)
+      AppiumConnect.start_driver
+      expect(Environ.browser).to eq(:appium)
+      expect(Environ.platform).to eq(:mobile)
+      expect(Environ.driver).to eq(:appium)
+      expect(Environ.device).to eq(:simulator)
+      expect(Environ.device_name).to eq('iPhone 13 Pro Max')
+      expect(Environ.device_os).to eq(:ios)
+      expect(Environ.device_type).to eq(:phone)
+      expect(Environ.device_os_version).to eq('15.4')
+      expect(Environ.is_ios?).to eq(true)
+    end
+
+    it 'connects to Android Simulator using environment variables' do
+      ENV['AUTOMATION_ENGINE'] = 'UiAutomator2'
+      ENV['APP_PLATFORM_NAME'] = 'Android'
+      ENV['APP_VERSION'] = '12.0'
+      ENV['APP_DEVICE'] = 'Pixel_5_API_31'
+      ENV['APP'] = Environ.current.android_apk_path
+      AppiumConnect.initialize_appium
+      AppiumConnect.start_driver
+      expect(Environ.browser).to eq(:appium)
+      expect(Environ.platform).to eq(:mobile)
+      expect(Environ.driver).to eq(:appium)
+      expect(Environ.device).to eq(:simulator)
+      expect(Environ.device_name).to eq('Pixel_5_API_31')
+      expect(Environ.device_os).to eq(:android)
+      expect(Environ.device_type).to eq(:phone)
+      expect(Environ.device_os_version).to eq('12.0')
+      expect(Environ.is_android?).to eq(true)
+    end
+
+    it 'connects to Android Simulator using desired_capabilities hash' do
+      ENV['APP_PLATFORM_NAME'] = 'Android'
+      ENV['APP_VERSION'] = '12.0'
+      ENV['APP_DEVICE'] = 'Pixel_5_API_31'
+
+      capabilities = {
+        platformName: 'Android',
+        platformVersion: '12.0',
+        deviceName: 'Pixel_5_API_31',
+        automationName: 'UiAutomator2',
+        avd: 'Pixel_5_API_31',
+        app: Environ.current.android_apk_path
+      }
+      AppiumConnect.initialize_appium(capabilities)
+      AppiumConnect.start_driver
+      expect(Environ.browser).to eq(:appium)
+      expect(Environ.platform).to eq(:mobile)
+      expect(Environ.driver).to eq(:appium)
+      expect(Environ.device).to eq(:simulator)
+      expect(Environ.device_name).to eq('Pixel_5_API_31')
+      expect(Environ.device_os).to eq(:android)
+      expect(Environ.device_type).to eq(:phone)
+      expect(Environ.device_os_version).to eq('12.0')
+      expect(Environ.is_android?).to eq(true)
+    end
+  end
+
+  after(:each) do
+    AppiumConnect.quit_driver
+    Environ.session_state = :quit
+  end
+
+  after(:context) do
+    $server.stop if Environ.driver == :appium && $server.running?
+  end
+end

data/spec/testcentricity/mobile/screen_object_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+describe TestCentricity::ScreenObject, required: true do
+  before :context do
+    @test_screen = TestScreen.new
+  end
+
+  context 'screen object traits' do
+    it 'returns page name' do
+      expect(@test_screen.page_name).to eq('Basic Test Screen')
+    end
+
+    it 'returns page locator' do
+      expect(@test_screen.page_locator).to eq({ accessibility_id: 'test screen' })
+    end
+
+    it 'responds to open_portal' do
+      expect(@test_screen).to respond_to(:open_portal)
+    end
+
+    it 'responds to load_page' do
+      expect(@test_screen).to respond_to(:load_page)
+    end
+
+    it 'responds to verify_page_exists' do
+      expect(@test_screen).to respond_to(:verify_page_exists)
+    end
+
+    it 'responds to exists?' do
+      expect(@test_screen).to respond_to(:exists?)
+    end
+  end
+
+  context 'page object with UI elements' do
+    it 'responds to element' do
+      expect(@test_screen).to respond_to(:element1)
+    end
+
+    it 'responds to button' do
+      expect(@test_screen).to respond_to(:button1)
+    end
+
+    it 'responds to textfield' do
+      expect(@test_screen).to respond_to(:field1)
+    end
+
+    it 'responds to image' do
+      expect(@test_screen).to respond_to(:image1)
+    end
+
+    it 'responds to switch' do
+      expect(@test_screen).to respond_to(:switch1)
+    end
+
+    it 'responds to checkbox' do
+      expect(@test_screen).to respond_to(:check1)
+    end
+
+    it 'responds to section' do
+      expect(@test_screen).to respond_to(:section1)
+    end
+  end
+end

data/spec/testcentricity/mobile/screen_section_object_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+describe TestCentricity::ScreenSection, required: true do
+  before :context do
+    @test_page = TestScreen.new
+    @test_section = @test_page.section1
+  end
+
+  context 'section object traits' do
+    it 'returns section name' do
+      expect(@test_section.section_name).to eq('Basic Test Section')
+    end
+
+    it 'returns section locator' do
+      expect(@test_section.get_locator).to eq([{ accessibility_id: 'test section' }])
+    end
+
+    it 'returns class' do
+      expect(@test_section.class).to eql TestScreenSection
+    end
+
+    it 'registers with type section' do
+      expect(@test_section.get_object_type).to eql :section
+    end
+  end
+
+  context 'section object with UI elements' do
+    it 'responds to element' do
+      expect(@test_section).to respond_to(:element1)
+    end
+
+    it 'responds to button' do
+      expect(@test_section).to respond_to(:button1)
+    end
+
+    it 'responds to textfield' do
+      expect(@test_section).to respond_to(:field1)
+    end
+
+    it 'responds to image' do
+      expect(@test_section).to respond_to(:image1)
+    end
+
+    it 'responds to switch' do
+      expect(@test_section).to respond_to(:switch1)
+    end
+
+    it 'responds to checkbox' do
+      expect(@test_section).to respond_to(:check1)
+    end
+
+    it 'responds to section' do
+      expect(@test_section).to respond_to(:section2)
+    end
+  end
+end