rhc 0.94.8 → 0.95.13

data/features/support/env.rb

@@ -0,0 +1,99 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+require 'rhc/coverage_helper'
+SimpleCov.at_exit do
+    SimpleCov.result.format!
+end
+
+require 'rhc_helper'
+require 'rhc-rest'
+require 'rhc/config'
+
+# Generate a random username in case one isn't set
+chars = ("1".."9").to_a
+random_username = "test" + Array.new(8, '').collect{chars[rand(chars.size)]}.join + "@example.com"
+
+ ENV["PATH"] = "#{ENV['RHC_LOCAL_PATH']}:#{ENV['PATH']}" if ENV['RHC_LOCAL_PATH']
+
+# Generate a random username if one isn't specified (for unauthenticated systems)
+$username = ENV['RHC_USERNAME'] || random_username
+
+# Use a generic password if one isn't specific (for unauthenticated systems)
+$password = ENV['RHC_PASSWORD'] || 'test'
+
+# Default the domain to production unless a random username is used.
+# In that case, use dev.rhcloud.com for the development DNS namespace
+default_domain = ENV['RHC_USERNAME'] ? "rhcloud.com" : "dev.rhcloud.com"
+$domain = ENV['RHC_DOMAIN'] || default_domain
+
+# Default the endpoint to the production REST API's
+$end_point = ENV['RHC_ENDPOINT'] || "https://openshift.redhat.com/broker/rest/api"
+
+# Don't default the namespace to anything - the existance if checked to
+# determine how the setup wizard is run
+$namespace = ENV['RHC_NAMESPACE']
+
+raise "Username not found in environment (RHC_USERNAME)" unless $username
+raise "Password not found in environment (RHC_PASSWORD)" unless $password
+
+puts "\n\n"
+puts "--------------------------------------------------------------------------------------------------"
+puts "                Test Information"
+puts "--------------------------------------------------------------------------------------------------"
+puts "  REST End Point: #{$end_point}"
+puts "  Domain: #{$domain}"
+puts "  Username: #{$username}"
+puts "  Creating New Namespace: #{$namespace.nil?}"
+puts "--------------------------------------------------------------------------------------------------"
+puts "\n\n"
+
+unless ENV['NO_CLEAN']
+  puts "--------------------------------------------------------------------------------------------------"
+  puts "               Resetting environment"
+  puts "--------------------------------------------------------------------------------------------------"
+  # Start with a clean config
+  puts "  Replacing express.conf with the specified libra_server"
+  File.open(RHC::Config::local_config_path, 'w') {|f| f.write("libra_server=#{URI.parse($end_point).host}") }
+
+  puts "  Cleaning up test applications..."
+  FileUtils.rm_rf RHCHelper::TEMP_DIR
+
+  # Cleanup all test applications
+  client = Rhc::Rest::Client.new($end_point, $username, $password)
+  client.domains.each do |domain|
+    domain.applications.each do |app|
+      if app.name.start_with?("test")
+        puts "    Deleting application #{app.name}"
+        app.delete
+      end
+    end
+  end
+
+  puts "  Application cleanup complete"
+  puts "--------------------------------------------------------------------------------------------------"
+  puts "\n\n"
+end
+
+AfterConfiguration do |config|
+  # Create the temporary space
+  FileUtils.mkdir_p RHCHelper::TEMP_DIR
+
+  # Persist the username used for the tests - in case it was auto-generated
+  File.open(File.join(RHCHelper::TEMP_DIR, 'username'), 'w') {|f| f.write($username)}
+
+  # Setup the logger
+  logger = Logger.new(File.join(RHCHelper::TEMP_DIR, "cucumber.log"))
+  logger.level = Logger::DEBUG
+  RHCHelper::Loggable.logger = logger
+
+  # Setup performance monitor logger
+  perf_logger = Logger.new(File.join(RHCHelper::TEMP_DIR, "perfmon.log"))
+  perf_logger.level = Logger::INFO
+  RHCHelper::Loggable.perf_logger = perf_logger
+end
+
+After do |s| 
+  # Tell Cucumber to quit after this scenario is done - if it failed.
+  Cucumber.wants_to_quit = true if s.failed?
+end
+
+World(RHCHelper)

data/features/verify.feature

@@ -0,0 +1,123 @@
+Feature: Client Integration Tests
+  @init
+  Scenario: Setup Wizard
+    Given the libra client tools
+    When the setup wizard is run
+    Then the client tools should be setup
+
+  @init
+  Scenario: Domain Creation
+    Given the libra client tools
+    When a new domain is needed and created
+    Then the domain should be reserved
+
+  @init
+  Scenario: Application Creation
+    Given the libra client tools
+    When 1 php-5.3 applications are created
+    Then the applications should be accessible
+
+  Scenario: Application Stopping
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is stopped
+    Then the application should not be accessible
+
+  Scenario: Application Starting
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is started
+    Then the application should be accessible
+
+  Scenario: Application Restarting
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is restarted
+    Then the application should be accessible
+
+  Scenario: Application Snapshot
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is snapshot
+    Then the snapshot should be found
+
+  Scenario: Application Tidy
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is tidied
+    Then it should succeed
+
+  Scenario: Application Show
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is shown
+    Then it should succeed
+
+  Scenario: Cartridge Add
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the mysql-5.1 cartridge is added
+    Then the mysql-5.1 cartridge should be running
+
+  Scenario: Cartridge Stop
+    Given the libra client tools
+    And an existing php-5.3 application with an embedded mysql-5.1 cartridge
+    When the mysql-5.1 cartridge is stopped
+    Then the mysql-5.1 cartridge should be stopped
+
+  Scenario: Cartridge Start
+    Given the libra client tools
+    And an existing php-5.3 application with an embedded mysql-5.1 cartridge
+    When the mysql-5.1 cartridge is started
+    Then the mysql-5.1 cartridge should be running
+
+  Scenario: Cartridge Restart
+    Given the libra client tools
+    And an existing php-5.3 application with an embedded mysql-5.1 cartridge
+    When the mysql-5.1 cartridge is restarted
+    Then the mysql-5.1 cartridge should be running
+
+  Scenario: Supporting Cartridge Added
+    Given the libra client tools
+    And an existing php-5.3 application with an embedded mysql-5.1 cartridge
+    When the phpmyadmin-3.4 cartridge is added
+    Then the phpmyadmin-3.4 cartridge should be running
+
+  Scenario: Conflicting Cartridge Fails
+    Given the libra client tools
+    And an existing php-5.3 application with embedded mysql-5.1 and phpmyadmin-3.4 cartridges
+    Then adding the postgresql-8.5 cartridge should fail
+
+  Scenario: Cartridge Removed
+    Given the libra client tools
+    And an existing php-5.3 application with embedded mysql-5.1 and phpmyadmin-3.4 cartridges
+    When the phpmyadmin-3.4 cartridge is removed
+    When the mysql-5.1 cartridge is removed
+    Then the phpmyadmin-3.4 cartridge should be removed
+    Then the mysql-5.1 cartridge should be removed
+
+  Scenario: Add Alias
+  Scenario: Remove Alias
+
+  Scenario: Application Destroy
+    Given the libra client tools
+    And an existing php-5.3 application
+    When the application is destroyed
+    Then the application should not be accessible
+
+  @init
+  Scenario: Template Creation
+  Scenario: Domain Changed
+  Scenario: Template Deleted
+  Scenario: Domain Changed Again
+  Scenario: Domain Deleted
+
+  @init
+  Scenario: Key Added
+  Scenario: Additional Key Added
+  Scenario: Default Key Deleted
+  Scenario: Key Overwritten
+  Scenario: Key Deleted
+
+  @init
+  Scenario: Get Server Status

data/lib/rhc/cli.rb

@@ -3,6 +3,7 @@ require 'commander'
 require 'commander/runner'
 require 'commander/delegates'
 require 'rhc/commands'
+require 'rhc/help_formatter'
 
 include Commander::UI
 include Commander::UI::AskForClass
@@ -25,11 +26,13 @@ module RHC
     end
 
     def self.start(args)
-      Commander::Runner.instance_variable_set :@singleton, Commander::Runner.new(args)
+      runner = Commander::Runner.new(args)
+      Commander::Runner.instance_variable_set :@singleton, runner
 
       program :name,        'rhc'
       program :version,     '0.0.0' #FIXME pull from versions.rb
       program :description, 'Command line interface for OpenShift.'
+      program :help_formatter, RHC::UsageHelpFormatter
 
       RHC::Commands.load.to_commander
       exit(run! || 0)

data/lib/rhc/commands/base.rb

@@ -4,15 +4,15 @@ require 'rhc/helpers'
 
 class RHC::Commands::Base
 
-  attr_reader :args, :options
-
-  def initialize(args=[], options={})
-    @args, @options = args, options
+  def initialize(command=nil, args=[], options=OptionParser.new)
+    @command, @args, @options = command, args, options
   end
 
   protected
     include RHC::Helpers
 
+    attr_reader :command, :args, :options
+
     def application
       #@application ||= ... identify current application or throw,
       #                     indicating one is needed.  Should check
@@ -33,6 +33,15 @@ class RHC::Commands::Base
       #                object).
     end
 
+    def config
+      @config ||= begin
+        RHC::Config.set_opts_config(options.config) if options.config
+        RHC::Config.password = options.password if options.password
+        RHC::Config.opts_login = options.rhlogin if options.rhlogin
+        RHC::Config
+      end
+    end
+
     class InvalidCommand < StandardError ; end
 
     def self.inherited(klass)
@@ -49,11 +58,12 @@ class RHC::Commands::Base
       name = [method_name]
       name.unshift(self.object_name).compact!
       raise InvalidCommand, "Either object_name must be set or a non default method defined" if name.empty?
-      RHC::Commands.add({
+      RHC::Commands.add((@options || {}).merge({
         :name => name.join(' '),
         :class => self,
         :method => method,
-      });
+      }));
+      @options = nil
     end
 
     def self.object_name(value=nil)
@@ -64,4 +74,16 @@ class RHC::Commands::Base
           value.to_s.downcase if value
         end
     end
+
+    def self.description(value)
+      options[:description] = value
+    end
+    def self.summary(value)
+      options[:summary] = value
+    end
+
+    private
+      def self.options
+        @options ||= {}
+      end
 end

data/lib/rhc/commands/server.rb

@@ -2,8 +2,11 @@ require 'rhc/commands/base'
 
 module RHC::Commands
   class Server < Base
+
+    summary "Display information about the status of the OpenShift service."
+    description "Retrieves any open issues or notices about the operation of the OpenShift service and displays them in the order they were opened."
     def run
-      status = decode_json(RestClient.get("https://#{openshift_server}/app/status/status.json").body)
+      status = decode_json(RestClient.get("#{openshift_url}/app/status/status.json").body)
       open = status['open']
 
       (success 'All systems running fine' and return 0) if open.blank?

data/lib/rhc/commands/setup.rb

@@ -0,0 +1,24 @@
+require 'rhc/commands/base'
+require 'rhc/wizard'
+require 'rhc/config'
+
+module RHC::Commands
+  class Setup < Base
+
+    summary "Runs the setup wizard to configure your OpenShift account."
+
+    def run
+      # TODO: make help subcommand global
+      if @args.include? 'help'
+        say Commander::Runner.instance.help_formatter.render_command(@command)
+        return 0
+      end
+
+      w = RHC::RerunWizard.new(config.config_path)
+      s = w.run
+
+      # exit 0 on success 1 otherwise
+      s ? 0 : 1
+    end
+  end
+end

data/lib/rhc/commands.rb

@@ -1,5 +1,3 @@
-require 'rhc/config'
-
 module RHC
   module Commands 
     def self.load
@@ -11,13 +9,17 @@ module RHC
     def self.add(opts)
       commands[opts[:name]] = opts
     end
+    def self.global_option(*args)
+      global_options << args
+    end
     def self.to_commander(instance=Commander::Runner.instance)
+      global_options.each{ |args| instance.global_option *args }
       commands.each_pair do |name, opts|
         instance.command name do |c|
-          c.option '--config PATH', String, 'Path of alternate config'
+          c.description = opts[:description]
+          c.summary = opts[:summary]
           c.when_called do |args, options|
-            RHC::Config.set_opts_config(options.config) if options.config
-            opts[:class].new(args, options).send(opts[:method])
+            opts[:class].new(c, args, options).send(opts[:method])
           end
         end
       end
@@ -28,5 +30,8 @@ module RHC
       def self.commands
         @commands ||= {}
       end
+      def self.global_options
+        @options ||= []
+      end
   end
 end

data/lib/rhc/config.rb

@@ -3,37 +3,65 @@ require 'rhc/core_ext'
 
 module RHC
   module Config
-    def self.initialize
+    # FIXME: Config shouldn't really exit
+    #        stub this out for now so we can test it
+    def self.exit(code)
+      # :nocov:
+      Kernel.exit(code)
+      # :nocov:
+    end
+
+    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)
+    rescue Errno::EACCES => e
+      say "Could not open config file: #{e.message}"
+      exit 253
+    end
+
+    def self.set_defaults
       @@defaults = RHC::Vendor::ParseConfig.new()
       @@global_config = nil
       @@local_config = nil
-      @@opts_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']
-
       #
       # Config paths... /etc/openshift/express.conf or $GEM/conf/express.conf -> ~/.openshift/express.conf
       #
-
       @@conf_name = 'express.conf'
-      _linux_cfg = '/etc/openshift/' + @@conf_name
-      _gem_cfg = File.join(File.expand_path(File.dirname(__FILE__) + "/../../conf"), @@conf_name)
-
-      config_path = File.exists?(_linux_cfg) ? _linux_cfg : _gem_cfg
       @@home_dir = File.expand_path("~")
       @@home_conf_path = File.join(@@home_dir, '.openshift')
       @@local_config_path = File.join(@@home_conf_path, @@conf_name)
 
-      begin
-        @@global_config = RHC::Vendor::ParseConfig.new(config_path)
-        @@local_config = RHC::Vendor::ParseConfig.new(File.expand_path(@@local_config_path)) if File.exists?(@@local_config_path)
-      rescue Errno::EACCES => e
-        puts "Could not open config file: #{e.message}"
-        exit 253
-      end
+      # config path passed in on the command line
+      @@opts_config_path = nil
+
+      # authoritive config path
+      # 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
+
+      @@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
+
+    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
     end
 
     self.initialize
@@ -43,11 +71,17 @@ module RHC
       @@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)
+      raise KeyError("Please use RHC::Config.password to access the password config") if key == "password"
+
       # evaluate in cascading order
-      configs = [@@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?
@@ -66,20 +100,37 @@ module RHC
       @@defaults.add('default_rhlogin', username)
     end
 
+    def self.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)
+    end
+
+    def self.password
+      @@opts['password']
+    end
+
     def self.set_local_config(confpath)
       begin
-        @@local_config = RHC::Vendor::ParseConfig.new(File.expand_path(confpath))
+        @@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
-        puts "Could not open config file: #{e.message}"
+        say "Could not open config file: #{e.message}"
         exit 253
       end
     end
 
     def self.set_opts_config(confpath)
       begin
-        @@opts_config = RHC::Vendor::ParseConfig.new(File.expand_path(confpath))
+        @@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
-        puts "Could not open config file: #{e.message}"
+        say "Could not open config file: #{e.message}"
         exit 253
       end
     end
@@ -88,7 +139,7 @@ module RHC
       unless opts["config"].nil?
         opts_config_path = File.expand_path(opts["config"])
         if !File.readable?(opts_config_path)
-          puts "Could not open config file: #{@opts_config_path}"
+          say "Could not open config file: #{@opts_config_path}"
           exit 253
         else
           set_opts_config(opts_config_path)
@@ -113,6 +164,20 @@ module RHC
       not (has_local_config? or has_opts_config?)
     end
 
+    def self.should_run_ssh_wizard?
+      not File.exists? @@ssh_priv_key_file_path
+    end
+
+    ##
+    # config_path
+    #
+    # 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
+    end
+
     def self.local_config_path
       @@local_config_path
     end
@@ -125,6 +190,10 @@ module RHC
       @@home_dir
     end
 
+    def self.ssh_pub_key_file_path
+      @@ssh_pub_key_file_path
+    end
+
     def self.default_rhlogin
       get_value('default_rhlogin')
     end

data/lib/rhc/core_ext.rb

@@ -9,7 +9,16 @@ class Object
     respond_to?(:empty?) ? empty? : !self
   end
 
-  def to_json
-    RHC::Json.encode(self)
+  # Avoid a conflict if to_json is already defined
+  unless Object.new.respond_to? :to_json
+    def to_json(options=nil)
+      RHC::Json.encode(self)
+    end
+  end
+end
+
+class File
+  def chunk(chunk_size=1024)
+    yield read(chunk_size) until eof?
   end
 end

data/lib/rhc/coverage_helper.rb

@@ -0,0 +1,35 @@
+# Must be the first module imported at entry points (executables that run
+# in seperate processes from the test harness) otherwise coverage will be
+# incomplete
+
+if RUBY_VERSION >= '1.9' and ENV['RHC_FEATURE_COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    coverage_dir 'coverage/features/'
+    command_name 'Cucumber Features'
+
+    # Filters - these files will be ignored.
+    add_filter 'lib/rhc/vendor/'   # vendored files should be taken directly and only
+                                   # namespaces changed
+    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])) }
+
+    use_merging = true
+    # Note, the #:nocov: coverage exclusion  should only be used on external functions 
+    #  that cannot be nondestructively tested in a developer environment.
+  end
+
+  # suppress output
+  SimpleCov.at_exit do
+  end
+end

data/lib/rhc/help_formatter.rb

@@ -0,0 +1,30 @@
+require 'commander/help_formatters/base'
+
+module RHC
+  class UsageHelpFormatter < Commander::HelpFormatter::Base
+    def global_options_output
+      result = "Global Options:\n"
+      @runner.options.each { |o|
+        result += o[:switches].join('|')
+        result += "\t#{o[:description]}\n"
+      }
+      result
+    end
+
+    def render
+      # TODO: render the rhc usage when we move 100% to using Commander
+      result = "#{@runner.program(:name)} - #{@runner.program(:description)}\n\n"
+      result += global_options_output
+      result
+    end
+
+    def render_command command
+      result = ""
+      result = "Usage: #{@runner.program(:name)} #{command.name}\n"
+      result += "#{command.summary}\n\n"
+      result += global_options_output
+    end
+  end
+
+  # TODO: class ManPageHelpFormatter
+end