guard-phpunit2 0.2.1

data/spec/fixtures/results/failing.txt

@@ -0,0 +1,15 @@
+FF
+
+Failures:
+
+  1) NumberTest::testThatMyMathTeacherSucked
+     Failed asserting that 10 is identical to 1.
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:62
+
+
+  2) NumberTest::testThatMyMathTeacherSuckedEvenMore
+     Failed asserting that 'I don't know!' is identical to -1.
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:72
+
+Finished in 0 seconds
+2 tests, 2 assertions, 2 failures

data/spec/fixtures/results/mixed.txt

@@ -0,0 +1,26 @@
+......SSFFEIF
+
+Errors:
+
+  1) NumberTest::testMathStillWorks
+     NumberException: Division by zero!
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/Number.php:61
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:81
+
+Failures:
+
+  1) NumberTest::testThatMyMathTeacherSucked
+     Failed asserting that 10 is identical to 1.
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:62
+
+
+  2) NumberTest::testThatMyMathTeacherSuckedEvenMore
+     Failed asserting that 'I don't know!' is identical to -1.
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:72
+
+
+  3) Warning
+     No tests found in class "emptyTest".
+
+Finished in 2 seconds
+13 tests, 4 assertions, 3 failures, 1 errors, 1 incomplete, 2 skipped

data/spec/fixtures/results/passing.txt

@@ -0,0 +1,4 @@
+..
+
+Finished in 0 seconds
+2 tests, 2 assertions

data/spec/fixtures/results/skipped_and_incomplete.txt

@@ -0,0 +1,4 @@
+ISS
+
+Finished in 0 seconds
+3 tests, 0 assertions, 1 incomplete, 2 skipped

data/spec/fixtures/sampleTest.php

@@ -0,0 +1,13 @@
+<?php
+
+class sampleTest extends PHPUnit_Framework_TestCase {
+  
+  public function testTrueIsTrue() {
+    $this->assertTrue(true);
+  }
+
+  public function testTrueIsFalse() {
+    $this->assertTrue(false);
+  }
+
+}

data/spec/guard/phpunit2/formatter_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Guard::PHPUnit2::Formatter do
+  describe '.parse_output' do
+    context 'when all tests pass' do
+      it 'returns a hash containing the tests result' do
+        output = load_phpunit_output('passing')
+        subject.parse_output(output).should == {
+          :tests  => 2, :failures => 0,
+          :errors => 0, :pending  => 0,
+          :duration => 0
+        }
+      end
+    end
+
+    context 'when all tests fail' do
+      it 'returns a hash containing the tests result' do
+        output = load_phpunit_output('failing')
+        subject.parse_output(output).should == {
+          :tests  => 2, :failures => 2,
+          :errors => 0, :pending  => 0,
+          :duration => 0
+        }
+      end
+    end
+
+    context 'when tests are skipped or incomplete' do
+      it 'returns a hash containing the tests result' do
+        output = load_phpunit_output('skipped_and_incomplete')
+        subject.parse_output(output).should == {
+          :tests  => 3, :failures => 0,
+          :errors => 0, :pending  => 3,
+          :duration => 0
+        }
+      end
+    end
+
+    context 'when tests have mixed statuses' do
+      it 'returns a hash containing the tests result' do
+        output = load_phpunit_output('mixed')
+        subject.parse_output(output).should == {
+          :tests  => 13, :failures => 3,
+          :errors => 1, :pending  => 3,
+          :duration => 2
+        }
+      end
+    end
+  end
+end

data/spec/guard/phpunit2/inspector_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Guard::PHPUnit2::Inspector do
+  before do
+    subject.tests_path = 'spec/fixtures'
+  end
+
+  describe 'clean' do
+    it 'removes non-tests files' do
+      subject.clean(['spec/fixtures/sampleTest.php', 'foo.php']).should == ['spec/fixtures/sampleTest.php']
+    end
+
+    it 'removes test-looking but non-existing files' do
+      subject.clean(['spec/fixtures/sampleTest.php', 'fooTest.rb']).should == ['spec/fixtures/sampleTest.php']
+    end
+
+    it 'removes test-looking but non-existing files (2)' do
+      subject.clean(['spec/fixtures/fooTest.php']).should == []
+    end
+
+    it 'removes duplicate files' do
+      subject.clean(['spec/fixtures/sampleTest.php', 'spec/fixtures/sampleTest.php']).should == ['spec/fixtures/sampleTest.php']
+    end
+
+    it 'remove nil files' do
+      subject.clean(['spec/fixtures/sampleTest.php', nil]).should == ['spec/fixtures/sampleTest.php']
+    end
+
+    it 'frees up the list of tests files' do
+      subject.should_receive(:clear_tests_files_list)
+      subject.clean(['classTest.php'])
+    end
+  end
+end

data/spec/guard/phpunit2/notifier_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Guard::PHPUnit2::Notifier do
+
+  let(:guard_notifier) { Guard::Notifier }
+
+  describe '.notify' do
+    it 'calls the guard notifier' do
+      guard_notifier.should_receive(:notify).with('My awesome message!', :image => :success)
+      subject.notify('My awesome message!', :image => :success)
+    end
+  end
+
+  describe '.notify_results' do
+    context 'with no errors, failures or pending tests' do
+      it 'displays a notification' do
+        subject.should_receive(:notify).with(
+          "10 tests, 0 failures\nin 5 seconds",
+          :title => 'PHPUnit results',
+          :image => :success
+        )
+        subject.notify_results(
+          :tests  => 10, :failures => 0,
+          :errors => 0, :pending  => 0,
+          :duration => 5
+        )
+      end
+    end
+    context 'with errors or failures' do
+      it 'displays a notification' do
+        subject.should_receive(:notify).with(
+          "10 tests, 3 failures\n4 errors\nin 6 seconds",
+          :title => 'PHPUnit results',
+          :image => :failed
+        )
+        subject.notify_results(
+          :tests  => 10, :failures => 3,
+          :errors => 4, :pending  => 0,
+          :duration => 6
+        )
+      end
+    end
+
+    context 'with pending tests' do
+      it 'displays a notification' do
+        subject.should_receive(:notify).with(
+          "10 tests, 0 failures (2 pending)\nin 4 seconds",
+          :title => 'PHPUnit results',
+          :image => :pending
+        )
+        subject.notify_results(
+          :tests  => 10, :failures => 0,
+          :errors => 0, :pending  => 2,
+          :duration => 4
+        )
+      end
+
+      it 'displays a notification (2)' do
+        subject.should_receive(:notify).with(
+          "10 tests, 0 failures\n3 errors (2 pending)\nin 4 seconds",
+          :title => 'PHPUnit results',
+          :image => :failed
+        )
+        subject.notify_results(
+          :tests  => 10, :failures => 0,
+          :errors => 3, :pending  => 2,
+          :duration => 4
+        )
+      end
+    end
+  end
+end

data/spec/guard/phpunit2/runner_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe Guard::PHPUnit2::Runner do
+
+  let(:formatter) { Guard::PHPUnit2::Formatter }
+  let(:notifier)  { Guard::PHPUnit2::Notifier  }
+  let(:ui)        { Guard::UI                 }
+
+  describe '#run' do
+    before do
+      FileUtils.stub(:ln_s)
+      FileUtils.stub(:mkdir_p)
+
+      subject.stub(:execute_command)
+      subject.stub(:phpunit_exists?).and_return(true)
+      notifier.stub(:notify_results)
+
+      $?.stub(:success?).and_return(true)
+    end
+
+    context 'when passed an empty paths list' do
+      it 'returns false' do
+        subject.run([]).should be_false
+      end
+    end
+
+    shared_examples_for 'paths list not empty' do
+      it 'checks that phpunit is installed' do
+        subject.should_receive(:phpunit_exists?)
+        subject.run( ['tests'] )
+      end
+
+      it 'displays an error when phpunit is not installed' do
+        subject.stub(:phpunit_exists?).and_return(false)
+        ui.should_receive(:error).with('phpunit is not installed on your machine.', anything)
+
+        subject.run( ['tests'] )
+      end
+
+      it 'notifies about running the tests' do
+        subject.should_receive(:notify_start).with( ['tests'], anything )
+        subject.run( ['tests'] )
+      end
+
+      it 'runs phpunit tests' do
+        subject.should_receive(:execute_command).with(
+          %r{^phpunit .+$}
+        ).and_return(true)
+        subject.run( ['tests'] )
+      end
+
+      it 'prints the tests output to the console' do
+          output = load_phpunit_output('passing')
+          subject.stub(:notify_start)
+          subject.stub(:execute_command).and_return(output)
+
+          ui.should_receive(:info).with(output)
+
+          subject.run( ['tests'] )
+      end
+
+      context 'when PHPUnit executes the tests' do
+        it 'parses the tests output' do
+          output = load_phpunit_output('passing')
+          subject.stub(:execute_command).and_return(output)
+
+          formatter.should_receive(:parse_output).with(output)
+
+          subject.run( ['tests'] )
+        end
+
+        it 'notifies about the tests output' do
+          output = load_phpunit_output('passing')
+          subject.stub(:execute_command).and_return(output)
+          subject.should_receive(:notify_results).with(output, anything())
+
+          subject.run( ['tests'] )
+        end
+
+        it 'notifies about the tests output even when they contain failures' do
+          $?.stub(:success? => false, :exitstatus => 1)
+
+          output = load_phpunit_output('failing')
+          subject.stub(:execute_command).and_return(output)
+          subject.should_receive(:notify_results).with(output, anything())
+
+          subject.run( ['tests'] )
+        end
+
+        it 'notifies about the tests output even when they contain errors' do
+          $?.stub(:success? => false, :exitstatus => 2)
+
+          output = load_phpunit_output('errors')
+          subject.stub(:execute_command).and_return(output)
+          subject.should_receive(:notify_results).with(output, anything())
+
+          subject.run( ['tests'] )
+        end
+
+        it 'does not notify about failures' do
+          subject.should_receive(:execute_command)
+          subject.should_not_receive(:notify_failure)
+          subject.run( ['tests'] )
+        end
+      end
+
+      context 'when PHPUnit fails to execute' do
+        before do
+          $?.stub(:success? => false, :exitstatus => 255)
+          notifier.stub(:notify)
+        end
+
+        it 'notifies about the failure' do
+          subject.should_receive(:execute_command)
+          subject.should_receive(:notify_failure)
+          subject.run( ['tests'] )
+        end
+
+        it 'does not notify about the tests output' do
+          subject.should_not_receive(:notify_results)
+          subject.run( ['tests'] )
+        end
+      end
+
+      describe 'options' do
+        describe ':cli' do
+          it 'runs with CLI options passed to PHPUnit' do
+            cli_options = '--colors --verbose'
+            subject.should_receive(:execute_command).with(
+              %r{^phpunit #{cli_options} .+$}
+            ).and_return(true)
+            subject.run( ['tests'], :cli => cli_options )
+          end
+        end
+
+        describe ':notification' do
+          it 'does not notify about tests output with notification option set to false' do
+            formatter.should_not_receive(:notify)
+            subject.run( ['tests'], :notification => false )
+          end
+        end
+      end
+    end
+
+    context 'when passed one path' do
+      it_should_behave_like 'paths list not empty'
+
+      it 'should not create a test folder' do
+        Dir.should_not_receive(:mktmpdir)
+        subject.run( ['spec/fixtures/sampleTest.php'] )
+      end
+    end
+
+    context 'when passed multiple paths' do
+      it_should_behave_like 'paths list not empty'
+
+      it 'creates a tests folder (tmpdir)' do
+        subject.should_receive(:create_tests_folder_for).with(instance_of(Array))
+        subject.run( ['spec/fixtures/sampleTest.php', 'spec/fixtures/emptyTest.php'] )
+      end
+
+      it 'symlinks passed paths to the tests folder' do
+        subject.should_receive(:symlink_paths_to_tests_folder).with(anything(), anything())
+        subject.run( ['spec/fixtures/sampleTest.php', 'spec/fixtures/emptyTest.php'] )
+      end
+    end
+  end
+end

data/spec/guard/phpunit2_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe Guard::PHPUnit2 do
+
+  let(:runner)    { Guard::PHPUnit2::Runner }
+  let(:inspector) { Guard::PHPUnit2::Inspector }
+  let(:defaults)  { Guard::PHPUnit2::DEFAULT_OPTIONS }
+
+  describe '#initialize' do
+    context 'when no options are provided' do
+      it 'sets a default :all_on_start option' do
+        subject.options[:all_on_start].should be_true
+      end
+
+      it 'sets a default :all_after_pass option' do
+        subject.options[:all_after_pass].should be_true
+      end
+
+      it 'sets a default :keep_failed option' do
+        subject.options[:keep_failed].should be_true
+      end
+
+      it 'sets a default :tests_path option' do
+        subject.options[:tests_path].should == @project_path.to_s
+      end
+    end
+
+    context 'when other options are provided' do
+
+      subject { Guard::PHPUnit2.new(nil, { :all_on_start   => false,
+                                          :all_after_pass => false,
+                                          :keep_failed    => false,
+                                          :cli            => '--colors',
+                                          :tests_path     => 'tests'     }) }
+
+      it 'sets :all_on_start with the provided option' do
+        subject.options[:all_on_start].should be_false
+      end
+
+      it 'sets :all_after_pass with the provided option' do
+        subject.options[:all_after_pass].should be_false
+      end
+
+      it 'sets :keep_failed with the provided option' do
+        subject.options[:keep_failed].should be_false
+      end
+
+      it 'sets :cli with the provided option' do
+        subject.options[:cli].should == '--colors'
+      end
+
+      it 'sets :tests_path with the provided option' do
+        subject.options[:tests_path].should == 'tests'
+      end
+    end
+
+    it 'sets the tests path for the inspector' do
+      inspector.should_receive(:tests_path=).with(@project_path.to_s)
+      subject
+    end
+  end
+
+  # ----------------------------------------------------------
+
+  describe '#start' do
+    it 'calls #run_all' do
+      subject.should_receive(:run_all)
+      subject.start
+    end
+
+    context 'with the :all_on_start option set to false' do
+      subject { Guard::PHPUnit2.new(nil, :all_on_start => false) }
+
+      it 'calls #run_all' do
+        subject.should_not_receive(:run_all)
+        subject.start
+      end
+    end
+  end
+
+  describe '#run_all' do
+    it 'runs all tests in the tests path' do
+      runner.should_receive(:run).with(defaults[:tests_path], anything).and_return(true)
+      subject.run_all
+    end
+
+    it 'throws :task_has_failed when an error occurs' do
+      runner.should_receive(:run).with(defaults[:tests_path], anything).and_return(false)
+      expect { subject.run_all }.to throw_symbol :task_has_failed
+    end
+
+    it 'passes the options to the runner' do
+      runner.should_receive(:run).with(anything, hash_including(defaults)).and_return(true)
+      subject.run_all
+    end
+  end
+
+  describe '#run_on_changes' do
+    before do
+      inspector.stub(:clean).and_return { |paths| paths }
+    end
+
+    it 'cleans the changed paths before running the tests' do
+      runner.stub(:run).and_return(true)
+      inspector.should_receive(:clean).with(['tests/firstTest.php', 'tests/secondTest.php'])
+      subject.run_on_changes ['tests/firstTest.php', 'tests/secondTest.php']
+    end
+
+    it 'runs the changed tests' do
+      runner.should_receive(:run).with(['tests/firstTest.php', 'tests/secondTest.php'], anything).and_return(true)
+      subject.run_on_changes ['tests/firstTest.php', 'tests/secondTest.php']
+    end
+
+    it 'throws :task_has_failed when an error occurs' do
+      runner.should_receive(:run).with(['tests/firstTest.php', 'tests/secondTest.php'], anything).and_return(false)
+      expect { subject.run_on_changes ['tests/firstTest.php', 'tests/secondTest.php'] }.to throw_symbol :task_has_failed
+    end
+
+    it 'passes the options to the runner' do
+      runner.should_receive(:run).with(anything, hash_including(defaults)).and_return(true)
+      subject.run_on_changes ['tests/firstTest.php', 'tests/secondTest.php']
+    end
+
+    context 'when tests fail' do
+      before do
+        runner.stub(:run).and_return(false)
+        subject.stub(:run_all).and_return(true)
+      end
+
+      context 'with the :keep_failed option set to true' do
+        it 'runs the next changed files plus the failed tests' do
+          expect { subject.run_on_changes ['tests/firstTest.php'] }.to throw_symbol :task_has_failed
+          runner.should_receive(:run).with(
+            ['tests/secondTest.php', 'tests/firstTest.php'], anything
+          ).and_return(true)
+
+          subject.run_on_changes ['tests/secondTest.php']
+        end
+      end
+
+      context 'with the :keep_failed option set to false' do
+        subject { Guard::PHPUnit2.new(nil, :keep_failed => false) }
+
+        it 'runs the next changed files normally without the failed tests' do
+          expect { subject.run_on_changes ['tests/firstTest.php'] }.to throw_symbol :task_has_failed
+          runner.should_receive(:run).with(
+            ['tests/secondTest.php'], anything
+          ).and_return(true)
+
+          subject.run_on_changes ['tests/secondTest.php']
+        end
+      end
+    end
+
+    context 'when tests fail then pass' do
+      before do
+        runner.stub(:run).and_return(false, true)
+      end
+
+      context 'with the :all_after_pass option set to true' do
+        it 'calls #run_all' do
+          subject.should_receive(:run_all)
+          expect { subject.run_on_changes ['tests/firstTest.php'] }.to throw_symbol :task_has_failed
+          subject.run_on_changes ['tests/firstTest.php']
+        end
+
+        it 'calls #run_all (2)' do
+          expect { subject.run_all }.to throw_symbol :task_has_failed
+          subject.should_receive(:run_all)
+          subject.run_on_changes ['tests/firstTest.php']
+        end
+      end
+
+      context 'with the :all_after_pass option set to false' do
+        subject { Guard::PHPUnit2.new(nil, :all_after_pass => false) }
+
+        it 'does not call #run_all' do
+          subject.should_not_receive(:run_all)
+          expect { subject.run_on_changes ['tests/firstTest.php'] }.to throw_symbol :task_has_failed
+          subject.run_on_changes ['tests/firstTest.php']
+        end
+
+        it 'does not call #run_all (2)' do
+          expect { subject.run_all }.to throw_symbol :task_has_failed
+          subject.should_not_receive(:run_all)
+          subject.run_on_changes ['tests/firstTest.php']
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+require 'guard/phpunit2'
+
+RSpec.configure do |config|
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.color_enabled = true
+  config.filter_run :focus
+
+  config.before(:each) do
+    ENV['GUARD_ENV'] = 'test'
+    @project_path    = Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
+  config.after(:each) do
+    ENV['GUARD_ENV'] = nil
+  end
+
+end
+
+def load_phpunit_output(name)
+  File.read(File.expand_path("fixtures/results/#{name}.txt", File.dirname(__FILE__)))
+end