rhc 1.9.6 → 1.10.7

data/lib/rhc/commands/authorization.rb

@@ -12,7 +12,8 @@ module RHC::Commands
       remembering what is available.
       DESC
     alias_action 'authorizations', :root_command => true
-    def run
+    default_action :list
+    def list
       rest_client.authorizations.each{ |auth| paragraph{ display_authorization(auth, token_for_user) } } or info "No authorizations"
 
       0

data/lib/rhc/commands/base.rb

@@ -147,7 +147,14 @@ class RHC::Commands::Base
 
     def self.default_action(action)
       options[:default] = action unless action == :help
-      define_method(:run) { |*args| send(action, *args) }
+      name = self.object_name
+      raise InvalidCommand, "object_name must be set" if name.empty?
+
+      RHC::Commands.add((@options || {}).merge({
+        :name => name,
+        :class => self,
+        :method => options[:default]
+      }));
     end
 
     private

data/lib/rhc/commands/cartridge.rb

@@ -44,7 +44,9 @@ module RHC::Commands
       if options.verbose
         carts.each do |c|
           paragraph do
-            name = c.display_name != c.name && "#{color(c.display_name, :cyan)} [#{c.name}]" || c.name
+            name = c.name
+            name += '*' if c.usage_rate?
+            name = c.display_name != c.name && "#{color(c.display_name, :cyan)} [#{name}]" || name
             tags = c.tags - RHC::Rest::Cartridge::HIDDEN_TAGS
             say header([name, "(#{c.only_in_existing? ? 'addon' : 'web'})"])
             say c.description
@@ -85,9 +87,8 @@ module RHC::Commands
       success "Success"
 
       paragraph{ display_cart(rest_cartridge) }
-
-      results{ rest_cartridge.messages.each { |msg| success msg } }
-
+      paragraph{ rest_cartridge.messages.each { |msg| success msg } }
+      
       0
     end
 
@@ -122,6 +123,8 @@ module RHC::Commands
       rest_cartridge.destroy
       success "removed"
 
+      paragraph{ rest_cartridge.messages.each { |msg| success msg } }
+
       0
     end
 
@@ -182,14 +185,30 @@ module RHC::Commands
       0
     end
 
-    summary "Set the scaling range of a cartridge"
-    syntax "<cartridge> [--namespace NAME] [--app NAME] [--min min] [--max max]"
-    argument :cart_type, "The name of the cartridge you are reloading", ["-c", "--cartridge cartridge"]
+    summary "Set the scale range for a cartridge"
+    description <<-DESC
+      Each cartridge capable of scaling may have a minimum and a maximum set, although within that range 
+      each type of cartridge may make decisions to autoscale.  Web cartridges will scale based on incoming
+      request traffic - see https://www.openshift.com/developers/scaling for more information. Non web
+      cartridges such as databases may require specific increments of scaling (1, 3, 5) in order to 
+      properly function.  Please consult the cartridge documentation for more on specifics of scaling.
+
+      Set both values the same to guarantee a scale value.  You may pecify both values with the argument
+      'multiplier' or use '--min' and '--max' independently.
+
+      Scaling may take several minutes or more if the server must provision multiple gears. Your operation
+      will continue in the background if your client is disconnected.
+      DESC
+    syntax "<cartridge> [multiplier] [--namespace NAME] [--app NAME] [--min min] [--max max]"
+    argument :cartridge, "The name of the cartridge you are scaling", ["-c", "--cartridge cartridge"]
+    argument :multiplier, "The number of instances of this cartridge you need", [], :optional => true, :hide => true
     option ["-n", "--namespace NAME"], "Namespace of the application the cartridge belongs to", :context => :namespace_context, :required => true
     option ["-a", "--app NAME"], "Application the cartridge belongs to", :context => :app_context, :required => true
     option ["--min min", Integer], "Minimum scaling value"
     option ["--max max", Integer], "Maximum scaling value"
-    def scale(cartridge)
+    def scale(cartridge, multiplier)
+      options.default(:min => Integer(multiplier), :max => Integer(multiplier)) if multiplier rescue raise ArgumentError, "Multiplier must be a positive integer."
+
       raise RHC::MissingScalingValueException unless options.min || options.max
 
       rest_app = rest_client.find_application(options.namespace, options.app, :include => :cartridges)
@@ -197,17 +216,22 @@ module RHC::Commands
 
       raise RHC::CartridgeNotScalableException unless rest_cartridge.scalable?
 
+      warn "This operation will run until the application is at the minimum scale and may take several minutes."
+      say "Setting scale range for #{rest_cartridge.name} ... "
+
       cart = rest_cartridge.set_scales({
         :scales_from => options.min,
         :scales_to   => options.max
       })
 
-      results do
-        paragraph{ display_cart(cart) }
-        success "Success: Scaling values updated"
-      end
+      success "done"
+      paragraph{ display_cart(cart) }
 
       0
+    rescue RHC::Rest::TimeoutException => e
+      raise unless e.on_receive?
+      info "The server has closed the connection, but your scaling operation is still in progress.  Please check the status of your operation via 'rhc show-app'."
+      1
     end
 
     summary 'View/manipulate storage on a cartridge'
@@ -269,11 +293,10 @@ module RHC::Commands
           total_amount = amount
         end
 
+        say "Set storage on cartridge ... "
         cart = rest_cartridge.set_storage(:additional_gear_storage => total_amount)
-        results do
-          say "Success: additional storage space set to #{total_amount}GB\n"
-          display_cart_storage_info cart
-        end
+        success "set to #{total_amount}GB"
+        paragraph{ display_cart_storage_info cart }
       end
 
       0

data/lib/rhc/commands/git_clone.rb

@@ -18,7 +18,8 @@ module RHC::Commands
     # argument :directory, "The name of a new directory to clone into", [], :default => nil
     def run(app_name)
       rest_app = rest_client.find_application(options.namespace, app_name)
-      git_clone_application(rest_app)
+      dir = git_clone_application(rest_app)
+      success "Your application Git repository has been cloned to '#{system_path(dir)}'"
 
       0
     end

data/lib/rhc/commands/port_forward.rb

@@ -110,14 +110,12 @@ module RHC::Commands
 
           if forwarding_specs.length == 0
             # check if the gears have been stopped
-            ggs = rest_app.gear_groups
-            if ggs.any? { |gg|
-              gears = gg.gears
-              true if gears.any? { |g| g["state"] == "stopped" }
-            }
-              warn "Application #{rest_app.name} is stopped. Please restart the application and try again."
+            if rest_app.gear_groups.all?{ |gg| gg.gears.all?{ |g| g["state"] == "stopped" } }
+              warn "none"
+              error "The application is stopped. Please restart the application and try again."
               return 1
             else
+              warn "none"
               raise RHC::NoPortsToForwardException.new "There are no available ports to forward for this application. Your application may be stopped or idled."
             end
           end

data/lib/rhc/commands/ssh.rb

@@ -0,0 +1,54 @@
+require 'rhc/commands/base'
+require 'resolv'
+require 'rhc/git_helpers'
+require 'rhc/cartridge_helpers'
+
+module RHC::Commands
+  class Ssh < Base
+    suppress_wizard
+
+    summary "SSH into the specified application"
+    description <<-DESC
+      Connect to your application using SSH.  This will connect to your primary gear 
+      (the one with your Git repository and web cartridge) by default.  To SSH to
+      other gears run 'rhc show-app --gears' to get a list of their SSH hosts.
+
+      You may run a specific SSH command by passing one or more arguments, or use a 
+      different SSH executable or pass options to SSH with the '--ssh' option.
+      DESC
+    syntax "<app> [--ssh path_to_ssh_executable]"
+    argument :app, "The name of the application you want to SSH into", ["-a", "--app NAME"], :context => :app_context
+    argument :command, "Command to run in the application's SSH session", [], :arg_type => :list, :required => false
+    option ["--ssh PATH"], "Path to your SSH executable or additional options"
+    option ["-n", "--namespace NAME"], "Namespace of the application", :context => :namespace_context, :required => false
+    option ["--gears"], "Execute this command on all gears in the app.  Requires a command."
+    option ["--limit INTEGER", Integer], "Limit the number of simultaneous SSH connections opened with --gears (default: 5)."
+    option ["--raw"], "Output only the data returned by each host, no hostname prefix."
+    alias_action 'app ssh', :root_command => true
+    def run(app_name, command)
+      raise ArgumentError, "No application specified" unless app_name.present?
+      raise ArgumentError, "--gears requires a command" if options.gears && command.blank?
+      raise ArgumentError, "--limit must be an integer greater than zero" if options.limit && options.limit < 1
+      raise OptionParser::InvalidOption, "No system SSH available. Please use the --ssh option to specify the path to your SSH executable, or install SSH." unless options.ssh or has_ssh?
+
+      if options.gears
+        groups = rest_client.find_application_gear_groups(options.namespace, app_name)
+        run_on_gears(command.join(' '), groups)
+        0
+      else
+        rest_app = rest_client.find_application(options.namespace, app_name)
+        $stderr.puts "Connecting to #{rest_app.ssh_string.to_s} ..." unless command.present?
+
+        ssh = options.ssh || 'ssh'
+        debug "Using user specified SSH: #{options.ssh}" if options.ssh
+
+        command_line = [ssh, rest_app.ssh_string.to_s, command].compact.flatten
+        debug "Invoking Kernel.exec with #{command_line.inspect}"
+        Kernel.send(:exec, *command_line)
+      end
+    end
+
+    protected
+      include RHC::SSHHelpers
+  end
+end

data/lib/rhc/exceptions.rb

@@ -135,17 +135,22 @@ module RHC
     end
   end
 
-  class ServerAPINotSupportedException < Exception
-    def initialize(min_version, current_version)
-      super "The server does not support this command (requires #{min_version}, found #{current_version})."
-    end
-  end
-
-  class OperationNotSupportedException < Exception
+  class UnsupportedError < Exception
     def initialize(message="This operation is not supported by the server.")
       super message, 1
     end
   end
+  class NoPerGearOperations < UnsupportedError
+    def initialize
+      super "The server does not support operations on individual gears."
+    end
+  end  
+  class ServerAPINotSupportedException < UnsupportedError
+    def initialize(min_version, current_version)
+      super "The server does not support this command (requires #{min_version}, found #{current_version})."
+    end
+  end
+  class OperationNotSupportedException < UnsupportedError; end
 
   class InvalidURIException < Exception
     def initialize(uri)

data/lib/rhc/git_helpers.rb

@@ -30,10 +30,10 @@ module RHC
       repo_dir = options.repo || app.name
 
       debug "Pulling new repo down"
-      git_clone_repo(app.git_url, repo_dir)
+      dir = git_clone_repo(app.git_url, repo_dir)
 
       debug "Configuring git repo"
-      Dir.chdir(repo_dir) do |dir|
+      Dir.chdir(repo_dir) do
         git_config_set "rhc.app-uuid", app.uuid
         git_config_set "rhc.app-name", app.name
         git_config_set "rhc.domain-name", app.domain_id
@@ -41,7 +41,7 @@ module RHC
 
       git_clone_deploy_hooks(repo_dir)
 
-      true
+      dir
     end
 
     # :nocov: These all call external binaries so test them in cucumber
@@ -86,8 +86,7 @@ module RHC
           raise RHC::GitException, "Unable to clone your repository. Called Git with: #{cmd}"
         end
       end
-
-      success "Your application code is now in '#{repo_dir}'"
+      File.expand_path(repo_dir)
     end
   end
 end

data/lib/rhc/help_formatter.rb

@@ -33,12 +33,17 @@ module RHC
 
     def initialize(command, instance_commands, runner)
       @command = command
-      @actions = instance_commands.collect do |command_name, command_class|
-        next if command_class.summary.nil?
-        m = /^#{command.name}[\-]([^ ]+)/.match(command_name)
-        # if we have a match and it is not an alias then we can use it
-        m and command_name == command_class.name ? {:name => m[1], :summary => command_class.summary || ""} : nil
-      end
+      @actions = 
+        if command.root?
+          instance_commands.collect do |command_name, command_class|
+            next if command_class.summary.nil?
+            m = /^#{command.name}[\-]([^ ]+)/.match(command_name)
+            # if we have a match and it is not an alias then we can use it
+            m and command_name == command_class.name ? {:name => m[1], :summary => command_class.summary || ""} : nil
+          end
+        else
+          []
+        end
       @actions.compact!
       @global_options = runner.options
       @runner = runner

data/lib/rhc/helpers.rb

@@ -38,6 +38,19 @@ module RHC
       path
     end
 
+    PREFIX = %W(TB GB MB KB B).freeze
+
+    def human_size( s )
+      return "unknown" unless s
+      s = s.to_f
+      i = PREFIX.length - 1
+      while s > 500 && i > 0
+        i -= 1
+        s /= 1000
+      end
+      ((s > 9 || s.modulo(1) < 0.1 ? '%d' : '%.1f') % s) + ' ' + PREFIX[i]
+    end    
+
     def date(s)
       now = Date.today
       d = datetime_rfc3339(s).to_time
@@ -100,6 +113,10 @@ module RHC
     global_option '--server NAME', String, 'An OpenShift server hostname (default: openshift.redhat.com)'
     global_option '-k', '--insecure', "Allow insecure SSL connections.  Potential security risk.", :hide => true
 
+    global_option '--limit INTEGER', Integer, "Maximum number of simultaneous operations to execute.", :hide => true
+    global_option '--raw', "Do not format the output from the requested operations.", :hide => true
+    global_option '--always-prefix', "Include the gear prefix on all output from the server.", :hide => true
+
     OptionParser.accept(SSLVersion = Class.new){ |s| OpenSSL::SSL::SSLContext::METHODS.find{ |m| m.to_s.downcase == s.downcase } or raise OptionParser::InvalidOption.new(nil, "The provided SSL version '#{s}' is not valid. Supported values: #{OpenSSL::SSL::SSLContext::METHODS.map(&:to_s).map(&:downcase).join(', ')}") }
     global_option '--ssl-version VERSION', SSLVersion, "The version of SSL to use", :hide => true do |value|
       raise RHC::Exception, "You are using an older version of the httpclient gem which prevents the use of --ssl-version.  Please run 'gem update httpclient' to install a newer version (2.2.6 or newer)." unless HTTPClient::SSLConfig.method_defined? :ssl_version
@@ -148,7 +165,7 @@ module RHC
     end
 
     def ssh_string(ssh_url)
-      return nil if ssh_url.nil?
+      return nil if ssh_url.blank?
       uri = URI.parse(ssh_url)
       "#{uri.user}@#{uri.host}"
     rescue => e
@@ -248,8 +265,12 @@ module RHC
     end
 
     # OVERRIDE: Replaces default commander behavior
-    def color(*args)
-      $terminal.color(*args)
+    def color(item, *args)
+      if item.is_a? Array
+        item.map{ |i| $terminal.color(i, *args) }
+      else
+        $terminal.color(item, *args)
+      end
     end
 
     [:pager, :indent, :paragraph, :section, :header, :table, :table_args].each do |sym|

data/lib/rhc/highline_extensions.rb

@@ -174,6 +174,7 @@ class HighLineExtension < HighLine
     top = 0 unless @margin
     @margin = [top, @margin || 0].max
 
+    separate_blocks if params[:now]
     value = block.call
 
     say "\n" if @last_line_open
@@ -276,7 +277,7 @@ class HighLine::Header < Struct.new(:text, :width, :indent, :color)
           text.textwrap_ansi(width)
         end
       end.tap do |rows|
-        rows << '-' * rows.map{ |s| s.strip_ansi.length }.max
+        rows << '-' * (rows.map{ |s| s.strip_ansi.length }.max || 0)
       end
     end
 end
@@ -318,7 +319,13 @@ class HighLine::Table
     def source_rows
       @source_rows ||= begin
         (@mapper ? (items.map &@mapper) : items).each do |row|
-          row.map!{ |col| col.is_a?(String) ? col : col.to_s }
+          row.map! do |col| 
+            case col
+            when Array then col.join("\n")
+            when String then col
+            else col.to_s
+            end
+          end
         end
       end
     end
@@ -367,18 +374,36 @@ class HighLine::Table
           end
       end
 
-      remaining = column_widths.inject(0){ |sum, w| if w.set == 0; sum += w.max; available -= w.min; end; sum }
+      remaining = column_widths.inject(0) do |sum, w| 
+          if w.set == 0
+            sum += w.max
+            available -= w.min 
+          end
+          sum
+        end
       fair = available.to_f / remaining.to_f
 
       column_widths.
         each do |w| 
           if w.set == 0
-            available -= (alloc = (w.max * fair).to_i)
+            alloc = (w.max * fair).to_i
+            overflow = alloc + w.min - w.max
+            if overflow > 0
+              alloc -= overflow
+            end
+            available -= alloc
             w.set = alloc + w.min
           end
         end.
-        each{ |w| if available > 0 && w.set < w.max; w.set += 1; available -= 1; end }.
-        map(&:set)
+        each do |w|
+          next unless available > 0
+          gap = w.max - w.set
+          if gap > 0
+            left = [gap,available].min
+            available -= left
+            w.set += left
+          end
+        end.map(&:set)
     end
 
     def widths

data/lib/rhc/output_helpers.rb

@@ -1,34 +1,5 @@
 module RHC
   module OutputHelpers
-    # Issues collector collects a set of recoverable issues and steps to fix them
-    # for output at the end of a complex command
-    def add_issue(reason, commands_header, *commands)
-      @issues ||= []
-      issue = {:reason => reason,
-               :commands_header => commands_header,
-               :commands => commands}
-      @issues << issue
-    end
-
-    def format_issues(indent)
-      return nil unless issues?
-
-      indentation = " " * indent
-      reasons = ""
-      steps = ""
-
-      @issues.each_with_index do |issue, i|
-        reasons << "#{indentation}#{i+1}. #{issue[:reason].strip}\n"
-        steps << "#{indentation}#{i+1}. #{issue[:commands_header].strip}\n"
-        issue[:commands].each { |cmd| steps << "#{indentation}  $ #{cmd}\n" }
-      end
-
-      [reasons, steps]
-    end
-
-    def issues?
-      not @issues.nil?
-    end
 
     #---------------------------
     # Application information