chake 0.92 → 0.93

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796da031fd0926e8f4a2ba13a949dc6b308d0ceb811a8568db08a5ca54f99a07
-  data.tar.gz: ab0c285bbbe3a7e8ce6b665ac63de976c4a6239ebc2e356ec7f8ded4caaa0f3a
+  metadata.gz: 8e89bfb172b6733b9c8fb9b2d793e3b0470077850d294ec81c56a0bbc55a28b2
+  data.tar.gz: 59de754c4cb0ef93964711c9057db81da593aabaf95d83ff3ba7796719f3b979
 SHA512:
-  metadata.gz: 2f8ee4d755b3beb84e101c694823e685ce121ec4b26183b0048db91da7d5ced6fcda624fc29cd96f6e111aa28d6e4a4b13e145d7f5887bf59032b3c1db868691
-  data.tar.gz: 0320fe56feaf9a4c8e514cbf33cfff46cd24f68daa88ab6c74e88ab475d8e4c13b0ac7477a463a28478aa38cad55dd588cfbe028ff1315fd62c1baf71d8e5bbb
+  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,9 @@
+# 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

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
 
 ```

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', '--skip=*.1'
+  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.92'.freeze
+  VERSION = '0.93'.freeze
 end

data/lib/chake.rb

@@ -184,6 +184,13 @@ 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] => [:recipe_input, :connect_common, "connect:#{hostname}"] do |_task, _args|
     maybe_decrypt(node) do
@@ -262,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,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: chake
 version: !ruby/object:Gem::Version
-  version: '0.92'
+  version: '0.93'
 platform: ruby
 authors:
 - Antonio Terceiro
 bindir: bin
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,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
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.7
 specification_version: 4
 summary: serverless configuration management tool for chef
 test_files: