NEWS

pywbem-0.8.0~dev (last updated: 2014-10-10, includes commits up to r672)

  ENHANCEMENTS:

    * Verify certificates against platform provided CA trust store in
      /etc/pki/tls/certs. Linux only.  (Peter Hatina)

    * Added '-d' option to MOF compiler that causes the compiler to perform a
      dry-run and just check the MOF file syntax. This allows to more easily
      detect included MOF files when used together with the '-v' option.
      (Jan Safranek)

    * Added support for non-ASCII (Unicode) characters.  (Michal Minar, Andreas
      Maier)
      
    * Improved information in the message text of some exceptions (TypeError
      and KeyError in cim_obj.py, ValueError in cim_obj.py, and ParseError in
      tupleparse.py).  (Andreas Maier)

    * Moved the definition of the pywbem version from setup.py to __init__.py,
      in order to make it available to programs using pywbem as
      pywbem.__version__.  (Andreas Maier)

    * Added support for direct iteration over NocaseDict objects using 'for'
      and 'in' by adding __iter__(), e.g. for use with CIMInstance.properties.
      (Andreas Maier)

    * Added more instance attributes to be shown in repr() on CIMProperty and
      other classes in cim_obj.  (Andreas Maier)

    * Added and improved docstring-based documentation in the pywbem modules
      cim_operations, cim_http, cim_obj, cim_types, and the pywbem module.
      (Andreas Maier)

    * Improved the way missing file:// URL support on Windows is handled, by
      now issuing a proper error message instead of stumbling across the
      missing socket.AF_UNIX constant.  (Andreas Maier)

    * Improved the way missing OWLocal authorization with the OpenWBEM server
      is handled on Windows, by now issuing a proper error message instead of
      stumbling across the missing os.getuid() function.  (Andreas Maier)
      
    * Improved Windows portability by no longer attempting to import 'pwd' in
      case the userid is not set in the environment variables that are checked
      when the WBEM server is local.  (Andreas Maier)

  BUG FIXES:

    * Fix syntax error in CIM DTDVERSION error path.  Allow KEYVALUE
      VALUETYPE attribute to be optional as specified in the DTD.
      (Andreas Linke)

    * Added parsing of InvokeMethod return value and output parameters for
      Twisted Python client.  (Tim Potter)

    * Fixed cim_provider2.py to properly support shutdown() and can_unload()
      (called from CMPI cleanup() functions).  Support was recently added
      to cmpi-bindings for this.  (Bart Whiteley)

    * Fixed XML parsing to accept SFCB-style embedded instance parameters.
      (Mihai Ibanescu)

    * Use getpass module instead of pwd to detect local user to fix Win32.
      (Tim Potter)

    * Re-throw KeyError exceptions with capitalised key string instead
      of lower cased version in NocaseDict.__getitem__().  (Tim Potter)

    * Use base64.b64encode() instead of base64.encodestring() in Twisted
      client. (Mihai Ibanescu)

    * Fix missing CIMDateTime import in Twisted client.  (Mihai Ibanescu)

    * Fixed CIMInstanceName rendering to string. It is now possible to pass the
      rendered string value as an instance path argument of a CIM method.
      (Jan Safranek, Michal Minar)

    * For Python providers, fixed the comparsion of the Role parameter in
      association operations to be case insensitive, and removed an erroneous
      test that raised an exception when the property specified in the Role
      parameter was not also in the property list specified by the Properties
      parameter.  (Jan Safranek)

    * For Python providers, converted debug 'print' statements to trace
      messages that end up in the system log.  (Jan Safranek)

    * The CIM-XML parser no longer throws an exception when parsing a
      qualifier declaration.
      Note: The CIM-XML supported by this fix does not conform to DSP0201 so
      far. Further fixes are pending.  (Jan Safranek)

    * Fixed parsing errors for connection URLs with IPv6 addresses.
      Note: The parsing support does not address all issues with IPv6 addresses,
      and it does not support zone indexes (aka scope IDs). Further fixes are
      pending.  (Peter Hatina)

    * Fixed the hard coded socket addressing family used for HTTPS that was
      incorrect in some IPv6 cases, by determining it dynamically.
      (Peter Hatina)

    * Fixed the list of output parameters of extrinsic method calls to be
      returned as a case insensitive dictionary (using cim_obj.NocaseDict).
      (Jan Safranek)

    * Fixed the checking of CIMVERSION attributes in CIM-XML to only verify the
      major version, consistent with DSP0201 (see subclause 5.2.1, in DSP0201
      version 2.3.1).  (Jan Safranek)

    * Fixed error in cim_http.py related to stronger type checking of Python
      2.7. (Eduardo de Barros Lima)

    * Removed erroneous qualifier scopes SCHEMA and QUALIFIER from the MOF
      compiler (see DSP0004).  (Andreas Maier)

    * Fixed debug logging of CIM-XML payload (that is, conn.last_*request/reply
      attributes) for extrinsic method calls, to now be consistent with
      intrinsic method calls.  (Andreas Maier)

    * Fixed TOCTOU (time-of-check-time-of-use) error when validating peer's
      certificate.  (Michal Minar)

    * Added a check in the CIMInstanceName constructor that the 'classname'
      argument is not None.  (Andreas Maier)

    * Fixed the issue in the CIMProperty constructor that specifying a tuple
      for the 'value' argument was incorrectly detected to be a scalar (and not
      an array).  (Andreas Maier)
    
    * Fixed the issue in the CIMProperty constructor that specifying a
      datetime or timedelta typed value resulted in storing the provided object
      in the 'value' attribute, instead of converting it to a CIMDateTime
      object.  (Andreas Maier)
    
    * Fixed the issue in the CIMProperty constructor that specifying a datetime
      formatted string typed 'value' argument along with type='datetime'
      resulted in storing the provided string object in the 'value' attribute,
      instead of converting it to a CIMDateTime object.  (Andreas Maier)
    
    * Fixed several cases in the CIMProperty constructor of unnecessarily
      requiring the optional arguments 'type', 'is_array', 'embedded_object',
      or 'reference_class'. These optional arguments are now only necessary to
      be provided if they cannot be implied from provided arguments (mainly
      from 'value').  (Andreas Maier)
    
    * Fixed the issue in the CIMProperty constructor that an 'embedded_object'
      argument value of 'object' was changed to 'instance' when a CIMInstance
      typed 'value' argument was also provided.  (Andreas Maier)

    * Fixed the issue in the CIMProperty constructor that the first array
      element was used for defaulting the 'type' attribute, without checking
      that for None, causing an exception to be raised in this case.
      (Andreas Maier)
    
    * Added a check in the CIMProperty constructor that the 'name' argument is
      not None.  (Andreas Maier)

    * Fixed the issue that the CIMProperty constructor raised only TypeError
      even when the issue was not about types; it now raises in addition
      ValueError.  (Andreas Maier)

    * Changed the exception that is raised in NocaseDict.__setitem__() for
      invalid key types, to be TypeError in instead of KeyError. Updated the
      testcases accordingly.  (Andreas Maier)

    * Added checks for more than one argument and for unsupported argument
      types to the constructor of NocaseDict.  (Andreas Maier)

  TESTING:

    * Added support for running the unit test cases without having to be in the
      testsuite directory. This was done by setting up the DTD_FILE path
      correctly for any XML tests.  (Andreas Maier)

    * Improved the quality of assertion messages issued when testcases fail, to
      include context information and types.  (Andreas Maier)

    * Added docstrings to test cases.  (Andreas Maier)

    * Added testcases for CIMProperty.__init__() to be comprehensive.
      (Andreas Maier)

    * In XML validation tests, added the expected XML root element.
      (Andreas Maier)

    * Added a header to any error messages issued by xmllint.  (Andreas Maier)

    * Fix: Merged stderr into stdout for the xmllint invocation, xmllint error
      messages go to stderr and had been dropped before.  (Andreas Maier)

    * Fix: The "mkdir -p ..:" command in the comfychair testcase constructor
      created subdirectories named "-p" when running on Windows; replaced that
      command with os.makedirs().  (Andreas Maier)

    * Fix: Replaced the "rm -fr ..." command in the comfychair testcase
      constructor with shutil.rmtree(), in order to better run on Windows.
      (Andreas Maier)
  
    * Fix: In comfychair._enter_rundir(), moved registration of cleanup
      function _restore_directory() to the end, so cleanup happens only if no
      errors happened.  (Andreas Maier)

    * Fixed a bug in pywbem/trunk/testsuite/test_tupleparse.py in function
      ParseCIMProperty.runtest(), where the use of real tab characters caused
      a few lines to be incorrectly indented, and as a result, ignored for the
      test.  (Andreas Maier)

    * Improved Windows portability in testsuite: Moved from using the Unix-only
      functions posix.WIFSIGNALED() and posix.WEXITSTATUS() for testing the
      success of subprocess.wait(), to simply testing for 0.

  CLEAN CODE:
    
    * Removed dangerous default parameter '{}' from CIMProperty and
      CIMInstanceName, and replaced it with 'None'. To support that, added
      support for initializing an empty NocaseDict object from 'None'.

    * In cim_obj, changed the use of the deprecated backticks to using %r in
      the format string (which produces the same result).

    * In the constructor of CIMInstanceName, added assertions to some paths
      that cannot possibly be taken based on the fact that the keybindings
      attribute is always a NocaseDict. They should be removed at some point.

    * Addressed PyLint issues:
      - Consolidated imports at the top of the module (after module docstring),
        consistent with the PEP-8 recommendation.
      - Ensured order of imports: standard, non-standard, pywbem, local (on a
        subset of modules only).
      - Replaced wildcard imports with specific imports, as much as possible.
      - Removed unused imports.
      - Addressed PyLint issues that are related to whitespace, continuation
        indentation, and line length.
      - Replaced all real tab characters with spaces.

  PACKAGING / BUILD:

    * Fixed grammatical funkiness in the license text.  No change to actual
      license - still LGPLv2.  (Tim Potter)

    * Added LICENSE.txt file to release.  (Tim Potter)

    * Added LICENSE.txt, NEWS, README and INSTALL files to distribution
      archive.  (Andreas Maier)

    * Removed confusing section about build from INSTALL file, to scope it just
      to the topic of installation.  (Andreas Maier)

    * Restructured pywbem/trunk subtree to move pywbem package files into a
      pywbem subdirectory.  (Andreas Maier)

    * Added a makefile (invoke 'make help' for valid targets).  (Andreas Maier)

    * Added support for checking the Python source code using PyLint.
      (Andreas Maier)

    * Added support for generating HTML documentation using epydoc, and
      included the documentation into the distribution archive. The syntax
      used in Python docstrings is reStructuredText markdown.   (Andreas Maier)


pywbem-0.7  2008-12-12

  BUG FIXES:

    * Fixed enumInstances and references in cim_provider to do a deep
      copy of the model before filtering instances so provider writers
      are less surprised.  (Bart Whiteley)

    * Added CIMDateTime.__cmp__() so that CIMDateTime instances can be
      compared.  (Bart Whiteley)

    * Fixed data types of method return values for python providers.
      (Bart Whiteley)

    * Fixed REF array out parameters in tupleparse.py.
      (Bart Whiteley)

    * Fixed Array parameters with no elements.  (Bart Whiteley)

    * Fixed precision for real32 and real64 types.  (Bart Whiteley)

    * Fixed Array properties where is_array isn't set in __init__.
      (Bart Whiteley)

    * Added NocaseDict.__cmp__(self, other).  (Bart Whiteley)

    * Fixed WBEMConnection.__repr__ for anonymous connections. (Tim Potter)

    * Fixed XML encoding of CIMQualifierDeclarations.  (Bart Whiteley)

    * Fixed EnumerateQualifiers if there are no qualifiers.  (Bart Whiteley)

    * Fixed InvokeMethod to only send a LOCALCLASSPATH or LOCALINSTANCEPATH,
      not a CLASSPATH or INSTANCEPATH.  (Bart Whiteley)

    * Fix unexpected line break in basic auth header for long
      credentials.  (Daniel Hiltgen)

    * Fix Host: HTTP header when connecting to a unix domain socket.
      (Bart Whiteley)

    * Fix deprecation warnings with Python 2.6.  (Bart Whiteley)

  ENHANCEMENTS:

    * Added support for generating Pegasus provider registration MOF in
      cim_provider.codegen(). (Bart Whiteley)

    * Implemented methods to parse indication export requests.
      (Bart Whiteley)

    * Python provider code generation enhancements.  (Bart Whiteley)

    * Support for Pegasus Local authentication.  (Bart Whiteley)

    * Support for Pegasus and OpenWBEM Unix Domain Socket.  (Tim and Bart)

    * Added support for Pegasus non-compliant EMBEDDEDOBJECT XML attribute.
      (Bart Whiteley)

    * Added CIMQualifierDeclaration.tomof().  (Bart Whiteley)

    * Added a powerful MOF compiler.  (Bart Whiteley)

    * Added property filtering to CIMInstance.  (Bart Whiteley)

    * Added value attribute to CIMParameter.  (Bart Whiteley)

    * Rigged CIMInstance to automagically update CIMInstance.path.keybindings
      as key properties are set.  (Bart Whiteley)

    * Added cim_provider2.py: A new provider interface.  Python providers
      using this interface can use the cmpi-bindings project within OMC
      (http://omc-project.org/) to run under any CIMOM supporting the
      CMPI interface.  This is prefered to the old cim_provider.py interface
      that was used with the Python Provider Managers for OpenWBEM and Pegasus.

    * Changed __init__.py to not import anything from cim_provider.py (or
      cim_provider2.py) into the pywbem namespace.  Existing providers based
      on cim_provider.py can still work with a minor adjustment involving
      importing CIMProvider from pywbem.cim_provider.  The codegen funtion
      can now be obtained with 'from pywbem.cim_provider import codegen', or
      'from pywbem.cim_provider2 import codegen' or similar.

    * Added wbemcli.py command line utility.  (Tim Potter)

    * Pass keyword args in unix domain socket connection functions down to
      WBEMConnection().  (Tim Potter)


pywbem-0.6  2007-10-26

  LICENSING:

    * Relicensed from the GNU GPLv2 to the GNU LGPLv2.

  API CHANGES:

    * Add a type keyword arg and attribute to CIMQualifier, similar to
      the CIMProperty object, to allow the creation of null qualifiers.
      (Tim Potter)

    * Remove the toxml() method from CIM object classes.  Use
      tocimxml().toxml() instead which specifies the CIM-XML
      representation of the object. (Tim Potter)

    * CIMDateTime class should now be used instead of datetime.datetime
      and datetime.timedelta.

    * Added a new method, CIMInstance.update_existing().  This behaves
      like update() on a dict, but only assigns new values to existing
      properties.  It skips values for properties not already present
      in the instance.  This is useful for honoring PropertyList within
      python providers.

  BUG FIXES:

    * Explicitly specify charset="utf-8" in HTTP Content-type header
      as this is required now by the Pegasus cimserver.  (Tim Potter)

    * Parse VALUETYPE elements that contain a TYPE attribute.  This
      feature was introduced in version 2.2 of the CIM-XML DTD and
      produced by some CIMOMs such as the Java WBEM Server.  (Tim Potter)

    * Don't require CreateInstance to have the path attribute set but
      if it is, use the namespace from it.  (Tim Potter)

    * Allow extrinsic methods to return object references.  (Tim Potter)

    * Fix CIMInstanceName to support more numeric types of keybindings.
      (Bart Whiteley)

    * Fix datetime values to support utc offset. (Bart Whiteley)

    * Fix http client to monitor the connection more closely (RFC 2616
      section 8.2.2).  Previously, a large request could cause a socket
      exception with no ability to read the response and respond to
      an authentication challenge.

    * Fix NULL qualifiers to have a (required) type. (Martin Mrazik)

    * Fix initialising CIMInstanceName keys from a NocaseDict. (Bart
      Whiteley)

    * Return correct namespace in path for return value from
      GetInstance. (Tim Potter)

    * Numerous bugfixes to Twisted Python client. (Tim Potter)

    * Fix for x.509 SSL certificate handling. (Bas ten Berge)

    * EnumerateClassNames() now returns an empty list instead of None
      if there are no classes. (Bart Whiteley)

  ENHANCEMENTS:

    * Support for OpenWBEM password-less local authentication.
      (Bart Whiteley)

    * Support for embedded objects is described in DSP0201-2.2.0
      (Bart Whiteley)

    * New CIMDateTime class to deal with CIM-isms of datetimes.
      Most notably, datetime deals with timezone info poorly.
      (Bart Whiteley)

    * Add InvokeMethod() support in Twisted Python client. (Tim
      Potter)

pywbem-0.5  2006-11-21

  API CHANGES:

    * Many API changes were made to simplify the function and object
      interface of PyWBEM.  Aspects of just about every CIM operation
      call and CIM object have changed.  The major changes are:

      - The "LocalNamespacePath" keyword argument has been renamed to
        simply "namespace" for all CIM operations.

      - Replaced all object location classes with CIMInstanceName, and
        all instance classes with CIMInstance.  CIMInstanceName now
        has "host" and "namespace" attributes to fully name a
        reference to an instance.  The CIMInstance class now has a
        "path" attribute which is of type CIMInstanceName.

      - EnumerateInstances() now returns a list of CIMInstance objects
        (with path attribute set) instead of a list of
        CIMNamedInstance or tuples of (CIMInstanceName, CIMInstance).

      - All representations of properties can now be represented with
        the CIMProperty class.

    * All classes now have a copy() method which return a deep copy of
      the object.  PyWBEM makes extensive use of dictionary objects
      which are passed by reference in Python.  Use the copy() method
      to create and manipulate objects without modifying them by
      accident.

  BUG FIXES:

    * Fix parse bug when a CIMInstanceName is passed as the
      localobject parameter to WBEMConnection.InvokeMethod().

    * Fix parsing of INSTANCE elements containing PROPERTY.REFERENCE
      elements bug found by Bart Whiteley.  This turns up when
      processing associations. (Tim Potter)

    * Handle extrinsic method calls that don't return a value or any
      output parameters. (Tim Potter)

    * Fixed parsing of PARAMETER.ARRAY and PARAMETER.REFARRAY to
      not require optional attrs. (Bart Whiteley)

    * Atomic_to_cim_xml string generation for a datetime - was missing
      a >> '.' in the string. (Norm Paxton)

    * InvokeMethod did not provide for 'None' in output parameters.
      (Norm Paxton)

  ENHANCEMENTS:

    * More parts of the class provider interface have been
      implemented.  (Tim Potter, Bart Whiteley)

    * Many case-sensitivity bugs, mostly in __cmp__ methods, were
      found and fixed.  (Tim Potter)

    * Implemented a test suite for maintaining backward compatibility
      and testing new features.  (Tim Potter)

    * Implemented ExecQuery. (Bart Whiteley)

    * Allow a string classname to be passed as the localobject
      parameter to WBEMConnection.InvokeMethod(). (Tim Potter)

    * Add missing qualifiers on array properties. (Bart Whiteley)

    * Added code for performing asynchronous WBEM client operations
      using the Twisted Python framework. (Tim Potter)

    * Allow extrinsic method calls that take parameters. (Tim Potter)

    * Added cim_http.AuthError exception class.  This is raised if the
      CIMOM returns a 401 (Unauthorized).  Now the client can
      distinguish this condition, and (re)prompt for credentials.
      (Bart Whiteley)

    * Created cim_obj.CIMParameter class.  Added return type,
      class origin, propagated to CIMMethod.  CIMParameter object
      now allows parameter types and qualifiers to be obtained.
      (Bart Whiteley)

    * Implemented case-insensitive keys for property and qualifier
      dictionaries, as per the CIM specification.  (Tim Potter, Bart
      Whitely)


pywbem-0.4  2005-11-15

  BUG FIXES:

    * Correctly calculate value of Content-Length HTTP header to include
      opening XML stanza. (Szalai Ferenc)

    * Fix syntax error when re-raising socket errors. (Pat Knight)

  ENHANCEMENTS:

    * Support for marshaling and unmarshaling CIM dates object into
      Python datetime objects. (Szalai Ferenc)

    * Experimental module for making asynchronous WBEM calls with
      PyWBEM in Twisted Python. (Tim Potter)

    * Add parameter type checking for object location classes. (Tim
      Potter)

    * Allow caller to pass in a dictionary containing the location of
      the SSL certificate and key files as per the httplib.HTTPSConnection()
      class constructor. (Pat Knight)

  API CHANGES:

    * Change association provider API functions to take a fixed
      parameter for the named object instead of a keyword argument.
      This breaks backward compatibility. (Tim Potter)

    * Remove the CIMLocalNamespacePath class and replaced by a Python
      string. (Tim Potter)

  PORTABILITY:

    * Don't use UserDict.DictMixin base class as it only exists in
      Python 2.3 and higher. (Tim Potter)

  TESTS:

    * Add tests for parameter type checking for object location
      classes. (Tim Potter)

    * Add tests for string representation of object location classes.
      (Tim Potter)