leap_salesforce_ui 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dac68f1cd35a89cc7051367715789f511f2bbb3bdf4cd992b62d6b4d775d8db
-  data.tar.gz: 9b50e04ed020695d9a94ffa43f84182aa336645cc2ff4e6fb1244a5a7384b2fd
+  metadata.gz: 10d36f660f1fd79ec05c6dcf5a0571b8b9394154ee59bece411722672045d9cc
+  data.tar.gz: e4bb12986774537a04ec55759e3005da3e54b1825acd62ec4e0251e8fdbabd4c
 SHA512:
-  metadata.gz: a31aa4579890235a69dee8192f17f7bfc74867ba23f0d0b9f10e69f41ab0c64973d1a280e7646f72f77c7be3f836746089cb28456e91342d2f4d27e7a4efc3eb
-  data.tar.gz: 885dcb0b1df4df2b4efd76bc98bc2bf7370ef0a137d83d141d2f3bd757007b0474c027245fc88f679c6da666cde2f0323179a0be50937fd4a22708bb4eaa0396
+  metadata.gz: 810cd99d1b6d9ff927cba94c9c680267c5005801210b5e9287229a897aa305befdb506c05cec90f55fb8dc2ae1949b47a5f33cb2855c0d5b417e5c20b2686f1f
+  data.tar.gz: cab59fba240bdad1a26b86166339ed1caa4e46cc6bacca7c7e2502b387c6343e3d8ba710c523c4cd25c6243fb085fd33788760ccb1e1c826d2c2cdb61fddd603

data/.leap_salesforce.yml

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

data/ChangeLog

@@ -1,3 +1,19 @@
+Version 0.1.6
+* Bug fix
+  * Not appending to Gemfile meant Rakefile could not load leap_salesfore_ui rake tasks
+
+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`
+
 Version 0.1.3
 * Enhancements
   * Explicitly specify higher version of Watir as minimum which is compatible with Ruby 3

data/README.md

@@ -40,9 +40,41 @@ LeapSalesforce.ui_user = 'test.user@salesforce.com'
 See [leap salesforce test users section](https://gitlab.com/leap-dojo/leap_salesforce#test-users)
 for details on ways to set test users.
 
+### Example spec_helper
+
+Following is example code that can be used to setup and teardown each test.
+
+```ruby
+require 'leap_salesforce_ui'
+RSpec.configure do |config|
+  LeapSalesforce.ui_user = LeapSalesforce::Users.list.first
+  config.before(:each) do |example|
+    # Start browser with test name as metadata
+    LeapSalesforce.browser example.full_description
+  end
+
+  config.after(:each) do |example|
+    # Take screenshot on failure
+    screenshot = "logs/#{tidy_description(example.full_description.to_s)}_failure.png"
+    LeapSalesforce.browser.screenshot.save screenshot if example.exception
+    # Use a fresh browser for each test
+    LeapSalesforce.close_browser 
+  end
+
+  # Tidy RSpec example description so it's suitable for a screenshot name
+  # @return [String] Description of test suitable for file name
+  def tidy_description(rspec_description)
+    rspec_description.delete("#<RSpec::Core::Example").delete('>".:{}').delete("=").delete(" ")
+  end
+end
+```
+
 ### Populate form using label in metadata
 
-Following is a walk through of one of the tests
+Following is a walk through of one of the tests. If you've copied the above code into `spec/spec_helper.rb`
+you should be able to copy this code into a new test file and execute it.
+
+> It may or may not work depending on how the fields Contact has in your org
 
 ```ruby
 RSpec.describe "Creating record" do
@@ -93,6 +125,14 @@ Follow other examples in `spec` to build tests using the auto-generated classes.
 unless run from an IP address that your Salesforce Org trusts. Many shared CI environments have runners that would
 be hard to whitelist as the address is dynamic.
 
+### Options
+
+To run tests in headless mode, set headless mode to true.
+```ruby
+LeapSalesforce.headless = true
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. 

data/exe/leap_salesforce_ui

@@ -1,4 +1,47 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "leap_salesforce_ui"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require "leap_salesforce/error"
+require "thor"
+
+def init_setup?
+  File.exist?(".leap_salesforce.yml")
+end
+
+unless init_setup?
+  puts "Setting up leap_salesforce API first"
+  Process.fork { exec("leap_salesforce init") }
+  Process.wait
+
+  raise LeapSalesforce::SetupError, "Unable to setup leap_salesforce" unless init_setup?
+end
+
+require "leap_salesforce_ui/version"
+require "leap_salesforce_ui/generator/appenders"
+require "colorize"
+
+module LeapSalesforce
+  # Executable for setting up Leap Salesforce UI
+  class UiExe < Thor
+    include LeapSalesforce::Generators::Appenders
+
+    desc "init", "Create leap salesforce ui configuration"
+    def init
+      puts "Initialising initial files to get started with leap_salesforce_ui"
+      append "Rakefile", "Rakefile.erb"
+      append "Gemfile", "Gemfile.erb"
+      puts 'Running Rake task "leaps:create_poms"'
+      puts `rake leaps:create_poms`
+      append File.join("spec", "spec_helper.rb"), "spec_helper.rb.erb"
+      append File.join("spec", "ui_spec.rb"), "ui_spec.rb.erb"
+      puts "Note test 'ui_spec' is specific to 'Contact' and 'Account' object using fields that
+may not exist but purely as a demonstration."
+    end
+  end
+end
+
+puts "Using #{LeapSalesforceUi::VERSION} of LeapSalesforceUi"
+
+LeapSalesforce::UiExe.start(ARGV)

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,48 @@ 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
+        text_area = form.textarea(xpath: "//lightning-textarea[./label[contains(.,'#{label}')]]//following-sibling::div/textarea")
+        text_area.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 +87,32 @@ 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.text_field(xpath: "//*[./*[text()='#{label}']]//following-sibling::div//input")
+        dropdown_id = dropdown.attribute "id"
+        LeapSalesforce.logger.debug "Using dropdown id: #{dropdown_id}"
+        dropdown.focus
+        sleep 0.5
+        dropdown.click
+        has_value = "@data-value='#{value}'"
+        in_dropdown = "starts-with(@data-item-id, '#{dropdown_id}')"
+        browser.element(xpath: ".//lightning-base-combobox-item[#{has_value} and #{in_dropdown}]").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.element(xpath: ".//lightning-base-combobox-item[starts-with(.,'SearchShow')]").click
+        browser.link(xpath: "//div[contains(@class,'searchScroller')]//a[contains(.,'#{search_val}')]").click
+      end
       self
     end
 
@@ -88,20 +121,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/generator/appenders.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "leap_salesforce/generator/generator"
+
+module LeapSalesforce
+  module Generators
+    # Used for appending content onto existing files (or adding if not already present)
+    module Appenders
+      include LeapSalesforce::Generator
+
+      # Create content in a file, adding to an existing file if present
+      def append(filename, template_path)
+        verb = "Appending to"
+        unless File.exist? filename
+          FileUtils.touch filename
+          verb = "Creating"
+        end
+        content = read_template template_path, binding, folder: __dir__
+        if File.read(filename).include?(content)
+          puts "File '#{filename}' already has expected content, skipping...".colorize :red
+        else
+          puts "\u2713 #{verb} #{filename}".colorize :green
+          open(filename, "a") { |f| f.puts content }
+        end
+      end
+    end
+  end
+end

data/lib/leap_salesforce_ui/generator/templates/Gemfile.erb

@@ -0,0 +1 @@
+gem 'leap_salesforce_ui'

data/lib/leap_salesforce_ui/generator/templates/Rakefile.erb

@@ -0,0 +1 @@
+require 'leap_salesforce_ui/rake'

data/lib/leap_salesforce_ui/generator/templates/spec_helper.rb.erb

@@ -0,0 +1,21 @@
+require 'leap_salesforce_ui'
+RSpec.configure do |config|
+  config.before(:each) do |example|
+    # Default to first test user defined for each test
+    LeapSalesforce.ui_user = LeapSalesforce::Users.list.first
+    # Start browser with test name as metadata
+    LeapSalesforce.browser example.full_description
+  end
+
+  config.after(:each) do |example|
+    screenshot = "logs/#{tidy_description(example.full_description.to_s)}_failure.png"
+    LeapSalesforce.browser.screenshot.save screenshot if example.exception
+    LeapSalesforce.close_browser # Fresh browser for each test
+  end
+
+  # Tidy RSpec example description so it's suitable for a screenshot name
+  # @return [String] Description of test suitable for file name
+  def tidy_description(rspec_description)
+    rspec_description.delete("#<RSpec::Core::Example").delete('>".:{}').delete("=").delete(" ")
+  end
+end

data/lib/leap_salesforce_ui/generator/templates/ui_spec.rb.erb

@@ -0,0 +1,22 @@
+
+RSpec.describe "Creating record" do
+  let(:first_name) { Faker::Name.first_name }
+  let(:last_name) { Faker::Name.last_name }
+  let(:salutation) { Contact::Salutation.sample }
+  let(:other_street) { Faker::Address.full_address }
+  it "populate form and save" do
+    account = FactoryBot.create(:account)
+    CreateContactPage.visit.submit_with({ "First Name" => first_name,
+                                          last_name: last_name,
+                                          salutation: salutation,
+                                          other_street: other_street,
+                                          account_id: account.account_name })
+    contact_id = ViewContactPage.id
+    @contact = Contact.find(id: contact_id)
+    expect(@contact.first_name).to eq first_name
+    expect(@contact.last_name).to eq last_name
+    expect(@contact.salutation).to eq salutation
+    expect(@contact.other_street).to eq other_street
+    expect(@contact.account_id).to eq account.id
+  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.3"
+  VERSION = "0.1.7"
 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.3
+  version: 0.1.7
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leap_salesforce
@@ -87,9 +87,15 @@ 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
+- lib/leap_salesforce_ui/generator/templates/Gemfile.erb
+- lib/leap_salesforce_ui/generator/templates/Rakefile.erb
 - lib/leap_salesforce_ui/generator/templates/create_page.rb.erb
+- lib/leap_salesforce_ui/generator/templates/spec_helper.rb.erb
+- lib/leap_salesforce_ui/generator/templates/ui_spec.rb.erb
 - lib/leap_salesforce_ui/generator/templates/update_page.rb.erb
 - lib/leap_salesforce_ui/generator/templates/view_page.rb.erb
 - lib/leap_salesforce_ui/login_page.rb