knife-solo 0.2.0 → 0.3.0.pre1

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# 0.3.0: _In progress_
+
 # 0.2.0: February 12, 2013
 
 ## Changes and new features
@@ -16,6 +18,7 @@
 * Drop support for Debian 5.0 Lenny (#172)
 * Integration tests for Debian 6 and 7 (74c6ed1 - f299a6)
 * Travis tests for both Chef 10 and 11 (#183)
+* Remove solo.rb and transfer cookbooks to user-owned path (#1, #86, #125, #128, #177). See https://github.com/matschaffer/knife-solo/wiki/Upgrading-to-0.2.0
 
 ## Fixes
 

data/lib/chef/knife/solo_bootstrap.rb

@@ -2,13 +2,11 @@ require 'chef/knife'
 require 'chef/knife/solo_cook'
 require 'chef/knife/solo_prepare'
 
-require 'knife-solo/kitchen_command'
 require 'knife-solo/ssh_command'
 
 class Chef
   class Knife
     class SoloBootstrap < Knife
-      include KnifeSolo::KitchenCommand
       include KnifeSolo::SshCommand
 
       deps do
@@ -36,7 +34,6 @@ class Chef
 
       def validate!
         validate_ssh_options!
-        validate_kitchen!
       end
 
       def command_with_same_args(klass)

data/lib/chef/knife/solo_clean.rb

@@ -1,24 +1,24 @@
 require 'chef/knife'
+
 require 'knife-solo/ssh_command'
-require 'knife-solo/kitchen_command'
+require 'knife-solo/config'
 
 class Chef
   class Knife
     class SoloClean < Knife
       include KnifeSolo::SshCommand
-      include KnifeSolo::KitchenCommand
 
       banner "knife solo clean [USER@]HOSTNAME"
 
       def run
+        @solo_config = KnifeSolo::Config.new
         validate!
-        Chef::Config.from_file('solo.rb')
-        run_command "rm -rf #{Chef::Config.file_cache_path}"
+        run_command "rm -rf #{@solo_config.chef_path}"
       end
 
       def validate!
         validate_ssh_options!
-        validate_kitchen!
+        @solo_config.validate!
       end
     end
   end

data/lib/chef/knife/solo_cook.rb

@@ -1,9 +1,10 @@
 require 'chef/knife'
 
+require 'knife-solo'
 require 'knife-solo/ssh_command'
-require 'knife-solo/kitchen_command'
 require 'knife-solo/node_config_command'
 require 'knife-solo/tools'
+require 'knife-solo/config'
 
 class Chef
   class Knife
@@ -13,7 +14,6 @@ class Chef
       CHEF_VERSION_CONSTRAINT    = ">=0.10.4" unless defined? CHEF_VERSION_CONSTRAINT
 
       include KnifeSolo::SshCommand
-      include KnifeSolo::KitchenCommand
       include KnifeSolo::NodeConfigCommand
       include KnifeSolo::Tools
 
@@ -52,6 +52,8 @@ class Chef
         :description => 'Enable whyrun mode'
 
       def run
+        @solo_config = KnifeSolo::Config.new
+
         time('Run') do
           if config[:skip_chef_check]
             ui.warn '`--skip-chef-check` is deprecated, please use `--no-chef-check`.'
@@ -59,53 +61,35 @@ class Chef
           end
 
           validate!
-          Chef::Config.from_file('solo.rb')
           check_chef_version if config[:chef_check]
           generate_node_config
           librarian_install if config[:librarian]
           rsync_kitchen
           add_patches
+          add_solo_config unless using_custom_solorb?
           cook unless config[:sync_only]
         end
       end
 
+      def_delegators :@solo_config,
+        :chef_path,
+        :using_custom_solorb?,
+        :patch_path
+
       def validate!
         validate_ssh_options!
-        validate_kitchen!
-      end
-
-      def chef_path
-        Chef::Config.file_cache_path
+        @solo_config.validate!
       end
 
       def chefignore
         @chefignore ||= ::Chef::Cookbook::Chefignore.new("./")
       end
 
-      # cygwin rsync path must be adjusted to work
-      def adjust_rsync_path(path)
-        path.gsub(/^(\w):/) { "/cygdrive/#{$1}" }
-      end
-
-      def adjust_rsync_path_on_node(path)
-        return path unless windows_node?
-        adjust_rsync_path(path)
-      end
-
-      def adjust_rsync_path_on_client(path)
-        return path unless windows_client?
-        adjust_rsync_path(path)
-      end
-
       # see http://stackoverflow.com/questions/5798807/rsync-permission-denied-created-directories-have-no-permissions
       def rsync_permissions
         '--chmod=ugo=rwX' if windows_client?
       end
 
-      def patch_path
-        Array(Chef::Config.cookbook_path).first + "/chef_solo_patches/libraries"
-      end
-
       def rsync_excludes
         (%w{revision-deploys tmp '.*'} + chefignore.ignores).uniq
       end
@@ -149,8 +133,12 @@ class Chef
         end
       end
 
+      def add_solo_config
+        rsync(KnifeSolo.resource('solo.rb'), chef_path)
+      end
+
       def rsync(source_path, target_path, extra_opts = '')
-        cmd = %Q{rsync -rl #{rsync_permissions} --rsh="ssh #{ssh_args}" #{extra_opts} #{rsync_excludes.collect{ |ignore| "--exclude #{ignore} " }.join} #{adjust_rsync_path_on_client(source_path)} :#{adjust_rsync_path_on_node(target_path)}}
+        cmd = %Q|rsync -rl #{rsync_permissions} --rsh="ssh #{ssh_args}" #{extra_opts} #{rsync_excludes.collect{ |ignore| "--exclude #{ignore} " }.join} #{source_path} :#{target_path}|
         ui.msg cmd if debug?
         system! cmd
       end

data/lib/chef/knife/solo_init.rb

@@ -26,7 +26,6 @@ class Chef
         create_kitchen
         create_cupboards %w[nodes roles data_bags site-cookbooks cookbooks]
         librarian_init if config[:librarian]
-        create_solo_config
       end
 
       def validate!
@@ -51,22 +50,6 @@ class Chef
         mkdir @base unless @base == '.'
       end
 
-      def create_solo_config
-        solo_file = File.join(@base, 'solo.rb')
-        return if File.exist? solo_file
-
-        File.open(solo_file, 'w') do |f|
-          f << <<-RUBY.gsub(/^ {12}/, '')
-            file_cache_path           "/tmp/chef-solo"
-            data_bag_path             "/tmp/chef-solo/data_bags"
-            encrypted_data_bag_secret "/tmp/chef-solo/data_bag_key"
-            cookbook_path             [ "/tmp/chef-solo/site-cookbooks",
-                                        "/tmp/chef-solo/cookbooks" ]
-            role_path                 "/tmp/chef-solo/roles"
-          RUBY
-        end
-      end
-
       def librarian_init
         cheffile = File.join(@base, 'Cheffile')
         unless File.exist?(cheffile)

data/lib/chef/knife/solo_prepare.rb

@@ -1,6 +1,5 @@
 require 'chef/knife'
 require 'knife-solo/ssh_command'
-require 'knife-solo/kitchen_command'
 require 'knife-solo/node_config_command'
 
 class Chef
@@ -9,7 +8,6 @@ class Chef
     # Copyright 2010, 2011, Miquel Torres <tobami@googlemail.com>
     class SoloPrepare < Knife
       include KnifeSolo::SshCommand
-      include KnifeSolo::KitchenCommand
       include KnifeSolo::NodeConfigCommand
 
       deps do
@@ -44,7 +42,6 @@ class Chef
 
       def validate!
         validate_ssh_options!
-        validate_kitchen!
       end
 
       def bootstrap

data/lib/knife-solo.rb

@@ -1 +1,7 @@
 require 'knife-solo/info'
+
+module KnifeSolo
+  def self.resource(name)
+    Pathname.new(__FILE__).dirname.join('knife-solo/resources', name)
+  end
+end

data/lib/knife-solo/config.rb

@@ -0,0 +1,39 @@
+require 'chef/config'
+
+module KnifeSolo
+  # Encapsulates some logic for checking and extracting
+  # path configuration from the structure of the
+  # current kitchen
+  class Config
+    def solo_path
+      Chef::Config.knife[:solo_path]
+    end
+
+    def chef_path
+      solo_path || './chef-solo'
+    end
+
+    def cookbook_path
+      if using_custom_solorb?
+        Chef::Config.from_file('solo.rb')
+        Array(Chef::Config.cookbook_path).first
+      else
+        chef_path + '/cookbooks'
+      end
+    end
+
+    def patch_path
+      cookbook_path + "/chef_solo_patches/libraries"
+    end
+
+    def using_custom_solorb?
+      File.exist?('solo.rb')
+    end
+
+    def validate!
+      raise Error, "You have a solo.rb file, but knife[:solo_path] is not set. You probably need to delete solo.rb unless you've customized it. See https://github.com/matschaffer/knife-solo/wiki/Upgrading-to-0.3.0 for more information." if using_custom_solorb? && solo_path.nil?
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/knife-solo/info.rb

@@ -1,6 +1,6 @@
 module KnifeSolo
   def self.version
-    '0.2.0'
+    '0.3.0.pre1'
   end
 
   def self.post_install_message

data/lib/knife-solo/resources/solo.rb

@@ -0,0 +1,6 @@
+base = File.expand_path('..', __FILE__)
+
+data_bag_path             base + '/data_bags'
+encrypted_data_bag_secret base + '/data_bag_key'
+role_path                 base + '/roles'
+cookbook_path             [ base + '/site-cookbooks', base + '/cookbooks' ]

data/test/integration/cases/cache_path_usage.rb

@@ -0,0 +1,13 @@
+module CachePathUsage
+  def setup
+    super
+    FileUtils.cp_r $base_dir.join('support', 'cache_using_cookbook'), 'cookbooks/cache_using_cookbook'
+  end
+
+  def test_changing_a_cached_directory_between_cooks
+    write_nodefile(run_count: 1, run_list: ["cache_using_cookbook"])
+    assert_subcommand "cook"
+    write_nodefile(run_count: 2, run_list: ["cache_using_cookbook"])
+    assert_subcommand "cook"
+  end
+end

data/test/integration/ubuntu12_04_test.rb

@@ -12,4 +12,5 @@ class Ubuntu12_04Test < IntegrationTest
   include EmptyCook
   include Apache2Cook
   include EncryptedDataBag
+  include CachePathUsage
 end

data/test/knife-solo/config_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'knife-solo/config'
+
+class KnifeSoloConfigTest < TestCase
+  def setup
+    super
+    @config = KnifeSolo::Config.new
+  end
+
+  def teardown
+    super
+    FileUtils.rm_f 'solo.rb'
+  end
+
+  def test_uses_cookbook_path_from_solo_rb_if_available
+    write_file('solo.rb', <<-RUBY)
+      knife[:solo_path] = "./custom"
+      cookbook_path ["./custom/path"]
+    RUBY
+    assert_equal "./custom/path", @config.cookbook_path
+  end
+
+  def test_reads_chef_root_path_from_knife_config_or_defaults_to_home
+    assert_equal './chef-solo', @config.chef_path
+    Chef::Config.knife[:solo_path] = "/tmp/custom-chef-solo"
+    assert_equal "/tmp/custom-chef-solo", @config.chef_path
+  end
+
+  def test_fails_validation_if_user_has_solo_rb_and_no_solo_path
+    Chef::Config.knife[:solo_path] = nil
+    write_file('solo.rb', <<-RUBY)
+        cookbook_path ["custom/path"]
+    RUBY
+    assert_raises KnifeSolo::Config::Error do
+      @config.validate!
+    end
+  end
+end

data/test/solo_cook_test.rb

@@ -16,18 +16,6 @@ class SoloCookTest < TestCase
   include KitchenHelper
   include ValidationHelper::ValidationTests
 
-  def test_gets_destination_path_from_chef_config
-    cmd = command
-    Chef::Config.file_cache_path "/foo/chef-solo"
-    assert_equal "/foo/chef-solo", cmd.chef_path
-  end
-
-  def test_gets_patch_path_from_chef_config
-    cmd = command
-    Chef::Config.cookbook_path ["/bar/chef-solo/cookbooks"]
-    assert_equal "/bar/chef-solo/cookbooks/chef_solo_patches/libraries", cmd.patch_path
-  end
-
   def test_chefignore_is_valid_object
     assert_instance_of Chef::Cookbook::Chefignore, command.chefignore
   end
@@ -152,8 +140,8 @@ class SoloCookTest < TestCase
   def command(*args)
     cmd = knife_command(Chef::Knife::SoloCook, *args)
     cmd.stubs(:check_chef_version)
-    cmd.stubs(:rsync_kitchen)
     cmd.stubs(:add_patches)
+    cmd.stubs(:rsync)
     cmd.stubs(:stream_command).returns(SuccessfulResult.new)
     cmd
   end

data/test/support/cache_using_cookbook/metadata.rb

@@ -0,0 +1,7 @@
+name             'cache_using_cookbook'
+maintainer       'Mat Schaffer'
+maintainer_email 'mat@schaffer.me'
+license          'MIT'
+description      'Writes some data to the cache path.'
+long_description 'This helps ensure that we can do this multiple times regardless of what user initiates the run.'
+version          '0.1.0'

data/test/support/cache_using_cookbook/recipes/default.rb

@@ -0,0 +1,33 @@
+#
+# Cookbook Name:: cache_using_cookbook
+# Recipe:: default
+#
+# Copyright 2013, Mat Schaffer
+#
+# 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.
+#
+
+container = Chef::Config[:file_cache_path] + "/test_dir"
+
+directory container
+
+file container + "/test_file" do
+  content "This was generated from run #{node['run_count']}"
+end

data/test/support/test_case.rb

@@ -3,6 +3,11 @@ class TestCase < MiniTest::Unit::TestCase
     super unless self.class == TestCase
   end
 
+  def write_file(file, contents)
+    FileUtils.mkpath(File.dirname(file))
+    File.open(file, 'w') { |f| f.print contents }
+  end
+
   def knife_command(cmd_class, *args)
     cmd_class.load_deps
     command = cmd_class.new(args)

data/test/support/validation_helper.rb

@@ -15,25 +15,7 @@ module ValidationHelper
     end
   end
 
-  module KitchenCommandTests
-    include KitchenHelper
-
-    def test_barks_outside_of_the_kitchen
-      cmd = default_command
-      cmd.ui.expects(:err).with(regexp_matches(/must be run inside .* kitchen/))
-      outside_kitchen do
-        assert_exits cmd
-      end
-    end
-
-    # Returns a Knife instance that shoud run without other validation errors.
-    def default_command
-      command("somehost")
-    end
-  end
-
   module ValidationTests
     include SshCommandTests
-    include KitchenCommandTests
   end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: knife-solo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0.pre1
+  prerelease: 6
 platform: ruby
 authors:
 - Mat Schaffer
@@ -204,11 +204,12 @@ files:
 - lib/knife-solo/bootstraps/freebsd.rb
 - lib/knife-solo/bootstraps/linux.rb
 - lib/knife-solo/bootstraps/sun_os.rb
+- lib/knife-solo/config.rb
 - lib/knife-solo/deprecated_command.rb
 - lib/knife-solo/gitignore.rb
 - lib/knife-solo/info.rb
-- lib/knife-solo/kitchen_command.rb
 - lib/knife-solo/node_config_command.rb
+- lib/knife-solo/resources/solo.rb
 - lib/knife-solo/ssh_command.rb
 - lib/knife-solo/tools.rb
 - test/bootstraps_test.rb
@@ -217,6 +218,7 @@ files:
 - test/integration/amazon_linux_2012_09_bootstrap_test.rb
 - test/integration/cases/apache2_bootstrap.rb
 - test/integration/cases/apache2_cook.rb
+- test/integration/cases/cache_path_usage.rb
 - test/integration/cases/empty_cook.rb
 - test/integration/cases/encrypted_data_bag.rb
 - test/integration/centos5_6_test.rb
@@ -230,7 +232,7 @@ files:
 - test/integration/ubuntu12_04_bootstrap_test.rb
 - test/integration/ubuntu12_04_test.rb
 - test/integration_helper.rb
-- test/kitchen_command_test.rb
+- test/knife-solo/config_test.rb
 - test/minitest/parallel.rb
 - test/node_config_command_test.rb
 - test/solo_bootstrap_test.rb
@@ -239,6 +241,8 @@ files:
 - test/solo_init_test.rb
 - test/solo_prepare_test.rb
 - test/ssh_command_test.rb
+- test/support/cache_using_cookbook/metadata.rb
+- test/support/cache_using_cookbook/recipes/default.rb
 - test/support/config.yml.example
 - test/support/data_bag_key
 - test/support/ec2_runner.rb
@@ -273,9 +277,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -289,6 +293,7 @@ test_files:
 - test/integration/amazon_linux_2012_09_bootstrap_test.rb
 - test/integration/cases/apache2_bootstrap.rb
 - test/integration/cases/apache2_cook.rb
+- test/integration/cases/cache_path_usage.rb
 - test/integration/cases/empty_cook.rb
 - test/integration/cases/encrypted_data_bag.rb
 - test/integration/centos5_6_test.rb
@@ -302,7 +307,7 @@ test_files:
 - test/integration/ubuntu12_04_bootstrap_test.rb
 - test/integration/ubuntu12_04_test.rb
 - test/integration_helper.rb
-- test/kitchen_command_test.rb
+- test/knife-solo/config_test.rb
 - test/minitest/parallel.rb
 - test/node_config_command_test.rb
 - test/solo_bootstrap_test.rb
@@ -311,6 +316,8 @@ test_files:
 - test/solo_init_test.rb
 - test/solo_prepare_test.rb
 - test/ssh_command_test.rb
+- test/support/cache_using_cookbook/metadata.rb
+- test/support/cache_using_cookbook/recipes/default.rb
 - test/support/config.yml.example
 - test/support/data_bag_key
 - test/support/ec2_runner.rb

data/lib/knife-solo/kitchen_command.rb

@@ -1,26 +0,0 @@
-module KnifeSolo
-  module KitchenCommand
-    def self.required_files
-      %w(solo.rb)
-    end
-
-    def validate_kitchen!
-      unless required_files_present?
-        ui.fatal "This command must be run inside a Chef solo kitchen."
-        exit 1
-      end
-    end
-
-    def required_files_present?
-      KitchenCommand.required_files.inject(true) do |m, f|
-        check = File.exists?(f)
-        warn_for_required_file(f) unless check
-        m && check
-      end
-    end
-
-    def warn_for_required_file(file)
-      ui.error "#{file} is a required file/directory"
-    end
-  end
-end

data/test/kitchen_command_test.rb

@@ -1,31 +0,0 @@
-require 'test_helper'
-require 'support/kitchen_helper'
-
-require 'chef/knife'
-require 'knife-solo/kitchen_command'
-
-class DummyKitchenCommand < Chef::Knife
-  include KnifeSolo::KitchenCommand
-end
-
-class KitchenCommandTest < TestCase
-  include KitchenHelper
-
-  def test_barks_outside_of_the_kitchen
-    cmd = command
-    cmd.ui.expects(:err).with(regexp_matches(/must be run inside .* kitchen/))
-    outside_kitchen do
-      assert_exits { cmd.validate_kitchen! }
-    end
-  end
-
-  def test_runs_when_in_a_kitchen
-    in_kitchen do
-      command.validate_kitchen!
-    end
-  end
-
-  def command(*args)
-    knife_command(DummyKitchenCommand, *args)
-  end
-end