chake 0.82 → 0.90

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912ff9a308d2f2d1738b2708fc487dcef50ab241b292e081e3a633b50136ed02
-  data.tar.gz: aa5819064902a6c70c29274d1d0f08497275f72c787ee2094db73e7c579faf24
+  metadata.gz: 73bba733109589908cc9fe35b4f009f105cdac398b8e2eeb4a6ca3638f328276
+  data.tar.gz: 715c2eb00007ced85da48fd4c5c4d4ec6c508627494a87aaeb0e25e1dea3968e
 SHA512:
-  metadata.gz: a0247ef1aa495a4ecf4c89d716123400f0c16f72d3897378b94923c1e355474fa356ec776c0ee5e2ebc0af271b54fa448b38b5368ff1acfc205ada2199c23029
-  data.tar.gz: 903e32b0e944b55dafe3a18cc717b30e73d2abf3dd09c0f62850514c9324c14a6d14d7c557a43ab1e2d0fbfc20c085b10b03328d58381f420ff1a62f9b42088e
+  metadata.gz: d04fcefd02e1fe73eba0941f2d1dda595f28e1c40067daf74defac1020039812c58740769bebbdcc92f6414c9d49da3b0753f4e088bb4cefaed295432910f1d2
+  data.tar.gz: 717537aa7effd7371cc23ba4e1fcaa80fb1a0a47fe97d5123abe69488b4b193b61afb34be806a8314234e2257b60081a4c2229a8c93880977609f1fdea69bea5

data/.manifest

@@ -8,6 +8,7 @@ ChangeLog.md
 Gemfile
 LICENSE.txt
 README.chef.md
+README.itamae-remote.md
 README.itamae.md
 README.md
 README.shell.md
@@ -28,10 +29,14 @@ lib/chake/bootstrap/00_set_hostname.sh
 lib/chake/bootstrap/chef/01_installed.sh
 lib/chake/bootstrap/chef/02_debian.sh
 lib/chake/bootstrap/chef/99_unsupported.sh
+lib/chake/bootstrap/itamae-remote/01_installed.sh
+lib/chake/bootstrap/itamae-remote/02_debian.sh
+lib/chake/bootstrap/itamae-remote/99_unsupported.sh
 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_remote.rb
 lib/chake/config_manager/shell.rb
 lib/chake/config_manager/skel/chef/Rakefile
 lib/chake/config_manager/skel/chef/config.rb
@@ -58,6 +63,7 @@ spec/chake/backend/local_spec.rb
 spec/chake/backend/ssh_spec.rb
 spec/chake/backend_spec.rb
 spec/chake/config_manager/chef_spec.rb
+spec/chake/config_manager/itamae_remote_spec.rb
 spec/chake/config_manager/itamae_spec.rb
 spec/chake/config_manager/shell_spec.rb
 spec/chake/config_manager_spec.rb

data/ChangeLog.md

@@ -1,3 +1,12 @@
+# 0.90
+
+* itamae: use --sudo when root for local backend
+* Chake::ConfigManager: fix typo
+* chake/config: allow aliases in YAML data
+* codespell: ignore tags file
+* ChangeLog.md: fix typo found by codespell
+* Implement new configuration manager: itamae-remote
+
 # 0.82
 
 * gemspec: drop bundler version constraint
@@ -23,7 +32,7 @@ This release adds support for multiple configuration managers. Chef is now only
 one of the options. There is also now support for configuration management with
 itamae, and lightweight configuration management tool inspired by Chef, and via
 shell commands. This should be mostly transparent to current Chef users, but
-new repositories initiatied by chake will use itamae by default.
+new repositories initiated by chake will use itamae by default.
 
 Other notable changes:
 

data/README.itamae-remote.md

@@ -0,0 +1,61 @@
+chake-itamae-remote(7) -- configure chake nodes with a remote itamae
+====================================================================
+
+## Description
+
+This configuration manager will run **itamae(1)** on each remote node. This is
+different from the _itamae_ configuration manager, which runs itamae on your
+workstation (the host running chake). _itamae-remote_ will run itamae
+individually on each node, which is one order of magnitude faster. This
+requires itamae to be installed on each node, and that will be taken care of
+automatically by the bootstrapping process.
+
+## Configuration
+
+The _itamae-remote_ configuration manager requires one key called
+`itamae-remote`, and the value must be a list of strings representing the list
+of recipes to apply to the node when converging.
+
+```yaml
+host1.mycompany.com:
+  itamae-remote:
+    - cookbooks/basic/default.rb
+    - roles/server.rb
+  service1:
+    option1: "here we go"
+```
+
+Any extra configuration under `host1.mycompany.com` will be saved to a JSON file
+and given to the itamae --node-json option in the command line. For example,
+the above configuration will produce a JSON file that looks like this:
+
+```json
+{
+  "itamae": [
+    "cookbooks/basic.rb",
+    "roles/server.rb"
+  ]
+  ,
+  "service1": {
+    "option1": "here we go"
+  }
+}
+```
+
+Inside itamae recipes, you can access those values by using the `node` object.
+For example:
+
+```ruby
+template "/etc/service1.conf.d/option1.conf" do
+  variables option1: node["option1"]
+end
+```
+
+## Bootstrapping
+
+The bootstrapping process will make sure itamae is installed. The node hostname
+will be set according to your chake configuration.
+
+## See also
+
+* **chake(1)**

data/Rakefile

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

data/lib/chake/bootstrap/itamae-remote/01_installed.sh

@@ -0,0 +1,4 @@
+# itamae already installed
+if which itamae >/dev/null 2>&1; then
+  exit
+fi

data/lib/chake/bootstrap/itamae-remote/02_debian.sh

@@ -0,0 +1,6 @@
+if [ -x /usr/bin/apt-get ]; then
+  apt-get update
+  export DEBIAN_FRONTEND=noninteractive
+  apt-get -q -y install rsync itamae
+  exit
+fi

data/lib/chake/bootstrap/itamae-remote/99_unsupported.sh

@@ -0,0 +1,16 @@
+echo "---------------------"
+echo "Unsupported platform: Installing itamae with rubygems"
+echo "---------------------"
+echo
+
+for file in /etc/os-release /etc/issue; do
+  if [ -f $file ]; then
+    cat $file
+    break
+  fi
+done
+
+if ! which itamae >/dev/null ; then
+  gem install itamae
+  exit
+fi

data/lib/chake/config.rb

@@ -8,12 +8,12 @@ end
 
 nodes_file = ENV['CHAKE_NODES'] || 'nodes.yaml'
 nodes_directory = ENV['CHAKE_NODES_D'] || 'nodes.d'
-nodes = File.exist?(nodes_file) && YAML.load_file(nodes_file) || {}
+nodes = File.exist?(nodes_file) && YAML.load_file(nodes_file, aliases: true) || {}
 nodes.values.each do |node|
   node['chake_metadata'] = { 'definition_file' => nodes_file }
 end
 Dir.glob(File.join(nodes_directory, '*.yaml')).sort.each do |f|
-  file_nodes = YAML.load_file(f)
+  file_nodes = YAML.load_file(f, aliases: true)
   file_nodes.values.each do |node|
     node['chake_metadata'] = { 'definition_file' => f }
   end

data/lib/chake/config_manager/itamae.rb

@@ -30,6 +30,9 @@ module Chake
           cmd << 'ssh' << "--user=#{node.username}" << "--host=#{node.hostname}"
           cmd += ssh_config
         when Chake::Connection::Local
+          if node.username == 'root'
+            cmd.prepend 'sudo'
+          end
           cmd << 'local'
         else
           raise NotImplementedError, "Connection type #{node.connection.class} not supported for itamee"

data/lib/chake/config_manager/itamae_remote.rb

@@ -0,0 +1,40 @@
+require 'shellwords'
+require 'chake/config'
+require 'chake/tmpdir'
+
+module Chake
+  class ConfigManager
+    class ItamaeRemote < ConfigManager
+      def converge
+        run_itamae(*node.data['itamae-remote'])
+      end
+
+      def apply(config)
+        run_itamae(config)
+      end
+
+      def needs_upload?
+        true
+      end
+
+      def self.accept?(node)
+        node.data.key?('itamae-remote')
+      end
+
+      private
+
+      def run_itamae(*recipes)
+        cmd = ['itamae', 'local', "--node-json=#{json_config}"]
+        if node.silent
+          cmd << '--log-level=warn'
+        end
+        cmd += recipes.map { |r| File.join(node.path, r) }
+        node.run_as_root(Shellwords.join(cmd))
+      end
+
+      def json_config
+        File.join(node.path, Chake.tmpdir, "#{node.hostname}.json")
+      end
+    end
+  end
+end

data/lib/chake/config_manager.rb

@@ -35,11 +35,15 @@ module Chake
     end
 
     def self.short_name
-      name.split('::').last.downcase
+      name.split('::').last.gsub(/([[:lower:]])([[:upper:]])/) do
+        first = Regexp.last_match(1)
+        last = Regexp.last_match(2).downcase
+        "#{first}-#{last}"
+      end.downcase
     end
 
-    def self.priority(new_prioriry = nil)
-      @priority ||= new_prioriry || 50
+    def self.priority(new_priority = nil)
+      @priority ||= new_priority || 50
     end
 
     def self.inherited(klass)

data/lib/chake/version.rb

@@ -1,3 +1,3 @@
 module Chake
-  VERSION = '0.82'.freeze
+  VERSION = '0.90'.freeze
 end

data/man/Rakefile

@@ -2,6 +2,7 @@ MAIN_MANPAGE = 'man/chake.1'.freeze
 OTHER_MANPAGES = %w[
   man/chake-chef.7
   man/chake-itamae.7
+  man/chake-itamae-remote.7
   man/chake-shell.7
 ].freeze
 MANPAGES = [MAIN_MANPAGE] + OTHER_MANPAGES

data/spec/chake/config_manager/itamae_remote_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'chake/node'
+require 'chake/config_manager/itamae_remote'
+
+describe Chake::ConfigManager::ItamaeRemote do
+  let(:node) do
+    Chake::Node.new('somehost').tap do |n|
+      n.silent = true
+      n.data['itamae-remote'] = ['foo.rb', 'bar.rb']
+    end
+  end
+  let(:cfg) { Chake::ConfigManager.get(node) }
+
+  it 'is detected correctly' do
+    expect(cfg).to be_a(Chake::ConfigManager::ItamaeRemote)
+  end
+
+  it 'requires uploading' do
+    expect(cfg.needs_upload?).to eq(true)
+  end
+
+  it 'calls itamae remotely to converge' do
+    expect(node).to receive(:run_as_root).with(
+      a_string_matching(%r{itamae.*#{node.path}/foo.rb.*#{node.path}/bar.rb})
+    )
+    cfg.converge
+  end
+
+  it 'calls itamae remotely to apply' do
+    expect(node).to receive(:run_as_root).with(
+      a_string_matching(%r{itamae.*#{node.path}/doit.rb})
+    )
+    cfg.apply('doit.rb')
+  end
+
+  it 'handles silent mode' do
+    node.silent = true
+    expect(node).to receive(:run_as_root).with(
+      a_string_matching(/--log-level\\=warn/)
+    )
+    cfg.converge
+  end
+
+  it 'has a name with dashes' do
+    expect(cfg.name).to eq('itamae-remote')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chake
 version: !ruby/object:Gem::Version
-  version: '0.82'
+  version: '0.90'
 platform: ruby
 authors:
 - Antonio Terceiro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2022-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.chef.md
+- README.itamae-remote.md
 - README.itamae.md
 - README.md
 - README.shell.md
@@ -136,10 +137,14 @@ files:
 - lib/chake/bootstrap/chef/01_installed.sh
 - lib/chake/bootstrap/chef/02_debian.sh
 - lib/chake/bootstrap/chef/99_unsupported.sh
+- lib/chake/bootstrap/itamae-remote/01_installed.sh
+- lib/chake/bootstrap/itamae-remote/02_debian.sh
+- lib/chake/bootstrap/itamae-remote/99_unsupported.sh
 - 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_remote.rb
 - lib/chake/config_manager/shell.rb
 - lib/chake/config_manager/skel/chef/Rakefile
 - lib/chake/config_manager/skel/chef/config.rb
@@ -166,6 +171,7 @@ files:
 - spec/chake/backend/ssh_spec.rb
 - spec/chake/backend_spec.rb
 - spec/chake/config_manager/chef_spec.rb
+- spec/chake/config_manager/itamae_remote_spec.rb
 - spec/chake/config_manager/itamae_spec.rb
 - spec/chake/config_manager/shell_spec.rb
 - spec/chake/config_manager_spec.rb
@@ -175,7 +181,7 @@ homepage: https://gitlab.com/terceiro/chake
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: serverless configuration management tool for chef
 test_files:
@@ -199,6 +205,7 @@ test_files:
 - spec/chake/backend/ssh_spec.rb
 - spec/chake/backend_spec.rb
 - spec/chake/config_manager/chef_spec.rb
+- spec/chake/config_manager/itamae_remote_spec.rb
 - spec/chake/config_manager/itamae_spec.rb
 - spec/chake/config_manager/shell_spec.rb
 - spec/chake/config_manager_spec.rb