fail_fast 0.5.2 → 0.6.0

data/spec/error_reporter/fail_fast_spec.rb

@@ -0,0 +1,73 @@
+# Prove that FailFast,
+#  - register FailFast::ErrorReporter::Stdout  as default errors reporter.
+#  - when it detects 1/many error(s), calls report(..) with the proper parameters on its errors reporter.
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'FailFast and error reporters :' do
+
+  let(:ff) {FailFast.new(nil,nil)}
+
+  it 'only reports errors to Stdout by default' do
+    ff.error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout]
+  end
+
+  it 'can register multiple error reporters' do
+    ff.register_errors_reporter(DummyErrorReporter.new)
+    ff.error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout, DummyErrorReporter]
+  end
+
+  it 'ignores duplicate registration' do
+    ff.register_errors_reporter(DummyErrorReporter.new)
+    ff.register_errors_reporter ff.error_reporters.first
+    ff.register_errors_reporter ff.error_reporters.last
+    ff.error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout, DummyErrorReporter]
+  end
+
+
+  it "calls all the registered reporters, when an error occurs" do
+    ff.register_errors_reporter(DummyErrorReporter.new)
+    ff.error_reporters[0].should_receive(:report).once
+    ff.error_reporters[1].should_receive(:report).once
+
+    ff.check_now.but_fail_later do                                            # = what we test!
+      has_value_for(:www_unknown , :message => "www_unknown is missing" )     #
+      has_value_for(:www_unknown2, :message => "www_unknown2 is missing")     #
+    end                                                                       #
+  end
+end
+
+describe FailFast do
+
+  let(:error_1) { FailFast::ErrorDetails.new(:www_unknown , :missing_value, nil, "www_unknown is missing" ) }
+  let(:error_2) { FailFast::ErrorDetails.new(:www_unknown2, :missing_value, nil, "www_unknown2 is missing") }
+  let(:two_errors) { [error_1, error_2] }
+  let(:two_errors_context) do {:errors_to_report =>  two_errors, :config_file_path =>  SIMPLE_FILE_PATH, :keys_prefix      =>  nil} end
+
+  describe ".check_now" do
+    it "passes all the detected errors and the context to Stdout.report" do
+      FailFast(SIMPLE_FILE_PATH).tap do |ff|
+        ff.error_reporters.first.should_receive(:report).with(two_errors, two_errors_context)  # the test
+        begin
+          ff.check_now do                                                         # = what we test!
+            has_value_for(:www_unknown , :message => "www_unknown is missing" )   #
+            has_value_for(:www_unknown2, :message => "www_unknown2 is missing")   #
+          end                                                                     #
+        rescue
+        end
+      end
+    end
+  end
+
+  describe ".check_now.but_fail_later" do
+    it "passes all the detected errors and the context to Stdout.report" do
+      FailFast(SIMPLE_FILE_PATH).tap do |ff|
+        ff.error_reporters.first.should_receive(:report).with(two_errors, two_errors_context)  # the test
+        ff.check_now.but_fail_later do                                            # = what we test!
+          has_value_for(:www_unknown , :message => "www_unknown is missing" )     #
+          has_value_for(:www_unknown2, :message => "www_unknown2 is missing")     #
+        end                                                                       #
+      end
+    end
+  end
+end

data/spec/error_reporter/global_reporters_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe FailFast do
+
+  let(:ff) {FailFast.new(nil,nil)}
+
+  it 'reports errors only to FailFast::ErrorReporter::Stdout by default' do
+    ff.error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout]
+  end
+
+  describe ".report_to" do
+    it 'add errors reporters to the next FailFast check blocks that will be created' do
+      FailFast.new(nil,nil).error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout]
+      FailFast.report_to DummyErrorReporter.new
+      FailFast.new(nil,nil).error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout, DummyErrorReporter]
+    end
+
+    it "resets the default error reporters between each test" do
+      FailFast.new(nil,nil).error_reporters.collect{|o|o.class}.should == [FailFast::ErrorReporter::Stdout]
+    end
+  end
+end

data/spec/error_reporter/hoptoad/expected_error_1_request.xml.erb

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0">
+  <api-key><%= @api_key %></api-key>
+  <notifier>
+    <name>FailFast Hoptoad Notifier</name>
+    <version>0.1</version>
+    <url>https://github.com/alainravet/fail_fast</url>
+  </notifier>
+  <error>
+    <class>FailFastError</class>
+    <message>FailFastError at <%= FROZEN_TIME %></message>
+    <backtrace>
+      <line method="<%= EMPTY_FILE_PATH %>" file="App not on path :   'azertyuiop'." number='1'/>
+    </backtrace>
+  </error>
+  <server-environment>
+    <project-root>/testapp</project-root>
+    <environment-name>test</environment-name>
+    <app-version>1.0.0</app-version>
+  </server-environment>
+</notice>

data/spec/error_reporter/hoptoad/expected_error_2_request.xml.erb

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notice version="2.0">
+  <api-key><%= @api_key %></api-key>
+  <notifier>
+    <name>FailFast Hoptoad Notifier</name>
+    <version>0.1</version>
+    <url>https://github.com/alainravet/fail_fast</url>
+  </notifier>
+  <error>
+    <class>FailFastError</class>
+    <message>FailFastError at <%= FROZEN_TIME %></message>
+    <backtrace>
+      <line method="<%= SIMPLE_FILE_PATH %>" file="msg-A| Missing value  for the key 'anykey_1'." number='1'/>
+      <line method="<%= SIMPLE_FILE_PATH %>" file="msg-B| Missing value  for the key 'anykey_2'." number='2'/>
+    </backtrace>
+  </error>
+  <server-environment>
+    <project-root>/testapp</project-root>
+    <environment-name>test</environment-name>
+    <app-version>1.0.0</app-version>
+  </server-environment>
+</notice>

data/spec/error_reporter/hoptoad/hoptoad_activation_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe FailFast::ErrorReporter::Hoptoad do
+
+  it 'is activated by adding it with FF#report_to to the global active error reporters' do
+    FailFast.report_to :hoptoad => VALID_HOPTOAD_API_KEY
+
+    FailFast.new.error_reporters.collect{|o|o.class}.
+        should == [FailFast::ErrorReporter::Stdout, FailFast::ErrorReporter::Hoptoad]
+    #                                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    #                                                 The new global errors reporter
+  end
+
+end

data/spec/error_reporter/hoptoad/hoptoad_requests_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe FailFast::ErrorReporter::Hoptoad do
+
+  let(:request_for_1_error_in_1_block){
+    a_request(:post, 'http://hoptoadapp.com/notifier_api/v2/notices').
+        with(:headers => {'Accept'=>'text/xml', 'Content-Type' => 'text/xml'},
+             :body    => evaluate_xml_erb(File.join(File.dirname(__FILE__), 'expected_error_1_request.xml.erb')))
+
+  }
+
+  let(:request_for_2_errors_in_1_block){
+    a_request(:post, 'http://hoptoadapp.com/notifier_api/v2/notices').
+        with(:headers => {'Accept'=>'text/xml', 'Content-Type' => 'text/xml'},
+             :body    => evaluate_xml_erb(File.join(File.dirname(__FILE__), 'expected_error_2_request.xml.erb')))
+
+  }
+
+#--------------------------------------------------------
+
+  before { Timecop.freeze(FROZEN_TIME); } #capture_stdout}
+  after  { Timecop.return             ; } #restore_stdout}
+  before do
+    @api_key  = VALID_HOPTOAD_API_KEY
+    @reporter = FailFast.report_to(:hoptoad => @api_key).first
+  end
+
+#--------------------------------------------------------
+
+
+  context 'when 1 errors occurs in 1 block' do
+    use_vcr_cassette :record => :new_episodes
+
+    it 'POSTs 1 xml request to hoptoadapp.com' do
+      produce_1_error_in_1_check_block
+      request_for_1_error_in_1_block.should have_been_made
+    end
+  end
+
+
+  context 'when 2 errors occur in 1 block' do
+    use_vcr_cassette :record => :new_episodes
+
+    it 'POSTs 1 xml request to hoptoadapp.com' do
+      produce_2_errors_in_1_check_block
+      request_for_2_errors_in_1_block.should have_been_made
+    end
+  end
+
+
+  context 'when 3 errors occur in 2 blocks' do
+    use_vcr_cassette :record => :new_episodes
+
+    it 'POSTs 2 xml requests to hoptoadapp.com' do
+      produce_1_error_in_1_check_block
+      produce_2_errors_in_1_check_block
+
+      request_for_1_error_in_1_block .should have_been_made
+      request_for_2_errors_in_1_block.should have_been_made
+    end
+  end
+
+end

data/spec/error_reporter/hoptoad/hoptoad_responses_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe FailFast::ErrorReporter::Hoptoad do
+
+  context 'when the API token is invalid' do
+    use_vcr_cassette :record => :new_episodes
+    before do
+      FailFast.send :reset_global_error_reporters
+      @api_key  = INVALID_HOPTOAD_API_KEY
+      @reporter = FailFast.report_to(:hoptoad => @api_key).first
+    end
+
+    example 'POST => 422' do
+      produce_1_error_in_1_check_block
+      @reporter.response.code.to_i.should == 422
+    end
+  end
+
+
+  context 'when the API token is valid' do
+    use_vcr_cassette :record => :new_episodes
+
+    before do
+      FailFast.send :reset_global_error_reporters
+      @api_key  = VALID_HOPTOAD_API_KEY
+      @reporter = FailFast.report_to(:hoptoad => @api_key).first
+    end
+
+    example 'POST => 200' do
+      produce_1_error_in_1_check_block
+      @reporter.response.code.to_i.should == 200
+    end
+  end
+
+end

data/spec/error_reporter/stdout/stdout_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe FailFast::ErrorReporter::Stdout do
+  before(:each) { capture_stdout }
+  after( :each) { restore_stdout }
+
+  context 'when 2 errors are detected in a config file' do
+    before do
+      produce_2_errors_in_1_check_block
+    end
+    it("prints to $stdout the config file path") do
+      $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}/mi)
+    end
+    it "prints to $stdout the 1st error details" do
+      $stdout.string.should match(/error.*msg-A.*missing value.*anykey_1/mi)
+    end
+    it "prints to $stdout the 2nd error details" do
+      $stdout.string.should match(/error.*msg-B.*missing value.*anykey_2/mi)
+    end
+    it "prints everything in sequence and in the right order" do
+      $stdout.string.should match(/error.*#{SIMPLE_FILE_PATH}.*msg-A.*missing value.*anykey_1.*msg-B.*missing value.*anykey_2/mi)
+    end
+  end
+end

data/spec/extensions/file_or_directory_exists_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-a_dir   = SPEC_DIR + '/fixtures'
-a_file  = SPEC_DIR + '/fixtures/simple.yml'
+a_dir   = SPEC_DIR + '/_/fixtures'
+a_file  = SPEC_DIR + '/_/fixtures/simple.yml'
 
 
 describe 'directory_exists' do

data/spec/extensions/has_url_spec.rb

@@ -1,12 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe 'has_url_for()' do
-before(:all) do
-    FakeWeb.register_uri(:get, "http://example.com/index.html", :body => "I'm reachable!")
-    FakeWeb.register_uri(:get, "http://localhost/index.html"  , :body => "I'm reachable!")
-    FakeWeb.register_uri(:get, "http://localhost/index.html"  , :body => "I'm reachable!")
-    FakeWeb.register_uri(:get, "http://localhost:3200"        , :body => "I'm reachable!")
-end
+  before(:each) do
+      stub_request(:get, "http://example.com"           ).to_return(:body => "I'm reachable!")
+  end
 
   it_should_return_true(       'when the value is an url') { has_url_for 'test/url' }
   it_should_not_raise_an_error('when the value is an url') { has_url_for 'test/url' }

data/spec/extensions/key_prefix_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe 'the key prefix' do
 
   example 'works fine in all the checkers' do
-    FakeWeb.register_uri(:get, "http://localhost:3200"        , :body => "I'm reachable!")
+    stub_request(:get, "http://localhost:3200").to_return(:body => "I'm reachable!")
 
     conn = Mongo::Connection.new
     conn.should_receive(:database_names).any_number_of_times.and_return %w(sample_mongoDB)

data/spec/how_to_use_spec.rb

@@ -35,9 +35,7 @@ describe "typical usage" do
 end
 
 def fake_the_remote_services
-  FakeWeb.register_uri(:get, "http://example.com/index.html", :body => "I'm reachable!")
-  FakeWeb.register_uri(:get, "http://localhost/index.html", :body => "I'm reachable!")
-  FakeWeb.register_uri(:get, "http://example.com", :body => "I'm reachable!")
+  stub_request(:get, "http://example.com"           ).to_return(:body => "I'm reachable!")
 
   conn = Mongo::Connection.new
   conn.should_receive(:database_names).any_number_of_times.and_return %w(sample_mongoDB)

data/spec/spec_helper.rb

@@ -1,148 +1,27 @@
 require 'rubygems'
 require 'fail_fast'
+
 require 'spec'
-require 'spec/autorun'
-require 'fakeweb'
-#gem 'mongo', '1.0'
+require 'timecop'
 require 'mongo'
+require 'active_support/inflector'
 
-SPEC_DIR = File.dirname(File.expand_path(__FILE__))
-UNKNOWN_FILE_PATH =   'an_unknown_file_path'
-EMPTY_FILE_PATH   =   File.expand_path(File.dirname(__FILE__) + '/fixtures/empty.yml')
-SIMPLE_FILE_PATH  =   File.expand_path(File.dirname(__FILE__) + '/fixtures/simple.yml')
-
-class ExitTriggered < StandardError ; end
-module Kernel
-  def exit(param=nil)
-    raise ExitTriggered.new('Kernel.exit was called')
-  end
-end
-
-
-module DSLMacros
-  module InstanceMethods
-    def capture_stdout
-      @@original_stdout = STDOUT
-      $stdout = StringIO.new
-    end
-
-    def restore_stdout
-      $stdout = @@original_stdout
-    end
-  end
-  module ClassMethods
-
-    def it_should_return_true(msg, &block)
-      it "returns true #{msg}" do
-        capture_stdout
-        begin
-          FailFast(SIMPLE_FILE_PATH).check.but_fail_later do
-            raise "BUG : @@errorz should be empty \n#{errors.inspect}"  unless errors.empty?
-            result = self.instance_eval(&block)
-            #TODO : BETTER ERROR REPORTING
-            result.should == true
-          end
-        rescue => e
-          raise e
-        end
-        restore_stdout
-      end
-    end
-
-
-    def it_should_return_false(msg, &block)
-      it "returns false #{msg}" do
-        capture_stdout
-        begin
-          FailFast(SIMPLE_FILE_PATH).check.but_fail_later do
-            raise "BUG : @@errorz should be empty \n#{errors.inspect}"  unless errors.empty?
-            result = self.instance_eval(&block)
-            #TODO : BETTER ERROR REPORTING
-            result.should == false
-          end
-        rescue => e
-          raise e
-        end
-        restore_stdout
-      end
-    end
+SPEC_DIR          = File.dirname(File.expand_path(__FILE__))
 
-    def it_should_not_raise_an_error(msg, &block)
-      it "does not raise an error #{msg}" do
-        capture_stdout
-        begin
-          FailFast(SIMPLE_FILE_PATH).check do
-            raise "BUG : @@errorz should be empty \n#{errors.inspect}"  unless errors.empty?
-            self.instance_eval(&block)
-          end
-        rescue => e
-          raise e
-        ensure
-          if FailFast.failed?
-            fail "ZZshould not have raised an error, but it raised\n#{FailFast.global_errors.join("\n")}"
-          end
-        end
-        restore_stdout
-      end
-    end
+UNKNOWN_FILE_PATH =   'an_unknown_file_path'
+EMPTY_FILE_PATH   =   SPEC_DIR + '/_/fixtures/empty.yml'
+SIMPLE_FILE_PATH  =   SPEC_DIR + '/_/fixtures/simple.yml'
 
-    def it_should_raise_an_error(key, kind, msg, &block)
-      it "raises an error #{kind}-#{key}-#{msg}" do
-        capture_stdout
-        begin
-          FailFast(SIMPLE_FILE_PATH).check do
-            raise "BUG : @@errorz should be empty \n#{errors.inspect}"  unless errors.empty?
-            self.instance_eval(&block)
-          end
-        rescue => e
-          # uncomment the next line after the refactoring/once error are no longer raise
-          #  raise e
-        ensure
-          if !FailFast.failed?
-            fail "\ne2d\nshould have raised a #{kind} error for #{key} \n==#{e}"
-          elsif FailFast.global_errors.length == 1 && !FailFast.global_errors.first.has_key_and_kind?(key, kind)
-            fail "\ne2e\nshould have raised a #{kind.inspect} error for #{key.inspect}, but raised instead #{FailFast.global_errors.inspect}"
-          elsif 2 <= FailFast.global_errors.length
-            fail "\ne2f\nshould have raised only a #{kind} error for #{key}\n#{FailFast.global_errors.join("\n")}"
-          end
-        end
-        restore_stdout
-      end
-    end
-    def it_should_raise_a_direct_error(value, kind, msg, &block)
-      it "raises an error #{kind}-#{value}-#{msg}" do
-        capture_stdout
-        begin
-          FailFast(SIMPLE_FILE_PATH).check do
-            raise "BUG : @@errorz should be empty \n#{errors.inspect}"  unless errors.empty?
-            self.instance_eval(&block)
-          end
-        rescue => e
-          # uncomment the next line after the refactoring/once error are no longer raise
-          #  raise e
-        ensure
-          if !FailFast.failed?
-            fail "\ne2d\nshould have raised a #{kind} error for #{value} \n==#{e}"
-          elsif FailFast.global_errors.length == 1 && !FailFast.global_errors.first.has_value_and_kind?(value, kind)
-            fail "\ne2e\nshould have raised a #{kind.inspect} error for #{value.inspect}\n, but raised instead\n#{FailFast.global_errors.inspect}"
-          elsif 2 <= FailFast.global_errors.length
-            fail "\ne2f\nshould have raised only 1 #{kind} error for #{value}\nbut raised instead\n#{FailFast.global_errors.join("\n")}"
-          end
-        end
-        restore_stdout
-      end
-    end
+require 'time'
+FROZEN_TIME = Time.parse('1999-05-04 03:02:01 +0200')
 
-  end
 
-  def self.included(receiver)
-    receiver.extend(ClassMethods)
-    receiver.send :include, InstanceMethods
-  end
-end
 Spec::Runner.configure do |config|
-  config.include(DSLMacros)
   config.before(:each) do
     FailFast.reset_error_db!
+    FailFast.send :reset_global_error_reporters
   end
 end
+
+
+Dir[File.join(SPEC_DIR, '_/support/**/*.rb')].each {|f| require f}