leap_salesforce 1.0.1 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d80eff87ab1c75f73d0f99c2556837698e418c3be87ba611fc044602c262add
-  data.tar.gz: 3a6090439223eeaafdc9194e7e19649ab805abd52885071ddbacc54d9bfd7431
+  metadata.gz: 50460046dd520df2e2b92b0384733e4b7785109d55f42c88d5dd9c81faad23c0
+  data.tar.gz: 1124dc04f4dea935ac48e21b1fccfb8b498b6675f1936164087cd35d75152f4d
 SHA512:
-  metadata.gz: 247b89d8a5059f353cee60834a25aa9c7d480df6a71bf2d262fe99023cdc536e44b670ff874793478e55a75ddf9443a62445e124b138c44d9ec772efd613fbbc
-  data.tar.gz: e05ae5ffee8f34badabdda8a1cb8814ba336df63848ccdb662e85439a1e85c44a59ce179354ea2d9790f7b79afb6ce035dabd8fd5d215b0f70393cfbf6ffe253
+  metadata.gz: 9674782b9b65f4c60fbac4e376594e7ff626c0a538f1f9e1b3ca745d2905bf9ef420a10f7c93d34ab433304cc3989d9329446efa30e2152923e7d07811f0f42c
+  data.tar.gz: f35b3686b4404083210e07cf71ab5ec7c21e132e04bb013dc9aadad245c9538f1152037b64995844b3323431e23bb0070f1195083424757377bf09c3b8d72f4f

data/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 include:
   - template: Code-Quality.gitlab-ci.yml
 
-image: ruby:2.7
+image: ruby:3.0
 
 stages:
   - test
@@ -18,7 +18,7 @@ variables:
 pages:
   stage: deploy
   dependencies:
-    - test_2.7
+    - test
   script:
     - mv coverage/ public
   artifacts:
@@ -612,18 +612,8 @@ pages:
     sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
   }
 
-test_2.6:
-  image: ruby:2.6
-  stage: test
-  script:
-    - *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
-
-test_2.7:
+test:
+  image: ruby:3.0
   script:
     # Decrypt server key
     - *sfdx_helpers
@@ -635,14 +625,3 @@ test_2.7:
   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,21 @@
+Version 1.0.5
+* Fix
+  * Stabilize using of active record by fixing version
+
+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

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?
 
@@ -27,7 +27,7 @@ The benefits of an open source tool like this are:
   and can add extra unit tests if you need more confidence
 * Built with and for CI in Gitlab. Designed to work within Docker containers
 * Will integrate with `sfdx` leveraging all of it's benefits
-* Supported by [IntegrationQA](www.integrationqa.com) who can provide 
+* Supported by [Sentify](https://www.sentify.co/) who can provide 
   [support and training](https://gitlab.com/leap-dojo/leap_salesforce/wikis/SupportModel)
   to help you get started and overcome challenges
 
@@ -260,7 +260,19 @@ The value of request body can be interrogated with `entity.request_parameters.bo
 
 ##### Logging
 
-By default, API traffic will be logged in a log file in a `logs` folder. 
+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
 
@@ -565,4 +577,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)
+* Video walking through setting up automation using this [here](https://youtu.be/Xvj0mAnDKfA)
 

data/leap_salesforce.gemspec

@@ -32,7 +32,7 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_development_dependency 'semaphore_test_boosters'
   spec.add_development_dependency 'topoisomerase'
   spec.add_development_dependency 'yard-doctest'
-  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activerecord', '6.1'
   spec.add_dependency 'colorize'
   spec.add_dependency 'factory_bot'
   spec.add_dependency 'faker', '>= 2.0'

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} --display-only-fail-level-offenses --enable-pending-cops`
+        `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} --enable-pending-cops`
-        `rubocop -a #{FACTORY_FOLDER} --enable-pending-cops`
+        `rubocop -A #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
+        `rubocop -A #{FACTORY_FOLDER} --enable-pending-cops`
       end
 
       private

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_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

@@ -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

@@ -60,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
 
@@ -92,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 = '1.0.1'
+  VERSION = '1.0.5'
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.5
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,16 +99,16 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement