leap_salesforce_ui 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49dd5004bf8b345bd392443488da5b806db264a7dd50dd2aa5ab9992d1169028
-  data.tar.gz: a091e11758fafcb039c7cf7bdd1bc06a061d605e742704e8ffc7bd4198a30395
+  metadata.gz: 1d7e63743b865e1a4fd706abeb9772fa5726a6304c336fe40dd6f32a455119b9
+  data.tar.gz: da6bfe38c4f2479a0ddb06e748ff262ac80d45fe9872839d115c0ccdb1eda758
 SHA512:
-  metadata.gz: 9462ecb9055aa0d8902096b5b4a2189e8e7fcb3bcd6ed2f25fe252e197d0df6fde9c3436f014f79375850c9fb462b81c62dc5921ef2ccf70f9bafdbf09120a5d
-  data.tar.gz: 076a3803d5be1a35d0da5dc4114482a15f4f6d22f372a2a00a5ca9da0c196f50f5e949e8cf0dfff3007c5e9d2b5f2e4cff7929389e3f039520e69d578246202a
+  metadata.gz: 9c0e05222bdb5c9c86f4367fc50a5e0bbb381d21329e7588cc4760011d636b4526aebe2e84db0ccf6ae60441186f673b6df70a73a1c370b3cbb54191d19f84c8
+  data.tar.gz: 78456a3a7afcd73a3e7b779843f17485f45b6c11b406038fa1ec43bdf2b8aee1b9cb6bef4fa66796f44c32f571591e6db1ce7b8b8f636d2064c3383dc85ddb6d

data/.gitignore

@@ -25,3 +25,6 @@ sf_log.log
 
 # Logs
 /logs/
+
+# Generated files
+spec/support/page_objects

data/.gitlab-ci.yml

@@ -11,6 +11,7 @@ test:
   script:
     - apk add docker-compose
     - docker-compose version
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
     - docker pull --quiet elgalu/selenium:3.141.59-p37 # Explicitly pull selenium image with working version
     - docker-compose up --abort-on-container-exit --exit-code-from test
   artifacts:
@@ -22,3 +23,6 @@ test:
     when: always
   variables:
     BROWSER: chrome
+
+include:
+  - template: Code-Quality.gitlab-ci.yml

data/.leap_salesforce.yml

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

data/ChangeLog

@@ -1,3 +1,28 @@
+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
+
+Version 0.1.2
+* Enhancements
+  * Added Rake task to auto-generate page classes from soql_objects
+  * Added update base class to update entities in a similar way to creating them
+
 Version 0.1.1
 * Enhancements
   * Add filling in of dropdown, reference field and text area to create

data/Dockerfile

@@ -1,4 +1,5 @@
-FROM ruby:2.6
+FROM ruby:2.7
+# Issue as of this time with Selenium webdriver remote with Ruby3
 MAINTAINER Samuel Garratt
 
 # Required ruby gems

data/Gemfile

@@ -9,4 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
+gem "pry"
 gem "rubocop", "~> 1.7"

data/README.md

@@ -23,21 +23,116 @@ Or install it yourself as:
 
 ## Usage
 
-Setup `leap_salesforce` with `leap_salesforce init`. 
+This gem is an extension to [leap salesforce](https://gitlab.com/leap-dojo/leap_salesforce)
+Setup `leap_salesforce` with `leap_salesforce init` and use the retrospective rake tasks to create soql objects. 
 
-Follow examples in `spec` to build a test using base classes.
+Add the line `require 'leap_salesforce_ui/rake'` to your `Rakefile`. Then run the Rake task `rake leaps:create_poms`
+which will generate page objects based upon the `soql_objects`
 
-These tests require that you [disable 2 step authentication for users](https://gitlab.com/leap-dojo/leap_salesforce_ui/-/wikis/Disable-2-step-authentication-and-allow-IP-range)
+Set the current UI user to be used with the `LeapSalesforce.ui_user` attribute.
+
+E.g
+
+```ruby
+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. 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
+  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
+```
+
+One doesn’t have to identify how to recognise first_name, last_name, etc. 
+From the metadata it works out what kind of field (textfield, textarea, reference) and then 
+finds the corresponding label and uses that to fill in the field.
+
+This test then uses the API to setup a dependent account (through FactoryBot) and then to find the contact 
+created to verify that what was entered on the UI was saved as expected.
+
+### Manually specify label
+
+Sometimes the label on the UI does not match the metadata label. In that case, one case manually
+specify the type of object, the label and what to set it to. E.g.,
+
+```ruby
+UpdateAccountPage.visit(@account.id).set_picklist("Type", Account::AccountType.prospect).save
+```
+
+This will set a picklist with the label `Type` to the value defined by the picklist `AccountType`, and
+the value `prospect`.
+
+Follow other examples in `spec` to build tests using the auto-generated classes.
+
+> These tests require that you [disable 2 step authentication for users](https://gitlab.com/leap-dojo/leap_salesforce_ui/-/wikis/Disable-2-step-authentication-and-allow-IP-range)
 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.
 
-> In the future a script will be used to scaffold base classes based on `.leap_salesforce.yml`
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. 
+Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'leap_salesforce/rake'
+require "leap_salesforce/rake"
+
+require_relative "lib/leap_salesforce_ui/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -8,8 +8,5 @@ require "leap_salesforce_ui"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/bin/setup

@@ -4,5 +4,4 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here
+bundle exec rake leaps:create_poms

data/exe/leap_salesforce_ui

@@ -1,3 +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/leap_salesforce_ui.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'lib/leap_salesforce_ui/version'
+require_relative "lib/leap_salesforce_ui/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "leap_salesforce_ui"
@@ -29,8 +29,8 @@ It reads the Metadata from Salesforce and creates the foundation for UI tests.'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "leap_salesforce", ">= 1.0.2"
-  spec.add_dependency "watir"
+  spec.add_dependency "leap_salesforce", ">= 1.0.3"
+  spec.add_dependency "watir", ">= 6.17.0"
   spec.add_dependency "webdrivers"
 
   # For more information and examples about making a new gem, checkout our

data/lib/leap_salesforce_ui.rb

@@ -4,18 +4,26 @@ 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"
 require_relative "leap_salesforce_ui/create_page"
 require_relative "leap_salesforce_ui/view_page"
+require_relative "leap_salesforce_ui/update_page"
+page_obj_folder = File.join(LeapSalesforce.lib_folder, "page_objects")
+require_all page_obj_folder if Dir.exist? page_obj_folder
 
+# @return [Hash]
 def zalenium_args(feature_name, scenario)
-  args = { timeout: 120, url: ENV['WEBDRIVER_URL'], name: "Scenario: #{scenario} #{Time.now}",
+  args = { timeout: 120, url: ENV["WEBDRIVER_URL"], name: "Scenario: #{scenario} #{Time.now}",
            'zal:build': "Feature: #{feature_name}" }
-  if ENV['BROWSER'] == 'chrome'
+  case ENV["BROWSER"]
+  when "chrome"
     args.merge!('goog:chromeOptions': {
-        args: ENV['WEBDRIVER_CHROMEOPTIONS']&.split(' ') || %w[]
-    })
-  elsif ENV['BROWSER'] == 'firefox'
+                  args: ENV["WEBDRIVER_CHROMEOPTIONS"]&.split(" ") || %w[]
+                })
+  when "firefox"
     args.merge!(timeouts: 120)
   end
   args
@@ -25,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)
@@ -35,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
@@ -50,10 +64,13 @@ module LeapSalesforce
     private
 
     def new_browser(test_name = nil)
-      if ENV['WEBDRIVER_URL']
-        Watir::Browser.new :chrome, **zalenium_args('LeapSalesforce', test_name || 'Test')
+      if ENV["WEBDRIVER_URL"]
+        # 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,14 +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.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/create_page.rb

@@ -1,95 +1,7 @@
 # frozen_string_literal: true
 
-module NewMethods
-  def new_panel
-    browser.div(class: "inlinePanel")
-  end
-
-  # Use metadata to get label for field
-  # @param [String] field
-  def get_label_for(field)
-    raise "SoqlObject not defined" unless @soql_object
-
-    return field if @soql_object.label_names.include? field
-
-    raise "Cannot find field #{field} on #{@soql_object}" unless @soql_object.accessors[field.to_sym]
-
-    @soql_object.accessors[field.to_sym][:label]
-  end
-
-  # @return [Hash] Description of field
-  def field_for(desc)
-    ruby_desc = @soql_object.accessors[desc.to_sym]
-    return ruby_desc if ruby_desc
-
-    @soql_object.properties_for(desc)
-  end
-
-  # Based on data type of field passed, fill in each field
-  # @param [Hash] data
-  def populate_with(data)
-    data.each do |desc, value|
-      field = field_for(desc)
-      label_name = field[:label] || field['label']
-
-      type = field[:type] || field['type']
-      case type
-      when 'string'
-        new_panel.text_field(xpath: "//label[contains(.,'#{label_name}')]//following-sibling::input").set 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)
-      else
-        raise NotImplementedError, "#{type} not yet defined in #{self.class}"
-      end
-    end
-  end
-
-  # Set value of picklist
-  # @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
-  end
-
-  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
-    sleep 1.5
-    search_field.send_keys :enter
-    browser.link(xpath: "//div[contains(@class,'searchScroller')]//a[contains(.,'#{search_val}')]").click
-  end
-
-  def submit_with(data)
-    populate_with data
-    save
-  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?
-        errors = browser_list.lis
-        raise "Errors creating: #{errors.collect(&:text)}" if errors.count.positive?
-      end
-
-      !panel.present?
-    end
-  end
-end
-
-# Base class for creating entities
+# Base class for creating entities in Salesforce
 class CreatePage
   extend BasePage
-  extend NewMethods
+  extend LeapSalesforce::FormFiller
 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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module LeapSalesforce
+  module FormFiller
+    # @return [Watir::Elements::Div] Div where form entered to create/edit entity
+    def form
+      browser.div(class: "inlinePanel")
+    end
+
+    # Use metadata to get label for field
+    # @param [String] field
+    def get_label_for(field)
+      raise "SoqlObject not defined" unless @soql_object
+
+      return field if @soql_object.label_names.include? field
+
+      raise "Cannot find field #{field} on #{@soql_object}" unless @soql_object.accessors[field.to_sym]
+
+      @soql_object.accessors[field.to_sym][:label]
+    end
+
+    # @return [Hash] Description of field
+    def field_for(desc)
+      ruby_desc = @soql_object.accessors[desc.to_sym]
+      return ruby_desc if ruby_desc
+
+      @soql_object.properties_for(desc)
+    end
+
+    # Based on data type of field passed, fill in each field
+    # 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|
+        field = field_for(desc)
+        label_name = field[:label] || field["label"]
+
+        type = field[:type] || field["type"]
+        case type
+        when "string" then set_text_field(label_name, value)
+        when "picklist" then set_picklist(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}"
+        end
+      end
+      self
+    end
+
+    # 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
+
+    # 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
+
+    # Set value of picklist
+    # @param [String] label Label of picklist
+    # @param [String] value Value to set picklist to
+    def set_picklist(label, value)
+      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]
+      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
+
+    def submit_with(data)
+      populate_with data
+      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
+      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/page_objects.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "leap_salesforce/generator/generator"
+
+module LeapSalesforce
+  # Generators for creating code
+  module Generator
+    # Creates SoqlObjects and related modules
+    class PageObjects
+      include Generator
+
+      POM_FOLDER = File.join(LeapSalesforce.lib_folder, "page_objects").freeze
+
+      def create
+        LeapSalesforce.objects_to_verify.each { |entity| create_poms_for entity }
+      end
+
+      # @param [LeapSalesforce::SoqlData] entity An object representing an object in Salesforce
+      def create_poms_for(entity)
+        @entity_name = entity
+        @soql_object = LeapSalesforce.soql_objects.find { |so| so.class_name == entity.to_s }
+        %w[create view update].each do |page_action|
+          content = read_template "#{page_action}_page.rb.erb", binding, folder: __dir__
+          file = File.join(POM_FOLDER, "#{@entity_name.to_s.snakecase}/#{page_action}_page.rb")
+          generate_file file, content, overwrite: false
+        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/create_page.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Create<%= @soql_object.class_name %>Page < CreatePage
+  soql_object <%= @soql_object.class_name %>
+end

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/generator/templates/update_page.rb.erb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Update<%= @soql_object.class_name %>Page < UpdatePage
+  soql_object <%= @soql_object.class_name %>
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class View<%= @soql_object.class_name %>Page < ViewPage
+  soql_object <%= @soql_object.class_name %>
+end

data/lib/leap_salesforce_ui/login_page.rb

@@ -2,7 +2,7 @@
 
 class LoginPage
   class << self
-    DISABLE_2STEP_URL = 'https://gitlab.com/leap-dojo/leap_salesforce_ui/-/wikis/Disable-2-step-authentication-and-allow-IP-range'
+    DISABLE_2STEP_URL = "https://gitlab.com/leap-dojo/leap_salesforce_ui/-/wikis/Disable-2-step-authentication-and-allow-IP-range"
 
     # @return [Watir::Browser]
     def browser
@@ -21,18 +21,17 @@ class LoginPage
       error_message_element.present?
     end
 
-    def visit
+    # Could be used if a user wants to login through UI for login specific tests
+    # which should not be necessary
+    def login_manually
       browser.goto LeapSalesforce.general_url
-    end
-
-    def login
       browser.text_field(id: "username").set(LeapSalesforce.ui_user)
       browser.text_field(id: "password").set(LeapSalesforce.password)
       browser.button(id: "Login").click
       Watir::Wait.until(timeout: 60, message: "Did not login within the expected time") do
         raise "Cannot Login. #{error_message}" if error_message?
 
-        if browser.url.include? '_ui/identity/verification/'
+        if browser.url.include? "_ui/identity/verification/"
           raise LeapSalesforce::SetupError, "2 step verification page appears.
 Go to #{DISABLE_2STEP_URL} to learn how to disable it"
         end
@@ -40,5 +39,15 @@ Go to #{DISABLE_2STEP_URL} to learn how to disable it"
         !browser.url.include? LeapSalesforce.general_url
       end
     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?
+        browser.checkbox(id: "thePage:inputForm:remember").set
+        continue_button.click
+      end
+    end
   end
 end

data/lib/leap_salesforce_ui/page_introspection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LeapSalesforce
+  # Relates to a page inspecting it's own state
+  module PageIntrospection
+    # @return [String] Id of current entity
+    def id
+      LeapSalesforce.browser.url.split("/")[-2]
+    end
+  end
+end

data/lib/leap_salesforce_ui/rake.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "../leap_salesforce_ui"
+Dir.glob(File.join(__dir__, "rake", "*.rake")).each(&method(:import))

data/lib/leap_salesforce_ui/rake/pom.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :leaps do
+  desc "Create Page objects using leaps ui framework"
+  task :create_poms do
+    require_relative "../generator/page_objects"
+    LeapSalesforce::Generator::PageObjects.new.create
+  end
+end

data/lib/leap_salesforce_ui/update_page.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Base class for updating an entity in Salesforce
+class UpdatePage
+  extend BasePage
+  extend LeapSalesforce::PageIntrospection
+  extend LeapSalesforce::FormFiller
+
+  class << self
+    def visit(id)
+      LoginPage.login
+      browser.goto "#{SoqlHandler.instance_url}/lightning/r/#{@soql_object.soql_object_name}/#{id}/edit"
+      self
+    end
+  end
+end

data/lib/leap_salesforce_ui/version.rb

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

data/lib/leap_salesforce_ui/view_page.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+# Base class for viewing an entity in Salesforce
 class ViewPage
   extend BasePage
+  extend LeapSalesforce::PageIntrospection
   class << self
-    # @return [String] Id of current entity
-    def id
-      LeapSalesforce.browser.url.split("/")[-2]
+    def visit(id)
+      LoginPage.login
+      browser.goto "#{SoqlHandler.instance_url}lightning/r/#{@soql_object.soql_object_name}/#{id}/view"
+      self
     end
   end
 end

data/run_tests_when_ready.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 # exit if a command returns a non-zero exit code and also print the commands and their args as they are executed
 set -e -x
+bin/setup # Setup POMs fresh each time testing generator
 # Wait for Zalenium to be up and running
 timeout 30 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' zalenium:4444/wd/hub/status)" != "200" ]]; do sleep 5; done' || false
-bundle install
 bundle exec rake spec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce_ui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-31 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leap_salesforce
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.17.0
 - !ruby/object:Gem::Dependency
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,22 @@ 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
+- lib/leap_salesforce_ui/page_introspection.rb
+- lib/leap_salesforce_ui/rake.rb
+- lib/leap_salesforce_ui/rake/pom.rake
+- lib/leap_salesforce_ui/update_page.rb
 - lib/leap_salesforce_ui/version.rb
 - lib/leap_salesforce_ui/view_page.rb
 - run_tests_when_ready.sh