leap_salesforce_ui 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dac68f1cd35a89cc7051367715789f511f2bbb3bdf4cd992b62d6b4d775d8db
-  data.tar.gz: 9b50e04ed020695d9a94ffa43f84182aa336645cc2ff4e6fb1244a5a7384b2fd
+  metadata.gz: 3481b31ac19a98f7d9fe40b017f0d9d2d047a50a891ed20e079aaee480c0c623
+  data.tar.gz: 72ec8083bcfe9155f7e631fd5354c9d8388104bf9007985440a2518e902576f8
 SHA512:
-  metadata.gz: a31aa4579890235a69dee8192f17f7bfc74867ba23f0d0b9f10e69f41ab0c64973d1a280e7646f72f77c7be3f836746089cb28456e91342d2f4d27e7a4efc3eb
-  data.tar.gz: 885dcb0b1df4df2b4efd76bc98bc2bf7370ef0a137d83d141d2f3bd757007b0474c027245fc88f679c6da666cde2f0323179a0be50937fd4a22708bb4eaa0396
+  metadata.gz: 34b181f68921877a0e0afe55fd9e4ce91f3273323065c034f8dd63e0e0b85341e1ca27187b6f8e773e25816935615c6e33baf7aab262cf65244eebfdc217de2b
+  data.tar.gz: 9d7d119547de5453559936160ecc520e6d0db99620050c38b6297998b3f99e3e5938bb6875621bc2cdbee698c2d6e1f817743291fa15fb6c08a1435be39d2cd6

data/ChangeLog

@@ -1,3 +1,7 @@
+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

data/exe/leap_salesforce_ui

@@ -1,4 +1,46 @@
 #!/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"
+      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/generator/appenders.rb

@@ -0,0 +1,24 @@
+# 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)
+        FileUtils.touch filename unless File.exist? filename
+        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 Appending to #{filename}".colorize :green
+          open(filename, "a") { |f| f.puts content }
+        end
+      end
+    end
+  end
+end

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LeapSalesforceUi
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 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.4
 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-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: leap_salesforce
@@ -88,8 +88,12 @@ files:
 - lib/leap_salesforce_ui/base_page.rb
 - lib/leap_salesforce_ui/create_page.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/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