rhc 0.97.17 → 0.98.16

data/lib/rhc/commands/port-forward.rb

@@ -0,0 +1,81 @@
+require 'rhc/commands/base'
+require 'uri'
+
+module RHC::Commands
+  class PortForward < Base
+
+    IP_AND_PORT = /[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\:[0-9]{1,5}/
+
+    summary "Forward remote ports to the workstation"
+    option ["-n", "--namespace namespace"], "Namespace of the application you are port forwarding to", :context => :namespace_context, :required => true
+    argument :app, "Application you are port forwarding to (required)", ["-a", "--app app"]
+    option ["--timeout timeout"], "Timeout, in seconds, for the session"
+    def run(app)
+
+      rest_domain = rest_client.find_domain options.namespace
+      rest_app = rest_domain.find_application app
+
+      raise RHC::ScaledApplicationsNotSupportedException.new "This utility does not currently support scaled applications. You will need to set up port forwarding manually." if (rest_app.embedded.keys.any?{ |k| k =~ /\Ahaproxy/ })
+
+      ssh_uri = URI.parse(rest_app.ssh_url)
+      say "Using #{rest_app.ssh_url}..." if options.debug
+
+      hosts_and_ports = []
+      hosts_and_ports_descriptions = []
+
+      begin
+
+        say "Checking available ports..."
+
+        Net::SSH.start(ssh_uri.host, ssh_uri.user) do |ssh|
+
+          ssh.exec! "rhc-list-ports" do |channel, stream, data|
+            if stream == :stderr
+              data.each_line do |line|
+                line.chomp!
+                raise RHC::PermissionDeniedException.new "Permission denied." if line =~ /permission denied/i
+                hosts_and_ports_descriptions << line if line.index(IP_AND_PORT)
+              end
+            else
+              data.each_line do |line|
+                line.chomp!
+                hosts_and_ports << line if ((not line =~ /scale/i) and IP_AND_PORT.match(line))
+              end
+            end
+          end
+
+          raise RHC::NoPortsToForwardException.new "There are no available ports to forward for this application. Your application may be stopped." if hosts_and_ports.length == 0
+
+          hosts_and_ports_descriptions.each { |description| say "Binding #{description}..." }
+
+          begin
+            Net::SSH.start(ssh_uri.host, ssh_uri.user) do |ssh|
+              say "Forwarding ports, use ctl + c to stop"
+              hosts_and_ports.each do |host_and_port|
+                host, port = host_and_port.split(/:/)
+                ssh.forward.local(host, port.to_i, host, port.to_i)
+              end
+              ssh.loop { true }
+            end
+          rescue Interrupt
+            results { say "Ending port forward" }
+            return 0
+          end
+
+        end
+
+      rescue Timeout::Error, Errno::EADDRNOTAVAIL, Errno::EADDRINUSE, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Net::SSH::AuthenticationFailed => e
+        ssh_cmd = "ssh -N "
+        hosts_and_ports.each { |port| ssh_cmd << "-L #{port}:#{port} " }
+        ssh_cmd << "#{ssh_uri.user}@#{ssh_uri.host}"
+        raise RHC::PortForwardFailedException.new("#{e.message if options.debug}\nError trying to forward ports. You can try to forward manually by running:\n" + ssh_cmd)
+      end
+
+      return 0
+    end
+  end
+end
+
+# mock for windows
+if defined?(UNIXServer) != 'constant' or UNIXServer.class != Class then class UNIXServer; end; end
+

data/lib/rhc/commands/setup.rb

@@ -6,7 +6,7 @@ module RHC::Commands
   class Setup < Base
     suppress_wizard
 
-    summary "Runs the setup wizard to configure your OpenShift account."
+    summary "Easy to use wizard for getting started with OpenShift."
     def run
       RHC::RerunWizard.new(config).run ?  0 : 1
     end

data/lib/rhc/commands/sshkey.rb

@@ -0,0 +1,95 @@
+#! /usr/bin/env ruby
+
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Sshkey < Base
+    include RHC::SSHKeyHelpers
+    
+    summary 'Manage multiple keys for the registered rhcloud user.'
+    syntax '<action>'
+    default_action :list
+    
+    summary 'Display all the SSH keys for the user account'
+    syntax ''
+    option ["--timeout timeout"], "Timeout, in seconds, for the session"
+    def list
+      ssh_keys = rest_client.sshkeys
+      results do
+        result = ''
+
+        ssh_keys.each do |key|
+          result += format(key, erb)
+        end
+        
+        say result
+      end
+      
+      0
+    end
+    
+    summary 'List the SSH key with the given name'
+    syntax '<name>'
+    argument :name, 'SSH key to display', []
+    option ["--timeout timeout"], "Timeout, in seconds, for the session"
+    def show(name)
+      key = rest_client.find_key(name)
+      say format(key, erb)
+      
+      0
+    end
+
+    summary 'Add SSH key to the user account'
+    syntax '<name> <SSH Key file>'
+    argument :name, 'Name for this key', []
+    argument :key, 'SSH public key filepath', []
+    option ["--timeout timeout"], "Timeout, in seconds, for the session"
+    def add(name, key)
+      begin
+        file = File.open(key)
+      rescue Errno::ENOENT => e
+        raise ::RHC::KeyFileNotExistentException.new("File '#{key}' does not exist.")
+      rescue Errno::EACCES => e
+        raise ::RHC::KeyFileAccessDeniedException.new("Access denied to '#{key}'.")
+      end
+      type, content, comment = file.gets.chomp.split
+      
+      # validate the user input before sending it to the server
+      begin
+        Net::SSH::KeyFactory.load_data_public_key "#{type} #{content}"
+      rescue NotImplementedError, Net::SSH::Exception => e
+        raise ::RHC::KeyDataInvalidException.new("File '#{key}' contains invalid data")
+      end
+
+      rest_client.add_key(name, content, type)
+      results { say "SSH key #{key} has been added as '#{name}'" }
+      
+      0
+    end
+
+    summary 'Remove SSH key from the user account'
+    syntax '<name>'
+    alias_action :delete
+    argument :name, 'SSH key to remove', []
+    option ["--timeout timeout"], "Timeout, in seconds, for the session"
+    def remove(name)
+      rest_client.delete_key(name)
+      results { say "SSH key '#{name}' has been removed" }
+      
+      0
+    end
+    
+    private
+    # shared ERB template for formatting SSH Key
+    def erb
+      return @erb if @erb # cache
+      @erb = ERB.new <<-FORMAT
+       Name: <%= key.name %>
+       Type: <%= key.type %>
+Fingerprint: <%= key.fingerprint %>
+
+      FORMAT
+    end
+    
+  end
+end

data/lib/rhc/config.rb

@@ -2,77 +2,95 @@ require 'rhc/vendor/parseconfig'
 require 'rhc/core_ext'
 
 module RHC
-  module Config
-    def self.read_config_files
-      @@global_config = RHC::Vendor::ParseConfig.new(@@global_config_path) if File.exists?(@@global_config_path)
-      @@local_config = RHC::Vendor::ParseConfig.new(File.expand_path(@@local_config_path)) if File.exists?(@@local_config_path)
+  class Config
+
+    def self.default
+      @default ||= begin
+        RHC::Config.new
+      end.tap do |c|
+        c.read_config_files
+      end
+    end
+
+    def self.method_missing(method, *args, &block)
+      if default.respond_to?(method)
+        default.send(method, *args, &block)
+      else
+        raise NoMethodError, method
+      end
+    end
+
+    def self.initialize
+      @default = nil
+      default
+    end
+
+    def initialize
+      set_defaults
+
+      _gem_cfg = File.join(File.expand_path(File.dirname(__FILE__) + "/../../conf"), @conf_name)
+      @global_config_path = File.exists?(@_linux_cfg) ? @_linux_cfg : _gem_cfg
+    end
+
+    def read_config_files
+      @global_config = RHC::Vendor::ParseConfig.new(@global_config_path) if File.exists?(@global_config_path)
+      @local_config = RHC::Vendor::ParseConfig.new(File.expand_path(@local_config_path)) if File.exists?(@local_config_path)
     rescue Errno::EACCES => e
       raise Errno::EACCES.new("Could not open config file: #{e.message}")
     end
 
-    def self.set_defaults
-      @@defaults = RHC::Vendor::ParseConfig.new()
-      @@global_config = nil
-      @@local_config = nil
-      @@opts_config = nil # config file passed in the options
-      @@opts  = RHC::Vendor::ParseConfig.new() # option switches that override config file
-      @@default_proxy = nil
-      @@env_config = RHC::Vendor::ParseConfig.new()
+    def set_defaults
+      @defaults = RHC::Vendor::ParseConfig.new()
+      @global_config = nil
+      @local_config = nil
+      @opts_config = nil # config file passed in the options
+      @opts  = RHC::Vendor::ParseConfig.new() # option switches that override config file
+      @default_proxy = nil
+      @env_config = RHC::Vendor::ParseConfig.new()
 
-      @@defaults.add('libra_server', 'openshift.redhat.com')
-      @@env_config.add('libra_server', ENV['LIBRA_SERVER']) if ENV['LIBRA_SERVER']
+      @defaults.add('libra_server', 'openshift.redhat.com')
+      @env_config.add('libra_server', ENV['LIBRA_SERVER']) if ENV['LIBRA_SERVER']
       #
       # Config paths... /etc/openshift/express.conf or $GEM/conf/express.conf -> ~/.openshift/express.conf
       #
-      @@conf_name = 'express.conf'
-      @@home_dir = File.expand_path("~")
-      @@home_conf_path = File.join(@@home_dir, '.openshift')
-      @@local_config_path = File.join(@@home_conf_path, @@conf_name)
+      @conf_name = 'express.conf'
+      @home_dir = File.expand_path("~")
+      @home_conf_path = File.join(@home_dir, '.openshift')
+      @local_config_path = File.join(@home_conf_path, @conf_name)
 
       # config path passed in on the command line
-      @@opts_config_path = nil
+      @opts_config_path = nil
 
       # authoritive config path
-      # this can be @@local_config_path or @@opts_config_path
-      # @@opts_config_path trumps
+      # this can be @local_config_path or @opts_config_path
+      # @opts_config_path trumps
       # this is used to determine where config options should be written to
       # when a script modifies the config such as in rhc setup
-      @@config_path = @@local_config_path
+      @config_path = @local_config_path
 
-      @@ssh_priv_key_file_path = "#{@@home_dir}/.ssh/id_rsa"
-      @@ssh_pub_key_file_path = "#{@@home_dir}/.ssh/id_rsa.pub"
- 
-      @@_linux_cfg = '/etc/openshift/' + @@conf_name
-      @@global_config_path = @@_linux_cfg
-    end
+      @ssh_priv_key_file_path = "#{@home_dir}/.ssh/id_rsa"
+      @ssh_pub_key_file_path = "#{@home_dir}/.ssh/id_rsa.pub"
 
-    def self.initialize
-      set_defaults
-
-      _gem_cfg = File.join(File.expand_path(File.dirname(__FILE__) + "/../../conf"), @@conf_name)
-      @@global_config_path = File.exists?(@@_linux_cfg) ? @@_linux_cfg : _gem_cfg
-
-      read_config_files
+      @_linux_cfg = '/etc/openshift/' + @conf_name
+      @global_config_path = @_linux_cfg
     end
 
-    self.initialize
-
     # used for tests
-    def self.home_dir=(home_dir)
-      @@home_dir=home_dir
-      @@home_conf_path = File.join(@@home_dir, '.openshift')
-      @@local_config_path = File.join(@@home_conf_path, @@conf_name)
-      @@local_config = nil
-      @@local_config = RHC::Vendor::ParseConfig.new(File.expand_path(@@local_config_path)) if File.exists?(@@local_config_path)
-      @@ssh_priv_key_file_path = "#{@@home_dir}/.ssh/id_rsa"
-      @@ssh_pub_key_file_path = "#{@@home_dir}/.ssh/id_rsa.pub"
+    def home_dir=(home_dir)
+      @home_dir=home_dir
+      @home_conf_path = File.join(@home_dir, '.openshift')
+      @local_config_path = File.join(@home_conf_path, @conf_name)
+      @local_config = nil
+      @local_config = RHC::Vendor::ParseConfig.new(File.expand_path(@local_config_path)) if File.exists?(@local_config_path)
+      @ssh_priv_key_file_path = "#{@home_dir}/.ssh/id_rsa"
+      @ssh_pub_key_file_path = "#{@home_dir}/.ssh/id_rsa.pub"
     end
 
-    def self.[](key)
+    def [](key)
       raise KeyError("Please use RHC::Config.password to access the password config") if key == "password"
 
       # evaluate in cascading order
-      configs = [@@opts, @@opts_config, @@env_config, @@local_config, @@global_config, @@defaults]
+      configs = [@opts, @opts_config, @env_config, @local_config, @global_config, @defaults]
       result = nil
       configs.each do |conf|
         result = conf[key] if !conf.nil?
@@ -82,45 +100,37 @@ module RHC
       result
     end
 
-    def self.get_value(key)
+    def get_value(key)
       self[key]
     end
 
-    def self.username
+    def username
       self['default_rhlogin']
     end
 
     # Public: configures the default user for this session
-    def self.config_user(username)
-      @@defaults.add('default_rhlogin', username)
+    def config_user(username)
+      @defaults.add('default_rhlogin', username)
     end
 
-    def self.opts_login=(username)
-      @@opts.add('default_rhlogin', username)
+    def opts_login=(username)
+      @opts.add('default_rhlogin', username)
     end
 
     # password is not allowed in config files and can only be passed on comman line
-    def self.password=(password)
-      @@opts.add('password', password)
+    def password=(password)
+      @opts.add('password', password)
     end
 
-    def self.password
-      @@opts['password']
+    def password
+      @opts['password']
     end
 
-    def self.noprompt(bool)
-      @@opts.add('noprompt', bool)
-    end
-
-    def self.noprompt?
-      @@opts['noprompt']
-    end
-
-    def self.set_local_config(confpath, must_exist=true)
+    def set_local_config(confpath, must_exist=true)
       begin
-        @@local_config_path = File.expand_path(confpath)
-        @@config_path = @@local_config_path if @@opts_config_path.nil?
-        @@local_config = RHC::Vendor::ParseConfig.new(@@local_config_path)
+        @local_config_path = File.expand_path(confpath)
+        @config_path = @local_config_path if @opts_config_path.nil?
+        @local_config = RHC::Vendor::ParseConfig.new(@local_config_path)
       rescue Errno::EACCES => e
         if must_exist
           raise Errno::EACCES.new "Could not open config file: #{e.message}"
@@ -128,17 +138,17 @@ module RHC
       end
     end
 
-    def self.set_opts_config(confpath)
+    def set_opts_config(confpath)
       begin
-        @@opts_config_path = File.expand_path(confpath)
-        @@config_path = @@opts_config_path
-        @@opts_config = RHC::Vendor::ParseConfig.new(@@opts_config_path) if File.exists?(@@opts_config_path)
+        @opts_config_path = File.expand_path(confpath)
+        @config_path = @opts_config_path
+        @opts_config = RHC::Vendor::ParseConfig.new(@opts_config_path) if File.exists?(@opts_config_path)
       rescue Errno::EACCES => e
         raise Errno::EACCES.new "Could not open config file: #{e.message}"
       end
     end
 
-    def self.check_cpath(opts)
+    def check_cpath(opts)
       unless opts["config"].nil?
         opts_config_path = File.expand_path(opts["config"])
         if !File.readable?(opts_config_path)
@@ -149,25 +159,20 @@ module RHC
       end
     end
 
-    def self.has_global_config?
-      !@@global_config.nil?
-    end
-
-    def self.has_local_config?
-      !@@local_config.nil?
+    def has_global_config?
+      !@global_config.nil?
     end
 
-    def self.has_opts_config?
-      !@@opts_config.nil?
+    def has_local_config?
+      !@local_config.nil?
     end
 
-    # Public: convinience function to see if we should run the wizard
-    def self.should_run_wizard?
-      not (has_local_config? or has_opts_config? or noprompt?)
+    def has_opts_config?
+      !@opts_config.nil?
     end
 
-    def self.should_run_ssh_wizard?
-      not File.exists? @@ssh_priv_key_file_path
+    def should_run_ssh_wizard?
+      not File.exists? @ssh_priv_key_file_path
     end
 
     ##
@@ -176,46 +181,46 @@ module RHC
     # authoritive configuration path
     # this is used to determine where config options should be written to
     # when a script modifies the config such as in rhc setup
-    def self.config_path
-      @@config_path
+    def config_path
+      @config_path
     end
 
-    def self.local_config_path
-      @@local_config_path
+    def local_config_path
+      @local_config_path
     end
 
-    def self.home_conf_path
-      @@home_conf_path
+    def home_conf_path
+      @home_conf_path
     end
 
-    def self.home_dir
-      @@home_dir
+    def home_dir
+      @home_dir
     end
 
-    def self.ssh_pub_key_file_path
-      @@ssh_pub_key_file_path
+    def ssh_pub_key_file_path
+      @ssh_pub_key_file_path
     end
 
-    def self.default_rhlogin
+    def default_rhlogin
       get_value('default_rhlogin')
     end
 
-    def self.default_proxy
+    def default_proxy
       #
       # Check for proxy environment
       #
-      if @@default_proxy.nil?
+      if @default_proxy.nil?
         if ENV['http_proxy']
           if ENV['http_proxy']!~/^(\w+):\/\// then
             ENV['http_proxy']="http://" + ENV['http_proxy']
           end
           proxy_uri=URI.parse(ENV['http_proxy'])
-          @@default_proxy = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+          @default_proxy = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
         else
-          @@default_proxy = Net::HTTP
+          @default_proxy = Net::HTTP
         end
       end
-      @@default_proxy
+      @default_proxy
     end
   end
 end