rhc 0.90.7 → 0.91.11

data/README.md

@@ -0,0 +1,75 @@
+# OpenShift Command Line Tools (RHC)
+
+The OpenShift command line tools allow you to manage your OpenShift
+applications from the command line.  The [Getting Started
+guide](https://openshift.redhat.com/app/getting_started) has additional
+info on installing the tool on each supported operating system.
+
+Please stop by #openshift on irc.freenode.net if you have any questions or
+comments.  For more information about OpenShift, visit https://openshift.redhat.com
+or the OpenShift forum
+https://openshift.redhat.com/community/forums/openshift.
+
+
+## Using RHC to create an application
+
+DEPENDENCIES: 
+
+* git
+* 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:
+
+    $ rhc domain create -n desirednamespace -l rhlogin
+
+The name you choose here will form part of your application's public
+URL.
+
+Step 2: Create an OpenShift application:
+
+    $ rhc app create -l rhlogin -a appname -r /path/to/new/git/repo -t <framework Ex: php-5.3>
+
+Once that's complete, follow the directions printed at the end of running
+rhc app create
+
+
+## Making changes to your application
+
+Once your site is created, updating it is as simple as making changes to your
+git repo.  Commit them, then push.  For example:
+
+    $ edit index.php
+    $ git commit -a -m "what I did"
+    $ git push
+
+Then just reload your web page to see the changes.
+
+## OS X Notes:
+
+git:
+OS X 10.6 comes w/ ssh and ruby, but not with git, unless you have
+Xcode 4.0.x installed (as a developer you should have Xcode anyway).
+Xcode, however, is not free (unless you are a registered Apple
+Developer) and costs around $5 from the Apple App Store.
+
+If you do not have Xcode, you can obtain a pre-packaged version
+of git from:
+
+    http://code.google.com/p/git-osx-installer/
+
+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

@@ -3,6 +3,7 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
+require 'rake/testtask'
 
 begin
   require 'rubygems/package_task'
@@ -24,22 +25,31 @@ spec = Gem::Specification.new do |s|
     s.homepage = %q{https://openshift.redhat.com/app/express}
     s.description = %q{The client tools for the OpenShift Express platform that allow for application management.}
     s.files = FileList['lib/**/*.rb', 'lib/rhc', 'bin/*', 'conf/*'].to_a
-    s.files += %w(LICENSE COPYRIGHT README Rakefile)
+    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']
-    begin
-    # Use Ruby version to target F13, RHEL5, Windows and OSX (assume no Xcode)
-    if ENV['JSON_PURE'] or (RUBY_VERSION == "1.8.6" or RUBY_PLATFORM =~ /mswin/ or RUBY_PLATFORM =~ /darwin/)
-        s.add_dependency('json_pure')
-    else
-        s.add_dependency('json')
-    end
-    end
     s.add_dependency('parseconfig')
-    s.add_dependency('rhc-rest', ">= 0.0.11")
+    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')
 
-    # This should only affect 1.9 rubies, since it's already included in 1.8
+    # 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'
+
+    # Leave this message for a few versions, or until we can 
+    #   figure out how to get it only displayed if rhc-rest 
+    #   is installed (taken care of in extension)
+    s.post_install_message = <<-MSG
+      ===================================================
+        rhc-rest is no longer needed as an external gem
+          - If it is installed, it will be removed
+          - Its libraries are now included in rhc
+            - Any applications requiring rhc-rest will 
+              still function as expected
+      ===================================================
+    MSG
 end
 
 # Define a :package task that bundles the gem
@@ -55,3 +65,9 @@ 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

data/bin/rhc

@@ -2,7 +2,7 @@
 #
 # print help
 #
-def p_usage
+def p_usage(exit_code = 255)
     puts <<USAGE
 
 Usage: rhc (<resource> | --help) [<command>] [<args>]
@@ -17,7 +17,7 @@ List of resources
 See 'rhc <resource> --help' for more applicable commands and argumments on a specific resource.
 
 USAGE
-exit 255
+exit exit_code
 end
 
 
@@ -34,21 +34,21 @@ end
 case ARGV[0]
 when "domain"
   system("rhc-domain #{get_args} 2>&1")
-  retcode = $?
+  retcode = $?.exitstatus
 when "app"
   system("rhc-app #{get_args} 2>&1")
-  retcode = $?
+  retcode = $?.exitstatus
 when "sshkey"
   system("rhc-sshkey #{get_args} 2>&1")
-  retcode = $?
+  retcode = $?.exitstatus
 when "port-forward"
   system("rhc-port-forward #{get_args} 2>&1")
-  retcode = $?
+  retcode = $?.exitstatus
 when "-h", "--help", "help", nil
-  p_usage
+  p_usage 0
 else
   puts "Invalid rhc command: #{ARGV[0]}"
   p_usage
 end
 
-exit (retcode != 0 ? 1 : 0)
+exit retcode

data/bin/rhc-app

@@ -7,7 +7,7 @@ $embed_mapper = { 'add' => 'configure', 'remove' => 'deconfigure' }
 #
 # print help
 #
-def p_usage
+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)
@@ -62,10 +62,10 @@ List of arguments
   -o|--opts         options      Options to pass to the server-side (linux based) tail command (applicable to tail command only) (-f is implicit.  See the linux tail man page full list of options.) (Ex: --opts '-n 100')
   --alias           alias        Specify server alias (when using add/remove-alias)
   --config          path         Path of alternate config file
-  --timeout         #            Timeout, in seconds, for connection
+  --timeout         #            Timeout, in seconds, for the session
   --enable-jenkins  [name]       Indicates to create a Jenkins application (if not already available) and embed the Jenkins client into this application.  The default name will be 'jenkins' if not specified. Note that --no-dns is ignored for the creation of the Jenkins application.
 USAGE
-exit 255
+exit exit_code
 end
 
 
@@ -95,8 +95,9 @@ def validate_args(val_type=true, val_cartridge=false, val_timeout=true)
   debug = $opt["debug"] ? true : false
   RHC::debug(debug)
   
-  RHC::timeout($opt["timeout"] ? $opt["timeout"] : get_var('timeout')) if val_timeout
-  
+  RHC::timeout($opt["timeout"], get_var('timeout')) if val_timeout
+  RHC::connect_timeout($opt["timeout"], get_var('timeout')) if val_timeout
+
   $password = $opt['password'] ? $opt['password'] : RHC::get_password
 end
 
@@ -541,12 +542,17 @@ begin
         ["--timeout", GetoptLong::REQUIRED_ARGUMENT]
     )
   else
-    puts "Missing or invalid command!" unless ARGV[0] =~ /^(help|-h|--help)$/
-    # just exit at this point
-    # printing the usage description will be handled in the rescue
-    exit 255
+    opts = GetoptLong.new(
+      ["--help",  "-h", GetoptLong::NO_ARGUMENT]
+    )
+    unless ARGV[0] =~ /^(help|-h|--help)$/
+      puts "Missing or invalid command!" unless ARGV[0] =~ /^(help|-h|--help)$/
+      #  just exit at this point
+      # printing the usage description will be handled in the rescue
+      exit 255
+    end
   end
-    
+
   $opt = {}
   opts.each do |o, a|
     $opt[o[2..-1]] = a.to_s
@@ -556,7 +562,7 @@ rescue Exception => e
   p_usage
 end
 
-p_usage if $opt["help"]
+p_usage 0 if $opt["help"]
 
 case argv_c[0]
 when "create"
@@ -586,7 +592,7 @@ when "cartridge"
     p_usage
   end
 when "-h", "--help", "help", nil
-  p_usage
+  p_usage 0
 else
   puts "Invalid command!"
   p_usage

data/bin/rhc-chk

@@ -18,7 +18,7 @@ require 'test/unit/ui/console/testrunner'
 #
 # print help
 #
-def p_usage
+def p_usage(exit_code = 255)
   rhlogin = get_var('default_rhlogin') ? "Default: #{get_var('default_rhlogin')}" : "required"
   puts <<USAGE
 
@@ -31,10 +31,10 @@ properly setup.  Often run to troubleshoot connection issues.
   -d|--debug                Print Debug info
   -h|--help                 Show Usage info
   --config  path            Path of alternate config file
-  --timeout #               Timeout, in seconds, for connection
+  --timeout #               Timeout, in seconds, for the session
 
 USAGE
-exit 255
+exit exit_code
 end
 
 begin
@@ -55,10 +55,13 @@ rescue Exception => e
   p_usage
 end
 
-if $opt["help"] || 0 != ARGV.length
-  p_usage
+if $opt["help"]
+  p_usage 0
 end
 
+if 0 != ARGV.length
+  p_usage
+end
 
 # If provided a config path, check it
 check_cpath($opt)
@@ -81,7 +84,9 @@ if $opt["debug"]
 end
 RHC::debug($debug)
 
-RHC::timeout($opt["timeout"] ? $opt["timeout"] : get_var('timeout'))
+RHC::timeout($opt["timeout"], get_var('timeout'))
+RHC::connect_timeout($opt["timeout"], get_var('timeout'))
+
 
 $opt["rhlogin"] = get_var('default_rhlogin') unless $opt["rhlogin"]
 if !RHC::check_rhlogin($opt['rhlogin'])

data/bin/rhc-create-app

@@ -19,7 +19,7 @@ def p_valid_gear_sizes(invalid_gear_size)
     exit 255
 end
 
-def p_usage
+def p_usage(error_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)
@@ -40,14 +40,14 @@ Create an OpenShift app.
   -h|--help                  Show Usage info
   --no-dns                   Skip DNS check. Must be used in combination with --nogit
   --config  path             Path of alternate config file
-  --timeout #                Timeout, in seconds, for connection
+  --timeout #                Timeout, in seconds, for the session
   --enable-jenkins [name]    Create a Jenkins application (see Note 1)
 
 Notes:
 1. Jenkins applications will have Jenkins embedded.  Their default name will be 'jenkins' if not specified and the '--no-dns' flag is ignored.
 
 USAGE
-exit 255
+exit error_code
 end
 
 begin
@@ -84,16 +84,16 @@ check_cpath(opt)
 libra_server = get_var('libra_server')
 debug = get_var('debug') == 'false' ? nil : get_var('debug')
 
-if opt["help"] || 0 != ARGV.length
-    p_usage
-end
+p_usage 0 if opt["help"]
+
+p_usage if 0 != ARGV.length
+
+debug = true if opt["debug"]
 
-if opt["debug"]
-    debug = true
-end
 RHC::debug(debug)
 
-RHC::timeout(opt['timeout'] ? opt['timeout'] : get_var('timeout'))
+RHC::timeout(opt['timeout'], get_var('timeout'))
+RHC::connect_timeout(opt["timeout"], get_var('timeout'))
 
 opt['rhlogin'] = get_var('default_rhlogin') unless opt['rhlogin']
 

data/bin/rhc-create-domain

@@ -4,7 +4,7 @@ require 'rhc-common'
 #
 # print help
 #
-def p_usage
+def p_usage(exit_code = 255)
     rhlogin = get_var('default_rhlogin') ? "Default: #{get_var('default_rhlogin')}" : "required"
     puts <<USAGE
 
@@ -21,10 +21,10 @@ Bind a registered rhcloud user to a domain in rhcloud.
   -d|--debug                   Print Debug info
   -h|--help                    Show Usage info
   --config  path               Path of alternate config file
-  --timeout #                  Timeout, in seconds, for connection
+  --timeout #                  Timeout, in seconds, for the session
   
 USAGE
-exit 255
+exit exit_code
 end
 
 begin
@@ -62,16 +62,16 @@ ssh_pub_key_file_path = get_kpfile(ssh_key_file_path, opt['alter'])
 ssh_config = "#{ENV['HOME']}/.ssh/config"
 ssh_config_d = "#{ENV['HOME']}/.ssh/"
 
-if opt["help"] || 0 != ARGV.length
-    p_usage
-end
+p_usage 0 if opt["help"]
+p_usage if 0 != ARGV.length
+
+
+debug = true if opt["debug"]
 
-if opt["debug"]
-    debug = true
-end
 RHC::debug(debug)
 
-RHC::timeout(opt["timeout"] ? opt["timeout"] : get_var('timeout'))
+RHC::timeout(opt["timeout"], get_var('timeout'))
+RHC::connect_timeout(opt["timeout"], get_var('timeout'))
 
 if !RHC::check_namespace(opt['namespace'])
     p_usage

data/bin/rhc-ctl-app

@@ -3,7 +3,7 @@ require 'rhc-common'
 
 embed_mapper = { 'add' => 'configure', 'remove' => 'deconfigure' }
 
-def p_usage
+def p_usage(exit_code = 255)
     rhlogin = get_var('default_rhlogin') ? "Default: #{get_var('default_rhlogin')}" : "required"
     puts <<USAGE
 
@@ -21,10 +21,10 @@ Control an OpenShift express app
   -h|--help                Show Usage info
   --alias                  Specify server alias (when using add/remove-alias)
   --config  path           Path of alternate config file
-  --timeout #              Timeout, in seconds, for connection
+  --timeout #              Timeout, in seconds, for the session
 
 USAGE
-exit 255
+exit exit_code
 end
 
 def p_embedded_list
@@ -74,16 +74,15 @@ ssh_config_d = "#{ENV['HOME']}/.ssh/"
 if opt["embedded-list"]
     p_embedded_list
 end
-if opt["help"] || 0 != ARGV.length
-    p_usage
-end
+p_usage 0 if opt["help"]
+p_usage if 0 != ARGV.length
+
+debug = true if opt["debug"]
 
-if opt["debug"]
-    debug = true
-end
 RHC::debug(debug)
 
-RHC::timeout(opt["timeout"] ? opt["timeout"] : get_var('timeout'))
+RHC::timeout(opt["timeout"], get_var('timeout'))
+RHC::connect_timeout(opt["timeout"], get_var('timeout'))
 
 opt["rhlogin"] = get_var('default_rhlogin') unless opt["rhlogin"]
 

data/bin/rhc-ctl-domain

@@ -4,7 +4,7 @@ require 'rhc-common'
 #
 # print help
 #
-def p_usage
+def p_usage(exit_code = 255)
   rhlogin = get_var('default_rhlogin') ? "Default: #{get_var('default_rhlogin')}" : "required"
   puts <<USAGE
 
@@ -26,7 +26,7 @@ Manage multiple keys for the registered rhcloud user.
   -h|--help                         Show Usage info
 
 USAGE
-exit 255
+exit exit_code
 end
 
 begin
@@ -68,13 +68,11 @@ libra_server = get_var('libra_server')
 debug = get_var('debug') == 'false' ? nil : get_var('debug')
 opt['rhlogin'] = get_var('default_rhlogin') unless opt['rhlogin']
 
-if opt['help'] || 0 != ARGV.length
-    p_usage
-end
+p_usage 0 if opt['help']
+p_usage if 0 != ARGV.length
+
+debug = true if opt['debug']
 
-if opt['debug']
-    debug = true
-end
 RHC::debug(debug)
 
 # Validate for no command or multiple commands being specified