lapis_lazuli 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea6c404b7d1a7a47007360bda7725812af256234c6b33b68626ced98c77b3fd
-  data.tar.gz: e9dc94d78218d53dd6e8bcc0938d8a08481b9e2bc53da9744619183b1f08e099
+  metadata.gz: 6371db0c7cade2ee1594513f572a7c36540be30947f35ec275ca88d8cf29f6f6
+  data.tar.gz: 58f488b7d84511ec095b04b585a8cbfc0c39853d232ce0285e963191a1ad3e9a
 SHA512:
-  metadata.gz: c637008b61477116811bb63e4436f4a00276073da2ad28a6257df7d4812376701e33565000d8abfca02085e6cd6c6877778cff9563609d8f355fa48853006c71
-  data.tar.gz: 858ce3df0863b0fcc949959bbc0cfa11f9e2b78d238d02f68bed2a6c4912d881e4e191eb4e193b9a051c5b8452dc0129d0eaa7ce8d445354c648e0e5c1f902fd
+  metadata.gz: 867d75be07317b7dff52efc926183e48ecc31322a645714fe4aceab9fa2c611f6e2deac7ce00f5c23fee4484407eed495466342dbc91abf80972d6a9caf30ba6
+  data.tar.gz: f7ddb7958fc2a0d87d7f0c8f92132f29851955823faf7df7d2afa0bc0aa02dbf5182359f88b57d8dd5ec796cac25a91fff9d5a132b363d5acbaf8ff1663dc7a9

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 3.0.0
+
+## Breaking changes
+
+* Dropped support for annotation
+* Dropped support for Cucumber `2` and `3`
+
+## Changes
+
+* Updated Cucumber support version to `>= 4`
+* Updated Watir support version to `>= 6`
+* Unlocked all other dependencies.
+* Don't act as an _in between_ party starting up a Watir browser anymore by passing all browser starts arguments directly to Watir.

data/README.md

@@ -7,6 +7,9 @@ test automation suite development.
 [![Code Climate](https://codeclimate.com/github/spriteCloud/lapis-lazuli/badges/gpa.svg)](https://codeclimate.com/github/spriteCloud/lapis-lazuli)
 [![Test Coverage](https://codeclimate.com/github/spriteCloud/lapis-lazuli/badges/coverage.svg)](https://codeclimate.com/github/spriteCloud/lapis-lazuli)
 
+Tested with Cucumber 4, 5 & 6
+For cucumber 2 and 3, have a look at the version 2 release of Lapis Lazuli.
+
 A lot of functionality is aimed at dealing better with [Watir](http://watir.com/),
 such as:
 

data/lapis_lazuli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Cucumber helper functions and scaffolding for easier test automation suite development.}
   spec.homepage      = "https://github.com/spriteCloud/lapis-lazuli"
   spec.license       = "MITNFA"
-  spec.required_ruby_version = '~> 2'
+  spec.required_ruby_version = '>= 2'
   spec.platform    = Gem::Platform::RUBY
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -31,23 +31,23 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", ">= 12.3"
+  spec.add_development_dependency "simplecov", ">= 0.17"
   
-  spec.add_dependency "faraday_middleware", "~> 0.13"
-  spec.add_dependency "faraday_json", "~> 0.1"
-  spec.add_dependency "multi_xml", "~> 0.6"
-  spec.add_dependency "teelogger", "~> 0.5"
-  spec.add_dependency "minitest", "~> 5.11"
-  spec.add_dependency "thor", "~> 0.20" # Used in the cucumber project generator
-  spec.add_dependency "facets", "~> 3.1" # Used in the cucumber project generator
-  spec.add_dependency "deep_merge", "~> 1.2"
+  spec.add_dependency "faraday_middleware", ">= 0.13"
+  spec.add_dependency "faraday_json", ">= 0.1"
+  spec.add_dependency "multi_xml", ">= 0.6"
+  spec.add_dependency "teelogger", ">= 0.5"
+  spec.add_dependency "minitest", ">= 5.11"
+  spec.add_dependency "thor", ">= 0.20" # Used in the cucumber project generator
+  spec.add_dependency "facets", ">= 3.1" # Used in the cucumber project generator
+  spec.add_dependency "deep_merge", ">= 1.2"
 
   # webdriver specifics
-  spec.add_dependency "selenium-webdriver", ">= 2.0", '< 4'
-  spec.add_dependency "watir", "~> 6"
-  spec.add_dependency "ffi", "~> 1.11"
-  spec.add_dependency "cucumber", ">= 2.0", '< 4.0'
+  spec.add_dependency "selenium-webdriver", ">= 2.0"
+  spec.add_dependency "watir", ">= 6"
+  spec.add_dependency "ffi", ">= 1.11"
+  spec.add_dependency "cucumber", ">= 4.0"
 
 end

data/lib/lapis_lazuli.rb

@@ -34,7 +34,6 @@ require "lapis_lazuli/world/config"
 require "lapis_lazuli/world/hooks"
 require "lapis_lazuli/world/variable"
 require "lapis_lazuli/world/error"
-require "lapis_lazuli/world/annotate"
 require "lapis_lazuli/world/logging"
 require "lapis_lazuli/world/browser"
 require "lapis_lazuli/world/api"
@@ -49,7 +48,6 @@ module LapisLazuli
   include LapisLazuli::WorldModule::Hooks
   include LapisLazuli::WorldModule::Variable
   include LapisLazuli::WorldModule::Error
-  include LapisLazuli::WorldModule::Annotate
   include LapisLazuli::WorldModule::Logging
   include LapisLazuli::WorldModule::Browser
   include LapisLazuli::WorldModule::API

data/lib/lapis_lazuli/ast.rb

@@ -5,23 +5,7 @@
 # Copyright (c) 2015 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
-
-# Hack for cucumber 2.0.x
-begin
-  module Cucumber
-    module Core
-      module Ast
-        class ExamplesTable
-          public :example_rows
-        end # ExamplesTable
-      end # Ast
-    end # Core
-  end # Cucumber
-rescue NameError
-  # Not cucumber 2.0.x
-end
-
-
+#
 module LapisLazuli
   ##
   # Convenience module for dealing with aspects of the cucumber AST. From
@@ -30,131 +14,8 @@ module LapisLazuli
     ##
     # Return a unique and human parsable ID for scenarios
     def scenario_id(scenario)
-      # For 2.0.x, the best scenario ID is one prefixed by the file name + line
-      # number, followed by the feature name, scenario name, and table data (if
-      # applicable).
-      if is_cucumber_2?(scenario)
-        id = [scenario.location.to_s]
-        for i in 0 .. scenario.source.length - 1 do
-          part = scenario.source[i]
-          if part.respond_to?(:name)
-            id << part.name
-          elsif part.is_a?(Cucumber::Core::Ast::ExamplesTable::Row)
-            id << part.values.join("|")
-          end
-        end
-        return id
-      end
-
-      case scenario
-      when Cucumber::Ast::Scenario
-        return [
-          scenario.feature.file,
-          scenario.name
-        ]
-      when Cucumber::Ast::OutlineTable::ExampleRow
-        return [
-          scenario.scenario_outline.feature.file,
-          scenario.scenario_outline.name,
-          scenario.name
-        ]
-      end
-    end
-
-
-    ##
-    # Tests whether the given scenario object indicates we're using cucumber 2.x
-    def is_cucumber_2?(scenario)
-      begin
-        # The assumption - FIXME perhaps wrong - is that cucumber 1.3.x does not
-        # have this source array.
-        return (scenario.respond_to?(:source) and scenario.source.is_a?(Array))
-      rescue
-        return false
-      end
-    end
-
-
-    ##
-    # Tests whether the scenario object is a single scenario
-    def is_scenario?(scenario)
-      begin
-        # 1.3.x
-        return scenario.class == Cucumber::Ast::Scenario
-      rescue
-        # 2.0.x - everything is a Cucumber::Core::Test::Case
-        return (not scenario.outline?)
-      end
+      [scenario.id]
     end
 
-
-    ##
-    # Tests whether the scenario object is a table row
-    def is_table_row?(scenario)
-      begin
-        # 1.3.x
-        return scenario.class == Cucumber::Ast::OutlineTable::ExampleRow
-      rescue
-        # 2.0.x - everything is a Cucumber::Core::Test::Case
-        return scenario.outline?
-      end
-    end
-
-
-    ##
-    # Tests whether this scenario is the last scenario of a feature
-    def is_last_scenario?(scenario)
-      if is_scenario?(scenario)
-        begin
-          # 2.0.x
-          return (scenario.feature.feature_elements.last.location == scenario.location)
-        rescue
-          # 1.3.x
-          return (scenario.feature.feature_elements.last == scenario)
-        end
-
-      elsif is_table_row?(scenario)
-        begin
-          # 2.0.x
-
-          # We can bail early if this scenario's line is < the last feature
-          # element's line
-          outline = scenario.feature.feature_elements.last
-          if scenario.source.last.location.line < outline.location.line
-            return false
-          end
-
-          # Now the last feature element needs to be an outline - this is a
-          # sanity check that makes later stuff easier
-          if not outline.respond_to? :examples_tables
-            return false
-          end
-
-          # The last row of the last examples tables is what we care about
-          last_row = outline.examples_tables.last.example_rows.last
-
-          # If the current scenario has the same location as the last example,
-          # then we're the last scenario.
-          return scenario.source.last.location.line == last_row.location.line
-
-        rescue
-          # 1.3.x
-          if scenario.scenario_outline.feature.feature_elements.last == scenario.scenario_outline
-            # And is this the last example in the table?
-            is_last_example = false
-            scenario.scenario_outline.each_example_row do |row|
-              if row == scenario
-                is_last_example = true
-              else
-                # Overwrite this again with 'false'
-                is_last_example = false
-              end
-            end
-            return is_last_example
-          end
-        end
-      end
-      raise "If you see this error it might indicate you're running an unsupported version of cucumber"
-    end
   end # module Ast
 end # module LapisLazuli

data/lib/lapis_lazuli/browser.rb

@@ -5,16 +5,13 @@
 # Copyright (c) 2013-2019 spriteCloud B.V. and other LapisLazuli contributors.
 # All rights reserved.
 #
-
 require "lapis_lazuli/ast"
-
 # Modules
 require "lapis_lazuli/browser/error"
 require 'lapis_lazuli/browser/find'
 require "lapis_lazuli/browser/wait"
 require "lapis_lazuli/browser/screenshots"
 require "lapis_lazuli/browser/interaction"
-require "lapis_lazuli/browser/remote"
 require 'lapis_lazuli/generic/xpath'
 require 'lapis_lazuli/generic/assertions'
 
@@ -27,19 +24,18 @@ module LapisLazuli
   # object, and for some WorldModules to exist in it (see assertions in
   # constructor).
   class Browser
-    include LapisLazuli::Ast
 
     include LapisLazuli::BrowserModule::Error
     include LapisLazuli::BrowserModule::Find
     include LapisLazuli::BrowserModule::Wait
     include LapisLazuli::BrowserModule::Screenshots
     include LapisLazuli::BrowserModule::Interaction
-    include LapisLazuli::BrowserModule::Remote
     include LapisLazuli::GenericModule::XPath
 
-    @@world=nil
-    @@cached_browser_options={}
-    @@browsers=[]
+    @@world = nil
+    @@cached_browser_options = {}
+    @@browsers = []
+
     class << self
       include LapisLazuli::GenericModule::Assertions
 
@@ -70,11 +66,9 @@ module LapisLazuli
     end
 
     @browser
-    @browser_name
-    @browser_wanted
-    @optional_data
+    @browser_args
 
-    attr_reader :browser_name, :browser_wanted, :optional_data
+    attr_reader :browser_args
 
     def initialize(*args)
       # The class only works with some modules loaded; they're loaded by the
@@ -94,8 +88,7 @@ module LapisLazuli
     # Support browser.dup to create a duplicate
     def initialize_copy(source)
       super
-      @optional_data = @optional_data.dup
-      @browser = create_driver(@browser_wanted, @optional_data)
+      @browser = create_driver(*@browser_args)
       # Add this browser to the list of all browsers
       LapisLazuli::Browser.add_browser(self)
     end
@@ -124,7 +117,7 @@ module LapisLazuli
         # Add this browser to the list of all browsers
         LapisLazuli::Browser.add_browser(self)
         # Making sure all browsers are gracefully closed when the exit event is triggered.
-        at_exit {LapisLazuli::Browser::close_all 'exit event trigger'}
+        at_exit { LapisLazuli::Browser::close_all 'exit event trigger' }
       end
     end
 
@@ -138,7 +131,7 @@ module LapisLazuli
 
     ##
     # Closes the browser and updates LL so that it will open a new one if needed
-    def close(reason = nil, remove_from_list=true)
+    def close(reason = nil, remove_from_list = true)
       if not @browser.nil?
         if not reason.nil?
           reason = " after #{reason}"
@@ -171,18 +164,39 @@ module LapisLazuli
       # Determine the config
       close_browser_after = world.env_or_config("close_browser_after")
       case close_browser_after
-        when "scenario"
-          # We always close it
+      when "scenario"
+        # We always close it
+        LapisLazuli::Browser.close_all close_browser_after
+      when "never"
+        # Do nothing: party time, excellent!
+      when "feature"
+        if is_last_scenario?(scenario)
+          # Close it
           LapisLazuli::Browser.close_all close_browser_after
-        when "never"
-          # Do nothing: party time, excellent!
-        when "feature"
-          if is_last_scenario?(scenario)
-            # Close it
-            LapisLazuli::Browser.close_all close_browser_after
-          end
-        else # close after 'end' is now default
-          # Also ignored here - this is handled  in World.browser_destroy
+        end
+      else
+        # close after 'end' is now default
+        # Also ignored here - this is handled  in World.browser_destroy
+      end
+    end
+
+    def is_last_scenario?(scenario)
+      begin
+        feature_file = File.read(scenario.location.file)
+        gherkin_object = Gherkin::Parser.new.parse(feature_file)
+        last_line = gherkin_object[:feature][:children].last[:scenario][:examples].last[:table_body].last[:location][:line] rescue nil
+        unless last_line
+          last_line = gherkin_object[:feature][:children].last[:scenario][:location][:line] rescue nil
+        end
+        if last_line
+          return last_line == scenario.location.line
+        else
+          warn 'Failed to find the last line of the feature trying to determine if this is the last scenario running.'
+          return false
+        end
+      rescue Exception => e
+        warn 'Something went wrong trying to determine if this is the last sceanrio of the feature.'
+        warn e
       end
     end
 
@@ -209,7 +223,7 @@ module LapisLazuli
       LapisLazuli::Browser.close_all("end")
     end
 
-    def self.close_all(reason=nil)
+    def self.close_all(reason = nil)
       # A running browser should exist and we are allowed to close it
       if @@browsers.length != 0 and @@world.env_or_config("close_browser_after") != "never"
         # Notify user
@@ -225,68 +239,22 @@ module LapisLazuli
     end
 
     private
+
     ##
     # The main browser window for testing
-    def init(browser_wanted=nil, optional_data=nil)
+    def init(*args)
       # Store the optional data so on restart of the browser it still has the correct configuration
-      if optional_data.nil? and @@cached_browser_options.has_key?(:optional_data) and (browser_wanted.nil? or browser_wanted == @@cached_browser_options[:browser])
-        optional_data = @@cached_browser_options[:optional_data].dup
-        if !@@cached_browser_options[:optional_data][:profile].nil?
-          # A selenium profile needs to be duplicated separately, else it doesn't get a new ID.
-          optional_data[:profile] = @@cached_browser_options[:optional_data][:profile].dup
-        end
-      elsif optional_data.nil?
-        optional_data = {}
-      end
-
-      # Do the same caching stuff for the browser
-      if browser_wanted.nil? and @@cached_browser_options.has_key?(:browser)
-        browser_wanted = @@cached_browser_options[:browser]
-      end
-
-      # Set the default device if the optional data does not contain a specific device
-      if optional_data[:device].nil?
-        # Check if there is a cached value of a previously used
-        if @@cached_browser_options.has_key?(:device)
-          optional_data[:device] = @@cached_browser_options[:device]
-          # Check if the ENV['DEVICE'] variable is set
-        elsif world.env_or_config('DEVICE', false)
-          optional_data[:device] = world.env_or_config('DEVICE')
-          # Else grab the default set device
-        elsif world.env_or_config('default_device', false)
-          optional_data[:device] = world.env_or_config('default_device')
-        else
-          warn 'No default device, nor a selected device was set. Browser default settings will be loaded. More info: http://testautomation.info/Lapis_Lazuli:Device_Simulation'
-        end
-      end
-
-      # cache all the settings if this is the first time opening the browser.
-      if !@@cached_browser_options.has_key? :browser and !@@cached_browser_options.has_key? :optional_data
-        @@cached_browser_options[:browser] = browser_wanted
-        # Duplicate the data as Webdriver modifies it
-        @@cached_browser_options[:optional_data] = optional_data.dup
-        if !@@cached_browser_options[:optional_data][:profile].nil?
-          # A selenium profile needs to be duplicated separately, else it doesn't get a new ID.
-          @@cached_browser_options[:optional_data][:profile] = optional_data[:profile].dup
-        end
-      end
-
-      @browser_wanted = browser_wanted
-      @optional_data = optional_data
-      # Create the browser
-      create_driver(@browser_wanted, @optional_data)
+      create_driver(*args)
     end
 
     ##
     # Create a new browser depending on settings
     # Always cached the supplied arguments
-    def create_driver(browser_wanted=nil, optional_data=nil)
+    def create_driver(*args)
       # Remove device information from optional_data and create a separate variable for it
-      device = optional_data[:device]
-      optional_data.delete :device
-
+      device = args[1] ? args[1].delete(:device) : nil
       # If device is set, load it from the devices.yml config
-      if !device.nil?
+      unless device.nil?
         begin
           world.add_config_from_file('./config/devices.yml')
         rescue
@@ -307,84 +275,6 @@ module LapisLazuli
         raise LoadError, "#{err}: you need to add 'watir' to your Gemfile before using the browser."
       end
 
-      # No browser? Does the config have a browser?
-      if browser_wanted.nil?
-        browser_wanted = world.env_or_config('browser', nil)
-      end
-
-      b = browser_wanted
-      b = b.to_sym unless b.nil?
-
-      # Overwrite user-agent if a device simulation is set and it contains a user-agent
-      if !device_configuration.nil? and !device_configuration['user-agent'].nil?
-        # Firefox user-agent settings
-        # Create a firefox profile if it does not exist yet
-        if optional_data[:profile].nil?
-          optional_data[:profile] = Selenium::WebDriver::Firefox::Profile.new
-        else
-          # If the profile already exists, we need to create a duplicate, so we don't overwrite any settings.
-          optional_data[:profile] = optional_data[:profile].dup
-        end
-        # Add the user agent to it if it has not been set yet
-        if optional_data[:profile].instance_variable_get(:@additional_prefs)['general.useragent.override'].nil?
-          optional_data[:profile]['general.useragent.override'] = device_configuration['user-agent']
-        else
-          world.log.debug "User-agent was already set in the :profile."
-        end
-        # Chrome user-agent settings
-        ua_string = "--user-agent=#{device_configuration['user-agent']}"
-        if optional_data[:switches].nil?
-          optional_data[:switches] = [ua_string]
-        elsif !optional_data[:switches].join(',').include? '--user-agent='
-          optional_data[:switches].push ua_string
-        else
-          world.log.debug "User-agent was already set in the :switches."
-        end
-        if b != :firefox and b != :chrome
-          warn "#{device} user agent cannot be set for #{b.to_s}. Only Chrome & Firefox are supported."
-        end
-      end
-
-      args = []
-      args = [b] unless b.nil?
-      @browser_name = b.to_s
-      if b == :remote
-        # Get the config
-        remote_config = world.env_or_config("remote", {})
-
-        # The settings we are going to use to create the browser
-        remote_settings = {}
-
-        # Add the config to the settings using downcase string keys
-        remote_config.each {|k, v| remote_settings[k.to_s.downcase] = v}
-
-        if optional_data.is_a? Hash
-          # Convert the optional data to downcase string keys
-          string_hash = Hash.new
-          optional_data.each {|k, v| string_hash[k.to_s.downcase] = v}
-
-          # Merge them with the settings
-          remote_settings.merge! string_hash
-        end
-
-        args.push(remote_browser_config(remote_settings))
-      elsif not optional_data.nil? and not optional_data.empty?
-        world.log.debug("Got optional data: #{optional_data}")
-        args.push(optional_data)
-      elsif world.has_proxy?
-        # Create a session if needed
-        if !world.proxy.has_session?
-          world.proxy.create()
-        end
-
-        proxy_url = "#{world.proxy.ip}:#{world.proxy.port}"
-        if b == :firefox
-          world.log.debug("Configuring Firefox proxy: #{proxy_url}")
-          profile = Selenium::WebDriver::Firefox::Profile.new
-          profile.proxy = Selenium::WebDriver::Proxy.new :http => proxy_url, :ssl => proxy_url
-          args.push({:profile => profile})
-        end
-      end
       begin
         browser_instance = Watir::Browser.new(*args)
         # Resize the browser if the device simulation requires it
@@ -394,7 +284,7 @@ module LapisLazuli
       rescue Selenium::WebDriver::Error::UnknownError => err
         raise err
       end
-      return browser_instance
+      browser_instance
     end
   end