genprovider 0.2.0

data/CHANGELOG

@@ -0,0 +1,8 @@
+=== 0.2.0 2013-04-11
+
+* Bugfix release
+
+=== 0.0.1 2010-10-05
+
+* Initial release of genprovider gem
+  License now 'Ruby'

data/CHANGELOG~

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-10-05
+
+* Initial release of genprovider gem
+  License now 'Ruby'

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in genprovider.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,58 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README.rdoc

@@ -0,0 +1,50 @@
+= genprovider
+
+* http://github.com/kkaemof/genprovider
+
+== DESCRIPTION:
+
+* A generator for Ruby based CIM providers
+  Generates Ruby provider templates for use with cmpi-bindings
+
+== FEATURES/PROBLEMS:
+
+* Generates CIM class and provider templates from MOF files
+
+== SYNOPSIS:
+
+  genprovider.rb [-d] [-h] [-q] [-I <includedir>] [-o <output>] [-n <namespace>] <moffile> [<moffile> ...]
+
+== EXAMPLE:
+
+  # generate .registration and .rb file
+  bin/genprovider -n root/cimv2 sample.mof
+  # convert .registration to sfcb .reg file
+  # copy .reg to /var/lib/sfcb/stage/regs
+  # copy .mof to /var/lib/sfcb/mofs/<namespace>/
+  # run sfcbrepos -f
+  sudo provider-register.sh -t sfcb -n root/cimv2 -r generated/sample.registration -m sample.mof
+  # copy provider template
+  cp generated/sample.rb /usr/share/cmpi
+  # reload sfcb to pick up provider information
+  sudo rcsfcb restart
+
+== REQUIREMENTS:
+
+* gems:
+  * cim
+  * mof
+
+* 'cmpi-bindings' (for provider execution)
+
+== INSTALL:
+
+* gem install gemprovider
+
+== LICENSE:
+
+(The Ruby License)
+
+Copyright (c) 2010 Klaus Kämpf <kkaempf@suse.de>
+
+See http://www.ruby-lang.org/en/LICENSE.txt for the full text

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:test]

data/bin/genprovider

@@ -0,0 +1,256 @@
+#!/usr/bin/env ruby
+#
+# genprovider
+#
+#  Generate Ruby provider templates for use with cmpi-bindings
+#
+# Copyright (c) 2010, 2011 Klaus Kämpf <kkaempf@suse.de>
+#
+# Licensed under the Ruby license
+#
+# == Usage
+#
+# genprovider [-c] [-d] [-h] [-q] [-t] [-n <namespace>] [-I <includedir>] [-o <output>] <moffile> [<moffile> ...]
+#
+# -c:
+#   generate classinfo instead
+# -d:
+#   turn on debugging
+# -h:
+#   show (this) help
+# -q:
+#   be quiet
+# -I <includedir>
+#   additional include directories to search
+# -o <outputdir>
+#   directory to write generated files, defaults to 'generated'
+# -t:
+#   generate testcase only
+# <moffile>
+#   .mof files to read
+#
+
+require 'rubygems'
+
+require 'mof'
+require 'pathname'
+require 'fileutils'
+
+$:.push(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'genprovider'
+
+#--------------------------------------------------------------------
+
+#
+# Extend CIM::Class with parent attribute, point to CIM::Class of parent
+#
+
+module CIM
+  class Class
+    attr_accessor :parent
+  end
+end
+
+#
+# Convert CamelCase to underline_case
+#
+
+class String
+  def decamelize
+    # CamelCase -> under_score
+    self.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+	 gsub(/([a-z\d])([A-Z])/,'\1_\2').
+	 tr("-", "_").
+	 downcase
+  end
+end
+
+#
+# find_and_parse_superclass_of
+#
+# Find the superclass name of a class, parse its mof file
+# returns Hash of { classname -> CIM::Class }
+#
+
+def find_and_parse_superclass_of c, options
+  superclasses = {}
+  # parent unknown
+  #  try parent.mof
+  begin
+    parser = MOF::Parser.new options
+    result = parser.parse ["qualifiers.mof", "#{c.superclass}.mof"]
+    if result
+      result.each_value do |r|
+	r.classes.each do |parent|
+	  if parent.name == c.superclass
+	    c.parent = parent
+	    superclasses[parent.name] = parent
+	    superclasses.merge!(find_and_parse_superclass_of(parent,options)) if parent.superclass
+	  end
+	end
+      end
+    else
+      $stderr.puts "Warn: Parent #{c.superclass} of #{c.name} not known"
+    end
+  rescue Exception => e
+    parser.error_handler e
+  end
+  superclasses
+end
+
+#--------------------------------------------------------------------
+
+# path to current cim schema files
+CIM_CURRENT = "/usr/share/mof/cim-current"
+
+####
+## argv handling
+
+generate_test = ARGV.delete("-t")
+
+generate_classinfo = ARGV.delete("-c")
+
+#
+# parse mofparse arguments
+#
+
+moffiles, options = MOF::Parser.argv_handler "genprovider", ARGV
+if moffiles.empty?
+  $stderr.puts "No .mof files given"
+  exit 1
+end
+if !options[:namespace].nil? && options[:namespace].empty?
+  options[:namespace] = nil
+end
+
+if options[:namespace].nil?
+  $stderr.puts "** skipping registration"
+  $stderr.puts "   Provide a namespace (-n <namespace>) to generate registration file"
+end
+
+#
+# parse genprovider arguments
+#
+
+options[:style] ||= :cim
+options[:includes] ||= []
+options[:includes].unshift(Pathname.new ".")
+options[:includes].unshift(Pathname.new CIM_CURRENT)
+options[:testcase] = generate_test
+
+#
+# Extend include pathes with all directories below CIM_CURRENT
+#
+
+Dir.new(CIM_CURRENT).each do |d|
+  next if d[0,1] == "."
+  fullname = File.join(CIM_CURRENT, d)
+  next unless File.stat(fullname).directory?
+  options[:includes].unshift(Pathname.new fullname)
+end
+
+#
+# Ensure that qualifiers.mof is included
+#
+
+moffiles.unshift "qualifiers.mof" unless moffiles.include? "qualifiers.mof"
+qualifiers_optional = "qualifiers_optional.mof"
+unless moffiles.include? qualifiers_optional
+  moffiles.unshift qualifiers_optional if File.readable?(File.join(CIM_CURRENT, qualifiers_optional))
+end
+
+####
+## parse
+
+#
+# Parse all given mof files
+#
+
+parser = MOF::Parser.new options
+begin
+  result = parser.parse moffiles
+rescue Exception => e
+  parser.error_handler e
+  exit 1
+end
+
+exit 0 unless result
+
+#
+# collect classes to find parent classes
+#
+
+# classes: Hash of { classname -> CIM::Class }
+classes = {}
+# to_generate: CIM::Class of mof files given as ARGV
+to_generate = []
+result.each do |name, res|
+  puts "Result #{name}"
+  res.classes.each do |c|
+    to_generate << c
+    puts "  Generate #{c.name}"
+    # complete classes hash (happens if a .mof file defines multiple classes)
+    classes[c.name] = c unless classes.has_key? c.name
+  end
+end
+
+#
+# Iterate through parsed classes to find their superclasses
+#
+
+superclasses = {}
+classes.each_value do |c|
+  puts "#{c.name} << #{c.superclass}"
+  next unless c.superclass # skip if no superclass
+  next if classes.has_key? c.superclass # skip if superclass known
+  next if superclasses.has_key? c.superclass # skip if superclass known
+  superclasses.merge! find_and_parse_superclass_of(c,options)
+end
+
+# extend the { classname -> CIM::Class } hash with all superclasses
+
+classes.merge! superclasses
+
+####
+## generate
+
+outdir = options[:output] || "generated"
+Dir.mkdir outdir rescue Errno::EEXIST
+
+to_generate.each do |c|
+  if generate_classinfo
+    klass = c
+    while klass
+      Genprovider::Output.new File.join(outdir,"#{klass.name}.rb"), options[:force] do |out|
+        Genprovider::ClassInfo.new klass, out
+      end
+      klass = klass.parent
+    end
+    next
+  end
+  
+  if options[:testcase]
+    Genprovider::Output.new File.join(outdir,"test_#{c.name.decamelize}.rb"), options[:force] do |out|
+      Genprovider::Testcase.new c, options[:namespace]||"root/cimv2", out
+    end
+    next
+  end
+
+  providerprop = c.qualifiers["provider", :string]
+  providername = (providerprop ? providerprop.value.sub("cmpi:","") : c.name)
+  Genprovider::Output.new File.join(outdir,"#{providername.decamelize}.rb"), options[:force] do |out|
+    Genprovider::Provider.new c, providername, out
+  end
+
+  Genprovider::Output.new File.join(outdir,"#{providername}.rdoc"), options[:force] do |out|
+    Genprovider::RDoc.new c, out
+  end
+
+  if options[:namespace]
+    Genprovider::Output.new File.join(outdir,"#{c.name}.registration"), options[:force] do |out|
+      Genprovider::Registration.new c, options[:namespace], providername, out
+    end
+  end
+  
+end

data/bin/regprovider

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+#
+# register
+#
+# Helper to register a 'genprovider' Ruby provider
+#
+
+$mofdir = "features/mof"
+$providerdir = "/usr/share/cmpi"
+$generateddir = "generated"
+
+#
+# Convert CamelCase to underline_case
+#
+
+class String
+  def decamelize
+    # CamelCase -> under_score
+    self.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+	 gsub(/([a-z\d])([A-Z])/,'\1_\2').
+	 tr("-", "_").
+	 downcase
+  end
+end
+
+
+def usage msg = nil
+  STDERR.puts "** Error: #{msg}" if msg
+  STDERR.puts "register [-h] [-c <cimom>] [-m <mofdir>] [-p <provdir] [-r <regdir>] <name>"
+  STDERR.puts "\tregisters <mofdir>/<name>.mof implemented by <provdir>/<name>.rb via <regdir>/<name>.registration to <cimom> (defaults to sfcb)"
+  STDERR.puts "\t<mofdir> defaults to #{$mofdir}"
+  STDERR.puts "\t<provdir> defaults to #{$generateddir}"
+  STDERR.puts "\t<regdir> defaults to #{$generateddir}"
+  exit 1
+end
+
+cimom = "sfcb"
+name = nil
+symlink = false # symlink provider, don't install
+
+loop do
+  arg = ARGV.shift
+  break unless arg
+  case arg
+  when "-h" then usage
+  when "-c" then cimom = ARGV.shift
+  when "-m" then mofdir = ARGV.shift
+  when "-r" then regdir = ARGV.shift
+  when "-p" then provdir = ARGV.shift
+  when "-l" then symlink = true
+  else
+    usage("Unknown option #{arg}") if arg[0,1] == "-"
+    name = arg
+  end
+end
+
+unless name
+  usage "Class name missing"
+end
+
+moffile = "#{mofdir || $mofdir}/#{name}.mof"
+providerfile = "#{provdir || $generateddir}/#{name.decamelize}.rb"
+registrationfile = "#{regdir || $generateddir}/#{name}.registration"
+
+puts "Registering #{moffile} implemented by #{providerfile} via #{registrationfile} to #{cimom}"
+
+classname = namespace = providername = libraryname = nil
+
+File.open registrationfile do |reg|
+  while line = reg.gets
+    next if line[0,1] == "#"
+    # Classname - Namespace - Providername - Libraryname - Capabilities ...
+    #RCP_SimpleDataTypes root/cimv2 RCP_SimpleDataTypes rbCmpiProvider instance
+    values = line.split(" ")
+    next if values.size < 5
+    next unless values[0] == name
+    classname = values[0]
+    namespace = values[1]
+    providername = values[2]
+    libraryname = values[3]
+    break
+  end
+end
+
+cmd = "provider-register.sh -t #{cimom} -n #{namespace} -r #{registrationfile} -m #{moffile}"
+result = system cmd
+unless $?.success?
+  STDERR.puts "** Failed: #{result}"
+  STDERR.puts cmd
+  exit 1
+end
+
+if symlink
+  File.symlink File.expand_path(providerfile), $providerdir
+else
+  cmd = "cp #{providerfile} #{$providerdir}"
+  result = system cmd
+  unless $?.success?
+    STDERR.puts "** Failed: #{result}"
+    STDERR.puts cmd
+    exit 1
+  end
+end
+
+puts "Success !"

data/features/003-create.feature

@@ -0,0 +1,10 @@
+Feature: Ability to parse a mof and create a template
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to access it using ruby-sfcc
+  Scenario: Create an instance
+    Given "Cmpi_Swig" is registered in namespace "test/test"
+    When I create an instance of "Cmpi_Swig" with "hello" set to "Hello world"
+    Then I should see "Cmpi_Swig" in enumerated instance names
+    And the instance of "Cmpi_Swig" should have property "hello" set to "Hello world"

data/features/004-modify.feature

@@ -0,0 +1,9 @@
+Feature: Ability to parse a mof and create a template
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to access it using ruby-sfcc
+  Scenario: Change an instance
+    Given an instance of "Cmpi_Swig" with property "hello" set to "Hello world"
+    When I change the property "hello" to "Goodbye, cruel world"
+    Then the instance of "Cmpi_Swig" should have property "hello" set to "Goodbye, cruel world"

data/features/005-delete.feature

@@ -0,0 +1,7 @@
+Feature: Ability to parse a mof and create a template
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to access it using ruby-sfcc
+  Scenario: Delete an instance
+    Given an instance of "Cmpi_Swig" with property "hello" set to "Hello, world"

data/features/datatypes.feature

@@ -0,0 +1,13 @@
+Feature: Test providers with different data types
+  In Order to test different property types
+  I want to run providers
+  Then they should all work
+  Scenario Outline: Run providers
+    Given a generated provider for "samples/mof/<klass>.mof"
+    When I register "samples/mof/<klass>.mof" using "<klass>.registration" with sfcb
+    Then I should see "<klass>" in enumerated instance names
+
+  Examples:
+  | klass |
+  | RCP_SimpleDataTypes |
+  | RCP_ArrayDataTypes |

data/features/ensure-format.feature

@@ -0,0 +1,28 @@
+Feature: Ensure genprovider output format
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to get it compiled
+  Scenario Outline: Ensure correct output format and compilation
+    Given I have a mof file called "<mof>"
+    When I pass "<mof>" to genprovider
+    Then comment lines should not exceed 75 characters
+    And its output should be accepted by Ruby
+
+  Examples:
+    | mof                                |
+    | features/mof/trivial.mof           |
+    | samples/mof/qualifiers.mof         |
+    | samples/mof/RCP_ArrayDataTypes.mof |
+    | samples/mof/RCP_ClassMethod.mof    |
+    | samples/mof/RCP_ComplexMethod.mof  |
+    | samples/mof/RCP_ComputerSystem.mof |
+    | samples/mof/RCP_OperatingSystem.mof|
+    | samples/mof/RCP_OSProcess.mof      |
+    | samples/mof/RCP_PhysicalMemory.mof |
+    | samples/mof/RCP_Processor.mof      |
+    | samples/mof/RCP_RunningOS.mof      |
+    | samples/mof/RCP_SimpleClass.mof    |
+    | samples/mof/RCP_SimpleDataTypes.mof|
+    | samples/mof/RCP_SimpleMethod.mof   |
+    | samples/mof/RCP_UnixProcess.mof    |

data/features/have-instances.feature

@@ -0,0 +1,19 @@
+Feature: Test providers with known instances
+  In Order to test providers known to have instances
+  As a developer
+  I want to enumerate instances
+  Then I should get a non-zero instance count
+  Scenario Outline: Enumerate instances
+    Given a generated provider for "samples/mof/<class>.mof"
+    And I register "samples/mof/<class>.mof" using "<class>.registration" with sfcb
+    And "<class>" is registered in namespace "test/test"
+    Then I should see "<class>" in enumerated instance names
+
+  Examples:
+    | class |
+    | RCP_ComputerSystem |
+    | RCP_OperatingSystem|
+    | RCP_PhysicalMemory |
+    | RCP_Processor      |
+    | RCP_RunningOS      |
+    | RCP_UnixProcess    |

data/features/mof/trivial.mof

@@ -0,0 +1,20 @@
+//
+// trivial.mof - A trivial sample file for genprovider
+//
+//
+
+#pragma locale ("en_US")
+//#pragma namespace ("root/cimv2")
+
+// ===================================================================
+// 	Cmpi_Swig
+// ===================================================================
+
+[ Provider("cmpi:Cmpi_Swig"),
+  Description ("A sample class to demonstrate cmpi/swig" )
+]
+class Cmpi_Swig : CIM_ManagedElement
+{ 
+  [Key, Description ("A friendly greeting") ]
+  string hello;
+};

data/features/registration.feature

@@ -0,0 +1,12 @@
+Feature: Ability to register a provider with sfcb
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to register it with sfcb
+  Scenario Outline: Register with sfcb
+    When I register "<mof>" using "<registration>" with sfcb
+    Then I should see "<class>" in namespace "<namespace>"
+
+  Examples:
+    | mof                      | registration           | class     | namespace |
+    | features/mof/trivial.mof | Cmpi_Swig.registration | Cmpi_Swig | test/test |

data/features/run-genprovider.feature

@@ -0,0 +1,10 @@
+Feature: Run genprovider
+  In Order to verify the basic functionality
+  As a developer
+  I want to generate a simple Ruby provider
+  Then I should be able to get it compiled
+  Scenario: Run genprovider
+    When I run genprovider with no arguments
+    Then I should see an error message
+    When I run genprovider with "-h"
+    Then I should see a short usage explanation

data/features/show-context.feature

@@ -0,0 +1,9 @@
+Feature: Show CMPIContext passed to provider
+  In Order to view the CMPIContext passed to the provider by the CIMOM
+  As a developer
+  I want to run the rcp_show_context provider
+  Then I should get an array of key, value pairs
+  Scenario: Run rcp_show_context
+    Given a generated provider for "samples/mof/RCP_ShowContext.mof"
+    And I register "samples/mof/RCP_ShowContext.mof" using "RCP_ShowContext.registration" with sfcb
+    Then I should see "RCP_ShowContext" in enumerated instance names