soloist 0.0.8 → 0.9.0

data/README.markdown

@@ -66,8 +66,8 @@ soloistrc
 	- pivotal_workstation::user_owns_usr_local
 	- pivotal_workstation::workspace_directory
 
-Environment Variable Switching (Alpha)
-======================================
+Environment Variable Switching
+==============================
 I'm trying out adding support in the soloistrc file for selecting recipes based on environment variables.  Cap should allow setting environment variables fairly easily on deploy, and they can be set permanently on the machine if desired.  To use these, add a env_variable_switches key to your soloistrc.  They keys of the hash should be the environment variable you wish to change the configuration based on, and the value should be a hash keyed by the value of the variable.  It's easier than it sounds - see the example below. (NB: Note that the CamelSnake is gone in the soloistrc, and while the basic config accepts the old keys, environment variable switching requires snake case keys)
 
 	cookbook_paths:
@@ -93,6 +93,14 @@ and a recipe list of
 	  "production::foo"
 	]
 	
+Log Level
+=========
+Soloist runs chef at log level info by default.  Debug is very verbose, but makes debugging chef recipes much easier.  Just set the LOG_LEVEL environment variable to 'debug' (or other valid chef log level) and it will be passed through.
+
+Local Overrides (experimental)
+==============================
+Soloist is an easy way to share configuration across workstations.  If you want to have configuration in chef that you don't want to share with the rest of the project, you can create a soloistrc_local file in addition to the soloistrc file.  This file will be processed after the soloistrc, and everything in it will be added to the run list.  Be careful that you are clear what goes where - if it's a dependency of the project, it should be checked into the soloistrc file in the project.
+
 License
 =======
 Soloist is MIT Licensed.  See MIT-LICENSE for details.

data/bin/soloist

@@ -1,40 +1,21 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'soloist'
-
-def fileify(contents)
-  file = Tempfile.new("soloist")
-  file << contents
-  file.flush
-  file
-end
+require File.join(File.dirname(__FILE__), '..', 'lib', 'soloist')
 
-def walk_up_and_find_file(filenames)
-  pwd = FileUtils.pwd
-  file = nil
-  path_to_file = ""
-  while !file && FileUtils.pwd != '/'
-    file = filenames.detect { |f| Dir.glob("*").include?(f) }
-    FileUtils.cd("..")
-    path_to_file << "../" unless file
-  end
-  FileUtils.cd(pwd)
-  file_contents = File.read(path_to_file + file) if file
-  [file_contents, path_to_file]
-end
+include Soloist::Util
 
 log_level = ENV['LOG_LEVEL'] || "info"
 
-soloistrc_contents, soloistrc_path = walk_up_and_find_file(["soloistrc"])
-config_generator = ChefConfigGenerator.new(soloistrc_contents, soloistrc_path)
+soloistrc_contents, soloistrc_path = walk_up_and_find_file(with_or_without_dot("soloistrc"))
+config_generator = Soloist::ChefConfigGenerator.new(YAML.load(soloistrc_contents), soloistrc_path)
 
-# if ARGV.length >= 1
-#   json_config = JSON.parse(File.read(json_file))
-#   json_config["recipes"] = ARGV
-#   json_file = "/tmp/#{File.basename(json_file)}"
-#   puts "OVERRIDING RECIPES: running [#{json_config["recipes"].join(", ")}].  Temp json config file: #{json_file}"
-#   File.open(json_file, "w+"){|f| f<<JSON.pretty_generate(json_config) }
-# end
+soloistrc_contents, soloistrc_path = walk_up_and_find_file(with_or_without_dot("soloistrc_local"), :required => false)
+config_generator.merge_config(YAML.load(soloistrc_contents), soloistrc_path) if soloistrc_contents
+
+if ARGV.length >= 1
+  requested_recipe = ARGV[0]
+  raise "requested recipe '#{requested_recipe}' not in soloistrc or soloistrc_local" unless config_generator.recipes.include?(requested_recipe)
+  config_generator.recipes = [requested_recipe]
+end
 
 solo_rb = fileify(config_generator.solo_rb)
 metadata_json = fileify(config_generator.json_file)

data/lib/soloist/chef_config_generator.rb

@@ -1,60 +1,71 @@
 require 'yaml'
 
-class ChefConfigGenerator
-  def initialize(yaml_string, relative_path_to_soloistrc)
-    @hash = YAML.load(yaml_string)
-    @relative_path_to_soloistrc = relative_path_to_soloistrc
-    merge_env_variable_switches
-  end
-  
-  def merge_env_variable_switches
-    return unless @hash["env_variable_switches"]
-    @hash["env_variable_switches"].keys.each do |variable|
-      ENV[variable] && ENV[variable].split(',').each do |env_variable_value|
-        sub_hash = @hash["env_variable_switches"][variable][env_variable_value]
-        if sub_hash && sub_hash["recipes"]
-          @hash["recipes"] ||= []
-          @hash["recipes"] = (@hash["recipes"] + sub_hash["recipes"]).uniq
-        end
-        if sub_hash && sub_hash["cookbook_paths"]
-          @hash["cookbook_paths"] ||= []
-          @hash["cookbook_paths"] = (@hash["cookbook_paths"] + sub_hash["cookbook_paths"]).uniq
-        end
+module Soloist
+  class Soloist::ChefConfigGenerator
+    def initialize(config, relative_path_to_soloistrc)
+      @recipes = []
+      @cookbook_paths = []
+      @preserved_environment_variables = %w{PATH BUNDLE_PATH GEM_HOME GEM_PATH RAILS_ENV RACK_ENV}
+      merge_config(config, relative_path_to_soloistrc)
+    end
+    
+    attr_reader :preserved_environment_variables, :cookbook_paths
+    attr_accessor :recipes
+    
+    def support_old_format(hash)
+      hash['recipes'] ||= hash.delete('Recipes')
+      hash['cookbook_paths'] ||= hash.delete('Cookbook_Paths')
+      hash
+    end
+    
+    def append_path(paths, relative_path_to_soloistrc)
+      paths.map do |path|
+        path.slice(0,1) == '/' ? path : "#{FileUtils.pwd}/#{relative_path_to_soloistrc}/#{path}"
       end
     end
-  end
   
-  def cookbook_paths
-    (@hash["cookbook_paths"] || @hash["Cookbook_Paths"]).map do |v|
-      (v =~ /\//) == 0 ? v : "#{FileUtils.pwd}/#{@relative_path_to_soloistrc}/#{v}"
+    def merge_config(sub_hash, relative_path_to_soloistrc)
+      sub_hash = support_old_format(sub_hash)
+      if sub_hash["recipes"]
+        @recipes = (@recipes + sub_hash["recipes"]).uniq
+      end
+      if sub_hash["cookbook_paths"]
+        @cookbook_paths = (@cookbook_paths + append_path(sub_hash["cookbook_paths"], relative_path_to_soloistrc)).uniq
+      end
+      if sub_hash["env_variable_switches"]
+        merge_env_variable_switches(sub_hash["env_variable_switches"], relative_path_to_soloistrc)
+      end
     end
-  end
   
-  def solo_rb
-    "cookbook_path #{cookbook_paths.inspect}"
-  end
+    def merge_env_variable_switches(hash_to_merge, relative_path_to_soloistrc)
+      hash_to_merge.keys.each do |variable|
+        @preserved_environment_variables << variable
+        ENV[variable] && ENV[variable].split(',').each do |env_variable_value|
+          sub_hash = hash_to_merge[variable] && hash_to_merge[variable][env_variable_value]
+          merge_config(sub_hash, relative_path_to_soloistrc) if sub_hash
+        end
+      end
+    end
   
-  def json_hash
-    recipes = @hash["Recipes"] || @hash["recipes"]
-    {
-      "recipes" => recipes
-    }
-  end
+    def solo_rb
+      "cookbook_path #{cookbook_paths.inspect}"
+    end
   
-  def json_file
-    json_hash.to_json
-  end
+    def json_hash
+      {
+        "recipes" => @recipes
+      }
+    end
   
-  def preserved_environment_variables
-    always_passed = %w{PATH BUNDLE_PATH GEM_HOME GEM_PATH RAILS_ENV RACK_ENV}
-    always_passed += @hash["env_variable_switches"].keys if @hash["env_variable_switches"]
-    always_passed
-  end
+    def json_file
+      json_hash.to_json
+    end
   
-  def preserved_environment_variables_string
-    variable_array = []
-    preserved_environment_variables.map do |env_variable|
-      "#{env_variable}=#{ENV[env_variable]}" unless ENV[env_variable].nil?
-    end.compact.join(" ")
+    def preserved_environment_variables_string
+      variable_array = []
+      preserved_environment_variables.map do |env_variable|
+        "#{env_variable}=#{ENV[env_variable]}" unless ENV[env_variable].nil?
+      end.compact.join(" ")
+    end
   end
 end

data/lib/soloist/util.rb

@@ -0,0 +1,34 @@
+module Soloist
+  module Util
+    def with_or_without_dot(file_name)
+      [file_name, ".#{file_name}"]
+    end
+    
+    def fileify(contents)
+      file = Tempfile.new("soloist")
+      file << contents
+      file.flush
+      file
+    end
+    
+    def walk_up_and_find_file(filenames, opts={})
+      pwd = FileUtils.pwd
+      file = nil
+      path_to_file = ""
+      while !file && FileUtils.pwd != '/'
+        file = filenames.detect { |f| File.exists?(f) }
+        FileUtils.cd("..")
+        path_to_file << "../" unless file
+      end
+      FileUtils.cd(pwd)
+      if file
+        file_contents = File.read(path_to_file + file) if file
+        [file_contents, path_to_file]
+      elsif opts[:required] == false
+        [nil, nil]
+      else
+        raise Errno::ENOENT, "#{filenames.join(" or ")} not found" unless file || opts[:required] == false
+      end
+    end
+  end
+end

data/lib/soloist/version.rb

@@ -1,3 +1,3 @@
 module Soloist
-  VERSION = "0.0.8"
+  VERSION = "0.9.0"
 end

data/lib/soloist.rb

@@ -1,10 +1,9 @@
-require 'soloist/chef_config_generator'
+require 'rubygems'
 require "json"
 require 'fileutils'
 require 'yaml'
 require 'tempfile'
 
+require File.join(File.dirname(__FILE__), 'soloist', 'chef_config_generator')
+require File.join(File.dirname(__FILE__), 'soloist', 'util')
 
-module Soloist
-  # Your code goes here...
-end

data/soloist.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Matthew Kocher"]
   s.email       = ["kocher@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/soloist"
+  s.homepage    = "http://github.com/mkocher/soloist"
   s.summary     = %q{Soloist is a simple way of running chef-solo}
   s.description = %q{Soloist is an easy way of running chef solo, but it's not doing much.}
 
@@ -19,6 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('chef', '0.9.12')
-  s.add_dependency('json', '1.4.6')
-end
+  s.add_dependency('chef')
+  s.add_dependency('json')
+end

data/spec/chef_config_generator_spec.rb

@@ -1,7 +1,7 @@
 require 'rspec'
 require 'lib/soloist'
 
-describe "ChefConfigGenerator" do
+describe Soloist::ChefConfigGenerator do
   describe "generation" do
     before do
       @config = <<-CONFIG
@@ -10,13 +10,20 @@ Cookbook_Paths:
 Recipes:
 - pivotal_workstation::ack
 CONFIG
-      @generator = ChefConfigGenerator.new(@config, "../..")
+      @config = YAML.load(@config)
       FileUtils.stub(:pwd).and_return("/current/working/directory")
+      @generator = Soloist::ChefConfigGenerator.new(@config, "../..")
     end
 
     it "appends the current path and relative path to the cookbooks directory" do
       @generator.cookbook_paths.should == ["/current/working/directory/../.././chef/cookbooks/"]
     end
+
+    it "does not append if an absolute path is given" do
+      @config['cookbook_paths'] = ["/foo/bar"]
+      @generator = Soloist::ChefConfigGenerator.new(@config, "../..")
+      @generator.cookbook_paths.should == ["/foo/bar"]
+    end
   
     it "can generate a solo.rb contents" do
       @generator.solo_rb.should == 'cookbook_path ["/current/working/directory/../.././chef/cookbooks/"]'
@@ -60,7 +67,7 @@ env_variable_switches:
       recipes:
       - pivotal_dev::foo
       CONFIG
-        @generator = ChefConfigGenerator.new(@config, "")
+        @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "")
         @generator.preserved_environment_variables.should =~ %w{PATH BUNDLE_PATH GEM_HOME GEM_PATH RAILS_ENV RACK_ENV ME_TOO}
       end
     end
@@ -73,25 +80,25 @@ env_variable_switches:
       
     it "accepts Cookbook_Paths, because the CamelSnake is a typo that must be supported" do
       @config = "Cookbook_Paths:\n- ./chef/cookbooks/\n"
-      @generator = ChefConfigGenerator.new(@config, "")
-      @generator.cookbook_paths.should == ["///./chef/cookbooks/"]
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "..")
+      @generator.cookbook_paths.should == ["//.././chef/cookbooks/"]
     end
     
     it "accepts cookbook_paths, because it is sane" do
       @config = "cookbook_paths:\n- ./chef/cookbooks/\n"
-      @generator = ChefConfigGenerator.new(@config, "")
-      @generator.cookbook_paths.should == ["///./chef/cookbooks/"]
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "..")
+      @generator.cookbook_paths.should == ["//.././chef/cookbooks/"]
     end
     
     it "accepts Recipes, because that's the way it was" do
       @config = "Recipes:\n- pivotal_workstation::ack"
-      @generator = ChefConfigGenerator.new(@config, "")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "")
       @generator.json_hash.should == { "recipes" => ["pivotal_workstation::ack"]}
     end
 
     it "accepts recipes, because it's snake now" do
       @config = "recipes:\n- pivotal_workstation::ack"
-      @generator = ChefConfigGenerator.new(@config, "")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "")
       @generator.json_hash.should == { "recipes" => ["pivotal_workstation::ack"]}
     end
   end
@@ -116,7 +123,7 @@ env_variable_switches:
       - pivotal_dev::foo
       CONFIG
       ENV["RACK_ENV"]="development"
-      @generator = ChefConfigGenerator.new(@config, "../..")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "../..")
       @generator.cookbook_paths.should == [
         "//../.././chef/cookbooks/",
         "//../.././chef/dev_cookbooks/"
@@ -147,7 +154,7 @@ env_variable_switches:
       recipes:
       - pivotal_db::database
       CONFIG
-      @generator = ChefConfigGenerator.new(@config, "../..")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(@config), "../..")
       @generator.cookbook_paths.should =~ [
         "//../.././chef/cookbooks/",
         "//../.././chef/app_cookbooks/",
@@ -159,6 +166,15 @@ env_variable_switches:
         "pivotal_db::database",
         ]
     end
+    
+    it "can deal with empty env switched variables, and passes them through" do
+      config = <<-CONFIG
+env_variable_switches:
+  RACK_ENV:
+      CONFIG
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(config), "../..")
+      @generator.preserved_environment_variables.should include("RACK_ENV")
+    end
 
 
     it "can deal with only having environment switched recipes/cookbooks" do
@@ -171,7 +187,7 @@ env_variable_switches:
       recipes:
       - pivotal_development::foo
       CONFIG
-      @generator = ChefConfigGenerator.new(config, "../..")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(config), "../..")
       @generator.cookbook_paths.should == [
         "//../.././chef/development_cookbooks/"
         ]
@@ -191,7 +207,7 @@ env_variable_switches:
       recipes:
       - pivotal_development::foo
       CONFIG
-      @generator = ChefConfigGenerator.new(config, "../..")
+      @generator = Soloist::ChefConfigGenerator.new(YAML.load(config), "../..")
       @generator.cookbook_paths.should == [
         "//../.././chef/development_cookbooks/"
         ]

data/spec/util_spec.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'lib/soloist'
+
+describe Soloist::Util do
+  class TestClass
+    extend Soloist::Util
+  end
+  
+  describe "walk_up_and_find_file" do
+    it "raises an error when the file isn't found" do
+      lambda do
+        TestClass.walk_up_and_find_file(["file_not_on_the_filesystem"])
+      end.should raise_error(Errno::ENOENT, "No such file or directory - file_not_on_the_filesystem not found")
+    end
+    
+    it "doesn't raise an error if :required => false is passed" do
+      TestClass.walk_up_and_find_file(["file_not_on_the_filesystem"], :required => false).should == [nil, nil]
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: soloist
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 59
   prerelease: false
   segments: 
   - 0
+  - 9
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.9.0
 platform: ruby
 authors: 
 - Matthew Kocher
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-19 00:00:00 -07:00
+date: 2011-06-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +24,12 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 35
+        hash: 3
         segments: 
         - 0
-        - 9
-        - 12
-        version: 0.9.12
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,14 +38,12 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 3
         segments: 
-        - 1
-        - 4
-        - 6
-        version: 1.4.6
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id002
 description: Soloist is an easy way of running chef solo, but it's not doing much.
@@ -70,11 +66,13 @@ files:
 - bin/soloist
 - lib/soloist.rb
 - lib/soloist/chef_config_generator.rb
+- lib/soloist/util.rb
 - lib/soloist/version.rb
 - soloist.gemspec
 - spec/chef_config_generator_spec.rb
+- spec/util_spec.rb
 has_rdoc: true
-homepage: http://rubygems.org/gems/soloist
+homepage: http://github.com/mkocher/soloist
 licenses: []
 
 post_install_message: 
@@ -109,3 +107,4 @@ specification_version: 3
 summary: Soloist is a simple way of running chef-solo
 test_files: 
 - spec/chef_config_generator_spec.rb
+- spec/util_spec.rb