gitnesse 0.12.5 → 0.12.6

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/config/gitnesse.rb

data/README.md

@@ -4,6 +4,8 @@
 
  It enables a project to store Cucumber feature stories in a git-based wiki, test them against your code, and then update the wiki with the latest test results.
 
+ The advantage is, that the features are on a wiki, so non-programmers can see them, and edit using the wiki. Hence an awesome bi-directional testing flow between developers and non-developers on a team.
+
  Conceptually influenced by Fitnesse http://fitnesse.org/ thank you Uncle Bob!
 
 ## Installation
@@ -29,6 +31,17 @@ the following to it:
       config.info = "Bob Martin's development laptop"
     end
 
+## Git Config
+
+Gitnesse depends on two values being present in your `gitconfig`: `user.name`
+and `user.email`. These will be used when annotating test results, and to
+identify commits you make to the feature wiki. If Gitnesse complains that you
+don't have these set, you can fix this by entering the following lines in your
+terminal:
+
+    $ git config --add --global user.name <your_name>
+    $ git config --add --global user.email <your_email>
+
 ## rake tasks
 
     $ rake gitnesse:pull

data/config/gitnesse.rb.example

@@ -0,0 +1,5 @@
+Gitnesse.configure do |config|
+  config.repository_url = "git@github.com:hybridgroup/gitnesse.wiki.git"
+  config.annotate_results = true
+  config.info = "Bob Martin's development laptop"
+end

data/features/step_definitions/gitnesse_steps.rb

@@ -0,0 +1,54 @@
+Given /^there is a code repo with cucumber features defined$/ do
+  @repo_dir = File.join(Dir.home, ".gitnesse_repo")
+end
+
+Given /^there is a code repo without any cucumber features defined$/ do
+  @repo_dir = File.join(Dir.home, ".gitnesse_repo_no_features")
+end
+
+Given /^there is a git wiki with cucumber features defined$/ do
+  @features_dir = File.join(Dir.home, ".gitnesse_features")
+
+  config_file = File.join(@repo_dir, "gitnesse.rb")
+  config = File.read(config_file)
+  config.gsub!(/config\.repository_url.*$/, "config.repository_url = '#{@features_dir}'")
+  File.open(config_file, 'w') { |file| file.puts config }
+end
+
+Given /^there is a git wiki without any cucumber features defined$/ do
+  @features_dir = File.join(Dir.home, ".gitnesse_features_no_features")
+
+  config_file = File.join(@repo_dir, "gitnesse.rb")
+  config = File.read(config_file)
+  config.gsub!(/config\.repository_url.*$/, "config.repository_url = '#{@features_dir}'")
+  File.open(config_file, 'w') { |file| file.puts config }
+end
+
+When /^developer pulls feature stories from the wiki$/ do
+  Dir.chdir(@repo_dir) do
+    `bundle exec rake gitnesse:pull &> /dev/null`
+    assert_equal $?, 0
+  end
+end
+
+When /^developer pushes feature stories to the wiki$/ do
+  Dir.chdir(@repo_dir) do
+    `bundle exec rake gitnesse:push &> /dev/null`
+    assert_equal $?, 0
+  end
+end
+
+Then /^the feature stories within the code should match the wiki$/ do
+  assert_dir = File.join(Dir.home, ".gitnesse_features_for_assert")
+
+  `git clone #{@features_dir} #{assert_dir} &> /dev/null`
+
+  repo_features = Dir.glob("#{@repo_dir}/features/*.feature").map { |file| File.basename(file, ".feature") }
+  wiki_files    = Dir.glob("#{assert_dir}/*.md").map { |file| File.basename(file, ".md") }
+
+  FileUtils.rm_rf(assert_dir)
+
+  repo_features.each do |feature|
+    assert(wiki_files.include?(feature) || wiki_files.include?("#{feature}.feature"))
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,65 @@
+require 'test/unit/assertions'
+World(Test::Unit::Assertions)
+
+puts "  Setting up Gitnesse for testing..."
+
+@features_dir = File.join(Dir.home, ".gitnesse_features")
+@features_dir_no_features = File.join(Dir.home, ".gitnesse_features_no_features")
+@repo_dir = File.join(Dir.home, ".gitnesse_repo")
+@repo_dir_no_features = File.join(Dir.home, ".gitnesse_repo_no_features")
+
+Dir.mkdir @features_dir
+Dir.mkdir @repo_dir
+Dir.mkdir @features_dir_no_features
+Dir.mkdir @repo_dir_no_features
+
+Dir.chdir(@features_dir) do
+  system('git clone --bare https://github.com/hybridgroup/gitnesse-demo.wiki.git . &> /dev/null')
+  if $? == 0
+    puts "  Cloned demo features to #{@features_dir}."
+  else
+    abort "  Failed to clone demo features to #{@features_dir}."
+  end
+end
+
+Dir.chdir(@features_dir_no_features) do
+  system('git init --bare &> /dev/null')
+  if $? == 0
+    puts "  Created demo wiki without features in #{@features_dir_no_features}."
+  else
+    abort "  Failed to create demo wiki without features in #{@features_dir_no_features}."
+  end
+end
+
+Dir.chdir(@repo_dir) do
+  system('git clone https://github.com/hybridgroup/gitnesse-example-sinatra.git . &> /dev/null')
+  if $? == 0
+    puts "  Cloned demo repo to #{@repo_dir}."
+  else
+    abort "  Failed to clone demo repo to #{@repo_dir}."
+  end
+
+  system('bundle install --path vendor/bundle &> /dev/null')
+  if $? == 0
+    puts "  Installed gems for demo wiki."
+  else
+    abort "  Failed to install gems for demo wiki."
+  end
+end
+
+Dir.chdir(@repo_dir_no_features) do
+  FileUtils.cp_r("#{@repo_dir}/.", @repo_dir_no_features)
+  Dir.glob("#{@repo_dir_no_features}/**/*.feature") do |file|
+    File.unlink(file)
+  end
+  puts "  Created demo repo without features."
+end
+
+puts "  Finished setting up Gitnesse for testing. Running features.", ""
+
+at_exit do
+  FileUtils.rm_rf(@features_dir)
+  FileUtils.rm_rf(@repo_dir)
+  FileUtils.rm_rf(@features_dir_no_features)
+  FileUtils.rm_rf(@repo_dir_no_features)
+end

data/features/sync_wiki_features_to_code.feature

@@ -0,0 +1,29 @@
+Feature: 
+  In order to build software that provides the best fitting solution to a user problem
+  As a developer
+  I want to be able to test feature stories in my code
+  And also store the feature stories in a wiki so users can easily view or edit them
+
+  Scenario: Features already exist in wiki but not in code
+    Given there is a code repo without any cucumber features defined
+    And there is a git wiki with cucumber features defined
+    When developer pulls feature stories from the wiki
+    Then the feature stories within the code should match the wiki
+
+  Scenario: Features already exist in code but not in wiki
+    Given there is a code repo with cucumber features defined
+    And there is a git wiki without any cucumber features defined
+    When developer pushes feature stories to the wiki
+    Then the feature stories within the code should match the wiki
+
+  Scenario: Features pushes features from code to existing wiki
+    Given there is a code repo with cucumber features defined
+    And there is a git wiki with cucumber features defined
+    When developer pushes feature stories to the wiki
+    Then the feature stories within the code should match the wiki
+
+  Scenario: Features pulls features from wiki to existing code
+    Given there is a code repo with cucumber features defined
+    And there is a git wiki with cucumber features defined
+    When developer pulls feature stories from the wiki
+    Then the feature stories within the code should match the wiki

data/lib/gitnesse.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 require 'gollum'
 require 'fileutils'
+require 'pathname'
 require 'tmpdir'
 require 'gitnesse/configuration'
 require 'gitnesse/git_config'
@@ -31,7 +32,7 @@ module Gitnesse
   def run
     if pull
       Hooks.create
-      puts "Now going to run cucumber..."
+      puts "\n  Now going to run Cucumber."
       exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
     end
   end
@@ -39,7 +40,7 @@ module Gitnesse
   def push_results
     if push
       Hooks.create
-      puts "Now going to run cucumber..."
+      puts "\n  Now going to run Cucumber."
       exec("cucumber #{Gitnesse.configuration.target_directory}/*.feature")
     end
   end
@@ -48,7 +49,9 @@ module Gitnesse
   def pull
     Dependencies.check
 
-    puts "Pulling features into #{Gitnesse.configuration.target_directory} from #{Gitnesse.configuration.repository_url}..."
+    relative_path = Pathname.new(Gitnesse.configuration.target_directory).relative_path_from(Pathname.new(Dir.pwd))
+
+    puts "  Pulling features into ./#{relative_path} from #{Gitnesse.configuration.repository_url}."
     Dir.mktmpdir do |tmp_dir|
       if clone_feature_repo(tmp_dir)
         FileUtils.mkdir(Gitnesse.configuration.target_directory) unless File.exists?(Gitnesse.configuration.target_directory)
@@ -62,7 +65,7 @@ module Gitnesse
         end
       end
     end
-    puts "  Done pulling features."
+    puts "  \e[32mDone pulling features.\e[0m"
     true
   end
 
@@ -71,7 +74,9 @@ module Gitnesse
     Dependencies.check
     generate_commit_info
 
-    puts "Pushing features from #{Gitnesse.configuration.target_directory} to #{Gitnesse.configuration.repository_url}..."
+    relative_path = Pathname.new(Gitnesse.configuration.target_directory).relative_path_from(Pathname.new(Dir.pwd))
+
+    puts "  Pushing features from ./#{relative_path} to #{Gitnesse.configuration.repository_url}."
     Dir.mktmpdir do |tmp_dir|
       if clone_feature_repo(tmp_dir)
         feature_files = Dir.glob("#{Gitnesse.configuration.target_directory}/*.feature")
@@ -79,17 +84,16 @@ module Gitnesse
 
         # push the changes to the remote git
         Dir.chdir(tmp_dir) do
-          puts `git push origin master`
+          `git push origin master &> /dev/null`
         end
       end
     end
-    puts "  Done pushing features."
+    puts "  \e[32mDone pushing features.\e[0m"
     true
   end
 
   def clone_feature_repo(dir)
-    output = `git clone #{Gitnesse.configuration.repository_url} #{dir} 2>&1`
-    puts output
+    output = `git clone #{Gitnesse.configuration.repository_url} #{dir} &> /dev/null`
     $?.success?
   end
 

data/lib/gitnesse/dependencies.rb

@@ -11,16 +11,17 @@ module Gitnesse
       check_git
       check_cucumber
       check_repository_url
+      check_annotation_info
     end
 
     protected
 
     def self.check_git
-      raise NoGitError, "git not found or not working." unless Kernel.system("git --version")
+      raise NoGitError, "git not found or not working." unless Kernel.system("git --version &> /dev/null")
     end
 
     def self.check_cucumber
-      raise NoCucumberError, "cucumber not found or not working." unless Kernel.system("cucumber --version")
+      raise NoCucumberError, "cucumber not found or not working." unless Kernel.system("cucumber --version &> /dev/null")
     end
 
     def self.check_repository_url

data/lib/gitnesse/features.rb

@@ -25,11 +25,11 @@ module Gitnesse
       features = ''
 
       name, content = page_features.shift
-      puts "  # Pulling Feature: #{name}"
+      puts "  \e[32m\e[1mPulling Feature: \e[0m#{name}"
       features += content
 
       page_features.each do |name, feature|
-        puts "  # WARNING! Discarding Feature: #{name}"
+        puts "  \e[33m\e[1mDiscarding Feature: \e[0m#{name}"
       end
 
       features

data/lib/gitnesse/hooks.rb

@@ -9,7 +9,7 @@ module Gitnesse
       Gitnesse::Configuration.load_using_search
       FileUtils.rm_rf(@dir) if File.directory?(@dir)
       Dir.mkdir(@dir)
-      `git clone #{Gitnesse.configuration.repository_url} #{@dir}`
+      `git clone #{Gitnesse.configuration.repository_url} #{@dir} &> /dev/null`
       Wiki.new(@dir).remove_past_results
     end
 
@@ -17,12 +17,14 @@ module Gitnesse
     #
     # Returns nothing
     def self.teardown
+      puts "  Pushing Cucumber results to wiki."
       Dir.chdir(@dir) do
-        `git push origin master`
+        `git push origin master &> /dev/null`
       end
 
       FileUtils.rm_rf(@dir)
       FileUtils.rm(File.absolute_path("#{Gitnesse.configuration.target_directory}/support/gitnesse_hooks.rb"))
+      puts "  Done."
     end
 
     # Public: Adds hooks into Cucumber

data/lib/gitnesse/tasks.rake

@@ -21,7 +21,7 @@ namespace :gitnesse do
   end
 
   desc "Push features to remote git wiki repository, run cucumber, and push results to wiki"
-  task :push => :environment do
+  task :push_results => :environment do
     Gitnesse::Configuration.load_using_search
     Gitnesse.push_results
   end

data/lib/gitnesse/version.rb

@@ -1,3 +1,3 @@
 module Gitnesse
-  VERSION = "0.12.5"
+  VERSION = "0.12.6"
 end

data/lib/gitnesse/wiki.rb

@@ -108,7 +108,7 @@ module Gitnesse
     def strip_results(content)
       if content.match(/\u0060{3}gherkin.*\u0060{3}(.*)/m)[1]
         [ "FAILED", "PASSED", "PENDING", "UNDEFINED" ].each do |type|
-          content.gsub!(/\n*\`Last result was #{type}: .*\n*/, '')
+          content.gsub!(/\n*\!\[\]\(.*\) \`Last result was #{type}: .*\n*/, '')
         end
       end
       content
@@ -118,20 +118,29 @@ module Gitnesse
     #
     # scenario - Cucumber scenario from After hook
     #
-    # Returns nothing
+    # Returns a string containing the scenario result
     def append_results(scenario)
-      pages = @wiki.pages
       filename = File.basename(scenario.feature.file, ".feature")
       @commit_info[:message] = Gitnesse.configuration.info
 
-      pages.each do |page|
+      self.pages.each do |page|
         if page.name == filename || page.name == "#{filename}.feature"
           if page.text_data.include? scenario.name
             content = page.raw_data
-            string = "\n\`Last result was #{scenario.status.to_s.upcase}: #{scenario.name} (#{Time.now.to_s} - #{Gitnesse.configuration.info})\`\n"
+
+            case scenario.status
+            when :undefined then image = "![](https://s3.amazonaws.com/gitnesse/github/undefined.png)"
+            when :passed   then image = "![](https://s3.amazonaws.com/gitnesse/github/passing.png)"
+            when :failed   then image = "![](https://s3.amazonaws.com/gitnesse/github/failing.png)"
+            when :pending   then image = "![](https://s3.amazonaws.com/gitnesse/github/pending.png)"
+            else image = "![](https://s3.amazonaws.com/gitnesse/github/undefined.png)"
+            end
+
+            string = "\n#{image} \`Last result was #{scenario.status.to_s.upcase}: #{scenario.name} (#{Time.now.to_s} - #{Gitnesse.configuration.info})\`\n"
             content.gsub(string, '')
             content << string
             @wiki.update_page(page, page.name, :markdown, content, @commit_info)
+            return string
           end
         end
       end
@@ -148,7 +157,7 @@ module Gitnesse
     def create_wiki_page(name, content)
       new_page_content = build_page_content(content)
       @wiki.write_page(name, :markdown, new_page_content, @commit_info)
-      puts "  # Created Page: #{name}"
+      puts "  \e[32mCreated page \e[0m#{name}."
     end
 
     # Private: Updates a wiki page with the provided name and content
@@ -163,10 +172,10 @@ module Gitnesse
       new_page_content  = build_page_content(feature_content, wiki_page_content)
 
       if new_page_content == wiki_page_content
-        puts "  # Page #{page_name} didn't change"
+        puts "  \e[32mPage \e[0m#{page_name} \e[32mdidn't change\e[0m."
       else
         @wiki.update_page(wiki_page, page_name, :markdown, new_page_content, @commit_info)
-        puts "  # Updated Page: #{page_name}"
+        puts "  \e[33mUpdated page \e[0m#{page_name}."
       end
     end
   end

data/test/lib/gitnesse/configuration_defaults_test.rb

@@ -0,0 +1,11 @@
+require_relative '../../test_helper'
+
+describe Gitnesse::Configuration do
+  describe "defaults" do
+    subject { Gitnesse::Configuration.new }
+    it { subject.branch.must_equal "master" }
+    it { subject.annotate_results.must_equal false }
+    it { subject.info.must_be_nil }
+    it { subject.target_directory.must_equal File.join(Dir.pwd, "features") }
+  end
+end

data/test/lib/gitnesse/dependencies_check_test.rb

@@ -1,6 +1,19 @@
 require_relative '../../test_helper'
 
 describe Gitnesse::Dependencies do
+  describe "#check" do
+    before do
+      Gitnesse::Dependencies.expects(:check_git)
+      Gitnesse::Dependencies.expects(:check_cucumber)
+      Gitnesse::Dependencies.expects(:check_repository_url)
+      Gitnesse::Dependencies.expects(:check_annotation_info)
+    end
+
+    it "calls the other check functions" do
+      Gitnesse::Dependencies.check
+    end
+  end
+
   describe "#check_repository_url" do
     let(:method) { lambda { Gitnesse::Dependencies.check_repository_url } }
 
@@ -19,12 +32,12 @@ describe Gitnesse::Dependencies do
     let(:method) { lambda { Gitnesse::Dependencies.check_git } }
 
     describe "when git is not installed" do
-      before { Kernel.expects(:system).with("git --version").returns(false) }
+      before { Kernel.expects(:system).with("git --version &> /dev/null").returns(false) }
       it { method.must_raise(Gitnesse::Dependencies::NoGitError) }
     end
 
     describe "when git is installed" do
-      before { Kernel.expects(:system).with("git --version").returns(true) }
+      before { Kernel.expects(:system).with("git --version &> /dev/null").returns(true) }
       it { method.call.must_be_nil }
     end
   end
@@ -33,12 +46,12 @@ describe Gitnesse::Dependencies do
     let(:method) { lambda { Gitnesse::Dependencies.check_cucumber } }
 
     describe "when cucumber is not installed" do
-      before { Kernel.expects(:system).with("cucumber --version").returns(false) }
+      before { Kernel.expects(:system).with("cucumber --version &> /dev/null").returns(false) }
       it { method.must_raise(Gitnesse::Dependencies::NoCucumberError) }
     end
 
     describe "when cucumber is installed" do
-      before { Kernel.expects(:system).with("cucumber --version").returns(true) }
+      before { Kernel.expects(:system).with("cucumber --version &> /dev/null").returns(true) }
       it { method.call.must_be_nil }
     end
   end

data/test/lib/gitnesse/strip_results_test.rb

@@ -16,13 +16,13 @@ Feature: Division
     When I divide
     Then the result should be 3
 ```
-`Last result was UNDEFINED: Divide two numbers`
+![](http://path-to-image) `Last result was UNDEFINED: Divide two numbers`
 
-`Last result was PENDING: Divide two numbers`
+![](http://path-to-image) `Last result was PENDING: Divide two numbers`
 
-`Last result was FAILED: Divide two numbers`
+![](http://path-to-image) `Last result was FAILED: Divide two numbers`
 
-`Last result was PASSED: Divide two numbers`
+![](http://path-to-image) `Last result was PASSED: Divide two numbers`
 EOS
     end
 

data/test/lib/gitnesse/wiki_append_results_test.rb

@@ -0,0 +1,50 @@
+require_relative '../../test_helper'
+
+describe Gitnesse::Wiki do
+  describe "#append_results" do
+    let(:dir) { Dir.mktmpdir }
+    let(:wiki) { mock }
+    let(:feature_file) do
+      <<-EOS
+```gherkin
+Feature: Addition
+  In order to avoid silly mistakes
+  I want to be told the sum of two numbers
+
+  Scenario: Add two single digit numbers
+    Given I have entered 7 into the calculator
+    And I have entered 5 into the calculator
+    When I add
+    Then the result should be 12 on the screen
+```
+      EOS
+    end
+    let(:pages) do
+      [
+        stub(
+          :name      => "addition",
+          :text_data => feature_file,
+          :raw_data  => feature_file
+        )
+      ]
+    end
+    let(:cucumber_scenario) do
+      stub(
+        :name => "Add two single digit numbers",
+        :status => :passed,
+        :feature => stub(:file => "addition.feature")
+      )
+    end
+
+    let(:method) { lambda { Gitnesse::Wiki.new(dir).append_results(cucumber_scenario) } }
+
+    before do
+      Gollum::Wiki.expects(:new).returns(wiki)
+      wiki.expects(:pages).returns(pages)
+      wiki.expects(:update_page).returns(true)
+      File.expects(:basename).returns("addition")
+    end
+
+    it { puts method.call.must_include "Last result was PASSED: Add two single digit numbers" }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitnesse
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.12.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2012-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,10 @@ files:
 - README.md
 - Rakefile
 - bin/gitnesse
+- config/gitnesse.rb.example
+- features/step_definitions/gitnesse_steps.rb
+- features/support/env.rb
+- features/sync_wiki_features_to_code.feature
 - gitnesse.gemspec
 - lib/gitnesse.rb
 - lib/gitnesse/configuration.rb
@@ -136,6 +140,7 @@ files:
 - lib/gitnesse/wiki.rb
 - test/lib/gitnesse/build_page_content_test.rb
 - test/lib/gitnesse/commit_info_test.rb
+- test/lib/gitnesse/configuration_defaults_test.rb
 - test/lib/gitnesse/configuration_to_hash_test.rb
 - test/lib/gitnesse/custom_branch_test.rb
 - test/lib/gitnesse/dependencies_check_test.rb
@@ -145,6 +150,7 @@ files:
 - test/lib/gitnesse/read_git_config_test.rb
 - test/lib/gitnesse/strip_results_test.rb
 - test/lib/gitnesse/version_test.rb
+- test/lib/gitnesse/wiki_append_results_test.rb
 - test/lib/gitnesse/write_file_test.rb
 - test/test_helper.rb
 - test/wiki_test_helper.rb
@@ -162,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3810986427098166554
+      hash: 3165279517982023743
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -171,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3810986427098166554
+      hash: 3165279517982023743
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -179,8 +185,12 @@ signing_key:
 specification_version: 3
 summary: Features on git-based Wiki!
 test_files:
+- features/step_definitions/gitnesse_steps.rb
+- features/support/env.rb
+- features/sync_wiki_features_to_code.feature
 - test/lib/gitnesse/build_page_content_test.rb
 - test/lib/gitnesse/commit_info_test.rb
+- test/lib/gitnesse/configuration_defaults_test.rb
 - test/lib/gitnesse/configuration_to_hash_test.rb
 - test/lib/gitnesse/custom_branch_test.rb
 - test/lib/gitnesse/dependencies_check_test.rb
@@ -190,6 +200,7 @@ test_files:
 - test/lib/gitnesse/read_git_config_test.rb
 - test/lib/gitnesse/strip_results_test.rb
 - test/lib/gitnesse/version_test.rb
+- test/lib/gitnesse/wiki_append_results_test.rb
 - test/lib/gitnesse/write_file_test.rb
 - test/test_helper.rb
 - test/wiki_test_helper.rb