rhc 0.95.14 → 0.96.9

data/lib/rhc-rest/exceptions/exceptions.rb

@@ -66,8 +66,10 @@ module Rhc
     #that authorization has been refused for those credentials. 
     class UnAuthorizedException < Rhc::Rest::ClientErrorException; end
 
-    #I/O Exceptions Connection timeouts, Unreachable host, etc
+    # Unreachable host, SSL Exception
     class ResourceAccessException < Rhc::Rest::BaseException; end
+    #I/O Exceptions Connection timeouts, etc
+    class ConnectionException < Rhc::Rest::BaseException; end
 
   end
 end

data/lib/rhc-rest/key.rb

@@ -17,7 +17,7 @@ module Rhc
         method =  @links['UPDATE']['method']
         payload = {:type => type, :content => content}
         request = RestClient::Request.new(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return send(request)
+        return request(request)
       end
 
       #Delete Key
@@ -26,7 +26,7 @@ module Rhc
         url = @links['DELETE']['href']
         method =  @links['DELETE']['method']
         request = RestClient::Request.new(:url => url, :method => method, :headers => @@headers)
-        return send(request)
+        return request(request)
       end
       alias :delete :destroy
     end

data/lib/rhc-rest/user.rb

@@ -14,7 +14,7 @@ module Rhc
         method =  @links['ADD_KEY']['method']
         payload = {:name => name, :type => type, :content => content}
         request = RestClient::Request.new(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return send(request)
+        return request(request)
       end
 
       #Get all Key for this user
@@ -22,7 +22,7 @@ module Rhc
         url = @links['LIST_KEYS']['href']
         method =  @links['LIST_KEYS']['method']
         request = RestClient::Request.new(:url => url, :method => method, :headers => @@headers)
-        return send(request)
+        return request(request)
       end
 
       #Find Key by name

data/lib/rhc.rb

@@ -7,6 +7,7 @@ require 'logger'
 
 # Extend core methods
 require 'rhc/core_ext'
+require 'rhc/version'
 
 module RHC
   module Commands; end

data/lib/rhc/cli.rb

@@ -30,9 +30,9 @@ module RHC
       Commander::Runner.instance_variable_set :@singleton, runner
 
       program :name,        'rhc'
-      program :version,     '0.0.0' #FIXME pull from versions.rb
+      program :version,     RHC::VERSION::STRING
       program :description, 'Command line interface for OpenShift.'
-      program :help_formatter, RHC::UsageHelpFormatter
+      program :help_formatter, :compact
 
       RHC::Commands.load.to_commander
       exit(run! || 0)

data/lib/rhc/commands/server.rb

@@ -6,7 +6,7 @@ module RHC::Commands
     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("#{openshift_url}/app/status/status.json").body)
+      status = decode_json(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

@@ -4,21 +4,18 @@ 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'
+      if args[0] == '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
+      w.run ? 0 : 1
     end
   end
 end

data/lib/rhc/core_ext.rb

@@ -1,5 +1,6 @@
 # From Rails core_ext/object.rb
 require 'rhc/json'
+require 'open-uri'
 
 class Object
   def present?
@@ -22,3 +23,18 @@ class File
     yield read(chunk_size) until eof?
   end
 end
+
+#
+# Allow http => https redirection, see 
+# http://bugs.ruby-lang.org/issues/859 to 1.8.7 for rough
+# outline of change.
+#
+module OpenURI
+  def self.redirectable?(uri1, uri2) # :nodoc:
+    # This test is intended to forbid a redirection from http://... to
+    # file:///etc/passwd.
+    # However this is ad hoc.  It should be extensible/configurable.
+    uri1.scheme.downcase == uri2.scheme.downcase ||
+    (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)
+  end
+end

data/lib/rhc/helpers.rb

@@ -39,6 +39,18 @@ module RHC
       # Replace with d = DateTime.rfc3339(s)
     end
 
+    #
+    # Web related requests
+    #
+
+    def user_agent
+      "rhc/#{RHC::VERSION::STRING} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})#{" (API #{Rhc::Rest::API_VERSION})" rescue ''}"
+    end
+
+    def get(uri, opts=nil, *args)
+      opts = {'User-Agent' => user_agent}.merge(opts || {})
+      RestClient.get(uri, opts, *args)
+    end
 
     #
     # Global config
@@ -49,8 +61,8 @@ module RHC
       raise "Operations requiring configuration must define a config accessor"
     end
 
-    global_option '-l', '--rhlogin login', "Red Hat login (RHN or OpenShift login with OpenShift access)"
-    global_option '-p', '--password password', "RHLogin password"
+    global_option '-l', '--rhlogin login', "Red Hat login (RedHat Network or OpenShift)"
+    global_option '-p', '--password password', "Red Hat password"
 
     def openshift_server
       config.get_value('libra_server')

data/lib/rhc/version.rb

@@ -0,0 +1,9 @@
+module RHC
+  module VERSION #:nocov:
+    MAJOR = 0
+    MINOR = 96
+    MICRO = 9
+    #PRE  = ''
+    STRING = [MAJOR,MINOR,MICRO].compact.join('.')
+  end
+end

data/spec/coverage_helper.rb

@@ -35,6 +35,7 @@ unless RUBY_VERSION < '1.9'
     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
+    add_filter 'lib/rhc/help_formatter.rb'
 
     # Groups - general categories of test areas
     add_group('Commands') { |src_file| src_file.filename.include?(File.join(%w[lib rhc commands])) }

data/spec/rest_spec_helper.rb

@@ -13,6 +13,11 @@ module RestSpecHelper
     "test_user"
   end
 
+  def stub_api_request(method, uri, with_auth=true)
+    stub_request(method, mock_href(uri, with_auth)).
+      with(&user_agent_header)
+  end
+
   def mock_pass
     "test pass"
   end
@@ -83,4 +88,26 @@ module RestSpecHelper
     [['ADD_KEY',   'user/keys/add', 'post'],
      ['LIST_KEYS', 'user/keys/',    'get' ]]
   end
+
+  def mock_cartridge_response(cart_count=1)
+    carts = []
+    while carts.length < cart_count
+      carts << {
+        :name  => "mock_cart_#{carts.length}",
+        :type  => "mock_cart_#{carts.length}_type",
+        :links => mock_response_links(mock_cart_links('mock_domain','mock_app',"mock_cart_#{carts.length}"))
+      }
+    end
+
+    carts = carts[0] if cart_count == 1
+    type  = cart_count == 1 ? 'cartridge' : 'cartridges'
+
+    return {
+      :body   => {
+        :type => type,
+        :data => carts
+      }.to_json,
+      :status => 200
+    }
+  end
 end

data/spec/rhc/commands/server_spec.rb

@@ -11,14 +11,14 @@ describe RHC::Commands::Server do
     let(:arguments) { ['server'] }
 
     context 'when no issues' do
-      before { stub_request(:get, 'https://openshift.redhat.com/app/status/status.json').to_return(:body => {'issues' => []}.to_json) }
+      before { stub_request(:get, 'https://openshift.redhat.com/app/status/status.json').with(&user_agent_header).to_return(:body => {'issues' => []}.to_json) }
       it('should output success') { run_output.should =~ /All systems running fine/ }
       it { expect { run }.should exit_with_code(0) }
     end
 
     context 'when 1 issue' do
       before do 
-        stub_request(:get, 'https://openshift.redhat.com/app/status/status.json').to_return(:body => 
+        stub_request(:get, 'https://openshift.redhat.com/app/status/status.json').with(&user_agent_header).to_return(:body => 
           {'open' => [
             {'issue' => { 
               'created_at' => '2011-05-22T17:31:32-04:00', 

data/spec/rhc/commands/setup_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'rhc/wizard'
+require 'rhc/config'
+require 'rhc/commands/setup'
+require 'webmock/rspec'
+
+# just test the command runner as we already have extensive wizard tests
+describe RHC::Commands::Setup do
+
+  before(:each) do
+    RHC::Config.set_defaults
+  end
+
+  describe 'run' do
+    let(:arguments) { ['setup', '--config', 'test.conf', '-l', 'test@test.foo', '-p',  'password'] }
+
+    before(:each) do
+        @wizard = mock('wizard')
+        @wizard.stub!(:run).and_return(true)
+        RHC::RerunWizard.stub!(:new) { @wizard }
+    end
+
+    context 'when no issues' do
+      it "should exit 0" do
+        expect { run }.should exit_with_code(0)
+      end
+    end
+
+    context 'when there is an issue' do
+      it "should exit 1" do
+        @wizard.stub!(:run).and_return(false)
+        expect { run }.should exit_with_code(1)
+      end
+    end
+  end
+
+  describe 'help' do
+    let(:arguments) { ['setup', 'help'] }
+
+    context 'help is run' do
+      it "should display help" do
+        @wizard.stub!(:run).and_return(true)
+        expect { run }.should exit_with_code(0)
+      end
+      it('should output usage') { run_output.should match("Runs the setup wizard") }
+    end
+  end
+end

data/spec/rhc/helpers_spec.rb

@@ -242,3 +242,10 @@ describe Object do
     specify('empty string') { ''.blank?.should be_true }
   end
 end
+
+describe OpenURI do
+  context 'redirectable?' do
+    specify('http to https') { OpenURI.redirectable?(URI.parse('http://foo.com'), URI.parse('https://foo.com')).should be_true }
+    specify('https to http') { OpenURI.redirectable?(URI.parse('https://foo.com'), URI.parse('http://foo.com')).should be_false }
+  end
+end

data/spec/rhc/rest_application_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'rest_spec_helper'
+require 'rhc-rest/client'
+
+Spec::Runner.configure do |configuration|
+  include(RestSpecHelper)
+end
+
+module Rhc
+  module Rest
+    describe Application do
+      let (:app_links) { mock_response_links(mock_app_links('mock_domain','mock_app')) }
+      let (:app_obj) {
+        Rhc::Rest::Application.new({ 'domain_id'       => 'mock_domain',
+                                     'name'            => 'mock_app',
+                                     'creation_time'   => Time.now.to_s,
+                                     'uuid'            => 1234,
+                                     'aliases'         => ['alias1','alias2'],
+                                     'server_identity' => mock_uri,
+                                     'links'           => app_links
+                                   })
+      }
+      context "#new" do
+        it "returns an application object" do
+          app = app_obj
+          app.should be_an_instance_of Rhc::Rest::Application
+          app.instance_variable_get(:@links).length.should equal(app_links.length)
+        end
+      end
+
+      context "#add_cartridge" do
+        before do
+          stub_api_request(:any, app_links['ADD_CARTRIDGE']['relative']).
+            to_return(mock_cartridge_response)
+        end
+        it "returns a new cartridge object" do
+          app  = app_obj
+          cart = app.add_cartridge('mock_cart_0')
+          cart.should be_an_instance_of Rhc::Rest::Cartridge
+          cart.instance_variable_get(:@name).should == 'mock_cart_0'
+        end
+      end
+
+      context "#cartridges" do
+        before(:each) do
+          stub_api_request(:any, app_links['LIST_CARTRIDGES']['relative']).
+            to_return(mock_cartridge_response(2)).
+            to_return(mock_cartridge_response(0))
+        end
+        it "returns a list of all cartridges in the current application" do
+          app   = app_obj
+          carts = app.cartridges
+          carts.length.should equal(2)
+          (0..1).each do |idx|
+            carts[idx].should be_an_instance_of Rhc::Rest::Cartridge
+            carts[idx].instance_variable_get(:@name).should == "mock_cart_#{idx}"
+          end
+        end
+        it "returns an empty list if the current app has no cartridges" do
+          app   = app_obj
+          carts = app.cartridges # Disregard the first request;
+          carts = app.cartridges # 2nd request simulates empty response.
+          carts.length.should equal(0)
+        end
+      end
+
+      # These application control tests are subtle; the key lies in making sure the
+      # webmock specifies the expected body that is sent in the request.
+      # This is currently of the form "event=foo"
+      shared_examples_for "a control method" do
+        before do
+          @control_method = control_data[:method]
+          @control_call   = [@control_method]
+          if control_data.has_key?(:arg)
+            @control_call << control_data[:arg]
+          end
+          @control_event  = control_data.has_key?(:event)   ? control_data[:event]       : @control_method.to_s
+          @control_link   = control_data.has_key?(:link)    ? control_data[:link].upcase : @control_method.to_s.upcase
+          @control_output = control_data.has_key?(:result)  ? control_data[:result]      : @control_event
+          @with_payload   = control_data.has_key?(:payload) ? control_data[:payload]     : true
+          if @with_payload
+            stub_api_request(:any, app_links[@control_link]['relative']).
+              with(:body => { 'event' => @control_event }). # This is the critical part
+              to_return({ :body => { :data => @control_event }.to_json, :status => 200 })
+          else
+            stub_api_request(:any, app_links[@control_link]['relative']).
+              to_return({ :body => { :data => @control_event }.to_json, :status => 200 })
+          end
+        end
+        it "sends the control request to the server" do
+          app = app_obj
+          expect { app.send(*@control_call)  }.to_not raise_error
+          app.send(*@control_call).should == @control_output
+        end
+      end
+
+      context "#start" do
+        let(:control_data) { { :method => :start } }
+        it_should_behave_like "a control method"
+      end
+
+      context "#stop" do
+        context " and the request is not forced (force == false)" do
+          let(:control_data) { { :method => :stop } }
+          it_should_behave_like "a control method"
+        end
+        context " and the request is forced (force == true)" do
+          let(:control_data) { { :method => :stop, :arg => true, :event => 'force-stop', :link => 'stop' } }
+          it_should_behave_like "a control method"
+        end
+      end
+
+      context "#restart" do
+        let(:control_data) { { :method => :restart } }
+        it_should_behave_like "a control method"
+      end
+
+      context "#delete" do
+        let(:control_data) { { :method => :delete, :payload => false } }
+        it_should_behave_like "a control method"
+      end
+
+      context "#destroy" do
+        let(:control_data) { { :method => :destroy, :event => 'delete', :link => 'delete', :payload => false } }
+        it_should_behave_like "a control method"
+      end
+    end
+  end
+end
+

data/spec/rhc/rest_client_spec.rb

@@ -29,18 +29,19 @@ module Rhc
       let(:domain_0_links) { mock_response_links(mock_domain_links('mock_domain_0')) }
       let(:domain_1_links) { mock_response_links(mock_domain_links('mock_domain_1')) }
       let(:user_links)     { mock_response_links(mock_user_links) }
-        
+
       context "#new" do
         before do
-          stub_request(:get, mock_href('', true)).
+          stub_api_request(:get, '').
             to_return({ :body   => { :data => client_links }.to_json,
                         :status => 200
                       })
-          stub_request(:get, mock_href('api_error', true)).
+          stub_api_request(:get, 'api_error').
             to_raise(RestClient::ExceptionWithResponse.new('API Error'))
-          stub_request(:get, mock_href('other_error', true)).
+          stub_api_request(:get, 'other_error').
             to_raise(Exception.new('Other Error'))
         end
+
         it "returns a client object from the required arguments" do
           credentials = Base64.encode64(mock_user + ":" + mock_pass)
           client      = Rhc::Rest::Client.new(mock_href, mock_user, mock_pass)
@@ -59,7 +60,7 @@ module Rhc
 
       context "with an instantiated client " do
         before(:each) do
-          stub_request(:get, mock_href('', true)).
+          stub_api_request(:get, '').
             to_return({ :body   => { :data => client_links }.to_json,
                         :status => 200
                       })
@@ -68,7 +69,7 @@ module Rhc
 
         context "#add_domain" do
           before do
-            stub_request(:any, mock_href(client_links['ADD_DOMAIN']['relative'], true)).
+            stub_api_request(:any, client_links['ADD_DOMAIN']['relative']).
               to_return({ :body   => {
                             :type => 'domain',
                             :data => {
@@ -90,7 +91,7 @@ module Rhc
 
         context "#domains" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['LIST_DOMAINS']['relative'], true)).
+            stub_api_request(:any, client_links['LIST_DOMAINS']['relative']).
               to_return({ :body   => {
                             :type => 'domains',
                             :data =>
@@ -130,7 +131,7 @@ module Rhc
 
         context "#find_domain" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['LIST_DOMAINS']['relative'], true)).
+            stub_api_request(:any, client_links['LIST_DOMAINS']['relative']).
               to_return({ :body   => {
                             :type => 'domains',
                             :data =>
@@ -157,7 +158,7 @@ module Rhc
 
         context "#find_application" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['LIST_DOMAINS']['relative'], true)).
+            stub_api_request(:any, client_links['LIST_DOMAINS']['relative']).
               to_return({ :body   => {
                             :type => 'domains',
                             :data =>
@@ -170,7 +171,7 @@ module Rhc
                           }.to_json,
                           :status => 200
                         })
-            stub_request(:any, mock_href(domain_0_links['LIST_APPLICATIONS']['relative'], true)).
+            stub_api_request(:any, domain_0_links['LIST_APPLICATIONS']['relative']).
               to_return({ :body   => {
                             :type => 'applications',
                             :data =>
@@ -185,7 +186,7 @@ module Rhc
                           }.to_json,
                           :status => 200
                         })
-            stub_request(:any, mock_href(domain_1_links['LIST_APPLICATIONS']['relative'], true)).
+            stub_api_request(:any, domain_1_links['LIST_APPLICATIONS']['relative']).
               to_return({ :body   => {
                             :type => 'applications',
                             :data =>
@@ -220,7 +221,7 @@ module Rhc
         
         context "#cartridges" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['LIST_CARTRIDGES']['relative'], true)).
+            stub_api_request(:any, client_links['LIST_CARTRIDGES']['relative']).
               to_return({ :body   => {
                             :type => 'cartridges',
                             :data =>
@@ -263,7 +264,7 @@ module Rhc
         
         context "#find_cartridge" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['LIST_CARTRIDGES']['relative'], true)).
+            stub_api_request(:any, client_links['LIST_CARTRIDGES']['relative']).
               to_return({ :body   => {
                             :type => 'cartridges',
                             :data =>
@@ -296,7 +297,7 @@ module Rhc
         
         context "#user" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['GET_USER']['relative'], true)).
+            stub_api_request(:any, client_links['GET_USER']['relative']).
               to_return({ :body   => {
                             :type => 'user',
                             :data =>
@@ -317,7 +318,7 @@ module Rhc
 
         context "#find_key" do
           before(:each) do
-            stub_request(:any, mock_href(client_links['GET_USER']['relative'], true)).
+            stub_api_request(:any, client_links['GET_USER']['relative']).
               to_return({ :body   => {
                             :type => 'user',
                             :data =>
@@ -327,7 +328,7 @@ module Rhc
                           }.to_json,
                           :status => 200
                         })
-            stub_request(:any, mock_href(user_links['LIST_KEYS']['relative'], true)).
+            stub_api_request(:any, user_links['LIST_KEYS']['relative']).
               to_return({ :body   => {
                             :type => 'keys',
                             :data =>
@@ -363,7 +364,7 @@ module Rhc
 
         shared_examples_for "a logout method" do
           before(:each) do
-            stub_request(:get, mock_href('', true)).
+            stub_api_request(:get, '').
               to_return({ :body   => { :data => client_links }.to_json,
                           :status => 200
                         })