sunzi 0.2.1 → 0.3.0

data/README.md

@@ -11,8 +11,8 @@ Sunzi assumes that modern Linux distributions have (mostly) sane defaults and gr
 
 Its design goals are:
 
-* **It's just shell script.** No clunky Ruby DSL involved. Sunzi recipes are written in a plain shell script. Why? Because, most of the information about server configuration on the web is written in shell commands. Just copy-paste them, why should you translate it into a proprietary, inconvenience DSL? Also, shell script 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 makes it difficult to understand what you are really doing.
+* **It's just shell script.** No clunky Ruby DSL involved. Sunzi recipes are written in a plain shell script. Why? Because, most of the information about server configuration on the web is written in shell commands. Just copy-paste them, why should you translate it into a proprietary, inconvenient DSL? Also, shell script 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.
 
@@ -32,7 +32,7 @@ It generates a `sunzi` folder along with subdirectories and templates. Inside `s
 Go into the `sunzi` directory, then run the `sunzi deploy`:
 
     $ cd sunzi
-    $ sunzi deploy root@example.com
+    $ sunzi deploy example.com
 
 Now, what it actually does is:
 
@@ -49,21 +49,55 @@ Here's the directory structure that `sunzi create` automatically generates:
 
 ```
 sunzi/
-  attributes.yml    ---- add custom attributes here
-  recipes.yml       ---- add remote recipes here
+  sunzi.yml         ---- add custom attributes and remote recipes here
   remote/           ---- everything under this folder will be transferred to the remote server
-    attributes/     ---- compiled attributes from attributes.yml at deploy (do not edit directly)
-      env
+    attributes/     ---- compiled attributes from sunzi.yml at deploy (do not edit directly)
       ssh_key
     recipes/        ---- put commonly used scripts here, referred from install.sh
       ssh_key.sh
     install.sh      ---- main scripts that gets run on the remote server
 ```
 
+How do you pass dynamic values to a recipe?
+-------------------------------------------
+
+In the compile phase, `attributes.yml` are split into multiple files, one per attribute. We use filesystem as a sort of key-value storage so that it's easy to use from shell scripts.
+
+The convention for argument passing to a recipe is to use `$1`, `$2`, etc. and put a comment line for each argument.
+
+For instance, given a recipe `greeting.sh`:
+
+```
+# Greeting
+# $1: Name for goodbye
+# $2: Name for hello
+
+echo "Goodbye $1, Hello $2!"
+```
+
+With `attributes.yml`:
+
+```
+goodbye: Chef
+hello: Sunzi
+```
+
+Then, include the recipe in `install.sh`:
+
+```
+source recipes/greeting.sh $(cat attributes/goodbye) $(cat attributes/hello)
+```
+
+Now, you get the following result. Isn't it awesome?
+
+```
+Goodbye Chef, Hello Sunzi!
+```
+
 Remote Recipes
 --------------
 
-Recipes can be retrieved remotely via HTTP. Put the URL in `recipes.yml`, and Sunzi automatically loads the content and put it into the `remote/recipes` folder.
+Recipes can be retrieved remotely via HTTP. Put a URL in `recipes.yml`, and Sunzi automatically loads the content and put it into the `remote/recipes` folder.
 
 For instance, if you have the following line in `recipes.yml`,
 
@@ -76,7 +110,28 @@ rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh
 Vagrant
 -------
 
-If you're using Sunzi with [Vagrant](http://vagrantup.com/), you need to specify the port number 2222.
+If you're using Sunzi with [Vagrant](http://vagrantup.com/), make sure that you have a root access via SSH.
+
+An easy way is to edit `Vagrantfile`:
+
+```ruby
+Vagrant::Config.run do |config|
+  config.vm.provision :shell do |shell|
+    shell.path = "chpasswd.sh"
+  end
+end
+```
+
+with `chpasswd.sh`:
+
+```
+#!/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.
 
-    $ vagrant up
-    $ sunzi deploy root@localhost 2222
+    $ sunzi deploy localhost:2222

data/lib/sunzi/cli.rb

@@ -18,37 +18,31 @@ module Sunzi
     # map "c" => :create
     # map "d" => :deploy
 
-    desc "create [PROJECT]", "Create sunzi project"
+    desc "create", "Create sunzi project"
     def create(project = 'sunzi')
       empty_directory project
       empty_directory "#{project}/remote"
       empty_directory "#{project}/remote/recipes"
-      template "templates/attributes.yml",            "#{project}/attributes.yml"
-      template "templates/recipes.yml",               "#{project}/recipes.yml"
+      template "templates/sunzi.yml",                 "#{project}/sunzi.yml"
       template "templates/remote/install.sh",         "#{project}/remote/install.sh"
       template "templates/remote/recipes/ssh_key.sh", "#{project}/remote/recipes/ssh_key.sh"
     end
 
-    desc "deploy [USER@HOST] [PORT]", "Deploy sunzi project"
-    def deploy(*target)
-      if target.empty? or !target.first.match(/@/)
-        say shell.set_color("Usage: sunzi deploy root@example.com", :red, true)
-        abort
-      end
+    desc "deploy example.com (or user@example.com:2222)", "Deploy sunzi project"
+    def deploy(target)
+      user, host, port = parse_target(target)
+      endpoint = "#{user}@#{host}"
 
+      # compile attributes and recipes
       compile
 
-      host, port = target
-      port ||= 22
-      user, domain = host.split('@')
-
       # 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 #{domain} 2> /dev/null`
+      `ssh-keygen -R #{host} 2> /dev/null`
 
       commands = <<-EOS
       cd remote
-      tar cz . | ssh -o 'StrictHostKeyChecking no' #{host} -p #{port} '
+      tar cz . | ssh -o 'StrictHostKeyChecking no' #{endpoint} -p #{port} '
       rm -rf ~/sunzi &&
       mkdir ~/sunzi &&
       cd ~/sunzi &&
@@ -73,24 +67,31 @@ module Sunzi
     desc "compile", "Compile sunzi project"
     def compile
       # Check if you're in the sunzi directory
-      unless File.exists?('attributes.yml')
+      unless File.exists?('sunzi.yml')
         say shell.set_color("You must be in the sunzi folder", :red, true)
         abort
       end
 
-      # Compile attributes.yml
-      hash = YAML.load(File.read('attributes.yml'))
+      # Load sunzi.yml
+      hash = YAML.load(File.read('sunzi.yml'))
       empty_directory 'remote/attributes'
-      hash.each do |key, value|
+      empty_directory 'remote/recipes'
+
+      # Compile attributes.yml
+      hash['attributes'].each do |key, value|
         File.open("remote/attributes/#{key}", 'w'){|file| file.write(value) }
       end
-
       # Compile recipes.yml
-      hash = YAML.load(File.read('recipes.yml'))
-      empty_directory 'remote/recipes'
-      hash.each do |key, value|
+      hash['recipes'].each do |key, value|
         get value, "remote/recipes/#{key}.sh"
       end
     end
+
+    no_tasks do
+      def parse_target(target)
+        target.match(/(.*@)?(.*?)(:.*)?$/)
+        [ ($1 && $1.delete('@') || 'root'), $2, ($3 && $3.delete(':') || '22') ]
+      end
+    end
   end
 end

data/lib/sunzi/version.rb

@@ -1,3 +1,3 @@
 module Sunzi
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/templates/remote/install.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
 
+# This line is necessary for automated provisioning for Debian/Ubuntu
+export DEBIAN_FRONTEND=noninteractive
+
 # SSH key
 source recipes/ssh_key.sh $(cat attributes/ssh_key)
 

data/lib/templates/sunzi.yml

@@ -0,0 +1,7 @@
+---
+attributes:
+  # Dynamic variables here will be compiled to individual files in remote/attributes.
+  ssh_key: id_rsa.pub
+recipes:
+  # Remote recipes here will be loaded to individual files in remote/recipes.
+  rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh

data/test/test_cli.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require '../lib/sunzi'
+
+class TestCli < Test::Unit::TestCase
+  def setup
+    @cli = Sunzi::Cli.new
+  end
+
+  def test_parse_target
+    assert_equal ['user', 'example.com', '2222'], @cli.parse_target('user@example.com:2222')
+    assert_equal ['root', 'example.com', '2222'], @cli.parse_target('example.com:2222')
+    assert_equal ['user', 'example.com', '22'],   @cli.parse_target('user@example.com')
+    assert_equal ['root', 'example.com', '22'],   @cli.parse_target('example.com')
+    assert_equal ['root', '192.168.0.1', '22'],   @cli.parse_target('192.168.0.1')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunzi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2152751920 !ruby/object:Gem::Requirement
+  requirement: &2152751900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152751920
+  version_requirements: *2152751900
 description: Server provisioning utility for minimalists
 email:
 - kenn.ejima@gmail.com
@@ -39,11 +39,11 @@ files:
 - lib/sunzi/base.rb
 - lib/sunzi/cli.rb
 - lib/sunzi/version.rb
-- lib/templates/attributes.yml
-- lib/templates/recipes.yml
 - lib/templates/remote/install.sh
 - lib/templates/remote/recipes/ssh_key.sh
+- lib/templates/sunzi.yml
 - sunzi.gemspec
+- test/test_cli.rb
 homepage: http://github.com/kenn/sunzi
 licenses: []
 post_install_message: 
@@ -68,4 +68,5 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Server provisioning utility for minimalists
-test_files: []
+test_files:
+- test/test_cli.rb

data/lib/templates/attributes.yml

@@ -1,3 +0,0 @@
---- # Dynamic variables here will be compiled to individual files in remote/attributes.
-env: production
-ssh_key: id_rsa.pub

data/lib/templates/recipes.yml

@@ -1,2 +0,0 @@
---- # Remote recipes here will be loaded to individual files in remote/recipes.
-rvm: https://raw.github.com/kenn/sunzi-recipes/master/ruby/rvm.sh