rhc 0.94.8 → 0.95.13

data/lib/rhc/helpers.rb

@@ -1,7 +1,18 @@
 require 'commander/user_interaction'
 require 'rhc/config'
+require 'rhc/commands'
+
+OptionParser.accept(URI) {|s,| URI.parse(s) if s}
 
 module RHC
+
+  module Helpers
+    private
+      def self.global_option(*args)
+        RHC::Commands.global_option *args
+      end
+  end
+
   module Helpers
 
     # helpers always have Commander UI available
@@ -28,15 +39,40 @@ module RHC
       # Replace with d = DateTime.rfc3339(s)
     end
 
+
+    #
+    # Global config
+    #
+
+    global_option '-c', '--config FILE', "Path of a different config file"
+    def config
+      raise "Operations requiring configuration must define a config accessor"
+    end
+
+    global_option '-l', '--rhlogin login', "Red Hat login (RHN or OpenShift login with OpenShift access)"
+    global_option '-p', '--password password', "RHLogin password"
+
     def openshift_server
-      RHC::Config.get_value('libra_server')
+      config.get_value('libra_server')
     end
+    def openshift_url
+      "https://#{openshift_server}"
+    end
+
 
-    def success(*args)
-      args.each{ |a| say color(a, :green) }
+    #
+    # Output helpers
+    #
+
+    def say(msg)
+      super
+      msg
+    end
+    def success(msg, *args)
+      say color(msg, :green)
     end
-    def warn(*args)
-      args.each{ |a| say color(a, :yellow) }
+    def warn(msg, *args)
+      say color(msg, :yellow)
     end
 
     def color(s, color)

data/lib/rhc/ssh_key_helpers.rb

@@ -0,0 +1,72 @@
+###
+# ssh_key_helpers.rb - methods to help manipulate ssh keys
+#
+# Copyright 2012 Red Hat, Inc. and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'net/ssh'
+require 'rhc/vendor/sshkey'
+
+
+module RHC
+  module SSHKeyHelpers
+    # Public: Generate an SSH key and store it in ~/.ssh/id_rsa
+    #
+    # type - The String type RSA or DSS.
+    # bits - The Integer value for number of bits.
+    # comment - The String comment for the key
+    #
+    # Examples
+    #
+    #  generate_ssh_key_ruby()
+    #  # => /home/user/.ssh/id_rsa.pub
+    #
+    # Returns nil on failure or public key location as a String on success
+    def generate_ssh_key_ruby(type="RSA", bits = 2048, comment = "OpenShift-Key")
+      key = RHC::Vendor::SSHKey.generate(:type => type,
+                                         :bits => bits,
+                                         :comment => comment)
+      ssh_dir = "#{RHC::Config.home_dir}/.ssh"
+      if File.exists?("#{ssh_dir}/id_rsa")
+        puts "SSH key already exists: #{ssh_dir}/id_rsa.  Reusing..."
+        return nil
+      else
+        unless File.exists?(ssh_dir)
+          FileUtils.mkdir_p(ssh_dir)
+          File.chmod(0700, ssh_dir)
+        end
+        File.open("#{ssh_dir}/id_rsa", 'w') {|f| f.write(key.private_key)}
+        File.chmod(0600, "#{ssh_dir}/id_rsa")
+        File.open("#{ssh_dir}/id_rsa.pub", 'w') {|f| f.write(key.ssh_public_key)}
+
+        ssh_add if exe?('ssh-add')
+      end
+      "#{ssh_dir}/id_rsa.pub"
+    end
+
+    def exe?(executable)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
+        File.executable?(File.join(directory, executable.to_s))
+      end
+    end
+
+    private
+
+    def ssh_add
+      #:nocov:
+      `ssh-add 2&>1`
+      #:nocov:
+    end
+  end
+end

data/lib/rhc/targz.rb

@@ -3,13 +3,7 @@ require 'rhc/vendor/zliby'
 require 'archive/tar/minitar'
 include Archive::Tar
 
-if File.executable?('/usr/bin/gnutar') then
-  #:nocov:
-  TAR_BIN = '/usr/bin/gnutar'
-  #:nocov:
-else
-  TAR_BIN = 'tar'
-end
+TAR_BIN = File.executable?('/usr/bin/gnutar') ? '/usr/bin/gnutar' : 'tar'
 
 module RHC
 
@@ -20,7 +14,7 @@ module RHC
       return false if ! (File.file? filename and File.basename(filename).downcase =~ /.\.tar\.gz$/i)
 
       contains = false
-      if RHC::Helpers.windows? or force_ruby then
+      if RHC::Helpers.windows? or force_ruby
         search = /#{search.to_s}/ if ! search.is_a?(Regexp)
         begin
           RHC::Vendor::Zlib::GzipReader.open(filename) do |gz|

data/lib/rhc/wizard.rb

@@ -1,5 +1,6 @@
 require 'rhc-common'
 require 'rhc/helpers'
+require 'rhc/ssh_key_helpers'
 require 'highline/system_extensions'
 require 'net/ssh'
 require 'fileutils'
@@ -8,19 +9,28 @@ module RHC
   class Wizard
     include HighLine::SystemExtensions
     include RHC::Helpers
-
-    @@stages = [:greeting_stage,
-                :login_stage,
-                :create_config_stage,
-                :config_ssh_key_stage,
-                :upload_ssh_key_stage,
-                :install_client_tools_stage,
-                :config_namespace_stage,
-                :show_app_info_stage,
-                :finalize_stage]
+    include RHC::SSHKeyHelpers
+
+    STAGES = [:greeting_stage,
+              :login_stage,
+              :create_config_stage,
+              :config_ssh_key_stage,
+              :upload_ssh_key_stage,
+              :install_client_tools_stage,
+              :config_namespace_stage,
+              :show_app_info_stage,
+              :finalize_stage]
+    def stages
+      STAGES
+    end
 
     def initialize(config_path)
       @config_path = config_path
+      if @libra_server.nil?
+        @libra_server = get_var('libra_server')
+        # if not set, set to default
+        @libra_server = @libra_server ?  @libra_server : "openshift.redhat.com"
+      end
     end
 
     # Public: Runs the setup wizard to make sure ~/.openshift and ~/.ssh are correct
@@ -32,7 +42,7 @@ module RHC
     #
     # Returns nil on failure or true on success
     def run
-      @@stages.each do |stage|
+      stages.each do |stage|
         # FIXME: cleanup if we fail
         if (self.send stage).nil?
           return nil
@@ -43,10 +53,6 @@ module RHC
 
     private
 
-    def stages
-      @@stages
-    end
-
     def greeting_stage
       paragraph do
         say "Starting Interactive Setup for OpenShift's command line interface"
@@ -68,18 +74,14 @@ module RHC
     end
 
     def login_stage
-      if @libra_server.nil?
-        @libra_server = get_var('libra_server')
-        # if not set, set to default
-        @libra_server = @libra_server ?  @libra_server : "openshift.redhat.com"
-      end
-
       # get_password adds an extra untracked newline so set :bottom to -1
       section(:top => 1, :bottom => -1) do
         @username = ask("To connect to #{@libra_server} enter your OpenShift login (email or Red Hat login id): ") do |q|
           q.default = RHC::Config.default_rhlogin
         end
-        @password = RHC::get_password
+
+        @password = RHC::Config.password
+        @password = RHC::get_password if @password.nil?
       end
 
       # Confirm username / password works:
@@ -121,29 +123,31 @@ EOF
     end
 
     def config_ssh_key_stage
-      @ssh_priv_key_file_path = "#{RHC::Config.home_dir}/.ssh/id_rsa"
-      @ssh_pub_key_file_path = "#{RHC::Config.home_dir}/.ssh/id_rsa.pub"
-      unless File.exists? @ssh_priv_key_file_path
+      if RHC::Config.should_run_ssh_wizard?
         paragraph do
           say "No SSH keys were found. We will generate a pair of keys for you."
         end
-        @ssh_pub_key_file_path = generate_ssh_key_ruby()
+        ssh_pub_key_file_path = generate_ssh_key_ruby()
         paragraph do
-          say "    Created: #{@ssh_pub_key_file_path}\n\n"
+          say "    Created: #{ssh_pub_key_file_path}\n\n"
         end
       end
       true
     end
 
+    def ssh_keygen_fallback(ssh_pub_key_file_path)
+      `ssh-keygen -lf #{ssh_pub_key_file_path} 2>&1`.split(' ')[1]
+    end
+
     def ssh_key_uploaded?
       @ssh_keys = RHC::get_ssh_keys(@libra_server, @username, @password, RHC::Config.default_proxy)
       additional_ssh_keys = @ssh_keys['keys']
 
       local_fingerprint = nil
       begin
-        local_fingerprint = Net::SSH::KeyFactory.load_public_key(@ssh_pub_key_file_path).fingerprint
+        local_fingerprint = Net::SSH::KeyFactory.load_public_key(RHC::Config.ssh_pub_key_file_path).fingerprint
       rescue NoMethodError #older net/ssh (mac for example)
-        local_fingerprint = `ssh-keygen -lf #{@ssh_pub_key_file_path}`.split(' ')[1]
+        local_fingerprint = ssh_keygen_fallback RHC::Config.ssh_pub_key_file_path
       end
 
       return true if @ssh_keys['fingerprint'] == local_fingerprint
@@ -192,20 +196,19 @@ EOF
         key_fingerprint = nil
         key_valid = true
         begin
-          key_fingerprint = Net::SSH::KeyFactory.load_public_key(@ssh_pub_key_file_path).fingerprint
+          key_fingerprint = Net::SSH::KeyFactory.load_public_key(RHC::Config.ssh_pub_key_file_path).fingerprint
         rescue NoMethodError #older net/ssh (mac for example)
-          key_fingerprint = `ssh-keygen -lf #{@ssh_pub_key_file_path}`.split(' ')[1]
+          key_fingerprint = ssh_keygen_fallback RHC::Config.ssh_pub_key_file_path
           if $?.exitstatus != 0
             key_valid = false
           end
-        rescue Net::SSH::Exception
-        rescue NotImplementedError
+        rescue Net::SSH::Exception, NotImplementedError
           key_valid = false
         end
 
         if ! key_valid
           paragraph do
-            say "Your ssh public key at #{@ssh_pub_key_file_path} can not be read. " \
+            say "Your ssh public key at #{RHC::Config.ssh_pub_key_file_path} can not be read. " \
                 "The setup can not continue until you manually remove or fix both of your " \
                 "public and private keys id_rsa keys."
             end
@@ -224,12 +227,12 @@ EOF
       if known_keys.include?(key_name)
         section do
           say "Key already exists!  Updating key #{key_name} .. "
-          add_or_update_key('update', key_name, @ssh_pub_key_file_path, @username, @password)
+          add_or_update_key('update', key_name, RHC::Config.ssh_pub_key_file_path, @username, @password)
         end
       else
         section do
           say "Sending new key #{key_name} .. "
-          add_or_update_key('add', key_name, @ssh_pub_key_file_path, @username, @password)
+          add_or_update_key('add', key_name, RHC::Config.ssh_pub_key_file_path, @username, @password)
         end
       end
       true
@@ -382,35 +385,41 @@ EOF
             "applications without first creating a namespace."
       end
 
-      namespace = nil
-      paragraph do
-        namespace = ask "Please enter a namespace or leave this blank if you wish to skip this step:" do |q|
-          q.validate = lambda { |p| RHC::check_namespace p }
-        end
-      end
-
-      while !config_namespace namespace do
+      # Ask for a namespace at least once, configure the namespace if a valid,
+      # non-blank string is provided.
+      namespace  = nil
+      first_pass = true
+      while first_pass or !config_namespace namespace do
+        first_pass = false
         paragraph do
           namespace = ask "Please enter a namespace or leave this blank if you wish to skip this step:" do |q|
-            q.validate = lambda { |p| RHC::check_namespace p }
+            q.validate  = lambda{ |p| RHC::check_namespace p }
+            q.responses[:not_valid]    = 'The namespace value must contain only letters and/or numbers (A-Za-z0-9):'
+            q.responses[:ask_on_error] = ''
           end
         end
       end
     end
 
-    def dbus_send_session_method(name, service, obj_path, iface, stringafied_params, wait_for_reply=true)
+    def dbus_send_exec(name, service, obj_path, iface, stringafied_params, wait_for_reply)
+      # :nocov: dbus_send_exec is not safe to run on a test system
       method = "#{iface}.#{name}"
       print_reply = ""
       print_reply = "--print-reply" if wait_for_reply
+
       cmd = "dbus-send --session #{print_reply} --type=method_call \
             --dest=#{service} #{obj_path} #{method} #{stringafied_params}"
-      output = `#{cmd} 2>&1`
+      `cmd 2>&1`
+      # :nocov:
+    end
 
+    def dbus_send_session_method(name, service, obj_path, iface, stringafied_params, wait_for_reply=true)
+      output = dbus_send_exec(name, service, obj_path, iface, stringafied_params, wait_for_reply)
       raise output if output.start_with?('Error') and !$?.success?
 
       # parse the output
       results = []
-      output.each_with_index do |line, i|
+      output.split('\n').each_with_index do |line, i|
         if i != 0 # discard first line
           param_type, value = line.chomp.split(" ", 2)
 
@@ -420,7 +429,7 @@ EOF
           when "string"
             results << value
           else
-            puts "unknown type #{param_type} - treating as string"
+            say "unknown type #{param_type} - treating as string"
             results << value
           end
         end
@@ -513,18 +522,12 @@ We recommend these free applications:
 EOF
     end
 
-    def exe?(executable)
-      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
-        File.executable?(File.join(directory, executable.to_s))
-      end
+    def git_version_exec
+      `git --version 2>&1`
     end
 
     def has_git?
-      begin
-        %x{ git --version }
-      rescue
-      end
-
+      git_version_exec
       $?.success?
     rescue
       false
@@ -581,4 +584,18 @@ EOF
       true
     end
   end
+
+  class SSHWizard < Wizard
+    STAGES = [:config_ssh_key_stage,
+              :upload_ssh_key_stage]
+    def stages
+      STAGES
+    end
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+      super("")
+    end
+  end
 end

data/lib/rhc-common.rb

@@ -176,15 +176,15 @@ end
                        regex_failed_error='contains non-alphanumeric characters!')
     if field
       if field =~ val_regex
-        puts "#{type} " + regex_failed_error
+        say "#{type} " + regex_failed_error
         return false
       end
       if max != 0 && field.length > max
-        puts "maximum #{type} size is #{max} characters"
+        say "maximum #{type} size is #{max} characters"
         return false
       end
     else
-      puts "#{type} is required"
+      say "#{type} is required"
       return false
     end
     field
@@ -306,9 +306,13 @@ end
 
     # Inject public fingerprint into key.
     begin
-      ssh_keys['fingerprint'] = \
-        Net::SSH::KeyFactory.load_data_public_key(
-          "#{ssh_keys['ssh_type']} #{ssh_keys['ssh_key']}").fingerprint
+      if ssh_keys['ssh_type'].nil? or ssh_keys['ssh_type'].empty?
+        ssh_keys['fingerprint'] = nil
+      else
+        ssh_keys['fingerprint'] = \
+          Net::SSH::KeyFactory.load_data_public_key(
+            "#{ssh_keys['ssh_type']} #{ssh_keys['ssh_key']}").fingerprint
+      end
     rescue NoMethodError 
       #older net/ssh (mac for example)
       tempfile = `mktemp /tmp/openshift.XXXXXXXX`
@@ -532,6 +536,9 @@ end
       rescue Rhc::Rest::ValidationException => e
         validation_error_code = (e.code.nil?) ? 406 : e.code
         print_response_err(Struct::FakeResponse.new(e.message, validation_error_code))
+      rescue Rhc::Rest::ServerErrorException => e
+        error_code = (e.code.nil?) ? 500 : e.code
+        print_response_err(Struct::FakeResponse.new(e.message, error_code))
       end
     else
       json_data = generate_json(data)
@@ -864,7 +871,7 @@ LOOKSGOOD
         end
       end
     rescue Exception => e
-      puts e.message
+      puts e.backtrace if debug
       puts "Error in trying to save snapshot.  You can try to save manually by running:"
       puts
       puts ssh_cmd
@@ -877,7 +884,7 @@ LOOKSGOOD
   def self.snapshot_restore(rhc_domain, namespace, app_name, app_uuid, filename, debug=false)
     if File.exists? filename
 
-      if ! RHC::TarGz.contains filename, './*/' + app_name
+      if ! RHC::Helpers.windows? and ! RHC::TarGz.contains filename, './*/' + app_name
 
         puts "Archive at #{filename} does not contain the target application: ./*/#{app_name}"
         puts "If you created this archive rather than exported with rhc-snapshot, be sure"
@@ -887,7 +894,7 @@ LOOKSGOOD
 
       else
 
-        include_git = RHC::TarGz.contains filename, './*/git'
+        include_git = RHC::Helpers.windows? ? false : RHC::TarGz.contains(filename, './*/git')
 
         ssh_cmd = "cat #{filename} | ssh #{app_uuid}@#{app_name}-#{namespace}.#{rhc_domain} 'restore#{include_git ? ' INCLUDE_GIT' : ''}'"
         puts "Restoring from snapshot #{filename}..."
@@ -919,8 +926,8 @@ LOOKSGOOD
                   puts "Terminating..."
                 end
                 File.open(filename, 'rb') do |file|
-                  while (line = file.gets)
-                    channel.send_data line
+                  file.chunk(1024) do |chunk|
+                    channel.send_data chunk
                   end
                 end
                 channel.eof!
@@ -929,7 +936,7 @@ LOOKSGOOD
             ssh.loop
           end
         rescue Exception => e
-          puts e.message if debug
+          puts e.backtrace
           puts "Error in trying to restore snapshot.  You can try to restore manually by running:"
           puts
           puts ssh_cmd
@@ -1235,7 +1242,7 @@ end
 #
 def default_setup_wizard
   if RHC::Config.should_run_wizard?
-    w = RHC::Wizard.new(RHC::Config.local_config_path) 
+    w = RHC::Wizard.new(RHC::Config.local_config_path)
     return w.run
   end
 

data/lib/rhc-rest.rb

@@ -8,17 +8,12 @@ require 'rhc-rest/domain'
 require 'rhc-rest/key'
 require 'rhc-rest/user'
 
-@@end_point = ""
-@@headers = {:accept => :json}
-
 module Rhc
   module Rest
+    @@headers = {:accept => :json}
+
     def logger
-      if defined?Rails.logger
-        Rails.logger
-      else
-        Logger.new(STDOUT)
-      end
+      Logger.new(STDOUT)
     end
 
     def parse_response(response)
@@ -67,15 +62,12 @@ module Rhc
 
     def send(request)
       begin
-        #puts request.headers
         response = request.execute
         #set cookie
         rh_sso = response.cookies['rh_sso']
-        #puts response.cookies
         if not rh_sso.nil?
           @@headers["cookie"] = "rh_sso=#{rh_sso}"
         end
-        #puts "#{response}"
         return parse_response(response) unless response.nil? or response.code == 204
       rescue RestClient::RequestTimeout, RestClient::ServerBrokeConnection, RestClient::SSLCertificateNotVerified => e
         raise ResourceAccessException.new("Failed to access resource: #{e.message}")

data/spec/coverage_helper.rb

@@ -0,0 +1,51 @@
+unless RUBY_VERSION < '1.9'
+  require 'simplecov'
+
+  # Patch to get correct coverage count, filed
+  # https://github.com/colszowka/simplecov/issues/146 upstream.
+  class SimpleCov::Result
+    def missed_lines
+      return @missed_lines if defined? @missed_lines
+      @missed_lines = 0
+      @files.each do |file|
+        @missed_lines += file.missed_lines.count
+      end
+      @missed_lines
+    end
+  end
+  
+  original_stderr = $stderr # in case helpers don't properly cleanup
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    if SimpleCov.result.covered_percent < 100.0
+      original_stderr.puts "Coverage not 100%, build failed."
+      exit 1
+    end
+  end
+  
+  SimpleCov.start do
+    coverage_dir 'coverage/spec/'
+
+    # Filters - these files will be ignored.
+    add_filter 'lib/rhc/vendor/'   # vendored files should be taken directly and only
+                                   # namespaces changed
+    add_filter 'lib/rhc-rest/'     # REST coverage is not yet 100%
+    add_filter 'lib/bin/'          # This is just for safety; simplecov isn't picking these up.
+    add_filter 'lib/rhc-common.rb' # deprecated, functionality moved into client or rhc/helpers.rb
+    add_filter 'features/'         # Don't report on the files that run the cucumber tests
+    add_filter 'lib/rhc-feature-coverage-helper.rb'
+    add_filter 'spec/'             # Don't report on the files that run the spec tests
+
+    # Groups - general categories of test areas
+    add_group('Commands') { |src_file| src_file.filename.include?(File.join(%w[lib rhc commands])) }
+    add_group('RHC Lib')  { |src_file| src_file.filename.include?(File.join(%w[lib rhc])) }
+    add_group('REST')     { |src_file| src_file.filename.include?(File.join(%w[lib rhc-rest])) }  
+    add_group('Legacy')   { |src_file| src_file.filename.include?(File.join(%w[bin])) or
+                                       src_file.filename.include?(File.join(%w[lib rhc-common.rb])) }  
+    add_group('Test')     { |src_file| src_file.filename.include?(File.join(%w[features])) or
+                                       src_file.filename.include?(File.join(%w[spec])) }
+  
+    # Note, the #:nocov: coverage exclusion  should only be used on external functions 
+    #  that cannot be nondestructively tested in a developer environment.
+  end
+end