lapis_lazuli 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b5527d2ff09b634197137d35cbe04a7b67c4a60
-  data.tar.gz: 262d2f7c7b6201f250dcce19971027c0eda5267a
+  metadata.gz: c231db7a9cb304150e2ca2eccf956be02c367482
+  data.tar.gz: 3eb2d929510b34cfd70f2e944eb2590b6059f6e6
 SHA512:
-  metadata.gz: 77883ebc45311366dd20819a803013d703c1116d2c8e98ea81de43868a1ee43b77a6d7c7262657abb28f152c5ad3e029e87e631146d8f963a1caf981fb60f8d0
-  data.tar.gz: 4563b9880ed1c985e0d88155b752a1d55c2480f0d7768e3d82b820e40abbcaba3464602617de29d29ffd6b5226a8e3aa45c93c78b9368eda67bbc63d0182ae7d
+  metadata.gz: cede96cad3beb40c9a3f331c47cc930906ccd707283b393aaddccd4d713120233b3e01c4b3d7f15dbf1f117fde4b1c9d3593f1ae43d8189b2d6316345d2e4b16
+  data.tar.gz: d941873ef4a11ef98524f994c931b0acea5348dc261b6392dddabdff7212b1d678b91a311b18fbe1d21cd58c986100e386e88de270299093e6b0c580b28a9915

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lapis_lazuli (0.6.2)
+    lapis_lazuli (0.7.0)
       facets (~> 2.9)
       faraday (~> 0.9.0)
       faraday_middleware (~> 0.9.1)
@@ -31,7 +31,7 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.9.0)
     simplecov-html (0.9.0)
-    teelogger (0.4.0)
+    teelogger (0.4.1)
     thor (0.19.1)
 
 PLATFORMS

data/lib/lapis_lazuli/browser.rb

@@ -18,6 +18,7 @@ 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'
 
@@ -26,7 +27,7 @@ module LapisLazuli
   # Extension to the Watir browser
   #
   # This class handles initialization, for the most part. BrowserModules
-  # included here can rely on @world being set to the current cucumber world
+  # included here can rely on world being set to the current cucumber world
   # object, and for some WorldModules to exist in it (see assertions in
   # constructor).
   class Browser
@@ -37,29 +38,54 @@ module LapisLazuli
     include LapisLazuli::BrowserModule::Wait
     include LapisLazuli::BrowserModule::Screenshots
     include LapisLazuli::BrowserModule::Interaction
+    include LapisLazuli::BrowserModule::Remote
     include LapisLazuli::GenericModule::XPath
-    include LapisLazuli::GenericModule::Assertions
 
-    @world
-    @browser
-    @cached_browser_wanted
-    @cached_optional_data
+    @@world=nil
+    @@cached_browser_options={}
+    @@browsers=[]
+    class << self
+      include LapisLazuli::GenericModule::Assertions
+
+      def browsers
+        return @@browsers
+      end
+      
+      def add_browser(b)
+        # Add destructor for all browsers
+        Runtime.instance.set_if(self, :browsers, LapisLazuli::Browser.method(:close_all))
+        @@browsers.push(b)
+      end
+
+      def remove_browser(b)
+        @@browsers.delete(b)
+      end
+
+      def set_world(w)
+        @@world = w
+      end
 
+      def check_world?
+        assert @@world.respond_to?(:config), "Need to include LapisLazuli::WorldModule::Config in your cucumber world."
+        assert @@world.respond_to?(:log), "Need to include LapisLazuli::WorldModule::Logging in your cucumber world."
+        assert @@world.respond_to?(:error), "Need to include LapisLazuli::WorldModule::Error in your cucumber world."
+        assert @@world.respond_to?(:has_proxy?), "Need to include LapisLazuli::WorldModule::Proxy in your cucumber world."
+      end
+    end
+
+    @browser
     @browser_name
-    attr_reader :browser_name
+    @browser_wanted
+    @optional_data
+
+    attr_reader :browser_name, :browser_wanted, :optional_data
 
-    def initialize(world, *args)
+    def initialize(*args)
       # The class only works with some modules loaded; they're loaded by the
       # Browser module, but we can't be sure that's been used.
-      assert world.respond_to?(:config), "Need to include LapisLazuli::WorldModule::Config in your cucumber world."
-      assert world.respond_to?(:log), "Need to include LapisLazuli::WorldModule::Logging in your cucumber world."
-      assert world.respond_to?(:error), "Need to include LapisLazuli::WorldModule::Error in your cucumber world."
-      assert world.respond_to?(:has_proxy?), "Need to include LapisLazuli::WorldModule::Proxy in your cucumber world."
+      LapisLazuli::Browser.check_world?
 
-      @world = world
-
-      # Create a new browser with optional arguments
-      @browser = self.init(*args)
+      self.start(*args)
 
       # Add registered world modules.
       if not LapisLazuli::WorldModule::Browser.browser_modules.nil?
@@ -69,92 +95,23 @@ module LapisLazuli
       end
     end
 
-    ##
-    # The main browser window for testing
-    def init(browser_wanted=(no_browser_wanted=true;nil), optional_data=(no_optional_data=true;nil))
-      # Store the optional data so on restart of the browser it still has the
-      # correct configuration
-      if no_optional_data and optional_data.nil? and @cached_optional_data
-        optional_data = @cached_optional_data
-      elsif optional_data.nil?
-        optional_data = {}
-      else
-        # Duplicate the data as Webdriver modifies it
-        @cached_optional_data = optional_data.dup
-      end
-
-      # Do the same caching stuff for the browser
-      if no_browser_wanted and browser_wanted.nil? and @cached_browser_wanted
-        browser_wanted = @cached_browser_wanted
-      else
-        @cached_browser_wanted = browser_wanted
-      end
-
-      # Create the browser
-      self.create_internal(browser_wanted, optional_data)
+    # Support browser.dup to create a duplicate
+    def initialize_copy(source)
+      super
+      @optional_data = @optional_data.dup
+      @browser = create_driver(@browser_wanted, @optional_data)
+      # Add this browser to the list of all browsers
+      LapisLazuli::Browser.add_browser(self)
     end
 
     ##
     # Creates a new browser instance.
     def create(*args)
-      return Browser.new(@world, *args)
+      return Browser.new(*args)
     end
 
-    ##
-    # Create a new browser depending on settings
-    # Always cached the supplied arguments
-    def create_internal(browser_wanted=nil, optional_data=nil)
-      # No browser? Does the config have a browser? Default to firefox
-      if browser_wanted.nil?
-        browser_wanted = @world.env_or_config('browser', 'firefox')
-      end
-
-      # Select the correct browser
-      case browser_wanted.to_s.downcase
-        when 'chrome'
-          # Check Platform running script
-          browser = :chrome
-        when 'safari'
-          browser = :safari
-        when 'ie'
-          require 'rbconfig'
-          if (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
-            browser = :ie
-          else
-            @world.error("You can't run IE tests on non-Windows machine")
-          end
-        when 'ios'
-          if RUBY_PLATFORM.downcase.include?("darwin")
-            browser = :iphone
-          else
-            @world.error("You can't run IOS tests on non-mac machine")
-          end
-        else
-          browser = :firefox
-      end
-
-      args = [browser]
-      @browser_name = browser.to_s
-      if 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 browser == :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
-
-      browser_instance = Watir::Browser.new(*args)
-      return browser_instance
+    def world
+      @@world
     end
 
     ##
@@ -165,23 +122,25 @@ module LapisLazuli
 
     ##
     # Start the browser if it's not yet open.
-    def start
+    def start(*args)
       if @browser.nil?
-        @browser = self.init
+        @browser = init(*args)
+        # Add this browser to the list of all browsers
+        LapisLazuli::Browser.add_browser(self)
       end
     end
 
     ##
     # Close and create a new browser
     def restart
-      @world.log.debug "Restarting browser"
+      world.log.debug "Restarting browser"
       @browser.close
       self.start
     end
 
     ##
     # Closes the browser and updates LL so that it will open a new one if needed
-    def close(reason = nil)
+    def close(reason = nil, remove_from_list=true)
       if not @browser.nil?
         if not reason.nil?
           reason = " after #{reason}"
@@ -189,8 +148,11 @@ module LapisLazuli
           reason = ""
         end
 
-        @world.log.debug "Closing browser#{reason}: #{@browser}"
+        world.log.debug "Closing browser#{reason}: #{@browser}"
         @browser.close
+        if remove_from_list
+          LapisLazuli::Browser.remove_browser(self)
+        end
         @browser = nil
       end
     end
@@ -209,12 +171,12 @@ module LapisLazuli
     # Default: feature
     def close_after_scenario(scenario)
       # Determine the config
-      close_browser_after = @world.env_or_config("close_browser_after")
+      close_browser_after = world.env_or_config("close_browser_after")
 
       case close_browser_after
       when "scenario"
         # We always close it
-        self.close close_browser_after
+        LapisLazuli::Browser.close_all close_browser_after
       when "never"
         # Do nothing: party time, excellent!
       when "end"
@@ -222,7 +184,7 @@ module LapisLazuli
       else
         if is_last_scenario?(scenario)
           # Close it
-          self.close close_browser_after
+          LapisLazuli::Browser.close_all close_browser_after
         end
       end
     end
@@ -246,13 +208,143 @@ module LapisLazuli
     end
 
     def destroy(world)
-      if "end" == world.env_or_config("close_browser_after")
-        begin
-          self.close "end"
-        rescue
-          world.log.debug("Failed to close the browser, probably chrome")
+      # Primary browser should also close other browsers
+      LapisLazuli::Browser.close_all("end")
+    end
+
+    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
+        @@world.log.debug("Closing all browsers")
+
+        # Close each browser
+        @@browsers.each do |b|
+          begin
+            b.close reason, false
+          rescue Exception => err
+            # Provide some details
+            @@world.log.debug("Failed to close the browser, probably chrome: #{err.to_s}")
+          end
         end
+
+        # Make sure the array is cleared
+        @@browsers = []
       end
     end
+
+    private
+      ##
+      # The main browser window for testing
+      def init(browser_wanted=(no_browser_wanted=true;nil), optional_data=(no_optional_data=true;nil))
+        # Store the optional data so on restart of the browser it still has the
+        # correct configuration
+        if no_optional_data and 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]
+        elsif optional_data.nil?
+          optional_data = {}
+        end
+
+        # Do the same caching stuff for the browser
+        if no_browser_wanted and browser_wanted.nil? and @@cached_browser_options.has_key?(:browser)
+          browser_wanted = @@cached_browser_options[:browser]
+        end
+
+
+        if !@@cached_browser_options.has_key? :browser
+          @@cached_browser_options[:browser] = browser_wanted
+          # Duplicate the data as Webdriver modifies it
+          @@cached_browser_options[:optional_data] = optional_data.dup
+        end
+
+        @browser_wanted = browser_wanted
+        @optional_data = optional_data
+        # Create the browser
+        create_driver(@browser_wanted, @optional_data)
+      end
+
+      ##
+      # Create a new browser depending on settings
+      # Always cached the supplied arguments
+      def create_driver(browser_wanted=nil, optional_data=nil)
+        # No browser? Does the config have a browser? Default to firefox
+        if browser_wanted.nil?
+          browser_wanted = world.env_or_config('browser', 'firefox')
+        end
+
+        # Select the correct browser
+        case browser_wanted.to_s.downcase
+          when 'chrome'
+            # Check Platform running script
+            b = :chrome
+          when 'safari'
+            b = :safari
+          when 'ie'
+            require 'rbconfig'
+            if (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+              b = :ie
+            else
+              world.error("You can't run IE tests on non-Windows machine")
+            end
+          when 'ios'
+            if RUBY_PLATFORM.downcase.include?("darwin")
+              b = :iphone
+            else
+              world.error("You can't run IOS tests on non-mac machine")
+            end
+          when 'remote'
+            b = :remote
+          else
+            b = :firefox
+        end
+
+        args = [b]
+        @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)
+        rescue Selenium::WebDriver::Error::UnknownError => err
+          raise err
+        end
+        return browser_instance
+      end
   end
+
 end

data/lib/lapis_lazuli/browser/error.rb

@@ -25,9 +25,9 @@ module BrowserModule
       if errors.length > 0 or self.get_http_status.to_i > 299
         errors.each do |error|
           if error.is_a? Hash
-            @world.log.debug("#{error["message"]} #{error["url"]} #{error["line"]} #{error["column"]}\n#{error["stack"]}")
+            world.log.debug("#{error["message"]} #{error["url"]} #{error["line"]} #{error["column"]}\n#{error["stack"]}")
           else
-            @world.log.debug("#{error}")
+            world.log.debug("#{error}")
           end
         end
         return true
@@ -42,12 +42,12 @@ module BrowserModule
     def get_html_errors
       result = []
       # Need some error strings
-      if @world.has_env_or_config?("error_strings")
+      if world.has_env_or_config?("error_strings")
         begin
           # Get the HTML of the page
           page_text = @browser.html
           # Try to find all errors
-          @world.env_or_config("error_strings").each {|error|
+          world.env_or_config("error_strings").each {|error|
             if page_text.include? error
               # Add to the result list
               result.push error
@@ -55,7 +55,7 @@ module BrowserModule
           }
         rescue RuntimeError => err
           # An error?
-          @world.log.debug "Cannot read the html for page #{@browser.url}: #{err}"
+          world.log.debug "Cannot read the html for page #{@browser.url}: #{err}"
         end
       end
       # By default we don't have errors

data/lib/lapis_lazuli/browser/find.rb

@@ -157,7 +157,7 @@ module BrowserModule
         else
           options[:message] = optional_message("Invalid :pick value #{pick}.", options)
           options[:groups] = ['find', 'pick']
-          @world.error(options)
+          world.error(options)
         end
       end
     end
@@ -243,7 +243,7 @@ module BrowserModule
         if not like_opts.has_key? :element
           selector[:message] = optional_message("Like selector are missing the :element key.", selector)
           selector[:groups] = ['find', 'selector']
-          @world.error(selector)
+          world.error(selector)
         end
       end
 
@@ -443,7 +443,7 @@ module BrowserModule
           res = []
           lambdas.each do |func|
             res = func.call
-            # @world.log.debug("Got: #{res}")
+            # world.log.debug("Got: #{res}")
             if res.length > 0
               break
             end
@@ -453,7 +453,7 @@ module BrowserModule
       else
         options[:message] = optional_message("Invalid mode '#{options[:mode]}' provided to multi_find_all.", options)
         options[:groups] = ['find', 'multi', 'mode']
-        @world.error(options)
+        world.error(options)
       end
     end
 
@@ -492,7 +492,7 @@ module BrowserModule
       rescue RuntimeError => err
         opts[:message] = optional_message(message, selectors)
         opts[:exception] = err
-        @world.error(opts)
+        world.error(opts)
       end
     end
   end # module Find

data/lib/lapis_lazuli/browser/interaction.rb

@@ -69,7 +69,7 @@ module BrowserModule
       end
 
       if errors.length > 0
-        raise "Could not click #{elem} given any of these click types: #{types}: #{errors}"
+        world.error("Could not click #{elem} given any of these click types: #{types}: #{errors}")
       end
     end
 

data/lib/lapis_lazuli/browser/remote.rb

@@ -0,0 +1,140 @@
+#
+# LapisLazuli
+# https://github.com/spriteCloud/lapis-lazuli
+#
+# Copyright (c) 2013-2014 spriteCloud B.V. and other LapisLazuli contributors.
+# All rights reserved.
+#
+
+module LapisLazuli
+module BrowserModule
+  module Remote
+    # Convert settings to a valid remote driver argument
+    #
+    # Features:
+    #  - settings hash can be case insensitive "URL","Url", "url"
+    #  - caps.firefox_profile will be converted to a Selenium::WebDriver::Firefox::Profile
+    #  - caps.proxy / caps.firefox_profile.proxy will be converted to a Selenium::WebDriver::Proxy
+    #  - Hashes can have a String or a Symbol as key
+    #
+    # Example:
+    #  args = remote_browser_config(
+    #   {
+    #     "url"=>"http://test.com",
+    #     "user"=>"user21",
+    #     "password"=>"jehwiufhewuf",
+    #     "caps"=> {
+    #       "browser_name"=>"firefox",
+    #       "version"=>"37",
+    #       "firefox_profile"=>{
+    #         "plugin.state.flash"=>0,
+    #         "secure_ssl"=>true,
+    #         "proxy"=>{"http"=>"test.com:9000"}
+    #       },
+    #       "proxy"=>{:http=>"test.com:7000"},
+    #       :css_selectors_enabled => true
+    #     }
+    #   })
+    #  Watir::Browser.new :remote, args
+    def remote_browser_config(settings)
+      require "uri"
+      require "selenium-webdriver"
+
+      if !settings.is_a? Hash
+        world.error("Missing Remote Browser Settings")
+      end
+
+      # Fetch the URl
+      url = hash_get_case_insensitive(settings,"url")
+
+      # Test if its a valid URL
+      if not (url.to_s =~ /\A#{URI::regexp(["http", "https"])}\z/)
+        raise "Incorrect Remote URL: '#{url.to_s}'"
+      end
+
+      # Create URI object
+      uri = URI.parse(url)
+
+      # Add user if needed
+      user = hash_get_case_insensitive(settings,"user")
+      if !user.nil?
+        uri.user = user
+      end
+
+      # Add password if needed
+      password = hash_get_case_insensitive(settings,"password")
+      if !password.nil?
+        uri.password = password
+      end
+
+      # Create capabil
+          # Check ities
+      caps = Selenium::WebDriver::Remote::Capabilities.new
+      # Fetch the settings
+      caps_settings = hash_get_case_insensitive(settings,"caps")
+
+      # If we have settings
+      if !caps_settings.nil? and caps_settings.is_a? Hash
+        caps_settings.each do |key, val|
+          # Convert to proxy
+          if key.to_s == "proxy"
+            set_proxy(caps, val)
+          # Convert to FF profile
+          elsif key.to_s == "firefox_profile"
+            profile = Selenium::WebDriver::Firefox::Profile.new
+            # Set all the options
+            val.each do |fkey, fval|
+              # Convert to proxy
+              if fkey.to_s == "proxy"
+                set_proxy(profile,fval)
+              else
+                set_key(profile, fkey, fval)
+              end
+            end
+            # Set the profile
+            caps[:firefox_profile] = profile
+          else
+            # Use set_key to assign the key
+            set_key(caps, key, val)
+          end
+        end
+      end
+
+      world.log.debug("Using remote browser: #{url} (#{uri.user}) #{caps.to_json}")
+
+      return {
+        :url => uri.to_s,
+        :desired_capabilities => caps
+      }
+    end
+
+    private
+      def hash_get_case_insensitive(hash, key)
+        new_key = hash.keys.find {|e| e.to_s.casecmp(key.to_s) == 0}
+        if new_key.nil?
+          return nil
+        end
+        return hash[new_key]
+      end
+
+      # Sets a selenium proxy to the object
+      def set_proxy(object, hash)
+        proxy = Selenium::WebDriver::Proxy.new
+        hash.each do |key, val|
+          set_key(proxy, key, val)
+        end
+        object.proxy = proxy
+      end
+
+      # Uses function based on key or key itself to store the value in the object
+      def set_key(object, key, val)
+        if object.respond_to? "#{key}="
+          object.send("#{key}=", val)
+        else
+          object[key] = val
+        end
+      end
+
+  end # module Remote
+end # module BrowserModule
+end # module LapisLazuli

data/lib/lapis_lazuli/browser/screenshots.rb

@@ -15,24 +15,23 @@ module BrowserModule
     ##
     # Returns the name of the screenshot, if take_screenshot is called now.
     def screenshot_name(suffix="")
-      dir = @world.env_or_config("screenshot_dir")
+      dir = world.env_or_config("screenshot_dir")
 
       # Generate the file name according to the new or old scheme.
-      name = 'screenshot'
-      case @world.env_or_config("screenshot_scheme")
+      case world.env_or_config("screenshot_scheme")
       when "new"
-        # For non-cucumber cases: we don't have @world.scenario.data
-        if not @world.scenario.data.nil?
-          name = @world.scenario.id
+        # For non-cucumber cases: we don't have world.scenario.data
+        if not world.scenario.data.nil?
+          name = world.scenario.id
         end
         # FIXME random makes this non-repeatable, sadly
-        name = "#{@world.scenario.time[:iso_short]}-#{name}-#{Random.rand(10000).to_s}.png"
+        name = "#{world.scenario.time[:iso_short]}-#{@browser.object_id}-#{name}-#{Random.rand(10000).to_s}.png"
       else # 'old' and default
-        # For non-cucumber cases: we don't have @world.scenario.data
-        if not @world.scenario.data.nil?
-          name = @world.scenario.data.name.gsub(/^.*(\\|\/)/, '').gsub(/[^\w\.\-]/, '_').squeeze('_')
+        # For non-cucumber cases: we don't have world.scenario.data
+        if not world.scenario.data.nil?
+          name = world.scenario.data.name.gsub(/^.*(\\|\/)/, '').gsub(/[^\w\.\-]/, '_').squeeze('_')
         end
-        name = @world.time[:timestamp] + "_" + name + '.png'
+        name = world.time[:timestamp] + "_" + name + '.png'
       end
 
       # Full file location
@@ -46,7 +45,7 @@ module BrowserModule
     # Using the name as defined at the start of every scenario
     def take_screenshot(suffix="")
       # If the target directory does not exist, create it.
-      dir = @world.env_or_config("screenshot_dir")
+      dir = world.env_or_config("screenshot_dir")
       begin
         Dir.mkdir dir
       rescue SystemCallError => ex
@@ -61,14 +60,14 @@ module BrowserModule
       begin
         # Save the screenshot
         @browser.screenshot.save fileloc
-        @world.log.debug "Screenshot saved: #{fileloc}"
+        world.log.debug "Screenshot saved: #{fileloc}"
 
         # Try to store the screenshot name
-        if @world.respond_to? :annotate
-          @world.annotate :screenshot => fileloc
+        if world.respond_to? :annotate
+          world.annotate :screenshot => fileloc
         end
       rescue RuntimeError => e
-        @world.log.debug "Failed to save screenshot to '#{fileloc}'. Error message #{e.message}"
+        world.log.debug "Failed to save screenshot to '#{fileloc}'. Error message #{e.message}"
       end
       return fileloc
     end

data/lib/lapis_lazuli/browser/wait.rb

@@ -103,7 +103,7 @@ module BrowserModule
       begin
         res = Watir::Wait.send(condition, timeout, &find_proc)
       rescue Watir::Wait::TimeoutError => e
-        @world.log.debug("Caught timeout: #{e}")
+        world.log.debug("Caught timeout: #{e}")
         err = e
       end
 
@@ -112,7 +112,7 @@ module BrowserModule
       # Error handling
       if not err.nil? and filter_results.empty?
         options[:exception] = err
-        @world.error(options)
+        world.error(options)
       end
 
       # Set if the underlying find function returns single results

data/lib/lapis_lazuli/runtime.rb

@@ -39,7 +39,10 @@ module LapisLazuli
         return @objects[name]
       end
 
-      obj = block.call
+      obj = nil
+      if !block.nil?
+        obj = block.call
+      end
 
       set(world, name, obj, destructor)
 
@@ -73,6 +76,17 @@ module LapisLazuli
           return world.send(name).destroy(world)
         end
 
+        # Try to run destroy on the object itself
+        obj = Runtime.get(name)
+        if obj.respond_to? :destroy
+          return obj.send(:destroy)
+        end
+
+        # If the object has stream/socket functions close ends the connection
+        if obj.respond_to? :close
+          return obj.send(:close)
+        end
+
         # If all else fails, we have to log an error. We can't rely
         # on log existing in world, though...
         message = "No destructor available for #{name}."

data/lib/lapis_lazuli/version.rb

@@ -6,5 +6,5 @@
 # All rights reserved.
 #
 module LapisLazuli
-  VERSION = "0.6.3"
+  VERSION = "0.7.0"
 end

data/lib/lapis_lazuli/world/browser.rb

@@ -50,9 +50,10 @@ module WorldModule
     def browser(*args)
       b = Runtime.instance.set_if(self, :browser) do
         # Add LL to the arguments for the browser
-        browser_args = args.unshift(self)
+        LapisLazuli::Browser.set_world(self)
+        
         # Create & return a new browser object
-        LapisLazuli::Browser.new(*browser_args)
+        LapisLazuli::Browser.new(*args)
       end
 
       if not b.is_open?

data/lib/lapis_lazuli/world/config.rb

@@ -238,7 +238,7 @@ module WorldModule
     # Returns current environment
     def current_env
       init
-      
+
       return @env
     end
 
@@ -255,11 +255,9 @@ module WorldModule
 
       # Environment variables for known options override environment specific
       # options, too
-      if CONFIG_OPTIONS.has_key? variable
-        var = variable.upcase
-        if ENV.has_key? var
-          return ENV[var]
-        end
+      env_var = var_from_env(variable, default)
+      if env_var != default
+        return env_var
       end
 
       return self.config("#{@env}.#{variable}",default)
@@ -281,17 +279,104 @@ module WorldModule
       # Make sure the configured configuration is loaded, if possible
       init
 
+      # Environment variables for known options override environment specific
+      # options, too
+      env_var = var_from_env(variable, default)
+      if env_var != default
+        return env_var
+      end
+
       if self.has_env?(variable)
         return self.env(variable, default)
       elsif self.has_config?(variable)
         return self.config(variable, default)
       else
-        return nil
+        return default
       end
     end
 
+    def var_from_env(var, default=nil)
+      # Simple solution for single depth variables like "browser"
+      if ENV.has_key? var
+        return ENV[var]
+      end
 
+      value = default
 
+      # Variables like:
+      #  var_from_env("remote.url","http://test.test")
+      if var.is_a? String and
+          var.include? "." and
+          not default.is_a? Hash
+
+        # Env variables cannot contain a . replace them by _
+        key_wanted = var.gsub(".","__")
+
+        # Do a case insensitive compare
+        ENV.keys.each do |key|
+          if key.casecmp(key_wanted) == 0
+            value = ENV[key]
+            break
+          end
+        end
+
+      # Environment:
+      #   REMOTE__USER=test
+      #   REMOTE__PASS=test
+      #   REMOTE__PROXY__HTTP=http://test.com
+      #
+      # Call:
+      #   var_from_env("remote",{})
+      #
+      # Result:
+      #   {"USER" => "test",
+      #    "PASS" => "test",
+      #    "proxy" => {"HTTP" => "http://test.con"}}
+      elsif default.is_a? Hash
+        # Env variables cannot contain a . replace them by _
+        key_wanted = var.gsub(".","__")
+        # Use a regular expression starting with the wanted key
+        rgx = Regexp.new("^#{key_wanted}","i")
+
+        result = {}
+        # For each key check if it matched the regexp
+        ENV.keys.each do |key|
+          if (key =~ rgx) == 0
+            tmp = result
+            # Remove start and split into parts
+            parts = key.sub(rgx, "").split("__")
+            # Remove empty start if needed
+            if parts[0].to_s.empty?
+              parts.shift
+            end
+
+            # For each part
+            parts.each_with_index do |part, index|
+              # Final part should store the value in the hash
+              if index == parts.length - 1
+                tmp[part] = ENV[key]
+              else
+                # Otherwise, downcase the partname
+                part.downcase!
+                # Set it to an object if needed
+                if !tmp.has_key? part
+                  tmp[part] = {}
+                end
+                # Assign tmp to the new hash
+                tmp = tmp[part]
+              end
+            end
+          end
+        end
+
+        # If we have set keys in the result return it
+        if result.keys.length > 0
+          return result
+        end
+      end
+
+      return value
+    end
 
   end # module Config
 end # module WorldModule

data/lib/lapis_lazuli/world/hooks.rb

@@ -77,18 +77,27 @@ module WorldModule
       end
 
       # Did we fail?
-      if respond_to? :scenario and respond_to? :browser and respond_to? :config
-        if (cuke_scenario.failed? or (scenario.check_browser_errors and browser.has_error?))
+      if respond_to? :scenario and respond_to? :has_browser? and respond_to? :browser and respond_to? :config
+        if has_browser? and (cuke_scenario.failed? or (scenario.check_browser_errors and browser.has_error?))
           # Take a screenshot if needed
           if has_env_or_config?('screenshot_on_failure')
-            fileloc = browser.take_screenshot()
+            if env_or_config("screenshot_scheme") == "new"
+              # Take screenshots on all active browsers
+              LapisLazuli::Browser.browsers.each do |b|
+                fileloc = b.take_screenshot()
+              end
+            else
+              browser.take_screenshot()
+            end
           end
         end
       end
 
       # Close browser if needed
-      if respond_to? :browser
-        browser.close_after_scenario(cuke_scenario)
+      if respond_to? :has_browser? and respond_to? :browser
+        if has_browser?
+          browser.close_after_scenario(cuke_scenario)
+        end
       end
     end
 

data/lib/lapis_lazuli/world/proxy.rb

@@ -23,8 +23,8 @@ module WorldModule
     ##
     # Checks if there is a proxy started
     def has_proxy?
-      p = Runtime.instance.get :proxy
-      return !p.nil?
+      proxy = Runtime.instance.get :proxy
+      return !proxy.nil?
     end
 
     ##
@@ -46,7 +46,7 @@ module WorldModule
           end
 
           # Try to start the proxy
-          p = LapisLazuli::Proxy.new(proxy_ip, proxy_port, proxy_master)
+          proxy = LapisLazuli::Proxy.new(proxy_ip, proxy_port, proxy_master)
 
           log.debug("Found proxy: #{proxy_ip}:#{proxy_port}, spritecloud: #{proxy_master}")
         rescue StandardError => err

data/test/Gemfile

@@ -36,8 +36,7 @@ gem 'cucumber', '>1.3.19'
 # gem 'cucumber', '=1.3.19'
 
 # Testing related
-gem 'simplecov', group: :test, require: nil
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'simplecov'
 
 # LapisLazul itself
 gem 'lapis_lazuli', :github => 'spriteCloud/lapis-lazuli', :branch => 'master'

data/test/features/config.feature

@@ -0,0 +1,14 @@
+@config @p
+Feature: config
+  When I want to test the Lapis Lazuli library
+  I want to run a webserver with some test files
+  And execute the each library function that handles configurations.
+
+  @config_01
+  Scenario: config_01 - Environment Hash
+    Given I set environment variable "configtest__user" to "username"
+    And I set environment variable "configtest__pass" to "password"
+    Then the environment variable "configtest" has "user" set to "username"
+    And the environment variable "configtest.user" is set to "username"
+    And the environment variable "configtest" has "pass" set to "password"
+    And the environment variable "close_browser_after" is set to "feature"

data/test/features/step_definitions/interaction_steps.rb

@@ -49,13 +49,13 @@ Given(/^I create a firefox browser named "(.*?)"( with proxy to "(.*?)")$/) do |
   else
     b = browser.create :firefox
   end
-  scenario.storage.set(name, browser)
+  scenario.storage.set(name, b)
 end
 
 Given(/^I close the browser named "(.*?)"$/) do |name|
   if scenario.storage.has? name
-    browser = scenario.storage.get name
-    browser.close
+    b = scenario.storage.get name
+    b.close
   else
     error("No item in the storage named #{name}")
   end
@@ -139,6 +139,9 @@ Then(/^I should be able to click the first button by force click$/) do
   )
 end
 
+Given(/^I set environment variable "(.*?)" to "(.*?)"$/) do |var, val|
+  ENV[var]=val
+end
 
 Given(/^I annotate a step with (.*?)$/) do |data|
   annotate data

data/test/features/step_definitions/validation_steps.rb

@@ -230,8 +230,14 @@ end
 Then(/^the firefox browser named "(.*?)" has a profile$/) do |name|
 	if scenario.storage.has? name
 		browser = scenario.storage.get name
-		if browser.driver.capabilities.firefox_profile.nil?
-			raise "Profile is not set"
+		if browser.browser_name == "remote"
+			if browser.driver.capabilities.firefox_profile.nil?
+				raise "Remote Firefox Profile is not set"
+			end
+		else
+			if browser.optional_data.has_key? "profile" or browser.optional_data.has_key? :profile
+				raise "No profile found in the optional data"
+			end
 		end
 	else
 		error("No item in the storage named #{name}")
@@ -348,3 +354,14 @@ Then(/^I expect to use tagname to hash options to (.*?) find element (.*?)$/) do
   end
 end
 
+Then(/^the environment variable "(.*?)" is set to "(.*?)"$/) do |var,val|
+	value = env(var)
+	assert_equal val, value, "Incorrect value"
+end
+
+Then(/^the environment variable "(.*?)" has "(.*?)" set to "(.*?)"$/) do |var, key, val|
+	hash = env(var,{})
+	assert hash.is_a?(Hash), "Config element is not a Hash: #{hash}"
+	assert hash.has_key?(key), "Config is missing #{key}"
+	assert_equal hash[key], val, "Config has incorrect value"
+end

data/test/features/support/env.rb

@@ -2,9 +2,6 @@
 # Copyright 2014 spriteCloud B.V. All rights reserved.
 # Generated by LapisLazuli, version 0.0.1
 # Author: "Onno Steenbergen" <onno@steenbe.nl>
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
 require 'lapis_lazuli'
 require 'lapis_lazuli/cucumber'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lapis_lazuli
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Onno Steenbergen
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -196,6 +196,7 @@ files:
 - lib/lapis_lazuli/browser/error.rb
 - lib/lapis_lazuli/browser/find.rb
 - lib/lapis_lazuli/browser/interaction.rb
+- lib/lapis_lazuli/browser/remote.rb
 - lib/lapis_lazuli/browser/screenshots.rb
 - lib/lapis_lazuli/browser/wait.rb
 - lib/lapis_lazuli/cli.rb
@@ -239,6 +240,7 @@ files:
 - test/features/browser.feature
 - test/features/button.feature
 - test/features/click.feature
+- test/features/config.feature
 - test/features/error.feature
 - test/features/find.feature
 - test/features/har.feature
@@ -293,6 +295,7 @@ test_files:
 - test/features/browser.feature
 - test/features/button.feature
 - test/features/click.feature
+- test/features/config.feature
 - test/features/error.feature
 - test/features/find.feature
 - test/features/har.feature