leap_salesforce 0.1.0

data/.leap_salesforce.yml

@@ -0,0 +1,10 @@
+environment: uat
+lib_folder: spec/support
+soql_objects:
+  - Case
+  - Contact
+  - Document: ContentDocument
+  - User:
+    create_enum: false
+  - Role: Role__c
+  - Account

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+# Modifies RuboCop (Static analysis tool)
+Metrics/LineLength:
+  Max: 160

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at leap.salesforce@integrationqa.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in leap_salesforce.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 IQA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# LeapSalesforce
+
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'leap_salesforce'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leap_salesforce
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/leap-dojo/leap_salesforce. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SfTest project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/leap-dojo/leap_salesforce/blob/master/CODE_OF_CONDUCT.md).
+
+# Examples
+
+```ruby
+# deleting old contacts
+objects = Contact.each_id_with CreatedDate: "<#{5.days.ago}"
+puts objects.count
+objects.each do |id|
+  puts "Deleting #{id}"
+  Contact.delete id
+end 
+```

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require 'leap_salesforce/rake'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+# TODO: This needs to be in one place
+require 'leap_salesforce'
+LeapSalesforce.api_user = LeapSalesforce::Users.where(key: :cet)
+
+desc "Create stubs for dynamic methods so they're picked up by the IDE"
+task :stub do
+  require 'topoisomerase'
+  Topoisomerase.create_stubs_based_on SoqlData
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'leap_salesforce'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/leap-salesforce

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'leap/salesforce'
+
+# Ask for test user details
+#

data/leap_salesforce.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leap_salesforce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'leap_salesforce'
+  spec.version       = LeapSalesforce::VERSION
+  spec.authors       = ['IQA', 'Samuel Garratt']
+  spec.email         = %w[samuel.garratt@integrationqa.com leap.salesforce@integrationqa.com]
+
+  spec.summary       = 'Helps with setting up integrated automated test frameworks
+                        against Salesforce.'
+  spec.description   = 'This gem helps ones to perform integration tests on Salesforce.
+It reads the Metadata from Salesforce and creates the foundation for API tests.'
+  spec.homepage      = 'https://gitlab.com/leap-dojo/leap_salesforce'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'topoisomerase'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'factory_bot'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'require_all'
+  spec.add_dependency 'rubocop'
+  spec.add_dependency 'rubykeyword'
+  spec.add_dependency 'soaspec'
+  spec.add_dependency 'thor'
+end

data/lib/leap_salesforce/ext/string.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'nori/core_ext'
+require 'rubykeyword'
+
+# Override string object to provide convenience methods for Strings
+class String
+  # @todo: Have method of replacing all
+  # @return [String] Remove many complex characters to make a key for a Ruby Hash that is usable
+  def to_key_name
+    tr(' ,', '_').tr("'/()-:", '').tr('&', '').gsub('<', 'gt').tr('ā', 'a').snakecase.gsub('__', '_')
+  end
+
+  # A ruby friendly method name that is not taken by keywords like 'class', 'alias'
+  # @return [String] Ruby friendly name that can be used as method name
+  def unused_ruby_name
+    name = to_key_name
+    name.keyword? ? "my_#{name}" : name
+  end
+
+  # @return [String] Zulu time stamp for string
+  def to_zulu_date_string
+    Time.parse(self).strftime('%Y-%m-%dT%H:%M:%S.000Z')
+  end
+
+  # @return [Boolean] Whether string can be parsed into a time
+  def type_of_time?
+    Time.parse self
+  rescue ArgumentError
+    false
+  else
+    true
+  end
+end

data/lib/leap_salesforce/ext/time.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# adding additional methods to inbuit time object
+class Time
+  # @return [String] String represents time in salesforce format
+  def salesforce_format
+    strftime('%Y-%m-%d')
+  end
+
+  # @param [String] date_string Date returned from salesforce
+  # @return [Time] Time object created from salesforce date String
+  def self.parse_salesforce(date_string)
+    mktime(*date_string.split('-'))
+  end
+end

data/lib/leap_salesforce/generator/default_fields.rb

@@ -0,0 +1,13 @@
+module LeapSalesforce
+  module DefaultFields
+    class << self
+      def contact
+        %w[FirstName LastName]
+      end
+
+      def account
+        ['Name']
+      end
+    end
+  end
+end

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -0,0 +1,46 @@
+require_relative 'soql_objects'
+
+module LeapSalesforce
+  # Generators for creating code
+  module Generator
+    # Creates Soql Enumerations / Picklists
+    class SoqlEnums
+      include Generator
+
+      ENUM_FOLDER = File.join(LeapSalesforce.lib_folder, 'metadata', 'enum').freeze
+
+      # Create Soql enumerations for all objects specified to verify
+      def create
+        if LeapSalesforce.objects_to_verify.empty?
+          raise LeapSalesforce::SetupError, 'LeapSalesforce.objects_to_verify is empty. ' \
+        'Please set the list of objects you want to verify in .leap_salesforce:soql_objects ' \
+        'and then run task "leaps:create_soql_objects" to create objects'
+        end
+
+        LeapSalesforce.objects_to_verify.each do |entity|
+          unless entity.create_enum?
+            puts "Skipping picklists for #{entity}"
+            next
+          end
+
+          puts "Creating picklists for #{entity}"
+          @entity_name = entity
+          picklists = entity.picklists
+          puts "#{picklists.count} picklists found"
+          picklists.each do |picklist|
+            @picklist = picklist
+            @enum_name = picklist.tr(" '/()-", '')
+            picklist_name = picklist.snakecase.tr(' ', '_')
+            values = entity.picklist_for picklist
+            @enum_values = {}
+            values.each { |value| @enum_values[value.to_key_name] = value }
+            content = read_template 'picklist.rb.erb', binding
+            file = File.join(ENUM_FOLDER, entity.to_s.snakecase, "#{picklist_name}.rb")
+            generate_file file, content
+          end
+        end
+        `rubocop -a #{ENUM_FOLDER}`
+      end
+    end
+  end
+end

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+require_relative 'default_fields'
+
+module LeapSalesforce
+  # Generators for creating code
+  module Generator
+    # @param [String] filename Relative filename to this file
+    # @param [Binding] binding Binding object used for ERB variables
+    # @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)
+    end
+
+    # Generate file creating necessary folder if necessary
+    # @param [String] filename Name of file to generate
+    # @param [String] content Content to put within file
+    def generate_file(filename, content)
+      FileUtils.mkdir_p File.dirname filename unless File.directory? File.dirname(filename)
+      File.write filename, content
+      puts "Created file at #{filename}"
+    end
+
+    # Creates SoqlObjects and related modules
+    class SoqlObjects
+      include Generator
+
+      SOQL_OBJECT_FOLDER = File.join(LeapSalesforce.lib_folder, 'soql_data').freeze
+      FACTORY_FOLDER = File.join(LeapSalesforce.lib_folder, 'factories').freeze
+
+      # Extracts the soql_object defined in '.leap_salesforce.yml' and assigns instance variables
+      def extract_info_from_object(soql_object)
+        @class_name, @soql_object = case soql_object
+                                    when Hash
+                                      @create_enum = soql_object['create_enum'].nil? ? true : soql_object['create_enum']
+                                      [soql_object.keys[0], soql_object.values[0] || soql_object.keys[0]]
+                                    else
+                                      [soql_object.to_s, soql_object.to_s]
+                                    end
+      end
+
+      # Create temporary class for building API requests on
+      def ensure_class_defined
+        @soql_class = Object.const_get @class_name
+      rescue NameError
+        @soql_class = Object.const_set @class_name, Class.new(SoqlData)
+        @soql_class.instance_variable_set(:@soql_object_name, @soql_object)
+      end
+
+      # Generate Soql object file
+      def generate_soql_object
+        ensure_class_defined
+        desc = @soql_class.description
+        unless desc.soql_fields?
+          raise LeapSalesforce::SetupError, "Error producing Soql data for '#{@soql_class}', soql table " \
+          " '#{@soql_object}'. Error message: '#{desc.error_message}'"
+        end
+        content = read_template 'soql_object.rb.erb', binding
+        file = File.join(SOQL_OBJECT_FOLDER, "#{@class_name.snakecase}.rb")
+        generate_file file, content
+      end
+
+      # Generate module with fields for Soql Object
+      def generate_field_module
+        field_content = read_template 'soql_object_field_names.rb.erb', binding
+        field_file = File.join(SOQL_OBJECT_FOLDER, "#{@field_name_file}.rb")
+        generate_file field_file, field_content
+      end
+
+      # Generate factory for mass generating objects using FactoryBot
+      def generate_factory
+        class_method_name = @class_name.snakecase
+        all_fields = @soql_class.fields
+        @default_fields, @other_fields = if DefaultFields.respond_to? class_method_name
+          all_fields.partition { |field| DefaultFields.send(class_method_name).include? field['name'] }
+                                         else
+                                           [[], all_fields]
+                                         end
+        content = read_template 'factory.rb.erb', binding
+        file = File.join(FACTORY_FOLDER, "#{@class_name.snakecase}.rb")
+        generate_file file, content
+      end
+
+      # Generate soql_object and it's related modules, factories
+      def create_all
+        LeapSalesforce.soql_objects.each do |soql_object|
+          extract_info_from_object soql_object
+          @field_name_file = "#{@class_name.snakecase}_field_names"
+          generate_soql_object
+          generate_field_module
+          generate_factory
+        end
+        `rubocop -a #{SOQL_OBJECT_FOLDER}`
+        `rubocop -a #{FACTORY_FOLDER}`
+      end
+    end
+  end
+end

data/lib/leap_salesforce/generator/templates/factory.rb.erb

@@ -0,0 +1,12 @@
+# Basic factory settings made according to values defined at
+# https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_case.htm
+FactoryBot.define do
+  <%= "factory :#{@class_name.snakecase} do" %>
+    <% @default_fields.each do |field| %>
+    <%= "#{field['label'].unused_ruby_name} { 'Content depending on #{field['type']}' }" %> <% end %>
+    trait :all do
+      <% @other_fields.each do |field| %>
+      <%= "#{field['label'].unused_ruby_name} { 'Content depending on #{field['type']}' }" %> <% end %>
+    end
+  <%= 'end' %>
+end

data/lib/leap_salesforce/generator/templates/picklist.rb.erb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Helps handle picklist values for <%= "#{@entity_name}, #{@enum_name}" %>
+class <%= @entity_name %> < SoqlData
+  # Enumeration for <%= @enum_name %>
+  module <%= @enum_name %>
+    include SoqlEnum
+  <% @enum_values.each do |name, value| %>
+    @<%= name.to_s %> = "<%= value %>"
+  <% end %>
+    class << self
+      # @return [String] Sample value from Enum
+      def sample
+        values.sample
+      end
+
+      # @return [String] Name of picklist as returned from Metadata
+      def name
+        '<%= @picklist %>'
+      end
+
+      # @return [Array] List of values for <%= @enum_name %>
+      def values
+        <%= @enum_values.values %>
+      end
+
+      attr_reader <%= @enum_values.keys.collect(&:to_sym).to_s.tr('[]','') %>
+    end
+  end
+end

data/lib/leap_salesforce/generator/templates/soql_object.rb.erb

@@ -0,0 +1,7 @@
+require_relative '<%= @field_name_file %>'
+# An <%= @class_name %> object mapping to a SOQL <%= @soql_object %>
+class <%= @class_name %> < SoqlData
+  include <%= @class_name %>::Fields
+  <%= "soql_object '#{@soql_object}'" unless @soql_object == @class_name %>
+  <%= "create_enum false" if @create_enum == false %>
+end

data/lib/leap_salesforce/generator/templates/soql_object_field_names.rb.erb

@@ -0,0 +1,10 @@
+# Fields for <%= @class_name %> mapped from SOQL <%= @soql_object %>
+class <%= @class_name %> < SoqlData
+  module Fields
+    extend SoqlGlobalObjectData
+    <% @soql_class.fields.each do |field| %>
+    # Element for '<%= field['label'] %>', type '<%= field['type'] %>'
+    soql_element :<%= field['label'].unused_ruby_name %>, '<%= field['name'] %>'
+    <% end %>
+  end
+end

data/lib/leap_salesforce/limits.rb

@@ -0,0 +1,13 @@
+module LeapSalesforce
+  # Handles retrieving limits of a Salesforce instance
+  class Limits
+    class << self
+      # @param [Symbol, String] limit_name Name of limit to find remaining amount for
+      # @return [Integer] Finds remaining amount for a Salesforce limit
+      def remaining_for(limit_name)
+        limit_data = SoqlData.limits[limit_name]
+        limit_data['Max'] - limit_data['Remaining']
+      end
+    end
+  end
+end

data/lib/leap_salesforce/parameters.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'users/users'
+
+# Adding parameters to set for authentication
+module LeapSalesforce
+  @config_folder = 'config'
+  @lib_folder = File.join('lib', 'leap_salesforce').freeze
+  @objects_to_verify = []
+  @soql_objects = []
+  class << self
+    # @return [String] Environment to use for tests. This can be accessed to change the username used to login
+    #   to test.salesforce with. This can be set on the command line with 'LEAP_ENV'
+    def environment
+      ENV['LEAP_ENV'] || @environment
+    end
+
+    # @param [String, LeapSalesforce::User] user User or email address of user
+    def api_user=(user)
+      @api_user = case user
+                  when String then user
+                  when LeapSalesforce::User then user.username
+                  when :default then nil # Will then use first user defined
+                  else
+                    raise ArgumentError, "Unable to use class '#{user.class}' to set api_user"
+                  end
+    end
+
+    # @return [String] Salesforce username used to execute API tests. This can be changed during tests
+    def api_user
+      @api_user || LeapSalesforce::Users.list.first.username
+    end
+
+    # @return [String] Folder where all configuration is stored. By default this is 'config'
+    attr_accessor :config_folder
+    # @return [String] Environment to use for tests. This can be accessed to change the username used to login
+    #   to test.salesforce with
+    attr_writer :environment
+    # @return [String] Common API password. This assumes all users use the same password
+    attr_accessor :password
+    # @return [String] Client id in Salesforce OAuth app
+    attr_accessor :client_id
+    # @return [String] Client secret in Salesforce OAuth app
+    attr_accessor :client_secret
+    # @return [String] Path where library generated assets are stored. By default lib/leap_salesforce
+    attr_accessor :lib_folder
+    # @return [Array] List of objects to verify metadata for. This includes enums, required values
+    #   Changes to these values will need to be version controlled
+    attr_accessor :objects_to_verify
+    # @return [Array] List of Soql Objects identified for Leap Salesforce to maintain
+    attr_accessor :soql_objects
+  end
+end

data/lib/leap_salesforce/rake/setup.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+
+
+namespace :leaps do
+  desc 'Create Enumeration objects for picklists from Salesforce Metadata'
+  task :create_enums do
+    require_relative '../generator/soql_enums'
+    LeapSalesforce::Generator::SoqlEnums.new.create
+  end
+
+  desc 'Create Soql Data objects'
+  task :create_soql_objects do
+    require_relative '../generator/soql_objects'
+    LeapSalesforce::Generator::SoqlObjects.new.create_all
+  end
+
+  # TODO: This does not work
+  desc 'Create objects, fields, enums'
+  task create_all: :create_soql_objects do
+    # require_all LeapSalesforce.lib_folder
+    LeapSalesforce.objects_to_verify = SoqlData.descendants
+    Rake::Task['leaps:create_enums'].invoke
+  end
+end

data/lib/leap_salesforce/rake.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+import File.join(__dir__, 'rake', 'setup.rake')
+
+# Dir.glob('rake/*.rake').each(&method(:import))