sunzi 1.5.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c79ff341d30ba481b5240cf5c3048195ab083216
-  data.tar.gz: 3daae0bd5c6856bd049ad389478e7e03defe15bc
+SHA256:
+  metadata.gz: 7c118fcfb05d687e587068fea6079f6e365ffbf637ef0a4f73dbd1920dc8f138
+  data.tar.gz: 251b57a131bd76db42637bdcd0dad5b373b1a37e964680f5fde2531ff995b768
 SHA512:
-  metadata.gz: dbdaa4fe5e8e08d0ef456f798ae66b24023e91ac9a94c1bd3e53e130ce98da248b371d0566322086f4a1c2864d267a9d9368db235c81957fdbc76705d22dde1a
-  data.tar.gz: 6957a84b58e79c0fedad317489d4d2e010d974962a17a53a6e4b599ff8b94118ed1ff2c015f0755bdc3c7dd292a382218127a30fd421439775dea3e049a0c320
+  metadata.gz: 19c134eda8a7b0b53570ad335e79b019daa553ae46cb5f554bc80f2157ac11e10e04e51f0c6444d249d6b97f14aa806a85a7c78a11e555eddccb849fd320666b
+  data.tar.gz: be46e99817efb6b0a8e85c5b562297b1b755c3a552ff4977039e70bf672aea636b6fc9cc4e81520120c82f5267e3ff2ba249aed0f061dae9fa4b9adcc48ee1c4

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0, release 2018-01
+* Plug-in support for commands.
+* 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.
+
 ## 1.5, release 2013-09-27
 * `sunzi deploy [linode|digital_ocean] [name]` will deploy to the instance with additional attributes.
 

data/README.md

@@ -46,7 +46,7 @@ $ sunzi deploy example.com
 
 Now, what it actually does is:
 
-1. Compile `sunzi.yml` to generate attributes and retrieve remote recipes, then copy files into the `compiled` directory
+1. Compile `sunzi.yml` to generate variables and retrieve remote recipes, then copy files into the `compiled` directory
 1. SSH to `example.com` and login as `root`
 1. Transfer the content of the `compiled` directory to the remote server and extract in `$HOME/sunzi`
 1. Run `install.sh` on the remote server
@@ -60,12 +60,8 @@ Commands
 
 ```bash
 $ sunzi                                           # Show command help
-$ sunzi compile                                   # Compile Sunzi project
 $ sunzi create                                    # Create a new Sunzi project
 $ sunzi deploy [user@host:port] [role] [--sudo]   # Deploy Sunzi project
-
-$ sunzi setup [linode|digital_ocean]              # Setup a new VM on the cloud services
-$ sunzi teardown [linode|digital_ocean]           # Teardown an existing VM on the cloud services
 ```
 
 Directory structure
@@ -76,7 +72,7 @@ Here's the directory structure that `sunzi create` automatically generates:
 ```bash
 sunzi/
   install.sh      # main script
-  sunzi.yml       # add custom attributes and remote recipes here
+  sunzi.yml       # add custom variables and remote recipes here
 
   recipes/        # put commonly used scripts here, referred from install.sh
     sunzi.sh
@@ -84,6 +80,7 @@ sunzi/
     db.sh         # to install.sh in the compile phase
     web.sh
   files/          # put any files to be transferred
+
   compiled/       # everything under this folder will be transferred to the
                   # remote server (do not edit directly)
 ```
@@ -91,22 +88,18 @@ sunzi/
 How do you pass dynamic values?
 -------------------------------
 
-There are two ways to pass dynamic values to the script - ruby and bash.
-
-**For ruby (recommended)**: Make sure `eval_erb: true` is set in `sunzi.yml`. In the compile phase, attributes defined in `sunzi.yml` are accessible from any files in the form of `<%= @attributes.ruby_version %>`.
-
-**For bash**: In the compile phase, attributes defined in `sunzi.yml` are split into multiple files in `compiled/attributes`, one per attribute. Now you can refer to it by `$(cat attributes/ruby_version)` in the script.
+In the compile phase, variables defined in `sunzi.yml` are accessible from any files in the form of `<%= @vars.ruby_version %>`
 
 For instance, given the following `install.sh`:
 
 ```bash
-echo "Goodbye <%= @attributes.goodbye %>, Hello <%= @attributes.hello %>!"
+echo "Goodbye <%= @vars.goodbye %>, Hello <%= @vars.hello %>!"
 ```
 
 With `sunzi.yml`:
 
 ```yaml
-attributes:
+vars:
   goodbye: Chef
   hello: Sunzi
 ```
@@ -150,19 +143,6 @@ sunzi deploy example.com web
 
 It is equivalent to running `install.sh`, followed by `web.sh`.
 
-Cloud Support
--------------
-
-You can setup a new VM, or teardown an existing VM interactively. Use `sunzi setup` and `sunzi teardown` for that.
-
-The following screenshot says it all.
-
-![Sunzi for Linode](http://farm8.staticflickr.com/7210/6783789868_ab89010d5c.jpg)
-
-Right now, only [Linode](http://www.linode.com/) and [DigitalOcean](https://www.digitalocean.com) are supported.
-
-For DNS, Linode and [Amazon Route 53](http://aws.amazon.com/route53/) are supported.
-
 Vagrant
 -------
 
@@ -171,21 +151,13 @@ If you're using Sunzi with [Vagrant](http://vagrantup.com/), make sure that you
 An easy way is to edit `Vagrantfile`:
 
 ```ruby
-Vagrant::Config.run do |config|
-  config.vm.provision :shell do |shell|
-    shell.path = "chpasswd.sh"
+Vagrant.configure("2") do |config|
+  config.vm.provision "shell",
+    inline: "sudo echo 'root:vagrant' | /usr/sbin/chpasswd"
   end
 end
 ```
 
-with `chpasswd.sh`:
-
-```bash
-#!/bin/bash
-
-sudo echo 'root:vagrant' | /usr/sbin/chpasswd
-```
-
 and now run `vagrant up`, it will change the root password to `vagrant`.
 
 Also keep in mind that you need to specify the port number 2222.
@@ -193,3 +165,8 @@ Also keep in mind that you need to specify the port number 2222.
 ```bash
 $ sunzi deploy localhost:2222
 ```
+
+Demonstration Videos
+-------
+
+You can watch video on how to deploy a Rails 4.1 app with Sunzi and Capistrano 3 at http://youtu.be/3mwupXqtkmg

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sunzi'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sunzi.rb

@@ -1,28 +1,24 @@
-require 'thor'
-require 'rainbow'
+# Stdlib
+require 'erb'
+require 'pathname'
 require 'yaml'
 
-# Starting 2.0.0, Rainbow no longer patches string with the color method by default.
-require 'rainbow/version'
-require 'rainbow/ext/string' unless Rainbow::VERSION < '2.0.0'
+# Gems
+require 'hashugar'
+require 'rainbow/ext/string'
+require 'thor'
 
+# Sunzi
 module Sunzi
-  autoload :Cli,        'sunzi/cli'
-  autoload :Cloud,      'sunzi/cloud'
-  autoload :Dependency, 'sunzi/dependency'
-  autoload :DNS,        'sunzi/dns'
-  autoload :Logger,     'sunzi/logger'
-  autoload :Utility,    'sunzi/utility'
+  GemRoot = Pathname.new(Gem.loaded_specs['sunzi'].gem_dir)
+end
 
-  class Cloud
-    autoload :Base,         'sunzi/cloud/base'
-    autoload :Linode,       'sunzi/cloud/linode'
-    autoload :DigitalOcean, 'sunzi/cloud/digital_ocean'
-  end
+require 'sunzi/core_ext'
+require 'sunzi/actions'
+require 'sunzi/dependency'
 
-  class DNS
-    autoload :Base,     'sunzi/dns/base'
-    autoload :Linode,   'sunzi/dns/linode'
-    autoload :Route53,  'sunzi/dns/route53'
-  end
-end
+require 'sunzi/cli'
+
+# Plug-ins
+require 'sunzi/plugin'
+Sunzi::Plugin.load

data/lib/sunzi/actions.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+
+module Sunzi
+  class Actions < Thor
+    # This class exists because thor has to be inherited AND included to import actions.
+    #
+    # https://github.com/erikhuda/thor/wiki/Actions
+    #
+    # This interface is ugly. Instead, initialize once and reuse everywhere.
+
+    include Thor::Actions
+
+    source_root GemRoot
+
+    # include this module to use delegate_to_thor method.
+    module Delegate
+      def self.included(base)
+        base.extend Forwardable
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def delegate_to_thor(*args)
+          def_delegators :'Sunzi.thor', *args
+        end
+      end
+    end
+  end
+
+  class << self
+    def thor
+      @thor ||= Sunzi::Actions.new
+    end
+  end
+end

data/lib/sunzi/cli.rb

@@ -1,35 +1,22 @@
-require 'open3'
-require 'ostruct'
-require 'net/ssh'
+require 'sunzi/command'
 
 module Sunzi
   class Cli < Thor
-    include Thor::Actions
 
     desc 'create', 'Create sunzi project'
     def create(project = 'sunzi')
-      do_create(project)
+      Sunzi::Command.new.create(project)
     end
 
-    desc 'deploy [user@host:port] [role] [--sudo] or deploy [linode|digital_ocean] [name] [role]  [--sudo]', 'Deploy sunzi project'
-    method_options :sudo => false
+    desc 'deploy [user@host:port] [role] [--sudo]', 'Deploy sunzi project'
+    method_options sudo: false
     def deploy(first, *args)
-      do_deploy(first, *args)
+      Sunzi::Command.new.deploy(first, *args)
     end
 
     desc 'compile', 'Compile sunzi project'
     def compile(role = nil)
-      do_compile(role)
-    end
-
-    desc 'setup [linode|digital_ocean]', 'Setup a new VM'
-    def setup(provider)
-      Sunzi::Cloud.new(self, provider).setup
-    end
-
-    desc 'teardown [linode|digital_ocean]', 'Teardown an existing VM'
-    def teardown(provider)
-      Sunzi::Cloud.new(self, provider).teardown
+      Sunzi::Command.new.compile(role)
     end
 
     desc 'version', 'Show version'
@@ -37,125 +24,5 @@ module Sunzi
       puts Gem.loaded_specs['sunzi'].version.to_s
     end
 
-    no_tasks do
-      include Sunzi::Utility
-
-      def self.source_root
-        File.expand_path('../../',__FILE__)
-      end
-
-      def do_create(project)
-        copy_file 'templates/create/.gitignore',         "#{project}/.gitignore"
-        copy_file 'templates/create/sunzi.yml',          "#{project}/sunzi.yml"
-        copy_file 'templates/create/install.sh',         "#{project}/install.sh"
-        copy_file 'templates/create/recipes/sunzi.sh',   "#{project}/recipes/sunzi.sh"
-        copy_file 'templates/create/roles/db.sh',        "#{project}/roles/db.sh"
-        copy_file 'templates/create/roles/web.sh',       "#{project}/roles/web.sh"
-        copy_file 'templates/create/files/.gitkeep',     "#{project}/files/.gitkeep"
-      end
-
-      def do_deploy(first, *args)
-        if ['linode', 'digital_ocean'].include?(first)
-          @instance_attributes = YAML.load(File.read("#{first}/instances/#{args[0]}.yml"))
-          target = @instance_attributes[:fqdn]
-          role = args[1]
-        else
-          target = first
-          role = args[0]
-        end
-
-        sudo = 'sudo ' if options.sudo?
-        user, host, port = parse_target(target)
-        endpoint = "#{user}@#{host}"
-
-        # compile attributes and recipes
-        do_compile(role)
-
-        # 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 #{host} 2> /dev/null`
-
-        remote_commands = <<-EOS
-        rm -rf ~/sunzi &&
-        mkdir ~/sunzi &&
-        cd ~/sunzi &&
-        tar xz &&
-        #{sudo}bash install.sh
-        EOS
-
-        remote_commands.strip! << ' && rm -rf ~/sunzi' if @config['preferences'] and @config['preferences']['erase_remote_folder']
-
-        local_commands = <<-EOS
-        cd compiled
-        tar cz . | ssh -o 'StrictHostKeyChecking no' #{endpoint} -p #{port} '#{remote_commands}'
-        EOS
-
-        Open3.popen3(local_commands) do |stdin, stdout, stderr|
-          stdin.close
-          t = Thread.new do
-            while (line = stderr.gets)
-              print line.color(:red)
-            end
-          end
-          while (line = stdout.gets)
-            print line.color(:green)
-          end
-          t.join
-        end
-      end
-
-      def do_compile(role)
-        # Check if you're in the sunzi directory
-        abort_with 'You must be in the sunzi folder' unless File.exists?('sunzi.yml')
-        # Check if role exists
-        abort_with "#{role} doesn't exist!" if role and !File.exists?("roles/#{role}.sh")
-
-        # Load sunzi.yml
-        @config = YAML.load(File.read('sunzi.yml'))
-
-        # Merge instance attributes
-        @config['attributes'] ||= {}
-        @config['attributes'].update(Hash[@instance_attributes.map{|k,v| [k.to_s, v] }]) if @instance_attributes
-
-        # Break down attributes into individual files
-        (@config['attributes'] || {}).each {|key, value| create_file "compiled/attributes/#{key}", value }
-
-        # Retrieve remote recipes via HTTP
-        cache_remote_recipes = @config['preferences'] && @config['preferences']['cache_remote_recipes']
-        (@config['recipes'] || []).each do |key, value|
-          next if cache_remote_recipes and File.exists?("compiled/recipes/#{key}.sh")
-          get value, "compiled/recipes/#{key}.sh"
-        end
-
-        # Copy local files
-        @attributes = OpenStruct.new(@config['attributes'])
-        copy_or_template = (@config['preferences'] && @config['preferences']['eval_erb']) ? :template : :copy_file
-        Dir['recipes/*'].each {|file| send copy_or_template, File.expand_path(file), "compiled/recipes/#{File.basename(file)}" }
-        Dir['roles/*'].each   {|file| send copy_or_template, File.expand_path(file), "compiled/roles/#{File.basename(file)}" }
-        Dir['files/*'].each   {|file| send copy_or_template, File.expand_path(file), "compiled/files/#{File.basename(file)}" }
-        (@config['files'] || []).each {|file| send copy_or_template, File.expand_path(file), "compiled/files/#{File.basename(file)}" }
-
-        # Build install.sh
-        if role
-          if copy_or_template == :template
-            template File.expand_path('install.sh'), 'compiled/_install.sh'
-            create_file 'compiled/install.sh', File.binread('compiled/_install.sh') << "\n" << File.binread("compiled/roles/#{role}.sh")
-          else
-            create_file 'compiled/install.sh', File.binread('install.sh') << "\n" << File.binread("roles/#{role}.sh")
-          end
-        else
-          send copy_or_template, File.expand_path('install.sh'), 'compiled/install.sh'
-        end
-      end
-
-      def parse_target(target)
-        target.match(/(.*@)?(.*?)(:.*)?$/)
-        # Load ssh config if it exists
-        config = Net::SSH::Config.for($2)
-        [ ($1 && $1.delete('@') || config[:user] || 'root'), 
-          config[:host_name] || $2, 
-          ($3 && $3.delete(':') || config[:port] && config[:port].to_s || '22') ]
-      end
-    end
   end
 end

data/lib/sunzi/command.rb

@@ -0,0 +1,113 @@
+require 'open3'
+require 'sunzi/endpoint'
+
+module Sunzi
+  class Command
+    include Sunzi::Actions::Delegate
+
+    delegate_to_thor :copy_file, :template, :get, :append_to_file, :options
+
+    def create(project)
+      copy_file 'templates/create/.gitignore',         "#{project}/.gitignore"
+      copy_file 'templates/create/sunzi.yml',          "#{project}/sunzi.yml"
+      copy_file 'templates/create/install.sh',         "#{project}/install.sh"
+      copy_file 'templates/create/recipes/sunzi.sh',   "#{project}/recipes/sunzi.sh"
+      copy_file 'templates/create/roles/db.sh',        "#{project}/roles/db.sh"
+      copy_file 'templates/create/roles/web.sh',       "#{project}/roles/web.sh"
+      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)
+
+      # compile vars and recipes
+      compile(role)
+
+      # 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`
+
+      remote_commands = <<-EOS
+      rm -rf ~/sunzi &&
+      mkdir ~/sunzi &&
+      cd ~/sunzi &&
+      tar xz &&
+      #{sudo}bash install.sh
+      EOS
+
+      remote_commands.strip! << ' && rm -rf ~/sunzi' if config.preferences.erase_remote_folder
+
+      local_commands = <<-EOS
+      cd compiled
+      tar cz . | ssh -o 'StrictHostKeyChecking no' #{endpoint.user}@#{endpoint.host} -p #{endpoint.port} '#{remote_commands}'
+      EOS
+
+      Open3.popen3(local_commands) do |stdin, stdout, stderr|
+        stdin.close
+        t = Thread.new do
+          while (line = stderr.gets)
+            print line.color(:red)
+          end
+        end
+        while (line = stdout.gets)
+          print line.color(:green)
+        end
+        t.join
+      end
+    end
+
+    def compile(role = nil)
+      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
+
+      # Retrieve remote recipes via HTTP
+      (config.recipes || []).each do |key, value|
+        dest = "compiled/recipes/#{key}.sh"
+        next if config.preferences.cache_remote_recipes && File.exist?(dest)
+        get value, dest
+      end
+
+      @vars = config.vars # Used within ERB templates
+
+      # Copy local files to compiled folder
+      files = Dir['{recipes,roles,files}/**/*'].select { |file| File.file?(file) }
+
+      files.each do |file|
+        render file, "compiled/#{file}"
+      end
+
+      # Copy files specified in sunzi.yml
+      (config.files || []).each do |file|
+        render file, "compiled/files/#{File.basename(file)}"
+      end
+
+      # Build install.sh
+      render 'install.sh', 'compiled/install.sh'
+
+      # Append role at the bottom of install.sh
+      if role
+        append_to_file 'compiled/install.sh', "\n" + File.read("compiled/roles/#{role}.sh")
+      end
+    end
+
+  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
+    end
+
+    # template method requires absolute path to work with current directory
+    #
+    def render(source, target)
+      template File.expand_path(source), target, context: binding
+    end
+
+  end
+end