rhc 1.25.3 → 1.26.9

data/lib/rhc/commands/base.rb

@@ -11,8 +11,7 @@ class RHC::Commands::Base
 
   attr_writer :options, :config
 
-  def initialize(options=Commander::Command::Options.new,
-                 config=RHC::Config.new)
+  def initialize(options=Commander::Command::Options.new, config=RHC::Config.new)
     @options, @config = options, config
   end
 
@@ -87,12 +86,15 @@ class RHC::Commands::Base
       o = args.join(' ')
       options[:description] = o.strip_heredoc
     end
+
     def self.summary(value)
       options[:summary] = value
     end
+
     def self.syntax(value)
       options[:syntax] = value
     end
+
     #def self.deprecated(msg)
     #  options[:deprecated] = msg
     #end

data/lib/rhc/commands/member.rb

@@ -219,7 +219,7 @@ module RHC::Commands
 
       Examples
         rhc update-member -n mydomain --role view bob
-          Adds or updates the user with login 'bob' to 'admin' role on mydomain
+          Adds or updates the user with login 'bob' to 'view' role on mydomain
 
         rhc update-member -n mydomain --role admin team1 --type team
           Updates the team member with name 'team1' to the 'admin' role on mydomain

data/lib/rhc/commands/server.rb

@@ -1,16 +1,48 @@
+require 'rhc/servers'
+
 module RHC::Commands
   class Server < Base
     suppress_wizard
 
-    summary "Display information about the status of the OpenShift service"
+    summary "Manage your configured servers and check the status of services"
+    description <<-DESC
+      The 'rhc server' commands allow users to add multiple OpenShift
+      servers to interact with the rhc commands and easily switch between
+      them.
+
+      For example, if an user's company has installations of OpenShift Origin 
+      (development) and Enterprise (production) and the user also has a personal
+      OpenShift Online account:
+
+        rhc server add openshift.redhat.com online -l personal@email.com
+        rhc server add origin.openshift.mycompany.com development -l user@company.com
+        rhc server add enterprise.openshift.mycompany.com production  -l user@company.com
+
+      Then, to switch between the servers:
+
+        rhc server use online
+        rhc server use development
+        rhc server use production
+
+      To list all servers configured:
+
+        rhc servers
+      DESC
+    default_action :help
+
+    summary "Display information about the status of the OpenShift server"
+    syntax "<server>"
     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
+      When connected to an OpenShift Enterprise or Origin server, will only display
       the version of the API that it is connecting to.
       DESC
-    def run
+    argument :server, "Server hostname or nickname to check. If not provided the default server will be used.", ["--server SERVER"], :optional => true
+    def status(server=nil)
+      options.server = server.hostname if server && server = (server_configs.find(server) rescue nil)
+
       say "Connected to #{openshift_server}"
 
       if openshift_online_server?
@@ -36,5 +68,159 @@ module RHC::Commands
         0
       end
     end
+
+    summary "Add a new server"
+    description <<-DESC
+      Add and configure a new OpenShift server that will be available to 
+      use through rhc commands.
+      When adding a new server users can optionally provide a 'nickname'
+      that will allow to easily switch between servers. 
+      DESC
+    syntax "<hostname> [<nickname>] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure]"
+    argument :hostname, "Hostname of the server you are adding", ["--server HOSTNAME"]
+    argument :nickname, "Optionally provide a nickname to the server you are adding (e.g. 'development', 'production', 'online')", ["--nickname NICKNAME"], :optional => true
+    option ["-l", "--rhlogin LOGIN"], "Change the default OpenShift login used on this server"
+    option ["--[no-]use-authorization-tokens"], "Server will attempt to create and use authorization tokens to connect to the server"
+    option ["--[no-]insecure"], "If true, certificate errors will be ignored"
+    option ["--use"], "If provided, the server being added will be set as default (same as 'rhc server use')"
+    option ["--skip-wizard"], "If provided, the wizard will be skipped and a session token will not be estabilished"
+    def add(hostname, nickname)
+      raise ArgumentError, "The --use and --skip-wizard options cannot be used together." if options.use && options.skip_wizard
+
+      attrs = [:login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_ca_file]
+
+      server = server_configs.add(hostname, 
+        attrs.inject({:nickname => nickname}){ |h, (k, v)| h[k] = options[k == :login ? :rhlogin : k]; h })
+
+      unless options.skip_wizard
+        (wizard_to_server(server.hostname, options.use, attrs.inject({}){ |h, (k, v)| h[k] = server.send(k); h }) ? 0 : 1).tap do |r|
+          paragraph { success "Now using '#{server.hostname}'" } if options.use && r == 0
+        end
+      else
+        say "Saving server configuration to #{system_path(server_configs.path)} ... "
+        server_configs.save!
+        success "done"
+        0
+      end
+    end
+
+    summary "List all configured servers"
+    alias_action :"servers", :root_command => true
+    def list
+      servers = config.has_configs_from_files? ? server_configs.list : []
+
+      servers.sort.each do |server|
+        say display_server(server)
+      end
+
+      paragraph do 
+        case servers.length
+        when 0
+          warn "You don't have any servers configured. Use 'rhc setup' to configure your OpenShift server."
+        when 1
+          say "You have 1 server configured. Use 'rhc server add' to add a new server."
+        else
+          say "You have #{servers.length} servers configured. Use 'rhc server use <hostname|nickname>' to switch between them."
+        end
+      end
+      0
+    end
+
+    summary "Change the default server"
+    syntax "<server>"
+    argument :server, "Server hostname or nickname to use", ["--server SERVER"]
+    def use(server)
+      server = server_configs.find(server)
+
+      if wizard_to_server(server.hostname, true, :login => server.login, :use_authorization_tokens => server.use_authorization_tokens, :insecure => server.insecure)
+        paragraph { success "Now using '#{server.hostname}'" }
+        0
+      else
+        1
+      end
+    end
+
+    summary "Remove a server"
+    syntax "<server>"
+    argument :server, "Server hostname or nickname to be removed", ["--server SERVER"]
+    def remove(server)
+      server = server_configs.find(server)
+
+      say "Removing '#{server.hostname}' ... "
+
+      if server.default?
+        raise RHC::ServerInUseException.new("The '#{server.designation}' server is in use. Please switch to another server before removing it.")
+      else
+        server_configs.remove(server.hostname)
+        server_configs.save!
+      end
+
+      success "done"
+      0
+    end
+
+    summary "Update server attributes"
+    syntax "<server> [--hostname HOSTNAME] [--nickname NICKNAME] [--rhlogin LOGIN] [--[no-]use-authorization-tokens] [--[no-]insecure]"
+    argument :server, "Server hostname or nickname to be configured", ["--server SERVER"]
+    option ["--hostname HOSTNAME"], "Change the hostname of this server"
+    option ["--nickname NICKNAME"], "Change the nickname of this server"
+    option ["-l", "--rhlogin LOGIN"], "Change the default OpenShift login used on this server"
+    option ["--[no-]use-authorization-tokens"], "Server will attempt to create and use authorization tokens to connect to the server"
+    option ["--[no-]insecure"], "If true, certificate errors will be ignored"
+    option ["--use"], "If provided, the server being configured will be set as default (same as 'rhc server use')"
+    option ["--skip-wizard"], "If provided, the wizard will be skipped and a session token will not be estabilished"
+    def configure(server)
+      raise ArgumentError, "The --use and --skip-wizard options cannot be used together." if options.use && options.skip_wizard
+
+      server = server_configs.find(server)
+
+      attrs = [:hostname, :nickname, :login, :use_authorization_tokens, :insecure, :timeout, :ssl_version, :ssl_client_cert_file, :ssl_ca_file].inject({}){ |h, (k, v)| v = options[k == :login ? :rhlogin : k]; h[k] = (v.nil? ? server.send(k) : v); h }
+
+      raise RHC::ServerNicknameExistsException.new(options.nickname) if options.nickname && 
+        server_configs.nickname_exists?(options.nickname) && 
+        server_configs.find(options.nickname).hostname != server.hostname
+
+      server = server_configs.update(server.hostname, attrs)
+
+      unless options.skip_wizard
+        wizard_to_server(attrs[:hostname], options.use, attrs.reject{|k, v| k == :hostname || k == :nickname})
+      else
+        say "Saving server configuration to #{system_path(server_configs.path)} ... "
+        server_configs.save!
+        success "done"
+        0
+      end
+
+      paragraph{ say display_server(server) }
+      paragraph { success "Now using '#{server.hostname}'" } if options.use
+      0
+    end
+
+    summary "Display the configuration of the given server"
+    syntax "<server>"
+    argument :server, "Server hostname or nickname to be displayed", ["--server SERVER"]
+    def show(server)
+      server = server_configs.find(server)
+      say display_server(server)
+      paragraph{ say "Use 'rhc servers' to display all your servers." } if server_configs.list.length > 1
+      0
+    end
+
+    protected
+      def wizard_to_server(hostname, set_default, args)
+        options['server'] = hostname
+        options['rhlogin'] = args[:login] if args[:login]
+        options['use_authorization_tokens'] = args[:use_authorization_tokens] unless args[:use_authorization_tokens].nil?
+        options['insecure'] = args[:insecure] unless args[:insecure].nil?
+        options['timeout'] = args[:timeout] unless args[:timeout].nil?
+        options['ssl_version'] = args[:ssl_version] unless args[:ssl_version].nil?
+        options['ssl_client_cert_file'] = args[:ssl_client_cert_file] unless args[:ssl_client_cert_file].nil?
+        options['ssl_ca_file'] = args[:ssl_ca_file] unless args[:ssl_ca_file].nil?
+        RHC::ServerWizard.new(config, options, server_configs, set_default).run
+      end
+
+      def server_configs
+        @servers ||= RHC::Servers.new(config)
+      end
   end
 end

data/lib/rhc/commands/setup.rb

@@ -27,7 +27,7 @@ module RHC::Commands
       If you would like to enable tab-completion in Bash shells, pass
       --autocomplete for more information.
       DESC
-    option ["--server NAME"], "Hostname of an OpenShift server", :default => :server_context, :required => true
+    option ["--server HOSTNAME"], "Hostname of an OpenShift server", :default => :server_context, :required => true
     option ['--clean'], "Ignore any saved configuration options"
     option ['--[no-]create-token'], "Create an authorization token for this server"
     option ['--autocomplete'], "Instructions for enabling tab-completion"

data/lib/rhc/config.rb

@@ -1,5 +1,8 @@
+require 'fileutils'
 require 'rhc/vendor/parseconfig'
 require 'rhc/core_ext'
+require 'rhc/servers'
+require 'rhc/server_helpers'
 
 module RHC
 
@@ -45,24 +48,24 @@ module RHC
   #
   class Config
     include ConfigEnv
+    include RHC::ServerHelpers
 
     # Option name     [config_key      type           comment_string_for_config]
     #                  if nil, == key  nil == string  won't be written to file if nil
     OPTIONS = {
-      :server =>      ['libra_server', nil, 'The OpenShift server to connect to'],
-      :rhlogin =>     ['default_rhlogin', nil, 'Your OpenShift login name'],
-      :password =>    nil,
-      :use_authorization_tokens =>
-                      [nil, :boolean, 'If true, the server will attempt to create and use authorization tokens to connect to the server'],
-      :timeout =>     [nil, :integer, 'The default timeout for network operations'],
-      :insecure =>    [nil, :boolean, "If true, certificate errors will be ignored.\nWARNING: This may allow others to eavesdrop on your communication with OpenShift."],
-      :ssl_version => [nil, nil, 'The SSL protocol version to use when connecting to this server'],
-      :ssl_client_cert_file => [nil, :path_to_file, 'A client certificate file for use with your server'],
-      :ssl_ca_file => [nil, :path_to_file, 'A file containing CA one or more certificates'],
+      :server                   => ['libra_server',    nil,           'The default OpenShift server to connect to'],
+      :rhlogin                  => ['default_rhlogin', nil,           'Your OpenShift login name'],
+      :password                 => nil,
+      :use_authorization_tokens => [nil,               :boolean,      'If true, the server will attempt to create and use authorization tokens to connect to the server'],
+      :timeout                  => [nil,               :integer,      'The default timeout for network operations'],
+      :insecure                 => [nil,               :boolean,      "If true, certificate errors will be ignored.\nWARNING: This may allow others to eavesdrop on your communication with OpenShift."],
+      :ssl_version              => [nil,               nil,           'The SSL protocol version to use when connecting to this server'],
+      :ssl_client_cert_file     => [nil,               :path_to_file, 'A client certificate file for use with your server'],
+      :ssl_ca_file              => [nil,               :path_to_file, 'A file containing CA one or more certificates'],
     }
 
-    def self.options_to_config(options)
-      OPTIONS.inject([]) do |arr, (name, opts)|
+    def self.options_to_config(options, args=OPTIONS.keys)
+      OPTIONS.select{|k,v| args ? args.include?(k) : true}.inject([]) do |arr, (name, opts)|
         opts ||= []
         next arr unless opts[2]
         value = options[name]
@@ -70,7 +73,8 @@ module RHC
         arr << "#{value.nil? ? '#' : ''}#{opts[0] || name}=#{self.type_to_config(opts[1], value)}"
         arr << ""
         arr
-      end.join("\n")
+      end.unshift(!args.nil? && args.length < OPTIONS.length ? 
+        ["# Check servers.yml for detailed server configuration", ""] : nil).flatten.compact.join("\n")
     end
 
     def self.type_to_config(type, value)
@@ -121,56 +125,83 @@ module RHC
       @global_config = nil
       @local_config = nil
       @opts_config = nil # config file passed in the options
+      @additional_config = nil
 
       @default_proxy = nil
 
-      @defaults.add('libra_server', 'openshift.redhat.com')
-      @env_config.add('libra_server', ENV['LIBRA_SERVER']) if ENV['LIBRA_SERVER']
-      @env_config.add('libra_server', ENV['RHC_SERVER']) if ENV['RHC_SERVER']
+      @defaults.add('insecure', false)
+      @defaults.add('libra_server', openshift_online_server)
+
+      @env_config.add('libra_server', libra_server_env) if libra_server_env
+      @env_config.add('libra_server', rhc_server_env) if rhc_server_env
 
       @opts_config_path = nil
     end
 
     def to_options
       OPTIONS.inject({}) do |h, (name, opts)|
-          opts = Array(opts)
-          value = self[opts[0] || name.to_s]
-          if value
-            value = case opts[1]
-                    when :integer
-                      Integer(value)
-                    when :boolean
-                      !!(value =~ /^\s*(y|yes|1|t|true)\s*$/i)
-                    else
-                      value unless value.blank?
-                    end
-            h[name] = value unless value.nil?
-          end
-          h
+        opts = Array(opts)
+        value = self[opts[0] || name.to_s]
+        unless value.nil?
+          value = case opts[1]
+                  when :integer
+                    Integer(value)
+                  when :boolean
+                    value.is_a?(TrueClass) || !!(value =~ /^\s*(y|yes|1|t|true)\s*$/i)
+                  else
+                    value unless value.blank?
+                  end
+          h[name] = value
         end
+        h
+      end
     end
 
-    def save!(options)
-      File.open(path, 'w'){ |f| f.puts self.class.options_to_config(options) }
-      @opts, @opts_config, @local_config, @global_config = nil
+    def backup
+      if File.exists? path
+        backup = "#{path}.bak"
+        FileUtils.cp(path, backup)
+      end
+    end
+
+    def save!(options, fields=nil)
+      File.open(path, 'w') do |f| 
+        f.puts self.class.options_to_config(
+          options, 
+          fields
+        )
+      end
+      @opts, @opts_config, @env_config, @additional_config, @local_config, @global_config = nil
       load_config_files
       self
     end
 
     def [](key)
       lazy_init
-
-      # evaluate in cascading order
-      configs = [@opts, @opts_config, @env_config, @local_config, @global_config, @defaults]
+      configs = configs_cascade
       result = nil
-      configs.each do |conf|
+      c = nil
+      configs.each_with_index do |conf, i|
         result = conf[key] if !conf.nil?
+        c = conf
         break if !result.nil?
       end
-
       result
     end
 
+    # individual configs will be evaluated in the following cascading order
+    def configs_cascade
+      [
+        @opts, 
+        @opts_config, 
+        @env_config, 
+        @additional_config, 
+        @local_config, 
+        @global_config, 
+        @defaults
+      ]
+    end
+
     # DEPRECATED - will be removed when old commands are gone
     def get_value(key)
       self[key]
@@ -238,6 +269,15 @@ module RHC
       !@opts_config.nil?
     end
 
+    def has_additional_config?
+      lazy_init
+      !@additional_config.nil?
+    end
+
+    def has_configs_from_files?
+      has_local_config? || has_opts_config? || has_additional_config?
+    end
+
     # DEPRECATED - should be moved to Helpers
     def should_run_ssh_wizard?
       not File.exists? ssh_priv_key_file_path
@@ -252,6 +292,7 @@ module RHC
     def config_path
       @config_path ||= local_config_path
     end
+
     def path
       config_path
     end
@@ -294,10 +335,18 @@ module RHC
     # DEPRECATED - will be removed when old commands are gone
     def proxy_vars
       Hash[[:address,:user,:pass,:port].map do |x|
-        [x,default_proxy.instance_variable_get("@proxy_#{x}")]
+        [x, default_proxy.instance_variable_get("@proxy_#{x}")]
       end]
     end
 
+    def servers
+      @servers
+    end
+
+    def sync_additional_config
+      @additional_config = servers_config
+    end
+
     private
       # Allow mocking of the home dir
       def self.home_dir
@@ -311,9 +360,19 @@ module RHC
         raise Errno::EACCES.new("Could not open config file: #{e.message}")
       end
 
+      def load_servers
+        @servers ||= RHC::Servers.new
+      end
+
+      def servers_config
+        lazy_init
+        (servers.find(self['libra_server']).to_config rescue nil) || (servers.list.first.to_config rescue nil)
+      end
+
       def lazy_init
         unless @loaded
           load_config_files
+          load_servers
           @loaded = true
         end
       end