chake 0.91 → 0.93

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe9cf47e4e7590cb5a32366622afc40947318a280a958615c927b5f50bd82a6
-  data.tar.gz: 415f634b59bdb86ad59e582e8685ddd85891d4df66a54d81f9cc0c8bfa7e6e26
+  metadata.gz: 8e89bfb172b6733b9c8fb9b2d793e3b0470077850d294ec81c56a0bbc55a28b2
+  data.tar.gz: 59de754c4cb0ef93964711c9057db81da593aabaf95d83ff3ba7796719f3b979
 SHA512:
-  metadata.gz: 9840c830bdbb3469a7458ac19eeeb4518a75a07ae35937326a02c437be8a6b809adb5bb89d45ac3bad86703f3c2068139378b300e057bb119d3b4249d7b38285
-  data.tar.gz: 2d85e0d8e47a6ce2a5b189bbe9cc81b0b58913c7089fa60f7b61697787e37b58dc7356c7626c64c37915f0ba72e104c38d5f67da5d134a925f13f98315470963
+  metadata.gz: fb264a8d9d1781b336c16c84f96bec3ee6cbf858c68804660b98eae5fa747dcb8b155166dd8c91e7c8baf68f77f5a2f8cde59406495c538d7502955cf1b87968
+  data.tar.gz: 6f12e02d6186521dcb72405f407cc3b5d4e27e7570b31a7b86fdd445c949c9322ce7004c6582cd375bbeaab2c3c07e9631f3d2e99c4a288fb68b14f697a01c55

data/.manifest

@@ -37,6 +37,7 @@ lib/chake/config.rb
 lib/chake/config_manager.rb
 lib/chake/config_manager/chef.rb
 lib/chake/config_manager/itamae.rb
+lib/chake/config_manager/itamae_base.rb
 lib/chake/config_manager/itamae_remote.rb
 lib/chake/config_manager/shell.rb
 lib/chake/config_manager/skel/chef/Rakefile

data/ChangeLog.md

@@ -1,3 +1,13 @@
+# 0.93
+
+- Chef::ConfigManager: add support for inheritance
+- itamae: extract common code into subclass
+- Add support for a preview action
+
+# 0.92
+
+- Add support for connect:$HOST hooks
+
 # 0.91
 
 - itamae: handle empty recipe list

data/README.md

@@ -153,6 +153,19 @@ To apply the configuration to a single node, run
 $ rake converge:$NODE
 ```
 
+To preview the changes that would have been made when `converge` is run, you
+can issue the `preview` command:
+
+```
+$ rake preview
+```
+
+To preview the changes that would have been done to a single node, run:
+
+```
+$ rake preview:$NODE
+```
+
 To apply a single recipe on all nodes, run
 
 ```
@@ -254,6 +267,8 @@ converging. To do this, you just need to enhance the corresponding tasks:
 * `connect_common`: executed before doing any action that connects to any of
   the hosts. This can be used for example to generate a ssh configuration file
   based on the contents of the nodes definition files.
+* `connect:HOSTNAME`: executed before doing any action that connects to
+  `HOSTNAME`.
 
 Example:
 

data/Rakefile

@@ -100,7 +100,7 @@ end
 
 desc 'Check spelling in the source code'
 task :codespell do
-  sh 'codespell', '--skip=.git', '--skip=coverage', '--skip=*.asc', '--skip=*.swp', '--skip=tags'
+  sh 'codespell', '--skip=.git', '--skip=coverage', '--skip=*.asc', '--skip=*.swp', '--skip=tags', '--skip=*.1', '--skip=pkg'
 end
 
 task default: [:test, :style, :codespell]

data/lib/chake/config_manager/itamae.rb

@@ -1,21 +1,11 @@
 require 'shellwords'
 require 'chake/config'
 require 'chake/tmpdir'
+require 'chake/config_manager/itamae_base'
 
 module Chake
   class ConfigManager
-    class Itamae < ConfigManager
-      def converge
-        recipes = node.data['itamae']
-        return if recipes.empty?
-
-        run_itamae(*recipes)
-      end
-
-      def apply(config)
-        run_itamae(config)
-      end
-
+    class Itamae < ItamaeBase
       def needs_upload?
         false
       end
@@ -26,7 +16,7 @@ module Chake
 
       private
 
-      def run_itamae(*recipes)
+      def run_itamae(preview, *recipes)
         cmd = ['itamae']
         case node.connection
         when Chake::Connection::Ssh
@@ -44,6 +34,9 @@ module Chake
         if node.silent
           cmd << '--log-level=warn'
         end
+        if preview
+          cmd << '--dry-run'
+        end
         cmd += recipes
         node.log("$ #{cmd.join(' ')}")
         io = IO.popen(cmd, 'r', err: %i[child out])

data/lib/chake/config_manager/itamae_base.rb

@@ -0,0 +1,23 @@
+module Chake
+  class ConfigManager
+    class ItamaeBase < ConfigManager
+      def converge
+        recipes = node.data[name]
+        return if recipes.empty?
+
+        run_itamae(false, *recipes)
+      end
+
+      def preview
+        recipes = node.data['itamae-remote']
+        return if recipes.empty?
+
+        run_itamae(true, *recipes)
+      end
+
+      def apply(config)
+        run_itamae(false, config)
+      end
+    end
+  end
+end

data/lib/chake/config_manager/itamae_remote.rb

@@ -1,21 +1,11 @@
 require 'shellwords'
 require 'chake/config'
 require 'chake/tmpdir'
+require 'chake/config_manager/itamae_base'
 
 module Chake
   class ConfigManager
-    class ItamaeRemote < ConfigManager
-      def converge
-        recipes = node.data['itamae-remote']
-        return if recipes.empty?
-
-        run_itamae(*recipes)
-      end
-
-      def apply(config)
-        run_itamae(config)
-      end
-
+    class ItamaeRemote < ItamaeBase
       def needs_upload?
         true
       end
@@ -26,11 +16,14 @@ module Chake
 
       private
 
-      def run_itamae(*recipes)
+      def run_itamae(preview, *recipes)
         cmd = ['itamae', 'local', "--node-json=#{json_config}"]
         if node.silent
           cmd << '--log-level=warn'
         end
+        if preview
+          cmd << '--dry-run'
+        end
         cmd += recipes.map { |r| File.join(node.path, r) }
         node.run_as_root(Shellwords.join(cmd))
       end

data/lib/chake/config_manager.rb

@@ -46,14 +46,18 @@ module Chake
       @priority ||= new_priority || 50
     end
 
+    class << self
+      attr_accessor :subclasses
+    end
+
     def self.inherited(klass)
       super
-      @subclasses ||= []
-      @subclasses << klass
+      Chake::ConfigManager.subclasses ||= []
+      Chake::ConfigManager.subclasses << klass
     end
 
     def self.get(node)
-      available = @subclasses.sort_by(&:priority)
+      available = subclasses.sort_by(&:priority)
       manager = available.find { |c| c.short_name == node.data['config_manager'] }
       manager ||= available.find { |c| c.accept?(node) }
       raise ArgumentError, "Can't find configuration manager class for node #{node.hostname}. Available: #{available}.join(', ')}" unless manager
@@ -66,7 +70,7 @@ module Chake
     end
 
     def self.all
-      @subclasses
+      subclasses
     end
 
     def self.init

data/lib/chake/node.rb

@@ -45,6 +45,15 @@ module Chake
 
     def_delegators :config_manager, :converge, :apply, :path, :bootstrap_steps, :needs_upload?
 
+    def preview
+      unless config_manager.respond_to?(:preview)
+        puts "I: the #{config_manager} driver does not support preview"
+        return
+      end
+
+      config_manager.preview
+    end
+
     def path
       @path ||= config_manager.path
     end

data/lib/chake/version.rb

@@ -1,3 +1,3 @@
 module Chake
-  VERSION = '0.91'.freeze
+  VERSION = '0.93'.freeze
 end

data/lib/chake.rb

@@ -184,8 +184,15 @@ Chake.nodes.each do |node|
     end
   end
 
+  desc "Preview changes when converging #{hostname}"
+  task "preview:#{hostname}" => converge_dependencies do
+    maybe_decrypt(node) do
+      node.dry_run
+    end
+  end
+
   desc 'apply <recipe> on #{hostname}'
-  task "apply:#{hostname}", [:recipe] => %i[recipe_input connect_common] do |_task, _args|
+  task "apply:#{hostname}", [:recipe] => [:recipe_input, :connect_common, "connect:#{hostname}"] do |_task, _args|
     maybe_decrypt(node) do
       node.apply($recipe_to_apply)
     end
@@ -193,19 +200,22 @@ Chake.nodes.each do |node|
   task "apply:#{hostname}" => converge_dependencies
 
   desc "run a command on #{hostname}"
-  task "run:#{hostname}", [:command] => %i[run_input connect_common] do
+  task "run:#{hostname}", [:command] => [:run_input, :connect_common, "connect:#{hostname}"] do
     node.run($cmd_to_run)
   end
 
   desc "Logs in to a shell on #{hostname}"
-  task "login:#{hostname}" => :connect_common do
+  task "login:#{hostname}" => [:connect_common, "connect:#{hostname}"] do
     node.run_shell
   end
 
   desc 'checks connectivity and setup on all nodes'
-  task "check:#{hostname}" => :connect_common do
+  task "check:#{hostname}" => [:connect_common, "connect:#{hostname}"] do
     node.run('sudo echo OK')
   end
+
+  # needs to be overridden in user projects
+  task "connect:#{hostname}"
 end
 
 task :run_input, :command do |_task, args|
@@ -259,6 +269,9 @@ multitask bootstrap: Chake.nodes.map { |node| "bootstrap:#{node.hostname}" }
 desc 'converge all nodes (default)'
 multitask 'converge' => Chake.nodes.map { |node| "converge:#{node.hostname}" }
 
+desc 'Preview changes when converigng all nodes'
+multitask 'preview' => Chake.nodes.map { |node| "preview:#{node.hostname}" }
+
 desc 'Apply <recipe> on all nodes'
 multitask 'apply', [:recipe] => Chake.nodes.map { |node| "apply:#{node.hostname}" }
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: chake
 version: !ruby/object:Gem::Version
-  version: '0.91'
+  version: '0.93'
 platform: ruby
 authors:
 - Antonio Terceiro
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +144,7 @@ files:
 - lib/chake/config_manager.rb
 - lib/chake/config_manager/chef.rb
 - lib/chake/config_manager/itamae.rb
+- lib/chake/config_manager/itamae_base.rb
 - lib/chake/config_manager/itamae_remote.rb
 - lib/chake/config_manager/shell.rb
 - lib/chake/config_manager/skel/chef/Rakefile
@@ -185,7 +185,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,8 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: serverless configuration management tool for chef
 test_files: