configtoolkit 1.0.0

data/test/sample.standard_yaml_types.yaml

@@ -0,0 +1,21 @@
+--- 
+opt_integer: 56
+req_uri: http://blogs.designingpatterns.com
+req_float: 3.14
+req_pathname: /usr/designingpatterns/bin
+req_integer: 6
+req_string: sample string2
+req_boolean: true
+req_symbol: sample_symbol2
+req_big_integer: 90000000000
+nested_config: 
+  req_nested_array: 
+  - req_second_nested_pathname: /usr/designingpatterns/Applications/pattmake
+    req_second_nested_array: 
+    - 6
+    - 20
+  - req_second_nested_pathname: /usr
+    req_second_nested_array: 
+    - 205
+    - 206
+  req_nested_integer: 34

data/test/test_baseconfig.rb

@@ -0,0 +1,292 @@
+#!/usr/bin/env ruby
+
+require 'common'
+
+require 'configtoolkit'
+require 'configtoolkit/yamlreader'
+require 'configtoolkit/yamlwriter'
+
+require 'pathname'
+require 'test/unit'
+
+class ConstrainedArrayTest < Test::Unit::TestCase
+  def verify_class_attributes(array_class, expected_attribute_values)
+    expected_attribute_values.each do |attribute, attribute_value|
+      assert_equal(attribute_value, array_class.send(attribute))
+    end
+  end
+
+  def test_new
+    verify_class_attributes(ConfigToolkit::ConstrainedArray.new(Integer, 1, 2),
+                            {
+                              :element_class => Integer,
+                              :min_num_elements => 1,
+                              :max_num_elements => 2
+                            })
+
+    verify_class_attributes(ConfigToolkit::ConstrainedArray.new(Integer),
+                            {
+                              :element_class => Integer,
+                              :min_num_elements => nil,
+                              :max_num_elements => nil
+                            })
+
+    verify_class_attributes(ConfigToolkit::ConstrainedArray.new(String, 1),
+                            {
+                              :element_class => String,
+                              :min_num_elements => 1,
+                              :max_num_elements => nil
+                            })
+  end
+end
+
+class BaseConfigTest < Test::Unit::TestCase
+  #
+  # This config class will be used in the tests.
+  # Note that it has a:
+  # 1.) optional parameter (:behind_firewall)
+  # 2.) A ConfigToolkit::Boolean parameter
+  # 3.) A ConstrainedArray parameter
+  #
+  class MachineConfig < ConfigToolkit::BaseConfig
+    add_required_param(:name, String)
+
+    add_required_param(:architecture, String)
+
+    add_required_param(:os, String)
+
+    add_required_param(:num_cpus, Integer) do |value|
+      if(value <= 0)
+        raise_error("num_cpus must be greater than zero")
+      end
+    end
+
+    add_optional_param(:behind_firewall, ConfigToolkit::Boolean, true)
+
+    add_required_param(:contains_sensitive_data, ConfigToolkit::Boolean)
+
+    add_required_param(:addresses, ConfigToolkit::ConstrainedArray.new(URI, 2, 3))
+
+    def validate_all_values
+      if(contains_sensitive_data && !behind_firewall)
+        raise_error("a machine cannot contain sensitive data and not be behind the firewall")
+      end
+    end
+  end
+
+  MACHINES_CONFIG_FILE_NAME = get_test_config_file_name("machines.yaml")
+
+  #
+  # Test whether the methods for MachineConfig's attributes
+  # were generated properly.
+  #
+  def test_attribute_method_generation
+    config = MachineConfig.new()
+
+    config_param_values = {
+      :name => "pear",
+      :architecture => "x86_64",
+      :os => "FreeBSD",
+      :num_cpus => 8,
+      :behind_firewall => true,
+      :contains_sensitive_data => true,
+      :addresses => [
+                     URI("http://release.designingpatterns.com"),
+                     URI("http://pear.designingpatterns.com")
+                    ]
+    }
+
+    #
+    # Iterate through the hash and check that the setters and
+    # getters for each parameter work properly.
+    #
+    config_param_values.each do |param_name, param_value|
+      assert_equal(nil, config.send(param_name))
+      setter = "#{param_name}=".to_sym()
+      config.send(setter, param_value)
+      assert_equal(param_value, config.send(param_name))
+    end
+
+    puts config
+  end
+
+  def verify_param_values(config, expected_config_param_values)
+    expected_config_param_values.each do |param_name, param_value|
+      assert_equal(param_value, config.send(param_name))
+    end
+  end
+
+  def verify_correct_dump(config_file_name, containing_object_name)
+    reader = ConfigToolkit::YAMLReader.new(config_file_name)
+    config = MachineConfig.load(reader, containing_object_name)
+
+    dump_stream = StringIO.new()
+    writer = ConfigToolkit::YAMLWriter.new(dump_stream, true)
+    config.dump(writer)
+    
+    puts dump_stream.string()
+
+    dump_stream.rewind()
+    dump_reader = ConfigToolkit::YAMLReader.new(dump_stream)
+    assert_equal(config, MachineConfig.load(dump_reader, containing_object_name))
+  end
+
+  def verify_dump_error(config, message)
+    dump_stream = StringIO.new()
+    writer = ConfigToolkit::YAMLWriter.new(dump_stream, true)
+    
+    rescued_exception = false
+    begin
+      config.dump(writer)
+    rescue ConfigToolkit::Error => e
+      assert_equal(message, e.message)
+      rescued_exception = true
+    end
+
+    assert(rescued_exception)
+  end
+
+  def test_dump
+    verify_correct_dump(get_test_config_file_name("firewall.yaml"), "firewall")
+    verify_correct_dump(get_test_config_file_name("webserver.yaml"), "")
+
+    #
+    # Verify that dumping a config sets the config's optional
+    # parameters to their default values.
+    #
+    config = MachineConfig.new()
+    config.name = "jackfruit"
+    config.architecture = "powerpc"
+    config.os = "AIX"
+    config.contains_sensitive_data = true
+    config.num_cpus = 2
+    config.addresses = ["http://jackfruit.designingpatterns.com", "http://www3.designingpatterns.com"]
+    dump_stream = StringIO.new()
+    writer = ConfigToolkit::YAMLWriter.new(dump_stream, true)
+    assert_equal(nil, config.behind_firewall)
+    config.dump(dump_stream)
+    assert_equal(true, config.behind_firewall)
+
+    config = MachineConfig.new()
+    config.name = "uniq"
+    verify_dump_error(config, "missing parameter(s): architecture, os, num_cpus, contains_sensitive_data, addresses")
+
+    config.architecture = "powerpc"
+    config.os = "AIX"
+    config.contains_sensitive_data = true
+    config.behind_firewall = false
+    config.num_cpus = 2
+    config.addresses = ["http://uniq.designingpatterns.com", "http://ftp.designingpatterns.com"]
+    verify_dump_error(config, "BaseConfigTest::MachineConfig#validate_all_values dump error: a machine cannot contain sensitive data and not be behind the firewall")
+  end
+
+  def verify_correct_load(config_file_name,
+                          containing_object_name,
+                          expected_param_values)
+    reader = ConfigToolkit::YAMLReader.new(config_file_name)
+    config = MachineConfig.load(reader, containing_object_name)
+    verify_param_values(config, expected_param_values)
+    puts config
+  end
+
+  def verify_load_error(config_file_name, containing_object_name, message)
+    reader = ConfigToolkit::YAMLReader.new(config_file_name)
+    
+    rescued_exception = false
+    begin
+      config = MachineConfig.load(reader, containing_object_name)
+    rescue ConfigToolkit::Error => e
+      assert_equal(message, e.message)
+      rescued_exception = true
+    end
+
+    assert(rescued_exception)
+  end
+
+  #
+  # Test whether a canned config file can be load correctly (whether
+  # the config instances ends up having the expected values).
+  #
+  def test_load
+    verify_correct_load(MACHINES_CONFIG_FILE_NAME, "", {
+                          :name => "apple",
+                          :architecture => "powerpc",
+                          :os => "AIX",
+                          :num_cpus => 32,
+                          :behind_firewall => false,
+                          :contains_sensitive_data => false,
+                          :addresses =>
+                          [
+                           URI("http://default.designingpatterns.com"),
+                           URI("http://apple.designingpatterns.com")
+                          ]
+                        })
+
+    verify_correct_load(MACHINES_CONFIG_FILE_NAME, "production", {
+                          :name => "orange",
+                          :architecture => "ultrasparc",
+                          :os => "Solaris",
+                          :num_cpus => 64,
+                          :behind_firewall => true,
+                          :contains_sensitive_data => true,
+                          :addresses => 
+                          [
+                           URI("http://production.designingpatterns.com"),
+                           URI("http://orange.designingpatterns.com")
+                          ]
+                        })
+
+    verify_correct_load(MACHINES_CONFIG_FILE_NAME, "test", {
+                          :name => "bananna",
+                          :architecture => "itanium",
+                          :os => "Linux",
+                          :num_cpus => 16,
+                          :behind_firewall => true,
+                          :contains_sensitive_data => false,
+                          :addresses =>
+                          [
+                           URI("http://test.designingpatterns.com"),
+                           URI("http://bananna.designingpatterns.com")
+                          ]
+                        })
+  end
+
+  def test_load_errors
+    verify_load_error(get_test_config_file_name("bad_config.yaml"),
+                      "",
+                      "ConfigToolkit::YAMLReader#read returned Array rather than Hash")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_containing_object",
+                      "error: BaseConfigTest::MachineConfig#load found Fixnum rather than Hash when reading the bad_containing_object containing object")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "missing_num_cpus",
+                      "missing parameter(s): missing_num_cpus.num_cpus")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "missing_name_and_num_cpus",
+                      "missing parameter(s): missing_name_and_num_cpus.name, missing_name_and_num_cpus.num_cpus")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_num_cpus",
+                      "error setting parameter bad_num_cpus.num_cpus with value -2: num_cpus must be greater than zero.")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_addresses_element_type",
+                      "error setting parameter bad_addresses_element_type.addresses[0] with value 2: cannot convert from value class Fixnum to specified class URI.")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_addresses_max_num_elements",
+                      "error setting parameter bad_addresses_max_num_elements.addresses with value [http://test.designingpatterns.com, http://bananna.designingpatterns.com, http://fruitsalad.designingpatterns.com, http://parfait.designingpatterns.com]: the number of elements (4) is greater than the specified maximum number of elements (3).")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_addresses_min_num_elements",
+                      "error setting parameter bad_addresses_min_num_elements.addresses with value [http://bananna.designingpatterns.com]: the number of elements (1) is less than the specified minimum number of elements (2).")
+
+    verify_load_error(MACHINES_CONFIG_FILE_NAME,
+                      "bad_contains_sensitive_data_behind_firewall_combo",
+                      "BaseConfigTest::MachineConfig#validate_all_values load error for bad_contains_sensitive_data_behind_firewall_combo: a machine cannot contain sensitive data and not be behind the firewall")
+
+  end
+end

data/test/test_yaml.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+require 'common'
+require 'readerwritertest'
+
+require 'configtoolkit/yamlreader'
+require 'configtoolkit/yamlwriter'
+
+class YAMLTest < Test::Unit::TestCase
+  include ReaderWriterTest
+
+  def test_readers
+    run_reader_test(ConfigToolkit::YAMLReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    get_test_config_file_name("sample.standard_yaml_types.yaml"))
+    
+    run_reader_test(ConfigToolkit::YAMLReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    get_test_config_file_name("sample.ruby_yaml_types.yaml"))
+    
+    run_reader_test(ConfigToolkit::YAMLReader,
+                    "",
+                    REFERENCE_SAMPLE_CONFIG,
+                    File.new(get_test_config_file_name("sample.ruby_yaml_types.yaml"), "r"))
+    
+    run_reader_test(ConfigToolkit::YAMLReader,
+                    "contained_sample",
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    get_test_config_file_name("contained_sample.yaml"))
+  end
+  
+  def test_writers
+    run_writer_test(ConfigToolkit::YAMLWriter,
+                    REFERENCE_SAMPLE_CONFIG,
+                    get_test_config_file_name("sample.standard_yaml_types.yaml"),
+                    get_test_config_file_name("sample.standard_yaml_types.dumped.yaml"),
+                    get_test_config_file_name("sample.standard_yaml_types.dumped.yaml"),
+                    true)
+    
+    run_writer_test(ConfigToolkit::YAMLWriter,
+                    REFERENCE_SAMPLE_CONFIG,
+                    get_test_config_file_name("sample.ruby_yaml_types.yaml"),
+                    get_test_config_file_name("sample.ruby_yaml_types.dumped.yaml"),
+                    get_test_config_file_name("sample.ruby_yaml_types.dumped.yaml"),
+                    false)
+    
+    run_writer_test(ConfigToolkit::YAMLWriter,
+                    REFERENCE_SAMPLE_CONFIG,
+                    get_test_config_file_name("sample.standard_yaml_types.yaml"),
+                    get_test_config_file_name("sample.standard_yaml_types.dumped.yaml"),
+                    File.new(get_test_config_file_name("sample.standard_yaml_types.dumped.yaml"), "w"),
+                    true)
+    
+    run_writer_test(ConfigToolkit::YAMLWriter,
+                    REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                    get_test_config_file_name("contained_sample.yaml"),
+                    get_test_config_file_name("contained_sample.dumped.yaml"),
+                    get_test_config_file_name("contained_sample.dumped.yaml"),
+                    true)
+  end
+  
+  def test_readers_writers
+    run_reader_writer_test(ConfigToolkit::YAMLReader,
+                           ConfigToolkit::YAMLWriter,
+                           REFERENCE_SAMPLE_CONFIG,
+                           [get_test_config_file_name("sample.standard_yaml_types.dumped.yaml")],
+                           [get_test_config_file_name("sample.standard_yaml_types.dumped.yaml"), false])
+    run_reader_writer_test(ConfigToolkit::YAMLReader,
+                           ConfigToolkit::YAMLWriter,
+                           REFERENCE_CONTAINED_SAMPLE_CONFIG,
+                           [get_test_config_file_name("contained_sample.yaml")],
+                           [get_test_config_file_name("contained_sample.dumped.yaml"), true])
+  end
+end

data/test/webserver.yaml

@@ -0,0 +1,9 @@
+name: papaya
+architecture: powerpc
+os: AIX
+num_cpus: 4
+contains_sensitive_data: false
+behind_firewall: false
+addresses:
+  - http://www.designingpatterns.com
+  - http://papaya.designingpatterns.com

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: configtoolkit
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- DesigningPatterns
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-13 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: "This package makes sourcing information from configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be returned from a configuration file.  The toolkit automatically will validate the file's data against this specification when loading the file, ensuring that the specifications always are met and saving the programmer the tedious chore of writing validation code. * Allows programmers to easily programatically create and dump new configuration files. * Provides classes that can load from and dump to different kinds of configuration files, including YAML configuration files."
+email: 
+- technical.inquiries@designingpatterns.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- History.txt
+files: 
+- LICENSE
+- README.txt
+- History.txt
+- Rakefile
+- lib/configtoolkit.rb
+- lib/configtoolkit/baseconfig.rb
+- lib/configtoolkit/toolkit.rb
+- lib/configtoolkit/types.rb
+- lib/configtoolkit/yamlreader.rb
+- lib/configtoolkit/yamlwriter.rb
+- test/common.rb
+- test/readerwritertest.rb
+- test/test_baseconfig.rb
+- test/test_yaml.rb
+- test/bad_config.yaml
+- test/contained_sample.yaml
+- test/firewall.yaml
+- test/machines.yaml
+- test/sample.ruby_yaml_types.yaml
+- test/sample.standard_yaml_types.yaml
+- test/webserver.yaml
+has_rdoc: true
+homepage: http://configtoolkit.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: configtoolkit
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: "This package makes sourcing information from configuration files robust and easy!  It: * Allows programmers to specify the type of data that should be returned from a configuration file"
+test_files: 
+- test/test_baseconfig.rb
+- test/test_yaml.rb