fail_fast 0.5.2 → 0.6.0

data/spec/_/support/errors.rb

@@ -0,0 +1,13 @@
+
+def produce_1_error_in_1_check_block
+  FailFast(EMPTY_FILE_PATH).check.but_fail_later do
+    is_on_path("azertyuiop")
+  end
+end
+
+def produce_2_errors_in_1_check_block
+  FailFast(SIMPLE_FILE_PATH).check.but_fail_later do
+    has_value_for(:anykey_1, :message => 'msg-A')
+    has_value_for(:anykey_2, :message => 'msg-B')
+  end
+end

data/spec/_/support/errors_reporters.rb

@@ -0,0 +1,3 @@
+class DummyErrorReporter
+  def report(a,b) ; end
+end

data/spec/_/support/hoptoad.rb

@@ -0,0 +1,7 @@
+
+# This fake Hoptoad api token works with the recorded vcr cassettes.
+# Should you need to hit hoptoadapp.com for real, then you must
+# temporarily replace it with a valid api token :
+VALID_HOPTOAD_API_KEY   = 'this-is-a-fake-hoptoad-api-token'
+
+INVALID_HOPTOAD_API_KEY = '000'

data/spec/_/support/it_extensions.rb

@@ -0,0 +1,126 @@
+
+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
+
+    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
+
+    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
+
+  end
+
+  def self.included(receiver)
+    receiver.extend(ClassMethods)
+    receiver.send :include, InstanceMethods
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(DSLMacros)
+end

data/spec/_/support/stdout.rb

@@ -0,0 +1,8 @@
+
+class ExitTriggered < StandardError ; end
+
+module Kernel
+  def exit(param=nil)
+    raise ExitTriggered.new('Kernel.exit was called')
+  end
+end

data/spec/_/support/vcr.rb

@@ -0,0 +1,11 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir     = 'spec/_vcr_cassette_library'
+  c.stub_with                :webmock
+  c.ignore_localhost         = true
+  c.default_cassette_options = { :record => :none }
+end
+Spec::Runner.configure do |config|
+  config.extend VCR::RSpec::Macros
+end

data/spec/_/support/webmock.rb

@@ -0,0 +1,4 @@
+
+require 'webmock/rspec'
+
+WebMock.allow_net_connect!(:net_http_connect_on_start => true)

data/spec/_/support/xml.rb

@@ -0,0 +1,4 @@
+
+def evaluate_xml_erb(template)
+  ERB.new(File.read(template)).result(binding).gsub(/[\t\r\n]/, '')
+end

data/spec/_vcr_cassette_library/FailFast_ErrorReporter_Hoptoad/when_1_errors_occurs_in_1_block.yml

@@ -0,0 +1,35 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: ! '<?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>this-is-a-fake-hoptoad-api-token</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/empty.yml"
+      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>'
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '200'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.084877'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<notice>\n  <error-id type=\"integer\">8252669</error-id>\n
+      \ <url>http://failfast.hoptoadapp.com/errors/8252669/notices/1453782749</url>\n
+      \ <id type=\"integer\">1453782749</id>\n</notice>\n"
+    http_version: '1.1'

data/spec/_vcr_cassette_library/FailFast_ErrorReporter_Hoptoad/when_2_errors_occur_in_1_block.yml

@@ -0,0 +1,37 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: <?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>this-is-a-fake-hoptoad-api-token</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/simple.yml"
+      file="msg-A| Missing value  for the key 'anykey_1'." number='1'/>      <line
+      method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/simple.yml"
+      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>
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '200'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.388047'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<notice>\n  <error-id type=\"integer\">8259349</error-id>\n
+      \ <url>http://failfast.hoptoadapp.com/errors/8259349/notices/1454725873</url>\n
+      \ <id type=\"integer\">1454725873</id>\n</notice>\n"
+    http_version: '1.1'

data/spec/_vcr_cassette_library/FailFast_ErrorReporter_Hoptoad/when_3_errors_occur_in_2_blocks.yml

@@ -0,0 +1,71 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: ! '<?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>this-is-a-fake-hoptoad-api-token</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/empty.yml"
+      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>'
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '200'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.061651'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<notice>\n  <error-id type=\"integer\">8252669</error-id>\n
+      \ <url>http://failfast.hoptoadapp.com/errors/8252669/notices/1454739109</url>\n
+      \ <id type=\"integer\">1454739109</id>\n</notice>\n"
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: <?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>this-is-a-fake-hoptoad-api-token</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/simple.yml"
+      file="msg-A| Missing value  for the key 'anykey_1'." number='1'/>      <line
+      method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/simple.yml"
+      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>
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '200'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.054047'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<notice>\n  <error-id type=\"integer\">8259349</error-id>\n
+      \ <url>http://failfast.hoptoadapp.com/errors/8259349/notices/1454739177</url>\n
+      \ <id type=\"integer\">1454739177</id>\n</notice>\n"
+    http_version: '1.1'

data/spec/_vcr_cassette_library/FailFast_ErrorReporter_Hoptoad/when_the_API_token_is_invalid.yml

@@ -0,0 +1,67 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: ! '<?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>000</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/empty.yml"
+      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>'
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '422'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.014402'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No project
+      exists with the given API key.</error>\n</errors>\n"
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: ! '<?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>000</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/empty.yml"
+      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>'
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '422'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.020815'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<errors>\n  <error>No project
+      exists with the given API key.</error>\n</errors>\n"
+    http_version: '1.1'

data/spec/_vcr_cassette_library/FailFast_ErrorReporter_Hoptoad/when_the_API_token_is_valid.yml

@@ -0,0 +1,35 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: http://hoptoadapp.com:80/notifier_api/v2/notices
+    body: ! '<?xml version="1.0" encoding="UTF-8"?><notice version="2.0">  <api-key>this-is-a-fake-hoptoad-api-token</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 1999-05-04 03:02:01 +0200</message>    <backtrace>      <line method="/Volumes/dropbox/Dropbox/dev/myos/fail_fast/spec/_/fixtures/empty.yml"
+      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>'
+    headers:
+      accept:
+      - text/xml
+      content-type:
+      - text/xml
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      content-type:
+      - text/xml
+      transfer-encoding:
+      - chunked
+      status:
+      - '200'
+      x-powered-by:
+      - Phusion Passenger (mod_rails/mod_rack) 3.0.6
+      x-runtime:
+      - '0.048813'
+      server:
+      - nginx/0.8.54 + Phusion Passenger 3.0.6 (mod_rails/mod_rack)
+    body: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<notice>\n  <error-id type=\"integer\">8252669</error-id>\n
+      \ <url>http://failfast.hoptoadapp.com/errors/8252669/notices/1454098661</url>\n
+      \ <id type=\"integer\">1454098661</id>\n</notice>\n"
+    http_version: '1.1'

data/spec/base/error_details_spec.rb

@@ -8,4 +8,12 @@ describe FailFast::ErrorDetails do
     its(:value  ){ should == 'a_value'  }
     its(:message){ should == 'a_message'}
   end
+
+  example "== works (bugfix)" do
+    e1 = FailFast::ErrorDetails.new(:a_key, :a_kind, 'a_value', 'a_message')
+    e1b= FailFast::ErrorDetails.new(:a_key, :a_kind, 'a_value', 'a_message')
+    e1.should == e1b
+    e2 = FailFast::ErrorDetails.new(:a_key, :a_kind, 'a_value', 'a_message'+"change")
+    e1.should_not == e2
+  end
 end