teaspoon 1.1.5 → 1.2.0

data/lib/teaspoon/configuration.rb

@@ -21,7 +21,7 @@ module Teaspoon
     @@asset_paths    = ["spec/javascripts", "spec/javascripts/stylesheets",
                         "test/javascripts", "test/javascripts/stylesheets"]
     @@fixture_paths  = ["spec/javascripts/fixtures", "test/javascripts/fixtures"]
-    @@asset_manifest = ["teaspoon.css", "teaspoon-filterer.js", "teaspoon/*.js", "support/*.js"]
+    @@asset_manifest = ["teaspoon.css", "teaspoon-filterer.js", "support/*.js"]
 
     # console runner specific
 
@@ -54,7 +54,7 @@ module Teaspoon
     # suite configurations
 
     cattr_accessor :suite_configs
-    @@suite_configs = { "default" => { block: proc {} } }
+    @@suite_configs = { "default" => { block: proc { } } }
 
     def self.suite(name = :default, &block)
       @@suite_configs[name.to_s] = { block: block, instance: Suite.new(name, &block) }
@@ -66,7 +66,7 @@ module Teaspoon
                     :hooks, :expand_assets, :js_extensions
 
       def initialize(name = nil)
-        @matcher       = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee}"
+        @matcher       = "{spec/javascripts,app/assets}/**/*_spec.{js,js.coffee,coffee,es6,js.es6}"
         @helper        = "spec_helper"
         @javascripts   = []
         @stylesheets   = ["teaspoon"]
@@ -104,7 +104,7 @@ module Teaspoon
     # coverage configurations
 
     cattr_accessor :coverage_configs
-    @@coverage_configs = { "default" => { block: proc {} } }
+    @@coverage_configs = { "default" => { block: proc { } } }
 
     def self.coverage(name = :default, &block)
       @@coverage_configs[name.to_s] = { block: block, instance: Coverage.new(&block) }

data/lib/teaspoon/console.rb

@@ -66,54 +66,54 @@ module Teaspoon
 
     protected
 
-    def resolve(files = [])
-      return if files.blank?
-      files.uniq.each do |path|
-        if result = Teaspoon::Suite.resolve_spec_for(path)
-          suite = @suites[result[:suite]] ||= []
-          suite << result[:path]
+      def resolve(files = [])
+        return if files.blank?
+        files.uniq.each do |path|
+          if result = Teaspoon::Suite.resolve_spec_for(path)
+            suite = @suites[result[:suite]] ||= []
+            suite << result[:path]
+          end
         end
       end
-    end
 
-    def start_server
-      server = Teaspoon::Server.new
-      log("Starting the Teaspoon server...") unless server.responsive?
-      server.start
-      server
-    end
+      def start_server
+        server = Teaspoon::Server.new
+        log("Starting the Teaspoon server...") unless server.responsive?
+        server.start
+        server
+      end
 
-    def suites
-      return [options[:suite]] if options[:suite].present?
-      return @suites.keys if @suites.present?
-      Teaspoon.configuration.suite_configs.keys
-    end
+      def suites
+        return [options[:suite]] if options[:suite].present?
+        return @suites.keys if @suites.present?
+        Teaspoon.configuration.suite_configs.keys
+      end
 
-    def driver
-      return @driver if @driver
-      driver = Teaspoon::Driver.fetch(Teaspoon.configuration.driver)
-      @driver = driver.new(Teaspoon.configuration.driver_options)
-    end
+      def driver
+        return @driver if @driver
+        driver = Teaspoon::Driver.fetch(Teaspoon.configuration.driver)
+        @driver = driver.new(Teaspoon.configuration.driver_options)
+      end
 
-    def base_url_for(suite)
-      ["#{@server.url}#{Teaspoon.configuration.mount_at}", suite].join("/")
-    end
+      def base_url_for(suite)
+        ["#{@server.url}#{Teaspoon.configuration.mount_at}", suite].join("/")
+      end
 
-    def url_for(suite, console = true)
-      url = [base_url_for(suite), filter(suite)].compact.join("?")
-      url += "#{(url.include?('?') ? '&' : '?')}reporter=Console" if console
-      url
-    end
+      def url_for(suite, console = true)
+        url = [base_url_for(suite), filter(suite)].compact.join("?")
+        url += "#{(url.include?('?') ? '&' : '?')}reporter=Console" if console
+        url
+      end
 
-    def filter(suite)
-      parts = []
-      parts << "grep=#{URI::encode(options[:filter])}" if options[:filter].present?
-      (@suites[suite] || options[:files] || []).flatten.each { |file| parts << "file[]=#{URI::encode(file)}" }
-      "#{parts.join('&')}" if parts.present?
-    end
+      def filter(suite)
+        parts = []
+        parts << "grep=#{CGI.escape(options[:filter])}" if options[:filter].present?
+        (@suites[suite] || options[:files] || []).flatten.each { |file| parts << "file[]=#{CGI.escape(file)}" }
+        "#{parts.join('&')}" if parts.present?
+      end
 
-    def log(str)
-      STDOUT.print("#{str}\n") unless Teaspoon.configuration.suppress_log
-    end
+      def log(str)
+        STDOUT.print("#{str}\n") unless Teaspoon.configuration.suppress_log
+      end
   end
 end

data/lib/teaspoon/coverage.rb

@@ -1,3 +1,5 @@
+require "open3"
+
 module Teaspoon
   class Coverage
     def self.configuration(name = Teaspoon.configuration.use_coverage)
@@ -18,7 +20,6 @@ module Teaspoon
     end
 
     def generate_reports(&block)
-
       input_path do |input|
         results = []
         @config.reports.each do |format|
@@ -33,8 +34,8 @@ module Teaspoon
       args = threshold_args
       return if args.blank?
       input_path do |input|
-        result = %x{#{@executable} check-coverage #{args.join(" ")} #{input.shellescape} 2>&1}
-        return if $?.exitstatus == 0
+        result, st = Open3.capture2e(@executable, "check-coverage", *args, input.shellescape)
+        return if st.exitstatus.zero?
         result = result.scan(/ERROR: .*$/).join("\n").gsub("ERROR: ", "")
         block.call(result) unless result.blank?
       end
@@ -42,31 +43,34 @@ module Teaspoon
 
     private
 
-    def self.normalize_config_name(name)
-      return "default" if name == true
-      name.to_s
-    end
+      def self.normalize_config_name(name)
+        return "default" if name == true
+        name.to_s
+      end
 
-    def input_path(&block)
-      Dir.mktmpdir do |temp_path|
-        input_path = File.join(temp_path, "coverage.json")
-        File.open(input_path, "w") { |f| f.write(@data.to_json) }
-        block.call(input_path)
+      def input_path(&block)
+        Dir.mktmpdir do |temp_path|
+          input_path = File.join(temp_path, "coverage.json")
+          File.open(input_path, "w") { |f| f.write(@data.to_json) }
+          block.call(input_path)
+        end
       end
-    end
 
-    def generate_report(input, format)
-      output_path = File.join(@config.output_path, @suite_name)
-      result = %x{#{@executable} report --include=#{input.shellescape} --dir #{output_path} #{format} 2>&1}
-      return result.gsub("Done", "").gsub("Using reporter [#{format}]", "").strip if $?.exitstatus == 0
-      raise Teaspoon::DependencyError.new("Unable to generate #{format} coverage report:\n#{result}")
-    end
+      def generate_report(input, format)
+        output_path = File.join(@config.output_path, @suite_name)
+        result, st =
+          Open3.capture2e(
+            @executable, "report", "--include=#{input.shellescape}", "--dir #{output_path}", format
+          )
+        return result.gsub("Done", "").gsub("Using reporter [#{format}]", "").strip if st.exitstatus.zero?
+        raise Teaspoon::DependencyError.new("Unable to generate #{format} coverage report:\n#{result}")
+      end
 
-    def threshold_args
-      %w{statements functions branches lines}.map do |assert|
-        threshold = @config.send(:"#{assert}")
-        "--#{assert}=#{threshold}" if threshold
-      end.compact
-    end
+      def threshold_args
+        %w{statements functions branches lines}.map do |assert|
+          threshold = @config.send(:"#{assert}")
+          "--#{assert}=#{threshold}" if threshold
+        end.compact
+      end
   end
 end

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

@@ -13,4 +13,3 @@ 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(:browserstack, "Teaspoon::Driver::BrowserStack", "teaspoon/driver/browserstack")
-Teaspoon::Driver.register(:capybara_webkit, "Teaspoon::Driver::CapybaraWebkit", "teaspoon/driver/capybara_webkit")

data/lib/teaspoon/driver/browserstack.rb

@@ -8,16 +8,13 @@ end
 
 require "teaspoon/driver/base"
 
-# The driver creates individual thread for each test.
-# This limit is here to disallow too many threads
-# Override via max_parallel key in options.
-MAX_PARALLEL = 10
-
 # 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
@@ -51,64 +48,64 @@ module Teaspoon
 
       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
+        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}"
+                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
+                yield
+                Thread.current[:driver].quit
+                STDOUT.print("#{Thread.current[:name]} Completed\n") unless Teaspoon.configuration.suppress_log
+              end
             end
+            threads.each(&:join)
+            threads = []
           end
-          threads.each(&:join)
-          threads = []
         end
-      end
 
-      def capabilities
-        driver_options[:capabilities]
-      end
+        def capabilities
+          driver_options[:capabilities]
+        end
 
-      def hub_url
-        "https://#{username}:#{access_key}@hub.browserstack.com/wd/hub"
-      end
+        def hub_url
+          "https://#{username}:#{access_key}@hub.browserstack.com/wd/hub"
+        end
 
-      def username
-        driver_options[:username] || ENV["BROWSERSTACK_USERNAME"]
-      end
+        def username
+          driver_options[:username] || ENV["BROWSERSTACK_USERNAME"]
+        end
 
-      def access_key
-        driver_options[:access_key] || ENV["BROWSERSTACK_ACCESS_KEY"]
-      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
+        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
-        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
+        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,37 +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 $?.nil? || $?.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 = 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 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();
         }