weblogic-jmx4r 0.1.9

data/lib/jmx4r/version.rb

@@ -0,0 +1,3 @@
+module JMX
+  VERSION = '0.1.9'
+end

data/lib/objectname_helper.rb

@@ -0,0 +1,21 @@
+# Copyright 2008 Jeff Mesnil (http://jmesnil.net)
+#
+# This file adds methods to ObjectName proxies
+require 'java'
+
+JavaUtilities.extend_proxy('javax.management.ObjectName') do
+  def key?(k)
+    self.contains_key k
+  end
+  alias has_key? key?
+  alias include? key?
+  alias member? key?
+
+  def keys
+    self.get_key_property_list.key_set
+  end
+
+  def [](key)
+    self.get_key_property key
+  end
+end

data/lib/open_data_helper.rb

@@ -0,0 +1,50 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+#
+# This file adds methods to CompositeData proxies so that they can behave like
+# regular (read-only) Ruby Hash
+require 'java'
+
+JavaUtilities.extend_proxy('javax.management.openmbean.CompositeData') do
+  include Enumerable
+  def each
+    self.get_composite_type.key_set.each do |k|
+      yield(k,self.get(k))
+    end
+    self
+  end
+
+  def key?(k)
+    self.contains_key k
+  end
+  alias has_key? key?
+  alias include? key?
+  alias member? key?
+
+  def keys
+    self.get_composite_type.key_set
+  end
+
+  def [](key)
+    self.get key
+  end
+
+  def method_missing(name, *args)
+    key = name.to_s.camel_case
+    super unless containsKey(key)
+    get(name.to_s.camel_case)
+  end
+
+  def respond_to?(symbol, include_private = false)
+    containsKey(symbol.to_s.camel_case) || super
+  end
+end
+
+JavaUtilities.extend_proxy('javax.management.openmbean.TabularData') do
+  include Enumerable
+  def each
+    self.values.each do |value|
+      yield value
+    end
+    self
+  end
+end

data/test/tc_attributes.rb

@@ -0,0 +1,44 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestAttribute < Test::Unit::TestCase
+  import java.lang.management.ManagementFactory
+
+  def setup
+    @memory = JMX::MBean.find_by_name "java.lang:type=Memory", :connection => ManagementFactory.platform_mbean_server
+  end
+
+  def teardown
+    JMX::MBean.remove_connection
+  end
+
+  def test_unknwown_attribute
+    assert_raise(NoMethodError) { @memory.unknown_attribute }
+  end
+
+  def test_readable_attribute
+    assert_equal false, @memory.verbose
+  end
+
+  def test_writable_attribute
+    assert_equal false, @memory.verbose
+    @memory.verbose = true
+    assert_equal true, @memory.verbose
+    @memory.verbose = false
+  end
+
+  def test_non_writable_attribute
+    assert_raise(NoMethodError) { @memory.object_pending_finalization_count = -1 }
+  end
+
+  def test_non_overlapping_attributes
+    assert_raise(NoMethodError) { @memory.logger_names }
+    logging = JMX::MBean.find_by_name "java.util.logging:type=Logging", :connection => ManagementFactory.platform_mbean_server
+    assert_raise(NoMethodError) { logging.verbose }
+    assert_raise(NoMethodError) { @memory.logger_names }
+  end
+end

data/test/tc_auth.rb

@@ -0,0 +1,70 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestAuthentication < Test::Unit::TestCase
+  import java.lang.SecurityException
+
+  def setup
+    @username = "jmx4r.user"
+    @password = "jmx4r.password"
+
+    pwd_path = "/tmp/jmx4r.password"
+    @pwd_file = File.new(pwd_path, "w")
+    @pwd_file.puts "#{@username} #{@password}"
+    @pwd_file.close
+
+    # pwd file must be readable only by user
+    # but somehow File.chmod is not working
+    # with JRuby
+    `chmod 0600 #{@pwd_file.path}`
+
+    access_path = "/tmp/jmx4r.access"
+    @access_file = File.new(access_path, "w")
+    @access_file.puts "#{@username} readwrite"
+    @access_file.close
+    # access file must be readable only by user
+    `chmod 0600 #{@access_file.path}`
+
+    JConsole::start :pwd_file => @pwd_file.path, :access_file => @access_file.path
+  end
+
+  def teardown
+    JMX::MBean.remove_connection
+    JConsole::stop
+    File.delete @pwd_file.path if File.file? @pwd_file.path
+    File.delete @access_file.path if File.file? @access_file.path
+  end
+  
+  def test_establish_auth_connection_with_correct_credentials
+    JMX::MBean.establish_connection :username => @username, :password => @password 
+  end
+  
+  # test that using the :credentials key to pass the username/password
+  # credentials is working the same way than passing :username/:password
+  def test_establish_auth_connection_with_custom_credentials
+    credentials = [@username, @password].to_java(:String)
+    JMX::MBean.establish_connection :credentials => credentials
+  end
+
+  def test_establish_auth_connection_with_invalid_username
+    assert_raise(SecurityException) {
+      JMX::MBean.establish_connection :username => "invalid user name", :password => @password
+    }
+  end
+
+  def test_establish_auth_connection_with_invalid_password
+    assert_raise(SecurityException) {
+      JMX::MBean.establish_connection :username => @username, :password => "invalid password" 
+    }
+  end
+
+  def test_establish_auth_connection_with_no_credentials
+    assert_raise(SecurityException) {
+      JMX::MBean.establish_connection
+    }
+  end
+end

data/test/tc_composite_data.rb

@@ -0,0 +1,77 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestCompositeData < Test::Unit::TestCase
+  import java.lang.management.ManagementFactory
+  import javax.management.openmbean.InvalidKeyException
+  
+  def setup
+    memory = JMX::MBean.find_by_name "java.lang:type=Memory", :connection => ManagementFactory.platform_mbean_server
+    # heap_memory_usage is a CompositeData
+    @heap = memory.heap_memory_usage
+  end
+
+  def teardown
+    @heap = nil
+    JMX::MBean.remove_connection
+  end
+  
+  # use #map to check that CompositeData includes Enumerable
+  def test_enumerable_composite_data
+    expected_headers = ["init", "committed", "used", "max"].sort
+    headers = @heap.map { |k, v| k }.sort
+    assert_equal expected_headers, headers
+  end
+
+  def test_composite_data_keys
+    expected_headers = ["init", "committed", "used", "max"].sort
+    headers = @heap.keys.sort
+    assert_equal expected_headers, headers
+  end
+
+  def test_composite_data_key_aliases
+    assert @heap.key?("used")
+    assert @heap.has_key?("used")
+    assert @heap.include?("used")
+    assert @heap.member?("used")
+  end
+  
+  def test_composite_data_method_missing
+    assert @heap.used
+    
+    def @heap.containsKey(key)
+      "camelCaseAttributeName" == key
+    end
+
+    def @heap.get(key)
+      return "value" if "camelCaseAttributeName" == key
+      raise("should not happen")
+    end
+    
+    assert_equal "value", @heap.camel_case_attribute_name
+    
+    assert_raises NoMethodError do
+      @heap.unknown_attribute
+    end
+  end
+  
+  def test_composite_data_as_hash
+    used = @heap.get "used"
+    used_from_hash = @heap["used"]
+    assert_equal used, used_from_hash
+  end  
+
+  def test_composite_data_as_hash_with_known_key
+    assert_equal true, @heap.key?("used")
+    used = @heap["used"]
+  end
+  
+  def test_composite_data_as_hash_with_unknown_key
+    assert_equal false, @heap.key?("unknown")
+    assert_raise(InvalidKeyException) { @heap["unknown"] }
+  end
+end

data/test/tc_connection.rb

@@ -0,0 +1,92 @@
+# Copyright 2007 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+
+require "jmx4r"
+require "jconsole"
+
+class TestConnection < Test::Unit::TestCase
+  import java.io.IOException
+
+  def teardown
+    JMX::MBean.remove_connection
+  end
+
+  def test_establish_connection_with_bad_port
+    assert_raise(IOException) { 
+      JMX::MBean.establish_connection :port => 9999
+    }
+  end
+
+  def test_establish_connection_with_bad_host
+    assert_raise(IOException) { 
+      JMX::MBean.establish_connection :host => "not a valid host"
+    }
+  end
+
+  def test_establish_connection
+    begin
+      JConsole::start
+      connection = JMX::MBean.establish_connection
+      assert(connection.getMBeanCount > 0)
+    ensure
+      JConsole::stop
+    end
+  end
+
+  def test_remove_connection
+    begin
+      JConsole::start
+      connection = JMX::MBean.establish_connection
+      JMX::MBean.remove_connection
+      assert_raise(IOException) {
+        connection.getMBeanCount
+      }
+    ensure
+      JConsole::stop
+    end
+  end
+
+  def test_establish_connection_with_custom_port
+    begin
+      JConsole::start :port => 3001
+      JMX::MBean.establish_connection :port => 3001
+    ensure
+      JConsole::stop 3001
+    end
+  end
+
+  def test_establish_connection_with_custom_url
+    begin
+      JConsole::start :port => 3001
+      url = "service:jmx:rmi:///jndi/rmi://localhost:3001/jmxrmi"
+      JMX::MBean.establish_connection :url => url
+    ensure
+      JConsole::stop 3001
+    end
+  end
+
+  def test_establish_connection_with_custom_url_overrides_host_and_port
+    begin
+      JConsole::start :port => 3001
+      good_url = "service:jmx:rmi:///jndi/rmi://localhost:3001/jmxrmi"
+      bad_port = 3000
+      # specifying a :url discards the :port & :host parameters
+      JMX::MBean.establish_connection :port => bad_port, :url => good_url
+    ensure
+      JConsole::stop 3001
+    end
+  end
+
+  def test_establish_connection_local
+    begin
+      JConsole::start :port => 0
+      connection = JMX::MBean.establish_connection \
+        :command => /jconsole/i
+      assert(connection.getMBeanCount > 0)
+    ensure
+      JConsole::stop 0
+    end
+  end
+
+end

data/test/tc_dynamic_mbean.rb

@@ -0,0 +1,157 @@
+# Copyright 2008 Jeff Mesnil (http://jmesnil.net)
+
+require "test/unit"
+require "jmx4r"
+
+
+class TestDynamicMBean < Test::Unit::TestCase
+
+  import java.lang.management.ManagementFactory
+  import javax.management.ObjectName
+  import javax.management.Attribute
+
+  class AttributeTypesMBean < JMX::DynamicMBean
+    rw_attribute :string_attr, :string, "a String attribute"
+    rw_attribute :byte_attr, :byte, "a Byte attribute"
+    rw_attribute :int_attr, :int, "a Integer attribute"
+    rw_attribute :long_attr, :long, "a Long attribute"
+    rw_attribute :float_attr, :float, "a Float attribute"
+    rw_attribute :double_attr, :double, "a Double attribute"
+    rw_attribute :list_attr, :list, "a List attribute"
+    rw_attribute :map_attr, :map, "a Map attribute"
+    rw_attribute :set_attr, :set, "a Set attribute"
+    rw_attribute :boolean_attr, :boolean, "a Boolean attribute"
+  end
+
+  def test_attribute_types
+    mbean = AttributeTypesMBean.new
+    object_name = ObjectName.new "jmx4r:name=AttributeTypesMBean"
+    mbean_server = ManagementFactory.platform_mbean_server
+    mbean_server.register_mbean mbean, object_name
+
+    mbean = JMX::MBean.find_by_name object_name.to_s, :connection => mbean_server
+    mbean.string_attr = "test"
+    assert_equal("test", mbean.string_attr)
+
+    mbean.byte_attr = 9
+    assert_equal(9, mbean.byte_attr)
+
+    mbean.int_attr = 23
+    assert_equal(23, mbean.int_attr)
+
+    mbean.long_attr = 33
+    assert_equal(33, mbean.long_attr)
+
+    mbean.float_attr = 91.0
+    assert_equal(91.0, mbean.float_attr)
+
+    mbean.float_attr = 7.0
+    assert_equal(7.0, mbean.float_attr)
+
+    mbean.list_attr = [1, 2, 3]
+    assert_equal([1, 2, 3], mbean.list_attr.to_a)
+
+    mbean.set_attr = [1, 2, 3]
+    assert_equal([1, 2, 3].sort, mbean.list_attr.to_a.sort)
+
+    mbean.map_attr = { "a" => 1, "b" => 2}
+    assert_equal({ "a" => 1, "b" => 2}.to_a.sort, mbean.map_attr.to_a.sort)
+
+    mbean.boolean_attr = true
+    assert_equal(true, mbean.boolean_attr)
+
+    mbean_server.unregister_mbean object_name
+  end
+
+  class OperationInvocationMBean < JMX::DynamicMBean
+    operation "reverse the string passed in parameter"
+    parameter :string, "arg", "a String to reverse"
+    returns :string
+    def reverse(arg)
+      arg.reverse
+    end
+  end
+
+  def test_operation_invocation
+    mbean = OperationInvocationMBean.new
+    object_name = ObjectName.new "jmx4r:name=OperationInvocationMBean"
+    mbean_server = ManagementFactory.platform_mbean_server
+    mbean_server.register_mbean mbean, object_name
+
+    mbean = JMX::MBean.find_by_name object_name.to_s, :connection => mbean_server
+    assert_equal("oof", mbean.reverse("foo"))
+
+    mbean_server.unregister_mbean object_name
+  end
+
+  class Foo < JMX::DynamicMBean
+    rw_attribute :foo_attr, :string
+
+    operation
+    parameter :string
+    returns :string
+    def foo(arg)
+       "foo #{arg}"
+    end
+  end
+
+  class Bar < JMX::DynamicMBean
+    rw_attribute :bar_attr, :string
+
+    operation
+    parameter :string
+    returns :string
+    def bar(arg)
+       "bar #{arg}"
+    end
+  end
+
+  def test_separate_dynamic_beans_have_separate_operations_and_attributes
+     mbean_server = ManagementFactory.platform_mbean_server
+     foo_object_name = ObjectName.new "jmx4r:name=foo"
+     bar_object_name = ObjectName.new "jmx4r:name=bar"
+     mbean_server.register_mbean Foo.new, foo_object_name
+     mbean_server.register_mbean Bar.new, bar_object_name
+
+     foo_mbean = JMX::MBean.find_by_name foo_object_name.to_s, :connection => mbean_server
+     assert_equal "foo test", foo_mbean.foo("test")
+     assert_raise(NoMethodError){
+        foo_mbean.bar("test")
+     }
+     foo_mbean.foo_attr = "test"
+     assert_equal "test", foo_mbean.foo_attr
+     assert_raise(NoMethodError){
+        foo_mbean.bar_attr = "test"
+     }
+     bar_mbean = JMX::MBean.find_by_name bar_object_name.to_s, :connection => mbean_server
+     assert_equal "bar test", bar_mbean.bar("test")
+     assert_raise(NoMethodError) {
+        bar_mbean.foo("test")
+     }
+     bar_mbean.bar_attr = "test"
+     assert_equal "test", bar_mbean.bar_attr
+     assert_raise(NoMethodError){
+        bar_mbean.foo_attr = "test"
+     }
+
+     mbean_server.unregister_mbean foo_object_name
+     mbean_server.unregister_mbean bar_object_name
+  end
+
+  def test_get_attributes
+    foo = Foo.new
+    foo.foo_attr = "value"
+
+    object_name = ObjectName.new "jmx4r:name=baz"
+    mbean_server = ManagementFactory.platform_mbean_server
+    mbean_server.register_mbean foo, object_name
+
+    foo_mbean = JMX::MBean.find_by_name object_name.to_s, :connection => mbean_server
+    attrs = mbean_server.get_attributes object_name, ["foo_attr"].to_java(:string)
+    assert attrs[0].kind_of? Attribute
+    assert_equal foo.foo_attr, attrs[0].value
+
+    mbean_server.unregister_mbean object_name
+
+  end
+end