rubber-jcarnegie 0.0.1

data/lib/rubber/util.rb

@@ -0,0 +1,72 @@
+
+
+module Rubber
+  module Util
+
+    def self.symbolize_keys(map)
+      map.inject({}) do |options, (key, value)|
+        options[key.to_sym || key] = value
+        options
+      end
+    end
+    
+    def self.stringify(val)
+      case val
+      when String
+        val
+      when Hash
+        val.inject({}) {|h, a| h[stringify(a[0])] = stringify(a[1]); h}
+      when Enumerable
+        val.collect {|v| stringify(v)}
+      else
+        val.to_s
+      end
+      
+    end
+
+    # Opens the file for writing by root
+    def self.sudo_open(path, perms, &block)
+      open("|sudo tee #{path} > /dev/null", perms, &block)
+    end
+
+    def self.is_rails?
+      File.exist?(File.join(RUBBER_ROOT, 'config', 'boot.rb'))
+    end
+
+    def self.is_rails2?
+      defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 2
+    end
+
+    def self.is_rails3?
+      defined?(Rails) && defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 3
+    end
+
+    def self.is_bundler?
+      File.exist?(File.join(RUBBER_ROOT, 'Gemfile'))
+    end
+
+    def self.rubber_as_plugin?
+      File.exist?(File.join(RUBBER_ROOT, 'vendor/plugins/rubber'))
+    end
+
+    def self.prompt(name, desc, required=false, default=nil)
+      value = ENV.delete(name)
+      msg = "#{desc}"
+      msg << " [#{default}]" if default
+      msg << ": "
+      unless value
+        print msg
+        value = gets
+      end
+      value = value.size == 0 ? default : value
+      self.fatal "#{name} is required, pass using environment or enter at prompt" if required && ! value
+      return value
+    end
+
+    def self.fatal(msg, code=1)
+      puts msg
+      exit code
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+# this file just makes it easy to refer to rubber config
+# variables in your apps's config'
+#
+
+require "rubber"
+Rubber::initialize(Rails.root, Rails.env)

data/test/environment_test.rb

@@ -0,0 +1,144 @@
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'tempfile'
+require File.expand_path(File.join(__FILE__, '..', 'test_helper'))
+
+class EnvironmentTest < Test::Unit::TestCase
+  include Rubber::Configuration
+
+  def test_known_roles
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/basic")
+    assert_equal ['role1', 'role2'], env.known_roles, "list of know roles not correct"
+  end
+
+  def test_env
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/basic")
+    e = env.bind()
+    assert_equal 'val1', e['var1'], 'env not retrieving right val'
+    assert_equal 'val2', e['var2'], 'env not retrieving right val'
+    assert_equal 'val1', e.var1, 'env not retrieving right val for method missing'
+    assert_equal 'val2', e.var2, 'env not retrieving right val for method missing'
+    
+    assert_equal 'val3', e.var3, 'env not retrieving right val for config in supplemental file'
+
+    e = env.bind('role1', 'nohost')
+    assert_equal 'val1', e['var1'], 'env not retrieving right val'
+    assert_equal 'role1val2', e['var2'], 'env not retrieving right val'
+    assert_equal 'val1', e.var1, 'env not retrieving right val for method missing'
+    assert_equal 'role1val2', e.var2, 'env not retrieving right val for method missing'
+
+    e = env.bind('role1', 'host1')
+    assert_equal 'val1', e['var1'], 'env not retrieving right val'
+    assert_equal 'host1val2', e['var2'], 'env not retrieving right val'
+    assert_equal 'val1', e.var1, 'env not retrieving right val for method missing'
+    assert_equal 'host1val2', e.var2, 'env not retrieving right val for method missing'
+
+    e = env.bind('norole', 'host1')
+    assert_equal 'val1', e['var1'], 'env not retrieving right val'
+    assert_equal 'host1val2', e['var2'], 'env not retrieving right val'
+    assert_equal 'val1', e.var1, 'env not retrieving right val for method missing'
+    assert_equal 'host1val2', e.var2, 'env not retrieving right val for method missing'
+  end
+
+  def test_host_override
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/basic")
+    e = env.bind('norole', 'host2')
+    assert_equal 'host2val3', e['var3'], 'env not retrieving right val'
+    assert_equal %w[host2val4a host2val4b], e['var4'], 'env not retrieving right val'
+    assert_equal [{'var51a' => 'val51a', 'var52a' => 'val52a'}, {'var53' => 'val53'}, {'var54' => 'val54'}], e['var5'], 'env not retrieving right val'
+  end
+
+  def test_combine
+    env = Rubber::Configuration::Environment
+    assert_equal "new", env.combine("old", "new"), "Last should win for scalar combine"
+    assert_equal 5, env.combine(1, 5), "Last should win for scalar combine"
+    assert_equal [1, 2, 3, 4], env.combine([1, 2, 3], [3, 4]), "Arrays should be unioned when combined"
+    assert_equal({1 => "1", 2 => "2", 3 => "3", 4 => "4"}, env.combine({1 => "1", 2 => "2"}, {3 => "3", 4 => "4"}), "Maps should be unioned when combined")
+    assert_equal({1 => "2"}, env.combine({1 => "1"}, {1 => "2"}), "Last should win for scalars in maps when combined")
+    assert_equal({1 => {1 => "1", 2 => "2"}}, env.combine({1 => {1 => "1"}}, {1 => {2 => "2"}}), "Maps should be unioned recursively when combined")
+  end
+
+  def test_expansion
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/expansion")
+    e = env.bind()
+    assert_equal 'val1', e['var1']
+    assert_equal 'val2', e['var2']
+    assert_equal 'val1', e['var3']
+    assert_equal '4 is val2', e['var4']
+    assert_equal 'val1', e['var5']
+    assert_equal %w[lv1 lv2 val1], e['list1']
+    expected = {'mk1' => 'mv1', 'mk2' => 'mv2', 'mk3' => 'val2'}
+    e.map1.each do |k, v|
+      assert_equal expected[k], v
+    end
+      
+    e = env.bind('role1', 'nohost')
+    assert_equal 'role1val1', e['var1']
+    assert_equal 'role1val1', e['var3']
+    assert_equal %w[lv1 lv2 role1val1 role1lv1 role1val2], e['list1']
+
+    e = env.bind('role1', 'host1')
+    assert_equal 'host1val1', e['var1']
+    assert_equal 'host1val1', e['var3']
+    assert_equal %w[lv1 lv2 host1val1 role1lv1 host1val2 host1lv1], e['list1'] # lists are additive
+    
+    e = env.bind('norole', 'host1')
+    assert_equal 'host1val1', e['var1']
+    assert_equal 'host1val1', e['var3']
+    assert_equal %w[lv1 lv2 host1val1 host1lv1 host1val2], e['list1']
+  end
+
+  def test_bool_expansion
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/expansion")
+    e = env.bind()
+    assert_equal true, e['truevar']
+    assert_equal false, e['falsevar']
+    assert_equal true, e['truevar_exp']
+    assert 'true' != e['truevar_exp']
+    assert_equal false, e['falsevar_exp']
+    assert 'false' != e['falsevar_exp']
+    assert_equal 'true thing', e['faketruevar_exp']      
+  end
+
+  def test_secret_env
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/basic")
+    e = env.bind()
+    assert_nil e['rubber_secret'], 'env should not have secret set'
+    
+    fixture_dir = File.expand_path("#{File.dirname(__FILE__)}/fixtures/secret")
+    env = Rubber::Configuration::Environment.new(fixture_dir)
+    e = env.bind()
+    assert_equal "#{fixture_dir}/secret.yml", e['rubber_secret'], 'env should have secret set'
+    assert_equal "secret_val", e['secret_key'], 'env should have gotten setting from secret file'    
+  end
+
+  def test_nested_ref
+    env = Rubber::Configuration::Environment.new("#{File.dirname(__FILE__)}/fixtures/nested")
+    e = env.bind()
+    assert_equal 'val1', e.var1, 'env not retrieving right val'
+    assert_equal 'val3', e.var2.var3, 'env not retrieving right val'
+    assert_equal({'var5' => 'val5'}, e.var2.var4, 'env not retrieving right val')
+    assert_equal ['val6a', 'val6b'], e.var2.var6, 'env not retrieving right val'
+    assert_equal 'val1', e.var2.var7, 'env not retrieving right val'
+    assert_equal 'val3', e.var2.var8, 'env not retrieving right val'
+    assert_equal 'val5', e.var2.var9, 'env not retrieving right val'
+  end
+
+  def test_instances_in_expansion
+    instance = InstanceItem.new('host1', 'domain.com', [RoleItem.new('role1')], '')
+    instance.external_ip = "1.2.3.4"
+    instances = Instance.new(Tempfile.new('testforinstanceexpansion').path)
+    instances.add(instance)
+
+    File.expects(:exist?).returns(true)
+    YAML.expects(:load_file).returns({'var1' =>'"#{rubber_instances.for_role("role1").first.external_ip}"'})
+    Rubber::Configuration.expects(:rubber_instances).returns(instances)
+    env = Rubber::Configuration::Environment.new(nil)
+    e = env.bind()
+
+    assert_equal "\"1.2.3.4\"", e['var1']    
+  end
+
+end

data/test/generator_test.rb

@@ -0,0 +1,370 @@
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'tempfile'
+require File.expand_path(File.join(__FILE__, '..', 'test_helper'))
+
+class GeneratorTest < Test::Unit::TestCase
+  include Rubber::Configuration
+
+  def test_validate
+    assert_raise RuntimeError do
+      src = <<-SRC
+        hello
+      SRC
+      Generator.new(nil, nil, nil).transform(src)
+    end
+    assert_raise RuntimeError do
+      src = <<-SRC
+        <%
+          @read_cmd = 'ls'
+        %>
+        hello
+      SRC
+      Generator.new(nil, nil, nil).transform(src)
+    end
+    assert_raise RuntimeError do
+      src = <<-SRC
+        <%
+          @write_cmd = 'cat'
+        %>
+        hello
+      SRC
+      Generator.new(nil, nil, nil).transform(src)
+    end
+  end
+
+  def test_simple_transform
+    out_file = Tempfile.new('testsimple')
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+  end
+
+  def test_additive_transform
+    out_file = Tempfile.new('testadditive')
+    open(out_file.path, 'w') { |f| f.write("howdy\n")}
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+        @additive = ['#start', '#end']
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert_equal "howdy\n#start      \n      hello\n#end", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    src += "neato\n"
+    open(out_file.path, 'a') { |f| f.write("again\n")}
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert_equal "howdy\n#start      \n      hello\nneato\n#end\nagain", File.read(out_file.path).strip, "transformed contents are incorrect"
+  end
+
+  def test_post_command
+    out_file = Tempfile.new('testpost')
+    post_file = out_file.path + '.post'
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+        @post = 'touch #{post_file}'
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert File.exists?(post_file), "transform did not execute post"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(post_file)
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert ! File.exists?(post_file), "post should not have been executed as dest file unchanged"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(post_file)
+    gen = Generator.new(nil, nil, nil)
+    gen.force = true
+    gen.transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert File.exists?(post_file), "forced transform did not execute post"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(post_file)
+    gen = Generator.new(nil, nil, nil)
+    gen.no_post = true
+    gen.transform(src + "there")
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert ! File.exists?(post_file), "post should not have been generated for no_post option"
+    assert_equal "hello\nthere", File.read(out_file.path).strip, "transformed contents are incorrect"
+  end
+
+  def test_stop_on_error
+    out_file = Tempfile.new('teststoponerr')
+    post_file = out_file.path + '.post'
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+        @post = 'badcommand; touch #{post_file}'
+      %>
+      hello
+    SRC
+
+    g = Generator.new(nil, nil, nil)
+    g.transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert File.exists?(post_file), "transform did not execute post"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(post_file)
+    g = Generator.new(nil, nil, nil)
+    g.stop_on_error_cmd = "function error_exit { exit 99; }; trap error_exit ERR"
+    g.transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert ! File.exists?(post_file), "post should not have been executed as comes after error"
+  end
+
+  def test_pipe_command
+    out_file = Tempfile.new('testpipe')
+    src = <<-SRC
+      <%
+        @read_cmd = 'echo hi'
+        @write_cmd = 'cat > #{out_file.path}'
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate to write_cmd"
+    assert_equal "hello", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(out_file.path)
+    src = <<-SRC
+      <%
+        @read_cmd = 'echo hi'
+        @write_cmd = 'cat > #{out_file.path}'
+        @additive = ['#start', '#end']
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate to write_cmd"
+    assert_equal "hi\n#start      \n      hello\n#end", File.read(out_file.path).strip, "transformed contents are incorrect"
+
+    FileUtils.rm_f(out_file.path)
+    src = <<-SRC
+      <%
+        @read_cmd = 'echo "#start\nthere\n#end\nhi\n"'
+        @write_cmd = 'cat > #{out_file.path}'
+        @additive = ['#start', '#end']
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate to write_cmd"
+    assert_equal "#start      \n      hello\n#end\nhi", File.read(out_file.path).strip, "transformed contents are incorrect"
+    
+    FileUtils.rm_f(out_file.path)
+    src = <<-SRC
+      <%
+        @read_cmd = 'echo hi'
+        @write_cmd = 'badcommand'
+      %>
+      hello
+    SRC
+
+    assert_raises do
+      Generator.new(nil, nil, nil).transform(src)
+    end
+    
+  end
+
+  def list_dir(dir)
+    l = Dir.entries(dir)
+    l.delete_if {|d| d =~ /(^\.+$)|\.bak$/}
+  end
+
+  def test_scoping
+    out_dir = "#{Dir::tmpdir}/test_rubber_scoping"
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/basic", nil, nil, :out_dir => out_dir)
+    g.run()
+    assert File.directory?(out_dir), "scoped transform did not create dir"
+    assert_equal ['bar.conf', 'foo.conf'], list_dir(out_dir), "scoped transform did not create correct files"
+    assert_equal "common", File.read("#{out_dir}/foo.conf").strip, "transformed contents are incorrect"
+    assert_equal "common", File.read("#{out_dir}/bar.conf").strip, "transformed contents are incorrect"
+
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/basic", ['role1'], nil, :out_dir => out_dir)
+    g.run()
+    assert File.directory?(out_dir), "scoped transform did not create dir"
+    assert_equal ['bar.conf', 'foo.conf'], list_dir(out_dir), "scoped transform did not create correct files"
+    assert_equal "role1", File.read("#{out_dir}/foo.conf").strip, "transformed contents are incorrect"
+    assert_equal "common", File.read("#{out_dir}/bar.conf").strip, "transformed contents are incorrect"
+
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/basic", ['role2', 'role1'], nil, :out_dir => out_dir)
+    g.run()
+    assert File.directory?(out_dir), "scoped transform did not create dir"
+    assert_equal ['bar.conf', 'foo.conf'], list_dir(out_dir), "scoped transform did not create correct files"
+    assert_equal "role2", File.read("#{out_dir}/foo.conf").strip, "transformed contents are incorrect"
+    assert_equal "common", File.read("#{out_dir}/bar.conf").strip, "transformed contents are incorrect"
+
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/basic", ['role1'], 'host1', :out_dir => out_dir)
+    g.run()
+    assert File.directory?(out_dir), "scoped transform did not create dir"
+    assert_equal ['bar.conf', 'foo.conf'], list_dir(out_dir), "scoped transform did not create correct files"
+    assert_equal "host1", File.read("#{out_dir}/foo.conf").strip, "transformed contents are incorrect"
+    assert_equal "common", File.read("#{out_dir}/bar.conf").strip, "transformed contents are incorrect"
+
+
+    FileUtils.rm_rf(out_dir)
+  end
+
+  def test_ordering_of_additive
+    out_dir = "#{Dir::tmpdir}/test_rubber_ordering"
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+    
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/generator_order", ['role2', 'role1'], 'host1', :out_dir => out_dir)
+    g.run()
+    assert File.directory?(out_dir), "transform did not create dir"
+    assert_equal ['out.conf'], list_dir(out_dir), "transform did not create correct file"
+    result = <<DATA
+# common first start
+first
+# common first end
+# common last start
+last
+# common last end
+# role1 first start
+role1 first
+# role1 first end
+# role1 last start
+role1 last
+# role1 last end
+# role2 first start
+role2 first
+# role2 first end
+# role2 last start
+role2 last
+# role2 last end
+# host1 first start
+host1 first
+# host1 first end
+# host1 last start
+host1 last
+# host1 last end
+DATA
+    assert_equal result.strip, File.read("#{out_dir}/out.conf").strip, "transformed contents are incorrect"
+    
+    FileUtils.rm_rf(out_dir)
+  end
+
+def test_file_pattern
+    out_dir = "#{Dir::tmpdir}/test_rubber_scoping"
+    FileUtils.rm_rf(out_dir)
+    assert ! File.exists?(out_dir)
+
+    g = Generator.new("#{File.dirname(__FILE__)}/fixtures/basic", nil, nil, :out_dir => out_dir)
+    g.file_pattern = 'foo\.conf'
+    g.run()
+    assert File.directory?(out_dir), "scoped transform did not create dir"
+    assert_equal ['foo.conf'], list_dir(out_dir), "scoped transform did not create correct files"
+    assert_equal "common", File.read("#{out_dir}/foo.conf").strip, "transformed contents are incorrect"
+  end
+
+  def test_perms
+    user = ENV['USER']
+    group = `groups`.split.last
+    out_file = Tempfile.new('testperms')
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+        @perms = 0777
+        @owner = '#{user}'
+        @group = '#{group}'
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert File.exists?(out_file.path), "transform did not generate an output file"
+    assert_equal "100777", sprintf("%o", File.stat(out_file.path).mode), "transformed permissions are incorrect"
+    assert_equal Etc.getpwnam(user).uid, File.stat(out_file.path).uid, "transformed owner is incorrect"
+    assert_equal Etc.getgrnam(group).gid,  File.stat(out_file.path).gid, "transformed group is incorrect"
+  end
+
+  def test_skip
+    out_file = Tempfile.new('testskip')
+    File.delete(out_file.path)
+    src = <<-SRC
+      <%
+        @skip = true
+        @path = '#{out_file.path}'
+      %>
+      hello
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+    assert ! File.exists?(out_file.path), "transform didn't skip generation of an output file"
+  end
+
+  def test_backup
+    out_file = Tempfile.new('testbak')
+    assert ! File.exists?("#{out_file.path}.bak")
+    File.open(out_file.path, 'w') {|f| f.write("howdy")}
+    
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+      %>
+     hello <%= Time.now.to_f %>
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+
+    assert File.exists?("#{out_file.path}.bak"), "transform didn't generate backup"
+    assert_match /howdy/, File.read("#{out_file.path}.bak"), "transform backup has wrong contents"
+  end
+
+  def test_no_backup
+    out_file = Tempfile.new('testnobak')
+    assert ! File.exists?("#{out_file.path}.bak")
+    File.open(out_file.path, 'w') {|f| f.write("howdy")}
+    src = <<-SRC
+      <%
+        @path = '#{out_file.path}'
+        @backup = false
+      %>
+     hello <%= Time.now.to_f %>
+    SRC
+
+    Generator.new(nil, nil, nil).transform(src)
+
+    assert ! File.exists?("#{out_file.path}.bak"), "transform shouldn't generate backup"
+  end
+
+end