yyuu-capistrano-chef-solo 0.1.5 → 0.1.6

data/CHANGES.md

@@ -0,0 +1,38 @@
+v0.1.0 (Yamashita, Yuu)
+
+* Deploy cookbooks from local `./config/cookbooks` by default. Also you can still deploy them from external SCM with some extra configuration.
+* Update default Chef version (10.16.4 -> 11.4.0)
+* Add `chef_solo.run_list()` method like [roundsman](https://github.com/iain/roundsman).
+* Add `chef_solo:attributes` task to debug attributes.
+* Replace old style `:chef_solo_user` by _bootstrap_ mode.
+* Call `bundle install` to install Chef only if the Chef has not been installed.
+
+v0.1.1 (Yamashita, Yuu)
+
+* Set `:rbenv_setup_default_environment` as `false` to avoid the problem with _bootstrap_ mode. 
+
+v0.1.2 (Yamashita, Yuu)
+
+* Deploy cookbooks with using deploy strategies of Capistrano. Use [copy_subdir](https://github.com/yyuu/capistrano-copy-subdir) strategy by default.
+
+v0.1.3 (Yamashita, Yuu)
+
+* Add support for deploying single cookbook repositories (like cookbooks in https://github.com/opscode-cookbooks).
+
+v0.1.4 (Yamashita, Yuu)
+
+* Add support for data bags of Chef. By default, deploy data bags from local `./config/data_bags`.
+* Add `:chef_solo_use_bundler` parameter. Try to install Chef without using Bundler if set `false`.
+* Add `chef_solo:purge` task to uninstall Chef.
+
+v0.1.5 (Yamashita, Yuu)
+
+* Catch exceptions on initial handshake during bootstrap mode.
+* Improve error logging during bootstrap mode.
+* Support regex match for `:chef_solo_capistrano_attributes_exclude` and `:chef_solo_capistrano_attributes_include`.
+
+v0.1.6 (Yamashita, Yuu)
+
+* Support options Hash in `chef_solo.run_list()`. Now it skips updating cookbooks, data bags, attirbutes and configurations if `:update => false` was given.
+* Generate Chef roles from Capistrano roles and apply them by default.
+* Add new tasks chef-solo:host_attributes and chef-solo:role_attributes to show effective attributes.

data/README.md

@@ -181,6 +181,9 @@ set(:chef_solo_run_list, ["recipe[locales]", "recipe[tzdata]"])
 
 In some cases, you may want to apply individual `attributes` per roles.
 
+Following example will create Chef roles `role[app]` and `role[web]`.
+All attributes defined in `:chef_solo_role_attributes` will be merged into `default_attributes` of Chef role.
+
 ```ruby
 set(:chef_solo_role_attributes) {
   :app => {

data/capistrano-chef-solo.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Capistrano::ChefSolo::VERSION
 
-  gem.add_dependency("capistrano", ">= 2.10.0")
+  gem.add_dependency("capistrano", [">= 2.10.0", "< 3"])
   gem.add_dependency("capistrano-copy-subdir", ">= 0.1.0")
   gem.add_dependency("capistrano-rbenv", ">= 1.0.1")
 end

data/lib/capistrano-chef-solo.rb

@@ -35,6 +35,16 @@ module Capistrano
           task(:attributes, :except => { :no_release => true }) {
             find_and_execute_task("chef_solo:attributes")
           }
+
+          desc("Show chef-solo attributes for role. (an alias of chef_solo:role_attributes)")
+          task(:role_attributes, :except => { :no_release => true }) {
+            find_and_execute_task("chef_solo:role_attributes")
+          }
+
+          desc("Show chef-solo attributes for host. (an alias of chef_solo:host_attributes)")
+          task(:host_attributes, :except => { :no_release => true }) {
+            find_and_execute_task("chef_solo:host_attributes")
+          }
         }
 
         namespace(:chef_solo) {
@@ -45,6 +55,7 @@ module Capistrano
           _cset(:chef_solo_config_path) { File.join(chef_solo_path, "config") }
           _cset(:chef_solo_cookbooks_path) { File.join(chef_solo_path, "cookbooks") }
           _cset(:chef_solo_data_bags_path) { File.join(chef_solo_path, "data_bags") }
+          _cset(:chef_solo_roles_path) { File.join(chef_solo_path, "roles") }
           _cset(:chef_solo_config_file) { File.join(chef_solo_config_path, "solo.rb") }
           _cset(:chef_solo_attributes_file) { File.join(chef_solo_config_path, "solo.json") }
 
@@ -175,11 +186,13 @@ module Capistrano
 
           # Acts like `default`, but will apply specified recipes only.
           def run_list(*recipes)
+            options = { :update => true }.merge(Hash === recipes.last ? recipes.pop : {})
+            update_p = options.delete(:update)
             connect_with_settings do
               setup
               transaction do
-                update
-                invoke(:run_list => recipes)
+                update(options) if update_p
+                invoke(options.merge(:run_list => recipes))
               end
             end
           end
@@ -195,11 +208,34 @@ module Capistrano
 
           desc("Show chef-solo attributes.")
           task(:attributes, :except => { :no_release => true }) {
-            hosts = ENV.fetch("HOST", "").split(/\s*,\s*/)
-            roles = ENV.fetch("ROLE", "").split(/\s*,\s*/).map { |role| role.to_sym }
-            roles += hosts.map { |host| role_names_for_host(ServerDefinition.new(host)) }
-            attributes = _generate_attributes(:hosts => hosts, :roles => roles)
-            STDOUT.puts(_json_attributes(attributes))
+            find_and_execute_task("chef_solo:host_attributes")
+            find_and_execute_task("chef_solo:role_attributes")
+          }
+
+          desc("Show chef-solo attributes for host.")
+          task(:host_attributes, :except => { :no_release => true }) {
+            if ENV.key?("HOST")
+              hosts = ENV.fetch("HOST", "").split(/\s*,\s*/)
+            else
+              hosts = find_servers_for_task(current_task).map { |server| server.host }
+            end
+            hosts.each do |host|
+              logger.debug("generating chef-solo attributes for host `#{host}'.")
+              STDOUT.puts(_json_attributes(_generate_host_attributes(host, :roles => role_names_for_host(ServerDefinition.new(host)))))
+            end
+          }
+
+          desc("Show chef-solo attributes for role.")
+          task(:role_attributes, :except => { :no_release => true }) {
+            if ENV.key?("ROLE")
+              roles = ENV.fetch("ROLE", "").split(/\s*,\s*/).map { |role| role.to_sym }
+            else
+              roles = find_servers_for_task(current_task).map { |server| role_names_for_host(server) }.flatten.uniq
+            end
+            roles.each do |role|
+              logger.debug("generating chef-solo attributes for role `#{role}'.")
+              STDOUT.puts(_json_attributes(_generate_role_attributes(role)))
+            end
           }
 
           _cset(:chef_solo_gem_dependencies) {{
@@ -226,9 +262,9 @@ module Capistrano
             rescue
               installed = false
             end
+            dirs = [ chef_solo_path, chef_solo_cache_path, chef_solo_config_path, chef_solo_roles_path ].uniq
+            run("mkdir -p #{dirs.map { |x| x.dump }.join(" ")}")
             unless installed
-              dirs = [ chef_solo_path, chef_solo_cache_path, chef_solo_config_path ].uniq
-              run("mkdir -p #{dirs.map { |x| x.dump }.join(" ")}")
               if chef_solo_use_bundler
                 top.put(chef_solo_gemfile, File.join(chef_solo_path, "Gemfile"))
                 args = fetch(:chef_solo_bundle_options, [])
@@ -423,6 +459,7 @@ module Capistrano
               file_cache_path #{chef_solo_cache_path.dump}
               cookbook_path #{chef_solo_cookbooks_path.dump}
               data_bag_path #{chef_solo_data_bags_path.dump}
+              role_path #{chef_solo_roles_path.dump}
             EOS
           }
           def update_config(options={})
@@ -469,50 +506,53 @@ module Capistrano
           ])
           _cset(:chef_solo_capistrano_attributes_exclude, [:logger, /password/, :source, :strategy])
           _cset(:chef_solo_attributes, {})
-          _cset(:chef_solo_host_attributes, {})
-          _cset(:chef_solo_role_attributes, {})
           _cset(:chef_solo_run_list, [])
+          _cset(:chef_solo_host_attributes, {})
           _cset(:chef_solo_host_run_list, {})
-          _cset(:chef_solo_role_run_list, {})
-
-          def _generate_attributes(options={})
-            hosts = [ options.delete(:hosts) ].flatten.compact.uniq
+          def _generate_host_attributes(host, options={})
             roles = [ options.delete(:roles) ].flatten.compact.uniq
             #
             # By default, the Chef attributes will be generated by following order.
             # 
             # 1. Use _non-lazy_ variables of Capistrano.
             # 2. Use attributes defined in `:chef_solo_attributes`.
-            # 3. Use attributes defined in `:chef_solo_role_attributes` for target role.
-            # 4. Use attributes defined in `:chef_solo_host_attributes` for target host.
+            # 3. Use attributes defined in `:chef_solo_host_attributes` for target host.
             #
             attributes = chef_solo_capistrano_attributes.dup
             _merge_attributes!(attributes, chef_solo_attributes)
-            roles.each do |role|
-              _merge_attributes!(attributes, chef_solo_role_attributes.fetch(role, {}))
-            end
-            hosts.each do |host|
-              _merge_attributes!(attributes, chef_solo_host_attributes.fetch(host, {}))
-            end
+            _merge_attributes!(attributes, chef_solo_host_attributes.fetch(host, {}))
             #
-            # The Chef `run_list` will be generated from `:chef_solo_role_run_list` and
-            # `:chef_solo_host_run_list`.
+            # The Chef `run_list` will be generated from `:chef_solo_run_list` and `:chef_solo_host_run_list`.
             #
             _merge_attributes!(attributes, {"run_list" => chef_solo_run_list})
-            roles.each do |role|
-              _merge_attributes!(attributes, {"run_list" => chef_solo_role_run_list.fetch(role, [])})
-            end
-            hosts.each do |host|
-              _merge_attributes!(attributes, {"run_list" => chef_solo_host_run_list.fetch(host, [])})
-            end
+            _merge_attributes!(attributes, {"run_list" => roles.map { |role| "role[#{role}]" } }) unless roles.empty?
+            _merge_attributes!(attributes, {"run_list" => chef_solo_host_run_list.fetch(host, [])})
+            attributes
+          end
+
+          _cset(:chef_solo_role_attributes, {})
+          _cset(:chef_solo_role_run_list, {})
+          def _generate_role_attributes(role, options={})
+            attributes = {
+              "name" => role,
+              "chef_type" => "role",
+              "json_class" => "Chef::Role",
+            }
+            _merge_attributes!(attributes, {"default_attributes" => chef_solo_role_attributes.fetch(role, {})})
+            _merge_attributes!(attributes, {"run_list" => chef_solo_role_run_list.fetch(role, [])})
             attributes
           end
 
           def update_attributes(options={})
+            roles.each_key.each do |role|
+              logger.debug("updating chef-solo role attributes for #{role}.")
+              attributes = _generate_role_attributes(role)
+              top.put(_json_attributes(attributes), File.join(chef_solo_roles_path, "#{role}.json"), options)
+            end
             servers = find_servers_for_task(current_task)
             servers.each do |server|
-              logger.debug("updating chef-solo attributes for #{server.host}.")
-              attributes = _generate_attributes(:hosts => server.host, :roles => role_names_for_host(server))
+              logger.debug("updating chef-solo host attributes for #{server.host}.")
+              attributes = _generate_host_attributes(server.host, :roles => role_names_for_host(server))
               top.put(_json_attributes(attributes), chef_solo_attributes_file, options.merge(:hosts => server.host))
             end
           end

data/lib/capistrano-chef-solo/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module ChefSolo
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/test/config/deploy.rb

@@ -39,22 +39,52 @@ def get_file(file, options={})
   tempfile.read
 end
 
-def get_attributes(options={})
+def get_host_attributes(options={})
   JSON.load(get_file(chef_solo_attributes_file, options))
 end
 
-def assert_attributes(expected, options={})
-  found = get_attributes(options)
+def get_role_attributes(role, options={})
+  JSON.load(get_file(File.join(chef_solo_roles_path, "#{role}.json"), options))
+end
+
+def test_attribute(x, y)
+  if Array === x
+    x.sort == Array(y).sort
+  else
+    x == y
+  end
+end
+
+def assert_host_attributes(expected, options={})
+  found = get_host_attributes(options)
   expected.each do |key, value|
-    if found[key] != value
-      abort("invalid attribute: #{key.inspect} (expected:#{value.inspect} != found:#{found[key].inspect})")
+    unless test_attribute(found[key], value)
+      abort("invalid host attribute: #{key.inspect} (expected:#{value.inspect} != found:#{found[key].inspect})")
     end
   end
 end
 
-def assert_run_list(expected, options={})
-  found = get_attributes(options)["run_list"]
-  abort("invalid run_list (expected:#{expected.inspect} != found:#{found.inspect})") if found != expected
+def assert_role_attributes(role, expected, options={})
+  found = get_role_attributes(role, options)
+  expected.each do |key, value|
+    unless test_attribute(found[key], value)
+      abort("invalid role attribute: #{key.inspect} (expected:#{value.inspect} != found:#{found[key].inspect})")
+    end
+  end
+end
+
+def assert_host_run_list(expected, options={})
+  found = get_host_attributes(options)["run_list"]
+  unless test_attribute(found, expected)
+    abort("invalid host run_list (expected:#{expected.inspect} != found:#{found.inspect})")
+  end
+end
+
+def assert_role_run_list(role, expected=[], options={})
+  found = [ get_role_attributes(role, options)["run_list"] ].flatten
+  unless test_attribute(found, expected)
+    abort("invalid role run_list (expected:#{expected.inspect} != found:#{found.inspect})")
+  end
 end
 
 def assert_file_exists(file, options={})
@@ -149,8 +179,9 @@ namespace(:test_default) {
 
   task(:test_attributes, :roles => :app) {
     chef_solo.update_attributes
-    assert_attributes({"aaa" => "AAA", "bbb" => "BBB", "ccc" => "CCC", "run_list" => %w(recipe[foo] recipe[bar] recipe[baz])})
-    assert_attributes({"application" => application, "deploy_to" => deploy_to})
+    assert_host_attributes({"aaa" => "AAA", "ccc" => "CCC", "run_list" => %w(recipe[foo] recipe[baz] role[web] role[app] role[db])})
+    assert_role_attributes(:app, {"default_attributes" => {"bbb" => "BBB"}, "run_list" => %w(recipe[bar])})
+    assert_host_attributes({"application" => application, "deploy_to" => deploy_to})
   }
 }
 
@@ -189,14 +220,14 @@ namespace(:test_without_bundler) {
   task(:test_invoke) {
     expected = chef_solo_run_list
     find_and_execute_task("chef-solo")
-    assert_run_list(expected)
+    assert_host_run_list(expected + %w(role[web] role[app] role[db]))
     _test_recipes(expected)
   }
 
   task(:test_run_list) {
     expected = %w(recipe[baz])
     chef_solo.run_list expected
-#   assert_run_list(expected) # arguments of chef_solo.run_list will not be written to attributes file
+#   assert_host_run_list(expected + %w(role[web] role[app] role[db])) # arguments of chef_solo.run_list will not be written to attributes file
     _test_recipes(expected)
   }
 }
@@ -228,14 +259,14 @@ namespace(:test_with_local_cookbooks) {
   task(:test_invoke) {
     expected = chef_solo_run_list
     find_and_execute_task("chef-solo")
-    assert_run_list(expected)
+    assert_host_run_list(expected + %w(role[web] role[app] role[db]))
     _test_recipes(expected)
   }
 
   task(:test_run_list) {
     expected = %w(recipe[baz])
     chef_solo.run_list expected
-#   assert_run_list(expected) # arguments of chef_solo.run_list will not be written to attributes file
+#   assert_host_run_list(expected + %w(role[web] role[app] role[db])) # arguments of chef_solo.run_list will not be written to attributes file
     _test_recipes(expected)
   }
 }
@@ -269,14 +300,14 @@ namespace(:test_with_remote_cookbooks) {
   task(:test_invoke) {
     expected = chef_solo_run_list
     find_and_execute_task("chef-solo")
-    assert_run_list(expected)
+    assert_host_run_list(expected + %w(role[web] role[app] role[db]))
     _test_recipes(expected)
   }
 
   task(:test_run_list) {
     expected = %w(recipe[three])
     chef_solo.run_list expected
-#   assert_run_list(expected) # arguments of chef_solo.run_list will not be written to attributes file
+#   assert_host_run_list(expected + %w(role[web] role[app] role[db])) # arguments of chef_solo.run_list will not be written to attributes file
     _test_recipes(expected)
   }
 }
@@ -340,14 +371,14 @@ namespace(:test_with_multiple_cookbooks) {
   task(:test_invoke) {
     expected = chef_solo_run_list
     find_and_execute_task("chef-solo")
-    assert_run_list(expected)
+    assert_host_run_list(expected + %w(role[web] role[app] role[db]))
     _test_recipes(expected)
   }
 
   task(:test_run_list) {
     expected = %w(recipe[foo] recipe[single] recipe[one])
     chef_solo.run_list expected
-#   assert_run_list(expected) # arguments of chef_solo.run_list will not be written to attributes file
+#   assert_host_run_list(expected + %w(role[web] role[app] role[db])) # arguments of chef_solo.run_list will not be written to attributes file
     _test_recipes(expected)
   }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yyuu-capistrano-chef-solo
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -19,6 +19,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.10.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,6 +30,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.10.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: capistrano-copy-subdir
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md