cucumber_helper 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20dd3877d2b27db23058ce01a0467b4e5dd272a2443952065f074866cb743d71
+  data.tar.gz: 3eee61c3235e724a70b538d323628065e8ef2d1cce06e248f8d0d78003894fe8
+SHA512:
+  metadata.gz: 6f8d04e795d741e555726f1051aebd2d427cfee29b69472c6a9dfa70cf8d9f71e5d8ac05285be5235dd7703b1b7ece9980a41ecf8eb60a0b1de5dbc76047b271
+  data.tar.gz: 2826c36e96569bb71ae59cc135a0dec542c641d8fa6db7e7e6c50a6d7ae968d9129cf9da434f17e0434b0dd1703fe625ff3a887eea93a5431cffc79b690dfb0b

data/README.md

@@ -0,0 +1,320 @@
+**Cucumber Helper for Automation**
+
+You can install this gem locally directly by clone this repo or using bundle.
+by using this we don't need to handle per-repo if there is code changes/update, instead we only update this gem.
+
+## Local Installation
+
+### Build Gem from repo
+
+1. Clone this repository
+
+```sh
+git clone https://bitbucket.org/mid-kelola-indonesia/cucumber-helper.git
+
+# or using ssh
+git clone git@bitbucket.org:mid-kelola-indonesia/cucumber-helper.git
+```
+
+2. Go to the repo root folder and build and install the gem
+
+```sh
+cd cucumber-helper
+gem build cucumber_helper.gemspec
+gem install ./cucumber_helper-0.0.1.gem # cucumber_helper-0.0.1.gem should be written as in File output in gem build
+```
+
+### Using specific_install gem
+
+```sh
+gem install specific_install
+gem specific_install https://bitbucket.org/mid-kelola-indonesia/cucumber-helper.git
+```
+
+## Integrate with Your Automation Repo
+
+1. Go to your test automation Repo and open the Gemfile (eg: Nemo) using you file editor and add this line:
+
+```ruby
+# Gemfile 
+
+gem 'cucumber_helper', git: 'https://bitbucket.org/mid-kelola-indonesia/cucumber-helper.git'
+# or by tag/branch
+gem 'cucumber_helper', git: 'https://bitbucket.org/mid-kelola-indonesia/cucumber-helper.git', tag: '0.0.3'
+gem 'cucumber_helper', git: 'https://bitbucket.org/mid-kelola-indonesia/cucumber-helper.git', branch: 'update-dalt'
+```
+
+## Usage
+
+2. Import the library in env.rb
+
+```ruby
+# env.rb
+
+# for API
+require 'cucumber_helper/api' 
+# or for WEB 
+require 'cucumber_helper/web'
+
+# if you want to add general code for setup env like setup browser
+# you need to add this
+require 'cucumber_helper/support'
+.....
+# setup browser using cucumber_helper support module, put after set SHORT_TIMEOUT and DEFAULT_TIMEOUT
+path = create_report_path
+create_browser path
+config_rspec
+.....
+```
+
+3. Add helper function in hooks.rb
+
+```ruby
+# hooks.rb
+Before do |scenario|
+  ....
+  @tags = scn_tags(scenario)
+  ....
+end
+
+After do |scenario|
+  .....
+  capture_screenshot(scenario)
+  handle_continue(scenario)
+  delete_downloaded_file
+  .....
+end
+```
+
+4. If using docker make sure using the latest version by using bundle update command after bundle install
+
+```sh
+# docker.sh
+
+....
+bundle install
+bundle update cucumber_helper
+....
+
+```
+
+### Hooks Helper
+
+- **scn_tags(scenario)** : get the scenario tags into array of tags
+- **capture_screenshot(scenario)** : capture screenshot if the scenario failed
+- **handle_continue(scenario)** : make scenario with @continue tag didn't delete its cookies/cache data
+- **delete_downloaded_file** : delete all downloaded file at ./features/data/downloaded
+
+```ruby
+# hooks.rb
+Before do |scenario|
+  @tags = scn_tags(scenario)
+end
+
+After do |scenario|
+  # .... Your Automation Script .....
+  capture_screenshot(scenario)
+  handle_continue(scenario)
+  delete_downloaded_file
+end
+
+``` 
+
+## Common Helper
+
+This Repo contains many function that generally help to setup automation:
+
+- **save_variable(name, value)**
+
+  This to save the variable to _instance variable_ or _global variable_.
+
+  _Instance Variable_ is variable that can used in 1 scenario but different step.
+
+  _Global Variable_ is variable that can used in different scenario and/or different step.
+
+  to save as global variable you need to add `$` in front of variable name, ex: (`save_variable('$test', 1234)` -> result in $test = 1234)
+  For instance variable no need to add `@` but the result will have `@` front of its name, ex: (`save_variable('test', 1234)` -> result in @test = 1234)
+
+example:
+
+```ruby
+# your_step.rb
+When('user save the data variable to {string}') do |name|
+  save_variable(name, @data)
+end
+
+# your_feature.feature
+Scenario: Scenario 1
+.....
+
+# to save as Global Variable
+When user save the data variable to "$test"
+# it will save as instance variable
+When user save the data variable to "test"
+.....
+Then user validate "test" data
+
+Scenario: Scenario 2
+.....
+# the $test is variable from Scenario 1
+Then user validate "$test" data
+....
+
+
+```
+
+- **production?**
+
+  basically it check for @production tag and the base_url contains mekari.com
+
+```ruby
+# your_step.rb
+if production? 
+  # do something...
+else
+  # do something else ...
+end
+
+```
+
+- **TestDataHelper** class
+
+  It help you load your data in yml format if you have different data in staging or production.
+  e.g you have different note id in staging and production to test.
+  by default, this helper will load file: features/data/test/test_data.yml in variable @test_data
+
+```ruby
+# test_data.yaml file:
+note_id:
+  staging: 11
+  production: 5
+
+# your_step.rb
+When('User open note of employee') do
+  # if need to declare @enviroment to 'staging' or 'production'
+  # in this case, if it run on staging, @test_data['note_id'] = 11,
+  # if it run in production @test_data['note_id'] = 5
+  @pages.employee_page.notes_id.find { |x| x.text == @test_data['note_id'] }.click
+  waiting_for_page_ready
+end
+
+```
+
+- **DataHelper** class
+
+  used for load email / password, generally it used to handle stored credentials
+
+```ruby
+When(/^user login using "(.*)" account$/) do |credential_type|
+  @data_login = DataHelper.new(@user_yml_data).prepare_credentials(credential_type)
+  @pages.login_page.input_email.set @data_login['email']
+  @pages.login_page.input_password.set @data_login['password']
+  # .....
+
+end
+```
+
+## API Automation Helper
+
+- **pretty_json(response)**
+
+  log your json pretty format
+
+```ruby
+log pretty_json(@response)
+# >> will write in log file:
+# { 
+#   "message" : "message .....",
+# }
+# instead : { "message" : "message ...." }
+
+```
+## WEB Automation Helper
+
+Many general function are included in this gem
+
+```ruby
+# you can open file in ./lib/cucumber_helper/web/helpers.rb
+# this include:
+waiting_for_page_ready
+short_wait
+wait_for_download
+waiting_for_xhr_complete
+adjust_comma_number
+parse_rp
+# and many more ...
+
+```
+- **TableSection** class helper
+
+
+  This is to help automation of table in an page
+  example your page have table:
+
+| name         | Description | Package   |
+| -------------|-------------|-----------|
+| Benefit A    | HR Dept     | Package A |
+| Benefit B    | Quality     | Package B |
+
+the functions are:
+
+```ruby
+click_header(name)
+# argument:
+# - name: Header name in column, example: name, Description, Package
+# - exact_text: true or false
+# - sort_arrow: true or false
+# - sort_path: css path of the element
+# example: @pages.employee_page.employee_table.click_header('Employee name')
+#          @pages.employee_page.employee_table.click_header('Employee name', sort_arrow: true) # if using sort arrow to sort table
+
+data_column(name)
+# argument:
+# - name: Header name in column, example: name, Description, Package
+# - exact_text: true or false
+
+data_row_as_text(row_number)
+# argument:
+# - row_number: row number
+
+data_column_as_text(name)
+# argument:
+# - name: Header name in column, example: name, Description, Package
+# - exact_text: true or false
+
+data_column(name)
+# argument:
+# - name: Header name in column, example: name, Description, Package
+# - exact_text: true or false
+
+click_data_column(col_name, text)
+# argument:
+# - col_name: Header name in column, example: name, Description, Package
+# - text: Cell text in table example: Quality, Package A
+# - exact_text: true or false
+```
+
+```ruby
+# your_page_class.rb
+class BenefitPage < SitePrism::Page
+  .....
+  # TableSection is in our Gem, so no need to declare it in our repo
+  # do rather than defining each column, we only need to define the table once
+  # if you want to add more like button or something you can do:
+  # section :table_benefit, TableSection, '#benefitTable' do
+  #   elements :btn_action, '#actionButton'
+  # end    
+  section :table_benefit, TableSection, '#benefitTable'
+  .....
+end
+
+# your_step.rb
+....
+
+Then(/^user successfully sort column "(.*)" benefit group table$/) do |column|
+  @pages.benefit_page.table_benefit.click_header(column)
+  waiting_for_page_ready
+  data = @pages.benefit_page.table_benefit.data_column_as_text(column)
+  expect(data).to eq data.sort
+end
+```

data/lib/cucumber_helper/api/helpers.rb

@@ -0,0 +1,32 @@
+module CucumberHelper
+  module Api
+    module Helpers
+      def pretty_json(response)
+        begin
+          l = JSON.pretty_generate(JSON.parse(response))[..2000]
+        rescue TypeError
+          l = ''
+        rescue JSON::ParserError
+          l = response.body if response.respond_to? 'body'
+          l = response unless response.respond_to? 'body'
+        end
+        l += '....' if l.size > 2000
+        l
+      end
+
+      def resolve(url)
+        url.gsub!(/\{([a-zA-Z0-9_]+)\}/) do |s|
+          s.gsub!(/[{}]/, '')
+          if instance_variable_defined?("@#{s}") # rubocop:disable Style/GuardClause
+            CGI.escape instance_variable_get("@#{s}").to_s
+          else
+            raise "Did you forget to \"grab\" #{s}?"
+          end
+        end
+        url
+      end
+    end
+  end
+end
+
+World(CucumberHelper::Api::Helpers)

data/lib/cucumber_helper/api/hooks.rb

@@ -0,0 +1,3 @@
+After do |scenario|
+  test_rail_integration(ENV['TESTRAIL_RUN'], scenario_id, scenario.status.to_s) if ENV['is_testrail_update'].eql?('true') && !(ENV['TESTRAIL_RUN'].empty? || ENV['TESTRAIL_RUN'].nil?)
+end

data/lib/cucumber_helper/api/response.rb

@@ -0,0 +1,155 @@
+# Extension of {RestClient::Response} with support for JSON path traversal and validation
+# original code from https://github.com/hidroh/cucumber-api/blob/master/lib/cucumber-api/response.rb
+module Response
+  # Create a Response with JSON path support
+  # @param response [RestClient::Response] original response
+  # @return [Response] self
+  def self.create(response)
+    result = response
+    result.extend Response
+    result
+  end
+
+  def valid_json?(json)
+    JSON.parse(json)
+    true
+  rescue JSON::ParserError
+    false
+  end
+
+  # Check if given JSON path exists
+  # @param json_path [String] a valid JSON path expression
+  # @param json [String] optional JSON from which to check JSON path, default to response body
+  # @return [true, false] true if JSON path is valid and exists, false otherwise
+  def has(json_path, json = nil)
+    json = JSON.parse body if json.nil?
+    !JsonPath.new(json_path, { allow_send: false }).on(json).empty?
+  end
+
+  # Retrieve value of the first JSON element with given JSON path
+  # @param json_path [String] a valid JSON path expression
+  # @param json [String] optional JSON from which to apply JSON path, default to response body
+  # @return [Object] value of first retrieved JSON element in form of Ruby object
+  # @raise [Exception] if JSON path is invalid or no matching JSON element found
+  def get(json_path, json = nil)
+    json = JSON.parse body if json.nil?
+    results = if Gem.loaded_specs['jsonpath'].version < Gem::Version.create('1.1.2')
+                JsonPath.new(json_path).on(json)
+              else
+                JsonPath.new(json_path, { allow_send: false }).on(json)
+              end
+    results.empty? ? nil : results.first
+  end
+
+  # Retrieve value of the first JSON element with given JSON path as given type
+  # @param json_path [String] a valid JSON path expression
+  # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+  # or 'object'
+  # @param json [String] optional JSON from which to apply JSON path, default to response body
+  # @return [Object] value of first retrieved JSON element in form of given type
+  # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+  # required type
+  def get_as_type(json_path, type, json = nil)
+    value = get(json_path, json)
+    case type
+    when 'numeric'
+      valid = value.is_a? Numeric
+    when 'array'
+      valid = value.is_a? Array
+    when 'string'
+      valid = value.is_a? String
+    when 'boolean'
+      valid = [true, false].include? value
+    when 'numeric_string'
+      (valid = value.is_a?(Numeric)) || value.is_a?(String)
+    when 'object'
+      valid = value.is_a? Hash
+    when 'null'
+      valid = value.is_a? NilClass
+    else
+      raise %(Invalid expected type '#{type}')
+    end
+
+    raise %(Expect '#{json_path}' as a '#{type}' but was '#{value.class}'\n#{to_json_s}) unless valid
+
+    value
+  end
+
+  # Retrieve value of the first JSON element with given JSON path as given type, with nil value allowed
+  # @param json_path [String] a valid JSON path expression
+  # @param type [String] required type, possible values are 'numeric', 'array', 'string', 'boolean', 'numeric_string'
+  # or 'object'
+  # @param json [String] optional JSON from which to apply JSON path, default to response body
+  # @return [Object] value of first retrieved JSON element in form of given type or nil
+  # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+  # required type
+  def get_as_type_or_null(json_path, type, json = nil)
+    value = get json_path, json
+    value.nil? ? value : get_as_type(json_path, type, json)
+  end
+
+  # Retrieve value of the first JSON element with given JSON path as given type, and check for a given value
+  # @param json_path [String] a valid JSON path expression
+  # @param type [String] required type, possible values are 'numeric', 'string', 'boolean', or 'numeric_string'
+  # @param value [String] value to check for
+  # @param json [String] optional JSON from which to apply JSON path, default to response body
+  # @return [Object] value of first retrieved JSON element in form of given type or nil
+  # @raise [Exception] if JSON path is invalid or no matching JSON element found or matching element does not match
+  # required type or value
+  def get_as_type_and_check_value(json_path, type, comparison_type, value, json = nil)
+    v = get_as_type(json_path, type, json)
+
+    case comparison_type
+    when 'equal'
+      raise %(Expect '#{json_path}' to be '#{value}' but was '#{v}'\n#{to_json_s}) if value != v.to_s
+
+      v.to_s == value
+    when 'not equal'
+      raise %(Expect '#{json_path}' not to be '#{value}' but was '#{v}'\n#{to_json_s}) if value == v.to_s
+
+      v.to_s != value
+    when 'include'
+      raise %(Expect '#{json_path}' should include '#{value}' but was '#{v}'\n#{to_json_s}) unless v.include?(value)
+
+      v.include?(value)
+    when 'between'
+      # define vstart and vend first
+      range = (vstart..vend)
+      raise %(Expect '#{json_path}' should between '#{vstart}' and '#{vend}' but was '#{v}'\n#{to_json_s}) unless range.include?(value)
+
+      range.include?(value)
+    end
+  end
+
+  # Retrieve pretty JSON response for logging
+  # @return [String] pretty JSON response if verbose setting is true, empty string otherwise
+  def to_json_s
+    if ENV['cucumber_api_verbose'] == 'true'
+      JSON.pretty_generate(JSON.parse(to_s))
+    else
+      ''
+    end
+  end
+
+  def response_include_text(text, response)
+    response = JSON.parse response if valid_json?(response)
+    raise "no text #{text} inside #{response}" if (response.to_s.include? text).eql? false
+  end
+
+  # Retrieve pretty JSON response for logging
+  # @return [String] pretty JSON response if verbose setting is true, empty string otherwise
+  def parser
+    JSON.pretty_generate(JSON.parse(to_s))
+  rescue JSON::ParserError, NoMethodError
+    to_s
+  end
+
+  def pretty_json
+    if parser.size > 2000
+      "#{parser[..2000]}......"
+    else
+      parser
+    end
+  end
+  RestClient::Response.send(:include, self)
+end

data/lib/cucumber_helper/api.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'cucumber_helper/commons'
+
+require 'cucumber_helper/api/hooks'
+require 'cucumber_helper/api/helpers'
+require 'cucumber_helper/api/response'
+
+require 'cucumber_helper/testrail/testrail'
+require 'cucumber_helper/testrail/test_rail_integration'
+
+require 'rest-client'
+require 'json-schema'
+require 'json'
+require 'jsonpath'
+
+include CucumberHelper::Api::Helpers

data/lib/cucumber_helper/commons/command_helpers.rb

@@ -0,0 +1,28 @@
+module CucumberHelper
+  module Commons
+    module Commands
+      alias old_dup dup
+
+      # save variable to instance variable or global variable if prefix is '$'
+      def save_variable(name, value)
+        if name.start_with? '$'
+          create_global = "#{name} = '#{value}'"
+          Module.module_eval create_global
+        else
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      def production?
+        @tags.include?('@production') && ENV['BASE_URL'].include?('mekari.com')
+      end
+
+      def dup
+        Marshal.load(Marshal.dump(self))
+      rescue Exception
+        old_dup
+      end
+    end
+  end
+end
+World(CucumberHelper::Commons::Commands)

data/lib/cucumber_helper/commons/test_data_helper.rb

@@ -0,0 +1,27 @@
+module CucumberHelper
+  module Commons
+    # This class help when you have test data for specific environment:
+    # the YAML can be like:
+    # sample.yaml
+    #
+    # sample_note_id:
+    #   staging: 15
+    #   production: 21
+    #
+    # then you can call with:
+    # testdata = TestDataHelper.new(sample.yml, environment)
+    # note_id = testdata['sample_note_id']
+    class TestDataHelper
+      attr_reader :env
+
+      def initialize(yml, environment)
+        @db = YAML.load_file yml
+        @env = environment
+      end
+
+      def [](key)
+        @db[key][@env]
+      end
+    end
+  end
+end

data/lib/cucumber_helper/commons/user_data_helper.rb

@@ -0,0 +1,19 @@
+module CucumberHelper
+  module Commons
+    # use to get credential email and pass, used mostly on WEB automation
+    class DataHelper
+      def initialize(path)
+        @db = YAML.load_file "features/config/#{path}.yml"
+      end
+
+      def prepare_credentials(user_details)
+        { 'email' => @db['credentials'][user_details]['email'],
+          'password' => @db['credentials'][user_details]['password'] }
+      end
+
+      def user_information(user_details, key)
+        @db['credentials'][user_details][key]
+      end
+    end
+  end
+end

data/lib/cucumber_helper/commons.rb

@@ -0,0 +1,6 @@
+require_relative './commons/command_helpers'
+require_relative './commons/test_data_helper'
+require_relative './commons/user_data_helper'
+
+include CucumberHelper::Commons
+include CucumberHelper::Commons::Commands