leap_salesforce_ui 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3481b31ac19a98f7d9fe40b017f0d9d2d047a50a891ed20e079aaee480c0c623
-  data.tar.gz: 72ec8083bcfe9155f7e631fd5354c9d8388104bf9007985440a2518e902576f8
+  metadata.gz: 526d7426b4cbc68a811661af10184c81150a07d5b9f7441909758a84a6ff6353
+  data.tar.gz: '0248a74aeaf95af16ac34ffecac449710687283b3b27bedef3bb0814e4d95106'
 SHA512:
-  metadata.gz: 34b181f68921877a0e0afe55fd9e4ce91f3273323065c034f8dd63e0e0b85341e1ca27187b6f8e773e25816935615c6e33baf7aab262cf65244eebfdc217de2b
-  data.tar.gz: 9d7d119547de5453559936160ecc520e6d0db99620050c38b6297998b3f99e3e5938bb6875621bc2cdbee698c2d6e1f817743291fa15fb6c08a1435be39d2cd6
+  metadata.gz: 829da20fbece1a80e9e01e099d6bbdaf1d1f949670c9e91ac09d37154dd194c62fe91e9a5dd65586dc53a1597e80a3a2e0d9aa6b6fead07d61aa32cc0b051a76
+  data.tar.gz: 0612cb14198ae7ec1cd0200ec952661346262aefab0c746f4e4fb3ded1a4d7269bb1c925bf593ab3280dfc7c37f4ce5a261b8585f4dd11119ddc514b84602272

data/.leap_salesforce.yml

@@ -4,3 +4,4 @@ sfdx: false
 soql_objects:
   - Contact
   - Account
+  - Broker: Broker__c

data/ChangeLog

@@ -1,3 +1,11 @@
+Version 0.1.5
+* Enhancements
+  * Added logging of actions
+  * Allow headless mode with LeapSalesforce.headless = true
+  * Throw custom errors when problem occurs setting fields
+* Bug fix
+  * Didn't handle where class name and backend name differ
+
 Version 0.1.4
 * Enhancements
   * Add executable to make it fast to setup testing with exe `leap_salesforce_ui init`

data/lib/leap_salesforce_ui.rb

@@ -4,6 +4,7 @@ require "watir"
 require "webdrivers"
 require "leap_salesforce"
 require_relative "leap_salesforce_ui/version"
+require_relative "leap_salesforce_ui/error"
 require_relative "leap_salesforce_ui/base_page"
 require_relative "leap_salesforce_ui/page_introspection"
 require_relative "leap_salesforce_ui/form_filler"
@@ -32,6 +33,8 @@ end
 module LeapSalesforce
   # @return [String] User for UI
   @ui_user = nil
+  # @return [Boolean] Whether to run in headless mode
+  @headless = false
   class << self
     def browser(test_name = nil)
       @browser ||= new_browser(test_name)
@@ -42,8 +45,12 @@ module LeapSalesforce
       @browser = nil
     end
 
+    # @return [String] User used for UI tests
     attr_reader :ui_user
 
+    # @return [Boolean] Whether to run in headless mode. Default false
+    attr_accessor :headless
+
     # @param [String, Symbol, Regexp, LeapSalesforce::User] user User or email address of user
     def ui_user=(user)
       @ui_user = if user.is_a? String
@@ -61,7 +68,9 @@ module LeapSalesforce
         # TODO: Get working on Ruby 3
         Watir::Browser.new :chrome, { **zalenium_args("LeapSalesforce", test_name || "Test") }
       else
-        Watir::Browser.new
+        args = {}
+        args[:headless] = true if headless
+        Watir::Browser.new :chrome, args
       end
     end
   end

data/lib/leap_salesforce_ui/base_page.rb

@@ -8,13 +8,17 @@ module BasePage
     LeapSalesforce.browser
   end
 
+  # Set entity this page object refers to
+  # @param [Class] soql_object Backend name of SoqlObject this page object refers to
   def soql_object(soql_object)
     @soql_object = soql_object
   end
 
+  # Visit the current page, logging in if required
   def visit
     LoginPage.login
-    page_url = "#{SoqlHandler.instance_url}/lightning/o/#{@soql_object}/new"
+    page_url = "#{SoqlHandler.instance_url}/lightning/o/#{@soql_object.soql_object_name}/new"
+    LeapSalesforce.logger.info "Visiting #{self}"
     browser.goto page_url
     self
   end

data/lib/leap_salesforce_ui/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LeapSalesforce
+  # Error related to submitting a form
+  class SubmitError < Error; end
+
+  # Error related to setting a field
+  class SetFieldError < Error; end
+end

data/lib/leap_salesforce_ui/form_filler.rb

@@ -2,7 +2,8 @@
 
 module LeapSalesforce
   module FormFiller
-    def new_panel
+    # @return [Watir::Elements::Div] Div where form entered to create/edit entity
+    def form
       browser.div(class: "inlinePanel")
     end
 
@@ -27,7 +28,8 @@ module LeapSalesforce
     end
 
     # Based on data type of field passed, fill in each field
-    # @param [Hash] data
+    # The type of field is attempted to be filled in based on the metadata
+    # @param [Hash] data Hash with label => value to set syntax.
     def populate_with(data)
       sleep 1 # Being too fast can cause issues with first value. TODO: Wait for a condition
       data.each do |desc, value|
@@ -36,28 +38,47 @@ module LeapSalesforce
 
         type = field[:type] || field["type"]
         case type
-        when "string"
-          set_text_field(label_name, value)
+        when "string" then set_text_field(label_name, value)
         when "picklist" then set_picklist(label_name, value)
-        when "textarea"
-          new_panel.textarea(xpath: "//label[contains(.,'#{label_name}')]//following-sibling::textarea").set value
-        when "reference"
-          set_reference_field(label_name, value)
+        when "textarea" then set_text_area(label_name, value)
+        when "reference" then set_reference_field(label_name, value)
         else
-          raise NotImplementedError, "#{type} not yet defined in #{self.class}"
+          raise NotImplementedError, "#{type} not yet defined in #{self}"
         end
       end
       self
     end
 
-    def set_text_field(label, value)
-      text_field = new_panel.text_field(xpath: "//label[contains(.,'#{label}')]//following-sibling::input")
-      text_field.focus
-      text_field.set! value
-      return self if text_field.value == value
+    # Set input text field
+    # @param [String] label Label of textfield
+    # @param [String] value Value to set textfield to
+    def set_text_area(label, value)
+      LeapSalesforce.logger.info "Setting text area, label '#{label}' with '#{value}'"
+      field_transaction label, value do
+        form.textarea(xpath: "//label[contains(.,'#{label}')]//following-sibling::textarea").set value
+      end
+    end
 
-      sleep 2 # Wait a bit and then set field
-      text_field.set! value
+    # Set input text field
+    # @param [String] label Label of text field
+    # @param [String] value Value to set text field to
+    def set_text_field(label, value)
+      value = value.to_s
+      LeapSalesforce.logger.info "Setting text field, label '#{label}' with '#{value}'"
+      field_transaction label, value do
+        label_element = form.label(xpath: "//label[contains(.,'#{label}')]")
+        text_field = label_element.text_field(xpath: ".//following-sibling::input|.//following-sibling::div/input")
+        text_field.focus
+        text_field.set! value
+        return self if text_field.value == value
+
+        sleep 2 # Wait a bit and then set field
+        text_field.set! value
+        unless text_field.value == value
+          raise SetFieldError, "Unable to set text field '#{label}' with value " \
+                               "'#{value}'. Value set is '#{text_field.value}'"
+        end
+      end
       self
     end
 
@@ -65,21 +86,28 @@ module LeapSalesforce
     # @param [String] label Label of picklist
     # @param [String] value Value to set picklist to
     def set_picklist(label, value)
-      dropdown = new_panel.link(xpath: "//*[./*[text()='#{label}']]//following-sibling::div//a")
-      dropdown.focus
-      sleep 0.5
-      dropdown.click
-      browser.link(xpath: ".//div[contains(@class, 'select-options')]//a[contains(.,'#{value}')]").click
+      LeapSalesforce.logger.info "Setting picklist, label '#{label}' with '#{value}'"
+      field_transaction label, value do
+        dropdown = form.link(xpath: "//*[./*[text()='#{label}']]//following-sibling::div//a")
+        dropdown.focus
+        sleep 0.5
+        dropdown.click
+        browser.link(xpath: ".//div[contains(@class, 'select-options')]//a[contains(.,'#{value}')]").click
+      end
       self
     end
 
+    # Set reference field where another entity is referred to by this entity
     def set_reference_field(label, value)
       ref_label = label.gsub("ID", "Name")
       search_val = value[0..12]
-      search_field = browser.text_field(xpath: "//label[contains(.,'#{ref_label}')]//following-sibling::div[1]//input")
-      search_field.set search_val
-      browser.div(xpath: "//div[contains(@data-aura-class,'forceSearchInputLookupDesktopActionItem') and contains(., 'Search')]").click
-      browser.link(xpath: "//div[contains(@class,'searchScroller')]//a[contains(.,'#{search_val}')]").click
+      LeapSalesforce.logger.info "Setting reference field, label '#{ref_label}', searching with '#{search_val}'"
+      field_transaction label, value do
+        search_field = browser.text_field(xpath: "//label[contains(.,'#{ref_label}')]//following-sibling::div[1]//input")
+        search_field.set search_val
+        browser.div(xpath: "//div[contains(@data-aura-class,'forceSearchInputLookupDesktopActionItem') and contains(., 'Search')]").click
+        browser.link(xpath: "//div[contains(@class,'searchScroller')]//a[contains(.,'#{search_val}')]").click
+      end
       self
     end
 
@@ -88,20 +116,37 @@ module LeapSalesforce
       save
     end
 
+    # @return [Watir::Elements::Ul] List of errors
+    def error_list
+      browser.ul(xpath: "//ul[contains(@class, 'errorsList') and not(normalize-space()='')]")
+    end
+
     # Save the current form, creating the new object
     def save
-      browser.button(title: "Save").click
-      new_panel.wait_until do |panel|
-        browser_list = browser.ul(class: "errorsList")
-        if browser_list.exists?
-          sleep 3
-          errors = browser_list.lis
-          sleep 1 if errors.collect(&:text) != [""] # Wait for error to come
-          raise "Errors creating: #{errors.collect(&:text)}" if errors.count.positive?
+      LeapSalesforce.logger.info "Saving form for #{self}"
+      form.button(xpath: "//button[@title='Save']|//button[text()='Save']").click
+      form.wait_until do |panel|
+        sleep 1.5
+        if error_list.exists?
+          errors = error_list.lis
+          error_text = errors.collect(&:text)
+          LeapSalesforce.logger.error "Error submitting #{self} #{error_list.text}"
+          raise LeapSalesforce::SubmitError, "Errors creating on #{self}: #{error_text}" if errors.count.positive?
         end
 
         !panel.present?
       end
     end
+
+    private
+
+    # Process of setting a field within this block. Exceptions will be caught
+    # and thrown with context specific information
+    def field_transaction(label, value)
+      yield
+    rescue Watir::Exception::Error => e
+      raise LeapSalesforce::SetFieldError, "Unable to set label '#{label}' to '#{value}'" \
+                                           " on #{self}. Due to #{e.inspect}"
+    end
   end
 end

data/lib/leap_salesforce_ui/login_page.rb

@@ -41,6 +41,7 @@ Go to #{DISABLE_2STEP_URL} to learn how to disable it"
     end
 
     def login
+      LeapSalesforce.logger.info "Logging in as user '#{LeapSalesforce.ui_user}'"
       browser.goto "#{LeapSalesforce.general_url}/?un=#{LeapSalesforce.ui_user}&pw=#{LeapSalesforce.password}"
       continue_button = browser.button(id: "thePage:inputForm:continue")
       if continue_button.exists?

data/lib/leap_salesforce_ui/update_page.rb

@@ -9,7 +9,7 @@ class UpdatePage
   class << self
     def visit(id)
       LoginPage.login
-      browser.goto "#{SoqlHandler.instance_url}/lightning/r/#{@soql_object}/#{id}/edit"
+      browser.goto "#{SoqlHandler.instance_url}/lightning/r/#{@soql_object.soql_object_name}/#{id}/edit"
       self
     end
   end

data/lib/leap_salesforce_ui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LeapSalesforceUi
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/leap_salesforce_ui/view_page.rb

@@ -7,7 +7,7 @@ class ViewPage
   class << self
     def visit(id)
       LoginPage.login
-      browser.goto "#{SoqlHandler.instance_url}lightning/r/#{@soql_object}/#{id}/view"
+      browser.goto "#{SoqlHandler.instance_url}lightning/r/#{@soql_object.soql_object_name}/#{id}/view"
       self
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce_ui
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leap_salesforce
@@ -87,6 +87,7 @@ files:
 - lib/leap_salesforce_ui.rb
 - lib/leap_salesforce_ui/base_page.rb
 - lib/leap_salesforce_ui/create_page.rb
+- lib/leap_salesforce_ui/error.rb
 - lib/leap_salesforce_ui/form_filler.rb
 - lib/leap_salesforce_ui/generator/appenders.rb
 - lib/leap_salesforce_ui/generator/page_objects.rb