fail_fast 0.1.2 → 0.2.1

data/CHANGELOG.txt

@@ -1,3 +1,8 @@
+0.2.1
+  - improve + colour the report template
+0.2.0
+  - added `FailFast(<afile>).check_now.but_fail_later` + FailFast.fail_now
+  - added `FailFast.failed?'
 0.1.2
   - added commands : only_if and skip_if
 0.1.1

data/README.markdown

@@ -6,38 +6,85 @@
 
 ## How to use :
 
-Early in your project boot sequence insert code like
 
-    require 'fail_fast'
-    FailFast('database.yml').check do
-      has_active_record_db_for  Rails.env
-    end
+### Case 1 : don't start the application if the DB cannot be reached.
 
-    FailFast('database.mongo.yml').check do
-      has_mongoDB_for   Rails.env
-    end
+Early in your project boot sequence insert this code :
 
-    FailFast('path_to/config.yml', prefix=Rails.env).check do
-      has_values_for    'author/fname', 'author/lname'
-      has_email_for     'newsletter/to_address'
+	require 'fail_fast'
+	FailFast("path/to/database.yml").check do
+	  has_active_record_db_for  'production'
+	end
 
-      only_if Rails.env.production? do
-        has_url_for       'bug_tracker/url', :reachable => true
-      end
 
-      directory_exists_for  '/tmp'
-      file_exists_for       'public/nda.pdf'
+If the DB connection fails,   
+* the application will exit immediately and    
+* you'll see this report :
+  
+
+    +------------------------------------------------------------------------------------------
+    |   FAIL_FAST error : precondition(s) not met in
+    |  -----------------
+    |     file         :  "path/to/database.yml"
+    |     keys prefix  :  (none)
+    +------------------------------------------------------------------------------------------
+    |      error                                   key                                value
+    +------------------------------------------------------------------------------------------
+    |  * active_record_db_connection_error      production                          Unknown database 'a_db'
+    +------------------------------------------------------------------------------------------
+
+Remark :  `check` will call `exit(1)` at the end of the first block with an error.   
+If you want to collect and report all the errors before exiting, use `check_now.but_fail_later` (see case 2 below).
+
+### Case 2 : collect errors in multiple blocks.
+
+
+	require 'fail_fast'
+	FailFast('database.yml').check_now.but_fail_later do
+	  has_active_record_db_for  'production'
+	end
+
+	FailFast('database.mongo.yml').check_now.but_fail_later do
+	  has_mongoDB_for   Rails.env
+	end
+	
+	FailFast('path_to/config.yml', prefix=Rails.env).check_now.but_fail_later do
+	  has_values_for    'author/fname', 'author/lname'
+	  has_email_for     'newsletter/to_address'
+	
+	  only_if Rails.env.production? do
+	    has_url_for       'bug_tracker/url', :reachable => true
+	  end
+	
+	  directory_exists_for  '/tmp'
+	  file_exists_for       'public/nda.pdf'
+	
+	  skip_if Rails.env.development? do
+	    fail "I don't work on Sunday" if 0 == Time.now.wday
+	   end
+	end
+	
+	FailFast.fail_now   # exit it an error was detected in any of the 3 blocks above.
 
-      skip_if Rails.env.development? do
-        fail "I don't work on Sunday" if 0 == Time.now.wday
-       end
-    end
 
 If it fails, you'll get a report like this :
     
     +------------------------------------------------------------------------------------------
-    |   FAIL_FAST error : "./spec/fixtures/simple.yml"
-    |   key prefix  = nil
+    |   FAIL_FAST error : precondition(s) not met in
+    |  -----------------
+    |     file         :  "path/to/database.yml"
+    |     keys prefix  :  (none)
+    +------------------------------------------------------------------------------------------
+    |      error                                   key                                value
+    +------------------------------------------------------------------------------------------
+    |  * active_record_db_connection_error      production                          Unknown database 'a_db'
+    +------------------------------------------------------------------------------------------
+
+    +------------------------------------------------------------------------------------------
+    |   FAIL_FAST error : precondition(s) not met in
+    |  -----------------
+    |     file         :  "./spec/fixtures/simple.yml"
+    |     keys prefix  :  none
     +------------------------------------------------------------------------------------------
     |      error                                   key                                value
     +------------------------------------------------------------------------------------------
@@ -62,6 +109,17 @@ If it fails, you'll get a report like this :
     |  * fail                                                                       a custom failure message
     +------------------------------------------------------------------------------------------
 
+### Case 3 : print an additional custom message if errors were detected
+
+	...	# code like in the cases above.
+
+	if FailFast.failed?
+        puts "Cannot start the application due to the problems mentioned above."
+		puts "You can skip those test with the SKIP_FAIL_FAST environment variable"
+		FailFast.fail_now	unless 'true'==ENV['SKIP_FAIL_FAST']
+	end
+
+
 
 ## Info :
 
@@ -89,11 +147,12 @@ You can also add custom rules, not related to any config files :
 
 ### _free/direct_ commands (not linked to the yaml file contents) :
 
-      directory_exists      '/tmp'
-      file_exists           '/Users/me/.bash_profile'
-      has_mongoDB           'localhost', 'db_app_1'
-      has_active_record_db  :host => 'dbserv', :adapter => 'mysql', :database => 'db'
-      fail "I don't work on Sunday" if (0 == Time.now.wday)
+	fail "I don't work on Sunday" if (0 == Time.now.wday)
+
+	directory_exists      '/tmp'
+	file_exists           '/Users/me/.bash_profile'
+	has_mongoDB           'localhost', 'db_app_1'
+	has_active_record_db  :host => 'dbserv', :adapter => 'mysql', :database => 'db'
 
 ### _keyed_ commands (linked to a value found in a yaml file) :
 
@@ -101,37 +160,38 @@ You can also add custom rules, not related to any config files :
 
 *presence :*
 
-      has_value_for   :application_name
-      has_values_for  'author/fname', 'author/lname'
+	has_value_for   :application_name
+	has_values_for  'author/fname', 'author/lname'
 
 *contents <-> a regexp or pattern :*
 
-      has_value_for   'level',  /(alpha|beta|production)/   
-      has_url_for     'bug_tracker/url'   
-      has_email_for   'newsletter/to_address'   
+	has_value_for   'level',  /(alpha|beta|production)/   
+	has_url_for     'bug_tracker/url'   
+	has_email_for   'newsletter/to_address'   
 
 Test the file system :
 
-      directory_exists_for  'assets-upload_dir'
-      file_exists_for       'assets-nda_pdf_file'
+	directory_exists_for  'assets-upload_dir'
+	file_exists_for       'assets-nda_pdf_file'
 
 Test external services :
 
-      # is a webserver up ?
-      has_url_for     'bug_tracker/url', :reachable => true
-      has_url_for     'bug_tracker/url', :reachable => true, :may_add_trailing_slash => true
-
-
-      # can we connect to a mongoDB db/server :
-      has_mongoDB_for   'test/mongoDB'
-      has_mongoDB_for   'test/unknown_mongoDB_db', :check_database => false
-
-      # can we connect to a SQL db :
-      has_active_record_db_for 'production/db_connection'
-
+	# is a webserver up ?
+	has_url_for     'bug_tracker/url', :reachable => true
+	has_url_for     'bug_tracker/url', :reachable => true, :may_add_trailing_slash => true
+
+	# can we connect to a mongoDB db/server :
+	has_mongoDB_for   'test/mongoDB'
+	has_mongoDB_for   'test/unknown_mongoDB_db', :check_database => false
+	
+	# can we connect to a SQL db :
+	has_active_record_db_for 'production/db_connection'
+	
 Misc :
-      fail 'message'
+
+	fail "I don't work on Sunday" if 0 == Time.now.wday
 
 Control commands :
-      skip_if <condition> do .. end
-      only_if <condition> do .. end
+
+	skip_if <condition> do .. end
+	only_if <condition> do .. end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.1

data/fail_fast.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fail_fast}
-  s.version = "0.1.2"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alain Ravet"]
-  s.date = %q{2010-06-22}
+  s.date = %q{2010-07-05}
   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 = [
@@ -26,28 +26,37 @@ Gem::Specification.new do |s|
      "VERSION",
      "fail_fast.gemspec",
      "lib/fail_fast.rb",
-     "lib/fail_fast/check_active_record_db.rb",
-     "lib/fail_fast/check_email.rb",
-     "lib/fail_fast/check_file_system.rb",
-     "lib/fail_fast/check_mongo_db.rb",
-     "lib/fail_fast/check_url.rb",
-     "lib/fail_fast/check_value.rb",
+     "lib/fail_fast/base/base.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_mongo_db.rb",
+     "lib/fail_fast/extensions/check_url.rb",
+     "lib/fail_fast/extensions/check_value.rb",
      "lib/fail_fast/main.rb",
-     "lib/fail_fast/misc.rb",
      "lib/fail_fast/report.txt.erb",
+     "lib/fail_fast/support/error_db.rb",
+     "lib/fail_fast/support/error_details.rb",
+     "lib/fail_fast/support/z_only_for_tests.rb",
      "show_all_errors.rb",
+     "spec/base_commands_spec.rb",
+     "spec/check_active_record_db_spec.rb",
+     "spec/check_email_spec.rb",
+     "spec/check_file_system_spec.rb",
+     "spec/check_mongo_db_spec.rb",
+     "spec/check_url_spec.rb",
+     "spec/check_value_spec.rb",
+     "spec/errors_storage_spec.rb",
      "spec/file_is_empty_spec.rb",
      "spec/file_is_missing_spec.rb",
-     "spec/file_system_spec.rb",
      "spec/fixtures/empty.yml",
      "spec/fixtures/simple.yml",
-     "spec/has_active_record_db_spec.rb",
-     "spec/has_email_for_spec.rb",
-     "spec/has_mongoDB_for_spec.rb",
-     "spec/has_url_for_spec.rb",
-     "spec/has_value_for_spec.rb",
      "spec/how_to_use_spec.rb",
-     "spec/misc_spec.rb",
+     "spec/multiple_blocks_support_spec.rb",
+     "spec/report_printing_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -57,16 +66,19 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{raises an error if the yaml contents of a config file does pass a test script.}
   s.test_files = [
-    "spec/file_is_empty_spec.rb",
+    "spec/base_commands_spec.rb",
+     "spec/check_active_record_db_spec.rb",
+     "spec/check_email_spec.rb",
+     "spec/check_file_system_spec.rb",
+     "spec/check_mongo_db_spec.rb",
+     "spec/check_url_spec.rb",
+     "spec/check_value_spec.rb",
+     "spec/errors_storage_spec.rb",
+     "spec/file_is_empty_spec.rb",
      "spec/file_is_missing_spec.rb",
-     "spec/file_system_spec.rb",
-     "spec/has_active_record_db_spec.rb",
-     "spec/has_email_for_spec.rb",
-     "spec/has_mongoDB_for_spec.rb",
-     "spec/has_url_for_spec.rb",
-     "spec/has_value_for_spec.rb",
      "spec/how_to_use_spec.rb",
-     "spec/misc_spec.rb",
+     "spec/multiple_blocks_support_spec.rb",
+     "spec/report_printing_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/fail_fast/base/base.rb

@@ -0,0 +1,44 @@
+class FailFast
+  module Base
+    ERB_TEMPLATE = File.dirname(__FILE__) + '/../report.txt.erb'
+
+    def check(&block)
+      fail_now_mode   = block_given? # false in the case of  *.check_now.but_fail_now do .. end
+
+      @config_file_not_found = !File.exist?(@config_file_path)
+      if @config_file_not_found
+        add_error ErrorDetails.new(nil, :config_file_not_found, @config_file_path)
+      else
+        check_all_rules(&block) if block_given?
+      end
+      unless errors.empty?
+        print_errors
+        exit(1) if fail_now_mode
+      end
+      self
+    end
+
+    alias check_now check
+
+    def but_fail_later(&block)
+      return if @config_file_not_found
+      check_all_rules(&block) if block_given?
+      unless errors.empty?
+        print_errors
+      end
+    end
+  private
+
+    def check_all_rules(&block)
+      @yaml_config_as_hash = YAML.load(ERB.new(File.read(@config_file_path)).result) || {}
+      self.instance_eval(&block)
+    end
+
+    def print_errors
+      @errors = errors
+      puts "\n\n\n" + ERB.new(File.read(ERB_TEMPLATE)).result(binding) + "\n\n"
+    end
+  end
+end
+
+FailFast.send  :include, FailFast::Base

data/lib/fail_fast/base/utils.rb

@@ -0,0 +1,58 @@
+class FailFast
+
+  class Params < Struct.new(:key, :value, :regexp, :options) ; end
+
+  module Utils
+
+    def blank?(value)
+      value.nil? || (value.is_a?(String) && '' == value.strip)
+    end
+
+    # Usage
+    #   value_for_deep_key('one/two/three')
+    # returns
+    #   @yaml_config_as_hash['one']['two']['three']
+    #
+    def value_for_deep_key(key)
+      key.to_s.split('/').inject(@yaml_config_as_hash) { |h, k| h[k] } rescue nil
+    end
+
+
+    def key_value_regexp_options(key, params)
+      last = params.pop
+      if last.is_a?(Hash)
+        options = last
+      else
+        params << last
+        options = {}
+      end
+
+      last = params.pop
+      if last.is_a?(Regexp)
+        regexp = last
+      else
+        params << last
+      end
+
+      key = "#{@keys_prefix}/#{key}" if @keys_prefix
+      value = value_for_deep_key(key)
+
+      Params.new(key, value, regexp, options)
+    end
+
+    NO_COLOUR="\033[0m"
+    RED      ="\033[31m"
+    LRED      ="\033[1;31m"
+    BLUE     ="\033[34m"
+    GREEN    ="\033[32m"
+    YELLOW   ="\033[1;33m"
+
+    def red(   str) [RED,    str, NO_COLOUR].join  end
+    def lred(   str) [LRED,    str, NO_COLOUR].join  end
+    def blue(  str) [BLUE,   str, NO_COLOUR].join  end
+    def green( str) [GREEN,  str, NO_COLOUR].join  end
+    def yellow(str) [YELLOW, str, NO_COLOUR].join  end
+  end
+end
+
+FailFast.send  :include, FailFast::Utils

data/lib/fail_fast/base/z_only_for_tests.rb

@@ -0,0 +1,10 @@
+# ONLY USED BY TESTS !!
+class FailFast
+  def self.global_errors
+    @@_errors_db.global_data
+  end
+
+  def self.reset_error_db!
+    @@_errors_db = ErrorDb.new
+  end
+end

data/lib/fail_fast/{misc.rb → extensions/base_commands.rb}

@@ -1,12 +1,12 @@
 class FailFast
-  module Misc
+  module BaseCommands
 
     # Usage
     #   if 0 == Time.now.wday
     #     fail "I don't work on Sunday""
     #   end
     def fail(message)
-      FailFast.errors << ErrorDetails.new(nil, :fail, message)
+      add_error ErrorDetails.new(nil, :fail, message)
     end
 
     def only_if(condition, &block)
@@ -18,4 +18,4 @@ class FailFast
     end
   end
 end
-FailFast.send  :include, FailFast::Misc
+FailFast.send  :include, FailFast::BaseCommands

data/lib/fail_fast/{check_active_record_db.rb → extensions/check_active_record_db.rb}

@@ -1,19 +1,4 @@
 require 'active_record'
-# ActiveRecord::Base.establish_connection(
-#    :adapter  => "mysql",
-#    :host     => "localhost",
-#    :username => "myuser",
-#    :password => "mypass",
-#    :database => "somedatabase"
-# )
-# ActiveRecord::Base.establish_connection(
-#    :adapter => "sqlite",
-#    :database  => "path/to/dbfile"
-#  )
-# ActiveRecord::Base.establish_connection(
-#    :adapter => "sqlite3",
-#    :dbfile  => ":memory:"
-#)
 
 class FailFast
   module CheckActiveRecordDB
@@ -34,7 +19,7 @@ class FailFast
         @error_message  = e.message
       end
       unless @success
-        FailFast.errors << ErrorDetails.new(nil, :active_record_db_connection_error, @error_message)
+        add_error ErrorDetails.new(nil, :active_record_db_connection_error, @error_message)
       end
     end
 
@@ -61,7 +46,7 @@ class FailFast
         @error_message  = e.message
       end
       unless @success
-        FailFast.errors << ErrorDetails.new(key, :active_record_db_connection_error, @error_message)
+        add_error ErrorDetails.new(key, :active_record_db_connection_error, @error_message)
       end
     end
 
@@ -70,38 +55,18 @@ end
 
 FailFast.send  :include, FailFast::CheckActiveRecordDB
 
-__END__
-    # Ensure the mongoDB server can be reached, and the db could be opened :
-    #
-    # Usage :
-    #  has_mongoDB_for 'test/mongoDB'
-    #  has_mongoDB_for 'test/unknown_mongoDB_db', :check_database => false
-    #
-    def has_mongoDB_for(key, *params)
-      return unless has_value_for key
-      return unless has_value_for "#{key}/host"
-      return unless has_value_for "#{key}/database"
-
-      p = key_value_regexp_options(key, params)
-      key, options = p.key, p.options
-
-      value = value_for_deep_key(key)
-      host, port, db = value['host'], value['port'], value['database']
-
-      begin
-        @conn = Mongo::Connection.new(host, port)
-      rescue Mongo::ConnectionFailure
-        FailFast.errors << ErrorDetails.new(key, :mongoDB_server_not_found, host)
-        return
-      end
-
-      must_check_db = !(false == options[:check_database])
-      if must_check_db && !@conn.database_names.include?(db)
-        FailFast.errors << ErrorDetails.new(key, :mongoDB_db_not_found, db)
-      end
-    end
-
-  end
-end
-
-
+# ActiveRecord::Base.establish_connection(
+#    :adapter  => "mysql",
+#    :host     => "localhost",
+#    :username => "myuser",
+#    :password => "mypass",
+#    :database => "somedatabase"
+# )
+# ActiveRecord::Base.establish_connection(
+#    :adapter => "sqlite",
+#    :database  => "path/to/dbfile"
+#  )
+# ActiveRecord::Base.establish_connection(
+#    :adapter => "sqlite3",
+#    :dbfile  => ":memory:"
+#)

data/lib/fail_fast/{check_email.rb → extensions/check_email.rb}

@@ -12,7 +12,7 @@ class FailFast
 
       value = value_for_deep_key(key)
       if EmailValidator.invalid_email_address?(value)
-        FailFast.errors << ErrorDetails.new(key, :not_an_email, value)
+        add_error ErrorDetails.new(key, :not_an_email, value)
       end
     end
   end

data/lib/fail_fast/{check_file_system.rb → extensions/check_file_system.rb}

@@ -8,7 +8,7 @@ class FailFast
     #
     def directory_exists(path, *params)
       unless File.exists?(path) && File.directory?(path)
-        FailFast.errors << ErrorDetails.new(nil, :directory_not_found, path)
+        add_error ErrorDetails.new(nil, :directory_not_found, path)
       end
     end
 
@@ -19,7 +19,7 @@ class FailFast
     #
     def file_exists(path, *params)
       unless File.exists?(path) && File.file?(path)
-        FailFast.errors << ErrorDetails.new(nil, :file_not_found, path)
+        add_error ErrorDetails.new(nil, :file_not_found, path)
       end
     end
 
@@ -37,7 +37,7 @@ class FailFast
       path = value_for_deep_key(key)
 
       unless File.exists?(path) && File.directory?(path)
-        FailFast.errors << ErrorDetails.new(key, :directory_not_found, p.value)
+        add_error ErrorDetails.new(key, :directory_not_found, p.value)
       end
     end
 
@@ -55,7 +55,7 @@ class FailFast
       path = value_for_deep_key(key)
 
       unless File.exists?(path) && File.file?(path)
-        FailFast.errors << ErrorDetails.new(key, :file_not_found, p.value)
+        add_error ErrorDetails.new(key, :file_not_found, p.value)
       end
     end
 

data/lib/fail_fast/{check_mongo_db.rb → extensions/check_mongo_db.rb}

@@ -16,12 +16,12 @@ class FailFast
         port = options.delete(:port)
         @conn = Mongo::Connection.new(host, port, options)
       rescue Mongo::ConnectionFailure
-        FailFast.errors << ErrorDetails.new(nil, :mongoDB_server_not_found, host)
+        add_error ErrorDetails.new(nil, :mongoDB_server_not_found, host)
         return
       end
 
       if db && !@conn.database_names.include?(db)
-        FailFast.errors << ErrorDetails.new(nil, :mongoDB_db_not_found, db)
+        add_error ErrorDetails.new(nil, :mongoDB_db_not_found, db)
       end
     end
 
@@ -45,13 +45,13 @@ class FailFast
       begin
         @conn = Mongo::Connection.new(host, port)
       rescue Mongo::ConnectionFailure
-        FailFast.errors << ErrorDetails.new(key, :mongoDB_server_not_found, host)
+        add_error ErrorDetails.new(key, :mongoDB_server_not_found, host)
         return
       end
 
       must_check_db = !(false == options[:check_database])
       if must_check_db && !@conn.database_names.include?(db)
-        FailFast.errors << ErrorDetails.new(key, :mongoDB_db_not_found, db)
+        add_error ErrorDetails.new(key, :mongoDB_db_not_found, db)
       end
     end
 

data/lib/fail_fast/{check_url.rb → extensions/check_url.rb}

@@ -18,11 +18,11 @@ class FailFast
 
       value = value_for_deep_key(key)
       if UrlValidator.invalid_url?(value)
-        FailFast.errors << ErrorDetails.new(key, :not_a_url, value)
+        add_error ErrorDetails.new(key, :not_a_url, value)
         return
       end
       if true==options.delete(:reachable) && UrlValidator.unreachable_url?(value, options)
-        FailFast.errors << ErrorDetails.new(key, :url_not_reachable, value)
+        add_error ErrorDetails.new(key, :url_not_reachable, value)
       end
     end
   end

data/lib/fail_fast/extensions/check_value.rb

@@ -0,0 +1,40 @@
+class FailFast
+  module CheckValue
+
+    # Usage
+    #  has_values_for :sym_key, 'str_key'
+    #
+    def has_values_for(*keys)
+      keys.each{|key| has_value_for(key)}
+    end
+
+
+    # Usage
+    #  has_value_for 'str_key'
+    #  has_value_for :sym_key, /localhost/
+    # returns
+    #   true if succesful, false otherwise
+    def has_value_for(key, *params)
+      p = key_value_regexp_options(key, params)
+      key, options = p.key, p.options
+
+      nof_errors = errors.size
+      if blank?(p.value)
+        add_error ErrorDetails.new(key, :missing_value, nil)
+
+      elsif p.regexp
+        add_error ErrorDetails.new(key, :value_does_not_match, p.value) unless p.value =~ p.regexp
+
+      elsif options.is_a?(Hash) && options[:in].is_a?(Range)
+        add_error ErrorDetails.new(key, :value_not_in_range,   p.value) unless options[:in].include?(p.value)
+
+      elsif options.is_a?(Hash) && options[:in].is_a?(Array)
+        add_error ErrorDetails.new(key, :value_not_in_array,   p.value) unless options[:in].include?(p.value)
+      end
+      no_new_error = nof_errors == errors.size
+    end
+
+  end
+end
+
+FailFast.send  :include, FailFast::CheckValue