sunzi 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c118fcfb05d687e587068fea6079f6e365ffbf637ef0a4f73dbd1920dc8f138
-  data.tar.gz: 251b57a131bd76db42637bdcd0dad5b373b1a37e964680f5fde2531ff995b768
+  metadata.gz: 3e3eb16169a27b2c4732e2f94b02c613620a4edd6c0b68b1f9a1f77384a3a76b
+  data.tar.gz: f8ee2e0f7277d0db5d654358ebbab93320586b66c02eb61b43844a42db67624f
 SHA512:
-  metadata.gz: 19c134eda8a7b0b53570ad335e79b019daa553ae46cb5f554bc80f2157ac11e10e04e51f0c6444d249d6b97f14aa806a85a7c78a11e555eddccb849fd320666b
-  data.tar.gz: be46e99817efb6b0a8e85c5b562297b1b755c3a552ff4977039e70bf672aea636b6fc9cc4e81520120c82f5267e3ff2ba249aed0f061dae9fa4b9adcc48ee1c4
+  metadata.gz: 80c422355f103e3ceb6152c3a43889a15d76fef27c2088de5d0cede253311317712294b8ed19bf380c77dafba53017fb009cc0b0aa3317067c6938da53c0dd0f
+  data.tar.gz: b449eba750487ffdf7a2864a5b96b89aba2266b729fe7d0f76ab85f17438577091d3c17d7befa039c0669443c0baa7ef37bb436406313383e40ff3599eef96b1

data/.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.1', '3.2', '3.3', '3.4', '4.0']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/.gitignore

@@ -1,5 +1,4 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-sandbox
+/.bundle/
+/pkg/
+/tmp/
+/Gemfile.lock

data/CHANGELOG.md

@@ -1,6 +1,14 @@
-## 2.0, release 2018-01
+## 3.0.0, release 2026-01-14
+* Update dependencies (thor, net-ssh, minitest).
+* Replace Travis CI with GitHub Actions.
+
+## 2.1, release 2018-01-15
+* Dotfiles (files that start with '.') in recipes, roles and files are now included.
+* `sunzi.yml` is now evaluated as ERB to access environment variables. (e.g. `<%= ENV['MY_PASSWORD'] %>`)
+
+## 2.0, release 2018-01-14
 * Plug-in support for commands.
-* Separate "setup" and "teardown" commands for VPS into the "sunzi-vps" gem as a plugin.
+* Separate `setup` and `teardown` commands for VPS into the `sunzi-vps` gem as a plugin.
 * "attributes" are now "vars" in sunzi.yml and shell scripts.
 * ERB templating (e.g. <%= @vars.environment %>) is always enabled.
 * Individual attribute files compiled/attributes/* are no longer supported. Use ERB template methods instead.

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,20 +1,30 @@
 Sunzi
 =====
 
+[![Tests](https://github.com/kenn/sunzi/actions/workflows/test.yml/badge.svg)](https://github.com/kenn/sunzi/actions/workflows/test.yml)
+
 ```
 "The supreme art of war is to subdue the enemy without fighting." - Sunzi
 ```
 
-Sunzi is the easiest [server provisioning](http://en.wikipedia.org/wiki/Provisioning#Server_provisioning) utility designed for mere mortals. If Chef or Puppet is driving you nuts, try Sunzi!
+Sunzi is the easiest configuration automation and [infrastructure as code](https://en.wikipedia.org/wiki/Infrastructure_as_Code) utility designed for mere mortals.
+
+If Chef, Puppet, Ansible or SaltStack is driving you nuts, try Sunzi!
 
 Sunzi assumes that modern Linux distributions have (mostly) sane defaults and great package managers.
 
 Its design goals are:
 
 * **It's just shell script.** No clunky Ruby DSL involved. Most of the information about server configuration on the web is written in shell commands. Just copy-paste them, rather than translate it into an arbitrary DSL. Also, Bash is the greatest common denominator on minimum Linux installs.
-* **Focus on diff from default.** No big-bang overwriting. Append or replace the smallest possible piece of data in a config file. Loads of custom configurations make it difficult to understand what you are really doing.
-* **Always use the root user.** Think twice before blindly assuming you need a regular user - it doesn't add any security benefit for server provisioning, it just adds extra verbosity for nothing. However, it doesn't mean that you shouldn't create regular users with Sunzi - feel free to write your own recipes.
-* **Minimum dependencies.** No configuration server required. You don't even need a Ruby runtime on the remote server.
+
+* **Minimal diff from default.** No big-bang overwriting. Append or replace the smallest possible piece of data in a config file. Loads of custom configurations make it difficult to reason what you are really doing.
+
+* **Minimum dependencies.** No configuration server required. You don't even need a Ruby runtime on the remote server, sunzi runs a combined shell script over SSH.
+
+See also:
+
+* [sunzi-vps](https://github.com/kenn/sunzi-vps) - Interactive server provisioning plugin for Linode and DigitalOcean.
+* [sunzi-recipes](https://github.com/kenn/sunzi-recipes) - Sample repository for remote recipes.
 
 ### What's new:
 
@@ -26,7 +36,7 @@ Quickstart
 Install:
 
 ```bash
-$ [sudo] gem install sunzi
+$ gem install sunzi
 ```
 
 Go into your project directory (if it's a Rails project, `config` would be a good place to start with), then:
@@ -85,6 +95,9 @@ sunzi/
                   # remote server (do not edit directly)
 ```
 
+Security note: `sunzi.yml` is evaluated with ERB and loaded via `YAML.load`.
+Only use configs you fully trust.
+
 How do you pass dynamic values?
 -------------------------------
 
@@ -119,7 +132,7 @@ For instance, if you have the following line in `sunzi.yml`,
 
 ```yaml
 recipes:
-  rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh
+  rvm: https://raw.githubusercontent.com/kenn/sunzi-recipes/master/ruby/rvm.sh
 ```
 
 `rvm.sh` will be available and you can refer to that recipe by `source recipes/rvm.sh`.
@@ -154,7 +167,6 @@ An easy way is to edit `Vagrantfile`:
 Vagrant.configure("2") do |config|
   config.vm.provision "shell",
     inline: "sudo echo 'root:vagrant' | /usr/sbin/chpasswd"
-  end
 end
 ```
 

data/Rakefile

@@ -1,9 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+  t.test_files = FileList['test/**/*_test.rb']
 end
+
 task :default => :test

data/lib/sunzi/cli.rb

@@ -10,8 +10,8 @@ module Sunzi
 
     desc 'deploy [user@host:port] [role] [--sudo]', 'Deploy sunzi project'
     method_options sudo: false
-    def deploy(first, *args)
-      Sunzi::Command.new.deploy(first, *args)
+    def deploy(target, role = nil)
+      Sunzi::Command.new.deploy(target, role, options)
     end
 
     desc 'compile', 'Compile sunzi project'

data/lib/sunzi/command.rb

@@ -5,7 +5,7 @@ module Sunzi
   class Command
     include Sunzi::Actions::Delegate
 
-    delegate_to_thor :copy_file, :template, :get, :append_to_file, :options
+    delegate_to_thor :copy_file, :template, :get, :append_to_file
 
     def create(project)
       copy_file 'templates/create/.gitignore',         "#{project}/.gitignore"
@@ -17,15 +17,13 @@ module Sunzi
       copy_file 'templates/create/files/.gitkeep',     "#{project}/files/.gitkeep"
     end
 
-    def deploy(first, *args)
-      role = args[0]
-
-      sudo = 'sudo ' if options.sudo?
-      endpoint = Endpoint.new(first)
-
+    def deploy(target, role, options)
       # compile vars and recipes
       compile(role)
 
+      sudo = 'sudo ' if options.sudo?
+      endpoint = Endpoint.new(target)
+
       # The host key might change when we instantiate a new VM, so
       # we remove (-R) the old host key from known_hosts.
       `ssh-keygen -R #{endpoint.host} 2> /dev/null`
@@ -60,6 +58,7 @@ module Sunzi
     end
 
     def compile(role = nil)
+      abort_with 'You must be in a sunzi folder' unless File.exist?('sunzi.yml')
       abort_with "#{role} doesn't exist!" if role && !File.exist?("roles/#{role}.sh")
       abort_with 'As of v2, "attributes" are now "vars" in sunzi.yml and shell scripts.' if config.attributes
 
@@ -73,7 +72,7 @@ module Sunzi
       @vars = config.vars # Used within ERB templates
 
       # Copy local files to compiled folder
-      files = Dir['{recipes,roles,files}/**/*'].select { |file| File.file?(file) }
+      files = glob('{recipes,roles,files}/**/*').select { |file| File.file?(file) }
 
       files.each do |file|
         render file, "compiled/#{file}"
@@ -96,11 +95,7 @@ module Sunzi
   private
 
     def config
-      @config ||= begin
-        abort_with 'You must be in a sunzi folder' unless File.exist?('sunzi.yml')
-
-        YAML.load(File.read('sunzi.yml')).to_hashugar
-      end
+      @config ||= YAML.load(ERB.new(File.read('sunzi.yml')).result).to_hashugar
     end
 
     # template method requires absolute path to work with current directory
@@ -109,5 +104,9 @@ module Sunzi
       template File.expand_path(source), target, context: binding
     end
 
+    def glob(pattern)
+      Dir.glob(pattern, File::FNM_DOTMATCH) - ['.', '..']
+    end
+
   end
 end

data/lib/sunzi/dependency.rb

@@ -28,7 +28,7 @@ module Sunzi
           else
             'install'
           end
-          text = ERB.new(base.join("#{which}.erb").read, nil, '-').result(binding)
+          text = ERB.new(base.join("#{which}.erb").read).result(binding)
           abort_with text
         end
       end

data/lib/sunzi/plugin.rb

@@ -2,7 +2,6 @@ module Sunzi
   module Plugin
     class << self
       # Find gems that start with "sunzi-*" and require them automatically.
-      # If that gem is a plugin, it will call the register method on load.
 
       def load
         plugins = Gem::Specification.find_all.select{|plugin| plugin.name =~ /sunzi-.+/ }

data/lib/sunzi.rb

@@ -10,7 +10,7 @@ require 'thor'
 
 # Sunzi
 module Sunzi
-  GemRoot = Pathname.new(Gem.loaded_specs['sunzi'].gem_dir)
+  GemRoot = Pathname.new(__dir__).parent
 end
 
 require 'sunzi/core_ext'

data/plan.md

@@ -0,0 +1,94 @@
+# Sunzi Modernization Plan
+
+## Overview
+Update Sunzi (server provisioning tool) from 2018-era dependencies to modern Ruby ecosystem.
+
+## Changes
+
+### 1. Confirm minimum Ruby versions
+Verified minimum Ruby version for `net-ssh ~> 7` and `thor ~> 1.3` is 2.6.
+Set `spec.required_ruby_version` accordingly.
+
+### 2. Update gemspec dependencies
+**File:** [sunzi.gemspec](sunzi.gemspec)
+
+| Dependency | Current | New |
+|------------|---------|-----|
+| `thor` | unrestricted | `~> 1.3` |
+| `net-ssh` | `< 5` | `~> 7.0` |
+| `rainbow` | `~> 3.0` | (keep) |
+| `hashugar` | unrestricted | (keep) |
+| `minitest` | unrestricted | `~> 6.0` |
+
+Also add:
+- `spec.required_ruby_version = '>= 2.6'`
+
+### 3. Keep YAML.load for compatibility (document trust boundary)
+**File:** [README.md](README.md)
+
+Leave `YAML.load(ERB.new(File.read('sunzi.yml')).result)` as-is for maximum compatibility.
+Add a short README note that `sunzi.yml` must be fully trusted because ERB executes Ruby
+and YAML.load can instantiate arbitrary objects.
+
+### 4. Replace Travis CI with GitHub Actions
+**Delete:** `.travis.yml`
+**Create:** `.github/workflows/test.yml`
+
+```yaml
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.1', '3.2', '3.3']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test
+```
+
+### 5. Update README badge + requirements
+**File:** [README.md](README.md)
+
+- Replace Travis badge with GitHub Actions badge (ensure workflow name/branch match the badge URL).
+- Add a short Requirements note for the minimum supported Ruby (from step 1).
+
+### 6. Add .ruby-version
+**Create:** `.ruby-version` with content `3.2`
+
+### 7. Update template default Ruby version
+**File:** [templates/create/sunzi.yml](templates/create/sunzi.yml)
+
+Update `ruby_version: 2.5` to match the modern baseline (e.g., `3.2`).
+
+### 8. Update CHANGELOG
+**File:** [CHANGELOG.md](CHANGELOG.md)
+
+Add a `3.0.0` entry with the breaking changes (Ruby requirement, dependency bumps, CI migration).
+
+### 9. Bump version
+**File:** [sunzi.gemspec:5](sunzi.gemspec#L5)
+
+Update version from `2.1.0` to `3.0.0` (major bump due to Ruby version requirement change).
+If a version constant exists (e.g., `lib/sunzi/version.rb`), update it too.
+
+## File Summary
+| Action | File |
+|--------|------|
+| Edit | `sunzi.gemspec` |
+| Edit | `README.md` |
+| Edit | `templates/create/sunzi.yml` |
+| Edit | `CHANGELOG.md` |
+| Delete | `.travis.yml` |
+| Create | `.github/workflows/test.yml` |
+| Create | `.ruby-version` |
+
+## Verification
+1. Run `bundle install` to update Gemfile.lock
+2. Run `bundle exec rake test` to verify tests pass
+3. Run `bundle exec sunzi version` and `bundle exec sunzi create test_project` to verify CLI works

data/sunzi.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'sunzi'
-  spec.version       = '2.0.0' # retrieve this value by: Gem.loaded_specs['sunzi'].version.to_s
+  spec.version       = '3.0.0' # retrieve this value by: Gem.loaded_specs['sunzi'].version.to_s
   spec.authors       = ['Kenn Ejima']
   spec.email         = ['kenn.ejima@gmail.com']
   spec.summary       = %q{Server provisioning utility for minimalists}
@@ -14,10 +14,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'thor', '~> 0.20'
-  spec.add_dependency 'rainbow', '~> 2.2'
-  spec.add_dependency 'net-ssh', '< 5' # 4.x only supports ruby-2.0
+  spec.add_dependency 'thor', '~> 1.3'
+  spec.add_dependency 'rainbow', '~> 3.0'
+  spec.add_dependency 'net-ssh', '~> 7.0'
+  spec.add_dependency 'logger'
   spec.add_dependency 'hashugar'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest', '~> 6.0'
 end

data/templates/create/sunzi.yml

@@ -3,7 +3,7 @@
 vars:
   github_username: kenn
   environment: production
-  ruby_version: 2.5
+  ruby_version: 3.3
 
 # Remote recipes here will be downloaded to compiled/recipes.
 recipes:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunzi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Kenn Ejima
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2026-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,44 +16,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: hashugar
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: hashugar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: Server provisioning utility for minimalists
 email:
 - kenn.ejima@gmail.com
@@ -102,8 +116,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -119,6 +133,7 @@ files:
 - lib/sunzi/dependency.rb
 - lib/sunzi/endpoint.rb
 - lib/sunzi/plugin.rb
+- plan.md
 - sunzi.gemspec
 - templates/create/.gitignore
 - templates/create/files/.gitkeep
@@ -133,7 +148,7 @@ homepage: https://github.com/kenn/sunzi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,9 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Server provisioning utility for minimalists
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - ruby-head