rhc 0.97.17 → 0.98.16

data/bin/rhc

@@ -39,7 +39,14 @@ def get_args
 end
 
 def run_setup_wizard_if_needed
-  default_setup_wizard unless ARGV.delete('--noprompt')
+  if not (RHC::Config.has_local_config? or
+          RHC::Config.has_opts_config? or
+          ARGV.include?('--noprompt') or
+          ARGV.include?('--help') or
+          ARGV.include?('-h'))
+    RHC::Wizard.new(RHC::Config).run
+  end
+  ARGV.delete('--noprompt')
 end
 
 begin
@@ -48,17 +55,10 @@ begin
     run_setup_wizard_if_needed
     system("rhc-app #{get_args} 2>&1")
     retcode = $?.exitstatus
-  when "sshkey"
-    run_setup_wizard_if_needed
-    system("rhc-sshkey #{get_args} 2>&1")
-    retcode = $?.exitstatus
-  when "port-forward"
-    run_setup_wizard_if_needed
-    system("rhc-port-forward #{get_args} 2>&1")
-    retcode = $?.exitstatus
   else
     begin
       require 'rhc/cli'
+      RHC::CLI.set_terminal
       RHC::CLI.start(ARGV)
       retcode = 0
     rescue SystemExit => e

data/bin/rhc-port-forward

@@ -4,6 +4,9 @@ require 'rhc/coverage_helper'
 
 require 'rhc-common'
 
+puts "Warning: This command is deprecated and will be removed in the future. Please use 'rhc port-forward' instead."
+puts""
+
 #
 # print help
 #

data/bin/rhc-sshkey

@@ -4,6 +4,9 @@ require 'rhc/coverage_helper'
 
 require 'rhc-common'
 
+puts "Warning: This command is deprecated and will be removed in the future. Please use 'rhc sshkey' instead."
+puts""
+
 #
 # print help
 #

data/features/README.md

@@ -3,68 +3,196 @@ 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
+independent and will shell out to execute the `rhc *` commands to emulate a
+user as closely as possible.  These tests exercise both the command-line
 client and the underlying infrastructure and serve as integration level
 verification tests for the entire stack.
 
 Usage
 =============
 
-Run from the base directory with 
+Run from the base directory with
 
-   <env variables> bundle exec rake features
+```
+<env variables> bundle exec rake features
+```
 
-'features' requires RHC_USERNAME+RHC_PASSWORD+RHC_NAMESPACE or
-RHC_ENDPOINT to be set in the environment.
+At the very least, you will probably want to specify `RHC_SERVER` (or
+the tests will run against the production OpenShift server by default).
 
-Using a proxy
---------------
+You may also want to specify credentials to use a specific account on
+the OpenShift server.
 
-You can use a proxy by setting the http_proxy environment variable.  For example
+All of these environment variables are described in detail in [the
+next section](#environment-variables).
 
-    http_proxy='http://proxyserver:proxyport/' bundle exec rake features
+If you are developing tests, or want to run specific tests, make sure to
+check out the [development usage section](#development-usage).
 
-Pre-defined users
------------------
+Environment Variables
+=====================
+Much of the configuration for these tests is controlled through
+environment variables.
+They can be used with either the `rake` commands or when executing
+`cucumber` directly.
+
+http_proxy
+----------
+Since the `rhc` tools use a HTTP based REST API, if you need a proxy to
+access the server you are testing against, you will need to specify a
+proxy. For instance:
+
+    http_proxy='http://proxyserver:proxyport/'
+
+GIT_SSH
+-------
+This is automatically set in `features/support/env.rb` but can be
+overridden if desired.
+
+This environment variable will be used by any `git` or `ssh` commands.
+Currently, we are using it to bypass host key validation because the
+user will be connecting to unknown hosts (the new OpenShift apps).
+Without this variable, the tests will wait for approval before
+connecting to the host.
+
+RHC_DEV
+-------
+If set, this will use the `libra_server` specified in
+`~/.openshift/express.conf` for `RHC_SERVER` (unless `RHC_SERVER` is
+also specified).
+
+RHC_(SERVER|ENDPOINT)
+---------------------
+This is the server/endpoint the tests will execute against.
+
+If `RHC_SERVER` is set, it will set `RHC_ENDPOINT` to be
+`https://#{RHC_SERVER}/broker/rest/api`.
+
+If you need to point to another API endpoint, you can also specify the full
+`RHC_ENDPOINT`.
+
+If not set, these will default to the production OpenShift server.
 
+RHC_(USERNAME|PASSWORD|NAMESPACE)
+-----------------
 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:
+These variables allow the tests to be run with the defined credentials
+instead of randomly generating new ones.
+
+NO_CLEAN
+--------
+This option prevents the tests from deleting the existing apps in this
+namespace before running the tests.
+It also prevents the tests from replacing the existing
+`~/.openshift/express.conf`.
 
-    RHC_USERNAME='mylogin@example.com' RHC_PASSWORD='supersecretpassword' RHC_NAMESPACE='mynamespace' bundle exec rake features
+If this is specified, the script will use values stored in `/tmp/rhc/(username|namespace)` (unless overridden by `RHC_(USERNAME|NAMESPACE)`).
 
 Development Usage
 =================
+When developing new features, whether for the `rhc` tools or OpenShift
+server, these tests will help to ensure the tools continue to function
+properly.
 
-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:
+Running Tests
+-------------
+First, and foremost, you will want be able to run the tests.
+Often when you are developing new tests, you don't want to run the entire suite
+each time.
+There are two ways to run them.
 
-    RHC_ENDPOINT='https://myserver/rest/api' bundle exec rake features
+1. The `rake` command may add additional functionality, such as coverage
+reporting.
+  To run the test, simply run
 
+    ```
+    <env variables> bundle exec rake features
+    ```
 
-Developing tests
-----------------
+1. Running the tests directly via `cucumber` gives you some more
+flexibility as to which tests to run. You can run `cucumber` using any of the techniques [shown
+here](https://github.com/cucumber/cucumber/wiki/Running-Features).
 
-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
+    For instance:
 
-    RHC_ENDPOINT='https://yourserver/rest/api' bundle exec cucumber -t @init
+    ```
+    # This runs all scenarios with the @application tag that also do not
+    #   have the @init tag
+    cucumber features -t @application -t ~@init
+    # This runs the scenario starting at a specific line in the file
+    cucumber features/application.feature:42
+    ```
 
-* 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
+Developing tests
+----------------
 
-    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
+Due to their nature, some tests require previous state to
+function properly.
+For instance, in order to test adding cartridges to an application, an
+application must exist first.
+
+When the tests are run in order, this state is reused.
+We have also devised a technique using before_hooks and backgrounds to
+ensure the environment is in the correct state.
+
+When a feature is run, there is generally a scenario tagged `@init` which does some sort of initialization step (such as creating an
+application).
+
+Normally, the other scenarios in the same feature will depend on this step to function
+properly.
+However, there are before_hooks defined for any `~@init` steps that
+ensure that state is in place.
+This way, you can run any scenario and know that you will have the same
+state as if the `@init` step was run.
+
+
+### Example
+In our feature file, we may have something like this:
+
+```
+@demo
+Feature: Demonstrating Hooks
+
+  @init
+  Scenario: Setting Up Demo
+    Given we are giving a demo
+    Then the demo directory should exist
+
+  Scenario: Running a Demo
+    Then we should start the demo
+
+  Scenario: Deleting a demo
+    Then the demo should be deleted
+```
+
+Notice we don't have another `Given` statement in our second or third scenario.
+We take care of that in our before hooks.
+If we were to run either of those scenarios on their own, they would fail.
+We fix this by defining a step that can set the expected state if it
+doesn't exist.
+
+```
+Given "a demo directory exists or is created" do
+  begin
+    Given "the demo directory exists"
+  rescue Spec::Expectations::ExpectationNotMetError
+    Then "create the demo directory"
+  end
+end
+```
+
+Now we can define a `before_hook` that runs our steps before any
+scenarios that are not tagged `@init`.
+
+```
+Before('@demo','~@init') do
+  Given "a demo directory exists or is created"
+end
+```
+
+After following these steps, we can confidently run any of our scenarios
+and know that they will be in the state they expect.

data/features/application.feature

@@ -0,0 +1,24 @@
+@application @domain_required
+Feature: Application Operations
+
+  @init
+  Scenario: Application Creation
+    When a php-5.3 application is created
+    Then the application should be accessible
+
+  # The state in these examples should be able to be broken into before hooks when we update cucumber
+  Scenario Outline: Running Application Commands
+    Given we have a <state> application
+    When the application is <command>
+    Then <what> should <status>
+
+    # Breaking these examples up so they can flow logically, but also be run individually
+    Examples:
+      | state   | command   | what            | status |
+      | running | restarted | the application | be accessible |
+      | running | snapshot  | the snapshot    | be found |
+      | running | tidied    | it              | succeed |
+      | running | shown     | it              | succeed |
+      | running | stopped   | the application | not be accessible |
+      | stopped | started   | the application | be accessible |
+      | running | destroyed | the application | not exist |

data/features/cartridge.feature

@@ -0,0 +1,24 @@
+@single_cartridge @domain_required
+Feature: Single Cartridge Tests
+
+  # Need to keep these outlines duplicated until we update cucumber to allow tagged examples
+
+  @init
+  Scenario Outline: Cartridge Commands
+    When the <type> cartridge is <command>
+    Then the <type> cartridge should be <status>
+
+    Examples:
+      | type            | command   | status  |
+      | mysql-5.1       | added     | running |
+
+  Scenario Outline: Cartridge Commands
+    Given we have a <state> mysql-5.1 cartridge
+    When the mysql-5.1 cartridge is <command>
+    Then the mysql-5.1 cartridge should be <status>
+
+    Examples:
+      | state   | command   | status  |
+      | running | restarted | running |
+      | running | stopped   | stopped |
+      | stopped | started   | running |

data/features/client.feature

@@ -0,0 +1,11 @@
+@client
+Feature: Client Integration Tests
+  Background:
+    Given the libra client tools
+
+  @init
+  Scenario: Setup Wizard
+    When the setup wizard is run
+    Then the client tools should be setup
+
+  Scenario: Get Server Status

data/features/domain.feature

@@ -0,0 +1,29 @@
+@domain @client_tools_required
+Feature: Existing Domain Operations
+
+  @init
+  Scenario: Domain Creation
+    When a new domain is needed and created
+    Then the domain should be reserved
+
+  Scenario: Domain Update
+    When domain is updated
+    Then the domain should be reserved
+
+  Scenario: Domain Show
+    When rhc domain is run
+    When rhc domain show is run
+    Then the default domain action output should equal the show action output
+
+  Scenario: Domain Create Fails
+    When rhc domain create is called
+    Then the domain command should fail with an exitcode of 128
+
+  Scenario: Domain Delete
+    When domain is deleted
+    Then domains should be empty
+
+  Scenario: Domain Update Fails
+    When domain is deleted
+    When domain is updated
+    Then the domain command should fail with an exitcode of 127

data/features/lib/rhc_helper.rb

@@ -1,3 +1,16 @@
+require 'rubygems'
+require 'active_support/ordered_hash'
+require 'tmpdir'
+
+### Some shared constant declarations
+module RHCHelper
+  TEMP_DIR = File.join(Dir.tmpdir, "rhc") unless const_defined?(:TEMP_DIR)
+  # The regex to parse the ssh output from the create app results
+  SSH_OUTPUT_PATTERN = %r|ssh://([^@]+)@([^/]+)| unless const_defined?(:SSH_OUTPUT_PATTERN)
+  # Regex to parse passwords out of logging messages
+  PASSWORD_REGEX = / -p [^\s]* / unless const_defined?(:PASSWORD_REGEX)
+end
+
 require 'rhc_helper/loggable'
 require 'rhc_helper/commandify'
 require 'rhc_helper/httpify'
@@ -5,3 +18,4 @@ require 'rhc_helper/persistable'
 require 'rhc_helper/runnable'
 require 'rhc_helper/app'
 require 'rhc_helper/domain'
+require 'rhc_helper/sshkey'

data/features/lib/rhc_helper/app.rb

@@ -1,12 +1,6 @@
-require 'tmpdir'
-require 'rhc-rest'
+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.
@@ -55,7 +49,7 @@ module RHCHelper
 
     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)
+      client = RHC::Rest::Client.new($end_point, $username, $password)
 
       # Cleanup all test applications
       test_names = []

data/features/lib/rhc_helper/cartridge.rb

@@ -1,12 +1,6 @@
-require 'tmpdir'
-require 'rhc-rest'
+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.

data/features/lib/rhc_helper/commandify.rb

@@ -48,7 +48,7 @@ module RHCHelper
     end
 
     # Print out the command arguments based on the state of the application instance
-    def get_args(cmd, cartridge=nil, debug=true)
+    def get_args(cmd, arg0=nil, debug=true)
       args = " "
       args << "-l #{$username} "
       args << "-p #{$password} "
@@ -80,8 +80,12 @@ module RHCHelper
           raise "No alias set" unless @alias
           args << "--alias #{@alias} "
         when /cartridge/
-          raise "No cartridge supplied" unless cartridge
-          args << "-c #{cartridge}"
+          raise "No cartridge supplied" unless arg0
+          args << "-c #{arg0}"
+        when /sshkey/
+          # in RHCHelper::Sshkey, we pass *args to method_missing here, so that
+          # we _know_ that arg0 is an Array.
+          args << arg0.first if arg0.first
       end
 
       args.rstrip
@@ -115,9 +119,6 @@ module RHCHelper
     end
   end
 
-  # The regex to parse the ssh output from the create app results
-  SSH_OUTPUT_PATTERN = %r|ssh://([^@]+)@([^/]+)|
-
   #
   # Begin Post Processing Callbacks
   #
@@ -180,4 +181,34 @@ module RHCHelper
     @exitcode = exitcode
   end
 
+  def sshkey_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+  
+  def sshkey_add_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+
+  def sshkey_list_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+
+  def sshkey_show_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+  
+  def sshkey_update_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+
+  def sshkey_delete_callback(exitcode, stdout, stderr, arg)
+    @sshkey_output = stdout
+    @exitcode = exitcode
+  end
+
 end