leap_salesforce 0.2.28 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c713a2f3052a5b335fb56963091508d652a4b1d570a6283e2ad775e2e062dd9b
-  data.tar.gz: a845f0ee3220c1d88ae9086a529e61612b25cc79ccdacf2bae0296b12ade189e
+  metadata.gz: 524899b1fcc374750dcb570db5de67ad6aaea98e8d9fd1381ed5c68cec0ea34a
+  data.tar.gz: d950d41267bbfde2fa9e7765b1f89a7b72cf61c47589567adef70b0a62e0566c
 SHA512:
-  metadata.gz: b8b6b99d725267fe4e89f32cfd513aadea6ee83e9ac1220052882988e88fa5bd1762ecaafc9ac23a8698f2645beea1bb2dce7cd1d38ae2b101bdb947588c1258
-  data.tar.gz: 93bcc18ead3300a227163fd19e18e5f9b7bbcc0c19c71cd0f32136ce3e176eb2b1515e00815507f438f94e84853a3d4c7f921edb3a9f76ded23d122b94035c43
+  metadata.gz: 5717e4bc877a62fa921abe70c0a2ee12d4a29e46941d6e0283f8665dc49d76d9a78be697ba4be609f6567d545b29e2d8cf6a7c965a4924e328feff71b090b891
+  data.tar.gz: 37adfa1837d29609c6aee8f2195ca0e41c134b94d5ced4be994064e4720eb12fe7930276fb296a9794a452a9ce21633c913fa507dfce24a88a51504b6cdecf95

data/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 include:
   - template: Code-Quality.gitlab-ci.yml
 
-image: ruby:2.6
+image: ruby:2.7
 
 stages:
   - test
@@ -18,7 +18,7 @@ variables:
 pages:
   stage: deploy
   dependencies:
-    - test
+    - test_2.7
   script:
     - mv coverage/ public
   artifacts:
@@ -600,25 +600,38 @@ pages:
     done
   }
 
-test:
-  stage: test
+  function setup_integration_env() {
+    # Decrypt server key
+    openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
+    ls -la assets
+    install_jq
+    install_salesforce_cli
+    # Integrated test
+    gem install bundler rake
+    bundle install
+    sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+  }
+
+test_2.7:
   script:
     # Decrypt server key
     - *sfdx_helpers
-    - openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
-    - ls -la assets
-    - install_jq
-    - install_salesforce_cli
-    # Integrated test
-    - ruby -v
-    - which ruby
-    - gem install bundler rake
-    - bundle install
-    - sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+    - setup_integration_env
     - bundle exec rake check_oauth   # Check OAuth
     - bundle exec rake leaps:create_soql_objects
     - bundle exec rake leaps:create_enums
-    - bundle exec rspec_booster --job $CI_NODE_INDEX/$CI_NODE_TOTAL
+    - bundle exec rspec
   artifacts:
     paths:
       - coverage/
+
+test_3.0:
+  image: ruby:3.0
+  script:
+    # Decrypt server key
+    - *sfdx_helpers
+    - setup_integration_env
+    - bundle exec rake check_oauth   # Check OAuth
+    - bundle exec rake leaps:create_soql_objects
+    - bundle exec rake leaps:create_enums
+    - bundle exec rspec

data/ChangeLog

@@ -1,3 +1,26 @@
+Version 1.0.4
+* Enhancement
+  * Strip out ':' from user key for when it is accidentally added
+
+Version 1.0.3
+* Enhancement
+  * Allow templates to be sourced from external gems for generator
+
+Version 1.0.2
+* Enhancement
+  * Only load sub folders of leap_salesforce.lib_folder that are needed by this gem, allowing room for UI
+    and other gems to use other folders independently
+  * New method 'accessors' on object to make it easy to pass list of fields for an object
+
+Version 1.0.1
+* Bug fix
+  * Fix #28 allowing !nil for query by non null values
+
+Version 1.0.0
+* Enhancement
+  * Disable rubocop output for pending ops when creating/fixing files
+  * Specify that working with Ruby 3 is a work in progress
+
 Version 0.2.28
 * Enhancement
   * Make exclude method able to use class name in exclusion filter (hence easier to use)
@@ -226,4 +249,4 @@ Version 0.1.1
   * Suggestions for generated factory
   * Begin unit tests
   * Handle Macrons by ensuring they're not copied into Ruby names / Modules
-  * Created executable
+  * Created executable

data/PITCHME.md

@@ -80,7 +80,7 @@ metadata.
 @[3](Declare what it is you're testing)
 @[5](Define what 'it' is, a the object under test must do)
 @[6](Create an instance of the object class - nothing sent to Salesforce yet)
-@[7-8](Set the first and last name to random names)
+@[4,7-8](Set the first and last name to random names)
 @[9](Create the object in Salesforce by sending request via API)
 @[10](Verify creation was successful)
 @[11](Verify first name set as expected)
@@ -92,8 +92,8 @@ metadata.
 
 ---?code=spec/integration/query_spec.rb&lang=ruby&title=Querying entities
 
-@[6](Find an object using a specific attribute specific value)
-@[19](Find an object using a comparator)
+@[21](Find an object using a specific attribute specific value)
+@[29-30](Find list of objects meeting condition)
 
 ---
 

data/README.md

@@ -3,7 +3,7 @@
 Welcome to LeapSalesforce gem. This gem helps ones to perform integration tests on Salesforce. It reads the Metadata
 from Salesforce and creates the foundation for API tests. 
 
-In the future it will also planned to be used to create page objects based on metadata to support UI testing. 
+Support for UI testing is being worked on in another gem [leap_salesforce_ui](https://gitlab.com/leap-dojo/leap_salesforce_ui)
 
 ## Is this for you?
 
@@ -258,6 +258,22 @@ This method can be used directly with the backend name. E.g, `contact[:FieldName
 This method in turn sets a value of the `@override_parameters[:body]` variable within the entity. 
 The value of request body can be interrogated with `entity.request_parameters.body`.
 
+##### Logging
+
+By default, API traffic will be logged in a log file in a `logs` folder. The gem `soaspec` is
+used to log this traffic. 
+
+Following is an example of changing some of the default logging. 
+
+```ruby
+# Turn this true if you need debug authentication
+Soaspec::OAuth2.debug_oauth = true 
+# Turn this to true if you want to see API traffic on the terminal
+Soaspec::SpecLogger.output_to_terminal = true 
+```
+
+See more configuration parameters in the [Soaspec repo](https://gitlab.com/samuel-garratt/soaspec#logging)
+
 ### CRUD of data
 
 To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
@@ -560,3 +576,5 @@ Everyone interacting in the LeapSalesforce project’s codebases, issue trackers
 
 * Presentation on this library [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)
 * Example of this library within a CI/CD pipeline [here](https://gitlab.com/iqa_public/labs/salesforce_cicd_demo)
+* Using `leap_salesforce` to download event log files [here](https://gitlab.com/samuel-garratt/leap_salesforce_event_log_files)
+

data/Rakefile

@@ -34,3 +34,21 @@ YARD::Doctest::RakeTask.new do |task|
   # TODO: Get all examples working in this way
   task.pattern = 'lib/leap_salesforce/ext/string.rb'
 end
+
+desc 'Task to enter pry terminal and types commands using the standard library code'
+task :pry do
+  require 'pry'
+  Pry.start
+end
+
+desc 'Example of cleaning up data'
+task :remove_contacts do
+  contacts = Contact.where first_name: '!null'
+  puts "Deleting #{contacts.size} contacts"
+  contacts.each do |contact|
+    contact.delete
+    print '.'
+  end
+  contacts = Contact.where first_name: '!null'
+  puts "#{contacts.size} contacts left"
+end

data/lib/leap_salesforce.rb

@@ -74,7 +74,10 @@ module LeapSalesforce
   require 'leap_salesforce/limits'
 
   FileUtils.mkdir_p lib_folder unless Dir.exist? lib_folder
-  require_all lib_folder
+  %w[factories metadata soql_data].each do |folder|
+    sub_folder = File.join(lib_folder, folder)
+    require_all sub_folder if Dir.exist? sub_folder
+  end
 
   self.objects_to_verify = SoqlData.descendants if objects_to_verify.empty?
 end

data/lib/leap_salesforce/error.rb

@@ -3,12 +3,16 @@
 module LeapSalesforce
   # Any error specific to LeapSalesforce
   class Error < StandardError; end
+
   # Error related to handling a request
   class RequestError < StandardError; end
+
   # Error related to handling a response
   class ResponseError < StandardError; end
+
   # Error related to setup of test automation suite
   class SetupError < Error; end
+
   # Error related to Test Users
   class UserError < Error; end
 end

data/lib/leap_salesforce/ext/string.rb

@@ -27,8 +27,8 @@ class String
   def to_ruby_friendly
     tr('&|=', '_').gsub('<', '_lt_').gsub('>', '_gt_')
                   .remove_macrons
-                  .gsub(/[\s]+/, '_')
-                  .gsub(/[\W]/, '') # Remove any other special characters
+                  .gsub(/\s+/, '_')
+                  .gsub(/\W/, '') # Remove any other special characters
                   .handle_initial_characters # Previous step could have removed all characters
                   .humanize_numbered_string
   end

data/lib/leap_salesforce/generator/default.rb

@@ -23,7 +23,7 @@ module LeapSalesforce
           when 'boolean' then set('true')
           when 'picklist' then set("#{class_name}::#{field['label'].to_class_name}.sample")
           when 'reference'
-            return set('User.find(CreatedDate: "<#{0.days.ago}").id') if field['name'] == 'OwnerId'
+            return set(%{User.find(CreatedDate: "<#{0.days.ago}").id}) if field['name'] == 'OwnerId'
 
             soql_obj = LeapSalesforce.soql_objects.find { |so| so.backend_name == field['relationshipName'] }&.reference
             if soql_obj

data/lib/leap_salesforce/generator/exe_helpers.rb

@@ -34,8 +34,8 @@ module LeapSalesforce
     def verify_oauth
       unless LeapSalesforce.sfdx
         LeapSalesforce.client_id = options[:client_id] || input_for('Client id (Customer Id)')
-        LeapSalesforce.client_secret = options[:client_secret] || STDIN.getpass('Client secret (Consumer Secret)')
-        LeapSalesforce.password = options[:password] || STDIN.getpass('Password (Recommendation is that 1 password' \
+        LeapSalesforce.client_secret = options[:client_secret] || $stdin.getpass('Client secret (Consumer Secret)')
+        LeapSalesforce.password = options[:password] || $stdin.getpass('Password (Recommendation is that 1 password' \
   ' be shared across all test users to be easier to manage):')
       end
       LeapSalesforce.api_user = ERB.new(options[:username] || input_for('Salesforce username. It is ideal to start with a System admin' \
@@ -50,7 +50,7 @@ module LeapSalesforce
       ' leap_salesforce testing repo'.colorize(:green)
       verify_environment
       verify_oauth
-      @user_key = options[:user_key] || input_for('Enter a key to refer to this user (This will be stored as a Symbol)')
+      @user_key = options[:user_key] || input_for('Enter a key to refer to this user (This will be stored as a Symbol)').delete(':')
     end
   end
 end

data/lib/leap_salesforce/generator/generator.rb

@@ -8,11 +8,20 @@ require 'colorize'
 module LeapSalesforce
   # Generators for creating code
   module Generator
+    # @param [String] filename Relative filename to this file
+    # @param [String] folder Folder where templates are stored (for external gems)
+    # @return [String] Location of template file
+    def template_loc(filename, folder: nil)
+      template_dir = folder || __dir__
+      File.join(template_dir, 'templates', filename)
+    end
+
     # @param [String] filename Relative filename to this file
     # @param [Binding] binding Binding object used for ERB variables
+    # @param [String] folder Folder where templates are stored (for external gems)
     # @return [String] Interpreted file after calculating ERB for template file passed
-    def read_template(filename, binding)
-      ERB.new(File.read(File.join(__dir__, 'templates', filename))).result(binding)
+    def read_template(filename, binding, folder: nil)
+      ERB.new(File.read(template_loc(filename, folder: folder))).result(binding)
     end
 
     # Generate file creating necessary folder if necessary

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -70,7 +70,7 @@ module LeapSalesforce
 
       # Clean up files generated for all picklists
       def cleanup_files_created
-        `rubocop -a #{ENUM_FOLDER}`
+        `rubocop -A #{ENUM_FOLDER} --display-only-fail-level-offenses --enable-pending-cops`
       end
     end
   end

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -62,8 +62,8 @@ module LeapSalesforce
           generate_field_module
           generate_factory
         end
-        `rubocop -a #{SOQL_OBJECT_FOLDER}`
-        `rubocop -a #{FACTORY_FOLDER}`
+        `rubocop -A #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
+        `rubocop -A #{FACTORY_FOLDER} --enable-pending-cops`
       end
 
       private

data/lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb

@@ -4,8 +4,8 @@
 # Depending on validation rules and mandatory fields this may or may not work
 
 RSpec.describe 'Contact CRUD' do
-  let(:uniq_value) { 'UNIQ FIRST NAME' }
-  let(:updated_value) { 'New Value' }
+  let(:uniq_value) { "UNIQ #{Faker::Name.first_name} #{Faker::Name.middle_name}" }
+  let(:updated_value) { "New #{Faker::Name.first_name} #{Faker::Name.neutral_first_name}" }
   it 'Create using factory bot' do
     @contact = FactoryBot.create(:contact)
   end

data/lib/leap_salesforce/parameters.rb

@@ -17,7 +17,7 @@ module LeapSalesforce
   @client_secret = ENV['client_secret']
   @password = ENV['password']
   @environment = nil
-  @logger = Logger.new STDOUT
+  @logger = Logger.new $stdout
   @sfdx = false
   # @access_token = nil
   @instance_url = nil
@@ -98,7 +98,7 @@ module LeapSalesforce
                   else
                     LeapSalesforce::Users.where(user)&.username
                   end
-      Soaspec::SpecLogger.info "Using user '#{@api_user}'"
+      Soaspec::SpecLogger.info "Using user '#{@api_user}' for API"
     end
 
     # @return [String] Salesforce username used to execute API tests. This can be changed during tests
@@ -128,6 +128,7 @@ module LeapSalesforce
     attr_reader :soql_objects
     # @return [Logger] Logger used by LeapSalesforce
     attr_accessor :logger
+
     # @return [Array] list_of_soql_objects Array describing Soql objects taken from .leap_salesforce.yml
     def soql_objects=(list_of_soql_objects)
       @soql_objects = list_of_soql_objects.collect do |soql_object_desc|

data/lib/leap_salesforce/soql_data/soql.rb

@@ -150,7 +150,8 @@ module LeapSalesforce
       elsif value[0] == 'I' # 'N' not 2nd character
         ['=', value]
       elsif value[0] == '!'
-        ['!=', value[1..-1]]
+        remaining = value[1..-1] == 'nil' ? 'null' : value[1..-1]
+        ['!=', remaining]
       else
         [value[0], value[1..-1]]
       end

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -72,13 +72,13 @@ module SoqlGlobalObjectData
   # @param [Hash] lookup Key value pair unique to Salesforce to query for
   # @yield [id] Perform block for each id returned. The 'id' parameter in a block represents an id matching the query
   # @return [Array] List of ids matching criteria. Only used if no block given
-  def ids_where(lookup = {})
+  def ids_where(lookup = {}, &block)
     lookup[:limit] ||= nil # Don't limit results returned
     SoqlHandler.new("Each Id where #{self}").use
     results = soql.query soql.soql_id(lookup), wait: false
     ids = results.ids
     if block_given?
-      ids.each { |id| yield(id) }
+      ids.each(&block)
     else
       ids
     end

data/lib/leap_salesforce/soql_data/soql_object_describe.rb

@@ -98,4 +98,27 @@ module SoqlObjectDescribe
   def field_names
     fields.collect { |field| field['name'] }
   end
+
+  # @return [Hash] List of accessors for an object and what they relate to
+  def accessors
+    return @attr_hash if @attr_hash
+
+    @attr_hash = {}
+    fields.each do |field|
+      @attr_hash[field['label'].unused_ruby_name.to_sym] = important_attributes_for(field)
+    end
+    @attr_hash
+  end
+
+  private
+
+  # @return [Hash] Important attributes for a field
+  def important_attributes_for(field)
+    important_attributes = { backend: field['name'],
+                             label: field['label'],
+                             type: field['type'] }
+    relationship_name = field['relationshipName']
+    important_attributes[:related_object] = relationship_name if relationship_name
+    important_attributes
+  end
 end

data/lib/leap_salesforce/users/user.rb

@@ -16,9 +16,9 @@ module LeapSalesforce
 
     # @param [String, Symbol] key Key used to identify a test user
     # @param [String] username Name used to login with user. In email address format.
-    def initialize(key, username, description: nil)
-      self.key = key
-      self.username = username
+    def initialize(*user_params, description: nil)
+      self.key = user_params[0]
+      self.username = user_params[1]
       self.description = description
     end
 
@@ -85,11 +85,9 @@ module LeapSalesforce
     private
 
     # Execute block as admin user, raising error if User class is not defined
-    def admin_query_user
+    def admin_query_user(&block)
       if defined? ::User
-        Users.execute_as_if_present key: :admin do
-          yield
-        end
+        Users.execute_as_if_present key: :admin, &block
       else
         raise LeapSalesforce::SetupError, "'User' class must be defined " \
         " to check presence of user in environment #{LeapSalesforce.environment}"

data/lib/leap_salesforce/users/users.rb

@@ -23,8 +23,12 @@ module LeapSalesforce
           raise LeapSalesforce::UserError, "Incorrect type #{user.class} for user. Expected either " \
           'type LeapSalesforce::User or Array'
         end
+        if user[2]
+          desc = user[2].is_a?(Hash) ? user[2].values[0] : user[2].dup
+          user[2] = nil
+        end
 
-        @list << User.new(*user)
+        @list << User.new(*user, description: desc)
       end
 
       # @example Filter user by key of :admin
@@ -34,14 +38,16 @@ module LeapSalesforce
       # @example Filter user by username
       #   where(username: 'username@domain.com')
       # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find users by
-      # @param [Boolean] all Whether to return all users matching criteria, not just first
+      # @param_key [Boolean] all Whether to return all users matching criteria, not just first
       # @return [LeapSalesforce::User, Array] A user that meets the criteria.
       #   If all is true this returns array of users
-      def where(filter, all: false)
-        @all = all
+      def where(filter)
+        @all = false
         case filter
         when :default then list.first # Will then use first user defined
-        when Hash then match_params filter
+        when Hash
+          @all = filter[:all] || false
+          match_params filter
         when String then match_params(username: filter)
         when Symbol then match_params(key: filter)
         when Regexp then match_params(description: filter)
@@ -54,11 +60,11 @@ module LeapSalesforce
       alias [] where
 
       # Iterate through each user, narrowing on filter if provided
-      def each(filter = nil)
+      def each(filter = nil, &block)
         if filter
-          where(filter, all: true).each { yield }
+          where({ **filter, all: true }).each(&block)
         else
-          list.each { yield }
+          list.each(&block)
         end
       end
 
@@ -86,11 +92,11 @@ module LeapSalesforce
       # Execute block as user matching filter if that user is present
       # If user is not present the current user will be used
       # @return [Object] Result of block
-      def execute_as_if_present(user_filter)
+      def execute_as_if_present(user_filter, &block)
         raise ArgumentError, 'Pass block to :execute_as_if_present method' unless block_given?
 
         if any? user_filter
-          execute_as(user_filter) { yield }
+          execute_as(user_filter, &block)
         else
           LeapSalesforce.logger.warn "No user found user filter #{user_filter}, using '#{LeapSalesforce.api_user}'"
           yield

data/lib/leap_salesforce/version.rb

@@ -2,5 +2,5 @@
 
 module LeapSalesforce
   # @return [String] Version of leap salesforce
-  VERSION = '0.2.28'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.28
+  version: 1.0.4
 platform: ruby
 authors:
 - IQA
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -355,7 +355,7 @@ homepage: https://gitlab.com/leap-dojo/leap_salesforce
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -371,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Helps with setting up integrated automated test frameworks against Salesforce.
 test_files: []