knife-vagrant 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,6 @@
 knife-vagrant
 ========
-First pass at knife-vagrant, a knife plugin that will create a Vagrant box, then run a set of Chef recipes in it.
+knife-vagrant tries to mirror the basic command structure of the knife-ec2 plugin for chef. The plugin will manage a series of Vagrantfiles in a tree to simulate a cloud environment.
 
 Requirements
 -------------------
@@ -21,38 +21,24 @@ knife-vagrant is available on rubygems.org.
 
 Usage
 -------------------
-knife vagrant test (options)
-
-    -b, --box BOX                    Name of vagrant box to be provisioned
-    -U, --box-url URL                URL of pre-packaged vbox template.  Can be a local path or an HTTP URL.  Defaults to ./package.box
-    -l, --chef-loglevel LEVEL        Logging level for the chef-client process that runs inside the provisioned VM.  Default is INFO
-    -s, --server-url URL             Chef Server URL
-    -k, --key KEY                    API Client Key
-        --[no-]color                 Use colored output, defaults to enabled
-    -c, --config CONFIG              The configuration file to use
-        --defaults                   Accept default values for all questions
-    -x, --destroy                    Destroy vagrant box and delete chef node/client when finished
-    -d, --disable-editing            Do not open EDITOR, just accept the data as is
-    -e, --editor EDITOR              Set the editor to use for interactive commands
-    -E, --environment ENVIRONMENT    Set the Chef environment
-    -F, --format FORMAT              Which format to use for output
-    -H, --hostname HOSTNAME          Hostname to be set as hostname on vagrant box when provisioned
-    -m, --memsize MEMORY             Amount of RAM to allocate to provisioned VM, in MB.  Defaults to 1024
-    -u, --user USER                  API Client Username
-    -p, --port-forward PORTS         Port forwarding.  Host port, VM port separated by a colon.  E.G. to forward 80 on the 
-                                     host machine to 8080 on the VM, -p 80:8080.  
-                                     To list multiple forwards separate with a comma, e.g. "-p 80:8080,22:2222"
-        --print-after                Show the data after a destructive operation
-    -D, --vagrant-dir PATH           Path to vagrant project directory.  Defaults to cwd (/Users/mgarrett/vagrant) if not specified
-    -r, --vagrant-run-list RUN_LIST  Comma separated list of roles/recipes to apply
-    -V, --verbose                    More verbose output. Use twice for max verbosity
-    -v, --version                    Show chef version
-    -y, --yes                        Say yes to all prompts for confirmation
-    -h, --help                       Show this message
-
-#### Example
-
-    knife vagrant test -b base -H vagrant-mgarrett01 -r role[vagrant] -m 2048 -p 22:2222,8080:8080 -b box64 -U http://files.vagrantup.com/lucid64.box -xy
+** VAGRANT COMMANDS **
+knife vagrant server [SUB-COMMAND]
+knife vagrant server ssh [hostname]
+knife vagrant server list
+knife vagrant server create (options)
+knife vagrant server delete [hostname] (args)
+
+#### Examples
+
+    knife vagrant server create -H vagrant01 -r role[vagrant] -m 2048 -p 22:2222,8080:8080 -U http://files.vagrantup.com/lucid64.box 
+
+    knife vagrant server list
+    testbox00
+    testbox01
+    testbox03
+
+    knife vagrant server ssh testbox00
+    [vagrant@testbox00 ~]$ 
 
 Disclaimer
 -------------------

data/lib/chef/knife/vagrant_server.rb

@@ -0,0 +1,232 @@
+# knife-vagrant
+# knife plugin for spinning up a vagrant instance and testing a runlist.
+
+module KnifePlugins
+
+  class VagrantServer < Chef::Knife
+    banner "knife vagrant server [SUB-COMMAND]"
+    
+    def run
+    end
+
+    #
+    class VagrantServerSsh < VagrantServer
+      banner "knife vagrant server ssh [hostname]"
+      deps do
+        require 'vagrant'
+        require 'vagrant/cli'
+      end
+
+      option :hostname,
+        :short => '-H HOSTNAME',
+        :long => '--hostname HOSTNAME',
+        :description => 'Hostname to be set as hostname on vagrant box when provisioned'
+
+      option :vagrant_dir,
+        :short => '-D PATH',
+        :long => '--vagrant-dir PATH',
+        :description => "Path to vagrant project directory.  Defaults to cwd (#{Dir.pwd}) if not specified",
+        :default => Dir.pwd + "/vagrant"
+
+      def run
+        unless config[:hostname] || name_args.size >= 1
+          ui.fatal "Please provide a box name."
+          show_usage
+          exit 1
+        end
+        
+        if name_args.size >= 1 then 
+          hostname = name_args.first
+        else 
+          hostname = config[:hostname] 
+        end
+        
+        
+        @vagrant_env = Vagrant::Environment.new(:cwd => "#{config[:vagrant_dir]}/#{hostname}/", :ui_class => Vagrant::UI::Colored)
+        @vagrant_env.load!
+        @vagrant_env.cli("ssh")
+      end
+    end
+
+    #
+    class VagrantServerList < Chef::Knife
+      banner "knife vagrant server list"
+
+      deps do
+        require 'vagrant'
+        require 'vagrant/cli'
+      end
+
+      def run
+        @vagrant_env = Vagrant::Environment.new(:ui_class => Vagrant::UI::Colored)
+        @vagrant_env.load!
+        @vagrant_env.cli("box","list")
+      end
+    end
+
+    #
+    class VagrantServerCreate < VagrantServer
+      banner "knife vagrant server create (options)"
+
+      deps do
+        require 'vagrant'
+        require 'vagrant/cli'
+      end
+
+      option :port_forward,
+        :short => '-p PORTS',
+        :long => '--port-forward PORTS',
+        :description => "Port forwarding.  Host port, VM port separated by a colon.  E.G. to forward 80 on the host machine to 8080 on the VM, -p 80:8080.  To list multiple forwards separate with a comma, e.g. \"-p 80:8080,22:2222\"",
+        :proc => lambda { |o| Hash[o.split(/,/).collect { |a| a.split(/:/) }] },
+        :default => {}
+  
+      option :vagrant_dir,
+        :short => '-D PATH',
+        :long => '--vagrant-dir PATH',
+        :description => "Path to vagrant project directory.  Defaults to cwd (#{Dir.pwd}) if not specified",
+        :default => Dir.pwd + "/vagrant"
+        
+      option :vagrant_run_list,
+        :short => "-r RUN_LIST",
+        :long => "--vagrant-run-list RUN_LIST",
+        :description => "Comma separated list of roles/recipes to apply",
+        :proc => lambda { |o| o.split(/[\s,]+/) },
+        :default => ["role[base]"]
+
+      option :hostname,
+        :short => '-H HOSTNAME',
+        :long => '--hostname HOSTNAME',
+        :description => 'Hostname to be set as hostname on vagrant box when provisioned'
+
+      option :box_url,
+        :short => '-U URL',
+        :long => '--box-url URL',
+        :description => 'URL of pre-packaged vbox template.  Can be a local path or an HTTP URL.  Defaults to ./package.box',
+        :default => "#{Dir.pwd}/package.box"
+
+      option :memsize,
+        :short => '-m MEMORY',
+        :long => '--memsize MEMORY',
+        :description => 'Amount of RAM to allocate to provisioned VM, in MB.  Defaults to 1024',
+        :default => 1024
+    
+      option :chef_loglevel,
+        :short => '-l LEVEL',
+        :long => '--chef-loglevel LEVEL',
+        :description => 'Logging level for the chef-client process that runs inside the provisioned VM.  Default is INFO',
+        :default => 'INFO'
+
+      # TODO - hook into chef/runlist
+      def build_runlist(runlist)
+        runlist.collect { |i| "\"#{i}\"" }.join(",\n")
+      end
+
+      def build_port_forwards(ports)
+        ports.collect { |k, v| "config.vm.forward_port(#{k}, #{v})" }.join("\n")
+      end
+
+      # TODO:  see if there's a way to pass this whole thing in as an object or hash or something, instead of writing a file to disk.
+      def build_vagrantfile
+        file = <<-EOF
+          Vagrant::Config.run do |config|
+            #{build_port_forwards(config[:port_forward])}
+            config.vm.box = "#{config[:hostname]}"
+            config.vm.host_name = "#{config[:hostname]}"
+            config.vm.customize [ "modifyvm", :id, "--memory", #{config[:memsize]} ]
+            config.vm.customize [ "modifyvm", :id, "--name", "#{config[:hostname]}" ]
+            config.vm.box_url = "#{config[:box_url]}"
+            config.vm.provision :chef_client do |chef|
+              chef.chef_server_url = "#{Chef::Config[:chef_server_url]}"
+              chef.validation_key_path = "#{Chef::Config[:validation_key]}"
+              chef.validation_client_name = "#{Chef::Config[:validation_client_name]}"
+              chef.node_name = "#{config[:hostname]}"
+              chef.log_level = :#{config[:chef_loglevel].downcase}
+              chef.environment = "#{Chef::Config[:environment]}"
+              chef.run_list = [
+                #{build_runlist(config[:vagrant_run_list])}
+              ]
+            end
+          end
+        EOF
+        file
+      end
+        
+      def write_vagrantfile(path, content)
+        File.open(path, 'w') { |f| f.write(content) }
+      end
+
+      #
+      def run
+        puts "Initializing..."
+        vagrantfile = "Vagrantfile"
+        vagrantdir = "#{config[:vagrant_dir]}/#{config[:hostname]}/"
+
+        unless File.directory?(vagrantdir)
+          Dir.mkdir(vagrantdir)
+        end
+        write_vagrantfile("#{vagrantdir}/#{vagrantfile}", build_vagrantfile)
+        @vagrant_env = Vagrant::Environment.new(:cwd => vagrantdir, :ui_class => Vagrant::UI::Colored)
+        @vagrant_env.load!
+        
+        begin
+          @vagrant_env.cli("up")
+        rescue
+          raise # I'll put some error handling here later.
+        ensure
+        end
+      end
+    end
+
+    #
+    class VagrantServerDelete < Chef::Knife
+      banner "knife vagrant server delete [hostname] (args)"
+
+      deps do
+        require 'vagrant'
+        require 'vagrant/cli'
+        require 'chef/node'
+        require 'chef/api_client'
+      end
+
+      option :hostname,
+        :short => '-H HOSTNAME',
+        :long => '--hostname HOSTNAME',
+        :description => 'Hostname to be set as hostname on vagrant box when provisioned'
+      option :vagrant_dir,
+        :short => '-D PATH',
+        :long => '--vagrant-dir PATH',
+        :description => "Path to vagrant project directory.  Defaults to cwd (#{Dir.pwd}) if not specified",
+        :default => Dir.pwd + "/vagrant"
+
+      def run
+        unless config[:hostname] || name_args.size >= 1
+          ui.fatal "Please provide a hostname."
+          show_usage
+          exit 1
+        end
+        
+        if name_args.size >= 1 then 
+          hostname = name_args.first
+        else 
+          hostname = config[:hostname] 
+        end
+
+        vagrantfile = "Vagrantfile"
+        vagrantdir = "#{config[:vagrant_dir]}/#{hostname}/"
+
+        # confirm delete
+        ui.confirm("Destroy vagrant box #{hostname} and delete chef node and client")
+        
+        #Dir.chdir("#{config[:vagrant_dir]}/#{config[:hostname]}/")
+        @vagrant_env = Vagrant::Environment.new(:cwd => vagrantdir, :ui_class => Vagrant::UI::Colored)
+        @vagrant_env.load!
+        @vagrant_env.cli("box","remove",hostname)
+        delete_object(Chef::Node, hostname)
+        delete_object(Chef::ApiClient, hostname)
+        Dir.delete( vagrantdir )
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-vagrant
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/chef/knife/vagrant_test.rb
+- lib/chef/knife/vagrant_server.rb
 homepage: https://github.com/garrettux/knife-vagrant
 licenses: []
 post_install_message: 

data/lib/chef/knife/vagrant_test.rb

@@ -1,141 +0,0 @@
-# knife-vagrant
-# knife plugin for spinning up a vagrant instance and testing a runlist.
-
-module KnifePlugins
-  class VagrantTest < Chef::Knife
-
-    banner "knife vagrant test (options)"
-
-    deps do
-      require 'rubygems'
-      require 'pp'
-      require 'vagrant'
-      require 'vagrant/cli'
-      require 'chef/node'
-      require 'chef/api_client'
-    end
-
-    option :port_forward,
-      :short => '-p PORTS',
-      :long => '--port-forward PORTS',
-      :description => "Port forwarding.  Host port, VM port separated by a colon.  E.G. to forward 80 on the host machine to 8080 on the VM, -p 80:8080.  To list multiple forwards separate with a comma, e.g. \"-p 80:8080,22:2222\"",
-      :proc => lambda { |o| Hash[o.split(/,/).collect { |a| a.split(/:/) }] },
-      :default => {}
- 
-    option :vagrant_dir,
-      :short => '-D PATH',
-      :long => '--vagrant-dir PATH',
-      :description => "Path to vagrant project directory.  Defaults to cwd (#{Dir.pwd}) if not specified",
-      :default => Dir.pwd
-      
-    option :vagrant_run_list,
-      :short => "-r RUN_LIST",
-      :long => "--vagrant-run-list RUN_LIST",
-      :description => "Comma separated list of roles/recipes to apply",
-      :proc => lambda { |o| o.split(/[\s,]+/) },
-      :default => []
- 
-    option :box,
-      :short => '-b BOX',
-      :long => '--box BOX',
-      :description => 'Name of vagrant box to be provisioned',
-      :default => false
-
-    option :hostname,
-      :short => '-H HOSTNAME',
-      :long => '--hostname HOSTNAME',
-      :description => 'Hostname to be set as hostname on vagrant box when provisioned',
-      :default => 'vagrant_test'
-
-    option :box_url,
-      :short => '-U URL',
-      :long => '--box-url URL',
-      :description => 'URL of pre-packaged vbox template.  Can be a local path or an HTTP URL.  Defaults to ./package.box',
-      :default => "#{Dir.pwd}/package.box"
-
-    option :memsize,
-      :short => '-m MEMORY',
-      :long => '--memsize MEMORY',
-      :description => 'Amount of RAM to allocate to provisioned VM, in MB.  Defaults to 1024',
-      :default => 1024
-  
-    option :chef_loglevel,
-      :short => '-l LEVEL',
-      :long => '--chef-loglevel LEVEL',
-      :description => 'Logging level for the chef-client process that runs inside the provisioned VM.  Default is INFO',
-      :default => 'INFO'
-
-    option :destroy,
-      :short => '-x',
-      :long => '--destroy',
-      :description => 'Destroy vagrant box and delete chef node/client when finished',
-      :default => false
-
-    # TODO - hook into chef/runlist
-    def build_runlist(runlist)
-      runlist.collect { |i| "\"#{i}\"" }.join(",\n")
-    end
-
-    def build_port_forwards(ports)
-      ports.collect { |k, v| "config.vm.forward_port(#{k}, #{v})" }.join("\n")
-    end
-
-    # TODO:  see if there's a way to pass this whole thing in as an object or hash or something, instead of writing a file to disk.
-    def build_vagrantfile
-      file = <<-EOF
-        Vagrant::Config.run do |config|
-          #{build_port_forwards(config[:port_forward])}
-          config.vm.box = "#{config[:box]}"
-          config.vm.host_name = "#{config[:hostname]}"
-          config.vm.customize [ "modifyvm", :id, "--memory", #{config[:memsize]} ]
-          config.vm.customize [ "modifyvm", :id, "--name", "#{config[:box]}" ]
-          config.vm.box_url = "#{config[:box_url]}"
-          config.vm.provision :chef_client do |chef|
-            chef.chef_server_url = "#{Chef::Config[:chef_server_url]}"
-            chef.validation_key_path = "#{Chef::Config[:validation_key]}"
-            chef.validation_client_name = "#{Chef::Config[:validation_client_name]}"
-            chef.node_name = "#{config[:hostname]}"
-            chef.log_level = :#{config[:chef_loglevel].downcase}
-            chef.environment = "#{Chef::Config[:environment]}"
-            chef.run_list = [
-              #{build_runlist(config[:vagrant_run_list])}
-            ]
-          end
-        end
-      EOF
-      file
-    end
-      
-    def write_vagrantfile(path, content)
-      File.open(path, 'w') { |f| f.write(content) }
-    end
-  
-    def cleanup(path)
-      File.delete(path)
-    end
-    
-    def run
-      ui.msg('Loading vagrant environment..')
-      Dir.chdir(config[:vagrant_dir])
-      vagrantfile = "#{config[:vagrant_dir]}/Vagrantfile"
-      write_vagrantfile(vagrantfile, build_vagrantfile)
-      @vagrant_env = Vagrant::Environment.new(:cwd => config[:vagrant_dir], :ui_class => Vagrant::UI::Colored)
-      @vagrant_env.load!
-      begin
-        @vagrant_env.cli("up")
-      rescue
-        raise # I'll put some error handling here later.
-      ensure
-        if config[:destroy]
-          ui.confirm("Destroy vagrant box #{config[:box]} and delete chef node and client")
-          args = %w[ destroy --force ]
-          @vagrant_env.cli(args)
-          config[:yes]
-          delete_object(Chef::Node, config[:hostname])
-          delete_object(Chef::ApiClient, config[:hostname])
-        end
-      end
-    end
-
-  end
-end