teaspoon 1.1.3 → 1.2.2

data/lib/teaspoon/deprecated.rb

@@ -79,7 +79,7 @@ teaspoon coverage directive has changed and is now more flexible, define coverag
       end
 
       def no_coverage(*)
-        Teaspoon.dep("suite.no_coverage has been removed in Teaspoon 1.0. Please use coverage.ignore instead. https://github.com/modeset/teaspoon/blob/master/CHANGELOG.md")
+        Teaspoon.dep("suite.no_coverage has been removed in Teaspoon 1.0. Please use coverage.ignore instead. https://github.com/jejacks0n/teaspoon/blob/master/CHANGELOG.md")
         []
       end
       alias_method :no_coverage=, :no_coverage

data/lib/teaspoon/driver.rb

@@ -12,4 +12,4 @@ end
 
 Teaspoon::Driver.register(:phantomjs, "Teaspoon::Driver::Phantomjs", "teaspoon/driver/phantomjs", default: true)
 Teaspoon::Driver.register(:selenium, "Teaspoon::Driver::Selenium", "teaspoon/driver/selenium")
-Teaspoon::Driver.register(:capybara_webkit, "Teaspoon::Driver::CapybaraWebkit", "teaspoon/driver/capybara_webkit")
+Teaspoon::Driver.register(:browserstack, "Teaspoon::Driver::BrowserStack", "teaspoon/driver/browserstack")

data/lib/teaspoon/driver/browserstack.rb

@@ -0,0 +1,111 @@
+# :nocov:
+begin
+  require "selenium-webdriver"
+rescue LoadError
+  Teaspoon.abort("Could not find Selenium Webdriver. Install the selenium-webdriver gem.")
+end
+# :nocov:
+
+require "teaspoon/driver/base"
+
+# Need to have BrowserStackLocal binary (https://www.browserstack.com/local-testing#command-line)
+# running in the background to use this driver.
+module Teaspoon
+  module Driver
+    class BrowserStack < Base
+      MAX_PARALLEL = 10
+
+      def initialize(options = nil)
+        options ||= {}
+        case options
+        when Hash then @options = options.symbolize_keys
+        when String then @options = JSON.parse(options).symbolize_keys
+        else raise Teaspoon::DriverOptionsError.new(types: "hash or json string")
+        end
+
+        unless @options[:capabilities] && @options[:capabilities].is_a?(Array)
+          raise Teaspoon::DriverOptionsError.new(types: "capabilities array." \
+                                                 "Options must have a key 'capabilities' of type array")
+        end
+        @options[:capabilities].each(&:symbolize_keys!)
+      rescue JSON::ParserError
+        raise Teaspoon::DriverOptionsError.new(types: "hash or json string")
+      end
+
+      def run_specs(runner, url)
+        parallelize do
+          driver = Thread.current[:driver]
+          driver.navigate.to(url)
+          ::Selenium::WebDriver::Wait.new(driver_options).until do
+            done = driver.execute_script("return window.Teaspoon && window.Teaspoon.finished")
+            driver.execute_script("return window.Teaspoon && window.Teaspoon.getMessages() || []").each do |line|
+              runner.process("#{line}\n")
+            end
+            done
+          end
+        end
+      end
+
+      protected
+
+        def parallelize
+          threads = []
+          left_capabilities = capabilities
+          until left_capabilities.empty?
+            left_capabilities.pop(max_parallel).each do |desired_capability|
+              desired_capability[:"browserstack.local"] = true
+              desired_capability[:project] = driver_options[:project] if driver_options[:project]
+              desired_capability[:build] = driver_options[:build] if driver_options[:build]
+              threads << Thread.new do
+                driver = ::Selenium::WebDriver.for(:remote, url: hub_url, desired_capabilities: desired_capability)
+                Thread.current[:driver] = driver
+                capability = driver.capabilities
+
+                Thread.current[:name] = "Session on #{capability[:platform].to_s.strip}," \
+                  "#{capability[:browser_name].to_s.strip} #{capability[:version].to_s.strip}"
+
+                yield
+                Thread.current[:driver].quit
+                STDOUT.print("#{Thread.current[:name]} Completed\n") unless Teaspoon.configuration.suppress_log
+              end
+            end
+            threads.each(&:join)
+            threads = []
+          end
+        end
+
+        def capabilities
+          driver_options[:capabilities]
+        end
+
+        def hub_url
+          "https://#{username}:#{access_key}@hub.browserstack.com/wd/hub"
+        end
+
+        def username
+          driver_options[:username] || ENV["BROWSERSTACK_USERNAME"]
+        end
+
+        def access_key
+          driver_options[:access_key] || ENV["BROWSERSTACK_ACCESS_KEY"]
+        end
+
+        def max_parallel
+          parallel = MAX_PARALLEL
+          begin
+            parallel = driver_options[:max_parallel].to_i if driver_options[:max_parallel].to_i > 0
+          rescue
+          end
+          parallel
+        end
+
+        def driver_options
+          @driver_options ||= HashWithIndifferentAccess.new(
+            timeout: Teaspoon.configuration.driver_timeout.to_i,
+            interval: 0.01,
+            message: "Timed out"
+          ).merge(@options)
+        end
+    end
+  end
+end

data/lib/teaspoon/driver/phantomjs.rb

@@ -31,38 +31,37 @@ module Teaspoon
 
       protected
 
-      def run(*args, &block)
-        IO.popen([executable, *args].join(" ")) { |io| io.each(&block) }
+        def run(*args, &block)
+          IO.popen([executable, *args].join(" ")) { |io| io.each(&block) }
 
-        unless $?.success?
-          raise Teaspoon::DependencyError.new("Failed to use phantomjs, which exited with status code: #{$?.exitstatus}")
+          unless $?.nil? || $?.success?
+            raise Teaspoon::DependencyError.new("Failed to use phantomjs, which exited with status code: #{$?.exitstatus}")
+          end
         end
-      end
 
-      def driver_options(url)
-        [
-          @options,
-          escape_quotes(script),
-          escape_quotes(url),
-          Teaspoon.configuration.driver_timeout
-        ].flatten.compact
-      end
+        def driver_options(url)
+          [
+            @options,
+            escape_quotes(script),
+            escape_quotes(url),
+            Teaspoon.configuration.driver_timeout
+          ].flatten.compact
+        end
 
-      def escape_quotes(string)
-        %{"#{string.gsub('"', '\"')}"}
-      end
+        def escape_quotes(string)
+          %{"#{string.gsub('"', '\"')}"}
+        end
 
-      def executable
-        return @executable if @executable
-        @executable = which("phantomjs")
-        @executable = ::Phantomjs.path if @executable.blank? && defined?(::Phantomjs)
-        return @executable unless @executable.blank?
-        raise Teaspoon::MissingDependencyError.new("Unable to locate phantomjs. Install it or use the phantomjs gem.")
-      end
+        def executable
+          return @executable if @executable
+          @executable = defined?(::Phantomjs) ? ::Phantomjs.path : which("phantomjs")
+          return @executable unless @executable.blank?
+          raise Teaspoon::MissingDependencyError.new("Unable to locate phantomjs. Install it or use the phantomjs gem.")
+        end
 
-      def script
-        File.expand_path("../phantomjs/runner.js", __FILE__)
-      end
+        def script
+          File.expand_path("../phantomjs/runner.js", __FILE__)
+        end
     end
   end
 end

data/lib/teaspoon/driver/phantomjs/runner.js

@@ -59,9 +59,12 @@
       var _this = this;
       return {
         onError: function(message, trace) {
+          var started = _this.page.evaluate(function() {
+            return window.Teaspoon && window.Teaspoon.started;
+          });
           console.log(JSON.stringify({
             _teaspoon: true,
-            type: "error",
+            type: started ? "error" : "exception",
             message: message,
             trace: trace
           }));
@@ -89,8 +92,33 @@
             return window.Teaspoon;
           });
           if (!(status === "success" && defined)) {
-            _this.fail("Failed to load: " + _this.url);
-            return;
+            if (status === "success") {
+              // Could not load the window.Teaspoon object from the JavaScript on the
+              // rendered page. This indicates that a problem occured. Lets therfore
+              // print the page as a failure description.
+              // Get plain text of the page, intend all lines (better readable)
+              var ind = "   ";
+              var error = _this.page.plainText.replace(/(?:\n)/g, "\n" + ind);
+              // take only first 10 lines, as they usually provide a good entry
+              // point for debugging and we should not spam our console.
+              var erroroutput = error.split("\n").slice(0, 10);
+              if (erroroutput !== error) {
+                erroroutput.push("... (further lines have been removed)");
+              }
+              var fail = [
+                "Failed to get Teaspoon result object on page: " + _this.url,
+                "The title of this page was '" + _this.page.title + "'.",
+                "",
+                erroroutput.join("\n")
+              ];
+
+              _this.fail(fail.join(" \n" + ind));
+            }
+            else {
+              // Status is not 'success'
+              _this.fail("Failed to load: " + _this.url + ". Status: " + status);
+              return;
+            }
           }
           _this.waitForResults();
         }

data/lib/teaspoon/driver/selenium.rb

@@ -23,7 +23,10 @@ module Teaspoon
       end
 
       def run_specs(runner, url)
-        driver = ::Selenium::WebDriver.for(driver_options[:client_driver])
+        driver = ::Selenium::WebDriver.for(
+          driver_options[:client_driver],
+          **driver_options[:selenium_options].to_hash.to_options
+        )
         driver.navigate.to(url)
 
         ::Selenium::WebDriver::Wait.new(driver_options).until do
@@ -39,14 +42,15 @@ module Teaspoon
 
       protected
 
-      def driver_options
-        @driver_options ||= HashWithIndifferentAccess.new(
-          client_driver: :firefox,
-          timeout: Teaspoon.configuration.driver_timeout.to_i,
-          interval: 0.01,
-          message: "Timed out"
-        ).merge(@options)
-      end
+        def driver_options
+          @driver_options ||= HashWithIndifferentAccess.new(
+            client_driver: :firefox,
+            timeout: Teaspoon.configuration.driver_timeout.to_i,
+            interval: 0.01,
+            message: "Timed out",
+            selenium_options: {}
+          ).merge(@options)
+        end
     end
   end
 end

data/lib/teaspoon/engine.rb

@@ -51,6 +51,9 @@ module Teaspoon
 
     def self.inject_instrumentation
       Sprockets::Environment.send(:include, Teaspoon::SprocketsInstrumentation)
+      Sprockets::CachedEnvironment.send(:include, Teaspoon::SprocketsInstrumentation)
+    rescue NameError
+      # Handle cached environment in Sprockets 2.x
       Sprockets::Index.send(:include, Teaspoon::SprocketsInstrumentation)
     end
 
@@ -58,7 +61,9 @@ module Teaspoon
       mount_at = Teaspoon.configuration.mount_at
 
       return if app.routes.recognize_path(mount_at)[:action] != "routing_error" rescue nil
-      require Teaspoon::Engine.root.join("app/controllers/teaspoon/suite_controller")
+      ActiveSupport.on_load(:action_controller) do
+        require Teaspoon::Engine.root.join("app/controllers/teaspoon/suite_controller")
+      end
 
       app.routes.prepend { mount Teaspoon::Engine => mount_at, as: "teaspoon" }
     end
@@ -79,40 +84,40 @@ module Teaspoon
 
       private
 
-      def self.using_phantomjs?
-        Teaspoon::Driver.equal?(Teaspoon.configuration.driver, :phantomjs)
-      end
+        def self.using_phantomjs?
+          Teaspoon::Driver.matches?(Teaspoon.configuration.driver, :phantomjs)
+        end
 
-      def self.render_exceptions_with_javascript
-        ActionDispatch::DebugExceptions.class_eval do
-          def render_exception(_env, exception)
-            message = "#{exception.class.name}: #{exception.message}"
-            body = "<script>throw Error(#{[message, exception.backtrace].join("\n").inspect})</script>"
-            [200, { "Content-Type" => "text/html;", "Content-Length" => body.bytesize.to_s }, [body]]
+        def self.render_exceptions_with_javascript
+          ActionDispatch::DebugExceptions.class_eval do
+            def render_exception(_env, exception)
+              message = "#{exception.class.name}: #{exception.message}"
+              body = "<script>throw Error(#{[message, exception.backtrace].join("\n").inspect})</script>"
+              [200, { "Content-Type" => "text/html;", "Content-Length" => body.bytesize.to_s }, [body]]
+            end
           end
         end
-      end
     end
   end
 end
 
-begin
-  require 'action_view'
-  if ActionView::VERSION::STRING == "4.2.5" || ActionView::VERSION::MAJOR >= 5
-    require 'action_view/helpers/asset_tag_helper'
-    module ActionView::Helpers::AssetTagHelper
-      def javascript_include_tag(*sources)
-        options = sources.extract_options!.stringify_keys
-        path_options = options.extract!('protocol', 'extname', 'host').symbolize_keys
-        path_options[:debug] = options['allow_non_precompiled']
-        sources.uniq.map { |source|
-          tag_options = {
-            "src" => path_to_javascript(source, path_options)
-          }.merge!(options)
-          content_tag(:script, "", tag_options)
-        }.join("\n").html_safe
+class Sprockets::Rails::HelperAssetResolvers::Environment
+  def raise_unless_precompiled_asset(path)
+    if Rails.env.test? or Rails.env.development?
+      # nothing, thank you
+    else
+      super
+    end
+  end
+end
+
+# Some Sprockets patches to work with Sprockets 2.x
+unless Sprockets::Asset.public_method_defined?(:filename)
+  module Sprockets
+    class Asset
+      def filename
+        pathname.to_s
       end
     end
   end
-rescue
 end

data/lib/teaspoon/environment.rb

@@ -26,41 +26,41 @@ module Teaspoon
 
     private
 
-    def self.find_env(override = nil)
-      override ||= ENV["TEASPOON_ENV"]
-      env_files = override && !override.empty? ? [override] : standard_environments
+      def self.find_env(override = nil)
+        override ||= ENV["TEASPOON_ENV"]
+        env_files = override && !override.empty? ? [override] : standard_environments
 
-      env_files.each do |filename|
-        file = File.expand_path(filename, Dir.pwd)
-        ENV["TEASPOON_ENV"] = file if override
-        return file if File.exists?(file)
-      end
+        env_files.each do |filename|
+          file = File.expand_path(filename, Teaspoon.root)
+          ENV["TEASPOON_ENV"] = file if override
+          return file if File.exist?(file)
+        end
 
-      raise Teaspoon::EnvironmentNotFound.new(searched: env_files.join(", "))
-    end
+        raise Teaspoon::EnvironmentNotFound.new(searched: env_files.join(", "))
+      end
 
-    def self.standard_environments
-      ["spec/teaspoon_env.rb", "test/teaspoon_env.rb", "teaspoon_env.rb"]
-    end
+      def self.standard_environments
+        ["spec/teaspoon_env.rb", "test/teaspoon_env.rb", "teaspoon_env.rb"]
+      end
 
-    def self.require_env(file)
-      ::Kernel.load(file)
-    end
+      def self.require_env(file)
+        ::Kernel.load(file)
+      end
 
-    def self.rails_loaded?
-      !!defined?(Rails)
-    end
+      def self.rails_loaded?
+        !!defined?(Rails)
+      end
 
-    def self.load_rails
-      rails_env = ENV["TEASPOON_RAILS_ENV"] || File.expand_path("config/environment.rb", Dir.pwd)
+      def self.load_rails
+        rails_env = ENV["TEASPOON_RAILS_ENV"] || File.expand_path("config/environment.rb", Teaspoon.root)
 
-      # Try to load rails, assume teaspoon_env will do it if the expected
-      # environment isn't found.
-      if File.exists?(rails_env)
-        require rails_env
-      else
-        require_environment
+        # Try to load rails, assume teaspoon_env will do it if the expected
+        # environment isn't found.
+        if File.exist?(rails_env)
+          require rails_env
+        else
+          require_environment
+        end
       end
-    end
   end
 end

data/lib/teaspoon/exceptions.rb

@@ -2,13 +2,13 @@ module Teaspoon
   class Error < StandardError
     protected
 
-    def build_message(msg_or_options)
-      if msg_or_options.is_a?(String)
-        msg_or_options
-      else
-        yield msg_or_options
+      def build_message(msg_or_options)
+        if msg_or_options.is_a?(String)
+          msg_or_options
+        else
+          yield msg_or_options
+        end
       end
-    end
   end
 
   class Failure < Teaspoon::Error
@@ -29,7 +29,7 @@ module Teaspoon
       super(build_message(msg_or_options) do |options|
         msg = "Unknown framework: expected \"#{options[:name]}\" to be a registered framework. Available frameworks are #{options[:available]}."
         if options[:available].blank?
-          msg += " Do you need to update your Gemfile to use the teaspoon-#{options[:name]} gem? If you are upgrading, please see https://github.com/modeset/teaspoon/blob/master/CHANGELOG.md"
+          msg + " Do you need to update your Gemfile to use the teaspoon-#{options[:name]} gem? If you are upgrading, please see https://github.com/jejacks0n/teaspoon/blob/master/CHANGELOG.md"
         end
       end)
     end