befog 0.3.0 → 0.4.0

data/bin/befog

@@ -1,15 +1,16 @@
 #!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'befog' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-require "rubygems"
-require "bundler/setup"
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-# resolve bin path, ignoring symlinks
-require "pathname"
-bin_file = Pathname.new(__FILE__).realpath
+require 'rubygems'
+require 'bundler/setup'
 
-# add self to libpath
-$:.unshift File.expand_path("../../lib", bin_file)
-
-require "befog"
-
-Befog::CLI.run(*ARGV)
+load Gem.bin_path('befog', 'befog')

data/lib/befog/cli.rb

@@ -5,16 +5,20 @@ require "befog/commands/stop"
 require "befog/commands/run"
 require "befog/commands/list"
 require "befog/commands/configure"
+require "befog/commands/mixins/safely"
 
 module Befog
   
   module CLI
     
     class Error < RuntimeError ; end
-
+    
+    extend Befog::Commands::Mixins::Safely
+    
     COMMANDS = {
       "add" => Befog::Commands::Add,
       "remove" => Befog::Commands::Remove,
+      "rm" => Befog::Commands::Remove,
       "start" => Befog::Commands::Start,
       "stop" => Befog::Commands::Stop,
       "run" => Befog::Commands::Run,
@@ -24,35 +28,39 @@ module Befog
       "config" => Befog::Commands::Configure
     }
     
-    def self.run(subcommand=nil,*args)
-      if command = COMMANDS[subcommand]
-        begin
-          command.run(args)
-          
-        # TODO: use a befog-specific error class to 
-        # differentiate between expected exceptions
-        # (just display the error message) and un-
-        # expected (display the backtrace)
-        rescue Befog::CLI::Error => e
-          $stderr.puts "befog: #{e.message}"
-          exit(-1)
-        rescue => e # uh-oh
-          $stderr.puts "Unexpected error"
-          $stderr.puts "#{e.class}: #{e.message}"
-          $stderr.puts e.backtrace
-          exit(-1)
-        end
-      else
-        if subcommand
-          usage "'#{subcommand}' is not a supported command"
+    def self.parse(arguments)
+      options = {}
+      key = :bank
+      while not arguments.empty?
+        argument = arguments.shift
+        flag, short, long = /^(?:\-(\w)|\-\-(\w+))$/.match(argument).to_a
+        if flag
+          key = (short or long).to_sym
+          options[key] = true
         else
-          usage "No subcommand provided."
+          case options[key]
+          when Array then options[key] << argument
+          when String then options[key] = [ options[key], argument ]
+          when true, nil then options[key] = argument
+          end
         end
       end
+      return options
+    end
+    
+    def self.run(arguments)
+      subcommand = arguments.shift
+      if subcommand && (command = COMMANDS[subcommand])
+        command.run(CLI.parse(arguments))
+      elsif subcommand
+        usage "'#{subcommand}' is not a supported command"
+      else
+        usage
+      end
     end
     
-    def self.usage(message)
-      $stderr.puts "befog: #{message}"
+    def self.usage(message=nil)
+      $stderr.puts "befog: #{message}" if message
       $stderr.puts <<-eos
         
 Usage: befog <subcommand> [<bank>] [<options>]
@@ -66,14 +74,13 @@ Adds 3 servers to the bank "web-servers"
 
 Valid commands:
 
-    configure   Configure a bank of servers
-    config
-    add         Provision new servers for a bank of servers
-    remove      De-provision servers for a bank of servers
-    start       Start a bank of servers
-    stop        Stop (suspend) a bank of servers
-    run         Run a command on each of a bank of servers
-    list,ls     List all servers with optional bank, region, or provider
+    configure, config   Configure a bank of servers
+    add                 Provision new servers for a bank of servers
+    remove, rm          De-provision servers
+    start               Start servers
+    stop                Stop (suspend) servers
+    run                 Run a command on each of a bank of servers
+    list, ls            List servers
     
 You can get more options for any command with --help or -h.
 eos

data/lib/befog/commands/add.rb

@@ -1,8 +1,9 @@
 require "befog/commands/mixins/command"
 require "befog/commands/mixins/configurable"
-require "befog/commands/mixins/bank"
-require "befog/commands/mixins/provider"
+require "befog/commands/mixins/scope"
+require "befog/commands/mixins/safely"
 require "befog/commands/mixins/help"
+require "befog/commands/mixins/traceable"
 
 module Befog
   module Commands
@@ -11,47 +12,80 @@ module Befog
   
       include Mixins::Command
       include Mixins::Configurable
-      include Mixins::Bank
-      include Mixins::Provider
+      include Mixins::Scope
       include Mixins::Help
+      include Mixins::Traceable
+      include Mixins::Safely
   
 
-      command "befog add <bank>",
+      command :name => :add,
+        :usage => "befog add <bank> [<options>]",
         :default_to_help => true
 
       option :count, 
-        :short => "-c COUNT",
-        :long  => "--count COUNT",
+        :short => :c,
         :required => true,
         :description => "The number of machines to provision"
-            
+
+      option :type, 
+        :short => :t,
+        :description => "The type of machines to provision"
+
       def run        
-        count = options[:count].to_i
-        if count <= 0
-          $stderr.puts "Number must be an integer greater than 0."
-          return
-        end
-        servers = []
+        provision_servers(options[:count].to_i)
+      end
+      
+      def provision_servers(count)
+        error("Count must be greater than zero.") unless (count > 0)
+        provisioned = []; threads = []
         count.times do |i|
-          $stdout.puts "Provisioning server #{i+1} for bank '#{options[:bank]}'..."
-          # TODO: Figure out how to give the server a name
-          # TODO: Check for values for all crucial configuration properties
-          servers << compute.servers.create(
-              :tags => {"Name" => options[:bank]}, :region => bank["region"],
-              :flavor_id => bank["type"], :image_id => bank["image"], 
-              :security_group_ids => [options[:group]||"default"],
-              :key_name => bank["keypair"])
-        end
-        $stdout.puts "This may take a few minutes ..."
-        servers.each do |server|
-          server.wait_for { $stdout.puts "Still working ..." ; ready? }
-          self.servers << server.id
+          verbose <<-EOF.gsub(/^\s*/,"")
+            Provision server: 
+              - region: #{region}
+              - type: #{flavor}
+              - image: #{image}
+              - security group: #{security_group}
+              - keypair: #{keypair}
+          EOF
+          threads << Thread.new do
+            safely do
+              unless rehearse?
+                log "Provisioning server #{i+1} for bank '#{bank_name}'..."
+                server = provision_server
+                server.wait_for { ready? }
+                provisioned << server
+                servers << server.id
+              end
+            end
+          end
         end
-        servers.each do |server|
-          $stdout.puts "Server #{server.id} is ready at #{server.dns_name}."
+        unless rehearse?
+          $stdout.print "This may take a few minutes .."
+          sleep 1 while threads.any? { |t| $stdout.print "."; $stdout.flush ; t.alive? } 
+          $stdout.print "\n"
+          provisioned.each do |server|
+            log "Server #{server.id} is ready at #{server.dns_name}."
+          end
+          save
         end
-        save
       end
+      
+      def provision_server
+        compute.servers.create(
+            :tags => {"Name" => generate_server_name},
+            :region => region, :flavor_id => flavor, :image_id => image, 
+            :security_group_ids => security_group, :key_name => keypair)
+      end
+      
+      def generate_server_name
+        "#{bank_name}-#{generate_id}"
+      end
+      
+      def generate_id
+        bank["counter"] ||= 0
+        bank["counter"] += 1
+      end
+
     end
   end
 end

data/lib/befog/commands/configure.rb

@@ -1,7 +1,7 @@
 require "befog/commands/mixins/command"
 require "befog/commands/mixins/configurable"
-require "befog/commands/mixins/provider"
-require "befog/commands/mixins/bank"
+require "befog/commands/mixins/scope"
+require "befog/commands/mixins/safely"
 require "befog/commands/mixins/help"
 
 module Befog
@@ -12,74 +12,61 @@ module Befog
     
       include Mixins::Command
       include Mixins::Configurable
-      include Mixins::Provider
-      include Mixins::Bank
+      include Mixins::Scope
+      include Mixins::Safely
       include Mixins::Help
       
-      command "befog configure [<bank>]",
+      command :name => :configure,
+        :usage => "befog configure [<bank>] [<options>]",
         :default_to_help => true
         
       option :key, 
-        :short => "-k KEY",
-        :long  => "--key KEY",
+        :short => :k,
         :description => "Your account key"
 
       option :secret, 
-        :short => "-s SECRET",
-        :long  => "--secret SECRET",
+        :short => :s,
         :description => "Your account secret"
       
       option :provider,
-        :short => "-q PROVIDER",
-        :long => "--provider PROVIDER",
+        :short => :q,
         :description => "The provider provisioning a bank of servers"
 
       option :region,
-        :short => "-r REGION",
-        :long => "--region REGION",
+        :short => :r,
         :description => "The region (datacenter) where a bank is provisioned"
 
       option :image, 
-        :short => "-i IMAGE",
-        :long  => "--image IMAGE",
+        :short => :i,
         :description => "The image for provisioning pods"
     
       option :keypair, 
-        :short => "-x KEYPAIR",
-        :long  => "--keypair KEYPAIR",
+        :short => :x,
         :description => "The keypair name to use with SSH"
 
       option :group, 
-        :short => "-g GROUP",
-        :long  => "--group GROUP",
+        :short => :g,
         :description => "The security group to use for new instances"
     
       option :type, 
-        :short => "-t TYPE",
-        :long  => "--type TYPE",
+        :short => :t,
         :description => "The number of machines to provision"
 
-      def self.run(args)
-        self.new(args).run
-      end
-      
-      def initialize(arguments)
-        process_arguments(arguments)
-      end
-      
       def run
-        %w( key secret ).each do |key|
-          _key = key.to_sym
-          provider[key] = options[_key] if options[_key]
-        end
-        %w( region image keypair group type ).each do |key|
-          _key = key.to_sym
-          bank[key] = options[_key] if options[_key]
-        end          
-        if options[:bank] and options[:provider]
-          bank["provider"] = options[:provider]
+        safely do
+          %w( key secret ).each do |key|
+            _key = key.to_sym
+            provider[key] = options[_key] if options[_key]
+          end
+          %w( region image keypair group type ).each do |key|
+            _key = key.to_sym
+            bank[key] = options[_key] if options[_key]
+          end          
+          if options[:bank] and options[:provider]
+            bank["provider"] = options[:provider]
+          end
+          save
         end
-        save
       end
     end
   end

data/lib/befog/commands/list.rb

@@ -1,9 +1,9 @@
 require "fog"
 require "befog/commands/mixins/command"
 require "befog/commands/mixins/configurable"
-require "befog/commands/mixins/bank"
-require "befog/commands/mixins/provider"
-require "befog/commands/mixins/server"
+require "befog/commands/mixins/scope"
+require "befog/commands/mixins/safely"
+require "befog/commands/mixins/selectable"
 require "befog/commands/mixins/help"
 
 module Befog
@@ -13,65 +13,27 @@ module Befog
   
       include Mixins::Command
       include Mixins::Configurable
-      include Mixins::Bank
-      include Mixins::Provider
-      include Mixins::Server
+      include Mixins::Scope
+      include Mixins::Safely
+      include Mixins::Selectable
       include Mixins::Help
 
-      command "befog list [<bank>]",
-        :default_to_help => false
+      command :name => :list,
+        :usage => "befog list [<bank>] <options>",
+        :default_to_help => true
 
-      option :provider,
-        :short => "-q PROVIDER",
-        :long => "--provider PROVIDER",
-        :description => "The provider provisioning a bank of servers"
+  
+      option :all,
+        :short => :a,
+        :description => "Deprovision all selected servers"
 
 
       def run
-        if options[:bank]
-          list_bank(options[:bank])
-        elsif options[:provider]
-          list_provider(options[:provider])
-        else
-          list_all
-        end
-      end
-      
-      def list_all
-        $stdout.puts "All Servers"
-        banks.keys.select do |name|
-          list_bank(name)
-        end
-      end
-      
-      def list_provider(provider,indent="")
-        $stdout.puts "#{indent}- Provider: #{provider}"
-        indent += "  "
-        banks.select do |name,b|
-          if b["configuration"] and b["configuration"]["provider"] == provider
-            list_bank(name,indent)
-          end
+        run_for_selected do |id|
+          server = compute.servers.get(id)
+          log "%-15s %-15s %-15s %-45s %-10s" % [id,server.flavor_id,server.tags["Name"],(server.dns_name||"-"),server.state]
         end
       end
-      
-      def list_bank(name, indent="")
-        out = []
-        out << "#{indent}- Bank: #{name}"
-        indent += "  "
-        configuration = banks[name]["configuration"]
-        out += %w( provider region image keypair type ).reduce([]) do |rval,key|        
-          rval << "#{key}: #{configuration[key]}" unless configuration[key].nil?
-          rval
-        end
-        out << "instances:"
-        banks[name]["servers"].each do |id|
-          c = compute(configuration["provider"])
-          s = c.servers.get(id)
-          out << "- #{s.flavor_id} #{s.public_ip_address} #{s.state}"
-        end
-        $stdout.puts out.join("\n#{indent}")
-      end
-
     end
   end
-end
+end

data/lib/befog/commands/mixins/command.rb

@@ -1,4 +1,4 @@
-require "optparse"
+require 'ostruct'
 
 module Befog
   module Commands
@@ -10,8 +10,8 @@ module Befog
             
             class << self 
               
-              def command(name,descriptor)
-                @command = (Struct.new(:name,:descriptor)).new(name,descriptor)
+              def command(descriptor=nil)
+                descriptor ? (@command = OpenStruct.new(descriptor)) : @command
               end
               
               def option(name,descriptor)
@@ -20,43 +20,8 @@ module Befog
               
               def options ; @options||=[] ; end
 
-              # TODO: Support multi-line descriptions?
-              def process_arguments(arguments)
-                results = {}; required = [] 
-                parser = OptionParser.new do |parser|
-                  parser.banner = "Usage: #{@command.name} [options]"
-                  options.each do |name,descriptor|
-                    if descriptor[:help]
-                      parser.on_tail(*descriptor.values_at(:short,:long,:description)) do |value|
-                        $stdout.puts parser
-                        exit(0)
-                      end
-                    else
-                      results[name] = descriptor[:default] if descriptor[:default]
-                      required << name if descriptor[:required]
-                      parser.on(*descriptor.values_at(:short,:long,:description)) do |value|
-                        results[name] = value
-                      end
-                    end
-                  end
-                end
-                if @command.descriptor[:default_to_help] and arguments.empty?
-                  $stdout.puts parser
-                  exit(0)
-                end
-                parser.parse!(arguments)
-                required.each do |name|
-                  unless results[name]
-                    $stderr.puts "Missing required option '#{name}'"
-                    $stderr.puts parser
-                    exit(-1)
-                  end
-                end
-                results
-              end
-              
-              def run(arguments)
-                new(arguments).run
+              def run(options)
+                new(options).run
               end
 
             end
@@ -66,12 +31,54 @@ module Befog
         
         attr_reader :options
         
-        def initialize(arguments)
-          process_arguments(arguments)
+        def initialize(_options)
+          safely do
+            @options = process_options(_options)
+          end
         end
-
-        def process_arguments(arguments)
-          @options = self.class.process_arguments(arguments)
+        
+        def command
+          self.class.command
+        end
+        
+        # TODO: Support multi-line descriptions?
+        def process_options(_options)
+          if (command.default_to_help and _options.empty?) or _options[:help]
+            usage
+            exit(0)
+          end
+          self.class.options.each do |name,descriptor|
+            short, required, default, type = descriptor.values_at(:short,:required,:default,:type)
+            _options[name] ||= (_options[short]||default)
+            _options.delete(short)
+            if required and not _options[name]
+              error("Missing required option --#{name}")
+            end
+          end
+          # TODO: add type conversion
+          return _options
+        end
+        
+        def usage
+          $stderr.puts command.usage
+          usage = []
+          self.class.options.each do |name,descriptor|
+            short, required, default, description = descriptor.values_at(:short,:required,:default,:description)
+            required = (required ? "(required) " : "")
+            default = (default ? "(default: #{default}) " : "")
+            usage << "\t%-3s %-20s\t%-40s" % ["-#{short},", "--#{name} #{name.to_s.upcase}", "#{description} #{required}#{default}"]
+          end
+          $stderr.puts *(usage.sort)
+        end
+        
+        
+        
+        def error(message)
+          raise CLI::Error.new(message)
+        end
+        
+        def log(message)
+          $stdout.puts(message)
         end
       end
     end

data/lib/befog/commands/mixins/configurable.rb

@@ -8,16 +8,12 @@ module Befog
           target.module_eval do
 
             option :path, 
-              :short => "-p PATH",
-              :long => "--path PATH",
-              :default => "~/.befog",
-              :description => "Path to the configuration file you want to use (defaults to '~/.befog')"
+              :short => :p, :default => "~/.befog",
+              :description => "Path to the configuration file"
 
             option :name,
-              :short => "-n NAME",
-              :long => "--name NAME",
-              :default => "default",
-              :description => "The name of this configuration (defaults to 'default')"
+              :short => :n, :default => "default",
+              :description => "The name of this configuration"
 
           end
         end
@@ -31,7 +27,11 @@ module Befog
         end
         
         def configuration
-          _configuration[options[:name]] ||= {}
+          _configuration[configuration_name] ||= {}
+        end
+        
+        def configuration_name
+          options[:name]
         end
 
         def save

data/lib/befog/commands/mixins/help.rb

@@ -5,10 +5,8 @@ module Befog
         def self.included(target)
           target.module_eval do
             option :help,
-              :short => "-h",
-              :long => "--help",
-              :description => "Show this message",
-              :help => true
+              :short => :h,
+              :description => "Show this message"
           end
         end
         

data/lib/befog/commands/mixins/safely.rb

@@ -0,0 +1,28 @@
+module Befog
+  module Commands
+    module Mixins
+      module Safely
+        
+        def safely
+          begin
+            yield
+          rescue Befog::CLI::Error => e
+            $stderr.puts "befog #{command.name}: #{e.message}"
+            exit(-1)
+          rescue => e # uh-oh
+            $stderr.puts "Unexpected error"
+            $stderr.puts "#{e.class}: #{e.message}"
+            $stderr.puts e.backtrace
+            exit(-1)
+          end
+        end
+
+
+      end
+    end
+  end
+end
+            
+
+
+