gusteau 0.4.8 → 1.0.0.dev

data/.travis.yml

@@ -5,3 +5,5 @@ rvm:
   - rbx
   - jruby
   - 2.0.0
+env:
+  - COVERAGE=coveralls

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.5.0
+
+  * Use omibus installation if platform is unspecified
+  * Use the unified `.gusteau.yml` configuration file for all nodes and environments

data/README.md

@@ -4,12 +4,13 @@ Gusteau
 *"Anyone can cook."*
 
 [![Build Status](https://www.travis-ci.org/locomote/gusteau.png?branch=master)](https://www.travis-ci.org/locomote/gusteau)
+[![Coverage Status](https://coveralls.io/repos/locomote/gusteau/badge.png)](https://coveralls.io/r/locomote/gusteau)
 [![Dependency Status](https://gemnasium.com/locomote/gusteau.png)](https://gemnasium.com/locomote/gusteau)
 
 Introduction
 ------------
 
-Gusteau is here to make servers provisioning simple and enjoyable. It's a good choice if you are running a small infrastructure or a VPS and want to use Chef. It provides an efficient interface to Chef Solo as well as some nice features:
+Gusteau is an easy to use configuration manager for Chef Solo and Vagrant. It provides an efficient interface to Chef Solo as well as some nice features:
 
 * Uses YAML for readable server configuration definitions
 * Uses a single SSH connection to stream compressed files and commands
@@ -24,60 +25,60 @@ Gettings started
 Gusteau is a Ruby gem:
 
 ```
-gem install gusteau
+gem install gusteau --pre
 ```
 
-A typical Gusteau node configuration looks like this:
+A typical Gusteau configuration looks like this:
 
 ```
-json:
-  mysql:
-    server_root_password: ASahiweqwqe2
-  rvm:
-    default_ruby: 1.9.3-p362
-  users:
-   - linguini
+environments:
+  development:
+    attributes:
+      mysql:
+        server_root_password: ASahiweqwqe2
+      rvm:
+        default_ruby: 1.9.3-p362
+      users:
+       - linguini
 
-roles:
-  - base
+    run_list:
+      - role[base]
+      - recipe[mysql::server]
+      - recipe[iptables]
 
-recipes:
-  - mysql::server
-  - iptables
-
-server:
-  host: 33.33.33.20
-  platform: ubuntu
-  password: omgsecret
+    nodes:
+      playground:
+        host: 33.33.33.20
+        password: omgsecret
 ```
 
-Gusteau only needs a node definition to run, but you'll need a few cookbooks to actually cook something :)
+Gusteau only needs a single node definition to run, but you'll need a few cookbooks to actually cook something :)
 The following command generates an example configuration to get you started:
 
 ```
 gusteau init project-name
 ```
 
-Next, `cd project-name` and see `nodes/example.yml`.
+Next, `cd project-name` and see `.gusteau.yml`.
 
 
-Provisioning a server
+Converging a server
 ----------
 
 The following command will run all roles and recipes from node's YAML file.
 
 ```
-gusteau example provision
+gusteau converge development-playground
 ```
 
 Use the `--bootstrap` or `-b` flag to bootstrap chef-solo (for the first time run).
 
-Running recipes
+Applying individual recipes
 -----------
-You may choose to run a few recipes instead of full provisioning.
+You may choose to run a custom run_list instead of the full convergence.
 
 ```
-gusteau example run redis::server ntp unicorn
+gusteau apply development-playground "role[base],recipe[oh-my-zsh]"
 ```
 
 SSH
@@ -85,7 +86,7 @@ SSH
 Gusteau provides a useful shortcut that you may use to ssh into a node. If you haven't got passwordless authentication set up, Gusteau will use `user` and `password` values from the node configuration.
 
 ```
-gusteau ssh example
+gusteau ssh development-playground
 ```
 
 Please note that `expect` utility must be installed for `gusteau ssh` to work.
@@ -123,7 +124,7 @@ end
 
 * The `prefix` option lets you prepend your VirtualBox VMs names, e.g. `loco-nodename`.
 * The `defaults` one lets you provide default values for `cpus`, `memory`, `box_url`.
-* If you'd like to use Vagrant's own automatic `chef_solo` provisioner, set `provision` to `true`. In this scenario, `gusteau provision` will be just calling `vagrant provision`.
+* If you'd like to use Vagrant's own automatic `chef_solo` provisioner, set `provision` to `true`.
 
 Please note that the add-on only works with Vagrant ~> 1.2 and needs gusteau to be installed as a Vagrant plugin:
 
@@ -135,5 +136,5 @@ Notes
 -----
 
 * Feel free to contribute a [bootstrap script](https://github.com/locomote/gusteau/tree/master/bootstrap) for your platform.
-* Gusteau uploads  both `./cookbooks` and `./site-cookbooks` so that you can use [librarian-chef](https://github.com/applicationsonline/librarian) to include third party cookbooks.
+* Gusteau uploads `./cookbooks` and `./site-cookbooks` from the current working directory.
 

data/bin/gusteau

@@ -13,14 +13,14 @@ class Gusteau::CLI < Optitron::CLI
   class_opt 'log_level', 'Set the log level',    :in => %w{debug info warn error fatal}
   class_opt 'why-run',   'Enable whyrun mode',   :short_name => 'W'
 
-  desc 'Fully provision a node'
-  def provision(node_name)
-    node(node_name).provision(params)
+  desc 'Fully converge a node'
+  def converge(node_name)
+    node(node_name).converge(params)
   end
 
-  desc 'Run recipe(s)'
-  def run(node_name, *recipe)
-    node(node_name).run(params, recipe)
+  desc 'Apply a run_list'
+  def apply(node_name, run_list)
+    node(node_name).apply(params, run_list.split(","))
   end
 
   desc 'SSH into a node'
@@ -30,25 +30,26 @@ class Gusteau::CLI < Optitron::CLI
 
   desc 'Generate an SSH config'
   def ssh_config
-    puts Gusteau::SSHConfig.new
+    puts Gusteau::SSHConfig.new(nodes)
   end
 
   desc 'Generate an example project (a bureau)'
   def init(bureau_name)
-    Gusteau::Bureau.new(bureau_name)
+    Gusteau::Bureau.new(bureau_name).generate!
   end
 
   private
 
   def node(node_name)
-    unless node_path = Dir.glob("./nodes/**/#{node_name}.yml")[0]
-      abort "Node '#{node_name}' is unknown. Known nodes are #{nodes_list.join(', ')}."
+    unless node = nodes[node_name]
+      abort "Node '#{node_name}' is unknown. Known nodes are #{nodes.keys.join(', ')}."
+    else
+      node
     end
-    Gusteau::Node.new(node_path)
   end
 
-  def nodes_list
-    Dir.glob("./nodes/**/*.yml").map { |f| File.basename(f, '.*') }
+  def nodes
+    @nodes ||= Gusteau::Config.nodes(".gusteau.yml")
   end
 
 end

data/gusteau.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Gusteau::VERSION
   gem.authors       = ["Vasily Mikhaylichenko", "Chris"]
   gem.email         = ["vasily@locomote.com", "chris@locomote.com"]
-  gem.description   = %q{A fine Chef Solo wrapper}
+  gem.description   = %q{Chef Solo wrapper and configuration manager}
   gem.summary       = %q{Making servers provisioning enjoyable since 2013.}
   gem.homepage      = "http://gusteau.gs"
 
@@ -21,9 +21,12 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'inform'
   gem.add_dependency 'json'
   gem.add_dependency 'hashie'
+  gem.add_dependency 'hash-deep-merge'
   gem.add_dependency 'net-ssh', '>= 2.2.2'
   gem.add_dependency 'archive-tar-minitar', '>= 0.5.2'
 
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'coveralls'
 end

data/lib/gusteau.rb

@@ -2,6 +2,7 @@ $LOAD_PATH << File.expand_path(File.dirname(__FILE__))
 
 module Gusteau
   require 'gusteau/node'
+  require 'gusteau/config'
   require 'gusteau/bureau'
   require 'gusteau/ssh_config'
   require 'gusteau/vagrant'

data/lib/gusteau/bureau.rb

@@ -8,41 +8,53 @@ module Gusteau
     include Gusteau::ERB
 
     def initialize(name)
-      template_path = File.expand_path('../../../template', __FILE__)
+      @name = name
+      @template_path = File.expand_path('../../../template', __FILE__)
 
       @login   = Etc.getlogin
       @ssh_key = File.read(File.expand_path '~/.ssh/id_rsa.pub').chomp rescue 'Your SSH key'
 
       abort "Directory #{name} already exists" if Dir.exists?(name)
+    end
 
-      FileUtils.cp_r(template_path, name)
+    def generate!(init = true)
+      FileUtils.cp_r(@template_path, @name)
+      yaml_template '.gusteau.yml'
+      text_template 'README.md'
+      json_template "data_bags/users/#{@login}.json", "data_bags/users/user.json.erb"
+      Dir.chdir(name) { system "bash ./init.sh ; rm ./init.sh" } if(init)
+    end
 
-      File.open(File.join(name, 'nodes', 'example.yml'), 'w+') do |f|
-        read_erb_yaml(File.join(template_path, 'nodes', 'example.yml.erb')).tap do |node|
-          f.write node.to_yaml
-          f.close
-        end
+    private
 
-        FileUtils.rm(File.join(name, 'nodes', 'example.yml.erb'))
+    def yaml_template(file)
+      replace_template file do |f|
+        read_erb_yaml("#{@template_path}/#{file}.erb").tap { |c| f.write(c.to_yaml) }
       end
+    end
 
-      File.open(File.join(name, 'data_bags', 'users', "#{@login}.json"), 'w+') do |f|
-        read_erb_json(File.join(template_path, 'data_bags', 'users', 'user.json.erb')).tap do |user|
-          f.write JSON::pretty_generate user
-          f.close
-        end
+    def json_template(file, src)
+      replace_template file, src do |f|
+        read_erb_json("#{@template_path}/#{src}").tap { |c| f.write JSON::pretty_generate(c) }
+      end
+    end
 
-        FileUtils.rm(File.join(name, 'data_bags', 'users', 'user.json.erb'))
+    def text_template(file)
+      replace_template file do |f|
+        read_erb("#{@template_path}/#{file}.erb").tap { |t| f.write t }
       end
+    end
 
-      puts "Created bureau '#{name}'"
-      Dir.chdir(name) do
-        puts   'Installing gem dependencies'
-        system 'bundle'
+    def replace_template(file, src = nil)
+      dest = "#{@name}/#{file}"
+      src  = "#{@name}/#{src}" if(src)
 
-        puts   'Installing cookbooks'
-        system 'bundle exec berks install --path ./cookbooks'
+      File.open(dest, 'w+') do |f|
+        yield f
+        f.close
+        FileUtils.rm(src || "#{dest}.erb")
       end
     end
+
   end
 end

data/lib/gusteau/chef.rb

@@ -1,8 +1,8 @@
 module Gusteau
   class Chef
-    def initialize(server, platform, dest_dir = '/etc/chef')
+    def initialize(server, platform = nil, dest_dir = '/etc/chef')
       @server   = server
-      @platform = platform
+      @platform = platform || 'omnibus'
       @dest_dir = dest_dir
     end
 

data/lib/gusteau/config.rb

@@ -0,0 +1,39 @@
+require 'gusteau/erb'
+require 'hash_deep_merge'
+
+module Gusteau
+  module Config
+    extend self
+    extend Gusteau::ERB
+
+    def nodes(config_path)
+      if File.exists?(config_path)
+        env_config = read_erb_yaml(config_path)['environments']
+        env_config.inject({}) do |nodes, (env_name, env_hash)|
+          if env_hash['nodes']
+            env_hash['nodes'].each_pair do |node_name, node_hash|
+              node_name = "#{env_name}-#{node_name}"
+              nodes[node_name] = build_node(node_name, env_hash, node_hash)
+            end
+          end
+          nodes
+        end
+      else
+        abort ".gusteau.yml not found"
+      end
+    end
+
+    #
+    # Node attributes get deep-merged with the environment ones
+    # Node run_list overrides the environment one
+    #
+    def build_node(node_name, env_hash, node_hash)
+      config = {
+        'server'     => node_hash,
+        'attributes' => env_hash['attributes'].deep_merge(node_hash['attributes'] || {}),
+        'run_list'   => node_hash['run_list'] || env_hash['run_list']
+      }
+      Gusteau::Node.new(node_name, config)
+    end
+  end
+end

data/lib/gusteau/node.rb

@@ -1,75 +1,43 @@
 require 'gusteau/server'
 require 'gusteau/chef'
-require 'gusteau/erb'
 
 module Gusteau
   class Node
-    include Gusteau::ERB
-
     attr_reader :name, :config, :server
 
-    def initialize(path)
-      raise "Node YAML file #{path} not found" unless path && File.exists?(path)
-
-      @name   = File.basename(path).gsub('.yml','')
-      @config = read_erb_yaml(path)
+    def initialize(name, config)
+      @name   = name
+      @config = config
 
       @server = Server.new(@config['server']) if @config['server']
       @dna_path = '/tmp/dna.json'
     end
 
-    def provision(opts = {})
-      wrap_vagrant :provision do
-        server.chef.run opts, dna(true)
-      end
+    def converge(opts = {})
+      server.chef.run opts, dna
     end
 
-    def run(opts = {}, *recipes)
-      wrap_vagrant :run do
-        server.chef.run opts, dna(false, recipes.flatten)
-      end
+    def apply(opts = {}, run_list)
+      server.chef.run opts, dna(run_list)
     end
 
     def ssh
-      wrap_vagrant :ssh do
-        server.ssh
-      end
+      server.ssh
     end
 
     private
 
-    def dna(include_all, recipes = [])
+    def dna(run_list = nil)
       node_dna = {
         :path => @dna_path,
         :hash => {
           :instance_role => @name,
-          :run_list      => run_list(include_all, recipes)
-        }.merge(@config['json'])
+          :run_list      => run_list || @config['run_list']
+        }.merge(@config['attributes'] || {})
       }
 
       File.open(node_dna[:path], 'w+') { |f| f.puts node_dna[:hash].to_json }
       node_dna
     end
-
-    def run_list(include_all, recipes)
-      if include_all
-        list = []
-        list += @config['roles'].map   { |r| "role[#{r}]"   } if @config['roles']
-        list += @config['recipes'].map { |r| "recipe[#{r}]" } if @config['recipes']
-        list
-      else
-        recipes.map { |r| "recipe[#{r}]" }
-      end
-    end
-
-    def wrap_vagrant(method)
-      if server
-        yield
-      elsif @config['vagrant']
-        Vagrant.send(method, @name)
-      else
-        Kernel.abort "Neither 'server' nor 'vagrant' defined for #{@name}. Please provide one."
-      end
-    end
   end
 end

data/lib/gusteau/ssh_config.rb

@@ -3,13 +3,14 @@ require 'gusteau/server'
 
 module Gusteau
   class SSHConfig
-    def initialize(root_dir = ".")
-      @config = Dir.glob("#{root_dir}/nodes/**/*.yml").sort.map do |n|
-        name   = File.basename(n, '.*')
-        config = YAML::load_file(n)['server']
+    def initialize(nodes)
+      @config = []
 
-        section name, Gusteau::Server.new(config)
-      end.join("\n")
+      nodes.each_pair do |name, node|
+        if server = node.server
+          @config << section(name, server)
+        end
+      end
     end
 
     def section(name, server)
@@ -25,7 +26,7 @@ Host #{name}
       <<-eos
 # BEGIN GUSTEAU NODES
 
-#{@config}
+#{@config.join("\n")}
 # END GUSTEAU NODES
       eos
     end