rhc 1.2.7 → 1.3.8

data/lib/rhc/commands/apps.rb

@@ -0,0 +1,22 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Apps < Base
+    summary "List all your applications"
+    description "Display the list of applications that you own. Includes information about each application."
+    def run
+      domains = rest_client.domains
+
+      info "In order to deploy applications, you must create a domain with 'rhc setup' or 'rhc domain create'." and return 1 if domains.empty?
+
+      applications = domains.map{ |d| d.applications(:include => :cartridges) }.flatten.sort
+
+      applications.each{ |a| display_app(a, a.cartridges) }.blank? and
+        info "No applications. Use 'rhc app create'." and
+        return 1
+
+      success "You have #{applications.length} applications"
+      0
+    end
+  end
+end

data/lib/rhc/commands/base.rb

@@ -10,58 +10,10 @@ require 'rhc/context_helper'
 class RHC::Commands::Base
 
   attr_writer :options, :config
-  attr_reader :messages
 
   def initialize(options=Commander::Command::Options.new,
-                 config=nil)
+                 config=RHC::Config.new)
     @options, @config = options, config
-    @messages = []
-  end
-
-  def validate_args_and_options(args_metadata, options_metadata, args)
-    # process options
-    options_metadata.each do |option_meta|
-      arg = option_meta[:arg]
-
-      # Check to see if we've provided a value for an option tagged as deprecated
-      if (!(val = @options.__hash__[arg]).nil? && dep_info = option_meta[:deprecated])
-        # Get the arg for the correct option and what the value should be
-        (correct_arg, default) = dep_info.values_at(:key, :value)
-        # Set the default value for the correct option to the passed value
-        ## Note: If this isn't triggered, then the original default will be honored
-        ## If the user specifies any value for the correct option, it will be used
-        options.default correct_arg => default
-        # Alert the users if they're using a deprecated option
-        (correct, incorrect) = [options_metadata.find{|x| x[:arg] == correct_arg },option_meta].flatten.map{|x| x[:switches].join(", ") }
-        deprecated_option(incorrect, correct)
-      end
-
-      context_helper = option_meta[:context_helper]
-
-      @options.__hash__[arg] = self.send(context_helper) if @options.__hash__[arg].nil? and context_helper
-      raise ArgumentError.new("Missing required option '#{arg}'.") if option_meta[:required] and @options.__hash__[arg].nil?
-    end
-
-    # process args
-    arg_slots = [].fill(nil, 0, args_metadata.length)
-    fill_args = args.reverse
-    args_metadata.each_with_index do |arg_meta, i|
-      # check options
-      value = @options.__hash__[arg_meta[:option_symbol]] unless arg_meta[:option_symbol].nil?
-      if value
-        arg_slots[i] = value
-      elsif arg_meta[:arg_type] == :list
-        arg_slots[i] = fill_args.reverse
-        fill_args = []
-      else
-        raise ArgumentError.new("Missing required argument '#{arg_meta[:name]}'.") if fill_args.empty?
-        arg_slots[i] = fill_args.pop
-      end
-    end
-
-    raise ArgumentError.new("Too many arguments passed in: #{fill_args.reverse.join(" ")}") unless fill_args.empty?
-
-    arg_slots
   end
 
   protected
@@ -70,23 +22,6 @@ class RHC::Commands::Base
 
     attr_reader :options, :config
 
-    #
-    # The implicit config object provides no defaults.
-    #
-    def config
-      @config ||= begin
-        RHC::Config.new
-      end
-    end
-
-    def application
-      #@application ||= ... identify current application or throw,
-      #                     indicating one is needed.  Should check
-      #                     options (commands which have it as an ARG
-      #                     should set it onto options), then check
-      #                     current git repo for remote, fail.
-    end
-
     # Return a client object capable of making calls
     # to the OpenShift API that transforms intent
     # and options, to remote calls, and then handle
@@ -94,16 +29,7 @@ class RHC::Commands::Base
     # formatted object output.  Most interactions 
     # should be through this call pattern.
     def rest_client
-      @rest_client ||= begin
-        username = config.username
-        unless username
-          username = ask "Login to #{openshift_server}: "
-          config.config_user(username)
-        end
-        config.password = config.password || RHC::get_password
-
-        RHC::Rest::Client.new(openshift_rest_node, username, config.password, @options.debug)
-      end
+      @rest_client ||= client_from_options(:auth => RHC::Auth::Basic.new(options))
     end
 
     def help(*args)
@@ -149,7 +75,13 @@ class RHC::Commands::Base
     end
 
     def self.description(*args)
-      options[:description] = args.join(' ')
+      o = args.join(' ')
+      indent = o.scan(/^[ \t]*(?=\S)/).min.size || 0
+      options[:description] =
+        o.gsub(/^[ \t]{#{indent}}/, '').
+          gsub(/(\b)\s*\n(?!\s*\n)(\S)/m, '\1 \2').
+          gsub(/\n+\Z/, '').
+          gsub(/\n{3,}/, "\n\n")
     end
     def self.summary(value)
       options[:summary] = value
@@ -196,6 +128,7 @@ class RHC::Commands::Base
       args_metadata << {:name => name,
                         :description => description,
                         :switches => switches,
+                        :context_helper => options[:context],
                         :option_symbol => option_symbol,
                         :arg_type => arg_type}
     end

data/lib/rhc/commands/cartridge.rb

@@ -8,27 +8,29 @@ module RHC::Commands
     alias_action :"app cartridge", :root_command => true, :deprecated => true
     default_action :list
 
-    summary "List supported embedded cartridges"
+    summary "List available cartridges"
+    option ["-v", "--verbose"], "Display more details about each cartridge"
     alias_action :"app cartridge list", :root_command => true, :deprecated => true
     def list
-      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']
+      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| 
+          name = c.display_name != c.name && "#{color(c.display_name, :cyan)} [#{c.name}]" || c.name
+          tags = c.tags - RHC::Rest::Cartridge::HIDDEN_TAGS
+          [
+            underline("#{name} (#{c.only_in_new? ? 'web' : 'addon'})"),
+            c.description,
+            tags.present? ? "\nTagged with: #{tags.sort.join(', ')}" : nil,
+          ].compact << "\n"
+        end.flatten
+      else
+        table(carts.map{ |c| [c.name, c.display_name, c.only_in_new? ? 'web' : 'addon'] })
+      end
 
-      paragraph{ say "Use the short name of a cartridge when interacting with your applications." }
 
-      say table(list).join("\n")
+      say list.join("\n")
+      paragraph{ say "Note: Web cartridges can only be added to new applications." }
 
       0
     end
@@ -42,14 +44,17 @@ module RHC::Commands
     def add(cart_type)
       cart = find_cartridge rest_client, cart_type
 
-      say "Adding '#{cart.name}' to application '#{options.app}'"
+      say "Adding #{cart.name} to application '#{options.app}' ... "
 
       rest_domain = rest_client.find_domain(options.namespace)
       rest_app = rest_domain.find_application(options.app)
       rest_cartridge = rest_app.add_cartridge(cart.name)
-      say "Success"
 
-      display_cart(rest_cartridge,rest_cartridge.properties[:cart_data])
+      success "Success"
+
+      paragraph{ display_cart(rest_cartridge) }
+
+      results{ rest_cartridge.messages.each { |msg| success msg } }
 
       0
     end
@@ -64,7 +69,7 @@ module RHC::Commands
       rest_app = rest_domain.find_application(options.app)
       rest_cartridge = find_cartridge rest_app, cartridge, nil
 
-      display_cart(rest_cartridge,rest_cartridge.properties[:cart_data])
+      display_cart(rest_cartridge)
 
       0
     end
@@ -74,20 +79,20 @@ module RHC::Commands
     argument :cartridge, "The name of the cartridge you are removing", ["-c", "--cartridge cartridge"]
     option ["-n", "--namespace namespace"], "Namespace of the application you are removing the cartridge from", :context => :namespace_context, :required => true
     option ["-a", "--app app"], "Application you are removing the cartridge from", :context => :app_context, :required => true
-    option ["--confirm"], "Safety switch - if this switch is not passed a warning is printed out and the cartridge will not be removed"
+    option ["--confirm"], "Pass to confirm removing the cartridge"
     alias_action :"app cartridge remove", :root_command => true, :deprecated => true
     def remove(cartridge)
-      unless options.confirm
-        results { say "Removing a cartridge is a destructive operation that may result in loss of data associated with the cartridge.  You must pass the --confirm switch to this command in order to to remove the cartridge." }
-        return 1
-      end
 
       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"
+
+      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}'?"
+
+      say "Removing #{rest_cartridge.name} from '#{rest_app.name}' ... "
       rest_cartridge.destroy
+      success "removed"
 
-      results { say "Success: Cartridge '#{rest_cartridge.name}' removed from application '#{rest_app.name}'." }
       0
     end
 
@@ -140,12 +145,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)
-      msgs = rest_cartridge.status
-      results {
-        msgs.each do |msg|
-          say msg['message']
-        end
-      }
+      results { rest_cartridge.status.each{ |msg| say msg['message'] } }
       0
     end
 
@@ -184,8 +184,8 @@ module RHC::Commands
       })
 
       results do
-        say "Success: Scaling values updated"
-        display_cart(cart)
+        paragraph{ display_cart(cart) }
+        success "Success: Scaling values updated"
       end
 
       0

data/lib/rhc/commands/domain.rb

@@ -41,28 +41,35 @@ module RHC::Commands
       0
     end
 
-    summary "Display the applications in your domain"
+    summary "Display your domain and any applications"
     def show
       domain = rest_client.domains.first
 
-      display_domain(domain)
+      warn "In order to deploy applications, you must create a domain with 'rhc setup' or 'rhc domain create'." and return 1 unless domain
+
+      applications = domain.applications(:include => :cartridges)
+
+      if applications.present?
+        header "Applications in #{domain.id} domain" do
+          applications.each do |a|
+            display_app(a,a.cartridges)
+          end
+        end
+        success "You have #{applications.length} applications in your domain."
+      else
+        success "The domain #{domain.id} exists but has no applications. You can use 'rhc app create' to create a new application."
+      end
 
       0
     end
 
-    summary "Run a status check on your domain"
+    summary "DEPRECATED use 'setup' instead"
+    deprecated 'rhc setup'
+    # :nocov:
     def status
-      args = []
-
-      options.__hash__.each do |key, value|
-        value = value.to_s
-        if value.length > 0 && value.to_s.strip.length == 0; value = "'#{value}'" end
-        args << "--#{key} #{value}"
-      end
-
-      Kernel.system("rhc-chk #{args.join(' ')} 2>&1")
-      $?.exitstatus.nil? ? 1 : $?.exitstatus
+      1 # return error status
     end
+    # :nocov:
 
     summary "Deletes your domain."
     syntax "<namespace>"

data/lib/rhc/commands/git_clone.rb

@@ -0,0 +1,30 @@
+require 'rhc/commands/base'
+require 'rhc/git_helpers'
+
+module RHC::Commands
+  class GitClone < Base
+    summary "Clone and configure an application's repository locally"
+    description "This is a convenience wrapper for 'git clone' with the added",
+                "benefit of adding configuration data such as the application's",
+                "UUID to the local repository.  It also automatically",
+                "figures out the git url from the application name so you don't",
+                "have to look it up."
+    syntax "<app> [--namespace namespace]"
+    option ["-n", "--namespace namespace"], "Namespace of the application", :context => :namespace_context, :required => true
+    option ["-r", "--repo dir"], "Path to the Git repository (defaults to ./$app_name)"
+    argument :app, "The application you wish to clone", ["-a", "--app name"]
+    alias_action 'app git-clone', :deprecated => true, :root_command => true
+    # TODO: Implement default values for arguments once ffranz has added context arguments
+    # argument :directory, "The name of a new directory to clone into", [], :default => nil
+    def run(app_name)
+      domain = rest_client.find_domain(options.namespace)
+      app = domain.find_application(app_name)
+      git_clone_application(app)
+
+      0
+    end
+
+    private
+      include RHC::GitHelpers
+  end
+end

data/lib/rhc/commands/{port-forward.rb → port_forward.rb}

@@ -180,10 +180,10 @@ module RHC::Commands
         raise RHC::PortForwardFailedException.new("#{e.message + "\n" if options.debug}Error trying to forward ports. You can try to forward manually by running:\n" + ssh_cmd.join(" "))
       end
 
-      return 0
-    rescue RestClient::Exception => e
+      0
+    rescue RHC::Rest::ConnectionException => e
       error "Connection to #{openshift_server} failed: #{e.message}"
-      return 1
+      1
     end
   end
 end

data/lib/rhc/commands/server.rb

@@ -1,28 +1,40 @@
-require 'rhc/commands/base'
-
 module RHC::Commands
   class Server < Base
     suppress_wizard
 
     summary "Display information about the status of the OpenShift service."
-    description "Retrieves any open issues or notices about the operation of the OpenShift service and displays them in the order they were opened."
+    description <<-DESC
+      Retrieves any open issues or notices about the operation of the
+      OpenShift service and displays them in the order they were opened.
+
+      When connected to an OpenShift Enterprise server, will only display
+      the version of the API that it is connecting to.
+      DESC
     def run
-      status = decode_json(get("#{openshift_url}/app/status/status.json").body)
-      open = status['open']
+      say "Connected to #{openshift_server}"
 
-      (success 'All systems running fine' and return 0) if open.blank?
+      if openshift_online_server?
+        #status = decode_json(get("#{openshift_url}/app/status/status.json").body)
+        status = rest_client.request(:method => :get, :url => "#{openshift_url}/app/status/status.json", :lazy_auth => true){ |res| decode_json(res.content) }
+        open = status['open']
 
-      open.each do |i|
-        i = i['issue']
-        say color("%-3s %s" % ["##{i['id']}", i['title']], :bold)
-        items = i['updates'].map{ |u| [u['description'], date(u['created_at'])] }
-        items.unshift ['Opened', date(i['created_at'])]
-        table(items, :align => [nil,:right], :join => '  ').each{ |s| say "    #{s}" }
-      end
-      say "\n"
-      warn pluralize(open.length, "open issue")
+        (success 'All systems running fine' and return 0) if open.blank?
 
-      open.length #exit with the count of open items
+        open.each do |i|
+          i = i['issue']
+          say color("%-3s %s" % ["##{i['id']}", i['title']], :bold)
+          items = i['updates'].map{ |u| [u['description'], date(u['created_at'])] }
+          items.unshift ['Opened', date(i['created_at'])]
+          table(items, :align => [nil,:right], :join => '  ').each{ |s| say "    #{s}" }
+        end
+        say "\n"
+        warn pluralize(open.length, "open issue")
+
+        open.length #exit with the count of open items
+      else
+        success "Using API version #{rest_client.api_version_negotiated}"
+        0
+      end
     end
   end
 end

data/lib/rhc/commands/setup.rb

@@ -6,7 +6,24 @@ module RHC::Commands
   class Setup < Base
     suppress_wizard
 
-    summary "Easy to use wizard for getting started with OpenShift."
+    summary "Connects to OpenShift and sets up your keys and domain"
+    description <<-DESC
+      Connects to an OpenShift server to get you started. Will help you 
+      configure your SSH keys, set up a domain, and check for any potential 
+      problems with Git or SSH.
+
+      Any options you pass to the setup command will be stored in a
+      .openshift/express.conf file in your home directory. If you run 
+      setup at a later time, any previous configuration will be reused.
+
+
+      Pass the --clean option to ignore your saved configuration and only
+      use options you pass on the command line. Pass --config FILE to use
+      default values from another config (the values will still be written
+      to .openshift/express.conf).
+      DESC
+    option ["--server NAME"], "Hostname of an OpenShift server", :context => :server_context, :required => true
+    option ['--clean'], "Ignore any saved configuration options"
     def run
       raise OptionParser::InvalidOption, "Setup can not be run with the --noprompt option" if options.noprompt
       RHC::RerunWizard.new(config, options).run ?  0 : 1