butternut 0.0.0

data/spec/butternut/formatter_spec.rb

@@ -0,0 +1,288 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Butternut
+  describe Formatter do
+    extend SpecHelperDsl
+    include SpecHelper
+
+    Spec::Matchers.define :have_css_node do |css, regexp|
+      match do |doc|
+        nodes = doc.css(css)
+        nodes.detect{ |node| node.text =~ regexp }
+      end
+    end
+
+    def setup_formatter(options = {})
+      @out = StringIO.new
+      @formatter = Butternut::Formatter.new(step_mother, @out, options)
+    end
+
+    def most_recent_html_file(dir)
+      path = Pathname.new(dir)
+      files = path.entries.collect { |file|
+        path+file
+      }.sort { |file1,file2|
+        file2.mtime <=> file1.mtime
+      }
+      files.detect { |f| f.to_s =~ /\.html$/ }
+    end
+
+    describe "visiting blank feature name" do
+      before(:each) do
+        setup_formatter
+      end
+
+      it "should not raise an error when visiting a blank feature name" do
+        lambda { @formatter.feature_name("") }.should_not raise_error
+      end
+    end
+
+    describe "given a single feature" do
+      before(:each) do
+        setup_formatter
+        run_defined_feature
+        @doc = Nokogiri.HTML(@out.string)
+      end
+
+      describe "with a comment" do
+        define_feature <<-FEATURE
+          # Healthy
+        FEATURE
+
+        it { @out.string.should =~ /^\<!DOCTYPE/ }
+        it { @out.string.should =~ /\<\/html\>$/ }
+        it { @doc.should have_css_node('.feature .comment', /Healthy/) }
+      end
+
+      describe "with a tag" do
+        define_feature <<-FEATURE
+          @foo
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .tag', /foo/) }
+      end
+
+      describe "with a narrative" do
+        define_feature <<-FEATURE
+          Feature: Bananas
+            In order to find my inner monkey
+            As a human
+            I must eat bananas
+        FEATURE
+
+        it { @doc.should have_css_node('.feature h2', /Bananas/) }
+        it { @doc.should have_css_node('.feature .narrative', /must eat bananas/) }
+      end
+
+      describe "with a background" do
+        define_feature <<-FEATURE
+          Feature: Bananas
+
+          Background:
+            Given there are bananas
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .background', /there are bananas/) }
+      end
+
+      describe "with a scenario" do
+        define_feature <<-FEATURE
+          Scenario: Monkey eats banana
+            Given there are bananas
+        FEATURE
+
+        it { @doc.should have_css_node('.feature h3', /Monkey eats banana/) }
+        it { @doc.should have_css_node('.feature .scenario .step', /there are bananas/) }
+      end
+
+      describe "with a scenario outline" do
+        define_feature <<-FEATURE
+          Scenario Outline: Monkey eats a balanced diet
+            Given there are <Things>
+
+            Examples: Fruit
+             | Things  |
+             | apples  |
+             | bananas |
+            Examples: Vegetables
+             | Things   |
+             | broccoli |
+             | carrots  |
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .scenario.outline h4', /Fruit/) }
+        it { @doc.should have_css_node('.feature .scenario.outline h4', /Vegetables/) }
+        it { @doc.css('.feature .scenario.outline h4').length.should == 2}
+        it { @doc.should have_css_node('.feature .scenario.outline table', //) }
+        it { @doc.should have_css_node('.feature .scenario.outline table td', /carrots/) }
+      end
+
+      describe "with a step with a py string" do
+        define_feature <<-FEATURE
+          Scenario: Monkey goes to town
+            Given there is a monkey called:
+             """
+             foo
+             """
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .scenario .val', /foo/) }
+      end
+
+      describe "with a multiline step arg" do
+        define_feature <<-FEATURE
+          Scenario: Monkey goes to town
+            Given there are monkeys:
+             | name |
+             | foo  |
+             | bar  |
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .scenario table td', /foo/) }
+      end
+
+      describe "with a table in the background and the scenario" do
+        define_feature <<-FEATURE
+          Background:
+            Given table:
+              | a | b |
+              | c | d |
+          Scenario:
+            Given another table:
+             | e | f |
+             | g | h |
+        FEATURE
+
+        it { @doc.css('td').length.should == 8 }
+      end
+
+      describe "with a py string in the background and the scenario" do
+        define_feature <<-FEATURE
+          Background:
+            Given stuff:
+              """
+              foo
+              """
+          Scenario:
+            Given more stuff:
+              """
+              bar
+              """
+        FEATURE
+
+        it { @doc.css('.feature .background pre.val').length.should == 1 }
+        it { @doc.css('.feature .scenario pre.val').length.should == 1 }
+      end
+
+      describe "with a step that fails in the scenario" do
+        define_steps do
+          Given(/boo/) { raise 'eek' }
+        end
+
+        define_feature(<<-FEATURE)
+          Scenario: Monkey gets a fright
+            Given boo
+        FEATURE
+
+        it { @doc.should have_css_node('.feature .scenario .step.failed', /eek/) }
+      end
+
+      describe "with a step that fails in the backgound" do
+        define_steps do
+          Given(/boo/) { raise 'eek' }
+        end
+
+        define_feature(<<-FEATURE)
+          Background:
+            Given boo
+          Scenario:
+            Given yay
+          FEATURE
+
+        it { @doc.should have_css_node('.feature .background .step.failed', /eek/) }
+        it { @doc.should_not have_css_node('.feature .scenario .step.failed', //) }
+        it { @doc.should have_css_node('.feature .scenario .step.undefined', /yay/) }
+      end
+    end
+
+    describe "displaying page source to stdout" do
+      before(:each) do
+        setup_formatter
+        run_defined_feature
+        @doc = Nokogiri.HTML(@out.string)
+      end
+
+      define_steps do
+        Given(/foo/) do
+          visit("file://" + File.expand_path(File.dirname(__FILE__) + "/../fixtures/foo.html"))
+        end
+      end
+
+      define_feature(<<-FEATURE)
+        Scenario: Monkey goes to the zoo
+          Given foo
+      FEATURE
+
+      it do
+        step = @doc.at('.feature .scenario .step.passed')
+        link = step.at('a[href^="file:///tmp/"]')
+        link.should_not be_nil
+      end
+    end
+
+    describe "displaying page source to file" do
+      before(:each) do
+        @tmpdir = File.join(File.dirname(__FILE__), "..", "..", "tmp")
+        setup_formatter({:formats => [
+          ['Butternut::Formatter', File.join(@tmpdir, "main", "huge.html")]
+        ]})
+        run_defined_feature
+        @doc = Nokogiri.HTML(@out.string)
+
+        dir = File.join(@tmpdir, "features", Date.today.to_s)
+        file = most_recent_html_file(dir)
+        @page_doc = Nokogiri.HTML(open(file).read)
+      end
+
+      define_steps do
+        Given(/foo/) do
+          visit("file://" + File.expand_path(File.dirname(__FILE__) + "/../fixtures/foo.html"))
+        end
+      end
+
+      define_feature(<<-FEATURE)
+        Scenario: Monkey goes to the zoo
+          Given foo
+      FEATURE
+
+      it "links to the page source" do
+        step = @doc.at('.feature .scenario .step.passed')
+        link = step.at("a")
+        link.should_not be_nil
+        file = link['href']
+        file.should match(%r{^/features/#{Date.today.to_s}/butternut.+\.html})
+      end
+
+      it "saves images and stylesheets and rewrites urls in page source" do
+        @page_doc.at('img')['src'].should == "picard.jpg"
+        @page_doc.at('link[rel="stylesheet"]')['href'].should == "foo.css"
+      end
+
+      it "turns off links" do
+        @page_doc.css('a').each do |link|
+          link['href'].should == "#"
+        end
+      end
+
+      it "turns off scripts" do
+        @page_doc.css('script').length.should == 0
+      end
+
+      it "disables form elements" do
+        @page_doc.css('input, select, textarea').each do |elt|
+          elt['disabled'].should == "disabled"
+        end
+      end
+    end
+  end
+end

data/spec/butternut/helpers_spec.rb

@@ -0,0 +1,128 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Butternut
+  describe Helpers do
+    include Helpers
+
+    def define_stub_chain
+      # This is what I hate about RSpec.
+      @stub_request_url = stub("fake request url", :toString => "http://example.com")
+      @stub_response = stub("fake web response", :getRequestUrl => @stub_request_url)
+      @stub_page = stub("fake html page", {
+        :as_xml => "<cheese>pepperjack</cheese>",
+        :getWebResponse => @stub_response
+      })
+      @stub_element = stub("fake element", :value= => nil, :select => nil, :click => nil, :exist? => true)
+      @stub_empty = stub("fake empty element", :exist? => false)
+
+      @stub_browser = stub("fake celerity browser", {
+        :goto => @stub_page, :page => @stub_page,
+        :text_field => @stub_element, :select_list => @stub_element,
+        :button => @stub_element
+      })
+      stub!(:browser).and_return(@stub_browser)
+    end
+
+    describe "#browser" do
+      it { browser.should be_a(Celerity::Browser) }
+    end
+
+    describe "#page_changed?" do
+      it { page_changed?.should_not be_true }
+    end
+
+    describe "#visit" do
+      before(:each) { define_stub_chain }
+
+      it "should go to the page" do
+        @stub_browser.should_receive(:goto).with("http://google.com")
+        visit("http://google.com")
+      end
+
+      it "should flag page as changed" do
+        visit("http://google.com")
+        page_changed?.should be_true
+      end
+    end
+
+    describe "#current_url" do
+      before(:each) { define_stub_chain }
+      it do
+        @stub_request_url.should_receive(:toString).and_return("http://google.com")
+        current_url.should == "http://google.com"
+      end
+    end
+
+    describe "#current_page_source" do
+      before(:each) { define_stub_chain }
+
+      it "returns the current page's source" do
+        @stub_page.should_receive(:as_xml).and_return("pants")
+        current_page_source.should == "pants"
+      end
+
+      it "returns nil if page is nil" do
+        @stub_browser.stub!(:page).and_return(nil)
+        current_page_source.should be_nil
+      end
+    end
+
+    describe "#fill_in" do
+      before(:each) { define_stub_chain }
+
+      it "should find by label" do
+        @stub_browser.should_receive(:text_field).with(:label, "pants").and_return(@stub_element)
+        @stub_element.should_receive(:value=).with("khakis")
+        fill_in("pants", :with => "khakis")
+      end
+
+      it "should find by name" do
+        @stub_browser.should_receive(:text_field).with(:label, "pants").and_return(@stub_empty)
+        @stub_browser.should_receive(:text_field).with(:name, "pants").and_return(@stub_element)
+        @stub_element.should_receive(:value=).with("khakis")
+        fill_in("pants", :with => "khakis")
+      end
+
+      it "should flag page as changed" do
+        fill_in("pants", :with => "khakis")
+        page_changed?.should be_true
+      end
+    end
+
+    describe "#select" do
+      before(:each) { define_stub_chain }
+
+      it "should find by label" do
+        @stub_browser.should_receive(:select_list).with(:label, "pants").and_return(@stub_element)
+        @stub_element.should_receive(:select).with("khakis")
+        select("khakis", :from => "pants")
+      end
+
+      it "should find by name" do
+        @stub_browser.should_receive(:select_list).with(:label, "pants").and_return(@stub_empty)
+        @stub_browser.should_receive(:select_list).with(:name, "pants").and_return(@stub_element)
+        @stub_element.should_receive(:select).with("khakis")
+        select("khakis", :from => "pants")
+      end
+
+      it "should flag page as changed" do
+        select("khakis", :from => "pants")
+        page_changed?.should be_true
+      end
+    end
+
+    describe "#click_button" do
+      before(:each) { define_stub_chain }
+      it do
+        @stub_browser.should_receive(:button).with("pants").and_return(@stub_element)
+        @stub_element.should_receive(:click)
+        click_button("pants")
+      end
+
+      it "should flag page as changed" do
+        click_button("pants")
+        page_changed?.should be_true
+      end
+    end
+  end
+end

data/spec/butternut_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Butternut do
+  describe "running a scenario" do
+    extend SpecHelperDsl
+    include SpecHelper
+
+    describe "saving last page info" do
+      define_steps do
+        Given('waffles') do
+          visit("file://" + File.expand_path(File.dirname(__FILE__) + "/fixtures/foo.html"))
+        end
+        AfterStep do |scenario|
+          begin
+            scenario.last_page_source.should match(/Foo/)
+            scenario.last_page_url.should match(/foo\.html/)
+          rescue Exception => e
+            p e
+          end
+        end
+      end
+
+      define_feature <<-FEATURE
+        Scenario: Roffle waffles
+          Given waffles
+      FEATURE
+
+      it { run_defined_feature }
+    end
+
+    describe "resetting page_changed" do
+      define_steps do
+        Given('waffles') do
+          visit("file://" + File.expand_path(File.dirname(__FILE__) + "/fixtures/foo.txt"))
+        end
+        AfterStep do |scenario|
+          begin
+            page_changed?.should be_false
+          rescue Exception => e
+            p e
+          end
+        end
+      end
+
+      define_feature <<-FEATURE
+        Scenario: Roffle waffles
+          Given waffles
+      FEATURE
+
+      it { run_defined_feature }
+    end
+  end
+end

data/spec/fixtures/foo.css

@@ -0,0 +1,3 @@
+body {
+  font-family: Verdana;
+}

data/spec/fixtures/foo.html

@@ -0,0 +1,20 @@
+<html>
+  <head>
+    <title>Foo</title>
+    <link rel="stylesheet" href="foo.css" type="text/css"/>
+    <script type="text/javascript" src="foo.js"></script>
+  </head>
+  <body>
+    Foo
+    <img src="picard.jpg"/>
+    <a href="http://picard.ytmnd.com/">Picard song</a>
+    <form action="foo.html" method="post">
+      <input type="text" name="foo" />
+      <select name="bar">
+        <option>pants</option>
+      </select>
+      <textarea name="yar"></textarea>
+      <input type="submit" value="Submit" />
+    </form>
+  </body>
+</html>

data/spec/fixtures/foo.js

@@ -0,0 +1,3 @@
+function picard() {
+  alert('Make it so!');
+}

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require 'spec/autorun'
+require 'ruby-debug'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'butternut'
+
+require 'cucumber/rb_support/rb_language'
+require 'nokogiri'
+
+module SpecHelperDsl
+  attr_reader :feature_content, :step_defs
+
+  def define_feature(string)
+    @feature_content = string
+  end
+
+  def define_steps(&block)
+    @step_defs = block
+  end
+end
+
+module SpecHelper
+  def run_defined_feature
+    setup_world
+    define_steps
+    features = load_features(self.class.feature_content || raise("No feature content defined!"))
+    run(features)
+  end
+
+  def step_mother
+    @step_mother ||= Cucumber::StepMother.new
+  end
+
+  def load_features(content)
+    feature_file = Cucumber::FeatureFile.new('spec.feature', content)
+    features = Cucumber::Ast::Features.new
+    features.add_feature feature_file.parse(step_mother, {})
+    features
+  end
+
+  def run(features)
+    # options = { :verbose => true }
+    options = {}
+    tree_walker = Cucumber::Ast::TreeWalker.new(step_mother, @formatter ? [@formatter] : [], options, STDOUT)
+    tree_walker.visit_features(features)
+  end
+
+  def dsl
+    unless @dsl
+      rb = step_mother.load_programming_language('rb')
+      @dsl = Object.new
+      @dsl.extend Cucumber::RbSupport::RbDsl
+    end
+    @dsl
+  end
+
+  def define_steps
+    return unless step_defs = self.class.step_defs
+    dsl.instance_exec &step_defs
+  end
+
+  def setup_world
+    dsl.instance_exec do
+      Butternut.setup_hooks(self)
+      World(Butternut::Helpers)
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    Cucumber::Parser::NaturalLanguage.instance_variable_set(:@languages, nil)
+  end
+end

data/tmp/features/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

data/tmp/main/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore