yacl 1.0.0

data/spec/define/cli/options_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'yacl/define/cli/options'
+
+module Yacl::Spec::Define
+  class OptionsTest < ::Yacl::Define::Cli::Options
+    opt 'pipeline.dir', :long => 'pipeline-dir', :short => 'd', :description => "The pipeline directory we are using"
+    opt 'timelimit'   , :long => 'time-limit',   :short => 't', :description => "The amount of time to run for"
+    opt 'system'      , :long => 'system',       :short => 's', :description => "The system setting"
+  end
+
+  #class OptionsWithBannerTest < OptionsTest
+    #banner "MyApp version 4.2"
+  #end
+end
+
+
+
+describe Yacl::Define::Cli::Options do
+
+  it "has all the options listed in the class" do
+    Yacl::Spec::Define::OptionsTest.opt_list.size.must_equal 3
+  end
+
+  it "keeps the options in listed order" do
+    Yacl::Spec::Define::OptionsTest.opt_list.map { |o| o.property_name }.must_equal  %w[ pipeline.dir timelimit system ]
+  end
+
+  it "implements each" do
+    ot = Yacl::Spec::Define::OptionsTest.new
+    gather = []
+    ot.each do |op|
+      gather << op.property_name
+    end
+    gather.must_equal %w[ pipeline.dir timelimit system ]
+
+  end
+
+  it "returns the properties of the options" do
+    ot = Yacl::Spec::Define::OptionsTest.new( 'pipeline-dir' => "/var/log/", "time-limit" => 40, "system" => "foo" )
+    props = ot.properties
+    props.pipeline.dir.must_equal '/var/log/'
+    props.timelimit.must_equal 40
+    props.system.must_equal 'foo'
+  end
+
+end
+

data/spec/define/cli/parser_spec.rb

@@ -0,0 +1,64 @@
+require 'yacl/define/cli/parser'
+
+module Yacl::Spec::Define
+  class OptionsForParserTest < ::Yacl::Define::Cli::Options
+    opt 'pipeline.dir', :long => 'pipeline-dir', :short => 'd', :description => "The pipeline directory we are using", :cast => :string
+    opt 'timelimit'   , :long => 'time-limit',   :short => 't', :description => "The amount of time to run for", :cast => :int
+    opt 'system'      , :long => 'system',       :short => 's', :description => "The system setting", :cast => :string
+  end
+
+  class ParserTest < ::Yacl::Define::Cli::Parser
+    options OptionsForParserTest
+  end
+
+  class ParserWithBannerTest < ::Yacl::Define::Cli::Parser
+    banner "MyApp version 4.2"
+    options OptionsForParserTest
+  end
+
+  class ParserWithOptions < ::Yacl::Define::Cli::Parser
+    banner "MyApp version 4.3"
+    opt 'pipeline.dir', :long => 'pipeline-dir', :short => 'd', :description => "The pipeline directory we are using", :cast => :string
+    opt 'timelimit'   , :long => 'time-limit',   :short => 't', :description => "The amount of time to run for", :cast => :int
+    opt 'system'      , :long => 'system',       :short => 's', :description => "The system setting", :cast => :string
+  end
+
+end
+
+describe Yacl::Define::Cli::Parser do
+
+  it "has a default banner" do
+    bt = Yacl::Spec::Define::ParserTest.new
+    bt.banner.must_match( /Usage.*Options:/m )
+  end
+
+  it "can set a banner" do
+    bt = Yacl::Spec::Define::ParserWithBannerTest.new
+    bt.banner.must_equal 'MyApp version 4.2'
+  end
+
+  it "can set the options class" do
+    Yacl::Spec::Define::ParserTest.options.must_equal Yacl::Spec::Define::OptionsForParserTest
+  end
+
+  it "creates a Properties instance from parsing the commandline" do
+    argv = [ '--pipeline-dir' , Dir.pwd, '--time-limit' , "42", '--system', 'out-of-this-world' ]
+    p = Yacl::Spec::Define::ParserTest.new( :argv => argv )
+    props = p.properties
+    props.pipeline.dir.must_equal Dir.pwd
+    props.timelimit.must_equal 42
+    props.system.must_equal 'out-of-this-world'
+  end
+
+  it "can define the commanline options internall without a separate Options class" do
+    argv = [ '--pipeline-dir' , Dir.pwd, '--time-limit' , "42", '--system', 'out-of-this-world' ]
+
+    p = Yacl::Spec::Define::ParserWithOptions.new( :argv => argv )
+    p.banner.must_equal 'MyApp version 4.3'
+    props = p.properties
+    props.pipeline.dir.must_equal Dir.pwd
+    props.timelimit.must_equal 42
+    props.system.must_equal 'out-of-this-world'
+  end
+
+end

data/spec/define/cli/runner_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'yacl/define/cli/runner'
+
+module Yacl::Spec::Define::Cli
+  class OptionsForRunner < ::Yacl::Define::Cli::Options
+    opt 'pipeline.dir', :long => 'pipeline-dir', :short => 'd', :description => "The pipeline directory we are using", :cast => :string
+    opt 'timelimit'   , :long => 'time-limit',   :short => 't', :description => "The amount of time to run for", :cast => :int
+    opt 'system'      , :long => 'system',       :short => 's', :description => "The system setting", :cast => :string
+    opt 'config.dir'  , :long => 'config-dir'  , :short => 'c', :description => "The configuration directory we are using", :cast => :string
+  end
+
+  class ParserForRunner < ::Yacl::Define::Cli::Parser
+    options OptionsForRunner
+  end
+
+  class DefaultsForRunner < ::Yacl::Define::Defaults
+    default 'host.name', 'localhost'
+    default 'host.port',  80
+  end
+
+  class PlanForRunner < ::Yacl::Define::Plan
+    try ParserForRunner
+    try DefaultsForRunner
+  end
+
+  class Runner < ::Yacl::Define::Cli::Runner
+    plan PlanForRunner
+
+    def run
+      42
+    end
+
+  end
+
+
+end
+
+describe Yacl::Define::Cli::Runner do
+
+  it "raises an error if no plan is defined" do
+    class BadRunner < ::Yacl::Define::Cli::Runner
+      plan nil
+    end
+
+    lambda { BadRunner.go }.must_raise ::Yacl::Define::Cli::Runner::Error
+  end
+
+  it "executes the run method defined in the Runner child class" do
+    r = Yacl::Spec::Define::Cli::Runner.go
+    r.must_equal 42
+  end
+
+  it "loads the propertes in the plan into the runner" do
+    r = Yacl::Spec::Define::Cli::Runner.new
+    r.properties.host.port.must_equal 80
+  end
+end

data/spec/define/defaults_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'yacl/define/defaults'
+
+module Yacl::Spec::Define
+  class DefaultsTest < ::Yacl::Define::Defaults
+    default 'host.name', 'localhost'
+    default 'host.port',  80
+  end
+end
+
+describe Yacl::Define::Defaults do
+  before do
+    @dt = Yacl::Spec::Define::DefaultsTest.new
+  end
+
+  it "allows for instance level access to the defaults" do
+    @dt.host.name.must_equal 'localhost'
+    @dt.host.port.must_equal 80
+  end
+
+  #it "does not allow for the setting of default values" do
+  #  lambda { @dt.set( 'host.foo', 'bar' ) }.must_raise Yacl::Define::Defaults::Error
+  #end
+end

data/spec/define/plan_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'yacl/define/plan'
+
+module Yacl::Spec::Define
+  class OptionsForPlan < ::Yacl::Define::Cli::Options
+    opt 'pipeline.dir', :long => 'pipeline-dir', :short => 'd', :description => "The pipeline directory we are using", :cast => :string
+    opt 'timelimit'   , :long => 'time-limit',   :short => 't', :description => "The amount of time to run for", :cast => :int
+    opt 'system'      , :long => 'system',       :short => 's', :description => "The system setting", :cast => :string
+    opt 'config.dir'  , :long => 'config-dir'  , :short => 'c', :description => "The configuration directory we are using", :cast => :string
+  end
+
+  class ParserForPlan < ::Yacl::Define::Cli::Parser
+    options OptionsForPlan
+  end
+
+  class DefaultsForPlan < ::Yacl::Define::Defaults
+    default 'host.name', 'localhost'
+    default 'host.port',  80
+  end
+
+  class Plan < ::Yacl::Define::Plan
+    try ParserForPlan
+    try Yacl::Loader::YamlDir, :parameter => 'config.dir'
+    try DefaultsForPlan
+  end
+
+
+end
+
+describe Yacl::Define::Plan do
+  before do
+    @config_dir = Yacl::Spec::Helpers.spec_dir( 'data/yaml_dir' )
+    @argv = [ '--pipeline-dir' , Dir.pwd,
+              '--time-limit' , "42",
+              '--system', 'out-of-this-world',
+              '--config-dir' , @config_dir
+            ]
+  end
+
+  it "loads properties from the try locations" do
+    p = Yacl::Spec::Define::Plan.new( :argv => @argv )
+    props = p.properties
+    props.host.name.must_equal 'localhost'
+    props.host.port.must_equal 80
+    props.system.must_equal 'out-of-this-world'
+  end
+
+  it "raises an error when there is an error in loading properties" do
+    lambda { Yacl::Spec::Define::Plan.new }.must_raise Yacl::Loader::YamlDir::Error
+  end
+
+  it "raises an error if you call #on_error and one is not defined" do
+    lambda { Yacl::Spec::Define::Plan.on_error }.must_raise ::Yacl::Define::Plan::Error
+  end
+
+  it "can define an on_error block" do
+    class PlanWithErrorBlock < Yacl::Define::Plan
+      class MyError < ::StandardError; end
+      try Yacl::Loader::YamlDir, :parameter => 'config.dir'
+      on_error do |exception|
+        raise MyError, "KABOOM!"
+      end
+    end
+
+    lambda { PlanWithErrorBlock.new }.must_raise PlanWithErrorBlock::MyError
+  end
+
+  it "can define an on_error callable" do
+    class PlanWithErrorCallable < Yacl::Define::Plan
+      class MyError < ::StandardError; end
+      try Yacl::Loader::YamlDir, :parameter => 'config.dir'
+      on_error Proc.new{ raise MyError, "from a proc!" }
+    end
+    lambda { PlanWithErrorCallable.new }.must_raise PlanWithErrorCallable::MyError
+  end
+
+end

data/spec/loader/env_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Yacl::Loader::Env do
+  it "returns a config containing properties" do
+    env = { 'MY_APP_A' => 'foo', 'MY_APP_B' => 'bar' }
+    e = Yacl::Loader::Env.new( :env => env, :prefix => "MY_APP" )
+    p = e.properties
+    p.a.must_equal 'foo'
+    p.b.must_equal 'bar'
+  end
+
+  it "raises an error if no prefix is given" do
+    env = { 'MY_APP_A' => 'foo', 'MY_APP_B' => 'bar', "SOMETHING_ELSE" => 'baz' }
+    lambda { Yacl::Loader::Env.new( :env => env ) }.must_raise Yacl::Loader::Env::Error
+  end
+
+  it "uses only those keys with the given prefix and strips that prefix" do
+    env = { 'MY_APP_A' => 'foo', 'MY_APP_B' => 'bar', "SOMETHING_ELSE" => 'baz' }
+    e = Yacl::Loader::Env.new( :env => env, :prefix => "my.app" )
+    p = e.properties
+    p.a.must_equal 'foo'
+    p.b.must_equal 'bar'
+    p.has_key?('c').must_equal false
+  end
+
+  it "does okay if there are no keys" do
+    env = { 'MY_APP_A' => 'foo', 'MY_APP_B' => 'bar', "SOMETHING_ELSE" => 'baz' }
+    e = Yacl::Loader::Env.new( :env => env, :prefix => "WIBBLE_FOO_BAR" )
+    p = e.properties
+    p.has_key?('c').must_equal false
+  end
+end

data/spec/loader/yaml_dir_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Yacl::Loader::YamlDir do
+  before do
+    @yaml_dir = Yacl::Spec::Helpers.spec_dir( 'data', 'yaml_dir' )
+  end
+
+  it "returns a config containing properties" do
+    e = Yacl::Loader::YamlDir.new( :path => @yaml_dir )
+    c = e.properties
+    c.httpserver.port.must_equal 4321
+    c.database.username.must_equal "myusername"
+    c.database.subpart.baz.must_equal 'wibble'
+  end
+
+  it "raises an error if the directory does not exist" do
+    lambda { Yacl::Loader::YamlDir.new( :path => "/does/not/exist" ).properties }.must_raise Yacl::Loader::YamlDir::Error
+  end
+
+  it "can lookup the directory in the passed through configuration if it is not given" do
+    cfg = Yacl::Properties.new( 'directory' => @yaml_dir )
+    e = Yacl::Loader::YamlDir.new( :properties => cfg, :parameter  => 'directory' )
+    c = e.properties
+    c.httpserver.port.must_equal 4321
+    c.database.username.must_equal "myusername"
+    c.database.subpart.baz.must_equal 'wibble'
+  end
+
+  it "raises an error if no directory was given and it was unable to look it up in a configuration" do
+    lambda { Yacl::Loader::YamlDir.new( :parameter => "directory" ).properties }.must_raise Yacl::Loader::YamlDir::Error
+  end
+
+  it "raises an error if no directory was given and it was unable to look it up in a configuration" do
+    cfg = Yacl::Properties.new( 'directory' => @yaml_dir )
+    lambda { Yacl::Loader::YamlDir.new( :properties => cfg ).properties }.must_raise Yacl::Loader::YamlDir::Error
+  end
+
+  it "raises an error if no directory was given and the value in the configuration doesn't exist" do
+    cfg = Yacl::Properties.new( 'path' => @yaml_dir )
+    lambda { Yacl::Loader::YamlDir.new( :properties => cfg, :parameter => 'my.path' ).properties }.must_raise Yacl::Loader::YamlDir::Error
+  end
+
+end

data/spec/loader/yaml_file_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Yacl::Loader::YamlFile do
+  before do
+    @yaml_contents = <<_yml_
+a: foo
+b: bar
+_yml_
+    @tmpdir    = Dir.mktmpdir
+    @yaml_file = File.join( @tmpdir, "ytest.yml" )
+    Yacl::Spec::Helpers.tmpfile_with_contents( @yaml_file, @yaml_contents )
+
+    @scoped_file = File.join( @tmpdir, "yscoped.yml" )
+    Yacl::Spec::Helpers.tmpfile_with_contents( @scoped_file, <<_eob_ )
+development:
+  a: foo
+  b: bar
+production:
+  a: baz
+  b: wibble
+_eob_
+
+
+  end
+
+  after do
+    FileUtils.rm_rf( @tmpdir ) if @tmpdir
+  end
+
+  it "returns a config containing properties" do
+    e = Yacl::Loader::YamlFile.new( :path => @yaml_file )
+    p = e.properties
+    p['a'].must_equal 'foo'
+    p.a.must_equal 'foo'
+    p['b'].must_equal 'bar'
+    p.b.must_equal 'bar'
+  end
+
+  it "can lookup the file in the passed through configuration if it is not given" do
+    cfg = Yacl::Properties.new( 'filename' => @yaml_file )
+    e = Yacl::Loader::YamlFile.new( :properties => cfg, :parameter  => 'filename' )
+    p = e.properties
+    p.a.must_equal 'foo'
+    p.b.must_equal 'bar'
+  end
+
+
+  it "raises an error if the file does not exist" do
+    lambda { Yacl::Loader::YamlFile.new( :path => "/does/not/exist" ).properties }.must_raise Yacl::Loader::YamlFile::Error
+  end
+
+  it "raises an error if the file is not readable" do
+    File.chmod( 0000, @yaml_file )
+    lambda { Yacl::Loader::YamlFile.new( :path => @yaml_file ).properties }.must_raise Yacl::Loader::YamlFile::Error
+    File.chmod( 0400, @yaml_file )
+  end
+
+  it "raises an error if the file is not a top level hash" do
+    bad_file = File.join( @tmpdir, "notahash.yml" )
+    Yacl::Spec::Helpers.tmpfile_with_contents( bad_file, <<_eob_ )
+- a: foo
+- b: bar
+_eob_
+    lambda { Yacl::Loader::YamlFile.new( :path => bad_file ).properties }.must_raise Yacl::Loader::YamlFile::Error
+  end
+
+  it "returns a scoped config containing properties" do
+    e = Yacl::Loader::YamlFile.new( :path => @scoped_file, :scope => "production" )
+    p = e.properties
+    p['a'].must_equal 'baz'
+    p.a.must_equal 'baz'
+    p['b'].must_equal 'wibble'
+    p.b.must_equal 'wibble'
+  end
+
+  it "raises an error if the scoped config does not contain the scoped key" do
+    lambda { Yacl::Loader::YamlFile.new( :path => @scoped_file, :scope => "badscope" ).properties }.must_raise Yacl::Loader::YamlFile::Error
+  end
+
+end

data/spec/loader_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'yacl/loader'
+
+describe 'Yacl::Loader' do
+  before do
+    @loader = Yacl::Loader.new( :foo => 'bar', :baz => 'wibble' )
+  end
+  it "is initialized with options" do
+    @loader.options[:foo].must_equal 'bar'
+  end
+
+  it "returns a Properties instance" do
+    p = @loader.properties
+    p.length.must_equal 0
+  end
+end