fail_fast 0.3.0 → 0.4.0

data/CHANGELOG.txt

@@ -1,3 +1,5 @@
+0.4
+  - added `is_on_path`
 0.3.0
   - added value_of()
   - added checks not linked to a config file  (FailFast().check do .. end)  

data/README.markdown

@@ -7,13 +7,14 @@
 ## How to use :
 
 
-### Example 0 : don't start the application if '_why' cannot be found (on the PATH).
+### Example 0 : don't start the application on Sunday or if '_why' cannot be found (on the PATH).
 
 Insert this code early in your program starting sequence :
 
 	require 'fail_fast'
 	FailFast().check do
-      fail '_why could not be found on the path' unless `which _why` =~ /_why$/
+	  is_on_path '_why'
+      fail "I don't work on Sunday" if 0 == Time.now.wday
 	end
 
 
@@ -195,11 +196,19 @@ You can also add custom rules, not related to any config files :
     nda_file = value_of(:nda_file)
     fail 'NDA is too old' if (Time.now - File.mtime(nda_file))  > (24 * 60 * 60) * 365
 
-Test the file system :
+Test the file system and .. :
 
+	directory_exists    '/home/ci/uploads'
+	file_exists         '/home/ci/config/secret.key'
+
+    # the keyed version :
 	directory_exists_for  'assets-upload_dir'
 	file_exists_for       'assets-nda_pdf_file'
 
+	is_on_path      'jruby'         # fail if jruby cannot be found 
+	is_on_path_for  :ruby_engine
+
+
 Test external services :
 
 	# is a webserver up ?

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/fail_fast.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fail_fast}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alain Ravet"]
-  s.date = %q{2010-07-17}
+  s.date = %q{2010-07-22}
   s.description = %q{raises an error if the yaml contents of a config file does not pass a test script.}
   s.email = %q{alainravet@gmail.com}
   s.extra_rdoc_files = [
@@ -27,12 +27,14 @@ Gem::Specification.new do |s|
      "fail_fast.gemspec",
      "lib/fail_fast.rb",
      "lib/fail_fast/base/base.rb",
+     "lib/fail_fast/base/messaging.rb",
      "lib/fail_fast/base/utils.rb",
      "lib/fail_fast/base/z_only_for_tests.rb",
      "lib/fail_fast/extensions/base_commands.rb",
      "lib/fail_fast/extensions/check_active_record_db.rb",
      "lib/fail_fast/extensions/check_email.rb",
      "lib/fail_fast/extensions/check_file_system.rb",
+     "lib/fail_fast/extensions/check_is_on_path.rb",
      "lib/fail_fast/extensions/check_mongo_db.rb",
      "lib/fail_fast/extensions/check_url.rb",
      "lib/fail_fast/extensions/check_value.rb",
@@ -52,6 +54,7 @@ Gem::Specification.new do |s|
      "spec/extensions/check_active_record_db_spec.rb",
      "spec/extensions/check_email_spec.rb",
      "spec/extensions/check_file_system_spec.rb",
+     "spec/extensions/check_is_on_path_spec.rb",
      "spec/extensions/check_mongo_db_spec.rb",
      "spec/extensions/check_url_spec.rb",
      "spec/extensions/check_value_spec.rb",
@@ -77,6 +80,7 @@ Gem::Specification.new do |s|
      "spec/extensions/check_active_record_db_spec.rb",
      "spec/extensions/check_email_spec.rb",
      "spec/extensions/check_file_system_spec.rb",
+     "spec/extensions/check_is_on_path_spec.rb",
      "spec/extensions/check_mongo_db_spec.rb",
      "spec/extensions/check_url_spec.rb",
      "spec/extensions/check_value_spec.rb",

data/lib/fail_fast/base/messaging.rb

@@ -0,0 +1,39 @@
+class FailFast
+
+  module Messaging
+
+    def default_message_for(e)
+      qc_value  = "'#{vcol(e.value)}'"
+      qc_key    = "'#{kcol(e.key)}'"
+      details = if    e.value.nil? then " for the key #{qc_key}"
+                elsif e.key.nil?   then " #{qc_value}"
+                else  " #{qc_value} for the key #{qc_key}"
+                end
+
+      case e.kind
+        when :config_file_not_found             then mcol("The config file could not be found") + " : #{yellow(e.value)}."
+        when :missing_value                     then mcol("Missing value") +" #{details}."
+        when :value_does_not_match              then mcol("Invalid value") +" #{details}."
+        when :not_an_email                      then mcol("Invalid email address") + " #{details}."
+        when :not_a_url                         then mcol("Invalid url") + " #{details}."
+        when :url_not_reachable                 then mcol("Could not reach the url") + " #{details}."
+        when :directory_not_found               then mcol("Missing directory") + " #{details}."
+        when :file_not_found                    then mcol("Missing file") + " #{details}."
+        when :not_on_path                       then mcol("App not on path : ") + " #{details}."
+        when :mongoDB_server_not_found          then mcol("Could not connect to the mongoDb server") + " #{details}."
+        when :mongoDB_db_not_found              then mcol("Could not open the mongoDb db") + " #{details}."
+        when :active_record_db_connection_error then mcol("Could not connect to the DB server") + " #{details}."
+        when :fail                              then mcol(e.value)
+        else
+          "%-38s %-35s %-30s \n" % [ e.kind, e.key, qc_value]
+      end
+    end
+
+    def mcol(msg)   lred(msg) end
+    def kcol(key) yellow(key) end
+    def vcol(val) yellow(val) end
+
+  end
+end
+
+FailFast.send  :include, FailFast::Messaging

data/lib/fail_fast/extensions/check_is_on_path.rb

@@ -0,0 +1,40 @@
+class FailFast
+  module CheckIsOnPath
+
+    # Ensure the application is on the path
+    #
+    # Usage
+    #   is_on_path 'jruby'
+    #
+    def is_on_path(app, *params)
+      unless found_on_the_path(app)
+        add_error ErrorDetails.new(nil, :not_on_path, app)
+      end
+    end
+
+    # Ensure the key value can be found on the path
+    #
+    # Usage
+    #   is_on_path_for 'file_compressor'
+    #
+    def is_on_path_for(key, *params)
+      return unless has_value_for key
+
+      p = key_value_regexp_options(key, params)
+
+      key = p.key
+      app   = value_for_deep_key(key)
+
+      unless found_on_the_path(app)
+        add_error ErrorDetails.new(key, :not_on_path, app)
+      end
+    end
+
+  private
+    def found_on_the_path(app)
+      `which #{app}` =~ /#{app}$/
+    end
+  end
+end
+
+FailFast.send  :include, FailFast::CheckIsOnPath

data/lib/fail_fast/extensions/check_value.rb

@@ -28,7 +28,7 @@ class FailFast
 
       nof_errors = errors.size
       if blank?(p.value)
-        add_error ErrorDetails.new(key, :missing_value, nil)
+        add_error ErrorDetails.new(key, :missing_value)
 
       elsif p.regexp
         add_error ErrorDetails.new(key, :value_does_not_match, p.value) unless p.value =~ p.regexp

data/lib/fail_fast/report.txt.erb

@@ -1,52 +1,13 @@
 <% if @config_file_path %>
 +------------------------------------------------------------------------------------------
-|   FAIL_FAST error : precondition(s) not met in
+|   <%= lred 'FAIL_FAST error' %> : precondition(s) not met in
 |  -----------------
-|     file         :  "<%= @config_file_path %>"
-<% if @keys_prefix%>|     keys prefix  :  <%= @keys_prefix ?  @keys_prefix.inspect : 'none' %>
+|     file          :  "<%= @config_file_path %>"
+<% if @keys_prefix%>|     keys prefix  :  <%= @keys_prefix.inspect %>
 <% end %>+------------------------------------------------------------------------------------------
 <% else %>
 +------------------------------------------------------------------------------------------
-|   FAIL_FAST error : precondition(s) not met.
+|   <%= lred 'FAIL_FAST error' %> : precondition(s) not met.
 +------------------------------------------------------------------------------------------
-<% end %><% @errors.each do |e|
-    @msg = case e.kind
-        when :config_file_not_found
-          red("The config file could not be found") + " : '#{yellow(lred(e.value))}'."
-        when :missing_value
-          red("Missing value") +" for the key '#{yellow(e.key)}'."
-        when :value_does_not_match
-          red("Invalid value") +" '#{lred(e.value)}' for the key '#{yellow(e.key)}'."
-        when :not_an_email
-          red("Invalid email address") + " '#{lred(e.value)}' for the key '#{yellow(e.key)}'."
-        when :not_a_url
-          red("Invalid url") + " '#{lred(e.value)}' for the key '#{yellow(e.key)}'."
-        when :url_not_reachable
-          red("Could not reach the url") + " '#{lred(e.value)}' for the key '#{yellow(e.key)}'."
-        when :directory_not_found
-          e.key ?
-          red("Missing directory") + " '#{lred(e.value)}' for the key '#{yellow(e.key)}'." :
-          red("Missing directory") + " '#{lred(e.value)}'."
-        when :file_not_found
-          e.key ?
-          red("Missing file") + " '#{lred(e.value)}' for the key '#{yellow(e.key)}'." :
-          red("Missing file") + " '#{lred(e.value)}'."
-        when :mongoDB_server_not_found
-          e.key ?
-          red("Could not connect to the mongoDb server") + " '#{lred(e.value)} for the key '#{yellow(e.key)}'." :
-          red("Could not connect to the mongoDb server") + " '#{lred(e.value)}."
-        when :mongoDB_db_not_found
-          e.key ?
-          red("Could not open the mongoDb db") + " '#{lred(e.value)} for the key '#{yellow(e.key)}'." :
-          red("Could not open the mongoDb db") + " '#{lred(e.value)}."
-        when :active_record_db_connection_error
-          e.key ?
-          red("Could not connect to the DB server") + " '#{lred(e.value)} for the key '#{yellow(e.key)}'." :
-          red("Could not connect to the DB server") + " '#{lred(e.value)}."
-        when :fail
-          red(lred(e.value))
-        else                      "%-38s %-35s %-30s \n" % [ e.kind, e.key, lred(e.value)] 
-      end
-    
-%>|  <%= @msg + "\n"%><% end 
-%>+------------------------------------------------------------------------------------------
+<% end %>| <%= @errors.collect{|e| default_message_for(e)}.join("\n| ") %>
++------------------------------------------------------------------------------------------

data/lib/fail_fast/support/error_details.rb

@@ -1,5 +1,11 @@
 class FailFast::ErrorDetails < Struct.new(:key, :kind, :value)
 
+  attr_reader :key, :kind, :value
+
+  def initialize(key, kind, value=nil)
+    @key, @kind, @value = key, kind, value
+  end
+
   def has_key_and_kind?(akey, akind)
     (key.to_s == akey.to_s) && kind.to_sym == akind.to_sym
   end

data/show_all_errors.rb

@@ -60,6 +60,9 @@ FailFast(SPEC_DIR + '/fixtures/simple.yml').check_now.but_fail_later do
   file_exists         '/tmp/foo/bar/??nOTaFile'   # not a file
   file_exists_for     'test/a_directory'          # not a file
 
+  is_on_path '_why'
+  is_on_path_for 'app_not_on_path'
+
 #test mondoDB
   fake_mongo_server_absent
   has_mongoDB      '10.0.0.123', :timeout => 1    # no mongo server at this address

data/spec/extensions/check_is_on_path_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+
+describe 'is_on_path' do
+
+  context '' do
+    it_should_not_raise_an_error('when the app is on the path') {
+      is_on_path 'ls'
+    }
+
+    it_should_raise_a_direct_error('ls987654321', :not_on_path, 'when the app is not on the path' ) {
+      is_on_path 'ls987654321'
+    }
+  end
+
+  context '_for' do
+    it_should_not_raise_an_error('when the app is on the path') {
+      is_on_path_for 'app_on_path'
+    }
+
+    it_should_raise_an_error('app_not_on_path', :not_on_path, 'when the app is not on the path' ) {
+      is_on_path_for 'app_not_on_path'
+    }
+  end
+
+end

data/spec/fixtures/simple.yml

@@ -1,6 +1,8 @@
 first_key: premier
 key_with_blank_value: <%= '' %>
 last_key: dernier
+app_on_path: ls
+app_not_on_path: ls0123
 test:
   host: localhost
   url: http://example.com/index.html

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fail_fast
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Alain Ravet
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-17 00:00:00 +02:00
+date: 2010-07-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,12 +82,14 @@ files:
 - fail_fast.gemspec
 - lib/fail_fast.rb
 - lib/fail_fast/base/base.rb
+- lib/fail_fast/base/messaging.rb
 - lib/fail_fast/base/utils.rb
 - lib/fail_fast/base/z_only_for_tests.rb
 - lib/fail_fast/extensions/base_commands.rb
 - lib/fail_fast/extensions/check_active_record_db.rb
 - lib/fail_fast/extensions/check_email.rb
 - lib/fail_fast/extensions/check_file_system.rb
+- lib/fail_fast/extensions/check_is_on_path.rb
 - lib/fail_fast/extensions/check_mongo_db.rb
 - lib/fail_fast/extensions/check_url.rb
 - lib/fail_fast/extensions/check_value.rb
@@ -107,6 +109,7 @@ files:
 - spec/extensions/check_active_record_db_spec.rb
 - spec/extensions/check_email_spec.rb
 - spec/extensions/check_file_system_spec.rb
+- spec/extensions/check_is_on_path_spec.rb
 - spec/extensions/check_mongo_db_spec.rb
 - spec/extensions/check_url_spec.rb
 - spec/extensions/check_value_spec.rb
@@ -160,6 +163,7 @@ test_files:
 - spec/extensions/check_active_record_db_spec.rb
 - spec/extensions/check_email_spec.rb
 - spec/extensions/check_file_system_spec.rb
+- spec/extensions/check_is_on_path_spec.rb
 - spec/extensions/check_mongo_db_spec.rb
 - spec/extensions/check_url_spec.rb
 - spec/extensions/check_value_spec.rb