rhcp 0.1.9 → 0.2.14

data/test/rhcp/test_base.rb

@@ -0,0 +1,25 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+
+require 'test/unit'
+require 'logger'
+require 'mocha'
+
+$logger = Logger.new(STDOUT)
+
+class TestBase < Test::Unit::TestCase
+
+  def test_fine
+    $logger.debug "There's absolutely no cause for alarm."
+  end
+
+  def read_file(filename)
+    file_name = File.dirname(__FILE__) + '/data/' + filename
+    File.new(file_name).read
+  end
+
+  def read_yaml(filename)
+    file_name = File.dirname(__FILE__) + '/data/' + filename
+    YAML::load(File.open(file_name))
+  end
+
+end

data/test/rhcp/tests_for_brokers.rb

@@ -0,0 +1,186 @@
+module TestsForBrokers
+
+  def test_command_list_with_context
+    command = RHCP::Command.new("test", "a test command that is enabled for hosts only", lambda {})
+    command.enabled_through_context_keys = ['host']
+    @broker.register_command command
+    command2 = RHCP::Command.new("test2", "a test command should always be enabled", lambda {})
+    @broker.register_command command2
+
+    assert_equal 1, @test_broker.get_command_list().size()
+    context = RHCP::Context.new()
+    context.cookies['host'] = 'deepthought'
+    assert_equal 2, @test_broker.get_command_list(context).size()
+  end
+
+    # it should not be possible to call get_command() for a command that is
+  # disabled through the context
+  def test_get_command_with_context
+    command = RHCP::Command.new("test", "a test command that is enabled for hosts only", lambda {})
+    command.enabled_through_context_keys = ['host']
+    @broker.register_command command
+    command2 = RHCP::Command.new("test2", "a test command should always be enabled", lambda {})
+    @broker.register_command command2
+
+    assert @test_broker.get_command("test2")
+    assert_raise(RHCP::RhcpException) {
+      @test_broker.get_command("test")
+    }
+    context = RHCP::Context.new()
+    context.cookies['host'] = 'deepthought'
+    assert @test_broker.get_command("test", context)
+  end
+
+  def test_get_lookup_values
+    command = RHCP::Command.new("test", "a test command with lookup values", lambda {})
+    command.add_param RHCP::CommandParam.new("first_param", "first param",
+        {
+          :is_default_param => true,
+          :lookup_method => lambda {
+            [ "wind", "sun", "boat" ]
+          }
+        }
+    )
+    command.add_param RHCP::CommandParam.new("second_param", "this param's lookup values depend on the first param",
+        {
+          :lookup_method => lambda { |request|
+            $logger.debug "in lookup : #{request}"
+            if request.has_param_value("first_param")
+              request.get_param_value("first_param").map do |item|
+                item.reverse
+              end
+            else
+              [ "wind", "sun", "boat" ]
+            end
+          }
+        }
+    )
+    command.add_param RHCP::CommandParam.new("host", "host dummy param",
+      {
+        :mandatory => false,
+        :autofill_context_key => "host"
+      }
+    )
+    command.add_param RHCP::CommandParam.new("third_param", "this param's lookup values depend on context",
+        {
+          :lookup_method => lambda { |request|
+            result = []
+            if request.has_param_value("host")
+              1.upto(3) do |loop|
+                result << request.get_param_value("host") + "_service#{loop}"
+              end
+            else
+              result = [ "wind", "sun", "boat" ]
+            end
+            result
+          }
+        }
+    )
+    @broker.register_command command
+
+    # no values collected so far, no context
+    request = RHCP::Request.new(command, { })
+    assert_equal [ "wind", "sun", "boat" ].sort, @test_broker.get_lookup_values(request, "first_param").sort
+    assert_equal [ "wind", "sun", "boat" ].sort, @test_broker.get_lookup_values(request, "second_param").sort
+    # lookup values can depend on other params' values
+#    context = RHCP::Context.new()
+#    context.collected_values["first_param"] = "zaphod"
+    request = RHCP::Request.new(command, { "first_param" => "wind" })
+    assert_equal [ "dniw" ], @test_broker.get_lookup_values(request, "second_param")
+    # or on the context
+    request = RHCP::Request.new(command, {}, RHCP::Context.new({"host" => "endeavour"}))
+    assert_equal [ "endeavour_service1", "endeavour_service2", "endeavour_service3" ].sort,
+      @test_broker.get_lookup_values(request, "third_param").sort
+  end
+
+  def test_param_is_valid
+    command = RHCP::Command.new("test", "a test command with lookup values", lambda {})
+    command.add_param RHCP::CommandParam.new("first_param", "first param",
+        {
+          :is_default_param => true,
+          :lookup_method => lambda {
+            [ "wind", "sun", "boat" ]
+          }
+        }
+    )
+    @broker.register_command command
+
+    request = RHCP::Request.new(command, {  })
+    assert @test_broker.check_param_is_valid(request, "first_param", [ "wind" ])
+    assert_raise(RHCP::RhcpException) {
+      @test_broker.check_param_is_valid(request, "first_param", ["zaphod"])
+    }
+  end
+
+  def test_param_is_valid_without_lookup_values
+    command = RHCP::Command.new("test", "a test command with lookup values", lambda {})
+    command.add_param RHCP::CommandParam.new("first_param", "first param",
+        {
+          :is_default_param => true,
+        }
+    )
+    @broker.register_command command
+
+    request = RHCP::Request.new(command, {  })
+    assert @test_broker.check_param_is_valid(request, "first_param", [ "wind" ])
+    assert @test_broker.check_param_is_valid(request, "first_param", ["zaphod"])
+  end
+
+  def test_mandatory_prefilled_params
+    command = RHCP::Command.new("test_duplicate", "command for testing param duplicates", lambda {})
+    command.add_param(RHCP::CommandParam.new("first_param", "first param", {
+      :mandatory => false
+    }))
+    command.add_param(RHCP::CommandParam.new("second_param", "second param", {
+      :mandatory => true
+    }))
+    command.add_param(RHCP::CommandParam.new("third_param", "third param", {
+      :mandatory => true,
+      :autofill_context_key => 'dessert'
+    }))
+    @broker.register_command command
+
+    assert_equal ["second_param", "third_param"], @test_broker.get_mandatory_params("test_duplicate").map { |param| param.name }.sort()
+    context = RHCP::Context.new()
+    context.cookies['dessert'] = 'mascarpone'
+    context.cookies['host'] = 'deepthought'
+    assert_equal ["second_param"], @test_broker.get_mandatory_params("test_duplicate", context).map { |param| param.name }.sort()
+    context.cookies.delete('dessert') #sigh
+    #assert_equal ["second_param", "third_param"], command.get_mandatory_params(context).map { |param| param.name }.sort()
+    assert_equal ["second_param", "third_param"], @test_broker.get_mandatory_params("test_duplicate", context).map { |param| param.name }.sort()
+  end
+
+  def test_execute
+    command = RHCP::Command.new("test", "a command for testing", lambda { |request,response|
+      first_param = request.get_param_value("first_param")
+      puts "just testing : #{first_param}"
+      first_param.reverse
+    })
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param"))
+    @broker.register_command command
+
+    request = RHCP::Request.new(command, {"first_param" => "thing"})
+    response = @test_broker.execute(request)
+    assert_equal "thing".reverse, response.data
+  end
+
+  def test_execute_with_context
+    command = RHCP::Command.new("testcontext", "a command for context testing", lambda { |request,response|
+      first_param = request.get_param_value("first_param")
+      puts "just testing : #{first_param}"      
+      response.set_context({'end' => 'happy'})
+      first_param.reverse
+    })
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param", {
+      :mandatory => true,
+      :autofill_context_key => 'spooky'
+    }))
+    @broker.register_command command
+
+    context = RHCP::Context.new({'spooky' => 'coincidence'})
+    request = RHCP::Request.new(command, {}, context)
+    response = @test_broker.execute(request)
+    assert_equal "coincidence".reverse, response.data
+  end
+
+end

data/test/rhcp/tests_for_writable_brokers.rb

@@ -0,0 +1,22 @@
+module TestsForWritableBrokers
+
+def test_register_commands
+    assert_not_nil @broker
+    commands = @broker.get_command_list
+    assert_not_nil commands
+    assert_equal 0, commands.size
+
+    command = RHCP::Command.new("test", "a test command", lambda {})
+    @broker.register_command(command)
+
+    commands = @test_broker.get_command_list
+    assert_equal 1, commands.size
+    assert_equal command, commands["test"]
+  end
+
+  def test_register_duplicate
+    @broker.register_command RHCP::Command.new("test", "a test command", lambda {})
+    assert_raise(RHCP::RhcpException) { @broker.register_command RHCP::Command.new("test", "a command with the same name", lambda {}) }
+  end
+
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhcp
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 14
+  version: 0.2.14
 platform: ruby
 authors: 
 - Philipp Traeder
@@ -9,19 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-21 00:00:00 +01:00
+date: 2011-07-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 0
+        - 0
         version: 0.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: philipp at hitchhackers.net
 executables: 
@@ -32,58 +44,72 @@ extra_rdoc_files: []
 
 files: 
 - bin/rhcp_test_server
-- lib/rhcp
-- lib/rhcp/client
-- lib/rhcp/client/http_broker.rb
-- lib/rhcp/client/command_param_stub.rb
-- lib/rhcp/client/command_stub.rb
-- lib/rhcp/command.rb
-- lib/rhcp/command_param.rb
-- lib/rhcp/response.rb
 - lib/rhcp/dispatching_broker.rb
+- lib/rhcp/context.rb
+- lib/rhcp/memcached_broker.rb
+- lib/rhcp/logging_broker.rb
 - lib/rhcp/broker.rb
+- lib/rhcp/response.rb
+- lib/rhcp/client/command_stub.rb
+- lib/rhcp/client/command_param_stub.rb
+- lib/rhcp/client/http_broker.rb
+- lib/rhcp/client/context_aware_broker.rb
+- lib/rhcp/command.rb
 - lib/rhcp/http_exporter.rb
-- lib/rhcp/request.rb
 - lib/rhcp/rhcp_exception.rb
+- lib/rhcp/command_param.rb
+- lib/rhcp/request.rb
 - lib/rhcp.rb
-- test/rhcp
-- test/rhcp/client
+- test/rhcp/broker_test.rb
+- test/rhcp/test_base.rb
+- test/rhcp/http_exporter_test.rb
+- test/rhcp/http_test_server.rb
+- test/rhcp/response_test.rb
+- test/rhcp/command_test.rb
+- test/rhcp/tests_for_brokers.rb
+- test/rhcp/request_test.rb
 - test/rhcp/client/command_param_stub_test.rb
 - test/rhcp/client/command_stub_test.rb
+- test/rhcp/http_broker_test.rb
+- test/rhcp/logging_broker_test.rb
+- test/rhcp/context_test.rb
 - test/rhcp/command_param_test.rb
-- test/rhcp/command_test.rb
-- test/rhcp/response_test.rb
+- test/rhcp/tests_for_writable_brokers.rb
 - test/rhcp/dispatching_broker_test.rb
-- test/rhcp/broker_test.rb
-- test/rhcp/http_test_server.rb
-- test/rhcp/http_exporter_test.rb
-- test/rhcp/http_registry_test.rb
-- test/rhcp/request_test.rb
+- test/rhcp/context_aware_broker_test.rb
 has_rdoc: true
 homepage: http://rubyforge.org/projects/rhcp
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: rhcp
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: RHCP is a protocol designed for building up a command-metadata-based communication infrastructure making it easier for application developers to export commands in applications to generic clients.
 test_files: []
 

data/test/rhcp/http_registry_test.rb

@@ -1,73 +0,0 @@
-# 
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
- 
-
-$:.unshift File.join(File.dirname(__FILE__),'..','lib')
-
-require 'test/unit'
-require 'rhcp'
-
-class HttpBrokerTest < Test::Unit::TestCase
-  
-  def self.suite    
-    # setup an http exporter we can connect to
-    puts "gonna setup"
-    broker = RHCP::Broker.new()
-    @@command_test = RHCP::Command.new("test", "just a test command", lambda { |req,res| "testing" })
-    broker.register_command @@command_test
-
-    @@command_reverse = RHCP::Command.new("reverse", "reversing input strings", 
-        lambda { |req,res| 
-          req.get_param_value("input").reverse 
-        }
-        ).add_param(RHCP::CommandParam.new("input", "the string to reverse", 
-            { 
-              :lookup_method => lambda { [ "zaphod", "beeblebrox" ] } 
-            }
-        )
-    )
-    broker.register_command @@command_reverse
-
-    @@exporter = RHCP::HttpExporter.new(broker, :port => 42001)
-    @@exporter.start()
-    super
-  end    
-  
-  def setup
-    url = URI.parse("http://localhost:42001")
-    @http_broker = RHCP::Client::HttpBroker.new(url)
-    assert_not_nil @http_broker
-  end
-  
-  def test_get_commands
-    commands = @http_broker.get_command_list
-    assert_not_nil commands
-    assert 2, commands.size
-    assert @@command_test, commands["test"]
-    assert @@command_reverse, commands["reverse"]
-    puts "command reverse : >>#{commands["reverse"]}<<"
-  end
-  
-  # the CommandParam should be wrapped in a way that we can retrieve lookup values
-  def test_get_lookup_values
-    command = @http_broker.get_command_list["reverse"]
-    param = command.get_param("input")
-    assert_equal [ "zaphod", "beeblebrox" ], param.get_lookup_values()
-  end
-  
-  def test_execute
-    command = @http_broker.get_command_list["reverse"]
-    assert_instance_of RHCP::Client::CommandStub, command
-    collected_params = {
-      "input" => [ "zaphod" ]
-    }
-    request = RHCP::Request.new(command, collected_params)
-    response = command.execute_request(request)
-    assert_not_nil response
-    assert_equal RHCP::Response::Status::OK, response.status
-    assert_equal "dohpaz", response.data
-  end
-  
-  
-end