rhcp_shell 0.0.6 → 0.0.7

data/lib/rhcp_shell.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+require "readline"
+require "logger"
+require "getoptlong"
+
+require 'rubygems'
+
+require 'rhcp'
+
+require 'base_shell'
+require 'rhcp_shell_backend'
+
+# TODO version number
+SHELL_VERSION = "0.1"
+
+class RhcpShell
+
+HELP_STRING = <<EOF
+
+RHCP Command Shell v #{SHELL_VERSION} (using RHCP library v #{RHCP::Version.to_s})
+
+Usage:
+  rhcp_shell.rb [--hostname=<hostname>] [--username=<username> --password=<password>] 
+         [--help]
+         
+Options:
+  --hostname=<hostname> 
+    the URL to the RHCP server you want to connect against, e.g.
+      http://server.local.network/rhcp
+    If the specified hostname does not start with "http", it is automatically expanded to
+      http://<hostname>:42000/rhcp
+    You can optionally specify a port number to connect against like this:
+      http://myserver:42000
+    If you do not specify a hostname, the shell will try to connect against 
+      http://localhost:42000
+      
+  --username/--password       
+    the authentication data you want to use for connecting to the RHCP server
+    
+  --help
+    displays this help screen.      
+
+EOF
+
+  def run
+    opts = GetoptLong.new(
+      [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+      [ '--username', '-u', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--password', '-p', GetoptLong::REQUIRED_ARGUMENT ],
+      [ '--hostname', GetoptLong::REQUIRED_ARGUMENT ]
+    )
+    
+    options = Hash.new
+    opts.each do |opt, arg|
+      case opt
+        when '--help'
+          puts HELP_STRING
+          Kernel.exit(1)
+        else
+          opt =~ /--(.+)/
+          $logger.debug "setting #{arg} for #{$1}" unless $1 == "password"
+          options[$1] = arg
+      end
+    end
+    
+    host = options["hostname"]
+    if host == nil then
+      host = "http://localhost:42000"      
+    else
+      if host !~ /http:/ then
+        host = "http://#{host}:42000/rhcp"
+      end  
+    end
+    $logger.debug "now connecting to #{host}"
+    
+    # TODO add interactive query for password!
+    
+    begin
+      url = URI.parse(host)
+      @http_broker = RHCP::Client::HttpBroker.new(url)
+      
+      backend = RHCPShellBackend.new(@http_broker)
+      backend.banner = <<EOF
+Good morning, this is the generic RHCP Shell.
+Press <tab> for command completion or type "help" for a list of commands.
+If you want to exit this shell, please press Ctrl+C or type "exit".
+
+EOF
+      $logger.debug "backend has been instantiated : #{backend}"
+      
+      shell = BaseShell.new(backend)
+      shell.run
+    rescue => ex
+      puts "There occurred an HTTP error while connecting to the RHCP: #{ex}"
+      puts "Please connect against another server or fix the connection problem."
+      puts ex.backtrace.join("\n")
+    end
+  end
+end  
+  
+  
+# TODO introduce something like the RAILS_ENVs
+$logger = Logger.new("rhcp_shell.log")
+RHCP::ModuleHelper.instance().logger = $logger
+
+shell = RhcpShell.new
+shell.run

data/lib/rhcp_shell_backend.rb

@@ -272,6 +272,7 @@ class RHCPShellBackend < ShellBackend
       response = command.execute_request(request)      
       if (response.status == RHCP::Response::Status::OK)
         $logger.debug "raw result : #{response.data}"
+         $logger.debug "result hints: #{command.result_hints}"
         $logger.debug "display_type : #{command.result_hints[:display_type]}"
         if command.result_hints[:display_type] == "table"
           @last_response = response  # we might want to access this response in further commands
@@ -281,16 +282,19 @@ class RHCPShellBackend < ShellBackend
           output = ""         
           
           # let's find out which columns we want to display
-          $logger.debug "overview columns : #{command.result_hints[:overview_columns]}"          
+          $logger.debug "overview columns : #{command.result_hints[:overview_columns]}"
+          # TODO this will probably fail if no overview_columns are specified
           columns_to_display = command.result_hints.has_key?(:overview_columns) ?
             command.result_hints[:overview_columns].clone() :
             # by default, we'll display all columns, sorted alphabetically
             columns_to_display = response.data[0].keys.sort
           
           # and which titles they should have (default : column names)
-          column_title_list = command.result_hints.has_key?(:column_titles) ?
+          $logger.debug "column titles : #{command.result_hints[:column_titles].length}"
+          column_title_list = command.result_hints[:column_titles].length > 0 ?
             command.result_hints[:column_titles].clone() :
-            column_title_list = columns_to_display 
+            column_title_list = columns_to_display
+          $logger.debug "column title list : #{column_title_list}"
           
           # TODO the sorting column should be configurable
           first_column = columns_to_display[0]
@@ -306,15 +310,18 @@ class RHCPShellBackend < ShellBackend
             count = count+1
           end
           
-          
           column_titles = {}
           0.upto(column_title_list.length - 1) do |i|
             column_titles[columns_to_display[i]] = column_title_list[i]
           end
-          $logger.debug "column title : #{column_titles}"
+          $logger.debug "column titles : #{column_titles}"
           
-          # find the maximum column width for each column
+          # initialize the max_width for all columns
           @max_width = {}
+          column_titles.each do |key, value|
+            @max_width[key] = 0
+          end
+          # find the maximum column width for each column
           response.data.each do |row|
             row.each do |k,v|
               if ! @max_width.has_key?(k) || v.to_s.length >  @max_width[k]
@@ -323,7 +330,7 @@ class RHCPShellBackend < ShellBackend
             end
           end
           
-          # check the column_title
+          # check the column_title for max width
           columns_to_display.each do |col_name|
             if column_titles[col_name].length > @max_width[col_name]
               @max_width[col_name] = column_titles[col_name].length

data/lib/version.rb

@@ -5,7 +5,7 @@ module RhcpShell #:nodoc:
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 6
+    TINY  = 7
 
     def Version.to_s
       [ MAJOR, MINOR, TINY ].join(".")

data/test/rhcp_shell_backend_test.rb

@@ -63,8 +63,11 @@ class RhcpShellBackendTest < Test::Unit::TestCase
     #puts "log now : >>#{@log.join("\n")}<<"
   end
   
-  def assert_received(expected)    
-    assert_equal(expected, @log.slice(- expected.length, expected.length))
+  def assert_received(expected)
+    @log_slice = expected.length < @log.length ?
+      @log.slice(- expected.length, expected.length) :
+      @log
+    assert_equal(expected, @log_slice)
     # clean the log so that assert_no_error works
     #@log.clear
   end
@@ -224,13 +227,45 @@ class RhcpShellBackendTest < Test::Unit::TestCase
     # TODO write a separate test for this stuff
     p $broker.get_command("build_a_table")
     @backend.process_input "build_a_table"
-#    assert_received [
-#      "Zaphod\tBeeblebrox",
-#      "Arthur\tDent",
-#      "Prostetnik\tYoltz(?)"
-#    ]
+#   puts "===================\n#{@log}\n=====================\n"
+    assert_received [
+      "---------------------------------------\n" +
+      "| # | __idx | first_name | last_name  |\n" +
+      "---------------------------------------\n" +
+      "|   | 1     | Arthur     | Dent       |\n" +
+      "|   | 2     | Prostetnik | Yoltz (?)  |\n" +
+      "|   | 3     | Zaphod     | Beeblebrox |\n" +
+      "---------------------------------------\n"
+    ]
   end
   
+  def test_empty_table
+    @backend.process_input "build_a_table empty=true"
+    assert_received [
+      "--------------------------------------\n" +
+      "| # | __idx | first_name | last_name |\n" +
+      "--------------------------------------\n" +
+      "--------------------------------------\n"
+    ]
+    puts "===================\n#{@log}\n=====================\n"
+  end
+
   # TODO test behaviour after an internal error occurred in the shell (e.g. some problem while formatting the result)
+#  E, [2009-09-17T01:21:53.399309 #9118] ERROR -- : comparison of Fixnum with nil failed (ArgumentError)
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:335:in `>'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:335:in `execute_command'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:334:in `each'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:334:in `execute_command'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:183:in `execute_command_if_possible'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/rhcp_shell_backend.rb:475:in `process_input'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:93:in `run'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:84:in `initialize'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:84:in `new'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:84:in `run'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:83:in `loop'
+#  /var/lib/gems/1.8/gems/rhcp_shell-0.0.7/lib/base_shell.rb:83:in `run'
+#  ./virtualop_rhcp.rb:131:in `setup_local_shell'
+#  ./virtualop_rhcp.rb:168
+#  exception raised: comparison of Fixnum with nil failed
   
 end

data/test/setup_test_registry.rb

@@ -92,13 +92,19 @@ broker.register_command command
 
 command2 = RHCP::Command.new("build_a_table", "this command returns tabular data", 
   lambda { |req,res|
-    [ 
-      { :first_name => "Zaphod", :last_name => "Beeblebrox", :heads => 2, :character => "dangerous" },
-      { :first_name => "Arthur", :last_name => "Dent", :heads => 1, :character => "harmless (mostly)" },
-      { :first_name => "Prostetnik", :last_name => "Yoltz (?)", :heads => 1, :character => "ugly" }
+    req.has_param_value("empty") ? [] :
+    [
+      { "first_name" => "Zaphod", "last_name" => "Beeblebrox", "heads" => 2, "character" => "dangerous" },
+      { "first_name" => "Arthur", "last_name" => "Dent", "heads" => 1, "character" => "harmless (mostly)" },
+      { "first_name" => "Prostetnik", "last_name" => "Yoltz (?)", "heads" => 1, "character" => "ugly" }
     ]
   }
-)
+).add_param(RHCP::CommandParam.new("empty", "if this is true, the table will be empty",
+      {
+        :mandatory => false,
+        :is_default_param => true
+      }
+))
 command2.mark_as_read_only()
 command2.result_hints[:display_type] = "table"
 command2.result_hints[:overview_columns] = [ "first_name", "last_name" ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rhcp_shell
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Philipp Traeder
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-21 00:00:00 +01:00
+date: 2009-09-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,13 +32,15 @@ extra_rdoc_files: []
 
 files: 
 - bin/rhcp_shell
-- lib/test.log
 - lib/shell_backend.rb
+- lib/rhcp_shell.rb
 - lib/base_shell.rb
-- lib/version.rb
+- lib/test.log
 - lib/rhcp_shell_backend.rb
-- test/setup_test_registry.rb
+- lib/version.rb
+- lib/rhcp_shell.log
 - test/rhcp_shell_backend_test.rb
+- test/setup_test_registry.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/rhcp
 post_install_message: