Class: VMC::Cli::Runner

Inherits:

Object

• Object
• VMC::Cli::Runner

Defined in:

lib/cli/usage.rb,
lib/cli/runner.rb

Instance Attribute Summary

• #action ⇒ Object readonly

  Returns the value of attribute action.

• #args ⇒ Object readonly

  Returns the value of attribute args.

• #namespace ⇒ Object readonly

  Returns the value of attribute namespace.

• #options ⇒ Object readonly

  Returns the value of attribute options.

Class Method Summary

• .run(args) ⇒ Object

Instance Method Summary

• #basic_usage ⇒ Object
• #check_instances_delta! ⇒ Object
• #command_usage ⇒ Object
• #convert_options! ⇒ Object
• #display_help ⇒ Object
• #display_usage ⇒ Object
• #initialize(args = []) ⇒ Runner constructor

  A new instance of Runner.

• #parse_command! ⇒ Object
• #parse_options! ⇒ Object

  Collect all the available options for all commands Some duplicates exists to capture all scenarios.

• #process_aliases! ⇒ Object
• #run ⇒ Object
• #set_cmd(namespace, action, args_range = 0) ⇒ Object
• #usage(msg = nil) ⇒ Object
• #usage_error(msg = nil) ⇒ Object

Constructor Details

#initialize(args = []) ⇒ Runner

Returns a new instance of Runner.

# File 'lib/cli/runner.rb', line 17

def initialize(args=[])
  @args = args
  @options = { :colorize => true }
  @exit_status = true
end

Instance Attribute Details

#action ⇒ Object (readonly)

Returns the value of attribute action.

# File 'lib/cli/runner.rb', line 9

def action
  @action
end

#args ⇒ Object (readonly)

Returns the value of attribute args.

# File 'lib/cli/runner.rb', line 10

def args
  @args
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.

# File 'lib/cli/runner.rb', line 8

def namespace
  @namespace
end

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/cli/runner.rb', line 11

def options
  @options
end

Class Method Details

.run(args) ⇒ Object

# File 'lib/cli/runner.rb', line 13

def self.run(args)
  new(args).run
end

Instance Method Details

#basic_usage ⇒ Object

# File 'lib/cli/usage.rb', line 3

def basic_usage
  "Usage: udn [options] command [<args>] [command_options]\n" +
  "Try 'udn help [command]' or 'udn help options' for more information."
end

#check_instances_delta! ⇒ Object

# File 'lib/cli/runner.rb', line 127

def check_instances_delta!
  return unless @args
  instance_args = @args.select { |arg| /^[-]\d+$/ =~ arg } || []
  @args.delete_if { |arg| instance_args.include? arg}
  instance_args
end

#command_usage ⇒ Object

# File 'lib/cli/usage.rb', line 20

def command_usage
  <<-USAGE

#{basic_usage}

Currently available udn commands are:

Getting Started
  target [url]                                 Reports current target or sets a new target
  login  [email] [--email, --passwd]           Login
  info                                         System and account information

Applications
  apps                                         List deployed applications

Application Creation
  push [appname]                               Create, push, map, and start a new application
  push [appname] --path                        Push application from specified path
  push [appname] --url                         Set the url for the application
  push [appname] --instances <N>               Set the expected number <N> of instances
  push [appname] --mem M                       Set the memory reservation for the application
  push [appname] --runtime RUNTIME             Set the runtime to use for the application
  push [appname] --framework Framework         Set the framework to use for the application
  push [appname] --debug [MODE]                Push application and start in a debug mode
  push [appname] --no-start                    Do not auto-start the application

Application Operations
  start <appname> [--debug [MODE]]             Start the application
  stop  <appname>                              Stop the application
  restart <appname> [--debug [MODE]]           Restart the application
  delete <appname>                             Delete the application

Application Updates
  update <appname> [--path,--debug [MODE]]     Update the application bits
  mem <appname> [memsize]                      Update the memory reservation for an application
  map <appname> <url>                          Register the application to the url
  unmap <appname> <url>                        Unregister the application from the url
  instances <appname> <num|delta>              Scale the application instances up or down

Application Information
  crashes <appname>                            List recent application crashes
  crashlogs <appname>                          Display log information for crashed applications
  logs <appname> [--all]                       Display log information for the application
  files <appname> [path] [--all]               Display directory listing or file download for [path]
  stats <appname>                              Display resource usage for the application
  instances <appname>                          List application instances

Application Environment
  env <appname>                                List application environment variables
  env-add <appname> <variable[=]value>         Add an environment variable to an application
  env-del <appname> <variable>                 Delete an environment variable to an application

Services
  services                                     Lists of services available and provisioned
  create-service <service> [--name,--bind]     Create a provisioned service
  create-service <service> <name>              Create a provisioned service and assign it <name>
  create-service <service> <name> <app>        Create a provisioned service and assign it <name>, and bind to <app>
  create-service <service> <name> <app> <plan> Create a provisioned service on specified plan and assign it <name>, and bind to <app>
  delete-service [servicename]                 Delete a provisioned service
  bind-service <servicename> <appname>         Bind a service to an application
  unbind-service <servicename> <appname>       Unbind service from the application
  clone-services <src-app> <dest-app>          Clone service bindings from <src-app> application to <dest-app>
  tunnel <servicename> [--port]                Create a local tunnel to a service
  tunnel <servicename> <clientcmd>             Create a local tunnel to a service and start a local client
  register-service <type>                      Register a cloudn service and assign it <type> (e.g. Cloudn RDB)
  register-service <type> <credential>         Register a cloudn service and assign it <type> with <credentials>

Administration
  user                                         Display user account information
  passwd                                       Change the password for the current user
  logout                                       Logs current user out of the target system
  add-user [--email, --passwd]                 Register a new user (requires admin privileges)
  delete-user <user>                           Delete a user and all apps and services (requires admin privileges)

System
  runtimes                                     Display the supported runtimes of the target system
  frameworks                                   Display the recognized frameworks of the target system

Micro Cloud Foundry
  micro status                                 Display Micro Cloud Foundry VM status
  micro offline                                Configure Micro Cloud Foundry VM for offline mode
  micro online                                 Configure Micro Cloud Foundry VM for online mode
    [--vmx file]                               Path to micro.vmx
    [--vmrun executable]                       Path to vmrun executable
    [--password cleartext]                     Cleartext password for guest VM vcap user
    [--save]                                   Save cleartext password in ~/.udn_micro

Misc
  aliases                                      List aliases
  alias <alias[=]command>                      Create an alias for a command
  unalias <alias>                              Remove an alias
  targets                                      List known targets and associated authorization tokens

Help
  help [command]                               Get general help or help on a specific command
  help options                                 Get help on available options

Timeout
  * --timeout timeout                          Set the timeout seconds for any requests

USAGE

end

#convert_options! ⇒ Object

# File 'lib/cli/runner.rb', line 139

def convert_options!
  # make sure certain options are valid and in correct form.
  @options[:instances] = Integer(@options[:instances]) if @options[:instances]
end

#display_help ⇒ Object

# File 'lib/cli/runner.rb', line 134

def display_help
  puts command_usage
  exit
end

#display_usage ⇒ Object

# File 'lib/cli/usage.rb', line 8

def display_usage
  if @usage
    say @usage_error if @usage_error
    say "Usage: #{@usage}"
    return
  elsif @verb_usage
    say @verb_usage
    return
  end
  say command_usage
end

#parse_command! ⇒ Object

# File 'lib/cli/runner.rb', line 163

def parse_command!
  # just return if already set, happends with -v, -h
  return if @namespace && @action

  verb = @args.shift
  case verb

  when 'version'
    usage('udn version')
    set_cmd(:misc, :version)

  when 'target'
    usage('udn target [url] [--url]')
    if @args.size == 1
      set_cmd(:misc, :set_target, 1)
    else
      set_cmd(:misc, :target)
    end

  when 'targets'
    usage('udn targets')
    set_cmd(:misc, :targets)

  when 'tokens'
    usage('udn tokens')
    set_cmd(:misc, :tokens)

  when 'info'
    usage('udn info')
    set_cmd(:misc, :info)

  when 'runtimes'
    usage('udn runtimes')
    set_cmd(:misc, :runtimes)

  when 'frameworks'
    usage('udn frameworks')
    set_cmd(:misc, :frameworks)

  when 'user'
    usage('udn user')
    set_cmd(:user, :info)

  when 'login'
    usage('udn login [email] [--email EMAIL] [--passwd PASS]')
    if @args.size == 1
      set_cmd(:user, :login, 1)
    else
      set_cmd(:user, :login)
    end

  when 'logout'
    usage('udn logout')
    set_cmd(:user, :logout)

  when 'passwd'
    usage('udn passwd')
    if @args.size == 1
      set_cmd(:user, :change_password, 1)
    else
      set_cmd(:user, :change_password)
    end

  when 'add-user', 'add_user', 'create_user', 'create-user', 'register'
    usage('udn add-user [user] [--email EMAIL] [--passwd PASS]')
    if @args.size == 1
      set_cmd(:admin, :add_user, 1)
    else
      set_cmd(:admin, :add_user)
    end

  when 'delete-user', 'delete_user', 'unregister'
    usage('udn delete-user <user>')
    set_cmd(:admin, :delete_user, 1)

  when 'users'
    usage('udn users')
    set_cmd(:admin, :users)

  when 'apps'
    usage('udn apps')
    set_cmd(:apps, :apps)

  when 'list'
    usage('udn list')
    set_cmd(:apps, :list)

  when 'start'
    usage('udn start <appname>')
    set_cmd(:apps, :start, @args.size == 1 ? 1 : 0)

  when 'stop'
    usage('udn stop <appname>')
    set_cmd(:apps, :stop, @args.size == 1 ? 1 : 0)

  when 'restart'
    usage('udn restart <appname>')
    set_cmd(:apps, :restart, @args.size == 1 ? 1 : 0)

  when 'mem'
    usage('udn mem <appname> [memsize]')
    if @args.size == 2
      set_cmd(:apps, :mem, 2)
    else
      set_cmd(:apps, :mem, 1)
    end

  when 'stats'
    usage('udn stats <appname>')
    set_cmd(:apps, :stats, @args.size == 1 ? 1 : 0)

  when 'map'
    usage('udn map <appname> <url>')
    set_cmd(:apps, :map, 2)

  when 'unmap'
    usage('udn unmap <appname> <url>')
    set_cmd(:apps, :unmap, 2)

  when 'delete'
    usage('udn delete <appname>')
    if @options[:all] && @args.size == 0
      set_cmd(:apps, :delete)
    else
      set_cmd(:apps, :delete, 1)
    end

  when 'files'
    usage('udn files <appname> [path] [--instance N] [--all] [--prefix]')
    if @args.size == 1
      set_cmd(:apps, :files, 1)
    else
      set_cmd(:apps, :files, 2)
    end

  when 'logs'
    usage('udn logs <appname> [--instance N] [--all] [--prefix]')
    set_cmd(:apps, :logs, 1)

  when 'instances', 'scale'
    if @args.size > 1
      usage('udn instances <appname> <num|delta>')
      set_cmd(:apps, :instances, 2)
    else
      usage('udn instances <appname>')
      set_cmd(:apps, :instances, 1)
    end

  when 'crashes'
    usage('udn crashes <appname>')
    set_cmd(:apps, :crashes, 1)

  when 'crashlogs'
    usage('udn crashlogs <appname>')
    set_cmd(:apps, :crashlogs, 1)

  when 'push'
    usage('udn push [appname] [--path PATH] [--url URL] [--instances N] [--mem] [--runtime RUNTIME] [--no-start]')
    if @args.size == 1
      set_cmd(:apps, :push, 1)
    else
      set_cmd(:apps, :push, 0)
    end

  when 'update'
    usage('udn update <appname> [--path PATH]')
    set_cmd(:apps, :update, @args.size == 1 ? 1 : 0)

  when 'services'
    usage('udn services')
    set_cmd(:services, :services)

  when 'env'
    usage('udn env <appname>')
    set_cmd(:apps, :environment, 1)

  when 'env-add'
    usage('udn env-add <appname> <variable[=]value>')
    if @args.size == 2
      set_cmd(:apps, :environment_add, 2)
    elsif @args.size == 3
      set_cmd(:apps, :environment_add, 3)
    end

  when 'env-del'
    usage('udn env-del <appname> <variable>')
    set_cmd(:apps, :environment_del, 2)

  when 'create-service', 'create_service'
    usage('udn create-service [service] [servicename] [plan] [appname] [--name servicename] [--bind appname] [--plan plan]')
    set_cmd(:services, :create_service) if @args.size == 0
    set_cmd(:services, :create_service, 1) if @args.size == 1
    set_cmd(:services, :create_service, 2) if @args.size == 2
    set_cmd(:services, :create_service, 3) if @args.size == 3
    set_cmd(:services, :create_service, 4) if @args.size == 4

  when 'register-service', 'register_service'
    usage( 'register-service [type] [instanceid] [--MasterUsername masterusername] [--MasterUserPassword masteruserpassword] [--DBName DBName]')
    set_cmd(:services, :register_service) if @args.size == 0
    set_cmd(:services, :register_service, 1) if @args.size == 1
    set_cmd(:services, :register_service, 2) if @args.size == 2

  when 'delete-service', 'delete_service'
    usage('udn delete-service <service>')
    if @args.size == 1
      set_cmd(:services, :delete_service, 1)
    else
      set_cmd(:services, :delete_service)
    end

  when 'bind-service', 'bind_service'
    usage('udn bind-service <servicename> <appname>')
    set_cmd(:services, :bind_service, 2)

  when 'unbind-service', 'unbind_service'
    usage('udn unbind-service <servicename> <appname>')
    set_cmd(:services, :unbind_service, 2)

  when 'clone-services'
    usage('udn clone-services <src-app> <dest-app>')
    set_cmd(:services, :clone_services, 2)

  when 'aliases'
    usage('udn aliases')
    set_cmd(:misc, :aliases)

  when 'alias'
    usage('udn alias <alias[=]command>')
    if @args.size == 1
      set_cmd(:misc, :alias, 1)
    elsif @args.size == 2
      set_cmd(:misc, :alias, 2)
    end

  when 'unalias'
    usage('udn unalias <alias>')
    set_cmd(:misc, :unalias, 1)

  when 'tunnel'
    usage('udn tunnel [servicename] [clientcmd] [--port port]')
    set_cmd(:services, :tunnel, 0) if @args.size == 0
    set_cmd(:services, :tunnel, 1) if @args.size == 1
    set_cmd(:services, :tunnel, 2) if @args.size == 2

  when 'rails-console'
    usage('udn rails-console <appname>')
    set_cmd(:apps, :console, 1)

  when 'micro'
    usage('udn micro <online|offline|status> [--password password] [--save] [--vmx file] [--vmrun executable]')
    if %w[online offline status].include?(@args[0])
        set_cmd(:micro, @args[0].to_sym, 1)
    end

  when 'help'
    display_help if @args.size == 0
    @help_only = true
    parse_command!

  when 'usage'
    display basic_usage
    exit(true)

  when 'options'
    # Simulate --options
    @args = @args.unshift('--options')
    parse_options!

  when 'manifest'
    usage('udn manifest')
    set_cmd(:manifest, :edit)

  when 'extend-manifest'
    usage('udn extend-manifest')
    set_cmd(:manifest, :extend, 1)

  else
    if verb
      display "udn: Unknown command [#{verb}]"
      display basic_usage
      exit(false)
    end
  end
end

#parse_options! ⇒ Object

Collect all the available options for all commands Some duplicates exists to capture all scenarios

# File 'lib/cli/runner.rb', line 25

def parse_options!
  opts_parser = OptionParser.new do |opts|
    opts.banner = "\nAvailable options:\n\n"

    opts.on('--email EMAIL')     { |email| @options[:email] = email }
    opts.on('--user EMAIL')      { |email| @options[:email] = email }
    opts.on('--passwd PASS')     { |pass|  @options[:password] = pass }
    opts.on('--pass PASS')       { |pass|  @options[:password] = pass }
    opts.on('--password PASS')   { |pass|  @options[:password] = pass }
    opts.on('--token-file TOKEN_FILE')     { |token_file|  @options[:token_file] = token_file }
    opts.on('--app NAME')        { |name|  @options[:name] = name }
    opts.on('--name NAME')       { |name|  @options[:name] = name }
    opts.on('--plan NAME')       { |name|  @options[:plan] = name }
    opts.on('--bind BIND')       { |bind|  @options[:bind] = bind }
    opts.on('--instance INST')   { |inst|  @options[:instance] = inst }
    opts.on('--instances INST')  { |inst|  @options[:instances] = inst }
    opts.on('--url URL')         { |url|   @options[:url] = url }
    opts.on('--mem MEM')         { |mem|   @options[:mem] = mem }
    opts.on('--path PATH')       { |path|  @options[:path] = path }
    opts.on('--no-start')        {         @options[:nostart] = true }
    opts.on('--nostart')         {         @options[:nostart] = true }
    opts.on('--force')           {         @options[:force] = true }
    opts.on('--all')             {         @options[:all] = true }

    # generic tracing and debugging
    opts.on('-t [TKEY]')         { |tkey|  @options[:trace] = tkey || true }
    opts.on('--trace [TKEY]')    { |tkey|  @options[:trace] = tkey || true }

    # start application in debug mode
    opts.on('-d [MODE]')         { |mode|  @options[:debug] = mode || "run" }
    opts.on('--debug [MODE]')    { |mode|  @options[:debug] = mode || "run" }

    # override manifest file
    opts.on('-m FILE')           { |file|  @options[:manifest] = file }
    opts.on('--manifest FILE')   { |file|  @options[:manifest] = file }

    opts.on('-q', '--quiet')     {         @options[:quiet] = true }

    # micro cloud options
    opts.on('--vmx FILE')        { |file|  @options[:vmx] = file }
    opts.on('--vmrun FILE')      { |file|  @options[:vmrun] = file }
    opts.on('--save')            {         @options[:save] = true }

    # Don't use builtin zip
    opts.on('--no-zip')          {         @options[:nozip] = true }
    opts.on('--nozip')           {         @options[:nozip] = true }

    opts.on('--no-resources')    {         @options[:noresources] = true }
    opts.on('--noresources')     {         @options[:noresources] = true }

    opts.on('--no-color')        {         @options[:colorize] = false }
    opts.on('--verbose')         {         @options[:verbose] = true }

    opts.on('-n','--no-prompt')  {         @options[:noprompts] = true }
    opts.on('--noprompt')        {         @options[:noprompts] = true }
    opts.on('--non-interactive') {         @options[:noprompts] = true }

    opts.on('--prefix')          {         @options[:prefixlogs] = true }
    opts.on('--prefix-logs')     {         @options[:prefixlogs] = true }
    opts.on('--prefixlogs')      {         @options[:prefixlogs] = true }

    opts.on('--json')            {         @options[:json] = true }

    opts.on('-v', '--version')   {         set_cmd(:misc, :version) }
    opts.on('-h', '--help')      {         puts "#{command_usage}\n"; exit }

    opts.on('--port PORT')       { |port|  @options[:port] = port }

    opts.on('--runtime RUNTIME') { |rt|    @options[:runtime] = rt }

    opts.on('--timeout TIMEOUT') { |t|
      if t.to_i > 0
        @options[:timeout] = t.to_i
        puts "Set timeout: #{t} sec"
      else
        @options[:timeout] = 120
      end
    }
    opts.on('-f FRAMEWORK', '--framework FRAMEWORK') { |fw| @options[:framework] = fw }

    # deprecated
    opts.on('--exec EXEC')       { |exec|  @options[:exec] = exec }
    opts.on('--noframework')     {         @options[:noframework] = true }
    opts.on('--canary')          {         @options[:canary] = true }

    # Proxying for another user, requires admin privileges
    opts.on('-u PROXY')          { |proxy| @options[:proxy] = proxy }

    opts.on_tail('--options')    {          puts "#{opts}\n"; exit }

    # For Cloudn RDB
    opts.on('--DBName DBNAME')           { |exec|  @options[:DBName] = exec }
    opts.on('--MasterUsername USER')     { |exec|  @options[:MasterUsername] = exec }
    opts.on('--MasterUserPassword PASS') { |exec|  @options[:MasterUserPassword] = exec }
  end
  instances_delta_arg = check_instances_delta!
  @args = opts_parser.parse!(@args)
  @args.concat instances_delta_arg
  convert_options!
  self
end

#process_aliases! ⇒ Object

# File 'lib/cli/runner.rb', line 448

def process_aliases!
  return if @args.empty?
  aliases = VMC::Cli::Config.aliases
  aliases.each_pair do |k,v|
    if @args[0] == k
      display "[#{@args[0]} aliased to #{aliases.invert[key]}]" if @options[:verbose]
      @args[0] = v
      break;
    end
  end
end

#run ⇒ Object

# File 'lib/cli/runner.rb', line 470

def run

  trap('TERM') { print "\nTerminated\n"; exit(false)}

  parse_options!

  @options[:colorize] = false unless STDOUT.tty?

  VMC::Cli::Config.colorize   = @options.delete(:colorize)
  VMC::Cli::Config.nozip      = @options.delete(:nozip)
  VMC::Cli::Config.trace      = @options.delete(:trace)
  VMC::Cli::Config.output   ||= STDOUT unless @options[:quiet]

  process_aliases!
  parse_command!

  if @namespace && @action
    cmd = VMC::Cli::Command.const_get(@namespace.to_s.capitalize)
    cmd.new(@options).send(@action, *@args.collect(&:dup))
  elsif @help_only || @usage
    display_usage
  else
    display basic_usage
    exit(false)
  end

rescue OptionParser::InvalidOption => e
  puts(e.message.red)
  puts("\n")
  puts(basic_usage)
  @exit_status = false
rescue OptionParser::AmbiguousOption => e
  puts(e.message.red)
  puts("\n")
  puts(basic_usage)
  @exit_status = false
rescue VMC::Client::AuthError => e
  if VMC::Cli::Config.auth_token.nil?
    puts "Login Required".red
  else
    puts "Not Authorized".red
  end
  @exit_status = false
rescue VMC::Client::TargetError, VMC::Client::NotFound, VMC::Client::BadTarget  => e
  puts e.message.red
  @exit_status = false
rescue VMC::Client::HTTPException => e
  puts e.message.red
  @exit_status = false
rescue VMC::Cli::GracefulExit => e
  # Redirected commands end up generating this exception (kind of goto)
rescue VMC::Cli::CliExit => e
  puts e.message.red
  @exit_status = false
rescue VMC::Cli::CliError => e
  say("Error #{e.error_code}: #{e.message}".red)
  @exit_status = false
rescue SystemExit => e
  @exit_status = e.success?
rescue SyntaxError => e
  puts e.message.red
  puts e.backtrace
  @exit_status = false
rescue Interrupt => e
  say("\nInterrupted".red)
  @exit_status = false
rescue Exception => e
  puts e.message.red
  puts e.backtrace
  @exit_status = false
ensure
  say("\n")
  @exit_status == true if @exit_status.nil?
  if @options[:verbose]
    if @exit_status
      puts "[#{@namespace}:#{@action}] SUCCEEDED".green
    else
      puts "[#{@namespace}:#{@action}] FAILED".red
    end
    say("\n")
  end
  exit(@exit_status)
end

#set_cmd(namespace, action, args_range = 0) ⇒ Object

# File 'lib/cli/runner.rb', line 144

def set_cmd(namespace, action, args_range=0)
  return if @help_only
  unless args_range == "*" || args_range.is_a?(Range)
    args_range = (args_range.to_i..args_range.to_i)
  end

  if args_range == "*" || args_range.include?(@args.size)
    @namespace = namespace
    @action    = action
  else
    @exit_status = false
    if @args.size > args_range.last
      usage_error("Too many arguments for [#{action}]: %s" % [ @args[args_range.last..-1].map{|a| "'#{a}'"}.join(', ') ])
    else
      usage_error("Not enough arguments for [#{action}]")
    end
  end
end

#usage(msg = nil) ⇒ Object

# File 'lib/cli/runner.rb', line 460

def usage(msg = nil)
  @usage = msg if msg
  @usage
end

#usage_error(msg = nil) ⇒ Object

# File 'lib/cli/runner.rb', line 465

def usage_error(msg = nil)
  @usage_error = msg if msg
  @usage_error
end