jeckyl 0.2.1

data/spec/jeckyl_spec.rb

@@ -0,0 +1,202 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'jeckyl/errors'
+require File.expand_path(File.dirname(__FILE__) + '/../test/test_configurator')
+require File.expand_path(File.dirname(__FILE__) + '/../test/test_configurator_errors')
+require File.expand_path(File.dirname(__FILE__) + '/../test/test_class')
+require File.expand_path(File.dirname(__FILE__) + '/../test/test_subclass')
+
+conf_path = File.expand_path(File.dirname(__FILE__) + '/../test/conf.d')
+
+describe "Jeckyl" do
+
+  # general tests
+  
+  it "should return the defaults" do
+    conf = TestJeckyl.new(File.join(conf_path, 'defaults.rb'))
+    conf[:log_dir].should == '/tmp'
+    #conf[:key_file].should be_nil
+    conf[:log_level].should == :verbose
+    conf[:log_rotation].should == 5
+    conf[:threshold].should == 5.0
+  end
+
+  it "should create a simple config" do
+    #TestJeckyl.debug(true)
+    conf_file = conf_path + '/jeckyl'
+    conf = TestJeckyl.new(conf_file)
+    conf[:log_dir].should match(/test$/)
+    conf[:log_level].should == :verbose
+    conf[:log_rotation].should == 5
+    conf[:email].should == "robert@osburn-sharp.ath.cx"
+    conf.has_key?(:sieve).should be_true
+    conf[:config_files].length.should == 1
+  end
+
+
+
+  # general exceptions
+
+  it "should fail if the config file does not exist" do
+    conf_file = conf_path + "/never/likely/to/be/there"
+    lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigFileMissing, conf_file)
+  end
+
+  it "should raise an exception if a file parameter does not exist" do
+    conf_file = conf_path + '/bad_filename'
+    lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[log_dir\]:/)
+  end
+
+  it "should raise an exception if there is a syntax error" do
+    conf_file = conf_path + '/syntax_error'
+    lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigSyntaxError)
+  end
+
+  it "should raise an exception if there is an unknown parameter used" do
+    conf_file = conf_path + '/unknown_param'
+    lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::UnknownParameter)
+  end
+
+  # test parameters
+
+  describe "File Parameters" do
+
+    it "should raise an exception if a dir is not writable" do
+      conf_file = conf_path + '/unwritable_dir'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[log_dir\]:/)
+    end
+
+    it "should raise an exception if file is not readable" do
+      conf_file = conf_path + '/no_such_file'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[key_file\]:/)
+    end
+
+  end
+
+  describe "Numeric Parameters" do
+
+    it "should raise an exception if it gets a float when expecting an integer" do
+      conf_file = conf_path + '/wrong_type'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[log_rotation\]:.*value is not of required type: Integer$/)
+    end
+
+    it "should raise an exception if it gets a number out of range" do
+      conf_file = conf_path + '/out_of_range'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[log_rotation\]:.*value is not within required range: 0..20$/)
+    end
+
+    it "should raise an exception if it gets an integer instead of a float" do
+      conf_file = conf_path + '/not_a_float'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[pi\]:.*value is not of required type: Float$/)
+    end
+
+  end
+
+  describe "Boolean Parameters" do
+
+    it "should raise an exception if it gets a string instead of a boolean" do
+      conf_file = conf_path + '/not_a_bool'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[debug\]:.*Value is not a Boolean$/)
+    end
+
+    it "should raise an exception if it gets an invalid flag value" do
+      conf_file = conf_path + '/not_a_flag'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[flag\]:.*Cannot convert to Boolean$/)
+    end
+
+  end
+
+  describe "Compound Parameters" do
+
+    it "should raise an exception if it gets a string instead of an array" do
+      conf_file = conf_path + '/not_an_array'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[collection\]:.*value is not an Array$/)
+    end
+
+    it "should raise an exception if it gets a string instead of a hash" do
+      conf_file = conf_path + '/not_a_hash'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[options\]:.*value is not a Hash$/)
+    end
+
+    it "should raise an exception if it gets an array of strings instead of a integers" do
+      conf_file = conf_path + '/not_an_integer_array'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[sieve\]:.*element of array is not of type: Integer$/)
+    end
+
+  end
+
+  describe "String Parameters" do
+
+    it "should raise an exception if it gets a number instead of a string" do
+      conf_file = conf_path + '/not_a_string'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[email\]:.*is not a String$/)
+    end
+
+    it "should raise an exception if a string does not match the required pattern" do
+      conf_file = conf_path + '/not_an_email'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[email\]:.*does not match required pattern:/)
+    end
+
+    it "should raise an exception if it gets a pattern that is not a pattern" do
+      conf_file = conf_path + '/not_a_pattern'
+      lambda{conf = TestJeckylErrors.new(conf_file)}.should raise_error(Jeckyl::ConfigSyntaxError, "Attempt to pattern match without a Regexp")
+    end
+
+  end
+
+  describe "Set Parameters" do
+
+    it "should raise an exception if it gets a set that is not an array" do
+      conf_file = conf_path + '/not_a_set'
+      lambda{conf = TestJeckylErrors.new(conf_file)}.should raise_error(Jeckyl::ConfigSyntaxError, "Sets to test membership must be arrays")
+    end
+
+    it "should raise an exception if a value is not in the given set" do
+      conf_file = conf_path + '/not_a_member'
+      lambda{conf = TestJeckyl.new(conf_file)}.should raise_error(Jeckyl::ConfigError, /^\[log_level\]:.*is not a member of:/)
+    end
+
+
+  end
+
+  describe "Operating in a more relaxed mode" do
+
+    # leave at the end or you need to re-strict Jeckyl.
+    it "should load any parameter if its not being strict" do
+      conf_file = conf_path + '/sloppy_params'
+      conf = TestJeckyl.new(conf_file, :relax=>true)
+      conf[:my_age].should == 50
+    end
+
+  end
+  
+  describe "find the parameters for a specific class" do
+    it "should sift out the parameters" do
+      bconf = File.join(conf_path, 'bclass.rb')
+      opts = Bclass.new(bconf)
+      opts.length.should == 4
+      subopts = Aclass.intersection(opts)
+      subopts.length.should ==2
+      subopts.has_key?(:a_bool).should be_true
+      subopts.has_key?(:no_def).should be_true
+      opts.complement(subopts)
+      opts.length.should == 2
+      opts.has_key?(:config_files).should be_true
+      opts.has_key?(:another).should be_true
+    end
+  end
+  
+  describe "Merging config files" do
+    it "should merge another config file" do
+      conf_file = conf_path + '/jeckyl'
+      conf = TestJeckyl.new(conf_file)
+      conf.merge File.join(conf_path, 'merger.rb')      
+      conf[:log_dir].should match(/reports$/)
+      conf[:log_level].should == :debug
+      conf[:log_rotation].should == 6
+      conf[:email].should == "robert@osburn-associates.ath.cx"
+      conf[:config_files].length.should == 2
+      conf[:pi].should == 3.14592
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jeckyl'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :doc
+
+end

data/test/conf.d/a_few_params

@@ -0,0 +1,2 @@
+
+log_level :debug

data/test/conf.d/bad_filename

@@ -0,0 +1,2 @@
+
+log_dir '/never/going/to/exist'

data/test/conf.d/bclass.rb

@@ -0,0 +1,2 @@
+a_bool false
+no_def "Its a problem"

data/test/conf.d/jeckyl

@@ -0,0 +1,46 @@
+#
+# Jeckyl test file
+#
+
+# should be a writable directory
+log_dir "./test"
+
+#should be a valid symbol
+log_level :verbose
+
+# should be an integer
+log_rotation 5
+
+# can be a float or any numeric
+threshold 5.6
+threshold 10
+
+# must be a float
+pi 3.14592
+
+# array of anything
+collection ["names", 1, true ]
+# array of integers
+sieve [2, 5, 7, 10, 15]
+
+# hash of anything
+my_opts = {:peter=>37, :paul=>40, :birds=>true}
+options my_opts
+
+# string formatted as email address
+email "robert@osburn-sharp.ath.cx"
+
+# real booleans
+debug false
+debug true
+
+# generous booleans
+flag "true"
+flag "false"
+flag "off"
+flag "on"
+flag "yes"
+flag "no"
+flag 1
+flag 0
+

data/test/conf.d/jeckyl_check

@@ -0,0 +1,46 @@
+#
+# Jeckyl test file
+#
+
+# should be a writable directory
+log_dir "jeckyl/test"
+
+#should be a valid symbol
+log_level :verbose
+
+# should be an integer
+log_rotation 5
+
+# can be a float or any numeric
+threshold 5.6
+threshold 10
+
+# must be a float
+pi 3.14592
+
+# array of anything
+collection ["names", 1, true ]
+# array of integers
+sieve [2, 5, 7, 10, 15]
+
+# hash of anything
+my_opts = {:peter=>37, :paul=>40, :birds=>true}
+options my_opts
+
+# string formatted as email address
+email "robert@osburn-sharp.ath.cx"
+
+# real booleans
+debug false
+debug true
+
+# generous booleans
+flag "true"
+flag "false"
+flag "off"
+flag "on"
+flag "yes"
+flag "no"
+flag 1
+flag 0
+

data/test/conf.d/merger.rb

@@ -0,0 +1,31 @@
+#
+# Jeckyl test file
+#
+
+# should be a writable directory
+log_dir "./test/reports"
+
+#should be a valid symbol
+log_level :debug
+
+# should be an integer
+log_rotation 6
+
+# can be a float or any numeric
+threshold 5.6
+threshold 10
+
+# must be a float
+pi 3.14592
+
+# array of anything
+collection ["names", 1, true ]
+# array of integers
+sieve [2, 5, 7, 10, 15]
+
+# hash of anything
+my_opts = {:peter=>37, :paul=>40, :birds=>true}
+options my_opts
+
+# string formatted as email address
+email "robert@osburn-associates.ath.cx"

data/test/conf.d/no_such_file

@@ -0,0 +1,2 @@
+
+key_file "../test/key_file.asc"

data/test/conf.d/not_a_bool

@@ -0,0 +1 @@
+debug "true"

data/test/conf.d/not_a_flag

@@ -0,0 +1 @@
+flag "maybe"

data/test/conf.d/not_a_float

@@ -0,0 +1 @@
+pi 3

data/test/conf.d/not_a_hash

@@ -0,0 +1 @@
+options "string"

data/test/conf.d/not_a_member

@@ -0,0 +1 @@
+log_level :turgid

data/test/conf.d/not_a_pattern

@@ -0,0 +1 @@
+invalid_pattern "robert@osburn-sharp.ath.cx"

data/test/conf.d/not_a_set

@@ -0,0 +1 @@
+invalid_set :verbose

data/test/conf.d/not_a_string

@@ -0,0 +1 @@
+email 12.0

data/test/conf.d/not_an_array

@@ -0,0 +1 @@
+collection "String"

data/test/conf.d/not_an_email

@@ -0,0 +1 @@
+email "robert-osburn-sharp"

data/test/conf.d/not_an_integer_array

@@ -0,0 +1 @@
+sieve [1, 2, 3, "4", 5]

data/test/conf.d/out_of_range

@@ -0,0 +1 @@
+log_rotation 100

data/test/conf.d/sloppy_params

@@ -0,0 +1,5 @@
+anything_goes true
+
+my_age 50
+
+great_things_to_do "Naturism"

data/test/conf.d/syntax_error

@@ -0,0 +1,3 @@
+
+log_dir "unfinished string
+

data/test/conf.d/unknown_param

@@ -0,0 +1,2 @@
+
+unusual_value "Not likely to be recognised"

data/test/conf.d/unwritable_dir

@@ -0,0 +1 @@
+log_dir "/home/robert/dev/projects/jeckyl/test/unwritable"

data/test/conf.d/wrong_type

@@ -0,0 +1,2 @@
+
+log_rotation 5.6

data/test/reports/not_ok.txt

@@ -0,0 +1 @@
+[debug]: true - Value is not a Boolean

data/test/reports/ok.txt

@@ -0,0 +1 @@
+No errors found in: /home/robert/dev/projects/jeckyl/test/conf.d/jeckyl

data/test/test_class.rb

@@ -0,0 +1,32 @@
+#
+#
+# = Title
+#
+# == SubTitle
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2011 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+
+#require 'jeckyl'
+
+class Aclass < Jeckyl::Options
+  
+  def configure_a_bool(bool)
+    default true
+    a_boolean(bool)
+  end
+  
+  def configure_no_def(text)
+    a_string(text)
+  end
+  
+end

data/test/test_configurator.rb

@@ -0,0 +1,105 @@
+#
+# Description
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2010 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+# 
+#
+#require 'jeckyl'
+
+class TestJeckyl < Jeckyl::Options
+
+  def prefix
+    'set'
+  end
+  
+  def set_log_dir(path)
+    default '/tmp'
+    comment "Location to write log files to"
+    a_writable_dir(path)
+  end
+
+  def set_key_file(path)
+    comment "key file to be used to check secure commands"
+    a_readable_file(path)
+  end
+
+  def set_log_level(symb)
+    default :verbose
+    comment "Log level can one of the following:",
+       "",
+       " * :system - log all important messages and use syslog",
+       " * :verbose - be more generous with logging to help resolve problems"
+    symbol_set = [:system, :verbose, :debug]
+    a_member_of(symb, symbol_set)
+  end
+
+  def set_log_rotation(val)
+    default 5
+    a_type_of(val, Integer)
+    in_range(val, 0, 20)
+  end
+
+  def set_threshold(val)
+    default 5.0
+    # make sure it is a number
+    a_type_of(val, Numeric)
+    # now make sure it is a float
+    in_range(val.to_f, 0.0, 10.0)
+
+  end
+
+  def set_pi(val)
+    default 3.14
+    a_type_of(val, Float)
+  end
+
+  def set_debug(bool)
+    default false
+    a_boolean(bool)
+  end
+
+  def set_flag(flag)
+    default "on"
+    a_flag(flag)
+  end
+
+  def set_collection(ary)
+    default Array.new
+    an_array(ary)
+  end
+  
+  def set_sieve(ary)
+    default [1,2,3]
+    an_array_of(ary, Integer)
+  end
+
+  def set_options(opts)
+    default Hash.new
+    a_hash(opts)
+  end
+
+  def set_email(email)
+    default "me@home.org.uk"
+    a_matching_string(email, /^[a-z]+\@[a-z][a-z\-\.]+[a-z]$/)
+  end
+
+#  def set_invalid_set(member)
+#    default 1
+#    invalid_set = {:one=>1, :two=>2, :three=>3}
+#    a_member_of(member, invalid_set)
+#  end
+#
+#  def set_invalid_pattern(email)
+#    default "me@work.org.uk"
+#    pattern = "email"
+#    a_matching_string(email, pattern)
+#  end
+
+end

data/test/test_configurator_errors.rb

@@ -0,0 +1,105 @@
+#
+# Description
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2010 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+# 
+#
+#require 'jeckyl'
+
+class TestJeckylErrors < Jeckyl::Options
+
+  def prefix
+    'set'
+  end
+  
+  def set_log_dir(path)
+    default '/tmp'
+    comment "Location to write log files to"
+    a_writable_dir(path)
+  end
+
+  def set_key_file(path)
+    comment "key file to be used to check secure commands"
+    a_readable_file(path)
+  end
+
+  def set_log_level(symb)
+    default :verbose
+    comment "Log level can one of the following:",
+       "",
+       " * :system - log all important messages and use syslog",
+       " * :verbose - be more generous with logging to help resolve problems"
+    symbol_set = [:system, :verbose, :debug]
+    a_member_of(symb, symbol_set)
+  end
+
+  def set_log_rotation(val)
+    default 5
+    a_type_of(val, Integer)
+    in_range(val, 0, 20)
+  end
+
+  def set_threshold(val)
+    default 5.0
+    # make sure it is a number
+    a_type_of(val, Numeric)
+    # now make sure it is a float
+    in_range(val.to_f, 0.0, 10.0)
+
+  end
+
+  def set_pi(val)
+    default 3.14
+    a_type_of(val, Float)
+  end
+
+  def set_debug(bool)
+    default false
+    a_boolean(bool)
+  end
+
+  def set_flag(flag)
+    default "on"
+    a_flag(flag)
+  end
+
+  def set_collection(ary)
+    default Array.new
+    an_array(ary)
+  end
+  
+  def set_sieve(ary)
+    default [1,2,3]
+    an_array_of(ary, Integer)
+  end
+
+  def set_options(opts)
+    default Hash.new
+    a_hash(opts)
+  end
+
+  def set_email(email)
+    default "me@home.org.uk"
+    a_matching_string(email, /^[a-z]+\@[a-z][a-z\-\.]+[a-z]$/)
+  end
+
+  def set_invalid_set(member)
+    default 1
+    invalid_set = {:one=>1, :two=>2, :three=>3}
+    a_member_of(member, invalid_set)
+  end
+
+  def set_invalid_pattern(email)
+    default "me@work.org.uk"
+    pattern = "email"
+    a_matching_string(email, pattern)
+  end
+
+end

data/test/test_subclass.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), 'test_class')
+
+class Bclass < Aclass
+  
+  def configure_another(text)
+    default "Hey"
+    a_string(text)
+    
+  end
+  
+end