gusteau 0.4.7 → 0.4.8

data/README.md

@@ -9,7 +9,7 @@ Gusteau
 Introduction
 ------------
 
-Gusteau is here to make servers provisioning simple and enjoyable. It provides an efficient interface to Chef Solo as well as some nice features:
+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:
 
 * Uses YAML for readable server configuration definitions
 * Uses a single SSH connection to stream compressed files and commands
@@ -29,7 +29,7 @@ gem install gusteau
 
 A typical Gusteau node configuration looks like this:
 
-```YAML
+```
 json:
   mysql:
     server_root_password: ASahiweqwqe2
@@ -39,8 +39,7 @@ json:
    - linguini
 
 roles:
-  - platform
-  - rails
+  - base
 
 recipes:
   - mysql::server
@@ -49,7 +48,7 @@ recipes:
 server:
   host: 33.33.33.20
   platform: ubuntu
-  password: vagrant
+  password: omgsecret
 ```
 
 Gusteau only needs a node definition to run, but you'll need a few cookbooks to actually cook something :)
@@ -68,7 +67,7 @@ Provisioning a server
 The following command will run all roles and recipes from node's YAML file.
 
 ```
-gusteau node-name provision
+gusteau example provision
 ```
 
 Use the `--bootstrap` or `-b` flag to bootstrap chef-solo (for the first time run).
@@ -78,7 +77,7 @@ Running recipes
 You may choose to run a few recipes instead of full provisioning.
 
 ```
-gusteau node-name run redis::server ntp unicorn
+gusteau example run redis::server ntp unicorn
 ```
 
 SSH
@@ -86,8 +85,9 @@ 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 node-name
+gusteau ssh example
 ```
+
 Please note that `expect` utility must be installed for `gusteau ssh` to work.
 
 If you prefer calling ssh directly, you will find the `gusteau ssh_config` subcommand useful:
@@ -98,9 +98,9 @@ gusteau ssh_config >> ~/.ssh/config
 
 Using with Vagrant
 ------------------
-Gusteau comes with partial Vagrant integration. It enables you to move node-specific Vagrant configuration away from the Vagrantfile into node yml files, e.g.
+Gusteau can save you from writing some Vagrantfile boilerplate code. It also enables you to move node-specific Vagrant configuration away from the Vagrantfile into node yml files.
 
-```YAML
+```
 ...
 vagrant:
   IP: 192.168.100.20
@@ -109,25 +109,28 @@ vagrant:
   box_url: 'https://opscode-vm.s3.amazonaws.com/vagrant/opscode_ubuntu-12.04_provisionerless.box'
 ```
 
-This way you can tidy up your Vagrantfile:
-
-```ruby
-Vagrant.require_plugin 'gusteau'
+The following bit will configure Vagrant for all Gusteau nodes which have `vagrant` section defined.
 
+```
 Vagrant.configure('2') do |config|
-  defaults = { :box_url => 'http://www.something.com/different.box' } # optional
-  Gusteau::Vagrant.define_nodes config, defaults
+  Gusteau::Vagrant.detect(config) do |setup|
+    setup.prefix = 'loco'
+    setup.defaults.box_url = 'http://example.com/vm/opscode_centos-6.4.box'
+    setup.provision = false
+  end
 end
 ```
 
-Please note that this feature only works with Vagrant ~> 1.2 and needs gusteau to be installed as a Vagrant plugin:
+* 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`.
+
+Please note that the add-on only works with Vagrant ~> 1.2 and needs gusteau to be installed as a Vagrant plugin:
 
 ```
 vagrant plugin install gusteau
 ```
 
-Gusteau doesn't automatically provision your Vagrant nodes.
-
 Notes
 -----
 

data/gusteau.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'optitron'
   gem.add_dependency 'inform'
   gem.add_dependency 'json'
+  gem.add_dependency 'hashie'
   gem.add_dependency 'net-ssh', '>= 2.2.2'
   gem.add_dependency 'archive-tar-minitar', '>= 0.5.2'
 

data/lib/gusteau/log.rb

@@ -2,24 +2,6 @@ require 'inform'
 
 module Gusteau
   module Log
-    private
-
-    def timestamp
-      Time.now.strftime('%Y-%m-%dT%H:%M:%S')
-    end
-
-    def indent
-      @level = (@level || 0) + 1
-    end
-
-    def unindent
-      @level = (@level || 0) - 1
-    end
-
-    def prompt
-      "[#{timestamp}] GUSTEAU: #{'  ' * (@level || 0)}"
-    end
-
     def log(msg, opts={})
       info "%{prompt}#{msg}", opts.merge(:prompt => prompt)
       if block_given?
@@ -41,5 +23,23 @@ module Gusteau
     def info(str, opts={})
       Inform.info str, opts
     end
+
+    private
+
+    def timestamp
+      Time.now.strftime('%Y-%m-%dT%H:%M:%S')
+    end
+
+    def indent
+      @level = (@level || 0) + 1
+    end
+
+    def unindent
+      @level = (@level || 0) - 1
+    end
+
+    def prompt
+      "[#{timestamp}] GUSTEAU: #{'  ' * (@level || 0)}"
+    end
   end
 end

data/lib/gusteau/node.rb

@@ -6,7 +6,7 @@ module Gusteau
   class Node
     include Gusteau::ERB
 
-    attr_reader :server
+    attr_reader :name, :config, :server
 
     def initialize(path)
       raise "Node YAML file #{path} not found" unless path && File.exists?(path)
@@ -14,21 +14,26 @@ module Gusteau
       @name   = File.basename(path).gsub('.yml','')
       @config = read_erb_yaml(path)
 
+      @server = Server.new(@config['server']) if @config['server']
       @dna_path = '/tmp/dna.json'
-
-      @server = Server.new(@config['server'])
     end
 
     def provision(opts = {})
-      @server.chef.run opts, dna(true)
+      wrap_vagrant :provision do
+        server.chef.run opts, dna(true)
+      end
     end
 
     def run(opts = {}, *recipes)
-      @server.chef.run opts, dna(false, recipes.flatten)
+      wrap_vagrant :run do
+        server.chef.run opts, dna(false, recipes.flatten)
+      end
     end
 
     def ssh
-      @server.ssh
+      wrap_vagrant :ssh do
+        server.ssh
+      end
     end
 
     private
@@ -56,5 +61,15 @@ module Gusteau
         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/vagrant.rb

@@ -1,59 +1,111 @@
+require 'hashie'
+require 'gusteau/log'
+
+class Hash; include Hashie::Extensions::SymbolizeKeys; end
+
 module Gusteau
   module Vagrant
     extend self
+    extend Gusteau::Log
+
+    def detect(config)
+      options = Hashie::Mash.new
+      options.defaults = Hashie::Mash.new
 
-    def complete_defaults(d)
-      d[:ip]     ||= '33.33.33.99'
-      d[:memory] ||= 1024
-      d[:cpus]   ||= 1
-      d
+      yield options if block_given?
+      define_nodes(config, options.to_hash.symbolize_keys)
     end
 
-    def vagrant_config(config_path, defaults, label)
-      if config = YAML::load_file(config_path)['vagrant']
-        name  = File.basename(config_path, '.yml')
-        label = label.nil? ? name : "#{label}-#{name}"
+    def define_nodes(config, options, prefix = nil)
+      if prefix
+        options[:prefix] = prefix
+        info "The 'prefix' param is deprecated. Please refer to the new Gusteau::Vagrant syntax."
+      end
 
-        box_url = config.fetch 'box_url' do
-          raise "Box url can't be determined for #{name}" unless defaults[:box_url]
-          defaults[:box_url]
+      Dir.glob("#{options[:dir] || './nodes'}/**/*.yml").sort.each do |path|
+        node = ::Gusteau::Node.new(path)
+        if node.config['vagrant']
+          define_vm config, node, options
         end
+      end
+    end
 
-        defaults = complete_defaults(defaults)
-        {
-          :name    => name,
-          :label   => label,
-          :box_url => box_url,
-          :ip      => config.fetch('IP',      defaults[:ip]),
-          :cpus    => config.fetch('cpus',    defaults[:cpus]),
-          :memory  => config.fetch('memory',  defaults[:memory])
-        }
+    def vm_config(node, options)
+      defaults = options[:defaults] || {}
+      config   = node.config['vagrant']
+      label    = options[:prefix] ? "#{options[:prefix]}-#{node.name}" : node.name
+
+      config = {} if config == true
+
+      box_url = config.fetch 'box_url' do
+        unless defaults[:box_url]
+          raise "Box url can't be determined for #{node.name}"
+        end
+        defaults[:box_url]
       end
+
+      {
+        :name    => node.name,
+        :label   => label,
+        :box_url => box_url,
+        :ip      => config['IP']     || defaults[:ip],
+        :cpus    => config['cpus']   || defaults[:cpus]   || 1,
+        :memory  => config['memory'] || defaults[:memory] || 1024
+      }
     end
 
-    def define_vm(c, config)
-      c.vm.define config[:name] do |instance|
-        instance.vm.box     = config[:name]
-        instance.vm.box_url = config[:box_url]
+    def define_vm(config, node, options)
+      vm_config = vm_config(node, options)
+
+      config.vm.define vm_config[:name] do |instance|
+        instance.vm.box     = vm_config[:name]
+        instance.vm.box_url = vm_config[:box_url]
 
         instance.vm.provider :virtualbox do |vb|
           vb.customize ['modifyvm', :id,
-            '--memory', config[:memory],
-            '--name',   config[:label],
-            '--cpus',   config[:cpus]
+            '--memory', vm_config[:memory],
+            '--name',   vm_config[:label],
+            '--cpus',   vm_config[:cpus],
+            '--natdnsproxy1', 'on'
           ]
         end
-        instance.vm.network :private_network, :ip => config[:ip]
+
+        if vm_config[:ip]
+          instance.vm.network :private_network, :ip => vm_config[:ip]
+        end
+
+        define_provisioner(instance, node) if options[:provision]
       end
     end
 
-    def define_nodes(c, defaults = {}, label = nil)
-      Dir.glob("./nodes/**/*.yml").sort.each do |path|
-        if config = vagrant_config(path, defaults, label)
-          define_vm c, config
-        end
+    def define_provisioner(instance, node)
+      instance.vm.provision 'chef_solo' do |chef|
+        chef.data_bags_path = 'data_bags'
+        chef.cookbooks_path = ['cookbooks', 'site-cookbooks']
+        chef.json = node.config['json'] || {}
+
+        (node.config['recipes'] || []).each { |r| chef.add_recipe(r) }
+        (node.config['roles']   || []).each { |r| chef.add_role(r)   }
       end
     end
 
+    def ssh(nodename)
+      vagrant_cmd("ssh #{nodename}")
+    end
+
+    def provision(nodename)
+      vagrant_cmd("provision #{nodename}")
+    end
+
+    def vagrant_cmd(cmd)
+      info "Running 'vagrant #{cmd}'"
+      Kernel.system("vagrant #{cmd}")
+      Kernel.exit $?.exitstatus
+    end
+
+    def run(nodename)
+      Kernel.abort "'run' is not supported for vagrant-only nodes. Please configure 'server' for #{nodename} node"
+    end
   end
 end
+

data/lib/gusteau/version.rb

@@ -1,3 +1,3 @@
 module Gusteau
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

data/spec/lib/gusteau/node_spec.rb

@@ -38,4 +38,65 @@ describe Gusteau::Node do
       end
     end
   end
+
+  describe "#vagrant_wrap" do
+    let(:node) { Gusteau::Node.new('spec/nodes/development.yml') }
+
+    describe "#ssh" do
+      context "server is defined" do
+        it "should call server.ssh" do
+          node.server.expects(:ssh)
+          node.ssh
+        end
+      end
+
+      context "vagrant is defined, server is not" do
+        before do
+          node.stubs(:server).returns(nil)
+        end
+
+        it "should call 'vagrant ssh'" do
+          Kernel.expects(:system).with("vagrant ssh development")
+          Kernel.expects(:exit)
+          node.ssh
+        end
+      end
+
+      context "neither server nor vagrant are defined" do
+        before do
+          node.stubs(:server).returns(nil)
+          node.config['vagrant'] = nil
+        end
+
+        it "should exit with an error" do
+          Kernel.expects(:abort)
+          node.ssh
+        end
+      end
+    end
+
+    describe "#run" do
+      context "server is defined" do
+        it "should call server.chef.run" do
+          chef = mock()
+          node.server.expects(:chef).returns(chef)
+          chef.expects(:run)
+
+          node.run('test')
+        end
+      end
+
+      context "vagrant is defined, server is not" do
+        before do
+          node.stubs(:server).returns(nil)
+        end
+
+        it "should exit with an error" do
+          Kernel.expects(:abort).with("'run' is not supported for vagrant-only nodes. Please configure 'server' for development node")
+          node.run('test')
+        end
+      end
+
+    end
+  end
 end

data/spec/lib/gusteau/vagrant_spec.rb

@@ -1,73 +1,91 @@
 require './spec/spec_helper.rb'
 
 describe Gusteau::Vagrant do
-  let(:defaults) do
-    {
-      :box_url => 'https://opscode.s3.amazonaws.com/centos-6.4.box',
-      :cpus    => 64
-    }
-  end
-  let(:label) { 'hyper' }
-
-  describe "#vagrant_config" do
-    subject { Gusteau::Vagrant.vagrant_config(config_path, defaults, label) }
 
-    context "non-vagrant node" do
-      let(:config_path) { './spec/nodes/staging.yml' }
+  describe "#detect" do
+    let(:config)   { mock() }
+    let(:vm)       { mock() }
+    let(:instance) { mock() }
+    let(:subvm)    { stub_everything('subvm') }
 
-      it "should return nil" do
-        subject.must_equal nil
+    before do
+      def vm.define(name)
+        yield instance
       end
+
+      config.expects(:vm).at_least_once.returns(vm)
+      vm.expects(:instance).at_least_once.returns(instance)
+      instance.expects(:vm).at_least_once.returns(subvm)
     end
 
-    context "vagrant node" do
-      let(:config_path) { './spec/nodes/development.yml' }
-
-      let(:expected_label)  { 'hyper-development' }
-      let(:expected_memory) { 1024 }
-
-      let(:expected_config) do
-        {
-          :name    => 'development',
-          :label   => expected_label,
-          :box_url => 'https://opscode.s3.amazonaws.com/centos-6.4.box',
-          :ip      => '192.168.100.21',
-          :cpus    => 4,
-          :memory  => expected_memory
-        }
+    it "should define vm instances with correct settings" do
+      subvm.expects('box='.to_sym).with('development')
+      subvm.expects('box_url='.to_sym).with("http://a.com/b.box")
+      subvm.expects(:network).with(:private_network, { :ip => '192.168.100.21' })
+      subvm.expects(:provision).never
+
+      Gusteau::Vagrant.detect(config) do |setup|
+        setup.dir = './spec/nodes'
+        setup.defaults.box_url = "http://a.com/b.box"
       end
+    end
 
-      def config_expectation
-        subject.must_equal(expected_config)
+    it "should define provisioner" do
+      subvm.expects(:provision).with('chef_solo')
+
+      Gusteau::Vagrant.detect(config) do |setup|
+        setup.dir = './spec/nodes'
+        setup.defaults.box_url = "http://a.com/b.box"
+        setup.provision = true
       end
+    end
+  end
 
-      specify { config_expectation }
+  describe "#vm_config" do
+    subject { Gusteau::Vagrant.vm_config(node, options) }
 
-      context "label not specified" do
-        let(:label) { nil }
-        let(:expected_label) { 'development' }
+    let(:defaults) do
+      {
+        :box_url => 'https://opscode.s3.amazonaws.com/centos-6.4.box',
+        :cpus    => 64,
+        :memory  => 4096,
+      }
+    end
+    let(:prefix)  { 'hyper' }
+    let(:options) { { :defaults => defaults, :prefix => prefix } }
 
-        specify { config_expectation }
-      end
+    let(:node) { ::Gusteau::Node.new('./spec/nodes/development.yml') }
+
+    let(:expected_label) { 'hyper-development' }
+    let(:expected_config) do
+      {
+        :name    => 'development',
+        :label   => expected_label,
+        :box_url => 'https://opscode.s3.amazonaws.com/centos-6.4.box',
+        :ip      => '192.168.100.21',
+        :cpus    => 4,
+        :memory  => 4096
+      }
+    end
 
-      context "different memory defaults" do
-        let(:defaults) do
-          {
-            :memory => 4096,
-            :box_url => 'https://opscode.s3.amazonaws.com/centos-6.4.box',
-          }
-        end
-        let(:expected_memory) { 4096 }
+    it "should merge in defaults" do
+      subject.must_equal(expected_config)
+    end
+
+    context "prefix not specified" do
+      let(:prefix) { nil }
+      let(:expected_label) { 'development' }
 
-        specify { config_expectation }
+      it "should omit the prefix" do
+        subject.must_equal(expected_config)
       end
+    end
 
-      context "box_url not specified" do
-        let(:defaults) { {} }
+    context "box_url not specified" do
+      let(:defaults) { {} }
 
-        it "should raise an exception" do
-          proc { subject }.must_raise RuntimeError
-        end
+      it "should raise an exception" do
+        proc { subject }.must_raise RuntimeError
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gusteau
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optitron
@@ -60,6 +60,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement