linecook 1.2.1 → 2.0.0

data/{History → History.rdoc}

@@ -1,6 +1,7 @@
-== 1.2.1 2011/05/26
+== 2.0.0 2012/01/05
 
-* made cookbook pick up alternate attributes files
+Big rewrite. Expect little backwards compatibility although the basic idea
+remains the same.
 
 == 1.2.0 2011/05/23
 

data/README.rdoc

@@ -0,0 +1,93 @@
+= Linecook
+
+A shell script generator.
+
+== Description
+
+Linecook helps to make scripts more manageable by allowing you to compose them
+from ERB helpers and attributes files. Scripts can be written at a higher
+level, and easily reconstructed when something changes. Scripts can be
+compiled in place, or built into packages that can be used, for example, to
+provision servers.
+
+== Usage
+
+Layout a project.
+
+  mkdir -p attributes helpers packages recipes
+
+Define attributes.
+
+  cat > attributes/chalkboard.yml <<DOC
+  n: 3
+  color: blue
+  message: I will not manually configure my server
+  DOC
+
+Define a helper.
+
+  mkdir -p helpers/chalkboard
+  cat > helpers/chalkboard/echo_in_color.erb <<DOC
+  Echo a string in color.
+  (color, str)
+    color_codes = Hash[*%W{
+      black       0;30   red         0;31
+      white       1;37   green       0;32
+      light_gray  0;37   blue        0;34
+    }]
+  --
+  echo -e '\033[<%= color_codes[color.to_s] %>m<%= str %>\033[0m'
+  DOC
+
+Use both in a recipe.
+
+  cat > recipes/chalkboard.rb <<DOC
+  attributes "chalkboard"
+  helpers "chalkboard"
+
+  attrs['n'].times do
+    echo_in_color attrs['color'], attrs['message']
+  end
+  DOC
+
+Build the recipe.
+
+  linecook build -c recipes/chalkboard.rb
+
+Check the packages directory to see the resulting script.
+
+  cat packages/chalkboard/run
+  echo -e '\033[0;34mI will not manually configure my server\033[0m'
+  echo -e '\033[0;34mI will not manually configure my server\033[0m'
+  echo -e '\033[0;34mI will not manually configure my server\033[0m'
+
+== Installation
+
+Linecook is available as a {gem}[http://rubygems.org/gems/linecook].
+
+  gem install linecook
+
+== Development
+
+Install dependencies using Bundler:
+
+  gem install bundler
+  bundle install
+
+Build a test VM using the {VM Setup}[rdoc-ref:doc/vm_setup.rdoc] doc, and make
+a config/ssh file that can can connect to it using the default Host (ie Host
+*). If you didn't customize anything, then you can use 'config/ssh.example'
+directly. When setup correctly this prints 'success' with any HOST:
+
+  ssh -F config/ssh [HOST] -- 'echo success'
+
+Now run the tests:
+
+  rake test
+
+Report issues and submit pull requests on {GitHub}[https://github.pinnacol.com/pinnacol/linecook].
+
+== Info 
+
+Developer:: {Simon Chiang}[http://github.com/thinkerbot]
+License:: {MIT-Style}[link:files/License_txt.html]

data/bin/linecook

@@ -1,65 +1,41 @@
 #!/usr/bin/env ruby
 
-if File.exists?('Gemfile') && ENV['LINECOOK_USE_BUNDLER'] != 'false'
-  require 'rubygems'
-  require 'bundler'
-  Bundler.setup
-end
-
 require 'linecook/version'
-require 'linecook/commands'
-registry = Linecook::Commands::Command.registry
+require 'linecook/executable'
 
-cmd = ARGV.shift
-cmd_class = registry[cmd]
+if ARGV.empty?
+  ARGV.unshift('--help')
+end
 
-if cmd_class.nil?
-  case cmd
-  when nil, '-h', '--help'
-    puts "usage: linecook [options] COMMAND"
-    puts
-    puts "commands: "
-    registry.keys.sort.each do |key|
-      cmd_class = registry[key]
-      puts "  %-16s   %s" % [key, cmd_class.desc]
+begin
+  Linecook::Executable.run do |callpath, command_class, options|
+    options.on '-h', '--help', 'print this help' do
+      puts "usage: #{callpath.unshift('linecook').join(' ')} #{command_class.signature}"
+      if command_class.respond_to?(:command_list)
+        puts
+        puts "commands:"
+        command_class.command_list.each do |name, command|
+          puts "    %-30s   %s" % [name, command.desc]
+        end
+        puts
+      else
+        puts command_class.help
+      end
+      puts "options:"
+      puts options.to_s
+
+      exit
     end
-    puts
-    puts "options:"
-    puts  "  -%s, --%-10s   %s" % ['v', 'version', 'print version']
-    puts  "  -%s, --%-10s   %s" % ['h', 'help', 'print this help']
     
-    exit
-  when '-v', '--version'
-    puts "linecook version #{Linecook::VERSION} -- #{Linecook::WEBSITE}"
-    exit
-  else
-    puts "unknown command: #{cmd.inspect}"
-    exit 1
-  end
-end
-
-parser = ConfigParser.new
-parser.add cmd_class.configurations
-parser.on '-h', '--help', 'print this help' do
-  puts "usage: linecook [options] #{cmd} #{cmd_class.args}"
-  
-  desc = cmd_class.desc.wrap(76, 2, "\n  ")
-  unless desc.empty?
-    puts
-    puts "  #{desc}"
-    puts
+    if command_class == Linecook::Executable
+      options.on('-v', '--version', 'print version') do |v|
+        puts "linecook version #{Linecook::VERSION} -- #{Linecook::WEBSITE}"
+        exit
+      end
+    end
   end
-  
-  puts "options:"
-  puts parser.to_s
-  exit
-end
-parser.parse! ARGV
-
-begin
-  cmd_class.new(parser.config).call ARGV
-rescue Linecook::Commands::CommandError
-  puts $!.message unless $!.message.strip.empty?
+rescue Linecook::CommandError
+  puts $!.message
   puts $!.backtrace if $DEBUG
-  exit $!.exitstatus
-end
+  exit 1
+end

data/bin/linecook_run

@@ -1,13 +1,14 @@
 #! /bin/sh
 ############################################################################
 
-ssh_config_file=${SSH_CONFIG_FILE:-config/ssh}
-remote_dir=${REMOTE_DIR:-$(pwd)/linecook}
+ssh_config_file=${SSH_CONFIG_FILE:-~/.ssh/config}
+remote_dir=${REMOTE_DIR:-\$(pwd)/linecook}
 remote_script=${REMOTE_SCRIPT:-run}
+xtrace="false"
 
-usage="usage: %s [-F SSH_CONFIG_FILE] [-D REMOTE_DIR] [-S REMOTE_SCRIPT] [-h] PACKAGE_DIRS...\n"
+usage="usage: %s [-F SSH_CONFIG_FILE] [-D REMOTE_DIR] [-S REMOTE_SCRIPT] [-h] [-x] PACKAGE_DIRS...\n"
 option="       %s   %s\n"
-while getopts "F:D:S:h" opt
+while getopts "F:D:S:h:x" opt
 do
   case $opt in
   F  )  ssh_config_file=$OPTARG ;;
@@ -18,20 +19,33 @@ do
         printf "$option" "-D" "the remote package dir"
         printf "$option" "-S" "the remote script"
         printf "$option" "-h" "prints this help"
+        printf "$option" "-x" "xtrace this script"
         exit 0 ;;
+  x  )  xtrace="true" ;;
   \? )  printf "$usage" $0
         exit 2 ;;
   esac
 done
 shift $(($OPTIND - 1))
 
+if [ "$xtrace" = "true" ]
+then set -x
+fi
+
 ################################### run ####################################
 
 for package_dir in "$@"
 do
 host=$(basename -- "$package_dir")
 
-ssh -q -t -t -F "$ssh_config_file" "$host" -- "$remote_dir/$remote_script" 2>/dev/null </dev/null
+# allocate pseudo-tty if possible so the script behaves as if the user
+# manually ran it on the VM, but don't force allocation as it can cause
+# hanging if no user is available for interaction (ex with su).
+if tty > /dev/null
+then ttyopt='-t'
+fi
+
+ssh -q $ttyopt -F "$ssh_config_file" "$host" -- "$remote_dir/$remote_script"
 
 status=$?
 if [ $status -ne 0 ]
@@ -39,7 +53,6 @@ then
   echo "[$status] $remote_dir/$remote_script" >&2
   exit 1
 fi
-
 done
 
 ################################## (run) ###################################

data/bin/linecook_scp

@@ -1,12 +1,13 @@
 #! /bin/sh
 ############################################################################
 
-ssh_config_file=${SSH_CONFIG_FILE:-config/ssh}
+ssh_config_file=${SSH_CONFIG_FILE:-~/.ssh/config}
 remote_dir=${REMOTE_DIR:-\$(pwd)/linecook}
+xtrace="false"
 
-usage="usage: %s [-D REMOTE_DIR] [-F SSH_CONFIG_FILE] [-h] PACKAGE_DIRS...\n"
+usage="usage: %s [-D REMOTE_DIR] [-F SSH_CONFIG_FILE] [-h] [-x] PACKAGE_DIRS...\n"
 option="       %s   %s\n"
-while getopts "F:D:h" opt
+while getopts "F:D:h:x" opt
 do
   case $opt in
   F  )  ssh_config_file=$OPTARG ;;
@@ -15,19 +16,27 @@ do
         printf "$option" "-F" "the ssh config file"
         printf "$option" "-D" "the remote package dir"
         printf "$option" "-h" "prints this help"
+        printf "$option" "-x" "xtrace this script"
         exit 0 ;;
+  x  )  xtrace="true" ;;
   \? )  printf "$usage" $0
         exit 2 ;;
   esac
 done
 shift $(($OPTIND - 1))
 
+if [ "$xtrace" = "true" ]
+then set -x
+fi
+
 ################################### scp ####################################
 
 for package_dir in "$@"
 do
 host=$(basename -- "$package_dir")
 
+# Note the subshell substitutions need to be escaped so that they will be
+# evaluated on the host -- ex: -R '$TMPDIR' (to get TMPDIR on the host)
 ssh -q -T -F "$ssh_config_file" "$host" -- <<SCRIPT
 rm -rf "$remote_dir"
 if [ "\$(dirname "$remote_dir")" != "" ]
@@ -47,4 +56,3 @@ fi
 done
 
 ################################## (scp) ###################################
-

data/doc/vm_setup.rdoc

@@ -0,0 +1,75 @@
+= Setting up a VM
+
+The only real requirement to allow testing of Linecook on a VM is that the VM
+be reachable by ssh. If you choose to run your VMs on VirtualBox and take care
+with a few snapshots then you can use some extra rake commands that expedite
+testing. Specifically you can reset+start and stop the VMs using:
+
+  rake start
+  rake stop
+
+As an example, build a {Ubuntu}[http://www.ubuntu.com/] VM on
+{VirtualBox}[http://www.virtualbox.org/] using the following:
+
+- name: ubuntu
+- Linux/Ubuntu
+- 512 MB memory
+- 8 GB dynamically resizing drive
+
+Add the iso to the cd/dvd device under Settings > Storage. Now start the
+server and install ubuntu (use default settings unless specified):
+
+- user/password: linecook
+- select 'OpenSSH server' in packages to install
+
+When the server has rebooted and is ready at the login screen, remove the
+install iso, take a snapshot and setup port forwarding. The snapshot is for
+convenience. Port forwarding allows you to ssh to yourself on one port (2220)
+and have that be received by the VM on another port (22).
+
+  (Devices > CD/DVD Devices > Remove disk from virtual drive)
+  VBoxManage snapshot ubuntu take RAW --pause
+  VBoxManage controlvm ubuntu poweroff
+  # wait to fully power off
+  VBoxManage modifyvm ubuntu --natpf1 'ubuntu-ssh,tcp,,2220,,22'
+  VBoxManage -q snapshot ubuntu restore RAW
+  VBoxManage startvm ubuntu
+
+Transfer your ssh key to the vm. Help to generate ssh keys can be found on
+{GitHub}[http://help.github.com/key-setup-redirect]:
+
+  scp -P 2220 -o UserKnownHostsFile=/dev/null ~/.ssh/id_rsa.pub linecook@localhost:id_rsa.pub
+
+Setup SSH for your user:
+
+  vm: mkdir .ssh
+  vm: mv id_rsa.pub .ssh/authorized_keys
+  vm: chmod 0700 .ssh
+  vm: chmod 0600 .ssh/authorized_keys
+
+Remove the login banner (cleans up test output) and exit.
+
+  vm: sudo rm /etc/motd
+  vm: exit
+
+Now take some standard snapshots. By taking them at the login screen you can
+reset to a running VM, which avoids startup overhead.
+
+  VBoxManage snapshot ubuntu take BASE --pause
+  VBoxManage snapshot ubuntu take CURRENT --pause
+  VBoxManage controlvm ubuntu poweroff
+
+To cleanup the port forwarding (run later, if ever):
+
+  VBoxManage modifyvm ubuntu --natpf1 delete 'ubuntu-ssh'
+
+Now add configs for this VM to config/ssh:
+
+  Host ubuntu
+  HostName localhost
+  Port 2220
+  User linecook
+
+Note that the Host, Port, and User should match up to the values you used
+during the VM setup. To add additional VMs, for instance to test on different
+operating systems, choose another name/port and repeat.

data/lib/linecook.rb

@@ -1,4 +1,5 @@
-require 'linecook/package'
+require "linecook/version"
 
 module Linecook
-end
+  # Your code goes here...
+end

data/lib/linecook/attributes.rb

@@ -1,5 +1,5 @@
 module Linecook
-  
+
   # Attributes provides a context for specifying default attributes.  For
   # example:
   #
@@ -21,36 +21,61 @@ module Linecook
     NEST_HASH_PROC = Proc.new do |hash, key|
       hash[key] = Hash.new(&NEST_HASH_PROC)
     end
-    
+
     class << self
       # Returns an auto-filling nested hash.
       def nest_hash
         Hash.new(&NEST_HASH_PROC)
       end
-      
+
       # Recursively disables automatic nesting of nest_hash hashes.
       def disable_nest_hash(hash)
         if hash.default_proc == NEST_HASH_PROC
           hash.default = nil
         end
-        
+
         hash.each_pair do |key, value|
           if value.kind_of?(Hash)
             disable_nest_hash(value)
           end
         end
-        
+
         hash
       end
     end
-    
+
     # An auto-filling nested hash
     attr_reader :attrs
-    
+
     def initialize
       @attrs = Attributes.nest_hash
     end
-    
+
+    # A list of file extnames that may be loaded by load_attrs
+    def load_attrs_extnames
+      %w{.rb .yml .yaml .json}
+    end
+
+    # Loads the attributes file into attrs. The loading mechanism depends on
+    # the file extname:
+    #
+    #   .rb: evaluate in the context of attributes
+    #   .yml,.yaml,.json: load as YAML and merge into attrs
+    #
+    # All other file types raise an error.
+    def load_attrs(path)
+      case File.extname(path)
+      when '.rb'
+        instance_eval(File.read(path), path)
+      when '.yml', '.yaml', '.json'
+        attrs.merge!(YAML.load_file(path))
+      else
+        raise "unsupported attributes format: #{path.inspect}"
+      end
+
+      self
+    end
+
     # Disables automatic nesting and returns attrs.
     def to_hash
       Attributes.disable_nest_hash(attrs)