linecook 0.6.2

data/History

@@ -0,0 +1,60 @@
+== 0.6.2 2011/01/06
+
+* added helper command to build a single helper
+* improved rake tasks in template to build as-needed
+* bugfix in Test#assert_content
+
+== 0.6.1 2011/01/06
+
+* added version flag to linecook
+* updated/improved help
+
+== 0.6.0 2011/01/06
+
+Rework with a cleaner interface. Now package interfaces with env state, which
+gets passed around, rather than the hodge-podge of state passed around
+previously.
+
+== 0.5.0 2010/12/28
+
+* rework with the ability to test more
+
+== 0.4.0 2010/12/27
+
+* enhanced linecook executable with commands
+* added sketches of default shell helpers
+* bug fixes
+
+== 0.3.1 2010/12/23
+
+* prevent capture_path from stripping content
+* added test tasks to template
+
+== 0.3.0 2010/12/23
+
+* improved configuration of cookbook manifest
+* helpers are now created in lib directory, by 
+  default under the Linebook namespace
+* added bundler support to template
+* renamed LineCook as Linecook
+
+== 0.2.1 2010/12/21
+
+* added missing line_cook executable
+
+== 0.2.0 2010/12/20
+
+Complete overhaul.
+
+* reworked script generation using rake
+* sketched out functionality for use of gems
+* added line_cook executable to generate scaffold
+
+== 0.1.1 2010/12/07
+
+* added nodoc to definition templates
+* added tap.yml for generator discover
+
+== 0.1.0 2010/12/07
+
+Initial release.

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Pinnacol Assurance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software. Except as contained in this
+notice, the name(s) of the above copyright holders shall not be used in
+advertising or otherwise to promote the sale, use or other dealings in this
+Software without prior written authorization.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -0,0 +1,98 @@
+= Linecook
+
+A shell script generator.
+
+== Description
+
+Linecook lets you generate shell scripts using an extensible set of tiny ERB
+helpers. The helpers output a shell script that you can use to (for example)
+provision a server.
+
+The workflow is like this:
+
+* define helpers
+* write a recipe using the helpers
+* generate a script from the recipe
+
+Linecook provides very basic helpers for POSIX shells and a command-line tool
+for generating scripts and running them on a test vm.
+
+== Usage
+
+Generate a cookbook.
+
+  % linecook init example
+  % cd example
+
+Make some helpers.
+
+  [helpers/example/_head.rb]
+  COLOR_CODES = Hash[*%W{
+    black       0;30   red         0;31
+    white       1;37   green       0;32
+    light_gray  0;37   blue        0;34
+  }]
+  
+  [helpers/example/color.erb]
+  Adds color to a string.
+  (color, str)
+  --
+  \033[<%= COLOR_CODES[color.to_s] %>m<%= str %>\033[0m
+  
+  [helpers/example/echo.erb]
+  Echo a string in color
+  (str, options={})
+  color = options[:color]
+  --
+  echo -e '<%= color ? _color(color, str) : str %>'
+
+Define default attributes.
+
+  [recipes/example.rb]
+  attrs['example']['n'] = 3
+  attrs['example']['color'] = 'blue'
+
+Use them in a recipe.
+
+  [recipes/example.rb]
+  helpers "example"
+  attributes "example"
+  
+  attrs['example']['n'].times do
+    echo "I will not manually configure my server", :color => attrs['example']['color']
+  end
+
+Define a script using the recipe.
+
+  [scripts/example.yml]
+  linecook:
+    recipe_name: example
+    script_name: example.sh
+  example:
+    n: 100
+
+Generate a script from the helpers, attributes, and recipe.
+
+  % rake scripts
+
+Start the VM and run the scripts (see the docs for setting up a VM).
+
+  % rake vbox:start
+  % rake vbox:ssh 
+  vm: bash /vbox/scripts/example.sh
+  vm: exit
+
+Stop the VM.
+
+  % rake vbox:stop
+
+== Installation
+
+Linecook is available as a gem on {Gemcutter}[http://gemcutter.org/gems/linecook]
+
+  % gem install linecook
+
+== Info 
+
+Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com]
+License:: {MIT-Style}[link:files/License_txt.html]

data/bin/linecook

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'linecook/version'
+require 'linecook/commands'
+registry = Linecook::Commands::Command.registry
+
+cmd = ARGV.shift
+cmd_class = registry[cmd]
+
+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]
+    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 "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
+  unless desc.empty?
+    puts
+    puts cmd_class.desc.wrap
+    puts
+  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
+  exit 1
+end

data/lib/linecook/attributes.rb

@@ -0,0 +1,22 @@
+require 'linecook/utils'
+
+module Linecook
+  class Attributes
+    attr_reader :attrs
+    attr_reader :context
+    
+    def initialize(context={})
+      @context = context
+      reset(true)
+    end
+    
+    def current
+      @current ||= Utils.serial_merge(attrs, context)
+    end
+    
+    def reset(full=true)
+      @attrs = Utils.nest_hash if full
+      @current = nil
+    end
+  end
+end

data/lib/linecook/commands/command.rb

@@ -0,0 +1,48 @@
+require 'linecook/commands/command_error'
+require 'configurable'
+
+module Linecook
+  module Commands
+    class Command
+      class << self
+        def registry
+          REGISTRY
+        end
+        
+        def inherited(base)
+          super
+          registry[base.to_s.split('::').last.downcase] = base
+        end
+      end
+      
+      REGISTRY = {}
+      
+      extend Lazydoc::Attributes
+      include Configurable
+      
+      lazy_attr :desc
+      lazy_attr :args, :process
+      lazy_register :process, Lazydoc::Arguments
+      
+      def initialize(config)
+        initialize_config(config)
+      end
+      
+      def log(action, msg)
+        puts("      %s  %s" % [action, msg])
+      end
+      
+      def sh(cmd)
+        system cmd
+      end
+      
+      def call(argv)
+        process(*argv)
+      end
+      
+      def process(*args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/linecook/commands/command_error.rb

@@ -0,0 +1,6 @@
+module Linecook
+  module Commands
+    class CommandError < RuntimeError
+    end
+  end
+end

data/lib/linecook/commands/env.rb

@@ -0,0 +1,23 @@
+require 'linecook/commands/command'
+require 'linecook/cookbook'
+
+module Linecook
+  module Commands
+    
+    # ::desc prints the cookbook env
+    #
+    # Print the cookbook env.
+    #
+    class Env < Command
+      config :cookbook_dir, '.', :short => :d       # the cookbook directory
+      config :path, nil                             # package path
+      
+      def process(*keys)
+        current = Linecook::Cookbook.init(cookbook_dir).env(path)
+        keys.each {|key| current = current[key] if current }
+        
+        YAML.dump(current, $stdout)
+      end
+    end
+  end
+end

data/lib/linecook/commands/helper.rb

@@ -0,0 +1,51 @@
+require 'linecook/commands/command'
+require 'linecook/helper'
+require 'linecook/utils'
+
+module Linecook
+  module Commands
+    
+    # ::desc generates a helper
+    class Helper < Command
+      config :cookbook_dir, '.', :short => :d       # the cookbook directory
+      config :namespace, 'linebook', :short => :n   # the helper namespace
+      config :force, false, :short => :f, &c.flag   # force creation
+      
+      include Utils
+      
+      def process(name, *sources)
+        name = underscore(name)
+        
+        const_path = namespace ? File.join(namespace, name) : name
+        const_name = camelize(const_path)
+        
+        sources = default_sources(name) if sources.empty?
+        target  = File.expand_path(File.join('lib', "#{const_path}.rb"), cookbook_dir)
+        
+        if sources.empty?
+          raise CommandError, "no sources specified (and none could be found)"
+        end
+        
+        if File.exists?(target) && !force
+          raise CommandError, "already exists: #{target}"
+        end
+        
+        log :create, const_name
+        
+        helper = Linecook::Helper.new(const_name, sources)
+        content = helper.build
+
+        target_dir = File.dirname(target)
+        unless File.exists?(target_dir)
+          FileUtils.mkdir_p(target_dir) 
+        end
+
+        File.open(target, 'w') {|io| io << content }
+      end
+      
+      def default_sources(name)
+        Dir.glob File.join(cookbook_dir, 'helpers', name, '**/*')
+      end
+    end
+  end
+end

data/lib/linecook/commands/helpers.rb

@@ -0,0 +1,28 @@
+require 'linecook/commands/helper'
+
+module Linecook
+  module Commands
+    
+    # ::desc generates all helpers
+    #
+    # Generates helpers that match the input patterns (by default all,
+    # helpers).
+    #
+    class Helpers < Helper
+      def process
+        helpers_dir = File.expand_path('helpers', cookbook_dir)
+
+        sources = {}
+        Dir.glob("#{helpers_dir}/**/*").each do |source|
+          next if File.directory?(source)
+          (sources[File.dirname(source)] ||= []) << source
+        end
+
+        sources.each_pair do |dir, sources|
+          name = dir[(helpers_dir.length+1)..-1]
+          super(name, *sources)
+        end
+      end
+    end
+  end
+end

data/lib/linecook/commands/init.rb

@@ -0,0 +1,82 @@
+require 'linecook/commands/command'
+require 'fileutils'
+require 'erb'
+require 'ostruct'
+
+module Linecook
+  module Commands
+    
+    # ::desc init a linecook scaffold
+    #
+    # Initializes a linecook scaffold in the specified directory.  This
+    # initializer is currently very basic; it is not a true generator.
+    # 
+    class Init < Command
+      config :force, false, :short => :f, &c.flag   # force creation
+      
+      def source_dir
+        @source_dir ||= File.expand_path('../../../../templates', __FILE__)
+      end
+      
+      def process(project_dir)
+        project_dir = File.expand_path(project_dir)
+        
+        prepare project_dir
+        template project_dir
+      end
+      
+      def prepare(project_dir)
+        if File.exists?(project_dir)
+          unless force
+            raise CommandError.new("already exists: #{project_dir}")
+          end
+
+          current_dir = File.expand_path('.')
+          unless project_dir.index(current_dir) == 0 && project_dir.length > current_dir.length
+            raise CommandError.new("cannot force creation of current or parent directory (safety issue)")
+          end
+
+          FileUtils.rm_rf(project_dir)
+        end
+      end
+      
+      def template(project_dir, project_name=nil)
+        project_name ||= File.basename(project_dir)
+        context = OpenStruct.new(:project_name => project_name).send(:binding)
+        
+        #
+        # Copy template files into place
+        #
+        
+        Dir.glob("#{source_dir}/**/*").each do |source|
+          if File.directory?(source)
+            next
+          end
+
+          path = source[(source_dir.length + 1)..-1]
+          path = path.sub('project_name', project_name).sub(/^_/, '.')
+          target = File.join(project_dir, path)
+
+          log :create, path
+
+          target_dir = File.dirname(target)
+          unless File.exists?(target_dir)
+            FileUtils.mkdir_p(target_dir)
+          end
+
+          File.open(target, 'w') do |io|
+            erb = ERB.new(File.read(source), nil, '<>')
+            erb.filename = source
+            io << erb.result(context)
+          end
+        end
+
+        # Link up scripts into vbox
+        source = File.join(project_dir, 'scripts')
+        target = File.join(project_dir, 'vbox/scripts')
+        FileUtils.ln_s source, target
+      end
+    end
+  end
+end
+      

data/lib/linecook/commands/package.rb

@@ -0,0 +1,39 @@
+require 'linecook/commands/command'
+require 'linecook/cookbook'
+require 'linecook/recipe'
+require 'yaml'
+
+module Linecook
+  module Commands
+    
+    # ::desc generates a package
+    #
+    # Generates a package.
+    #
+    class Package < Command
+      config :cookbook_dir, '.', :short => :d       # the cookbook directory
+      config :force, false, :short => :f, &c.flag   # force creation
+      
+      def process(source, target=nil)
+        target ||= default_target(source)
+        
+        if File.exists?(target)
+          if force
+            FileUtils.rm_r(target)
+          else
+            raise "already exists: #{target}"
+          end
+        end
+        
+        log :create, File.basename(target)
+        
+        env = Linecook::Cookbook.init(cookbook_dir).env(source)
+        Linecook::Recipe.build(env).export(target)
+      end
+      
+      def default_target(source)
+        source.chomp(File.extname(source))
+      end
+    end
+  end
+end

data/lib/linecook/commands/vbox.rb

@@ -0,0 +1,85 @@
+module Linecook
+  module Commands
+    
+    # Linecook::Commands::Start::desc start the vm
+    class Start < Command
+      config :type, 'headless'
+      
+      def process(vmname='vbox')
+        unless `VBoxManage -q list runningvms`.include?(VMNAME)
+          sh "VBoxManage -q startvm #{vmname} --type #{type}"
+        end
+      end
+    end
+    
+    # Linecook::Commands::Stop::desc stop the vm
+    class Stop < Command
+      def process(vmname='vbox')
+        if `VBoxManage -q list runningvms`.include?(vmname)
+          sh "VBoxManage -q controlvm #{vmname} poweroff"
+        end
+      end
+    end
+    
+    # Linecook::Commands::Reset::desc reset vm to a snapshot
+    class Reset < Command
+      
+      config :type, 'headless'
+      config :snapshot, 'BASE'
+      
+      def process(vmname='vbox')
+        if `VBoxManage -q list runningvms`.include?(vmname)
+          sh "VBoxManage -q controlvm #{vmname} poweroff"
+        end
+
+        sh "VBoxManage -q snapshot #{vmname} restore #{snapshot.upcase}"
+        sh "VBoxManage -q startvm #{vmname} --type #{type}"
+      end
+    end
+    
+    # Linecook::Commands::Snapshot::desc take a snapshop
+    class Snapshot < Command
+      def process(snapshot, vmname='vbox')
+        `VBoxManage -q snapshot #{vmname} delete #{snapshot.upcase} > /dev/null`
+        sh "VBoxManage -q snapshot #{vmname} take #{snapshot.upcase}"
+      end
+    end
+    
+    # Linecook::Commands::State::desc print the vm state
+    class State < Command
+      def process(vmname='vbox')
+        if `VBoxManage -q list runningvms`.include?(vmname)
+          puts "running"
+        else
+          puts "stopped"
+        end
+      end
+    end
+    
+    # Linecook::Commands::Ssh::desc ssh to vm
+    class Ssh < Command
+      
+      config :port, 2222, &c.integer
+      config :user, 'vbox'
+      config :keypath, File.expand_path('../../../../vbox/ssh/id_rsa', __FILE__)
+      
+      def process(cmd=nil)
+        # To prevent ssh errors, protect the private key
+        FileUtils.chmod(0600, keypath)
+
+        # Patterned after vagrant/ssh.rb (circa 0.6.6)
+        platform = RUBY_PLATFORM.to_s.downcase
+        ssh = "ssh -p #{port} -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i #{keypath} #{user}@localhost #{cmd}"
+
+        # Some hackery going on here. On Mac OS X Leopard (10.5), exec fails
+        # (GH-51). As a workaround, we fork and wait. On all other platforms, we
+        # simply exec.
+
+        pid = nil
+        pid = fork if platform.include?("darwin9") || platform.include?("darwin8")
+        Kernel.exec(ssh)  if pid.nil?
+        Process.wait(pid) if pid
+      end
+    end
+  end
+end

data/lib/linecook/commands.rb

@@ -0,0 +1,6 @@
+require 'linecook/commands/init'
+require 'linecook/commands/helper'
+require 'linecook/commands/helpers'
+require 'linecook/commands/package'
+require 'linecook/commands/env'
+require 'linecook/commands/vbox'