rhc 1.0.4 → 1.1.11

data/bin/rhc-chk

@@ -526,8 +526,13 @@ class CheckRunner < Test::Unit::UI::Console::TestRunner
   end
 end
 
-Test::Unit::AutoRunner::RUNNERS[:console] = proc do |r|
-  CheckRunner
+# Need to register the default runner differently using the standard test-unit and the gem
+proc{|*r| CheckRunner}.tap do |_proc|
+  if Test::Unit::AutoRunner.respond_to?(:register_runner)
+    Test::Unit::AutoRunner.register_runner(:console, _proc)
+  else
+    Test::Unit::AutoRunner::RUNNERS[:console] = _proc
+  end
 end
 
 ############################

data/bin/rhc-user-info

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# print deprecation warning
-RHC::Helpers.deprecated_command('rhc-domain-info',true)
 
 args = ""
 ARGV.each do|a|

data/features/cartridge.feature

@@ -22,3 +22,13 @@ Feature: Single Cartridge Tests
       | running | restarted | running |
       | running | stopped   | stopped |
       | stopped | started   | running |
+
+  Scenario Outline: Cartridge List
+    When we list cartridges
+    Then the list should contain the cartridge <cart> with display name "<name>"
+
+    Examples:
+      | cart        | name          |
+      | php-5.3     | PHP 5.3       |
+      | mongodb-2.2 | MongoDB NoSQL |
+      | cron-1.4    | Cron 1.4      |

data/features/lib/rhc_helper/cartridge.rb

@@ -7,6 +7,7 @@ module RHCHelper
   #
   class Cartridge
     extend Runnable
+    extend Commandify
     extend Persistable
     include Loggable
     include Runnable
@@ -19,19 +20,25 @@ module RHCHelper
     # Create the data structure for a test cartridge
     def initialize(app, name)
       @name = name
-      @app_name = app.name
+      @app_name = app.name unless app.nil?
       @hostname = "#{@app_name}-#{$namespace}.#{$domain}"
       @file = "#{TEMP_DIR}/#{$namespace}.json"
     end
 
     def rhc_cartridge(cmd)
-      full_cmd = "rhc cartridge #{cmd} -l #{$username} -p #{$password} -a #{@app_name}"
+      full_cmd = "rhc cartridge #{cmd} -l #{$username} -p #{$password} #{@app_name ? "-a #{@app_name}" : ""}"
       full_cmd += " #{@name}" if cmd != "list"
       run(full_cmd, nil) do |exitstatus, out, err, arg|
         yield exitstatus, out, err, arg if block_given?
       end
     end
 
+    def self.list
+      rhc_cartridge_list do |exitstatus, out, err, arg|
+        return [exitstatus, out, err, arg]
+      end
+    end
+
     def add
       rhc_cartridge('add') do |exitstatus, out, err, arg|
         yield exitstatus, out, err, arg if block_given?

data/features/lib/rhc_helper/commandify.rb

@@ -11,7 +11,7 @@ module RHCHelper
         cmd = get_cmd(sym)
 
         # Get any blocks that should be run after processing
-        cmd_callback = get_cmd_callback(cmd, args[0])
+        cmd_callback = get_cmd_callback(cmd, args[0]) || block
 
         # Add arguments to the command
         cmd << get_args(cmd, args[0])
@@ -85,8 +85,7 @@ module RHCHelper
           raise "No alias set" unless @alias
           args << "--alias #{@alias} "
         when /cartridge/
-          raise "No cartridge supplied" unless arg0
-          args << "-c #{arg0}"
+          args << "-c #{arg0}" if arg0
         when /sshkey/
           # in RHCHelper::Sshkey, we pass *args to method_missing here, so that
           # we _know_ that arg0 is an Array.

data/features/step_definitions/cartridge_steps.rb

@@ -47,6 +47,10 @@ When /^the (\w+) scaling value is set to (.*)$/ do |minmax,value|
   @exitcode = @app.cartridge(@cartridge_name).send(:scale,"--#{minmax} #{value}")
 end
 
+When /^we list cartridges$/ do
+  @exitcode, @cartridge_output = Cartridge.list
+end
+
 Then /^the (\w+) scaling value should be (.*)$/ do |minmax,value|
   expected = {
     :min => "Minimum",
@@ -64,3 +68,9 @@ end
 Then /^it should fail with code (\d+)$/ do |code|
   @exitcode.should == code.to_i
 end
+
+Then /^the list should contain the cartridge ([^\s]+) with display name "([^"]+)"$/ do |name, display_name|
+  line = @cartridge_output.each_line.find{ |s| s.include?(name) }
+  line.should_not be_nil
+  line.should match(display_name)
+end

data/lib/rhc-common.rb

@@ -471,9 +471,7 @@ end
   # Check if host exists
   #
   def self.hostexist?(host)
-      dns = Resolv::DNS.new
-      resp = dns.getresources(host, Resolv::DNS::Resource::IN::A)
-      return resp.any?
+    RHC::Helpers.host_exists?(host)
   end
   
   def self.create_app(libra_server, net_http, user_info, app_name, app_type, rhlogin, password, repo_dir=nil, no_dns=false, no_git=false, is_embedded_jenkins=false, gear_size='small',scale=false)

data/lib/rhc/{cartridge_helper.rb → cartridge_helpers.rb}

@@ -1,5 +1,6 @@
 module RHC
   module CartridgeHelpers
+
     def find_cartridge(rest_obj, cartridge_name, type="embedded")
       carts = rest_obj.find_cartridges :regex => cart_regex(cartridge_name), :type => type
 

data/lib/rhc/command_runner.rb

@@ -35,10 +35,6 @@ module RHC
         return
       end
       global_option('-v', '--version', 'Display version information') { say version; return }
-      global_option('--timeout seconds', Integer, 'Set the timeout in seconds for network commands') do |value|
-        # FIXME: Refactor so we don't have to use a global var here
-        $rest_timeout = value
-      end
 
       # remove these because we monkey patch Commands to process all options
       # at once, avoiding conflicts between the global and command options
@@ -71,9 +67,9 @@ module RHC
           OptionParser::MissingArgument => e
 
           help_bindings = CommandHelpBindings.new(active_command, commands, Commander::Runner.instance.options)
-          usage = RHC::HelpFormatter.new(self).render_command(help_bindings)
+          usage = RHC::HelpFormatter.new(self).render_command_syntax(help_bindings)
           RHC::Helpers.error e.message
-          say "\n#{usage}"
+          say "#{usage}"
           1
         rescue RHC::Exception, RHC::Rest::Exception => e
           RHC::Helpers.error e.message
@@ -100,18 +96,16 @@ module RHC
         c.syntax = 'rhc help <command>'
         c.description = 'Display global or <command> help documentation.'
         c.when_called do |args, options|
+          cmd = (1..args.length).reverse_each.map{ |n| args[0,n].join(' ') }.find{ |cmd| command_exists?(cmd) }
+
           if args.empty?
             say help_formatter.render
+          elsif cmd.nil?
+            RHC::Helpers.error "The command '#{program :name} #{provided_arguments.join(' ')}' is not recognized.\n"
+            say "See '#{program :name} help' for a list of valid commands."
+            next
           else
-            command = command args.join(' ')
-            begin
-              require_valid_command command
-            rescue InvalidCommandError => e
-              RHC::Helpers.error "The command '#{program :name} #{provided_arguments.join(' ')}' is not recognized.\n"
-              say "See '#{program :name} help' for a list of valid commands."
-              next
-            end
-
+            command = command(cmd)
             help_bindings = CommandHelpBindings.new command, commands, Commander::Runner.instance.options
             say help_formatter.render_command help_bindings
           end

data/lib/rhc/commands.rb

@@ -66,7 +66,10 @@ module RHC
               options.help or
               config.has_local_config? or
               config.has_opts_config?)
-        RHC::Wizard.new(config).run
+
+        RHC::Helpers.warn(
+          "You have not yet configured the OpenShift client tools. Please run 'rhc setup'.",
+            :stderr => true)
       end
     end
 

data/lib/rhc/commands/app.rb

@@ -1,7 +1,7 @@
 require 'rhc/commands/base'
 require 'resolv'
 require 'rhc/git_helper'
-require 'rhc/cartridge_helper'
+require 'rhc/cartridge_helpers'
 
 module RHC::Commands
   class App < Base
@@ -11,24 +11,26 @@ module RHC::Commands
     default_action :help
 
     summary "Create an application and adds it to a domain"
-    syntax "<name> <cartridge> [... <other cartridges>][--namespace namespace]"
-    option ["-n", "--namespace namespace"], "Namespace to add your application to", :context => :namespace_context, :required => true
-    option ["-g", "--gear-size size"], "The  size  of the gear for this app. Available gear sizes depend on the type of account you have."
-    option ["-s", "--scaling"], "Enable scaling for this application"
-    option ["-r", "--repo dir"], "Git Repo path (defaults to ./$app_name) (applicable to the  create command)"
-    option ["--[no-]git"], "Only  create  remote space, don't pull it locally"
-    option ["--nogit"], "DEPRECATED! Only  create  remote space, don't pull it locally", :deprecated => {:key => :git, :value => false}
-    option ["--[no-]dns"], "Skip DNS check. Must be used in combination with --no-git"
-    option ["--enable-jenkins [server_name]"], "Indicates to create a Jenkins application (if not already available)  and  embed the Jenkins client into this application. The default name will be 'jenkins' if not specified. Note that --no-dns is ignored for the creation of the Jenkins application."
-    argument :name, "The name you wish to give your application", ["-a", "--app name"]
-    argument :cartridge, "The first cartridge added to the application. Usually a web framework", ["-t", "--type cartridge"]
-    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, cartridge, additional_cartridges)
+    description "Create an application in your domain. You can see a list of all valid cartridge types by running 'rhc cartridge list'."
+    syntax "<name> <cartridge> [-n namespace]"
+    option ["-n", "--namespace namespace"], "Namespace for the application", :context => :namespace_context, :required => true
+    option ["-g", "--gear-size size"], "Gear size controls how much memory and CPU your cartridges can use."
+    option ["-s", "--scaling"], "Enable scaling for the web cartridge."
+    option ["-r", "--repo dir"], "Path to the Git repository (defaults to ./$app_name)"
+    option ["--[no-]git"], "Skip creating the local Git repository."
+    option ["--nogit"], "DEPRECATED: Skip creating the local Git repository.", :deprecated => {:key => :git, :value => false}
+    option ["--[no-]dns"], "Skip waiting for the application DNS name to resolve. Must be used in combination with --no-git"
+    option ["--enable-jenkins [server_name]"], "Enable Jenkins builds for this application (will create a Jenkins application if not already available). The default name will be 'jenkins' if not specified."
+    argument :name, "Name for your application", ["-a", "--app name"]
+    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)
+      cartridge = check_cartridges(cartridges).first
+
       options.default \
         :dns => true,
         :git => true
 
-      warnings = []
       header "Creating application '#{name}'"
       paragraph do
         table({"Namespace:" => options.namespace,
@@ -72,7 +74,7 @@ module RHC::Commands
               # error downloading Jenkins /jnlpJars/jenkins-cli.jar
               attempts += 1
               debug "Jenkins server could not be contacted, sleep and then retry: attempt #{attempts}\n    #{e.message}"
-              sleep(10)
+              Kernel.sleep(10)
             end
             exit_code = e.code
             exit_message = e.message
@@ -269,6 +271,42 @@ module RHC::Commands
       include RHC::GitHelpers
       include RHC::CartridgeHelpers
 
+      def standalone_cartridges
+        @standalone_cartridges ||= rest_client.cartridges.select{ |c| c.type == 'standalone' }
+      end
+
+      def check_cartridges(cartridge_names)
+        cartridge_names = Array(cartridge_names).map{ |s| s.strip if s && s.length > 0 }.compact
+
+        unless cartridge_name = cartridge_names.first
+          section(:bottom => 1){ list_cartridges }
+          raise ArgumentError.new "Every application needs a web cartridge to handle incoming web requests. Please provide the short name of one of the carts listed above."
+        end
+
+        unless standalone_cartridges.find{ |c| c.name == cartridge_name }
+          matching_cartridges = standalone_cartridges.select{ |c| c.name.include?(cartridge_name) }
+          if matching_cartridges.length == 1
+            cartridge_names[0] = use_cart(matching_cartridges.first, cartridge_name)
+          elsif matching_cartridges.present?
+            paragraph { list_cartridges(matching_cartridges) }
+            raise RHC::MultipleCartridgesException.new("There are multiple web cartridges named '#{cartridge_name}'.  Please provide the short name of your desired cart.")
+          end
+        end
+        cartridge_names.first(1)
+      end
+
+      def use_cart(cart, for_cartridge_name)
+        info "Using #{cart.name}#{cart.display_name ? " (#{cart.display_name})" : ''} instead of '#{for_cartridge_name}'"
+        cart.name
+      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")
+      end
+
       def app_action(app, action, *args)
         rest_domain = rest_client.find_domain(options.namespace)
         rest_app = rest_domain.find_application(app)
@@ -282,16 +320,17 @@ module RHC::Commands
         app_options[:scale] = scale if scale
         app_options[:debug] = true if @debug
 
-        debug "Creating application '#{name}' with these options - #{app_options}.inspect"
-
-        rest_cartridge = find_cartridge rest_client, cartridge, "standalone"
-        app_options[:cartridge] = rest_cartridge.name
-
+        debug "Creating application '#{name}' with these options - #{app_options.inspect}"
         rest_app = rest_domain.add_application name, app_options
-
         debug "'#{rest_app.name}' created"
 
         rest_app
+      rescue RHC::Rest::Exception => e
+        if e.code == 109
+          paragraph{ say "Valid cartridge types:" }
+          paragraph{ list_cartridges }
+        end
+        raise
       end
 
       def dns_propagated?(host, sleep_time=2)
@@ -307,7 +346,7 @@ module RHC::Commands
 
         # Now start checking for DNS
         for i in 0..MAX_RETRIES-1
-          found = host_exist?(host)
+          found = host_exists?(host)
           break if found
 
           say "    retry # #{i+1} - Waiting for DNS: #{host}"
@@ -320,13 +359,6 @@ module RHC::Commands
         found
       end
 
-      def host_exist?(host)
-        # :nocov:
-        dns = Resolv::DNS.new
-        dns.getresources(host, Resolv::DNS::Resource::IN::A).any?
-        # :nocov:
-      end
-
       def check_sshkeys!
         wizard = RHC::SSHWizard.new(rest_client)
         wizard.run

data/lib/rhc/commands/base.rb

@@ -59,7 +59,7 @@ class RHC::Commands::Base
       end
     end
 
-    raise ArgumentError.new("Too many arguments passed in.") unless fill_args.empty?
+    raise ArgumentError.new("Too many arguments passed in: #{fill_args.reverse.join(" ")}") unless fill_args.empty?
 
     arg_slots
   end

data/lib/rhc/commands/cartridge.rb

@@ -1,5 +1,5 @@
 require 'rhc/commands/base'
-require 'rhc/cartridge_helper'
+require 'rhc/cartridge_helpers'
 
 module RHC::Commands
   class Cartridge < Base
@@ -11,8 +11,25 @@ module RHC::Commands
     summary "List supported embedded cartridges"
     alias_action :"app cartridge list", :root_command => true, :deprecated => true
     def list
-      carts = rest_client.find_cartridges(:type => 'embedded').collect { |c| c.name }
-      results { say "#{carts.join(', ')}" }
+      rest_client = RHC::Rest::Client.new(openshift_rest_node, nil, nil)
+      list = rest_client.cartridges.
+        map{ |c| [c.name, c.display_name || '', c.type == 'standalone' ? 'Y' : ''] }.
+        sort do |a,b|
+          if a[2] == 'Y' && b[2] == ''
+            -1
+          elsif a[2] == '' && b[2] == 'Y'
+            1
+          else
+            a[1].downcase <=> b[1].downcase
+          end
+        end
+      list.unshift ['==========', '=========', '=============']
+      list.unshift ['Short Name', 'Full name', 'New apps only']
+
+      paragraph{ say "Use the short name of a cartridge when interacting with your applications." }
+
+      say table(list).join("\n")
+
       0
     end
 
@@ -176,14 +193,14 @@ module RHC::Commands
     end
 
     private
-    include RHC::CartridgeHelpers
-
-    def cartridge_action(cartridge, action)
-      rest_domain = rest_client.find_domain(options.namespace)
-      rest_app = rest_domain.find_application(options.app)
-      rest_cartridge = find_cartridge rest_app, cartridge
-      result = rest_cartridge.send action
-      [result, rest_cartridge, rest_app, rest_domain]
-    end
+      include RHC::CartridgeHelpers
+
+      def cartridge_action(cartridge, action)
+        rest_domain = rest_client.find_domain(options.namespace)
+        rest_app = rest_domain.find_application(options.app)
+        rest_cartridge = find_cartridge rest_app, cartridge
+        result = rest_cartridge.send action
+        [result, rest_cartridge, rest_app, rest_domain]
+      end
   end
 end

data/lib/rhc/commands/sshkey.rb

@@ -13,11 +13,12 @@ module RHC::Commands
     summary 'Display all the SSH keys for the user account'
     syntax ''
     def list
+      keys = rest_client.sshkeys
+
       results do
-        result = rest_client.sshkeys.inject('') do |r, key|
+        result = keys.inject('') do |r, key|
           r += format(key, erb)
         end
-
         say result
       end
 

data/lib/rhc/help_formatter.rb

@@ -5,6 +5,9 @@ module RHC
     def template(name)
       ERB.new(File.read(File.join(File.dirname(__FILE__), 'usage_templates', "#{name}.erb")), nil, '-')
     end
+    def render_command_syntax command
+      template(:command_syntax_help).result command.get_binding
+    end
   end
   # TODO: class ManPageHelpFormatter
 end

data/lib/rhc/helpers.rb

@@ -4,6 +4,8 @@ require 'rhc/config'
 require 'rhc/commands'
 require 'rhc/output_helpers'
 
+require 'resolv'
+
 OptionParser.accept(URI) {|s,| URI.parse(s) if s}
 
 module RHC
@@ -80,6 +82,10 @@ module RHC
     global_option '-p', '--password password', "OpenShift password"
     global_option '-d', '--debug', "Turn on debugging"
 
+    global_option('--timeout seconds', Integer, 'Set the timeout in seconds for network commands') do |value|
+      # FIXME: Refactor so we don't have to use a global var here
+      $rest_timeout = value
+    end
     global_option '--noprompt', "Suppress the interactive setup wizard from running before a command"
     global_option '--config FILE', "Path of a different config file"
     def config
@@ -113,6 +119,8 @@ module RHC
     end
 
     def deprecated(msg,short = false)
+      HighLine::use_color = false if windows? # handle deprecated commands that does not start through highline
+
       info = " For porting and testing purposes you may switch this %s to %s by setting the DISABLE_DEPRECATED environment variable to %d.  It is not recommended to do so in a production environment as this option may be removed in future releases."
 
       msg << info unless short
@@ -123,18 +131,29 @@ module RHC
       end
     end
 
-    def say(msg)
-      super
+    def say(msg, *args)
+      if Hash[*args][:stderr]
+        $stderr.puts msg
+      else
+        super(msg)
+      end
       msg
     end
+
     def success(msg, *args)
-      say color(msg, :green)
+      say color(msg, :green), *args
     end
+
+    def info(msg, *args)
+      say color(msg, :cyan), *args
+    end
+
     def warn(msg, *args)
-      say color(msg, :yellow)
+      say color(msg, :yellow), *args
     end
+
     def error(msg, *args)
-      say color(msg, :red)
+      say color(msg, :red), *args
     end
 
     def color(s, color)
@@ -306,5 +325,15 @@ Fingerprint: <%= key.fingerprint %>
       FORMAT
     end
 
+    #
+    # Check if host exists
+    #
+    def host_exists?(host)
+      # :nocov:
+      # Patch for BZ840938 to support Ruby 1.8 on machines without /etc/resolv.conf
+      dns = Resolv::DNS.new((Resolv::DNS::Config.default_config_hash || {}))
+      dns.getresources(host, Resolv::DNS::Resource::IN::A).any?
+      # :nocov:
+    end
   end
 end