wbem 0.2.6 → 0.2.8

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 0.2.8
+
+* Client#class_names accepts an ObjectPath now
+
+== 0.2.7
+
+* Adapt to sfcb 1.3.15 root/interop:CIM_Namespace
+* Assume cimxml is via https and wsman requires basic auth
+
 == 0.2.6
 
 * Honor iAMT when choosing classnames

data/lib/wbem.rb

@@ -41,13 +41,13 @@ module Wbem
         u = uri
         protocol_given = uri.port
       end
-      case protocol.to_sym
-      when :wsman
+      case protocol.to_s
+      when "wsman"
         unless protocol_given
           u.port = (u.scheme == "http") ? 5985 : 5986
         end
         return WsmanClient.new u, auth_scheme
-      when :cimxml
+      when "cimxml"
         unless protocol_given
           u.port = (u.scheme == "http") ? 5988 : 5989
         end

data/lib/wbem/cimxml.rb

@@ -14,7 +14,7 @@ module Sfcc
     class ObjectPath
       def keys
         res = []
-        each_key { |key| res << key }
+        each_key { |key,value| res << key }
         res
       end
     end
@@ -33,7 +33,6 @@ private
   def _identify
     # sfcb has /root/interop:CIM_ObjectManager
     sfcb_op = objectpath "root/interop", "CIM_ObjectManager"
-    STDERR.puts "Looking for #{sfcb_op}"
     begin
       @client.instances(sfcb_op).each do |inst|
         @product = inst.Description
@@ -44,6 +43,7 @@ private
       raise "Unknown CIMOM"
     end
   end
+
 public
 
   #
@@ -54,19 +54,38 @@ public
     @client = Sfcc::Cim::Client.connect( { :uri => url, :verify => false } )
     _identify
   end
-  
+
   #
-  # Create ObjectPath from namespace and classname
+  # return list of namespaces
   #
-  def objectpath namespace, classname = nil
-    Sfcc::Cim::ObjectPath.new(namespace, classname)
+  def namespaces
+    result = []
+    each_instance( "root/interop", "CIM_Namespace" ) do |inst|
+      result << inst.Name
+    end
+    result.uniq
+  end
+
+  #
+  # Create ObjectPath from namespace, classname, and properties
+  #
+  def objectpath namespace, classname = nil, properties = {}
+    op = Sfcc::Cim::ObjectPath.new(namespace, classname, @client)
+    properties.each do |k,v|
+      op.add_key k,v
+    end
+    op
   end
 
   #
   # Return instances for namespace and classname
   #
-  def each_instance( ns, cn )
-    op = objectpath ns, cn
+  def each_instance( namespace_or_objectpath, classname = nil )
+    op = if namespace_or_objectpath.is_a? Sfcc::Cim::ObjectPath
+      namespace_or_objectpath
+    else
+      objectpath namespace_or_objectpath, classname
+    end
     begin
       @client.instances(op).each do |inst|
         yield inst
@@ -76,15 +95,16 @@ public
   end
   
   #
-  # Return list of classnames for given namespace
+  # Return list of classnames for given object_path
   #
-  def class_names namespace, deep_inheritance = false
-    STDERR.puts "#{@client}.class_names(#{namespace})"
+  def class_names op, deep_inheritance = false
     ret = []
-    op = Sfcc::Cim::ObjectPath.new(namespace)
+    unless op.is_a? Sfcc::Cim::ObjectPath
+      op = Sfcc::Cim::ObjectPath.new(op.to_s, nil) # assume namespace
+    end
     flags = deep_inheritance ? Sfcc::Flags::DeepInheritance : 0
     begin
-      @client.class_names(op,flags).each do |name|
+      @client.class_names(op, flags).each do |name|
 	ret << name.to_s
       end
     rescue Sfcc::Cim::ErrorInvalidNamespace
@@ -95,10 +115,18 @@ public
   #
   # Return list of Wbem::EndpointReference (object pathes) for instances
   #  of namespace, classname
+  # @param namespace : String or Sfcc::Cim::ObjectPath
+  # @param classname : String (optional)
+  # @param properties : Hash (optional)
   #
-  def instance_names namespace, classname
-    objectpath = Sfcc::Cim::ObjectPath.new(namespace,classname)
-    STDERR.puts "#{@client}.instance_names(#{objectpath})"
+  def instance_names namespace, classname=nil, properties={}
+    case namespace
+    when Sfcc::Cim::ObjectPath
+      objectpath = namespace
+      namespace = objectpath.namespace
+    else
+      objectpath = objectpath namespace.to_s, classname, properties
+    end
     ret = []
     begin
       @client.instance_names(objectpath).each do |path|
@@ -109,5 +137,24 @@ public
     end
     ret
   end
+
+  #
+  # Return matching Wbem::Instance for first instance
+  #  matching namespace, classname, properties
+  # @param namespace : String or Sfcc::Cim::ObjectPath
+  # @param classname : String (optional)
+  # @param properties : Hash (optional)
+  #
+  def get_instance namespace, classname=nil, properties={}
+    case namespace
+    when Sfcc::Cim::ObjectPath
+      objectpath = namespace
+      namespace = objectpath.namespace
+    else
+      objectpath = objectpath namespace.to_s, classname, properties
+    end
+    ret = []
+    @client.get_instance(objectpath)
+  end
 end # class
 end # module

data/lib/wbem/version.rb

@@ -1,3 +1,3 @@
 module Wbem
-  VERSION = "0.2.6"
+  VERSION = "0.2.8"
 end

data/lib/wbem/wbem.rb

@@ -20,7 +20,7 @@ module Wbem
 
     def initialize url, auth_scheme = :basic
       @url = (url.is_a? URI) ? url : URI.parse(url)
-      @auth_scheme = auth_scheme.to_s.to_sym
+      @auth_scheme = auth_scheme.to_s.to_sym rescue nil
     end
 
     def response_code
@@ -35,36 +35,13 @@ module Wbem
       raise "#{self.class}.objectpath not implemented"
     end
 
-private
-    # assemble all namespaces
-    def _namespaces ns, cn
-      result = nil
-      # each_instance is the downcall to cimxml or wsman
-      each_instance( ns, cn ) do |inst|
-        result ||= [ns]
-        name = "#{ns}/#{inst.Name}"
-        unless result.include? name
-          result << name
-          result.concat(_namespaces name, cn)
-        end
-      end
-      result || []
-    end
-public
-    # return list of namespaces
-    def namespaces
-      STDERR.puts "Namespaces for #{@url}"
-      result = []
-      ['root', 'Interop', 'interop'].each do |ns|
-        ["CIM_Namespace", "__Namespace", "__NAMESPACE"].each do |cn|
-          result.concat(_namespaces ns, cn)
-        end
-      end
-      result.uniq
+    def to_s
+      "#{@product}(#{@url})"
     end
 
-    # return list of classnames for namespace ns
-    def class_names ns, deep_inheritance=false
+public
+    # return list of classnames for ObjectPath op
+    def class_names op, deep_inheritance=false
       raise "#{self.class}.class_names not implemented"
     end
   

data/lib/wbem/wsman.rb

@@ -20,27 +20,167 @@ module Openwsman
       return nil
     end
   end
+  #
+  # Capture Fault as Exception
+  #
+  class Exception < ::RuntimeError
+    def initialize fault
+      unless fault.is_a? Openwsman::Fault
+        raise "#{fault} is not a fault" unless fault.fault?
+        fault = Openwsman::Fault.new fault
+      end
+      @fault = fault
+    end
+    def to_s
+      "Fault code #{@fault.code}, subcode #{@fault.subcode}" +
+      "\n\treason #{@fault.reason}" +
+      "\n\tdetail #{@fault.detail}"
+    end
+  end
+  #
+  # Capture namespace, classname, and properties as ObjectPath
+  #
   class ObjectPath
-    attr_reader :namespace, :classname
-    def initialize namespace, classname = nil
+    attr_reader :namespace, :classname, :properties
+    def initialize namespace, classname = nil, properties = {}
       @namespace = namespace
       @classname = classname
+      @properties = properties
     end
   end
-  # Provide Cim::ObjectPath like accessors
+  #
+  # Provide Cim::ObjectPath like accessors for EndPointReference
+  #
   class EndPointReference
-    alias keys selector_names
-    alias key_count selector_count
-    alias add_key add_selector
+    alias :keys :selector_names
+    alias :key_count :selector_count
+    alias :add_key :add_selector
     def each_key
       keys.each { |key| yield key }
     end
   end
+  #
+  # Capture XmlDoc + WsmanClient as Instance
+  #
+  class Instance
+    def initialize node, client, epr_or_uri
+      @node = (node.is_a? Openwsman::XmlDoc) ? node.body : node
+      @epr = (epr_or_uri.is_a? Openwsman::EndPointReference) ? epr_or_uri : Openwsman::EndPointReference.new(epr_or_uri)
+      @client = client
+    end
+    #
+    #
+    #    
+    def to_s
+      "Instance #{@client}\n\t#{@epr}\n\t#{@node.to_xml}"
+    end
+    #
+    # Instance#<property>
+    # Instance#<method>(<args>)
+    #
+    def method_missing name, *args
+      if args.empty?
+        # try property first
+        res = @node.send name
+        return res.text if res
+      end
+      # try as method invocation
+      options = Openwsman::ClientOptions.new
+      options.set_dump_request
+      selectors = {}
+      @epr.each do |k,v|
+        selectors[k] = v
+      end
+      options.selectors = selectors # instance key properties
+      uri = @epr.resource_uri
+	
+      #
+      # get method input parameter information
+      #
+      classname = @epr.classname
+      s = "mof/#{classname}"
+      begin
+        require s
+      rescue LoadError
+        raise RuntimeError.new "Cannot load #{s} for type information"
+      end
+      methods = MOF.class_eval "#{classname}::METHODS"
+      method = methods[name.to_s]
+      raise RuntimeError.new("Unknown method #{name} for #{classname}") unless method
+      result_type = method[:type]
+      parameters = method[:parameters] || {}
+      input = parameters[:in]
+      output = parameters[:out]
+      argsin = {}
+      i = 0
+      if input
+        while i < input.size
+          value = args.shift
+          raise "Argument for #{input[i]} is nil, not allowed !" unless value
+          argsin[input[i]] = value
+          # FIXME more typecheck of args ?
+          i += 2
+        end
+      end
+      STDERR.puts "\n\tproperties #{argsin.inspect}\n"
+      options.properties = argsin
+      #
+      # output parameters ?
+      #
+      argsout = nil
+      if output
+        if args.empty?
+          raise "Function #{name} has output arguments, please add an empty hash to the call"
+        end
+        argsout = args.shift
+        unless argsout.kind_of? Hash
+          raise "Function #{name} has output arguments, last argument must be a Hash"
+        end
+        unless args.empty?
+          raise "Function call to #{name} has excess arguments"
+        end
+      end
+      STDERR.puts "\n\targsout #{argsout.inspect}\n"
+Openwsman.debug = -1
+      STDERR.puts "\n\tinvoke #{uri}.#{name}\n"
+      res = @client.client.invoke(options, uri, name.to_s)
+      raise Openwsman::Exception.new(res) if res.fault?
+      STDERR.puts "\n\tresult #{res.to_xml}\n"
+      result = res.find(uri, "#{name}_OUTPUT").find(uri, "ReturnValue").text
+      case result_type
+      when :boolean
+        result == "true" ? true : false
+      when :uint8, :uint16, :uint32, :uint64
+        result.to_i
+      when :string
+        result
+      when :float
+        result.to_f
+      when :datetime
+      else
+        raise "Unsupported result_type #{result_type.inspect}"
+      end
+    end
+  end
 end
 
+
 module Wbem
 class WsmanClient < WbemClient
 private
+  #
+  # create end point reference URI
+  #
+  def epr_uri_for(namespace,classname)
+    case @product
+    when :winrm
+      # winrm embeds namespace in resource URI
+      Openwsman::epr_uri_for(namespace,classname) rescue "http://schema.suse.com/wbem/wscim/1/cim-schema/2/#{namespace}/#{classname}"
+    else
+      (Openwsman::epr_prefix_for(classname)+"/#{classname}") rescue "http://schema.suse.com/wbem/wscim/1/cim-schema/2/#{classname}"
+    end
+  end
+
   #
   # Handle client connection or protocol fault
   #
@@ -48,15 +188,17 @@ private
   #
   def _handle_fault client, result
     if result.nil?
-      STDERR.puts "Client connection failed:\n\tResult code #{@client.response_code}, Fault: #{@client.fault_string}"
+      STDERR.puts "Client connection failed:\n\tResult code #{client.response_code}, Fault: #{client.fault_string}" if Wbem.debug
       return true
     end
     if result.fault?
       fault = Openwsman::Fault.new result
-      STDERR.puts "Client protocol failed for (#{uri})"
-      STDERR.puts "\tFault code #{fault.code}, subcode #{fault.subcode}"
-      STDERR.puts "\t\treason #{fault.reason}"
-      STDERR.puts "\t\tdetail #{fault.detail}"
+      if Wbem.debug
+        STDERR.puts "Client protocol failed for (#{client})"
+        STDERR.puts "\tFault code #{fault.code}, subcode #{fault.subcode}"
+        STDERR.puts "\t\treason #{fault.reason}"
+        STDERR.puts "\t\tdetail #{fault.detail}"
+      end
       return true
     end
     false
@@ -73,13 +215,14 @@ private
     end
     if doc.fault?
       fault = doc.fault
-      STDERR.puts "Fault: #{fault.to_xml}"
-      raise fault.to_s
+      STDERR.puts "Fault: #{fault.to_xml}" if Wbem.debug
+      raise Openwsman::Exception.new fault
     end
 #    STDERR.puts "Return #{doc.to_xml}"
     doc
   end
 public
+  attr_reader :client
 
   def initialize uri, auth_scheme = nil
     super uri, auth_scheme
@@ -92,7 +235,7 @@ public
     @client.transport.timeout = 5
     @client.transport.verify_peer = 0
     @client.transport.verify_host = 0
-    case @auth_scheme
+    case @auth_scheme.to_s
     when nil, ""
       @client.transport.auth_method = nil # negotiate
     when /none/i
@@ -172,15 +315,40 @@ public
 
   end
 
-  def objectpath classname, namespace
-    Openwsman::ObjectPath.new classname, namespace
+public
+  #
+  # return list of namespaces
+  #
+  def namespaces ns = "root", cn = "__Namespace"
+    result = []
+    each_instance( ns, cn ) do |inst|
+      name = "#{ns}/#{inst.Name}"
+      result << name
+      result.concat namespaces name, cn
+    end
+    result.uniq
+  end
+
+  #
+  # Create ObjectPath from namespace, classname, and properties
+  #
+  def objectpath namespace, classname = nil, properties = {}
+    Openwsman::ObjectPath.new namespace, classname, properties
   end
 
-  def each_instance( ns, cn )
+  #
+  # Enumerate instances
+  #
+  def each_instance( namespace_or_objectpath, classname = nil )
+    op = if namespace_or_objectpath.is_a? Openwsman::ObjectPath
+      namespace_or_objectpath
+    else
+      objectpath namespace_or_objectpath, classname
+    end
     @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
     @options.max_elements = 999
-    resource = "#{@prefix}#{ns}/#{cn}"
-    result = @client.enumerate( @options, nil, resource )
+    uri = epr_uri_for op.namespace, op.classname
+    result = @client.enumerate( @options, nil, uri )
     loop do
       if _handle_fault @client, result
         break
@@ -188,34 +356,39 @@ public
       items = result.Items rescue nil
       if items
         items.each do |inst|
-          yield inst
+          yield Openwsman::Instance.new(inst, self, uri)
         end
       end
       context = result.context
       break unless context
-      result = @client.pull( @options, nil, resource, context )
+      result = @client.pull( @options, nil, uri, context )
     end
   end
 
-  def class_names namespace, deep_inheritance = false
+  #
+  # Enumerate class names
+  #
+  def class_names op, deep_inheritance = false
     @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
     @options.max_elements = 999
-    @options.cim_namespace = namespace if @product == :openwsman
+    namespace = (op.is_a? Sfcc::ObjectPath) ? op.namespace : op
+    classname = (op.is_a? Sfcc::ObjectPath) ? op.classname : nil
     case @product
     when :openwsman
-      unless @product_version >= "2.2"
+      if @product_version < "2.2"
         STDERR.puts "ENUMERATE_CLASS_NAMES unsupported for #{@product_vendor} #{@product_version}, please upgrade"
         return []
       end
       method = Openwsman::CIM_ACTION_ENUMERATE_CLASS_NAMES
       uri = Openwsman::XML_NS_CIM_INTRINSIC
+      @options.cim_namespace = namespace
       @options.add_selector("DeepInheritance", "True") if deep_inheritance
       result = @client.invoke( @options, uri, method )
     when :winrm
       # see https://github.com/kkaempf/openwsman/blob/master/bindings/ruby/tests/winenum.rb
       filter = Openwsman::Filter.new
       query = "select * from meta_class"
-      query << " where __SuperClass is null" unless deep_inheritance
+      query << " where __SuperClass is #{classname?classname:'null'}" unless deep_inheritance
       filter.wql query
       uri = "#{@prefix}#{namespace}/*"
       result = @client.enumerate( @options, filter, uri )
@@ -247,19 +420,43 @@ public
         break unless context
         # get the next chunk
         result = @client.pull( @options, nil, uri, context)
-        break if _handle_fault
+        break if _handle_fault @client, result
       end
     end
     return classes
   end
 
-  def instance_names namespace, classname
+  #
+  # Return list of Wbem::EndpointReference (object pathes) for instances
+  #  of namespace, classname
+  # @param namespace : String or Sfcc::Cim::ObjectPath
+  # @param classname : String (optional)
+  # @param properties : Hash (optional)
+  #
+  def instance_names namespace, classname=nil, properties = {}
+    case namespace
+    when Openwsman::ObjectPath
+      classname = namespace.classname
+      properties = namespace.properties
+      namespace = namespace.namespace
+      uri = epr_uri_for(namespace,classname)
+    when Openwsman::EndPointReference
+      namespace.each do |k,v|
+        properties[k] = v
+      end
+      classname = namespace.classname
+      uri = namespace.resource_uri
+      namespace = namespace.namespace
+    else
+      uri = epr_uri_for(namespace, classname)
+    end
     @options.flags = Openwsman::FLAG_ENUMERATION_ENUM_EPR # get EPRs
     @options.flags = Openwsman::FLAG_ENUMERATION_OPTIMIZATION
     @options.max_elements = 999
     @options.cim_namespace = namespace if @product == :openwsman
     @options.set_dump_request
-    uri = Openwsman::epr_prefix_for(classname, namespace) + "/#{classname}"
+    @options.selectors = properties unless properties.empty?
+    start = Time.now
     STDERR.puts "instance_names enumerate (#{uri})"
     result = @client.enumerate( @options, nil, uri )
     names = []
@@ -278,8 +475,42 @@ public
       break unless context
       result = @client.pull( @options, nil, uri, context )
     end
+    STDERR.puts "Enumerated #{names.size} items in #{Time.now-start} seconds"
     return names
   end
-  
+
+  #
+  # Return matching Wbem::Instance for first instance
+  #  matching namespace, classname, properties
+  # @param namespace : String or Sfcc::Cim::ObjectPath
+  # @param classname : String (optional)
+  # @param properties : Hash (optional)
+  #
+  def get_instance namespace, classname=nil, properties={}
+    case namespace
+    when Openwsman::ObjectPath
+      classname = namespace.classname
+      properties = namespace.properties
+      namespace = namespace.namespace
+      uri = epr_uri_for(namespace, classname)
+    when Openwsman::EndPointReference
+      namespace.each do |k,v|
+        properties[k] = v
+      end
+      classname = namespace.classname
+      uri = namespace.resource_uri
+      namespace = namespace.namespace
+    else
+      uri = epr_uri_for(namespace, classname)
+    end
+    @options.set_dump_request
+    @options.cim_namespace = namespace if @product == :openwsman
+    @options.selectors = properties unless properties.empty?
+    STDERR.puts "@client.get(namepace '#{@options.cim_namespace}', props #{properties.inspect}, uri #{uri}"
+    res = @client.get(@options, uri)
+    raise Openwsman::Exception.new res if res.fault?
+    Openwsman::Instance.new res, self, Openwsman::EndPointReference.new(uri, "", properties)
+  end
+
 end
-end # module
+end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wbem
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &5664140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *5664140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: sfcc
-  requirement: &5663580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *5663580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: openwsman
-  requirement: &5662940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: 2.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *5662940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
 description: ruby-wbem allows to access a CIMOM transparently through CIM/XML or WS-Management
 email:
 - kkaempf@suse.de
@@ -51,11 +66,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/wbem.rb
-- lib/wbem/wbem.rb
-- lib/wbem/cimxml.rb
 - lib/wbem/version.rb
+- lib/wbem/cimxml.rb
+- lib/wbem/wbem.rb
 - lib/wbem/wsman.rb
+- lib/wbem.rb
 - CHANGELOG.rdoc
 - README.rdoc
 homepage: http://www.github.com/kkaempf/ruby-wbem
@@ -79,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: WBEM client for Ruby based on ruby-sfcc and openwsman