dwaite-cucumber 0.3.101

data/spec/cucumber/broadcaster_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module Cucumber
+  describe Broadcaster do
+    before do
+      @receiver = mock('receiver')
+      @broadcaster = Broadcaster.new([@receiver])
+    end
+    
+    it "should broadcast methods to registered objects" do
+      @receiver.should_receive(:konbanwa).with('good evening')
+      @broadcaster.konbanwa('good evening')
+    end
+  end
+end

data/spec/cucumber/cli/configuration_spec.rb

@@ -0,0 +1,396 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'yaml'
+
+module Cucumber
+module Cli
+  describe Configuration do
+
+    def given_cucumber_yml_defined_as(hash_or_string)
+      File.stub!(:exist?).and_return(true)
+      cucumber_yml = hash_or_string.is_a?(Hash) ? hash_or_string.to_yaml : hash_or_string
+      IO.stub!(:read).with('cucumber.yml').and_return(cucumber_yml)
+    end
+
+    def given_the_following_files(*files)
+      File.stub!(:directory?).and_return(true)
+      File.stub!(:file?).and_return(true)
+      Dir.stub!(:[]).and_return(files)
+    end
+
+    before(:each) do
+      File.stub!(:exist?).and_return(false) # Meaning, no cucumber.yml exists
+      Kernel.stub!(:exit).and_return(nil)
+    end
+
+    def config
+      @config ||= Configuration.new(@out = StringIO.new, @error = StringIO.new)
+    end
+
+    def reset_config
+      @config = nil
+    end
+
+    attr_reader :out, :error
+
+    it "should require env.rb files first" do
+      given_the_following_files("/features/support/a_file.rb","/features/support/env.rb")
+
+      config.parse!(%w{--require /features})
+
+      config.support_to_load.should == [
+        "/features/support/env.rb",
+        "/features/support/a_file.rb"
+      ]
+    end
+
+    it "should not require env.rb files when --dry-run" do
+      given_the_following_files("/features/support/a_file.rb","/features/support/env.rb")
+
+      config.parse!(%w{--require /features --dry-run})
+
+      config.support_to_load.should == [
+        "/features/support/a_file.rb"
+      ]
+    end
+
+    it "should require files in vendor/{plugins,gems}/*/cucumber/*.rb" do
+      given_the_following_files("/vendor/plugins/plugin_a/cucumber/foo.rb",
+                                "/vendor/gems/gem_a/cucumber/bar.rb")
+
+      config.parse!(%w{--require /features})
+
+      config.step_defs_to_load.should == [
+        "/vendor/plugins/plugin_a/cucumber/foo.rb",
+        "/vendor/gems/gem_a/cucumber/bar.rb"
+      ]
+    end
+
+    describe "--exclude" do
+
+      it "excludes a ruby file from requiring when the name matches exactly" do
+        given_the_following_files("/features/support/a_file.rb","/features/support/env.rb")
+
+        config.parse!(%w{--require /features --exclude a_file.rb})
+
+        config.all_files_to_load.should == [
+          "/features/support/env.rb"
+        ]
+      end
+
+      it "excludes all ruby files that match the provided patterns from requiring" do
+        given_the_following_files("/features/support/foof.rb","/features/support/bar.rb",
+                                  "/features/support/food.rb","/features/blah.rb",
+                                  "/features/support/fooz.rb")
+
+        config.parse!(%w{--require /features --exclude foo[df] --exclude blah})
+
+        config.all_files_to_load.should == [
+          "/features/support/bar.rb",
+          "/features/support/fooz.rb"
+        ]
+      end
+    end
+
+    describe '#drb?' do
+      it "indicates whether the --drb flag was passed in or not" do
+        config.parse!(%w{features})
+        config.should_not be_drb
+
+
+        config.parse!(%w{features --drb})
+        config.should be_drb
+      end
+    end
+
+    describe "#drb_port" do
+      it "is nil when not configured" do
+        config.parse!([])
+        config.drb_port.should be_nil
+      end
+
+      it "is numeric when configured" do
+        config.parse!(%w{features --port 1000})
+        config.drb_port.should == 1000
+      end
+
+
+    end
+
+    it "uses the default profile when no profile is defined" do
+      given_cucumber_yml_defined_as({'default' => '--require some_file'})
+
+      config.parse!(%w{--format progress})
+      config.options[:require].should include('some_file')
+    end
+
+    context '--profile' do
+
+      it "expands args from profiles in the cucumber.yml file" do
+        given_cucumber_yml_defined_as({'bongo' => '--require from/yml'})
+
+        config.parse!(%w{--format progress --profile bongo})
+        config.options[:formats].should == [['progress', out]]
+        config.options[:require].should == ['from/yml']
+      end
+
+      it "expands args from the default profile when no flags are provided" do
+        given_cucumber_yml_defined_as({'default' => '--require from/yml'})
+
+        config.parse!([])
+        config.options[:require].should == ['from/yml']
+      end
+      
+      it "parses ERB syntax in the cucumber.yml file" do
+        given_cucumber_yml_defined_as({'default' => '<%="--require some_file"%>'})
+
+        config.parse!([])
+        config.options[:require].should include('some_file')
+      end
+
+      it "provides a helpful error message when a specified profile does not exists in cucumber.yml" do
+        given_cucumber_yml_defined_as({'default' => '--require from/yml', 'html_report' =>  '--format html'})
+
+        expected_message = <<-END_OF_MESSAGE
+Could not find profile: 'i_do_not_exist'
+
+Defined profiles in cucumber.yml:
+  * default
+  * html_report
+END_OF_MESSAGE
+
+        lambda{config.parse!(%w{--profile i_do_not_exist})}.should raise_error(ProfileNotFound, expected_message)
+      end
+
+      it "allows profiles to be defined in arrays" do
+        given_cucumber_yml_defined_as({'foo' => ['-f','progress']})
+
+        config.parse!(%w{--profile foo})
+        config.options[:formats].should == [['progress', out]]
+      end
+
+      it "disregards default STDOUT formatter defined in profile when another is passed in (via cmd line)" do
+        given_cucumber_yml_defined_as({'foo' => %w[--format pretty]})
+        config.parse!(%w{--format progress --profile foo})
+        config.options[:formats].should == [['progress', out]]#, ['pretty', 'pretty.txt']]
+      end
+
+
+
+      ["--no-profile", "-P"].each do |flag|
+        context 'when none is specified with #{flag}' do
+          it "disables profiles" do
+            given_cucumber_yml_defined_as({'default' => '-v --require file_specified_in_default_profile.rb'})
+
+            config.parse!("#{flag} --require some_file.rb".split(" "))
+            config.options[:require].should == ['some_file.rb']
+          end
+
+          it "notifies the user that the profiles are being disabled" do
+            given_cucumber_yml_defined_as({'default' => '-v'})
+
+            config.parse!("#{flag} --require some_file.rb".split(" "))
+            out.string.should =~ /Disabling profiles.../
+          end
+        end
+      end
+
+      it "issues a helpful error message when a specified profile exists but is nil or blank" do
+        [nil, '   '].each do |bad_input|
+          given_cucumber_yml_defined_as({'foo' => bad_input})
+
+          expected_error = /The 'foo' profile in cucumber.yml was blank.  Please define the command line arguments for the 'foo' profile in cucumber.yml./
+          lambda{config.parse!(%w{--profile foo})}.should raise_error(expected_error)
+        end
+      end
+
+      it "issues a helpful error message when no YAML file exists and a profile is specified" do
+        File.should_receive(:exist?).with('cucumber.yml').and_return(false)
+
+        expected_error = /cucumber.yml was not found.  Please refer to cucumber's documentation on defining profiles in cucumber.yml./
+        lambda{config.parse!(%w{--profile i_do_not_exist})}.should raise_error(expected_error)
+      end
+
+      it "issues a helpful error message when cucumber.yml is blank or malformed" do
+          expected_error_message = /cucumber.yml was found, but was blank or malformed. Please refer to cucumber's documentation on correct profile usage./
+
+        ['', 'sfsadfs', "--- \n- an\n- array\n", "---dddfd"].each do |bad_input|
+          given_cucumber_yml_defined_as(bad_input)
+          lambda{config.parse!([])}.should raise_error(expected_error_message)
+          reset_config
+        end
+      end
+
+      it "issues a helpful error message when cucumber.yml can not be parsed" do
+        expected_error_message = /cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage./
+
+        given_cucumber_yml_defined_as("input that causes an exception in YAML loading")
+        YAML.should_receive(:load).and_raise ArgumentError
+
+        lambda{config.parse!([])}.should raise_error(expected_error_message)
+      end
+
+      it "issues a helpful error message when cucumber.yml can not be parsed by ERB" do
+        expected_error_message = /cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage./
+        given_cucumber_yml_defined_as("<% this_fails %>")
+
+        lambda{config.parse!([])}.should raise_error(expected_error_message)
+      end
+    end
+
+
+    it "should accept --dry-run option" do
+      config.parse!(%w{--dry-run})
+      config.options[:dry_run].should be_true
+    end
+
+    it "should accept --no-source option" do
+      config.parse!(%w{--no-source})
+
+      config.options[:source].should be_false
+    end
+
+    it "should accept --no-snippets option" do
+      config.parse!(%w{--no-snippets})
+
+      config.options[:snippets].should be_false
+    end
+
+    it "should set snippets and source to false with --quiet option" do
+      config.parse!(%w{--quiet})
+
+      config.options[:snippets].should be_false
+      config.options[:source].should be_false
+    end
+
+    it "should accept --verbose option" do
+      config.parse!(%w{--verbose})
+
+      config.options[:verbose].should be_true
+    end
+
+    it "should accept --out option" do
+      config.parse!(%w{--out jalla.txt})
+      config.options[:formats].should == [['pretty', 'jalla.txt']]
+    end
+
+    it "should accept multiple --out options" do
+      config.parse!(%w{--format progress --out file1 --out file2})
+      config.options[:formats].should == [['progress', 'file2']]
+    end
+
+    it "should accept multiple --format options and put the STDOUT one first so progress is seen" do
+      config.parse!(%w{--format pretty --out pretty.txt --format progress})
+      config.options[:formats].should == [['progress', out], ['pretty', 'pretty.txt']]
+    end
+
+    it "should not accept multiple --format options when both use implicit STDOUT" do
+      lambda do
+        config.parse!(%w{--format pretty --format progress})
+      end.should raise_error("All but one formatter must use --out, only one can print to each stream (or STDOUT)")
+    end
+
+    it "should not accept multiple --out streams pointing to the same place" do
+      lambda do
+        config.parse!(%w{--format pretty --out file1 --format progress --out file1})
+      end.should raise_error("All but one formatter must use --out, only one can print to each stream (or STDOUT)")
+    end
+
+    it "should associate --out to previous --format" do
+      config.parse!(%w{--format progress --out file1 --format profile --out file2})
+      config.options[:formats].should == [["progress", "file1"], ["profile" ,"file2"]]
+    end
+
+    it "should accept --color option" do
+      Term::ANSIColor.should_receive(:coloring=).with(true)
+      config.parse!(['--color'])
+    end
+
+    it "should accept --no-color option" do
+      Term::ANSIColor.should_receive(:coloring=).with(false)
+      config = Configuration.new(StringIO.new)
+      config.parse!(['--no-color'])
+    end
+
+    describe "--backtrace" do
+      before do
+        Cucumber.use_full_backtrace = false
+      end
+
+      it "should show full backtrace when --backtrace is present" do
+        config = Main.new(['--backtrace'])
+        begin
+          "x".should == "y"
+        rescue => e
+          e.backtrace[0].should_not == "#{__FILE__}:#{__LINE__ - 2}"
+        end
+      end
+
+      after do
+        Cucumber.use_full_backtrace = false
+      end
+    end
+
+    describe "diff output" do
+
+      it "is enabled by default" do
+        config.diff_enabled?.should be_true
+      end
+
+      it "is disabled when the --no-diff option is supplied" do
+        config.parse!(%w{--no-diff})
+
+        config.diff_enabled?.should be_false
+      end
+
+    end
+
+    it "should accept multiple --name options" do
+      config.parse!(['--name', "User logs in", '--name', "User signs up"])
+
+      config.options[:name_regexps].should include(/User logs in/)
+      config.options[:name_regexps].should include(/User signs up/)
+    end
+
+    it "should accept multiple -n options" do
+      config.parse!(['-n', "User logs in", '-n', "User signs up"])
+
+      config.options[:name_regexps].should include(/User logs in/)
+      config.options[:name_regexps].should include(/User signs up/)
+    end
+
+    it "should search for all features in the specified directory" do
+      File.stub!(:directory?).and_return(true)
+      Dir.should_receive(:[]).with("feature_directory/**/*.feature").
+        any_number_of_times.and_return(["cucumber.feature"])
+
+      config.parse!(%w{feature_directory/})
+
+      config.feature_files.should == ["cucumber.feature"]
+    end
+
+    it "defaults to the features directory when no feature file are provided" do
+      File.stub!(:directory?).and_return(true)
+      Dir.should_receive(:[]).with("features/**/*.feature").
+        any_number_of_times.and_return(["cucumber.feature"])
+
+      config.parse!(%w{})
+
+      config.feature_files.should == ["cucumber.feature"]
+    end
+
+    it "should allow specifying environment variables on the command line" do
+      config.parse!(["foo=bar"])
+      ENV["foo"].should == "bar"
+      config.feature_files.should_not include('foo=bar')
+    end
+
+    it "should allow specifying environment variables in profiles" do
+      given_cucumber_yml_defined_as({'selenium' => 'RAILS_ENV=selenium'})
+      config.parse!(["--profile", "selenium"])
+      ENV["RAILS_ENV"].should == "selenium"
+      config.feature_files.should_not include('RAILS_ENV=selenium')
+    end
+
+  end
+end
+end

data/spec/cucumber/cli/drb_client_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+
+module Cucumber
+  module Cli
+    describe DRbClient do
+      before(:each) do
+        @args = ['features']
+        @error_stream = StringIO.new
+        @out_stream = StringIO.new
+
+        @drb_object = mock('DRbObject', :run => true)
+        DRbObject.stub!(:new_with_uri).and_return(@drb_object)
+      end
+
+      it "starts up a druby service" do
+        DRb.should_receive(:start_service).with("druby://localhost:0")
+        DRbClient.run(@args, @error_stream, @out_stream)
+      end
+
+      it "connects to the DRb server" do
+        DRbObject.should_receive(:new_with_uri).with("druby://127.0.0.1:8990")
+        DRbClient.run(@args, @error_stream, @out_stream)
+      end
+
+      it "runs the features on the DRb server" do
+        @drb_object.should_receive(:run).with(@args, @error_stream, @out_stream)
+        DRbClient.run(@args, @error_stream, @out_stream)
+      end
+
+      it "returns raises an error when it can't connect to the server" do
+        DRbObject.stub!(:new_with_uri).and_raise(DRb::DRbConnError)
+        running { DRbClient.run(@args, @error_stream, @out_stream) }.should raise_error(DRbClientError, "No DRb server is running.")
+      end
+
+      it "returns the result from the DRb server call" do
+        @drb_object.should_receive(:run).and_return('foo')
+        DRbClient.run(@args, @error_stream, @out_stream).should == 'foo'
+      end
+
+      context "with $CUCUMBER_DRB set" do
+        before do 
+          @original_env = ENV['CUCUMBER_DRB']
+          ENV['CUCUMBER_DRB'] = '90000'
+        end
+        after do
+          ENV['CUCUMBER_DRB'] = @original_env
+        end
+        it "connects to specified DRb server" do
+          DRbObject.should_receive(:new_with_uri).with("druby://127.0.0.1:90000")
+          DRbClient.run(@args, @error_stream, @out_stream)
+        end
+      end
+
+      context "with provided drb_port" do
+        before do
+          @args = @args + ['--port', '8000']
+        end
+        it "connects to specified drb port" do
+          DRbObject.should_receive(:new_with_uri).with("druby://127.0.0.1:8000")
+          DRbClient.run(@args, @error_stream, @out_stream, 8000)
+        end
+        it "prefers configuration to environment"  do
+          original = ENV['CUCUMBER_DRB'] = original
+          begin
+            ENV['CUCUMBER_DRB'] = "4000"
+            DRbObject.should_receive(:new_with_uri).with("druby://127.0.0.1:8000")
+            DRbClient.run(@args, @error_stream, @out_stream, 8000)
+          ensure
+            ENV['CUCUMBER_DRB'] = original
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/cucumber/cli/main_spec.rb

@@ -0,0 +1,172 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'yaml'
+begin
+  require 'spec/runner/differs/default' # RSpec >=1.2.4
+rescue ::LoadError
+  require 'spec/expectations/differs/default' # RSpec <=1.2.3
+end
+
+module Cucumber
+  module Cli
+    describe Main do
+      before(:each) do
+        @out = StringIO.new
+        @err = StringIO.new
+        Kernel.stub!(:exit).and_return(nil)
+        File.stub!(:exist?).and_return(false) # When Configuration checks for cucumber.yml
+        Dir.stub!(:[]).and_return([]) # to prevent cucumber's features dir to being laoded
+      end
+
+      describe "verbose mode" do
+
+        before(:each) do
+          @empty_feature = Ast::Feature.new(nil, Ast::Comment.new(''), Ast::Tags.new(2, []), "Feature", [])
+        end
+
+        it "should show feature files parsed" do
+          @cli = Main.new(%w{--verbose example.feature}, @out)
+          @cli.stub!(:require)
+
+          FeatureFile.stub!(:new).and_return(mock("feature file", :parse => @empty_feature))
+
+          @cli.execute!(StepMother.new)
+
+          @out.string.should include('example.feature')
+        end
+
+      end
+
+      describe "diffing" do
+
+        before :each do
+          @configuration = mock('Configuration', :null_object => true, :drb? => false)
+          Configuration.should_receive(:new).and_return(@configuration)
+
+          @step_mother = mock('StepMother', :null_object => true)
+
+          @cli = Main.new(nil, @out)
+        end
+
+        it "uses Spec Differ::Default when diff is enabled" do
+          @configuration.should_receive(:diff_enabled?).and_return(true)
+
+          ::Spec::Expectations::Differs::Default.should_receive(:new)
+
+          @cli.execute!(@step_mother)
+        end
+
+        it "does not use Spec Differ::Default when diff is disabled" do
+          @configuration.should_receive(:diff_enabled?).and_return(false)
+
+          ::Spec::Expectations::Differs::Default.should_not_receive(:new)
+
+          @cli.execute!(@step_mother)
+        end
+
+      end
+
+      describe "--format with class" do
+
+       describe "in module" do
+
+          it "should resolve each module until it gets Formatter class" do
+            cli = Main.new(%w{--format ZooModule::MonkeyFormatterClass}, nil)
+            mock_module = mock('module')
+            Object.stub!(:const_defined?).and_return(true)
+            mock_module.stub!(:const_defined?).and_return(true)
+
+            f = stub('formatter', :null_object => true)
+
+            Object.should_receive(:const_get).with('ZooModule').and_return(mock_module)
+            mock_module.should_receive(:const_get).with('MonkeyFormatterClass').and_return(mock('formatter class', :new => f))
+
+            cli.execute!(StepMother.new)
+          end
+
+        end
+      end
+
+      describe "setup step sequence" do
+        
+        it "should load files and execute hooks in order" do
+          Configuration.stub!(:new).and_return(configuration = mock('configuration', :null_object => true))
+          step_mother = mock('step mother', :null_object => true)
+          configuration.stub!(:drb?).and_return false
+          cli = Main.new(%w{--verbose example.feature}, @out)
+          cli.stub!(:require)
+          
+          configuration.stub!(:support_to_load).and_return(['support'])
+          configuration.stub!(:step_defs_to_load).and_return(['step defs'])
+          
+          # Support must be loaded first to ensure post configuration hook can
+          # run before anything else.
+          step_mother.should_receive(:load_code_files).with(['support']).ordered
+          # The post configuration hook/s (if any) need to be run next to enable
+          # extensions to do their thing before features are loaded
+          step_mother.should_receive(:after_configuration).with(configuration).ordered
+          # Feature files must be loaded before step definitions are required.
+          # This is because i18n step methods are only aliased when
+          # features are loaded. If we swap the order, the requires
+          # will fail.
+          step_mother.should_receive(:load_plain_text_features).ordered
+          step_mother.should_receive(:load_code_files).with(['step defs']).ordered
+
+          cli.execute!(step_mother)
+        end
+        
+      end
+      
+    [ProfilesNotDefinedError, YmlLoadError, ProfileNotFound].each do |exception_klass|
+
+      it "rescues #{exception_klass}, prints the message to the error stream and returns true" do
+        Configuration.stub!(:new).and_return(configuration = mock('configuration'))
+        configuration.stub!(:parse!).and_raise(exception_klass.new("error message"))
+
+        main = Main.new('', out = StringIO.new, error = StringIO.new)
+        main.execute!(StepMother.new).should be_true
+        error.string.should == "error message\n"
+      end
+    end
+
+
+      context "--drb" do
+        before(:each) do
+          @configuration = mock('Configuration', :drb? => true, :null_object => true)
+          Configuration.stub!(:new).and_return(@configuration)
+
+          @args = ['features']
+
+          @cli = Main.new(@args, @out, @err)
+          @step_mother = mock('StepMother', :null_object => true)
+        end
+
+        it "delegates the execution to the DRB client passing the args and streams" do
+          @configuration.stub :drb_port => 1450
+          DRbClient.should_receive(:run).with(@args, @err, @out, 1450).and_return(true)
+          @cli.execute!(@step_mother)
+        end
+
+        it "returns the result from the DRbClient" do
+          DRbClient.stub!(:run).and_return('foo')
+          @cli.execute!(@step_mother).should == 'foo'
+        end
+
+        it "ceases execution if the DrbClient is able to perform the execution" do
+          DRbClient.stub!(:run).and_return(true)
+          @configuration.should_not_receive(:build_formatter_broadcaster)
+          @cli.execute!(@step_mother)
+        end
+
+        context "when the DrbClient is unable to perfrom the execution" do
+          before { DRbClient.stub!(:run).and_raise(DRbClientError.new('error message.')) }
+
+          it "alerts the user that execution will be performed locally" do
+            @cli.execute!(@step_mother)
+            @err.string.should include("WARNING: error message. Running features locally:")
+          end
+
+        end
+      end
+    end
+  end
+end