scrumninja-git-cli 0.0.2

data/test/test_git_wrapper.rb

@@ -0,0 +1,375 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require "git_wrapper"
+
+class GitWrapperUnitTest < Test::Unit::TestCase
+
+  def branch(name)
+    stub('Grit::Head', :name => name)
+  end
+  def remote(name)
+    stub('Grit::Remote', :name => name)
+  end
+
+  def setup
+    # Holler if we ever inadvertently try to run a git command
+    GitWrapper.expects(:run_git).never
+  end
+
+  def expect_git_command(command, interactive=false)
+    if interactive
+      GitWrapper.expects(:run_git).with(command, true)
+    else
+      GitWrapper.expects(:run_git).with(command)
+    end
+  end
+
+  context "#locate_git_repo_root" do
+    context "ENV['PWD'] is the root of a git repo" do
+      should 'return ENV["PWD"]' do
+        pwd = '/some/path/somedir'
+        dir = stub(:entries => %w(. .. .git foo))
+        Dir.expects(:new).with(pwd).returns(dir)
+        ENV.expects(:[]).with('PWD').returns(pwd)
+        assert_equal pwd, GitWrapper.locate_git_repo_root
+      end
+    end
+
+    context "ENV['PWD'] is a (grand)child directory of a git repo" do
+      should 'return first parent of ENV["PWD"] that contains a .git directory' do
+        repo_path = '/some/path/repo'
+        pwd = "#{repo_path}/child/grandchild"
+        ENV.expects(:[]).with('PWD').returns(pwd)
+        normal_dir = stub(:entries => %w(. .. foo))
+        repo_dir = stub(:entries => %w(. .. .git foo))
+        Dir.stubs(:new => normal_dir)
+        Dir.expects(:new).with(repo_path).returns(repo_dir)
+        assert_equal repo_path, GitWrapper.locate_git_repo_root
+      end
+    end
+
+    context "ENV['PWD'] is not part of a git repo" do
+      should 'return nil' do
+        pwd = "/some/dir/child/grandchild"
+        ENV.expects(:[]).with('PWD').returns(pwd)
+        dir = stub(:entries => %w(. .. foo))
+        Dir.stubs(:new => dir)
+        assert_nil GitWrapper.locate_git_repo_root
+      end
+    end
+  end
+
+  context "git_version" do
+    should 'use run_git to get the version and return the correct version and memoize the answer' do
+      GitWrapper.expects(:run_git).with('--version').returns('git version 1.7.0.2')
+      assert_equal [1,7,0,2], GitWrapper.git_version
+      assert_equal [1,7,0,2], GitWrapper.git_version
+    end
+  end
+
+  context "is_git_current_enough?" do
+    should "be false if version is < 1.7" do
+      GitWrapper.stubs(:git_version).returns([1,6,9])
+      deny GitWrapper.is_git_current_enough?
+    end
+
+    should "be true if version is = 1.7" do
+      GitWrapper.stubs(:git_version).returns([1,7])
+      assert GitWrapper.is_git_current_enough?
+    end
+
+    should "be true if version is = 1.7 with extra version info" do
+      GitWrapper.stubs(:git_version).returns([1,7,0])
+      assert GitWrapper.is_git_current_enough?
+    end
+
+    should "be true if version is > 1.7" do
+      GitWrapper.stubs(:git_version).returns([1,7,1])
+      assert GitWrapper.is_git_current_enough?
+    end
+
+  end
+
+
+  should "return current_branch_name" do
+    current_branch = stub('Grit::Head', :name => 'this-branch-right-here-yall')
+    GitWrapper.git.expects(:head).returns(current_branch)
+    assert_equal('this-branch-right-here-yall', GitWrapper.current_branch_name)
+  end
+
+  context "branches" do
+    should "return a list of local branches when called with no arguments" do
+      locals = [branch('master'), branch('hackery')]
+      GitWrapper.git.expects(:branches).returns(locals)
+      assert_equal(locals, GitWrapper.branches)
+    end
+
+    should "return a list of remote branches when called with a remote name as the first argument" do
+      remotes = [
+        remote('origin/master'),
+        remote('origin/some-topical-branch'),
+        remote('github/foo')
+      ]
+      remotes_on_origin = remotes[0,2]
+      GitWrapper.git.expects(:remotes).returns(remotes)
+      assert_equal(remotes_on_origin, GitWrapper.branches('origin'))
+    end
+  end
+
+  should "track_remote_branch" do
+    expect_git_command 'branch --set-upstream my-story origin/my-story'
+    GitWrapper.track_remote_branch('my-story')
+  end
+
+  should "publish_remote_branch" do
+    expect_git_command 'push origin my-story:refs/heads/my-story'
+    GitWrapper.publish_remote_branch('my-story')
+  end
+
+  context "fetch" do
+    should "grab a specified remote" do
+      expect_git_command 'fetch my_crazy_remote'
+      GitWrapper.fetch('my_crazy_remote')
+    end
+    should "grab 'origin' with no parameters" do
+      expect_git_command 'fetch origin'
+      GitWrapper.fetch
+    end
+  end
+
+  context "checkout" do
+    should 'fetch' do
+      expect_git_command 'fetch origin'
+      expect_git_command 'branch my-story'
+      expect_git_command 'push origin my-story:refs/heads/my-story'
+      expect_git_command 'branch --set-upstream my-story origin/my-story'
+      expect_git_command 'checkout my-story'
+
+      GitWrapper.checkout('my-story')
+    end
+
+    should "take an optional 'remote' parameter" do
+      expect_git_command 'fetch nonstandard_remote'
+      expect_git_command 'branch my-story'
+      expect_git_command 'push nonstandard_remote my-story:refs/heads/my-story'
+      expect_git_command 'branch --set-upstream my-story nonstandard_remote/my-story'
+      expect_git_command 'checkout my-story'
+
+      GitWrapper.checkout('my-story', 'nonstandard_remote')
+    end
+
+    context "when remote branch 'my-story' does not exist" do
+      setup do
+        @branches, @remotes = [branch('master')], []
+        GitWrapper.git.stubs(:branches).returns(@branches)
+        GitWrapper.git.stubs(:remotes).returns(@remotes)
+      end
+
+      should "create local 'my-story' branch, check it out, publish it, and track it" do
+        expect_git_command 'fetch origin'
+        expect_git_command 'branch local-story-branch'
+        expect_git_command 'push origin local-story-branch:refs/heads/local-story-branch'
+        expect_git_command 'branch --set-upstream local-story-branch origin/local-story-branch'
+        expect_git_command 'checkout local-story-branch'
+
+        GitWrapper.checkout('local-story-branch')
+      end
+
+      context "and local branch 'my-story' exists" do
+        setup do
+          @branches << branch('my-story')
+        end
+        should "check out the remote branch and track it" do
+          expect_git_command 'fetch origin'
+          expect_git_command 'push origin my-story:refs/heads/my-story'
+          expect_git_command 'branch --set-upstream my-story origin/my-story'
+          expect_git_command 'checkout my-story'
+
+          GitWrapper.checkout('my-story')
+        end
+      end
+    end
+
+    context "when remote branch 'my-story' exists" do
+      setup do
+        @branches, @remotes = [branch('master')], [remote('origin/my-story')]
+        GitWrapper.git.stubs(:branches).returns(@branches)
+        GitWrapper.git.stubs(:remotes).returns(@remotes)
+      end
+
+      should "create local 'my-story' branch, make it track the remote branch, and check it out" do
+        expect_git_command 'fetch origin'
+        expect_git_command 'branch my-story'
+        expect_git_command 'branch --set-upstream my-story origin/my-story'
+        expect_git_command 'checkout my-story'
+
+        GitWrapper.checkout('my-story')
+      end
+
+      context "when local branch 'my-story' exists" do
+        setup do
+          @branches << branch('my-story')
+        end
+        should "make it track the remote branch, and check it out" do
+          expect_git_command 'fetch origin'
+          expect_git_command 'branch --set-upstream my-story origin/my-story'
+          expect_git_command 'checkout my-story'
+
+          GitWrapper.checkout('my-story')
+        end
+      end
+    end
+  end
+
+  context "#is_state_clean?" do
+    should "be true when it is" do
+      expect_git_command('status').returns <<-EOF
+# On branch master
+nothing to commit (working directory clean)
+      EOF
+      assert GitWrapper.is_state_clean?
+    end
+
+    context "unclean" do
+      should 'be false when there are unstaged changes' do
+        expect_git_command('status').returns <<-EOF
+# On branch master
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#	newfile
+nothing added to commit but untracked files present (use "git add" to track)
+        EOF
+        deny GitWrapper.is_state_clean?
+      end
+      should 'be false when there are staged changes' do
+        expect_git_command('status').returns <<-EOF
+# On branch master
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+#	new file:   newfile
+#
+        EOF
+        deny GitWrapper.is_state_clean?
+      end
+
+      should 'be false when tehre are both staged and unstaged changes' do
+        expect_git_command('status').returns <<-EOF
+# On branch master
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+#	new file:   somethingelse
+#
+# Changed but not updated:
+#   (use "git add <file>..." to update what will be committed)
+#   (use "git checkout -- <file>..." to discard changes in working directory)
+#
+#	modified:   newfile
+#
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#	something
+        EOF
+        deny GitWrapper.is_state_clean?
+      end
+    end
+  end
+
+  context "require_clean_story_branch" do
+    should "complain if working state is not clean" do
+      GitWrapper.expects(:is_state_clean?).returns(false)
+      GitWrapper.stubs(:current_branch_name).returns('master')
+      assert_raise(GitWrapper::WorkingFolderDirtyException) { GitWrapper.require_clean_story_branch }
+    end
+
+    should "complain if already on master" do
+      GitWrapper.stubs(:is_state_clean?).returns(true)
+      GitWrapper.expects(:current_branch_name).returns('master')
+      assert_raise(GitWrapper::WrongBranchException) { GitWrapper.require_clean_story_branch }
+    end
+  end
+
+  context "merge_from_master" do
+    should 'do a checkout of master, a pull, a checkout of the local branch, and a merge' do
+      GitWrapper.expects(:require_clean_story_branch)
+      GitWrapper.stubs(:current_branch_name).returns('99-bottles')
+      expect_git_command 'checkout master'
+      expect_git_command 'pull'
+      expect_git_command 'checkout 99-bottles'
+      expect_git_command 'merge master'
+      GitWrapper.merge_from_master
+    end
+  end
+
+  context "push_branch" do
+    should "do a pull/rebase, then a push" do
+      GitWrapper.expects(:require_clean_story_branch)
+      GitWrapper.stubs(:current_branch_name).returns('321-contact')
+      expect_git_command 'pull --rebase'
+      expect_git_command 'push origin 321-contact'
+      GitWrapper.push_branch
+    end
+  end
+
+  context 'merge_branch_into_master' do
+    should "do a checkout of master, a pull, and merge the story branch in" do
+      GitWrapper.expects(:require_clean_story_branch)
+      GitWrapper.stubs(:current_branch_name).returns('99-bottles')
+      expect_git_command 'checkout master'
+      expect_git_command 'pull'
+      expect_git_command 'merge 99-bottles'
+      GitWrapper.merge_branch_into_master
+    end
+
+    should 'accept a branch name, if called while on master' do
+      GitWrapper.expects(:require_clean_master_branch)
+      expect_git_command 'pull'
+      expect_git_command 'merge 99-bottles'
+      GitWrapper.merge_branch_into_master('99-bottles')
+    end
+
+    # To consider:
+    # should 'prefix the commit message with "Story #{nnn}: #{story name}"'
+  end
+
+  context 'require_clean_master_branch' do
+    context "require_clean_story_branch" do
+      should "complain if working state is not clean" do
+        GitWrapper.expects(:is_state_clean?).returns(false)
+        GitWrapper.stubs(:current_branch_name).returns('master')
+        assert_raise(GitWrapper::WorkingFolderDirtyException) { GitWrapper.require_clean_master_branch }
+      end
+
+      should "complain if not on master" do
+        GitWrapper.stubs(:is_state_clean?).returns(true)
+        GitWrapper.expects(:current_branch_name).returns('not_master')
+        assert_raise(GitWrapper::WrongBranchException) { GitWrapper.require_clean_master_branch }
+      end
+    end
+  end
+
+  context 'push_master' do
+    should "do a pull/rebase, then a push" do
+      GitWrapper.expects(:require_clean_master_branch)
+      expect_git_command 'pull --rebase'
+      expect_git_command 'push origin master'
+      GitWrapper.push_master
+    end
+  end
+
+  context "#add" do
+    should "add the specified paths to the index" do
+      expect_git_command 'add -A foo bar'
+      GitWrapper.add('-A foo bar')
+    end
+  end
+
+  context "#commit" do
+    should "commit changes with story number prepended to commit message" do
+      expect_git_command 'commit -m "Story 12345: " -e', true
+      GitWrapper.commit("Story 12345: ")
+    end
+  end
+end

data/test/test_scrum_ninja_git_cli.rb

@@ -0,0 +1,224 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require 'scrum_ninja_git_cli'
+
+class TestScrumNinjaGitCli < Test::Unit::TestCase
+  def story(project_id, name)
+    ScrumNinja::Story.new("Story", project_id, name)
+  end
+
+  def setup
+    @git = mock('git')
+    @git.stubs(:is_git_current_enough?).returns(true)
+    ScrumNinjaGitCli.stubs(:git_wrapper).returns(@git)
+    @session = mock('session')
+    ScrumNinjaGitCli.stubs(:session).returns(@session)
+    GitWrapper.expects(:run_command).never
+  end
+
+  def expect_output(message_name)
+    message = ScrumNinjaGitCli::Messages[message_name]
+    ScrumNinjaGitCli.expects(:output).with(message).returns(true)
+  end
+
+  context "help" do
+    should "output ScrumNinjaGitCli::HelpText" do
+      ScrumNinjaGitCli.expects(:output).with(ScrumNinjaGitCli::HelpText)
+      ScrumNinjaGitCli.help
+    end
+
+    should 'be displayed when the utility is run with no args' do
+      ScrumNinjaGitCli.expects(:help)
+      ScrumNinjaGitCli.run_command
+    end
+
+    should 'be run when a run_command gets an ArgumentError' do
+      ScrumNinjaGitCli.expects(:help)
+      ScrumNinjaGitCli.run_command(:start)
+    end
+  end
+
+  context "info" do
+    should "make an API call and return a single Story object" do
+      the_story = story(99, "mmm... something...")
+      @session.expects(:get_story).with(99).returns(the_story)
+      ScrumNinjaGitCli.expects(:output).with(the_story)
+      ScrumNinjaGitCli.run_command(:info, 99)
+    end
+  end
+
+  context "xml" do
+    should "make an API call and return the raw XML" do
+      xml = "<xml>bogus XML</xml>"
+      @session.expects(:get_story_xml).with(99).returns(xml)
+      ScrumNinjaGitCli.expects(:output).with(xml)
+      ScrumNinjaGitCli.run_command(:xml, 99)
+    end
+  end
+
+  context 'list' do
+    should 'display a list of stories from ScrumNinja' do
+      stories = [story(999, "Do stuff"), story(42, "do something else")]
+      @session.expects(:get_stories).returns(stories)
+      ScrumNinjaGitCli.expects(:output).with(stories.map(&:to_s).join("\n"))
+      ScrumNinjaGitCli.run_command(:list)
+    end
+  end
+
+  context "own" do
+    should "update the owner of the given story" do
+      @session.expects(:update_ownership).with(42, nil, {})
+      ScrumNinjaGitCli.run_command(:own, 42)
+    end
+  end
+
+  context "start" do
+    should "join and own (nicely)" do
+      ScrumNinjaGitCli.expects(:join).with(42)
+      ScrumNinjaGitCli.expects(:own).with(42, nil, :abort_if_already_owned => true)
+      ScrumNinjaGitCli.run_command(:start, 42)
+    end
+  end
+
+  context "dev-task" do
+    should 'start work on a branch named "dev-hyphenated-story-name"' do
+      ScrumNinjaGitCli.expects(:start_work_on_branch).with('dev-hyphenated-story-name')
+      ScrumNinjaGitCli.run_command(:dev_task, 'hyphenated STORY _nAmE')
+    end
+  end
+
+
+  context "rake" do
+    should "run rake" do
+      ShellCmd.expects(:run).with('rake').returns(0)
+      assert ScrumNinjaGitCli.rake
+    end
+
+    should 'print a message and return false in the event of a rake failure' do
+      ShellCmd.expects(:run).with('rake').returns(256)
+      expect_output :rake_failure
+      deny ScrumNinjaGitCli.rake
+    end
+  end
+
+  context "#commit" do
+    should "commit pending changes and add story number to commit message" do
+      @git.stubs(:current_branch_name).returns('12345-some-story-name')
+      @git.expects(:commit).with("Story 12345: Some Story Name")
+      ScrumNinjaGitCli.run_command(:commit)
+    end
+  end
+
+  context "#add" do
+    should "add the specified paths to git" do
+      @git.expects(:add).with("foo bar baz")
+      ScrumNinjaGitCli.run_command(:add, 'foo bar baz')
+    end
+  end
+
+  context "deliver" do
+    actions = [
+      "push-branch",
+      "merge-from-master",
+      "rake",
+      "merge back into master",
+      "check out master and push it", # can't reuse GitWrapper#push_branch for this, though
+    ]
+    should actions.join('; ') do
+      @git.stubs(:current_branch_name).returns('not_master')
+      @git.expects(:push_branch)
+      @git.expects(:merge_from_master)
+      ScrumNinjaGitCli.expects(:rake).returns(true)
+      @git.expects(:merge_branch_into_master)
+      @git.expects(:push_master)
+      ScrumNinjaGitCli.run_command(:deliver)
+    end
+
+    should 'not squash nor push master if rake fails' do
+      @git.stubs(:current_branch_name).returns('not_master')
+      @git.expects(:push_branch)
+      @git.expects(:merge_from_master)
+      ScrumNinjaGitCli.expects(:rake).returns(false)
+      ScrumNinjaGitCli.run_command(:deliver)
+    end
+
+    should 'not run if the current branch is master' do
+      @git.expects(:current_branch_name).returns('master')
+      expect_output(:wrong_branch)
+      ScrumNinjaGitCli.run_command(:deliver)
+    end
+
+    should_eventually "complain if any of the commit messages to be merged in don't have a story number prefix" do
+      # yeah, this'll be easy to mock...
+      flunk
+    end
+  end
+
+  context "join" do
+    setup do
+      @story = story(99, "bottles of beer")
+      @session.stubs(:get_story).returns(@story)
+    end
+
+    should "inform the user that Git 1.7 or newer is required" do
+      @git.expects(:is_git_current_enough?).returns(false)
+      expect_output :git_version
+      ScrumNinjaGitCli.run_command(:join, 99)
+    end
+
+    should "call #own, git fetch, and git checkout" do
+      @git.expects(:checkout).with(@story.branch_name)
+      @git.stubs(:is_state_clean?).returns(true)
+      @git.stubs(:current_branch_name).returns('master')
+      ScrumNinjaGitCli.run_command(:join, 99)
+    end
+
+    should 'give a nice warning message and/or error if the working state is not clean' do
+      @session.expects(:get_story).never
+      @git.expects(:is_state_clean?).returns(false)
+      @git.stubs(:current_branch_name).returns('master')
+      expect_output :clean_working_state
+      ScrumNinjaGitCli.run_command(:join, 99)
+    end
+
+    should 'give a nice warning message and/or error if the current branch is not master' do
+      @session.expects(:get_story).never
+      @git.stubs(:is_state_clean?).returns(true)
+      @git.stubs(:current_branch_name).returns('not-at-all-master')
+      expect_output :must_be_on_master
+      ScrumNinjaGitCli.run_command(:join, 99)
+    end
+  end
+
+  context "push-branch" do
+    should "call GitWrapper#push_branch" do
+      @git.expects(:push_branch)
+      ScrumNinjaGitCli.run_command('push-branch')
+    end
+
+    should "handle raised exceptions" do
+      @git.expects(:push_branch).raises(GitWrapper::WorkingFolderDirtyException)
+      expect_output :clean_working_state
+      assert_nothing_raised(Exception) { ScrumNinjaGitCli.run_command('push-branch') }
+    end
+  end
+
+  context "merge-from-master" do
+    should "call GitWrapper#push_branch" do
+      @git.expects(:merge_from_master)
+      ScrumNinjaGitCli.run_command('merge-from-master')
+    end
+
+    should "handle raised exceptions" do
+      @git.expects(:merge_from_master).raises(GitWrapper::WrongBranchException)
+      expect_output :wrong_branch
+      assert_nothing_raised(Exception) { ScrumNinjaGitCli.run_command('merge-from-master') }
+    end
+  end
+
+  context "#git" do
+    should "run git command with passed-through arguments" do
+      ScrumNinjaGitCli.expects(:exec).with("export I_AM_A_GIT_GURU=1; git arg1 arg2 arg3").returns('some output')
+      ScrumNinjaGitCli.run_command('git', 'arg1', 'arg2', 'arg3')
+    end
+  end
+end