rhc 0.92.11 → 0.93.18

data/README.md

@@ -1,4 +1,4 @@
-# OpenShift Command Line Tools (RHC)
+# OpenShift Command Line Tools (RHC) [![Build Status](https://secure.travis-ci.org/openshift/os-client-tools.png)](http://travis-ci.org/openshift/os-client-tools)
 
 The OpenShift command line tools allow you to manage your OpenShift
 applications from the command line.  The [Getting Started
@@ -19,7 +19,6 @@ DEPENDENCIES:
 * openssh-clients
 * ruby (1.8.7 or later)
 * rubygems
-* json_pure gem (native json is fine too)
 * parseconfig gem
 
 Step 1:  Create a domain to under which your applications will live:
@@ -66,10 +65,3 @@ Installing git from MacPorts/HomeBrew/Fink/etc requires Xcode.
 Now obtain the client code, either via 'git clone' as above
 or via the rhc gem.
 
-json_pure gem:
-The client tools also make use of JSON as the data set for
-I/O, and therefore needs the json ruby gem. Unless you have
-Xcode installed, you will need to install json_pure, which
-is the 100% ruby version of the JSON gem. If you have Xcode,
-you can elect to install either json_pure or the native
-json gem.

data/Rakefile

@@ -2,59 +2,5 @@
 
 require 'rubygems'
 require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
 
-begin
-  require 'rubygems/package_task'
-rescue LoadError
-  require 'rake/gempackagetask'
-  rake_gempackage = true
-end
-
-task(:default).clear
-task :default => [:package]
-
-# Create the gem specification for packaging
-spec = Gem::Specification.new do |s|
-    s.name = %q{rhc}
-    s.version = /(Version: )(.*)/.match(File.read("client.spec"))[2]
-    s.author = "Red Hat"
-    s.email = %q{openshift@redhat.com}
-    s.summary = %q{OpenShift Client Tools}
-    s.homepage = %q{https://openshift.redhat.com/app/express}
-    s.description = %q{The client tools for the OpenShift platform that allow for application management.}
-    s.files = FileList['lib/**/*.rb', 'lib/rhc', 'bin/*', 'conf/*'].to_a
-    s.files += %w(LICENSE COPYRIGHT README.md Rakefile)
-    s.executables = ['rhc', 'rhc-domain', 'rhc-app', 'rhc-sshkey', 'rhc-chk', 'rhc-create-app', 'rhc-create-domain', 'rhc-ctl-domain', 'rhc-ctl-app', 'rhc-snapshot', 'rhc-domain-info', 'rhc-user-info', 'rhc-tail-files', 'rhc-port-forward']
-    s.add_dependency('parseconfig')
-    s.add_dependency("rest-client")
-    # This does not need to be added as a dep for the RPM since it is only needed in extension installation
-    s.add_dependency('rake')
-
-    # Adding install time dependencies for
-    #   - test-unit (Ruby 1.9)
-    #   - json_pure (Ruby (Ruby 1.8.6, Windows, Mac) / json (everything else)
-    # http://en.wikibooks.org/wiki/Ruby_Programming/RubyGems
-    s.extensions << 'ext/mkrf_conf.rb'
-end
-
-# Define a :package task that bundles the gem
-if rake_gempackage
-  Rake::GemPackageTask.new(spec) do |pkg, args|
-    pkg.need_tar = false
-  end
-else
-  Gem::PackageTask.new(spec) do |pkg, args|
-    pkg.need_tar = false
-  end
-end
-
-# Add the 'pkg' directory to the clean task
-CLEAN.include("pkg")
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
+Dir.glob('tasks/*.rake').each { |r| import r }

data/bin/rhc

@@ -2,6 +2,10 @@
 #
 # print help
 #
+
+# Require rhc-common for wizard invocation
+require 'rhc-common'
+
 def p_usage(exit_code = 255)
     puts <<USAGE
 
@@ -13,10 +17,12 @@ List of resources
   app                Manage applications within the rhcloud account.
   sshkey             Manage multiple keys for the registered rhcloud user.
   port-forward       Forward remote ports to the workstation
+  server             Display information about the status of the service.
+  setup              Run the setup wizard to configure your account.
 
 See 'rhc <resource> --help' for more applicable commands and argumments on a specific resource.
-
 USAGE
+
 exit exit_code
 end
 
@@ -31,6 +37,9 @@ def get_args
   args
 end
 
+
+wizard_run = default_setup_wizard unless ARGV.include?('--noprompt')
+
 case ARGV[0]
 when "domain"
   system("rhc-domain #{get_args} 2>&1")
@@ -44,6 +53,20 @@ when "sshkey"
 when "port-forward"
   system("rhc-port-forward #{get_args} 2>&1")
   retcode = $?.exitstatus
+when "server"
+  begin
+    require 'rhc/cli'
+    RHC::CLI.start(ARGV)
+    retcode = 0
+  rescue SystemExit => e
+    retcode = e.status
+  end
+when "setup"
+  exit 0 if wizard_run
+  w = RHC::RerunWizard.new(RHC::Config.local_config_path) 
+  success = w.run
+  retcode = 0
+  retcode = 1 unless success
 when "-h", "--help", "help", nil
   p_usage 0
 else
@@ -51,4 +74,11 @@ else
   p_usage
 end
 
+if retcode == nil
+  retcode = 1
+
+  # return codes for uncaught signals are 128 + the signal code
+  retcode = 128 + $?.termsig if $?.signaled? and !$?.termsig.nil?
+end
+
 exit retcode

data/bin/rhc-app

@@ -10,7 +10,7 @@ $embed_mapper = { 'add' => 'configure', 'remove' => 'deconfigure' }
 def p_usage(exit_code = 255)
     libra_server = get_var('libra_server')
     rhlogin = get_var('default_rhlogin') ? "Default: #{get_var('default_rhlogin')}" : "required"
-    type_keys = RHC::get_cartridge_listing(nil, ', ', libra_server, @http, 'standalone', false)
+    type_keys = RHC::get_cartridge_listing(nil, ', ', libra_server, RHC::Config.default_proxy, 'standalone', false)
     puts <<USAGE
 
 Usage: rhc app (<command> | cartridge <cartridge-action> | --help) [<args>]
@@ -29,7 +29,7 @@ List of commands
   tidy                           Garbage collects the git repo and empties log/tmp dirs
   add-alias                      Add a custom domain name for the application
   remove-alias                   Remove a custom domain name for the application
-  threaddump                     Trigger a thread dump for jbossas applications
+  threaddump                     Trigger a thread dump for jbossas, jbosseap, and ruby applications
   tail                           Tail the logs of an application
   snapshot       [save|restore]  Saves/Restores an application snapshot to/from a tarball at the location specified using --filepath (default: ./$APPNAME.tar.gz)
   cartridge      <action>        Manage an embedded cartridge
@@ -70,8 +70,9 @@ end
 
 
 def validate_args(val_type=true, val_cartridge=false, val_timeout=true)
+
   # If provided a config path, check it
-  check_cpath($opt)
+  RHC::Config.check_cpath($opt)
   
   # Pull in configs from files
   $libra_server = get_var('libra_server')
@@ -92,7 +93,7 @@ def validate_args(val_type=true, val_cartridge=false, val_timeout=true)
     p_usage
   end
   
-  debug = $opt["debug"] ? true : false
+  debug = $opt.has_key? 'debug'
   RHC::debug(debug)
   
   RHC::timeout($opt["timeout"], get_var('timeout')) if val_timeout
@@ -104,7 +105,7 @@ end
 def create_app
   validate_args
   
-  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, @http, false)
+  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, RHC::Config.default_proxy, false)
   app_info = user_info['app_info']
   
   if app_info[$opt['app']]
@@ -212,8 +213,8 @@ currently being created: '#{$opt['app']}'
   end
   
   if jenkins_app_name && !has_jenkins
-    jenkins_app = RHC::create_app($libra_server, @http, user_info, jenkins_app_name, 'jenkins-1.4', $opt['rhlogin'], $password, nil, false, true, true)
-    available = RHC::check_app_available(@http, jenkins_app[:app_name], jenkins_app[:fqdn], jenkins_app[:health_check_path], jenkins_app[:result], jenkins_app[:git_url], nil, true)
+    jenkins_app = RHC::create_app($libra_server, RHC::Config.default_proxy, user_info, jenkins_app_name, 'jenkins-1.4', $opt['rhlogin'], $password, nil, false, true, true)
+    available = RHC::check_app_available(RHC::Config.default_proxy, jenkins_app[:app_name], jenkins_app[:fqdn], jenkins_app[:health_check_path], jenkins_app[:result], jenkins_app[:git_url], nil, true)
     if !available
       puts "Unable to access your new Jenkins application."
       exit 1
@@ -223,10 +224,10 @@ currently being created: '#{$opt['app']}'
   #
   # Create remote application space
   #
-  main_app = RHC::create_app($libra_server, @http, user_info, $opt['app'], $opt['type'], $opt['rhlogin'], $password, $opt['repo'], $opt['no-dns'], $opt['nogit'], false, $opt['gear-size'], $opt['scaling'])
+  main_app = RHC::create_app($libra_server, RHC::Config.default_proxy, user_info, $opt['app'], $opt['type'], $opt['rhlogin'], $password, $opt['repo'], $opt['no-dns'], $opt['nogit'], false, $opt['gear-size'], $opt['scaling'])
   if jenkins_app_name
     puts "Now embedding the jenkins client into '#{$opt['app']}'..."
-    RHC::ctl_app($libra_server, @http, $opt['app'], $opt['rhlogin'], $password, 'configure', true, 'jenkins-client-1.4', nil, false)
+    RHC::ctl_app($libra_server, RHC::Config.default_proxy, $opt['app'], $opt['rhlogin'], $password, 'configure', true, 'jenkins-client-1.4', nil, false)
   end
   
   if $opt['no-dns']
@@ -238,7 +239,7 @@ currently being created: '#{$opt['app']}'
       puts "#{main_app[:result]}"
     end
   else
-    available = RHC::check_app_available(@http, main_app[:app_name], main_app[:fqdn], main_app[:health_check_path], main_app[:result], main_app[:git_url], $opt['repo'], $opt['nogit'])
+    available = RHC::check_app_available(RHC::Config.default_proxy, main_app[:app_name], main_app[:fqdn], main_app[:health_check_path], main_app[:result], main_app[:git_url], $opt['repo'], $opt['nogit'])
     if !available
       puts "Unable to access your new application."
       exit 1
@@ -247,9 +248,19 @@ currently being created: '#{$opt['app']}'
 
 end
 
+def get_args(l)
+  l.shift
+  args = ""
+  l.each do|a|
+    if (a.to_s.strip.length == 0 || a.to_s.strip.match(/\s/) ); a = "'#{a}'" end    
+    args += " #{a}"
+  end
+  args
+end
+
 def show_app
   validate_args(false)
-  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, @http, true)
+  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, RHC::Config.default_proxy, true)
   
   app_found = false
   unless user_info['app_info'].empty?
@@ -333,7 +344,7 @@ WARNING
     end
   end
 
-  RHC::ctl_app($libra_server, @http, $opt['app'], $opt['rhlogin'], $password, command, false, nil, $opt['alias'])
+  RHC::ctl_app($libra_server, RHC::Config.default_proxy, $opt['app'], $opt['rhlogin'], $password, command, false, nil, $opt['alias'])
 end
 
 def control_cartridge(command)
@@ -343,7 +354,7 @@ def control_cartridge(command)
   command = $embed_mapper[command] if $embed_mapper[command]
   framework = $opt['cartridge']
   
-  RHC::ctl_app($libra_server, @http, $opt['app'], $opt['rhlogin'], $password, command, true, framework, $opt['alias'])
+  RHC::ctl_app($libra_server, RHC::Config.default_proxy, $opt['app'], $opt['rhlogin'], $password, command, true, framework, $opt['alias'])
 end
 
 def show_embedded_list
@@ -351,7 +362,7 @@ def show_embedded_list
     puts ""
     puts "List of supported embedded cartridges:"
     puts ""
-    type_keys = RHC::get_cartridge_listing(nil, ', ', libra_server, @http, 'embedded', false)
+    type_keys = RHC::get_cartridge_listing(nil, ', ', libra_server, RHC::Config.default_proxy, 'embedded', false)
     puts type_keys
     puts ""
     exit 255
@@ -359,8 +370,8 @@ end
 
 def save_or_restore_snapshot(command)
   validate_args(false, false, true)
-  
-  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, @http, @mydebug, false)
+
+  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, RHC::Config.default_proxy, @mydebug, false)
   
   app = $opt['app']
   $opt['filepath'] = "#{$opt['app']}.tar.gz" unless $opt['filepath']
@@ -376,94 +387,17 @@ def save_or_restore_snapshot(command)
   app_uuid = user_info['app_info'][app]['uuid']
   namespace = user_info['user_info']['domains'][0]['namespace']
   rhc_domain = user_info['user_info']['rhc_domain']
+  
   if command == 'save'
-    ssh_cmd = "ssh #{app_uuid}@#{app}-#{namespace}.#{rhc_domain} 'snapshot' > #{$opt['filepath']}"
-    puts "Pulling down a snapshot to #{$opt['filepath']}"
-  else
-    if File.exists? $opt['filepath']
-      `tar -tf #{$opt['filepath']} './*/#{app}'`
-      if $?.exitstatus != 0
-        puts "Archive at #{$opt['filepath']} does not contain the target application: ./*/#{app}"
-        puts "If you created this archive rather than exported with 'rhc app snapshot', be sure"
-        puts "the directory structure inside the archive starts with ./<app_uuid>/"
-        puts "i.e.: tar -czvf <app_name>.tar.gz ./<app_uuid>/"
-        exit 255
-      else
-        `tar -tf #{$opt['filepath']} './*/git'`
-        include_git = $?.exitstatus == 0
-        ssh_cmd = "cat #{$opt['filepath']} | ssh #{app_uuid}@#{app}-#{namespace}.#{rhc_domain} 'restore#{include_git ? ' INCLUDE_GIT' : ''}'"
-        puts "Restoring from snapshot #{$opt['filepath']}"
-      end
-    else
-      puts "Archive not found: #{$opt['filepath']} - you may specify a path to the archive using the -f option"
-      exit 255
-    end
-  end
-
-  puts 
-  puts ssh_cmd if @mydebug
-  output = `#{ssh_cmd}`
-  puts
-  if $?.exitstatus != 0
-      puts output
-      puts
-  if command == 'save'
-      puts "Error in trying to save snapshot.  You can try to save manually by running:"
+    status = RHC.snapshot_create rhc_domain, namespace, app, app_uuid, $opt['filepath'], @mydebug
+    exit status if ! status
   else
-      puts "Error in trying to restore application from snapshot.  You can try to restore manually by running:"
+    status = RHC.snapshot_restore rhc_domain, namespace, app, app_uuid, $opt['filepath'], @mydebug
+    exit status if ! status
   end
-      puts
-      puts ssh_cmd
-      puts
-      exit 1
-  end
-  puts output if command == 'restore' && @mydebug
-end
-
-def show_logs
-  validate_args(false, false, true)
 
-  user_info = RHC::get_user_info($libra_server, $opt['rhlogin'], $password, @http, false)
-  app = $opt['app']
-  
-  unless user_info['app_info'][app]
-      puts
-      puts "Could not find app '#{$opt['app']}'.  Please run 'rhc domain show' to get a list"
-      puts "of your current running applications"
-      puts
-      exit 101
-  end
-  
-  $opt['filepath'] = "#{$opt['app']}/logs/*" unless $opt['filepath']
-  file_glob = "#{$opt['filepath']}"
-  app_uuid = user_info['app_info'][app]['uuid']
-  namespace = user_info['user_info']['domains'][0]['namespace']
-  rhc_domain = user_info['user_info']['rhc_domain']
-  
-  # -t to force PTY and avoid daemons
-  # Red Hat OpenShift: https://bugzilla.redhat.com/show_bug.cgi?id=726646
-  # OpenSSH https://bugzilla.mindrot.org/show_bug.cgi?id=396
-  ssh_cmd = "ssh -t #{app_uuid}@#{app}-#{namespace}.#{rhc_domain} 'tail#{$opt['opts'] ? ' --opts ' + Base64::encode64($opt['opts']).chomp : ''} #{file_glob}'"
-
-  puts "Attempting to tail files: #{file_glob}"
-  puts "Use ctl + c to stop"
-  puts 
-  puts ssh_cmd if @mydebug
-  begin
-    exec ssh_cmd
-  rescue SystemCallError
-    puts
-    puts "Error in trying to tail files.  You can tail manually by running:"
-    puts
-    puts ssh_cmd
-    puts
-    exit 1
-  end
-  # this should never happen
-  exit 1
 end
 
-
 begin
   argv_c = ARGV.clone
   
@@ -561,37 +495,38 @@ end
 p_usage 0 if $opt["help"]
 
 case argv_c[0]
-when "create"
-  create_app
-when "show"
-  show_app
-when "start", "stop", "force-stop", "restart", "reload", "status", "tidy", "add-alias", "remove-alias", "threaddump", "destroy"
-  control_app(argv_c[0])
-when "tail"
-  show_logs
-when "snapshot"
-  case argv_c[1]
-  when "save", "restore"
-    save_or_restore_snapshot(argv_c[1])
-  else
-    puts "Missing or invalid snapshot action!"
-    p_usage
-  end
-when "cartridge"
-  case argv_c[1]
-  when "add", "remove", "start", "stop", "restart", "status", "reload"
-    control_cartridge(argv_c[1])
-  when "list", nil
-    show_embedded_list
+  when "create"
+    create_app
+  when "show"
+    show_app
+  when "start", "stop", "force-stop", "restart", "reload", "status", "tidy", "add-alias", "remove-alias", "threaddump", "destroy"
+    control_app(argv_c[0])
+  when "tail"
+    system("rhc-tail-files #{get_args argv_c} 2>&1")
+    exit $?.exitstatus
+  when "snapshot"
+    case argv_c[1]
+    when "save", "restore"
+      save_or_restore_snapshot(argv_c[1])
+    else
+      puts "Missing or invalid snapshot action!"
+      p_usage
+    end
+  when "cartridge"
+    case argv_c[1]
+    when "add", "remove", "start", "stop", "restart", "status", "reload"
+      control_cartridge(argv_c[1])
+    when "list", nil
+      show_embedded_list
+    else
+      puts "Missing or invalid cartridge action!"
+      p_usage
+    end
+  when "-h", "--help", "help", nil
+    p_usage 0
   else
-    puts "Missing or invalid cartridge action!"
+    puts "Invalid command!"
     p_usage
-  end
-when "-h", "--help", "help", nil
-  p_usage 0
-else
-  puts "Invalid command!"
-  p_usage
 end
 
 exit 0