knife-solo 0.0.15 → 0.1.0.pre1

data/CHANGELOG.md

@@ -0,0 +1,216 @@
+# 0.1.0: In progress
+
+## Goals
+
+* Cleaner bootstrap code
+* Local integration testing
+* Compatibility with plugins like knife-ec2
+
+# Not released yet
+
+* Move all commands under "knife solo" namespace (#118)
+    - Rename `knife kitchen` to `knife solo init`
+    - Rename `knife wash_up` to `knife solo clean`
+* Add `knife solo bootstrap` command (#120)
+* Detect Fedora 17 (#141)
+* Improve help/error messages and validation (#142)
+* Fix exit status of "cook" if chef-solo fails (#97)
+
+## Thanks to our contributors!
+
+* [Marek Hulan][ares]
+
+# 0.0.15: November 29th, 2012
+
+* Support for non-x86 omnibus (#137)
+* Validate hostname in wash\_up (7a9115)
+* Scientific Linux support (#131)
+* Default to SSL omnibus URL (#130)
+* Fixes for base debian installations (#129)
+* Whyrun flag support (#123)
+* Node-name flag support (#107)
+* No More Syntax Check!! (#122)
+
+* Various fixes: #138, #119, #113, d38bfd1
+
+## Thanks to our contributors!
+
+* [David Schneider][davidsch]
+* [Andrew Vit][avit]
+* [Nick Shortway][DrGonzo65]
+* [Guido Serra aka Zeph][zeph]
+* [Patrick Connolly][patcon]
+* [Greg Fitzgerald][gregf]
+* [Bryan McLellan][btm]
+* [Aaron Jensen][aaronjensen]
+
+And a special thanks to [Teemu Matilainen][tmatilai] who is now on the list of direct colaborators!
+
+# 0.0.14: September 21st, 2012
+
+* Fix argument checks (#101)
+* Allow custom omnibus URLs (#99)
+* Verbose logging options (#96)
+
+## Thanks to our contributors!
+
+* [Vaughan Rouesnel][vjpr]
+* [Ryan Walker][ryandub]
+* [Aaron Cruz][pferdefleisch]
+
+# 0.0.13: August 16th, 2012
+
+* Less agressive in-kitchen check (36a14161a1c)
+* New curl/wget selection during omnibus install (#84)
+* FreeBSD 9.0 support (#78)
+* Syntax-check-only switch (#74)
+* Validate CLI user/host args (#73)
+
+## Thanks to our contributors!
+
+* [Deepak Kannan][deepak]
+* [Florian Unglaub][funglaub]
+
+# 0.0.12: June 25th, 2012
+
+* Better validation on CLI args (#68, #70)
+* Switch from wget to curl (#66)
+* Initial fedora support (not under integration) (#67)
+* Support new omnibus path (/opt/chef)
+
+## Thanks to our contributors!
+
+* [Bryan Helmkamp][brynary]
+* [Greg Fitzgerald][gregf]
+* [Deepak Kannan][deepak]
+
+# 0.0.11: June 16th, 2012
+
+* Encrypted data bag support (#22)
+* Updated dependency version (#63, #64)
+* Joyent Ubuntu detection (#62)
+* Omnibus version selection (#61)
+
+## Thanks to our contributors!
+
+* [Hector Castro][hectcastro]
+* [Sean Porter][portertech]
+
+# 0.0.10: May 30th, 2012
+
+* Include apache recipe during integration testing (#17)
+* Use omnibus installer on Ubuntu and RedHat (#40, #45, #58)
+* `knife wash_up` command for removing uploaded resources (#48)
+* Cleaner sudo pre-processing (#59)
+* Support `knife kitchen .` to init an existing kitchen (#54)
+
+## Thanks to our contributors!
+
+* [Hector Castro][hectcastro]
+* [Nix-wie-weg][Nix-wie-weg]
+* [Justin Grevich][jgrevich]
+* [Ross Timson][rosstimson]
+
+# 0.0.9: May 13th, 2012
+
+* Chef 0.10.10 compatibility (b0fa50e9)
+* Finished support and integration testing for remaining key OSes (Issues #2 and #15)
+* Added support for 'chefignore' (e4bcbd1..4b578cf9)
+* Use `lsb_release` to detect OSes where possible (c976cc119..a31d8234b)
+* Ignore `tmp` and `deploy_revision` to rsync exclusion (7d252ff2b)
+
+## Thanks to our contributors!
+
+* [Hector Castro][hectcastro]
+* [Amos Lanka][amoslanka]
+* [Roland Moriz][rmoriz]
+* [Tyler Rick][TylerRick]
+* [Motiejus Jakštys][Motiejus]
+
+# 0.0.8: February 10, 2012
+
+* Add --startup-script which gets sourced before any command to setup env vars (e.g., ~/.bashrc) (d1489f94)
+* Use curl + rpm rather than rpm against direct URL for better proxy support (51ad9c51)
+* Integration harness improvements (1ac5cce..4be36c2)
+* BUG #10: Create .gitkeep's to avoid errors on sparse kitchens (074b4e0a)
+* Add --skip-chef-check knife option (a1a66ae)
+
+## Thanks to our contributors!
+
+* [Cyril Ledru][patatepartie]
+* [Fletcher Nichol][fnichol]
+* [Jason Garber][jgarber]
+* [Greg Sterndale][gsterndale]
+
+# 0.0.7: Dec 9, 2011
+
+* BUG #9: Fix intelligent sudo handling for OSes that don't have it
+* Move integration tests into proper test cases
+* CentOS 5.6 integration test
+
+# 0.0.6: Dec 8, 2011
+
+* Support for Mac OS 10.5 and 10.6 (00921ebd1b93)
+* Parallel integration testing and SLES (167360d447..167360d447)
+* Dynamic sudo detection for yum-based systems (5282fc36ac3..256f27658a06cb)
+
+## Thanks to our contributors!
+
+* [Sergio Rubio][rubiojr]
+* [Nat Lownes][natlownes]
+
+# 0.0.5: Oct 31, 2011
+
+* Started on integration testing via EC2
+* Add openSuSE support. Installation via zypper. (64ff2edf42)
+* Upgraded Rubygems to 1.8.10 (8ac1f4d43a)
+
+# 0.0.4: Oct 7, 2011
+
+* Chef 0.10.4 based databag and search method (a800880e6d)
+* Proper path for roles (b143ae290a)
+* Test fixes for CI compatibility (ccf4247125..62b8bd498d)
+
+## Thanks to our contributors!
+
+* [John Dewey][retr0h]
+
+# 0.0.3: July 31, 2011
+
+* Kitchen directory generation
+* Prepare tested on ubuntu
+* Generate node config on prepare
+* Cook via rsync
+
+[DrGonzo65]:     https://github.com/DrGonzo65
+[Motiejus]:      https://github.com/Motiejus
+[Nix-wie-weg]:   https://github.com/Nix-wie-weg
+[TylerRick]:     https://github.com/TylerRick
+[aaronjensen]:   https://github.com/aaronjensen
+[amoslanka]:     https://github.com/amoslanka
+[ares]:          https://github.com/ares
+[avit]:          https://github.com/avit
+[brynary]:       https://github.com/brynary
+[btm]:           https://github.com/btm
+[davidsch]:      https://github.com/davidsch
+[deepak]:        https://github.com/deepak
+[fnichol]:       https://github.com/fnichol
+[funglaub]:      https://github/funglaub
+[gregf]:         https://github.com/gregf
+[gsterndale]:    https://github.com/gsterndale
+[hectcastro]:    https://github.com/hectcastro
+[jgarber]:       https://github.com/jgarber
+[jgrevich]:      https://github.com/jgrevich
+[natlownes]:     https://github.com/natlownes
+[patatepartie]:  https://github.com/patatepartie
+[patcon]:        https://github.com/patcon
+[pferdefleisch]: https://github.com/pferdefleisch
+[portertech]:    https://github.com/portertech
+[retr0h]:        https://github.com/retr0h
+[rmoriz]:        http://github.com/rmoriz
+[rosstimson]:    https://github.com/rosstimson
+[rubiojr]:       https://github.com/rubiojr
+[ryandub]:       https://github.com/ryandub
+[tmatilai]:      https://github.com/tmatilai
+[vjpr]:          https://github.com/vjpr
+[zeph]:          https://github.com/zeph

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Mat Schaffer <mat@schaffer.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,127 @@
+= knife-solo
+
+{<img src="https://secure.travis-ci.org/matschaffer/knife-solo.png" alt="Build Status" />}[http://travis-ci.org/matschaffer/knife-solo]
+{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/matschaffer/knife-solo]
+
+== DESCRIPTION:
+
+Knife-solo is a gem plugin for Chef's knife utility. It currently adds 5 subcommands to knife:
+
+- <tt>knife solo init</tt> is used to create a new directory structure (i.e. "kitchen") that fits with Chef's standard structure and can be used to build and store recipes.
+
+- <tt>knife solo prepare</tt> installs Chef on a given host. It's structured to auto-detect the target OS and change the installation process accordingly.
+
+- <tt>knife solo cook</tt> uploads the current kitchen (Chef repo) to the target host and runs chef-solo on that host.
+
+- <tt>knife solo bootstrap</tt> combines the two previous ones (prepare and cook).
+
+- <tt>knife solo clean</tt> removes the uploaded kitchen from the target host.
+
+Preliminary Windows support for "knife solo cook" is available (see below).
+
+== USAGE:
+
+Installation is a normal gem installation.
+
+    gem install knife-solo
+
+If you need to install from git run:
+
+    rake install
+
+=== Init command
+
+The init command simply takes a name of the directory to store the kitchen structure. Use "." to initialize the current directory.
+
+    knife init mychefrepo
+
+Currently the directory structure looks like this, but could change as development continues.
+
+    mychefrepo/
+    ├── cookbooks
+    ├── data_bags
+    ├── nodes
+    ├── roles
+    ├── site-cookbooks
+    └── solo.rb
+
+=== Prepare command
+
+The prepare command takes an ssh-style host argument as follows:
+
+    knife solo prepare ubuntu@10.0.0.201
+
+It will look up SSH information from <tt>~/.ssh/config</tt> or in the file specified by +-F+. You can also pass port information (+-p+), identity information (+-i+), or a password (+-P+). It will use sudo to run some of these commands and will prompt you for the password if it's not supplied on the command line.
+
+This command will make a best-effort to detect and install Chef Solo on your target operating system. We use the {Opscode Installer}[http://www.opscode.com/chef/install/] wherever possible.
+
+If you need specific behavior you can fallback to a knife bootstrap command with an empty runlist using the following:
+
+    knife bootstrap --template-file bootstrap.centos.erb -u root 172.16.144.132
+    echo '{"run_list":[]}' > nodes/172.16.144.132.json
+
+Bootstrap templates are quite simple, as shown in {this gist for bootstrap.centos.erb}[https://gist.github.com/2402433].
+
+Or if your modifications provide some general benefit, consider sending a pull request to {this project}[https://github.com/matschaffer/knife-solo] or {the omnibus installer}[https://github.com/opscode/omnibus].
+
+=== Cook command
+
+The cook command also takes an ssh-style host argument:
+
+    knife solo cook ubuntu@10.0.0.201
+
+The cook command uploads the current kitchen to the server and runs chef-solo on that server. If you only specify one argument it will look for a node config in <tt>nodes/<hostname>.json</tt>. Or if you want to specify a node config you can pass the path to the file as the second argument.
+
+This uploads all of your cookbooks in addition to a patch that allows you to use data_bags in a read-only fashion from the +data_bags+ folder.
+
+This also supports encrypted data bags. To use them, place your key in +data_bag_key+ in the root of your kitchen (or if you move it make sure to update +solo.rb+ to reflect the new path).
+
+The knife command for creating encrypted data bags doesn't work well without a Chef server, so use {this gist}[https://gist.github.com/2896172] as an example on how to create encrypted data bag items on your local file system.
+
+=== Bootstrap command
+
+The bootstrap command takes the same arguments and most of the options as prepare and cook:
+
+    knife solo bootstrap ubuntu@10.0.0.201
+
+Under the hood it first calls +knife solo prepare+ and then +knife solo cook+ with the specified arguments and options.
+
+=== Clean command
+
+The clean command takes the same arguments like prepare and cook:
+
+    knife solo clean ubuntu@10.0.0.201
+
+The clean command removes an uploaded kitchen completely from the target host. This improves security because passwords etc. are not left behind on that host.
+
+=== Windows support
+
+The cook command will work on Windows node if you meet the following howto:
+
+==== Init then tweak
+
+- run <tt>knife solo init</tt> then edit solo.rb to use Windows path-naming (see https://gist.github.com/1773854)
+
+==== Prepare the node manually
+
+- install a SSH server (eg: WinSSHd)
+- install rsync on the node (see https://github.com/thbar/rsync-windows)
+- add rsync to the user PATH
+- install http://www.opscode.com/chef/install.msi
+- add nodes/hostname.json and put <tt>{ "run_list": [] }</tt> in it
+
+==== Cook
+
+- cook should work as expected automatically, if you use cygwin rsync
+
+== DEVELOPMENT
+
+Get set up by running +./script/newb+ this will do some of the steps and guide you through the rest. If it doesn't run for you, feel free to {file an issue}[https://github.com/matschaffer/knife-solo/issues].
+
+When running integration tests all output is sent to the log directory into a file that matches matches the test case name. The EC2Runner log is the main runner log that contains information about instance provisioning.
+
+Note that instances will remain running until your tests pass. This aids in speeding up the test cycle. Upon succesfful test completion you'll be given 10 seconds to cancel the process before the instances are cleaned up. Note that any instance tagged with <tt>knife_solo_integration_user == $USER</tt> will be cleaned up. Or if you want to leave your instances running regardless, specify <tt>SKIP_DESTROY=true</tt> as an environment variable.
+
+To make an integration test, create a file in the +test/integration+ directory and a test class that inherits from +IntegrationTest+ and includes a module from +test/integration/cases+. You can override methods as necessary, but generally you only need to override +user+ and +image_id+ to specify the user name and AMI ID.
+
+If you're interested in contributing, contact me via GitHub or have a look at the {GitHub issues page}[https://github.com/matschaffer/knife-solo/issues].

data/Rakefile

@@ -0,0 +1,31 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Updates Manifest.txt with a list of files from git'
+task :manifest do
+  git_files = `git ls-files`.split("\n")
+  ignored = %w(.gitignore Gemfile Gemfile.lock Manifest.txt knife-solo.gemspec script/newb script/test)
+
+  File.open('Manifest.txt', 'w') do |f|
+    f.puts (git_files - ignored).join("\n")
+  end
+end
+
+task :release => :manifest
+
+namespace :test do
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/integration/*_test.rb']
+  end
+
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+  end
+end
+
+desc "Alias for test:units"
+task :test => ['test:units']
+task :default => :test
+

data/lib/chef/knife/cook.rb

@@ -1,137 +1,10 @@
-require 'chef/knife'
-
-require 'knife-solo/ssh_command'
-require 'knife-solo/kitchen_command'
-require 'knife-solo/node_config_command'
-require 'knife-solo/tools'
+require 'chef/knife/solo_cook'
+require 'knife-solo/deprecated_command'
 
 class Chef
   class Knife
-    # Approach ported from spatula (https://github.com/trotter/spatula)
-    # Copyright 2009, Trotter Cashion
-    class Cook < Knife
-      OMNIBUS_EMBEDDED_PATHS  = ["/opt/chef/embedded/bin", "/opt/opscode/embedded/bin"]
-      OMNIBUS_EMBEDDED_GEM_PATHS  = ["/opt/chef/embedded/lib/ruby/gems/1.9.1", "/opt/opscode/embedded/lib/ruby/gems/1.9.1"]
-      CHEF_VERSION_CONSTRAINT = ">=0.10.4"
-
-      include KnifeSolo::SshCommand
-      include KnifeSolo::KitchenCommand
-      include KnifeSolo::NodeConfigCommand
-      include KnifeSolo::Tools
-
-      deps do
-        require 'chef/cookbook/chefignore'
-        require 'pathname'
-        KnifeSolo::SshCommand.load_deps
-        KnifeSolo::NodeConfigCommand.load_deps
-      end
-
-      banner "knife cook [user@]hostname [json] (options)"
-
-      option :skip_chef_check,
-        :long => '--skip-chef-check',
-        :boolean => true,
-        :description => "Skip the version check on the Chef gem"
-
-      option :sync_only,
-        :long => '--sync-only',
-        :boolean => false,
-        :description => "Only sync the cookbook - do not run Chef"
-
-      option :why_run,
-        :short        => '-W',
-        :long         => '--why-run',
-        :boolean      => true,
-        :description  => "Enable whyrun mode"
-
-      def run
-        time('Run') do
-          validate_params!
-          super
-          Chef::Config.from_file('solo.rb')
-          check_chef_version unless config[:skip_chef_check]
-          generate_node_config
-          rsync_kitchen
-          add_patches
-          cook unless config[:sync_only]
-        end
-      end
-
-      def chef_path
-        Chef::Config.file_cache_path
-      end
-
-      def chefignore
-        @chefignore ||= ::Chef::Cookbook::Chefignore.new("./")
-      end
-
-      # cygwin rsync path must be adjusted to work
-      def adjust_rsync_path(path)
-        return path unless windows_node?
-        path.gsub(/^(\w):/) { "/cygdrive/#{$1}" }
-      end
-
-      def patch_path
-        Array(Chef::Config.cookbook_path).first + "/chef_solo_patches/libraries"
-      end
-
-      def rsync_exclude
-        (%w{revision-deploys tmp '.*'} + chefignore.ignores).uniq
-      end
-
-      def debug?
-        config[:verbosity] and config[:verbosity] > 0
-      end
-
-      # Time a command
-      def time(msg)
-        return yield unless debug?
-        ui.msg "Starting '#{msg}'"
-        start = Time.now
-        yield
-        ui.msg "#{msg} finished in #{Time.now - start} seconds"
-      end
-
-      def rsync_kitchen
-        time('Rsync kitchen') do
-          cmd = %Q{rsync -rl --rsh="ssh #{ssh_args}" --delete #{rsync_exclude.collect{ |ignore| "--exclude #{ignore} " }.join} ./ :#{adjust_rsync_path(chef_path)}}
-          ui.msg cmd if debug?
-          system! cmd
-        end
-      end
-
-      def add_patches
-        run_portable_mkdir_p(patch_path)
-        Dir[Pathname.new(__FILE__).dirname.join("patches", "*.rb").to_s].each do |patch|
-          time(patch) do
-            system! %Q{rsync -rl --rsh="ssh #{ssh_args}" #{patch} :#{adjust_rsync_path(patch_path)}}
-          end
-        end
-      end
-
-      def check_chef_version
-        ui.msg "Checking Chef version..."
-        result = run_command <<-BASH
-          export PATH="#{OMNIBUS_EMBEDDED_PATHS.join(":")}:$PATH"
-          export GEM_PATH="#{OMNIBUS_EMBEDDED_GEM_PATHS.join(":")}:$GEM_PATH"
-          ruby -rubygems -e "gem 'chef', '#{CHEF_VERSION_CONSTRAINT}'"
-        BASH
-        raise "Couldn't find Chef #{CHEF_VERSION_CONSTRAINT} on #{host}. Please run `#{$0} prepare #{ssh_args}` to ensure Chef is installed and up to date." unless result.success?
-      end
-
-      def cook
-        cmd = "sudo chef-solo -c #{chef_path}/solo.rb -j #{chef_path}/#{node_config}"
-        cmd << " -l debug" if debug?
-        cmd << " -N #{config[:chef_node_name]}" if config[:chef_node_name]
-        cmd << " -W" if config[:why_run]
-
-        stream_command cmd
-      end
-
-      def validate_params!
-        validate_first_cli_arg_is_a_hostname!
-      end
-
+    class Cook < SoloCook
+      include KnifeSolo::DeprecatedCommand
     end
   end
 end