soloist 0.9.7 → 1.0.0.pre

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=nested

data/.rvmrc

@@ -1 +1 @@
-rvm --create ruby-1.9.3-p194@soloist
+rvm --create use ruby-1.9.3-p286@soloist

data/.travis.yml

@@ -7,3 +7,4 @@ rvm:
   - jruby
 #  - ruby-head
   - ree
+script: script/ci.sh

data/Gemfile

@@ -1,7 +1,3 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in soloist.gemspec
 gemspec
-
-gem "rake"
-gem "rspec", "2.4.0"

data/Gemfile.lock

@@ -1,19 +1,23 @@
 PATH
   remote: .
   specs:
-    soloist (0.9.6)
+    soloist (1.0.0.pre)
       chef
+      hashie
+      librarian
+      thor
 
 GEM
   remote: http://rubygems.org/
   specs:
-    bunny (0.8.0)
-    chef (10.12.0)
-      bunny (>= 0.6.0)
+    archive-tar-minitar (0.5.2)
+    bunny (0.7.9)
+    chef (10.16.2)
+      bunny (>= 0.6.0, < 0.8.0)
       erubis
       highline (>= 1.6.9)
       json (>= 1.4.4, <= 1.6.1)
-      mixlib-authentication (>= 1.1.0)
+      mixlib-authentication (>= 1.3.0)
       mixlib-cli (>= 1.1.0)
       mixlib-config (>= 1.1.2)
       mixlib-log (>= 1.3.0)
@@ -26,11 +30,33 @@ GEM
       treetop (~> 1.4.9)
       uuidtools
       yajl-ruby (~> 1.1)
-    diff-lcs (1.1.2)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
     erubis (2.7.0)
-    highline (1.6.14)
+    gem-release (0.4.1)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (2.1.1)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    hashie (1.2.0)
+    highline (1.6.15)
     ipaddress (0.8.0)
     json (1.6.1)
+    librarian (0.0.25)
+      archive-tar-minitar (>= 0.5.2)
+      chef (>= 0.10)
+      highline
+      thor (~> 0.15)
+    listen (0.5.3)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
     mime-types (1.19)
     mixlib-authentication (1.3.0)
       mixlib-log
@@ -53,19 +79,26 @@ GEM
       systemu
       yajl-ruby
     polyglot (0.3.3)
-    rake (0.8.7)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rb-fsevent (0.9.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    slop (3.3.3)
     systemu (2.5.2)
-    treetop (1.4.10)
+    terminal-notifier-guard (1.5.3)
+    thor (0.16.0)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
     uuidtools (2.1.3)
@@ -75,6 +108,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rake
-  rspec (= 2.4.0)
+  gem-release
+  guard-bundler
+  guard-rspec
+  rb-fsevent
+  rspec
   soloist!
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+guard 'rspec', cli: '--fail-fast --tag ~@slow:true' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('soloist.gemspec')
+end

data/README.markdown

@@ -1,122 +1,116 @@
+# Soloist
+
 [![Build Status](https://secure.travis-ci.org/mkocher/soloist.png)](http://travis-ci.org/mkocher/soloist)
 
-Soloist: Making chef-solo easier
-================================
-
-# Why?
-You just want to use chef solo, not worry about where your config files are, or what they should look like (too much).  You might think that json is a data serialization format and not a config file format.  You might think that having two config files that you have to pass to an executable every time you run it is two too many.
-
-# How?
-Soloist is a script packaged as a gem which when run recurses up the file tree looking for a soloistrc file.  When it finds it, it uses it to determine 1) Where its cookbooks are and 2) What recipes to run.  It generates the necessary config files for chef solo, and kicks it off.
-
-# That's exactly what I've always wanted! How do I use it?
-* (sudo) gem install soloist
-* create a directory to store your cookbooks in, and get a cookbook: 
-	sh -c 'mkdir -p chef/cookbooks/pivotal_workstation && cd chef/cookbooks/pivotal_workstation &&  curl -L http://github.com/pivotal/pivotal_workstation/tarball/master |  gunzip | tar xvf - --strip=1'
-* create your soloistrc file in the root of your project.
-
-# What if I'm just setting up my own machine, and have many projects?
-Just put your soloistrc file in your home directory, and point it to wherever you want to keep your cookbooks. Or just dedicate a git repo to it, and go into that directory before running soloist.
-
-# How do I write a soloistrc file?
-It's a yaml file, currently with two lists to maintain:
-
-The first, _cookbook\_paths_, should point (using an absolute or path relative to your soloistrc file) to the directory containing your cookbooks, such was pivotal_workstation.
-
-The second, _recipes_ should be a list of recipes you wish to run.
-
-# Then What?
-$> soloist
-
-
-Example soloistrc Files
-=======================
-
-directory layout:
-
-    /Users/mkocher/workspace/project/soloistrc <-Config File
-    /Users/mkocher/workspace/project/cookbooks/pivotal_workstation/
-
-
-soloistrc
----------
-	cookbook_paths:
-	- ./cookbooks/
-	recipes:
-	- pivotal_workstation::ack
-	- pivotal_workstation::bash_path_order
-	- pivotal_workstation::bash_profile-better_history
-	- pivotal_workstation::defaults_fast_key_repeat_rate
-	- pivotal_workstation::finder_display_full_path
-	- pivotal_workstation::git_config_global_defaults
-	- pivotal_workstation::git_scripts
-	- pivotal_workstation::google_chrome
-	- pivotal_workstation::inputrc
-	- pivotal_workstation::rvm
-	- pivotal_workstation::turn_on_ssh
-
-Packaging Gems as Cookbooks (alpha)
-===========================
-
-If you're a ruby developer, you're probably very comfortable wrangling gems.  Bundler makes it easy to lock your dependencies and keep them in sync in all your environments.  Soloist adds the ability to load cookbooks out of these gems.  This means you can install the  pivotal_workstation_cookbook gem, and add it to your soloistrc like so:
-
-	cookbook_gems:
-	- pivotal_workstation_cookbook
-
-Easy cookbook dependency tracking, no more git cloning, no more chef recipes that aren't yours checked into your project and easy forking with bundler and github.
-
-Environment Variable Switching
-==============================
-The soloistrc file allows for selecting all options 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.
-
-	cookbook_paths:
-	- ./chef/cookbooks/
-	recipes:
-	- pivotal_workstation::ack
-	env_variable_switches:
-	  RACK_ENV:
-	    production:
-	      cookbook_paths:
-	      - ./chef/production_cookbooks/
-	      recipes:
-	      - production::foo
-
-The values are merged in, so this results in a cookbook path of
-	[
-      "./chef/cookbooks/",
-      "./chef/production_cookbooks/"
-    ]
-and a recipe list of
-	[
-	  "pivotal_workstation::ack", 
-	  "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
-==============================
-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.
-
-Setting Node Attributes
-=======================
-You can set node attributes in your soloistrc file that will be included in the JSON attributes file passed to chef-solo.
+Soloist lets you quickly and easily converge [Chef](http://opscode.com/chef) recipes using [chef-solo](http://wiki.opscode.com/display/chef/Chef+Solo).  It does not require a Chef server, but can exploit [community cookbooks](http://community.opscode.com/cookbooks), github-hosted cookbooks and locally-sourced cookbooks through [Librarian](https://github.com/applicationsonline/librarian).
+
+Soloist was originally built to support the [Pivotal Labs Workstation Cookbook](https://github.com/pivotal/pivotal_workstation).
+
+
+Using Soloist
+-------------
+
+Let's say you want to converge the Pivotal Labs Workstation default recipe and install Sublime Text 2.
+
+1. You'll need to have Soloist installed:
+
+        $ gem install soloist
+
+1. You'll need a `Cheffile` in your home directory that points Librarian to all the cookbooks you've included:
+
+        $ cat /Users/pivotal/Cheffile
+        site "http://community.opscode.com/api/v1"
+        cookbook "pivotal_workstation",
+                 :git => "https://github.com/pivotal/pivotal_workstation"
+
+1. You'll need to create a `soloistrc` file in your home directory to tell Chef which recipes to converge:
+
+        $ cat /Users/pivotal/soloistrc
+        recipes:
+          - pivotal_workstation::default
+          - pivotal_workstation::sublime_text
+
+1. You'll need to run `soloist` for anything to happen:
+
+        $ soloist
+
+
+Examples
+--------
+
+##### Running a set of recipes
+
+Here's an example of a `soloistrc`:
 
     cookbook_paths:
-    - ./chef/cookbooks/
+      - /opt/beans
     recipes:
-    - pivotal_workstation::github_ssh_keys
-    - pivotal_workstation::rvm
+      - beans::chili
+      - beans::food_fight
+      - napkins
+
+This tells Soloist to search in both `/opt/beans` and `./cookbooks` (relative to the `soloistrc`) for cookbooks to run.  Then, it attempts to converge the `beans::chili`, `beans::food_fight` and `napkins` recipes.
+
+
+##### Setting node attributes
+
+Soloist lets you override node attributes.  Let's say we've got a `bash::prompt` recipe for which  we want to set `node['bash']['prompt']['color']='p!nk'`.  No problem!
+
+    recipes:
+      - bash::prompt
     node_attributes:
-      github_username: john.smith
-      github_password: pas$w0rd
-      rvm:
-        rubies:
-          ruby-1.8.7-p299: {}
-          jruby-1.6.6: {}
+      bash:
+        prompt:
+          color: p!nk
+
+
+##### Conditionally modifying Soloist
+
+Soloist allows conditionally switching on environment variables.  Let's say we only want to include the `embarrassment::parental` recipe when the `MEGA_PRODUCTION` environment variable is set to `juggalos`.  Here's the `soloistrc`:
+
+    cookbook_paths:
+      - /fresno
+    recipes:
+      - disaster
+    env_variable_switches:
+      MEGA_PRODUCTION:
+        juggalos:
+          recipes:
+            - embarrassment::parental
+
+So now, this is the result of our Soloist run:
+
+    $ MEGA_PRODUCTION=juggalos soloist
+    Installing disaster (1.0.0)
+    Installing embarrassment (1.0.0)
+    … chef output …
+    INFO: Run List expands to [disaster, embarrassment::parental, faygo]
+    … chef output …
+
+If we set `MEGA_PRODUCTION=godspeed`, the `embarrassment::parental` recipe is not converged.
+
+
+##### Running one-off recipes
+
+Soloist can also run one-off recipes:
+
+    $ soloist DO_IT_LIVE lice::box
+    Installing lice (1.0.0)
+    … chef output …
+    INFO: Run List expands to [lice::box]
+    … chef output …
+
+This just runs the `lice::box` recipe from your current set of cookbooks.  It still uses all the `node_attributes` and `env_variable_switches` logic.
+
+
+##### Chef logging
+
+Soloist runs `chef-solo` at log level `info` by default, which is helpful when you need to see what your Chef run is doing.  If you need more information, you can set the `LOG_LEVEL` environment variable:
+
+    $ LOG_LEVEL=debug soloist
+
 
 License
 =======
-Soloist is MIT Licensed.  See MIT-LICENSE for details.
+
+See MIT-LICENSE for details.

data/bin/soloist

@@ -1,26 +1,4 @@
 #!/usr/bin/env ruby
-require File.join(File.dirname(__FILE__), '..', 'lib', 'soloist')
-
-include Soloist::Util
-
-log_level = ENV['LOG_LEVEL'] || "info"
-
-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)
-
-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]
-  config_generator.recipes = [requested_recipe]
-end
-
-solo_rb = fileify(config_generator.solo_rb)
-metadata_json = fileify(config_generator.json_file)
-
-system "sudo mkdir -p /var/chef/cache" unless File.directory?("/var/chef/cache")
-
-command = "sudo bash -c '#{config_generator.preserved_environment_variables_string} chef-solo -j #{metadata_json.path} -c #{solo_rb.path} -l #{log_level}'"
-puts "running chef: " + command
-system(command) || exit(1)
+$:.push File.expand_path("../../lib", __FILE__)
+require "soloist"
+Soloist::CLI.start

data/lib/soloist/cli.rb

@@ -0,0 +1,83 @@
+require "librarian/chef/cli"
+require "soloist/spotlight"
+require "soloist/config"
+require "tempfile"
+require "thor"
+
+module Soloist
+  class CLI < Thor
+    default_task :chef
+
+    desc "chef", "Runs chef-solo like a baws"
+    def chef
+      ensure_chef_cache_path
+      write_solo_rb
+      write_node_json
+      install_cookbooks if cheffile_exists?
+      exec("sudo -E bash -c '#{chef_solo}'")
+    end
+
+    desc "run_recipe", "Runs an individual recipe with chef-solo"
+    def DO_IT_LIVE(*recipes)
+      config.royal_crown.recipes = recipes
+      chef
+    end
+
+    no_tasks do
+      def write_solo_rb
+        content = config.as_solo_rb
+        content.each{ |line| puts line } if log_level == "debug"
+        File.open(solo_rb.path, "w") { |f| f.write(content) }
+      end
+
+      def write_node_json
+        content = config.as_json
+        puts JSON.pretty_generate(content) if log_level == "debug"
+        File.open(node_json.path, "w") { |f| f.write(JSON.dump(content)) }
+      end
+
+      def ensure_chef_cache_path
+        unless File.directory?("/var/chef/cache")
+          system("sudo mkdir -p /var/chef/cache")
+        end
+      end
+
+      def install_cookbooks
+        Dir.chdir(File.dirname(rc_path)) do
+          Librarian::Chef::Cli.with_environment do
+            Librarian::Chef::Cli.new.install
+          end
+        end
+      end
+
+      def config
+        @config ||= Soloist::Config.from_file(rc_path)
+      end
+
+      def chef_solo
+        "chef-solo -j '#{node_json.path}' -c '#{solo_rb.path}' -l '#{log_level}'"
+      end
+    end
+
+    private
+    def cheffile_exists?
+      File.exists?(File.expand_path("../Cheffile", rc_path))
+    end
+
+    def log_level
+      ENV["LOG_LEVEL"] || "info"
+    end
+
+    def solo_rb
+      @solo_rb ||= Tempfile.new(["solo", ".rb"])
+    end
+
+    def node_json
+      @node_json ||= Tempfile.new(["node", ".json"])
+    end
+
+    def rc_path
+      @rc_path ||= Soloist::Spotlight.find!("soloistrc", ".soloistrc")
+    end
+  end
+end

data/lib/soloist/config.rb

@@ -0,0 +1,50 @@
+require "soloist/royal_crown"
+
+module Soloist
+  class Config
+    attr_reader :royal_crown
+
+    def self.from_file(royal_crown_path)
+      rc = Soloist::RoyalCrown.from_file(royal_crown_path)
+      new(rc)
+    end
+
+    def initialize(royal_crown)
+      @royal_crown = royal_crown
+    end
+
+    def as_solo_rb
+      paths = cookbook_paths.uniq.map do |cookbook_path|
+        File.expand_path(cookbook_path, bash_path)
+      end
+      "cookbook_path #{paths.inspect}"
+    end
+
+    def as_json
+      {
+        "recipes" => compiled_rc.recipes
+      }
+    end
+
+    def compiled_rc
+      @compiled_rc ||= royal_crown.dup.tap do |rc|
+        while rc["env_variable_switches"]
+          rc.delete("env_variable_switches").each do |variable, switch|
+            switch.each do |value, inner|
+              rc.merge!(inner) if ENV[variable] == value
+            end
+          end
+        end
+      end
+    end
+
+    private
+    def bash_path
+      File.dirname(royal_crown.path)
+    end
+
+    def cookbook_paths
+      ["cookbooks"] + compiled_rc.cookbook_paths
+    end
+  end
+end

data/lib/soloist/royal_crown.rb

@@ -0,0 +1,56 @@
+require "hashie"
+
+module Soloist
+  class RoyalCrown < Hashie::Trash
+    property :path
+    property :recipes, :default => []
+    property :cookbook_paths, :default => []
+    property :node_attributes, :default => Hashie::Mash.new,
+             :transform_with => lambda { |v| Hashie::Mash.new(v) }
+    property :env_variable_switches, :default => Hashie::Mash.new,
+             :transform_with => lambda { |v| Hashie::Mash.new(v) }
+
+    def node_attributes=(hash)
+      self["node_attributes"] = Hashie::Mash.new(hash)
+    end
+
+    def env_variable_switches=(hash)
+      self["env_variable_switches"] = Hashie::Mash.new(hash)
+    end
+
+    def to_yaml
+      to_hash.tap do |hash|
+        hash.delete("path")
+        self.class.nilable_properties.each { |k| hash[k] = nil if hash[k].empty? }
+      end
+    end
+
+    def save
+      return self unless path
+      File.open(path, "w+") { |file| file.write(YAML.dump(to_yaml)) }
+      self
+    end
+
+    def reload
+      self.class.from_file(path)
+    end
+
+    def self.from_file(file_path)
+      new(read_config(file_path).merge("path" => file_path))
+    end
+
+    def self.read_config(yaml_file)
+      content = File.read(yaml_file)
+      YAML.load(content).tap do |hash|
+        nilable_properties.each do |key|
+          hash.delete(key) if hash[key].nil?
+        end if hash
+      end || {}
+    end
+
+    private
+    def self.nilable_properties
+      (properties - [:path]).map(&:to_s)
+    end
+  end
+end

data/lib/soloist/spotlight.rb

@@ -0,0 +1,41 @@
+require 'pathname'
+
+module Soloist
+  class NotFound < RuntimeError; end
+
+  class Spotlight
+    attr_reader :pathname
+
+    def self.find(*file_names)
+      new(Dir.pwd).find(*file_names)
+    end
+
+    def self.find!(*file_names)
+      new(Dir.pwd).find!(*file_names)
+    end
+
+    def initialize(path)
+      @pathname = Pathname.new(path)
+    end
+
+    def find(*file_names)
+      pathname.ascend do |path|
+        file_name = file_names.detect { |fn| path.join(fn).file? }
+        break path.join(file_name) if file_name
+      end
+    end
+
+    def find!(*file_names)
+      file_path = find(*file_names)
+      unless file_path
+        file_names = if file_names.length > 2
+          file_names[0...-1].join(", ") + " or " + file_names.last
+        else
+          file_names.join(" or ")
+        end
+        raise Soloist::NotFound.new("Could not find #{file_names}")
+      end
+      file_path
+    end
+  end
+end

data/lib/soloist/version.rb

@@ -1,3 +1,3 @@
 module Soloist
-  VERSION = "0.9.7"
+  VERSION = "1.0.0.pre"
 end

data/lib/soloist.rb

@@ -1,11 +1,2 @@
-require 'rubygems'
-require "json"
-require 'fileutils'
-require 'yaml'
-require 'tempfile'
-require 'tmpdir'
-require 'set'
-
-require File.join(File.dirname(__FILE__), 'soloist', 'util')
-require File.join(File.dirname(__FILE__), 'soloist', 'chef_config_generator')
-require File.join(File.dirname(__FILE__), 'soloist', 'cookbook_gem_linker')
+require "soloist/version"
+require "soloist/cli"

data/script/ci.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec