testcentricity_web 4.1.5 → 4.1.6

data/features/support/hooks.rb

@@ -0,0 +1,245 @@
+
+BeforeAll do
+  # start Appium Server if command line option was specified and target browser is mobile simulator or device
+  if ENV['APPIUM_SERVER'] == 'run' && Environ.driver == :appium
+    $server = TestCentricity::AppiumServer.new
+    $server.start
+  end
+end
+
+
+AfterAll do
+  # terminate Appium Server if command line option was specified and target browser is mobile simulator or device
+  if ENV['APPIUM_SERVER'] == 'run' && Environ.driver == :appium && $server.running?
+    $server.stop
+  end
+  # close driver
+  terminate_session
+end
+
+
+Before do |scenario|
+  # if executing tests in parallel concurrent threads, print thread number with scenario name
+  message = Environ.parallel ? "Thread ##{Environ.process_num} | Scenario:  #{scenario.name}" : "Scenario:  #{scenario.name}"
+  log message
+  $initialized ||= false
+  unless $initialized
+    $initialized = true
+    $test_start_time = Time.now
+    # HTML report header information if reporting is enabled
+    log Environ.report_header if ENV['REPORTING']
+  end
+end
+
+
+After do |scenario|
+  # process and embed any screenshots recorded during execution of scenario
+  process_embed_screenshots(scenario)
+  # clear out any queued screenshots
+  Environ.reset_contexts
+  # close any external pages that may have been opened
+  if Environ.external_page
+    Browsers.close_current_browser_instance
+    begin
+      page.driver.browser.switch_to.alert.accept
+      Browsers.switch_to_new_browser_instance
+    rescue
+    end
+    Environ.set_external_page(false)
+  end
+  # block any JavaScript modals that may appear as a result of ending the session
+  Browsers.suppress_js_leave_page_modal
+  # close Capybara Appium driver if it was opened
+  Capybara.page.driver.quit if Capybara.default_driver == :appium
+
+  if ENV['QUIT_DRIVER']
+    terminate_session
+  elsif Environ.grid == :browserstack
+    # restart BrowserStack test sessions if test duration exceeds 110 minutes to avoid the 2 hour test limit
+    test_elapsed_time = Time.now - $test_start_time
+    if test_elapsed_time > 6600
+      terminate_session
+      log 'Restarting BrowserStack test session'
+      $test_start_time = Time.now
+    else
+      Capybara.reset_sessions!
+    end
+  end
+end
+
+
+# exclusionary Around hooks to prevent running feature/scenario on unsupported browsers, devices, or
+# cloud remote browser hosting platforms. Use the following tags to block test execution:
+#   desktop web browsers:      @!safari, @!ie, @!firefox, @!chrome, @!edge
+#   mobile devices:            @!ipad, @!iphone
+#   remotely hosted browsers:  @!browserstack, @!saucelabs
+
+# block feature/scenario execution if running against Safari browser
+Around('@!safari') do |scenario, block|
+  qualify_browser(:safari, 'Safari', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Internet Explorer browser
+Around('@!ie') do |scenario, block|
+  qualify_browser(:ie, 'Internet Explorer', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Microsoft Edge browser
+Around('@!edge') do |scenario, block|
+  qualify_browser(:edge, 'Edge', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Chrome browser
+Around('@!chrome') do |scenario, block|
+  qualify_browser(:chrome, 'Chrome', scenario, block)
+end
+
+
+# block feature/scenario execution if running against Firefox browser
+Around('@!firefox') do |scenario, block|
+  qualify_browser(:firefox, 'Firefox', scenario, block)
+end
+
+
+# block feature/scenario execution if running against iPad mobile browser
+Around('@!ipad') do |scenario, block|
+  qualify_device('ipad', scenario, block)
+end
+
+
+# block feature/scenario execution if running against iPhone mobile browser
+Around('@!iphone') do |scenario, block|
+  qualify_device('iphone', scenario, block)
+end
+
+
+# block feature/scenario execution if running on Selenium Grid or cloud-hosted services
+Around('@!grid') do |scenario, block|
+  if !Environ.grid
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on Selenium Grid or cloud-hosted services."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against Browserstack cloud-hosted service
+Around('@!browserstack') do |scenario, block|
+  if Environ.grid != :browserstack
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on the BrowserStack service."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against Sauce Labs cloud-hosted service
+Around('@!saucelabs') do |scenario, block|
+  if Environ.grid != :saucelabs
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed on the SauceLabs service."
+    skip_this_scenario
+  end
+end
+
+
+# block feature/scenario execution if running against a physical or emulated mobile device
+Around('@!device') do |scenario, block|
+  if Environ.is_device?
+    log "Scenario '#{scenario.name}' cannot be executed on physical or emulated devices."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+Around('@!ios') do |scenario, block|
+  if Environ.device_os == :android
+    block.call
+  else
+    log "Scenario '#{scenario.name}' can not be executed on iOS devices."
+    skip_this_scenario
+  end
+end
+
+
+Around('@!android') do |scenario, block|
+  if Environ.device_os == :ios
+    block.call
+  else
+    log "Scenario '#{scenario.name}' can not be executed on Android devices."
+    skip_this_scenario
+  end
+end
+
+
+Around('@!mobile') do |scenario, block|
+  if Environ.platform == :mobile
+    log "Scenario '#{scenario.name}' can not be executed on mobile devices or simulators."
+    skip_this_scenario
+  else
+    block.call
+  end
+end
+
+
+# supporting methods
+
+def qualify_browser(browser_type, browser_name, scenario, block)
+  if Environ.browser != browser_type && ENV['HOST_BROWSER'] != browser_name.downcase
+    block.call
+  else
+    log "Scenario '#{scenario.name}' cannot be executed with the #{browser_name} browser."
+    skip_this_scenario
+  end
+end
+
+def qualify_device(device, scenario, block)
+  if Environ.is_device?
+    if Environ.device_type.include? device
+      log "Scenario '#{scenario.name}' cannot be executed on #{device} devices."
+      skip_this_scenario
+    else
+      block.call
+    end
+  else
+    block.call
+  end
+end
+
+def terminate_session
+  Capybara.page.driver.quit
+  Capybara.reset_sessions!
+  Environ.session_state = :quit
+  $driver_scenario_count = 0
+end
+
+def screen_shot_and_save_page(scenario)
+  timestamp = Time.now.strftime('%Y%m%d%H%M%S%L')
+  filename = scenario.nil? ? "Screenshot-#{timestamp}.png" : "Screenshot-#{scenario.__id__}-#{timestamp}.png"
+  path = File.join Dir.pwd, 'reports/screenshots/', filename
+  save_screenshot path
+  log "Screenshot saved at #{path}"
+  screen_shot = { path: path, filename: filename }
+  Environ.save_screen_shot(screen_shot)
+  attach(path, 'image/png') unless scenario.nil?
+end
+
+def process_embed_screenshots(scenario)
+  screen_shots = Environ.get_screen_shots
+  if screen_shots.count > 0
+    screen_shots.each do |row|
+      path = row[:path]
+      attach(path, 'image/png')
+    end
+  else
+    screen_shot_and_save_page(scenario) if scenario.failed?
+  end
+end

data/features/support/pages/basic_css_test_page.rb

@@ -0,0 +1,49 @@
+# Page Object class definition for Basic HTML Test page with CSS locators
+
+class BasicCSSTestPage < BasicTestPage
+  trait(:page_name)    { 'Basic CSS Test' }
+  trait(:page_locator) { 'form#HTMLFormElements' }
+
+  # Basic HTML Test page UI elements
+  textfields  username_field:    'input#username',
+              password_field:    'input#password',
+              max_length_field:  'input#maxlength',
+              read_only_field:   'input#readonly',
+              number_field:      'input#number-field',
+              color_picker:      'input#color-picker',
+              comments_field:    'textarea#comments'
+  range       :slider,           'input#slider'
+  filefield   :upload_file,      'input#filename'
+  checkboxes  check_1:           'input#check1',
+              check_2:           'input#check2',
+              check_3:           'input#check3',
+              check_4:           'input#check4'
+  radios      radio_1:           'input#radio1',
+              radio_2:           'input#radio2',
+              radio_3:           'input#radio3',
+              radio_4:           'input#radio4'
+  selectlists multi_select:      'select#multipleselect',
+              drop_down_select:  'select#dropdown'
+  table       :static_table,     'table#table'
+  images      image_1:           'img#image1',
+              image_2:           'img#image2',
+              image_3:           'img#image3'
+  buttons     cancel_button:     'input#cancel',
+              submit_button:     'input#submit'
+  labels      header_label:      'h1',
+              username_label:    "label[for='username']",
+              password_label:    "label[for='password']",
+              max_length_label:  "label[for='maxlength']",
+              read_only_label:   "label[for='readonly']",
+              number_label:      "label[for='number-field']",
+              color_label:       "label[for='color-picker']",
+              slider_label:      "label[for='slider']",
+              comments_label:    "label[for='comments']",
+              filename_label:    "label[for='filename']",
+              checkboxes_label:  'label#checkboxes',
+              radios_label:      'label#radios',
+              multiselect_label: "label[for='multipleselect']",
+              dropdown_label:    "label[for='dropdown']",
+              table_label:       "label[for='table']",
+              images_label:      'label#images'
+end

data/features/support/pages/basic_test_page.rb

@@ -0,0 +1,238 @@
+# Page Object class definition for Basic HTML Test page
+
+class BasicTestPage < TestCentricity::PageObject
+  trait(:page_url)         { '/basic_test_page.html' }
+  trait(:tab_order)        {
+    [
+      username_field,
+      password_field,
+      max_length_field,
+      read_only_field,
+      number_field,
+      color_picker,
+      slider,
+      comments_field,
+      upload_file,
+      check_1,
+      check_2,
+      check_3,
+      radio_1,
+      [
+        radio_2,
+        radio_3
+      ],
+      multi_select,
+      drop_down_select,
+      cancel_button,
+      submit_button
+    ]
+  }
+  trait(:safari_tab_order) {
+    [
+      username_field,
+      password_field,
+      max_length_field,
+      read_only_field,
+      number_field,
+      comments_field,
+      multi_select,
+      drop_down_select
+    ]
+  }
+
+  def verify_page_ui
+    ui = {
+      self              => { exists: true, secure: false, title: 'Basic HTML Form' },
+      header_label      => { visible: true, caption: 'Basic HTML Form Example' },
+      username_label    => { visible: true, caption: 'Username:' },
+      username_field    => { visible: true, enabled: true, required: true, value: '', placeholder: 'User name' },
+      password_label    => { visible: true, caption: 'Password:' },
+      password_field    => { visible: true, enabled: true, required: true, value: '', placeholder: 'Password' },
+      max_length_label  => { visible: true, caption: 'Max Length:' },
+      max_length_field  => {
+        visible: true,
+        enabled: true,
+        placeholder: 'up to 64 characters',
+        value: '',
+        maxlength: 64
+      },
+      read_only_label   => { visible: true, caption: 'Read Only:' },
+      read_only_field   => {
+        visible: true,
+        enabled: true,
+        readonly: true,
+        value: 'I am a read only text field'
+      },
+      number_label      => { visible: true, caption: 'Number:' },
+      number_field      => {
+        visible: true,
+        enabled: true,
+        value: '41',
+        min: 10,
+        max: 1024,
+        step: 1
+      },
+      color_label       => { visible: true, caption: 'Color:' },
+      color_picker      => { visible: true, enabled: true, value: '#000000' },
+      slider_label      => { visible: true, caption: 'Range:' },
+      slider            => {
+        visible: true,
+        enabled: true,
+        value: 25,
+        min: 0,
+        max: 50,
+      },
+      comments_label    => { visible: true, caption: 'TextArea:' },
+      comments_field    => { visible: true, enabled: true, value: '' },
+      filename_label    => { visible: true, caption: 'Filename:' },
+      upload_file       => { visible: true, enabled: true, value: '' },
+      checkboxes_label  => { visible: true, caption: 'Checkbox Items:' },
+      check_1           => { visible: true, enabled: true, checked: false },
+      check_2           => { visible: true, enabled: true, checked: false },
+      check_3           => { visible: true, enabled: true, checked: false },
+      check_4           => { visible: true, enabled: false, checked: false },
+      radios_label      => { visible: true, caption: 'Radio Items:' },
+      radio_1           => { visible: true, enabled: true, selected: false },
+      radio_2           => { visible: true, enabled: true, selected: false },
+      radio_3           => { visible: true, enabled: true, selected: false },
+      radio_4           => { visible: true, enabled: false, selected: false },
+      multiselect_label => { visible: true, caption: 'Multiple Select Values:' },
+      multi_select      => {
+        visible: true,
+        enabled: true,
+        optioncount: 4,
+        options: ['Selection Item 1', 'Selection Item 2', 'Selection Item 3', 'Selection Item 4'],
+        selected: ''
+      },
+      dropdown_label    => { visible: true, caption: 'Dropdown:' },
+      drop_down_select  => {
+        visible: true,
+        enabled: true,
+        optioncount: 6,
+        options: ['Drop Down Item 1', 'Drop Down Item 2', 'Drop Down Item 3', 'Drop Down Item 4', 'Drop Down Item 5', 'Drop Down Item 6'],
+        selected: 'Drop Down Item 1'
+      },
+      table_label       => { visible: true, caption: 'Table:' },
+      static_table      => {
+        visible: true,
+        columncount: 3,
+        rowcount: 4,
+        column_headers: %w[Company Contact Country],
+        { row: 1 } => [['Alfreds Futterkiste', 'Maria Anders', 'Germany']],
+        { row: 2 } => [['Centro comercial Moctezuma', 'Francisco Chang', 'Mexico']],
+        { row: 3 } => [['Ernst Handel', 'Roland Mendel', 'Austria']],
+        { row: 4 } => [['Island Trading', 'Helen Bennett', 'UK']]
+      },
+      images_label      => { visible: true, caption: 'Images:' },
+      image_1           => {
+        visible: true,
+        broken: false,
+        src: { ends_with: 'images/Wilder.jpg' },
+        alt: "It's alive"
+      },
+      image_2           => {
+        visible: true,
+        broken: false,
+        src: { ends_with: 'images/You_Betcha.jpg' },
+        alt: 'You Betcha'
+      },
+      image_3           => {
+        visible: true,
+        broken: true,
+        src: { ends_with: 'wrongname.gif' },
+        alt: 'A broken image'
+      },
+      cancel_button     => { visible: true, enabled: true, caption: 'Cancel' },
+      submit_button     => { visible: true, enabled: true, caption: 'Submit' }
+    }
+    verify_ui_states(ui)
+  end
+
+  def form_data
+    file_path = Environ.platform == :mobile ? nil : "#{Dir.pwd}/test_site/images/Wilder.jpg"
+    {
+      username:     Faker::Name.name,
+      password:     'T0p_Sekrit',
+      maxlength:    Faker::Marketing.buzzwords,
+      number:       Faker::Number.between(from: 10, to: 1024),
+      color:        Faker::Color.hex_color,
+      slider:       45,
+      comments:     Faker::Hipster.paragraph,
+      filepath:     file_path,
+      filename:     "Wilder.jpg",
+      check1:       true,
+      check2:       true,
+      check3:       false,
+      radio1:       true,
+      radio2:       false,
+      radio3:       false,
+      multi_select: 'Selection Item 2',
+      drop_select:  'Drop Down Item 5'
+    }
+  end
+
+  def populate_form
+    @data = form_data
+    fields = {
+      username_field   => @data[:username],
+      password_field   => @data[:password],
+      max_length_field => @data[:maxlength],
+      number_field     => @data[:number],
+      color_picker     => @data[:color],
+      slider           => @data[:slider],
+      comments_field   => @data[:comments],
+      upload_file      => @data[:filepath],
+      check_1          => @data[:check1],
+      check_2          => @data[:check2],
+      check_3          => @data[:check3],
+      radio_1          => @data[:radio1],
+      radio_2          => @data[:radio2],
+      radio_3          => @data[:radio3],
+      multi_select     => @data[:multi_select],
+      drop_down_select => @data[:drop_select]
+    }
+    populate_data_fields(fields)
+  end
+
+  def verify_form_data
+    ui = {
+      username_field   => { value: @data[:username] },
+      password_field   => { value: @data[:password] },
+      max_length_field => { value: @data[:maxlength] },
+      number_field     => { value: @data[:number].to_s },
+      color_picker     => { value: @data[:color] },
+      slider           => { value: @data[:slider] },
+      comments_field   => { value: @data[:comments] },
+      upload_file      => { value: { ends_with: @data[:filename] } },
+      check_1          => { checked: @data[:check1] },
+      check_2          => { checked: @data[:check2] },
+      check_3          => { checked: @data[:check3] },
+      radio_1          => { selected: @data[:radio1] },
+      radio_2          => { selected: @data[:radio2] },
+      radio_3          => { selected: @data[:radio3] },
+      multi_select     => { selected: @data[:multi_select] },
+      drop_down_select => { selected: @data[:drop_select] }
+    }
+    verify_ui_states(ui)
+  end
+
+  def perform_action(action)
+    case action
+    when :submit
+      submit_button.click
+    when :cancel
+      cancel_button.click
+    else
+      raise "#{action} is not a valid selector"
+    end
+  end
+
+  def verify_tab_order
+    order = if Environ.browser == :safari
+              safari_tab_order
+            else
+              tab_order
+            end
+    verify_focus_order(order)
+  end
+end

data/features/support/pages/basic_xpath_test_page.rb

@@ -0,0 +1,49 @@
+# Page Object class definition for Basic HTML Test page with Xpath locators
+
+class BasicXpathTestPage < BasicTestPage
+  trait(:page_name)    { 'Basic Xpath Test' }
+  trait(:page_locator) { "//form[@id='HTMLFormElements']" }
+
+  # Basic HTML Test page UI elements
+  textfields  username_field:    "//input[@id='username']",
+              password_field:    "//input[@id='password']",
+              max_length_field:  "//input[@id='maxlength']",
+              read_only_field:   "//input[@id='readonly']",
+              number_field:      "//input[@id='number-field']",
+              comments_field:    "//textarea[@id='comments']",
+              color_picker:      "//input[@id='color-picker']"
+  range       :slider,           "//input[@id='slider']"
+  filefield   :upload_file,      "//input[@id='filename']"
+  checkboxes  check_1:           "//input[@id='check1']",
+              check_2:           "//input[@id='check2']",
+              check_3:           "//input[@id='check3']",
+              check_4:           "//input[@id='check4']"
+  radios      radio_1:           "//input[@id='radio1']",
+              radio_2:           "//input[@id='radio2']",
+              radio_3:           "//input[@id='radio3']",
+              radio_4:           "//input[@id='radio4']"
+  selectlists multi_select:      "//select[@id='multipleselect']",
+              drop_down_select:  "//select[@id='dropdown']"
+  table       :static_table,     "//table[@id='table']"
+  images      image_1:           "//img[@id='image1']",
+              image_2:           "//img[@id='image2']",
+              image_3:           "//img[@id='image3']"
+  buttons     cancel_button:     "//input[@id='cancel']",
+              submit_button:     "//input[@id='submit']"
+  labels      header_label:      '//h1',
+              username_label:    "//label[@for='username']",
+              password_label:    "//label[@for='password']",
+              max_length_label:  "//label[@for='maxlength']",
+              read_only_label:   "//label[@for='readonly']",
+              number_label:      "//label[@for='number-field']",
+              color_label:       "//label[@for='color-picker']",
+              slider_label:      "//label[@for='slider']",
+              comments_label:    "//label[@for='comments']",
+              filename_label:    "//label[@for='filename']",
+              checkboxes_label:  "//label[@id='checkboxes']",
+              radios_label:      "//label[@id='radios']",
+              multiselect_label: "//label[@for='multipleselect']",
+              dropdown_label:    "//label[@for='dropdown']",
+              table_label:       "//label[@for='table']",
+              images_label:      "//label[@id='images']"
+end

data/features/support/pages/media_page.rb

@@ -0,0 +1,11 @@
+# Page Object class definition for Media Test page with CSS locators
+
+class MediaTestPage < TestCentricity::PageObject
+  trait(:page_name)    { 'Media Test' }
+  trait(:page_locator) { 'div.media-page-body' }
+  trait(:page_url)     { '/media_page.html' }
+
+  # Media Test page UI elements
+  video :video_player, 'video#video_player'
+  audio :audio_player, 'audio#audio_player'
+end

data/features/support/world_pages.rb

@@ -0,0 +1,15 @@
+module WorldPages
+  #
+  #  page_objects method returns a hash table of your web app's page objects and associated page classes to be instantiated
+  # by the TestCentricity™ PageManager. Page Object class definitions are contained in the features/support/pages folder.
+  #
+  def page_objects
+    {
+      basic_css_test_page:   BasicCSSTestPage,
+      basic_xpath_test_page: BasicXpathTestPage,
+    }
+  end
+end
+
+
+World(WorldPages)

data/lib/testcentricity_web/data_objects/environment.rb

@@ -328,6 +328,10 @@ module TestCentricity
       @platform = platform
     end
 
+    def self.platform
+      @platform
+    end
+
     def self.is_mobile?
       @platform == :mobile
     end

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.1.5'
+  VERSION = '4.1.6'
 end

data/lib/testcentricity_web/web_core/page_object.rb

@@ -1,5 +1,9 @@
 module TestCentricity
   class PageObject < BasePageSectionObject
+    def initialize
+      set_locator_type(page_locator) if defined?(page_locator)
+    end
+
     # Declare and instantiate a single generic UI Element for this page object.
     #
     # @param element_name [Symbol] name of UI object (as a symbol)
@@ -310,17 +314,20 @@ module TestCentricity
     def open_portal
       environment = Environ.current
       url = environment.hostname.blank? ? "#{environment.base_url}#{environment.append}" : "#{environment.hostname}/#{environment.base_url}#{environment.append}"
-      if environment.user_id.blank? || environment.password.blank?
-        visit "#{environment.protocol}://#{url}"
-      else
-        visit "#{environment.protocol}://#{environment.user_id}:#{environment.password}@#{url}"
-      end
+      full_url = if environment.user_id.blank? || environment.password.blank?
+                   "#{environment.protocol}://#{url}"
+                 else
+                   "#{environment.protocol}://#{environment.user_id}:#{environment.password}@#{url}"
+                 end
+      visit full_url
       Environ.portal_state = :open
     end
 
     def verify_page_exists
       raise "Page object #{self.class.name} does not have a page_locator trait defined" unless defined?(page_locator)
-      unless page.has_selector?(page_locator)
+
+      set_locator_type(page_locator) if @locator_type.blank?
+      unless page.has_selector?(@locator_type, page_locator)
         body_class = find(:xpath, '//body')[:class]
         error_message = %(
           Expected page to have selector '#{page_locator}' but found '#{body_class}' instead.