rhc 1.3.8 → 1.4.7

data/features/lib/rhc_helper/domain.rb

@@ -1,4 +1,3 @@
-require 'dnsruby'
 require 'rhc/rest'
 
 module RHCHelper
@@ -9,21 +8,16 @@ module RHCHelper
     extend Runnable
     extend Commandify
     extend API
-    include Dnsruby
 
     class << self
       attr_reader :domain_output, :domain_show_output, :exitcode
     end
 
     def self.unique_namespace(prefix)
-      namepace = nil
-      begin
-        # Loop until we find a unique namespace
-        chars = ("1".."9").to_a
-        namespace = prefix + Array.new(8, '').collect{chars[rand(chars.size)]}.join
-
-       end while reserved?(namespace)
-       namespace
+      # TODO:  Due to DNS changes with the model refactor,
+      #        the namespace is not checked here - see #reserved?
+      chars = ("1".."9").to_a
+      prefix + Array.new(8, '').collect{chars[rand(chars.size)]}.join
     end
 
     def self.create_if_needed(prefix="test")
@@ -61,14 +55,11 @@ module RHCHelper
     end
 
     def self.reserved?(namespace=$namespace)
-      # If we get a response, then the namespace is reserved
-      # An exception means that it is available
-      begin
-        Dnsruby::Resolver.new.query("#{namespace}.#{$domain}", Dnsruby::Types::TXT)
-        return true
-      rescue
-        return false
-      end
+      # With the recent model refactoring, we no longer create
+      # TXT DNS records.
+      # Here, we return 'true', since this is the only code that is
+      # used in 'Then' clauses of 2 Cucumber scenarios.
+      true
     end
   end
 end

data/features/scaled_application.feature

@@ -34,7 +34,7 @@ Feature: Scaled Application Operations
 
     Examples:
       | cart    | type  | value |
-      | php-5.3 | min   |   3   |
+      | php-5.3 | min   |   1   |
       | php-5.3 | max   |   5   |
       | php-5.3 | max   |   -1  |
 

data/features/step_definitions/cartridge_steps.rb

@@ -32,7 +32,7 @@ Then /^the (.+) cartridge should be (.*)$/ do |name,status|
              when :stopped
                "(.+) stopped"
              when :removed
-               "Cartridge '#{name}' cannot be found in application"
+               "There are no cartridges that match '#{name}'"
              else
                raise "Unrecognized status type #{status}"
              end

data/lib/rhc.rb

@@ -12,12 +12,15 @@ require 'rhc/core_ext'
 
 module RHC
   autoload :Auth,           'rhc/auth'
+  autoload :CartridgeHelpers, 'rhc/cartridge_helpers'
   autoload :CommandRunner,  'rhc/command_runner'
   autoload :Commands,       'rhc/commands'
   autoload :Config,         'rhc/config'
+  autoload :GitHelpers,     'rhc/git_helpers'
   autoload :Helpers,        'rhc/helpers'
   autoload :HelpFormatter,  'rhc/help_formatter'
   autoload :Rest,           'rhc/rest'
+  autoload :SSHHelpers,     'rhc/ssh_helpers'
   autoload :TarGz,          'rhc/tar_gz'
   autoload :VERSION,        'rhc/version'
 end

data/lib/rhc/cartridge_helpers.rb

@@ -1,40 +1,98 @@
 module RHC
   module CartridgeHelpers
 
-    def find_cartridge(rest_obj, cartridge_name, type="embedded")
-      carts = find_cartridges(rest_obj, [cartridge_name], type)
+    protected
+      def check_cartridges(names, opts={}, &block)
+        cartridge_names = Array(names).map{ |s| s.strip if s && s.length > 0 }.compact
+        from = opts[:from] || all_cartridges
 
-      if carts.length == 0
-        valid_carts = rest_obj.cartridges.collect { |c| c.name if c.type == type }.compact
-
-        msg = if RHC::Rest::Application === rest_obj
-                "Cartridge '#{cartridge_name}' cannot be found in application '#{rest_obj.name}'."
-              else
-                "Cartridge '#{cartridge_name}' is not a valid cartridge name."
-              end
-
-        unless valid_carts.empty?
-          msg += "  Valid cartridges are (#{valid_carts.join(', ')})."
+        cartridge_names.map do |name|
+          name = name.downcase
+          from.find{ |c| c.name.downcase == name } ||
+          begin
+            carts = from.select{ |c| match_cart(c, name) }
+            if carts.empty?
+              paragraph { list_cartridges(from) }
+              raise RHC::CartridgeNotFoundException, "There are no cartridges that match '#{name}'."
+            elsif carts.length == 1
+              use_cart(carts.first, name)
+            else
+              carts.sort!.instance_variable_set(:@for, name)
+              carts
+            end
+          end
+        end.tap do |carts|
+          yield carts if block_given?
+        end.each do |carts|
+          if carts.is_a? Array
+            name = carts.instance_variable_get(:@for)
+            paragraph { list_cartridges(carts) }
+            raise RHC::MultipleCartridgesException, "There are multiple cartridges matching '#{name}'. Please provide the short name of the correct cart."
+          end
         end
+      end
 
-        raise RHC::CartridgeNotFoundException, msg
-      elsif carts.length > 1
-        msg = "Multiple cartridge versions match your criteria. Please specify one."
-        carts.each { |cart| msg += "\n  #{cart.name}" }
-        raise RHC::MultipleCartridgesException, msg
+      def use_cart(cart, for_cartridge_name)
+        info "Using #{cart.name}#{cart.display_name ? " (#{cart.display_name})" : ''} for '#{for_cartridge_name}'"
+        cart
       end
 
-      carts[0]
-    end
+      def match_cart(cart, search)
+        search = search.to_s.downcase.gsub(/[_\-\s]/,' ')
+        [
+           cart.name, 
+           cart.description, 
+          (cart.tags || []).join(' '),
+        ].compact.any?{ |s| s.present? && s.downcase.gsub(/[_\-\s]/,' ').include?(search) }
+      end
 
-    def find_cartridges(rest_obj, cartridge_list, type='embedded')
-      rest_obj.find_cartridges :regex => cartridge_list.collect { |c| cart_regex c }.join('|'), :type => type
-    end
+      def web_carts_only
+        lambda{ |cart|
+          next cart unless cart.is_a? Array
+          name = cart.instance_variable_get(:@for)
+          matching = cart.select(&:only_in_new?)
+          if matching.empty?
+            raise RHC::MultipleCartridgesException, "You must select only a single web cartridge. '#{name}' matches web cartridges."
+          elsif matching.size == 1
+            use_cart(matching.first, name)
+          else
+            matching.instance_variable_set(:@for, name)
+            matching
+          end
+        }
+      end
 
-    private
+      def other_carts_only
+        lambda{ |cart|
+          next cart unless cart.is_a? Array
+          name = cart.instance_variable_get(:@for)
+          matching = cart.select{ |c| not c.only_in_new? }
+          if matching.empty?
+            raise RHC::MultipleCartridgesException, "You must select only a single web cartridge. '#{name}' matches web cartridges."
+          elsif matching.size == 1
+            use_cart(matching.first, name)
+          else
+            matching.instance_variable_set(:@for, name)
+            matching
+          end
+        }
+      end
 
-    def cart_regex(cart)
-      "^#{cart.rstrip}(-[0-9\.]+){0,1}$"
-    end
+      def standalone_cartridges
+        @standalone_cartridges ||= all_cartridges.select{ |c| c.type == 'standalone' }
+      end
+      def not_standalone_cartridges
+        @not_standalone_cartridges ||= all_cartridges.select{ |c| c.type != 'standalone' }
+      end
+      def all_cartridges
+        @all_cartridges = rest_client.cartridges
+      end
+
+      def list_cartridges(cartridges)
+        carts = cartridges.map{ |c| [c.name, c.display_name || ''] }.sort{ |a,b| a[1].downcase <=> b[1].downcase }
+        carts.unshift ['==========', '=========']
+        carts.unshift ['Short Name', 'Full name']
+        say table(carts).join("\n")
+      end
   end
 end

data/lib/rhc/command_runner.rb

@@ -89,7 +89,7 @@ module RHC
           1
         rescue RHC::Exception, RHC::Rest::Exception => e
           RHC::Helpers.error e.message
-          e.code.nil? ? 128 : e.code
+          e.code.nil? ? 128 : [1, (e.code || 1).to_i].max
         end
       else
         run_active_command

data/lib/rhc/commands/app.rb

@@ -51,7 +51,7 @@ module RHC::Commands
     argument :cartridges, "The web framework this application should use", ["-t", "--type cartridge"], :arg_type => :list
     #argument :additional_cartridges, "A list of other cartridges such as databases you wish to add. Cartridges can also be added later using 'rhc cartridge add'", [], :arg_type => :list
     def create(name, cartridges)
-      cartridges = check_cartridges(cartridges)
+      cartridges = check_cartridges(cartridges, &require_one_web_cart) 
 
       options.default \
         :dns => true,
@@ -278,6 +278,29 @@ module RHC::Commands
       0
     end
 
+    summary "SSH into the specified application"
+    syntax "<app> [--ssh path_to_ssh_executable]"
+    argument :app, "The name of the application you want to SSH into", ["-a", "--app app"], :context => :app_context
+    option ["--ssh PATH"], "Path to your SSH executable"
+    option ["-n", "--namespace namespace"], "Namespace of the application the cartridge belongs to", :context => :namespace_context, :required => true
+    alias_action 'ssh', :root_command => true
+    def ssh(app_name)
+      raise ArgumentError, "No application specified" unless app_name.present?
+      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?
+
+      domain = rest_client.find_domain(options.namespace)
+      app = domain.find_application(app_name)
+
+      say "Connecting to #{app.ssh_string.to_s} ..."
+      if options.ssh
+        debug "Using user specified SSH: #{options.ssh}"
+        Kernel.send(:system, "#{options.ssh} #{app.ssh_string.to_s}")
+      else
+        debug "Using system ssh"
+        Kernel.send(:system, "ssh #{app.ssh_string.to_s}")
+      end
+    end
+
     summary "DEPRECATED use 'show <app> --state' instead"
     syntax "<app> [--namespace namespace] [--app app]"
     argument :app, "The name of the application you are getting information on", ["-a", "--app app"], :context => :app_context
@@ -292,54 +315,26 @@ module RHC::Commands
     private
       include RHC::GitHelpers
       include RHC::CartridgeHelpers
-
-      def check_sshkeys!
-        RHC::SSHWizard.new(rest_client, config, options).run
-      end
-
-      def standalone_cartridges
-        @standalone_cartridges ||= all_cartridges.select{ |c| c.type == 'standalone' }
-      end
-      def all_cartridges
-        @all_cartridges = rest_client.cartridges
-      end
-
-      def check_cartridges(cartridge_names)
-        cartridge_names = Array(cartridge_names).map{ |s| s.strip if s && s.length > 0 }.compact
-
-        cartridge_names.map do |name|
-          all_cartridges.find{ |c| c.name == name } ||
-            begin
-              matching_cartridges = all_cartridges.select{ |c| c.name.include?(name) }
-              unless matching_cartridges.length == 1
-                if matching_cartridges.present?
-                  paragraph { list_cartridges(matching_cartridges) }
-                  raise RHC::MultipleCartridgesException, "There are multiple web cartridges named '#{name}'. Please provide the short name of your desired cart." if matching_cartridges.present?
-                else
-                  paragraph { list_cartridges(all_cartridges) }
-                  raise RHC::CartridgeNotFoundException, "There are no cartridges that match '#{name}'."
-                end
-              end
-              use_cart(matching_cartridges.first, name)
-            end
-        end.tap do |carts|
-          if carts.none?(&:only_in_new?)
-            section(:bottom => 1){ list_cartridges }
+      
+      def require_one_web_cart
+        lambda{ |carts|
+          match, ambiguous = carts.partition{ |c| not c.is_a?(Array) }
+          selected_web = match.any?(&:only_in_new?)
+          possible_web = ambiguous.flatten.any?(&:only_in_new?)
+          if not (selected_web or possible_web)
+            section(:bottom => 1){ list_cartridges(standalone_cartridges) }
             raise RHC::CartridgeNotFoundException, "Every application needs a web cartridge to handle incoming web requests. Please provide the short name of one of the carts listed above."         
           end
-        end
-      end
-
-      def use_cart(cart, for_cartridge_name)
-        info "Using #{cart.name}#{cart.display_name ? " (#{cart.display_name})" : ''} for '#{for_cartridge_name}'"
-        cart
+          if selected_web
+            carts.map! &other_carts_only
+          elsif possible_web
+            carts.map! &web_carts_only
+          end
+        }
       end
 
-      def list_cartridges(cartridges=standalone_cartridges)
-        carts = cartridges.map{ |c| [c.name, c.display_name || ''] }.sort{ |a,b| a[1].downcase <=> b[1].downcase }
-        carts.unshift ['==========', '=========']
-        carts.unshift ['Short Name', 'Full name']
-        say table(carts).join("\n")
+      def check_sshkeys!
+        RHC::SSHWizard.new(rest_client, config, options).run
       end
 
       def app_action(app, action, *args)
@@ -363,7 +358,7 @@ module RHC::Commands
       rescue RHC::Rest::Exception => e
         if e.code == 109
           paragraph{ say "Valid cartridge types:" }
-          paragraph{ list_cartridges }
+          paragraph{ list_cartridges(standalone_cartridges) }
         end
         raise
       end
@@ -422,18 +417,19 @@ module RHC::Commands
         Kernel.sleep 5
 
         # Now start checking for DNS
-        for i in 0..MAX_RETRIES-1
-          found = host_exists?(host) || hosts_file_contains?(host)
-          break if found
+        host_found = hosts_file_contains?(host) or
+        1.upto(MAX_RETRIES) { |i|
+          host_found = host_exists?(host)
+          break found if host_found
 
-          say "    retry # #{i+1} - Waiting for DNS: #{host}"
+          say "    retry # #{i} - Waiting for DNS: #{host}"
           Kernel.sleep sleep_time.to_i
           sleep_time *= DEFAULT_DELAY_THROTTLE
-        end
+        }
 
         debug "End checking for application dns @ '#{host} - found=#{found}'"
 
-        found
+        host_found
       end
 
       def enable_jenkins?
@@ -461,6 +457,22 @@ module RHC::Commands
         # :nocov:
       end
 
+      # check the version of SSH that is installed
+      def ssh_version
+        @ssh_version ||= `ssh -V 2>&1`.strip
+      end
+
+      # return whether or not SSH is installed
+      def has_ssh?
+        @has_ssh ||= begin
+          @ssh_version = nil
+          ssh_version
+          $?.success?
+        rescue
+          false
+        end
+      end
+
       def windows_nslookup_bug?(rest_app)
         windows_nslookup = run_nslookup(rest_app.host)
         windows_ping = run_ping(rest_app.host)

data/lib/rhc/commands/cartridge.rb

@@ -15,7 +15,7 @@ module RHC::Commands
       carts = rest_client.cartridges.sort_by{ |c| "#{c.type == 'standalone' && 1}_#{c.tags.include?('experimental') ? 1 : 0}_#{(c.display_name || c.name).downcase}" }
 
       list = if options.verbose
-        carts.map do |c| 
+        carts.map do |c|
           name = c.display_name != c.name && "#{color(c.display_name, :cyan)} [#{c.name}]" || c.name
           tags = c.tags - RHC::Rest::Cartridge::HIDDEN_TAGS
           [
@@ -42,7 +42,7 @@ module RHC::Commands
     argument :cart_type, "The type of the cartridge you are adding (run 'rhc cartridge list' to obtain a list of available cartridges)", ["-c", "--cartridge cart_type"]
     alias_action :"app cartridge add", :root_command => true, :deprecated => true
     def add(cart_type)
-      cart = find_cartridge rest_client, cart_type
+      cart = check_cartridges(cart_type, :from => not_standalone_cartridges).first
 
       say "Adding #{cart.name} to application '#{options.app}' ... "
 
@@ -67,7 +67,7 @@ module RHC::Commands
     def show(cartridge)
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
-      rest_cartridge = find_cartridge rest_app, cartridge, nil
+      rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
 
       display_cart(rest_cartridge)
 
@@ -85,7 +85,7 @@ module RHC::Commands
 
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
-      rest_cartridge = rest_app.find_cartridge cartridge, :type => "embedded"
+      rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
 
       confirm_action "Removing a cartridge is a destructive operation that may result in loss of data associated with the cartridge.\n\nAre you sure you wish to remove #{rest_cartridge.name} from '#{rest_app.name}'?"
 
@@ -103,9 +103,7 @@ module RHC::Commands
     option ["-a", "--app app"], "Application the cartridge", :context => :app_context, :required => true
     alias_action :"app cartridge start", :root_command => true, :deprecated => true
     def start(cartridge)
-      cartridge_action cartridge, :start
-
-      results { say "#{cartridge} started!" }
+      cartridge_action(cartridge, :start){ |_, c| results{ say "#{c.name} started" } }
       0
     end
 
@@ -116,9 +114,7 @@ module RHC::Commands
     option ["-a", "--app app"], "Application you the cartridge belongs to", :context => :app_context, :required => true
     alias_action :"app cartridge stop", :root_command => true, :deprecated => true
     def stop(cartridge)
-      cartridge_action cartridge, :stop
-
-      results { say "#{cartridge} stopped!" }
+      cartridge_action(cartridge, :stop){ |_, c| results{ say "#{c.name} stopped" } }
       0
     end
 
@@ -129,9 +125,7 @@ module RHC::Commands
     option ["-a", "--app app"], "Application the cartridge belongs to", :context => :app_context, :required => true
     alias_action :"app cartridge restart", :root_command => true, :deprecated => true
     def restart(cartridge)
-      cartridge_action cartridge, :restart
-
-      results { say "#{cartridge} restarted!" }
+      cartridge_action(cartridge, :restart){ |_, c| results{ say "#{c.name} restarted" } }
       0
     end
 
@@ -144,7 +138,7 @@ module RHC::Commands
     def status(cartridge)
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
-      rest_cartridge = find_cartridge(rest_app, cartridge)
+      rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
       results { rest_cartridge.status.each{ |msg| say msg['message'] } }
       0
     end
@@ -156,9 +150,7 @@ module RHC::Commands
     option ["-a", "--app app"], "Application the cartridge belongs to", :context => :app_context, :required => true
     alias_action :"app cartridge reload", :root_command => true, :deprecated => true
     def reload(cartridge)
-      cartridge_action cartridge, :reload
-
-      results { say "#{cartridge} config reloaded!" }
+      cartridge_action(cartridge, :reload){ |_, c| results{ say "#{c.name} reloaded" } }
       0
     end
 
@@ -174,7 +166,7 @@ module RHC::Commands
 
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
-      rest_cartridge = find_cartridge rest_app, cartridge, nil
+      rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
 
       raise RHC::CartridgeNotScalableException unless rest_cartridge.scalable?
 
@@ -191,8 +183,6 @@ module RHC::Commands
       0
     end
 
-=begin
-    #  Commenting this out for US2438
     summary 'View/manipulate storage on a cartridge'
     syntax '<cartridge> -a app [--show] [--add|--remove|--set amount] [--namespace namespace]'
     argument :cart_type, "The name of the cartridge", ["-c", "--cartridge cart_type"], :arg_type => :list
@@ -203,11 +193,8 @@ module RHC::Commands
     option ["--remove amount"], "Remove the indicated amount from the additional storage capacity"
     option ["--set amount"], "Set the specified amount of additional storage capacity"
     option ["-f", "--force"], "Force the action"
-    def storage(cartridges)
-      # Make sure that we are dealing with an array (-c param will only pass in a string)
-      # BZ 883658
-      cartridges = [cartridges].flatten
-
+    def storage(cartridge)
+      cartridges = Array(cartridge)
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
 
@@ -227,8 +214,7 @@ module RHC::Commands
           if cartridges.length == 0
             display_cart_storage_list rest_app.cartridges
           else
-            cartridges.each do |cartridge_name|
-              cart = rest_app.find_cartridge(cartridge_name)
+            check_cartridges(cartridge, :from => rest_app.cartridges).each do |cart|
               display_cart_storage_info cart, cart.display_name
             end
           end
@@ -237,7 +223,7 @@ module RHC::Commands
         raise RHC::MultipleCartridgesException,
           'Exactly one cartridge must be specified for this operation' if cartridges.length != 1
 
-        rest_cartridge = find_cartridge rest_app, cartridges.first, nil
+        rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
         amount = amount.match(/^(\d+)(GB)?$/i)
         raise RHC::AdditionalStorageValueException if amount.nil?
 
@@ -266,17 +252,18 @@ module RHC::Commands
 
       0
     end
-=end
 
     private
       include RHC::CartridgeHelpers
 
-      def cartridge_action(cartridge, action)
+      def cartridge_action(cartridge, action, &block)
         rest_domain = rest_client.find_domain(options.namespace)
         rest_app = rest_domain.find_application(options.app)
-        rest_cartridge = find_cartridge rest_app, cartridge
+        rest_cartridge = check_cartridges(cartridge, :from => rest_app.cartridges).first
         result = rest_cartridge.send action
-        [result, rest_cartridge, rest_app, rest_domain]
+        resp = [result, rest_cartridge, rest_app, rest_domain]
+        yield resp if block_given?
+        resp
       end
   end
 end