rhc 0.94.8 → 0.95.13

data/README.md

@@ -19,7 +19,6 @@ DEPENDENCIES:
 * openssh-clients
 * ruby (1.8.7 or later)
 * rubygems
-* parseconfig gem
 
 Step 1:  Create a domain to under which your applications will live:
 
@@ -65,3 +64,30 @@ 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.
 
+## Developing / Contributing
+We expect code contributions to follow these standards:
+
+1. Ensure code matches the [GitHub Ruby styleguide](https://github.com/styleguide/ruby), except where the file establishes a different standard.
+2. We use RSpec for functional testing and Cucumber for our high level
+   integration tests.  Specs are in 'spec/' and can be run with <code>bundle
+exec rake spec</code>.  Features are in 'features/' and can be run with
+<code>bundle exec rake features</code> (although these tests runs
+against the gem installed locally so you will need to gem install
+first).  See [README.md](https://github.com/openshift/os-client-tools/blob/master/features/README.md) in the features dir for more info.
+3. We maintain 100% line coverage of all newly added code via spec
+   testing.  The build will fail if new code is added and it does not
+have full line coverage.  Some old code is currently excluded until it
+can be refactored.  Run <code>bundle exec rake spec</code> on Ruby 1.9+
+to see your code coverage level.
+
+Once you've made your changes:
+
+1. [Fork](http://help.github.com/forking/) the code
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch
+5. That's it!
+
+If you use vim, we've included a .vimrc in the root of this project.
+In order to use it, install https://github.com/MarcWeber/vim-addon-local-vimrc
+

data/bin/rhc

@@ -2,6 +2,7 @@
 #
 # print help
 #
+require 'rhc/coverage_helper'
 
 # Require rhc-common for wizard invocation
 require 'rhc-common'
@@ -38,7 +39,7 @@ def get_args
 end
 
 def run_setup_wizard_if_needed
-  default_setup_wizard unless ARGV.include?('--noprompt')
+  default_setup_wizard unless ARGV.delete('--noprompt')
 end
 
 begin
@@ -59,31 +60,22 @@ begin
     run_setup_wizard_if_needed
     system("rhc-port-forward #{get_args} 2>&1")
     retcode = $?.exitstatus
-  when "server"
-    run_setup_wizard_if_needed
-    begin
-      require 'rhc/cli'
-      RHC::CLI.start(ARGV)
-      retcode = 0
-    rescue SystemExit => e
-      retcode = e.status
-    end
-  when "setup"
-    if ARGV.include?('--help') or ARGV.include?('-h') or ARGV.include?('help')
-      puts "Usage: rhc setup"
-      puts "Runs the setup wizard to configure your account"
-      exit 0
-    end
-
-    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
-    puts "Invalid rhc command: #{ARGV[0]}"
-    p_usage
+    if ["server", "setup"].include?(ARGV[0])
+      run_setup_wizard_if_needed if ARGV[0] != "setup"
+      begin
+        require 'rhc/cli'
+        RHC::CLI.start(ARGV)
+        retcode = 0
+      rescue SystemExit => e
+        retcode = e.status
+      end
+    else
+      puts "Invalid rhc command: #{ARGV[0]}"
+      p_usage
+    end
   end
 
   if retcode == nil

data/bin/rhc-app

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 require 'base64'
 
@@ -93,7 +96,7 @@ def validate_args(val_type=true, val_cartridge=false, val_timeout=true)
     p_usage
   end
   
-  debug = $opt.has_key? 'debug'
+  debug = true if $opt.has_key? 'debug'
   RHC::debug(debug)
   
   RHC::timeout($opt["timeout"], get_var('timeout')) if val_timeout

data/bin/rhc-chk

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 require 'net/http'
 require 'net/https'

data/bin/rhc-create-app

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 def p_usage(error_code = 255)

data/bin/rhc-create-domain

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #

data/bin/rhc-ctl-app

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 embed_mapper = { 'add' => 'configure', 'remove' => 'deconfigure' }

data/bin/rhc-ctl-domain

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #

data/bin/rhc-domain

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #
@@ -77,8 +80,8 @@ def create_or_alter_domain(alter=false)
       puts "OpenShift key found at #{ssh_key_file_path}.  Reusing..."
   else
       puts "Generating OpenShift ssh key to #{ssh_key_file_path}"
-      # Use system for interaction
-      system("ssh-keygen -t rsa -f '#{ssh_key_file_path}'")
+      w = RHC::SSHWizard.new($opt['rhlogin'], $password)
+      w.run
   end
   
   ssh_keyfile_contents = File.open(ssh_pub_key_file_path).gets.chomp.split(' ')

data/bin/rhc-domain-info

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #

data/bin/rhc-port-forward

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #
@@ -86,7 +89,7 @@ end
 
 # mock for windows
 if defined?(UNIXServer) != 'constant' or UNIXServer.class != Class
-  class UNIXServer; end 
+  class UNIXServer; end
 end
 
 app_uuid = user_info['app_info'][app_name]['uuid']
@@ -108,21 +111,17 @@ Net::SSH.start(ssh_host, app_uuid) do |ssh|
 
   ssh.exec! "rhc-list-ports" do |channel, stream, data|
 
-    # data comes from a linux server so it is a one-line string for windows, we need to split \n manually
-    if RHC::Helpers.windows? 
-      data = data.split /\n/
-    end
-
     if stream == :stderr
 
-      data.each { |line|
+      data.lines { |line|
+
         line = line.chomp
 
         if line.downcase =~ /permission denied/
           puts line
           exit 1
         end
-        
+
         if line.index(ip_and_port_simple_regex)
           hosts_and_ports_descriptions << line
         end
@@ -130,7 +129,8 @@ Net::SSH.start(ssh_host, app_uuid) do |ssh|
 
     else
 
-      data.each { |line|
+      data.lines { |line|
+
         line = line.chomp
 
         if line.downcase =~ /scale/
@@ -149,18 +149,15 @@ Net::SSH.start(ssh_host, app_uuid) do |ssh|
   end
 
   scaled_uuids.each { |scaled_uuid|
-    
+
     puts "Using #{scaled_uuid}@#{ssh_host} (scaled instance)..." if debug
 
     Net::SSH.start(ssh_host, scaled_uuid) do |ssh|
 
       ssh.exec! "rhc-list-ports" do |channel, stream, data|
-        # data comes from a linux server so it is a one-line string for windows, we need to split \n manually
-        if RHC::Helpers.windows?
-          data = data.split /\n/
-        end
         if stream == :stderr
-          data.each { |line|
+          data.lines { |line|
+
             line = line.chomp
             if line.downcase =~ /permission denied/
               puts line
@@ -171,7 +168,8 @@ Net::SSH.start(ssh_host, app_uuid) do |ssh|
             end
           }
         else
-          data.each { |line|
+          data.lines { |line|
+
             line = line.chomp
             if ip_and_port_simple_regex.match(line)
               hosts_and_ports << line
@@ -202,12 +200,12 @@ Net::SSH.start(ssh_host, app_uuid) do |ssh|
       end
       ssh.loop { true }
     end
-  
+
   rescue Interrupt
     puts
     puts "Terminating..."
     exit 0
-    
+
   rescue Exception => e
     puts
     puts e.message if debug

data/bin/rhc-snapshot

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #

data/bin/rhc-sshkey

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 
 #

data/bin/rhc-tail-files

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+
+require 'rhc/coverage_helper'
+
 require 'rhc-common'
 require 'base64'
 

data/bin/rhc-user-info

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # print deprecation warning
+
 puts "Warning: This command is deprecated. Please use rhc-domain-info instead."
 puts""
 

data/features/README.md

@@ -0,0 +1,70 @@
+Overview
+==============
+
+These tests can be run against a production or OpenShift Origin instance for
+verification of basic functionality.  These tests should be operating system
+independent and will shell out to execute the 'rhc *' commands to emulate a
+user as closely as possible.  These tests exercise both the commandline
+client and the underlying infrastructure and serve as integration level
+verification tests for the entire stack.
+
+Usage
+=============
+
+Run from the base directory with 
+
+   <env variables> bundle exec rake features
+
+'features' requires RHC_USERNAME+RHC_PASSWORD+RHC_NAMESPACE or
+RHC_ENDPOINT to be set in the environment.
+
+Using a proxy
+--------------
+
+You can use a proxy by setting the http_proxy environment variable.  For example
+
+    http_proxy='http://proxyserver:proxyport/' bundle exec rake features
+
+Pre-defined users
+-----------------
+
+In many cases, these tests will be run with an existing, pre-created user.  The
+tests should keep the resource needs of that user to a minimum, but in some
+cases, the user might need to have an increased number of gears added to
+support certain tests.
+
+You use environment variables to notify the tests of the well defined user,
+password and namespace.  This can be done by passing the values in before the
+command:
+
+    RHC_USERNAME='mylogin@example.com' RHC_PASSWORD='supersecretpassword' RHC_NAMESPACE='mynamespace' bundle exec rake features
+
+Development Usage
+=================
+
+In development, you probably aren't going to be running against production systems.
+You will most likely be running against your own OpenShift Origin system.  To be
+able to point to a custom system, you can configure the REST endpoint that is used.
+If not specified, it will default to the OpenShift Production REST Endpoint:
+
+    RHC_ENDPOINT='https://myserver/rest/api' bundle exec rake features
+
+
+Developing tests
+----------------
+
+Often when you are developing new tests, you don't want to run the entire suite
+each time.  However, the tests by default automatically clean up the test
+applications that were created on the previous run.  You can quickly develop
+and interate on a single test by doing the following:
+
+* Run the initialization portion of the test suite
+
+    RHC_ENDPOINT='https://yourserver/rest/api' bundle exec cucumber -t @init
+
+* Run the tests on your specific feature without reset state and using the
+created username and namespace from the previous run. For example, if the
+cucumber feature you wanted to test started on line 17, in your .feature file,
+you would run
+
+    RHC_USERNAME=`cat /tmp/rhc/username` RHC_NAMESPACE=`cat /tmp/rhc/namespace` RHC_ENDPOINT='https://yourserver/rest/api' NO_CLEAN=1 bundle exec cucumber features/verify.feature:20

data/features/lib/rhc_helper/app.rb

@@ -0,0 +1,124 @@
+require 'tmpdir'
+require 'rhc-rest'
+
+module RHCHelper
+  #
+  # Constant Definitions
+  #
+  TEMP_DIR = File.join(Dir.tmpdir, "rhc")
+
+  #
+  # A class to help maintain the state from rhc calls and helper
+  # methods around application management.
+  #
+  class App 
+    extend Persistable
+    extend Runnable
+    include Loggable
+    include Commandify
+    include Runnable
+    include Persistify
+    include Httpify
+
+    # attributes to represent the general information of the application
+    attr_accessor :name, :type, :hostname, :repo, :embed, :snapshot, :uid, :alias
+
+    # mysql connection information
+    attr_accessor :mysql_hostname, :mysql_user, :mysql_password, :mysql_database
+
+    # Create the data structure for a test application
+    def initialize(type, name)
+      @name, @type = name, type
+      @hostname = "#{name}-#{$namespace}.#{$domain}"
+      @repo = "#{TEMP_DIR}/#{$namespace}_#{name}_repo"
+      @file = "#{TEMP_DIR}/#{$namespace}.json"
+      @embed = []
+      @embed_helpers = {}
+    end
+
+    def self.rhc_setup
+      # Setup questions asked by wizard which are passed in below:
+      #   1 - username
+      #   2 - password
+      #   3 - upload SSH keys
+      #   4 - if no namespace is found, create namespace? (blank is no)
+      if $namespace
+        # Namespace is already created, so don't pass anything in
+        logger.info("Namespace (#{$namespace}) should be found by the wizard")
+        run("rhc setup", nil, [$username, $password, 'yes', ""])
+      else
+        # Pass in a blank value for namespace to create in the next step
+        logger.info("Skipping namespace creation")
+        run("rhc setup", nil, [$username, $password, 'yes', "", ""])
+      end
+    end
+
+    def self.create_unique(type, prefix="test")
+      # Get a REST client to verify the application name
+      client = Rhc::Rest::Client.new($end_point, $username, $password)
+
+      # Cleanup all test applications
+      test_names = []
+      client.domains.each do |domain|
+        domain.applications.each do |app|
+          test_names << app.name if app.name.start_with?(prefix)
+        end
+      end
+      
+      loop do
+        # Generate a random application name
+        chars = ("1".."9").to_a
+        name = prefix + Array.new(8, '').collect{chars[rand(chars.size)]}.join
+
+        # If the test name exists, try again
+        next if test_names.index(name)
+
+        # Create the app
+        app = App.new(type, name)
+        app.persist
+        return app
+      end
+    end
+
+    def add_cartridge(name)
+      exitcode = 0
+      cartridge(name).add do |ec|
+        exitcode = ec
+        embed << name unless embed.include?(name) or ec != 0
+      end
+
+      persist
+      exitcode
+    end
+
+    def remove_cartridge(name)
+      cartridge(name).remove
+      embed.reject! { |s| s == name }
+
+      persist
+    end
+
+    def cartridge(name)
+      @embed_helpers[name] = RHCHelper::Cartridge.new(self, name) unless @embed_helpers.include?(name)
+      @embed_helpers[name]
+    end
+
+    def get_index_file
+      case @type
+        when "php-5.3" then "php/index.php"
+        when "ruby-1.8" then "config.ru"
+        when "python-2.6" then "wsgi/application"
+        when "perl-5.10" then "perl/index.pl"
+        when "jbossas-7" then "src/main/webapp/index.html"
+        when "jbosseap-6.0" then "src/main/webapp/index.html"
+        when "nodejs-0.6" then "index.html"
+      end
+    end
+
+    def get_mysql_file
+      case @type
+        when "php-5.3" then File.expand_path("../misc/php/db_test.php", File.expand_path(File.dirname(__FILE__)))
+      end
+    end
+  end
+end

data/features/lib/rhc_helper/cartridge.rb

@@ -0,0 +1,72 @@
+require 'tmpdir'
+require 'rhc-rest'
+
+module RHCHelper
+  #
+  # Constant Definitions
+  #
+  TEMP_DIR = File.join(Dir.tmpdir, "rhc")
+
+  #
+  # A class to help maintain the state from rhc calls and helper
+  # methods around cartridge management.
+  #
+  class Cartridge
+    extend Runnable
+    extend Persistable
+    include Loggable
+    include Runnable
+    include Httpify
+    include Persistify
+
+    # attributes to represent the general information of the cartridge
+    attr_accessor :name
+
+    # Create the data structure for a test cartridge
+    def initialize(app, name)
+      @name = name
+      @app_name = app.name
+      @hostname = "#{@app_name}-#{$namespace}.#{$domain}"
+      @file = "#{TEMP_DIR}/#{$namespace}.json"
+    end
+
+    def rhc_app_cartridge(cmd)
+      full_cmd = "rhc app cartridge #{cmd} -l #{$username} -p #{$password} -a #{@app_name}"
+      full_cmd += " -c #{@name}" if cmd != "list"
+      run(full_cmd, nil) do |exitstatus, out, err, arg|
+        yield exitstatus, out, err, arg if block_given?
+      end
+    end
+
+    def add
+      rhc_app_cartridge('add') do |exitstatus, out, err, arg|
+        yield exitstatus, out, err, arg if block_given?
+      end
+    end
+
+    def status
+      result = ""
+      rhc_app_cartridge('status') do |exitstatus, out, err, arg|
+        result = out
+      end
+
+      result
+    end
+
+    def start
+      rhc_app_cartridge('start')
+    end
+
+    def stop
+      rhc_app_cartridge('stop')
+    end
+
+    def restart
+      rhc_app_cartridge('restart')
+    end
+
+    def remove
+      rhc_app_cartridge('remove')
+    end
+  end
+end