Directions and Priorities for pywbem 1.0.0

[andy-maier]

In our meeting on 2018-10-10, we have decided that the next release after pywbem 0.13.0 would be 1.0.0, in which we would largely maintain compatibility for users.

Items for 1.0.0 (final):

• Resolve open bugs - DONE - no open bugs
• UDSConnection support (issue UDSConnection support #2287) DONE - PR Fixes #2287: Removed *UDSConnection classes #2347
• Mock: provider registry list methods are case sensitive (issue Mock: provider registry list methods are case sensitive #2253) DONE - PR Partly fixes #2253: Changed lists and dicts in mock support to use NocaseList #2349
• Pylint issues for 1.0.0 (issue Pylint issues for 1.0.0 #1413) DONE - PR Addressed Pylint issues #2345, Fixes #1413: Addressed Pylint issues and enforced clean Pylint results #2351
• Make NocaseList and NocaseDict public? (issue Make NocaseList (and NocaseDict) public? #2354) - DONE - nocaselist and nocasedict are released. PR Used NocaseDict from nocasedict package #2370 starts using the released NocaseDict, and an earlier PR started using NocaseList.

For information:

• Open issues targeting 1.0.0
• Open issues not targeting any milestone

Items for 1.0.0 that had been released in 1.0.0b3:

• Duplications in description of user-defined providers (issue Duplications in description of user-defined providers #2290) DONE - PR Fixes #2290: Reworked docs on mock server, specifically user-defined providers #2324
• Remove instead of deprecate in experimental mock support (issue Remove instead of deprecate in experimental mock support #2284) DONE - deprecated in PR Change log fixes and cleanup of compile_dmtf_schema() #2292 in 1.0.0b1, removed in PR Fixes #2284: Removed deprecated compile_dmtf_schema() and schema_mof_file #2286 in 1.0.0b3
• It appears there is no code to compile value of inst with embedded object property in it (issue There is no code to compile value of inst with embedded object property in it  #2277) DONE - PR Fixes #2277: MOF compiler ignores EmbeddedObject instance property #2331
• Include tests on pypi tarball area: setup type: enhancement (issue Include tests on pypi tarball #2260) DONE - PR Fixes #2260: Added support for testing from Pypi/GitHub source archives #2319
• Create issues from TODOs in test_wbemconnection_mock.py (issue Create issues from TODOs in test_wbemconnection_mock.py #1240) DONE - PR Fixes #1240: Clean TODOs in tests_wbemconnection.py and _wbemconnection.py #2328, and new issue Mock tests incomplete #2327

Items for 1.0.0 that had been released in 1.0.0b2:

• Add support for array elements to ValueMapping (issue Add support for array elements to ValueMapping #2304) DONE - PR Fixes #2304: Improved support for array-typed elements in ValueMapping #2308 (PR 0.17: Improved support for array-typed elements in ValueMapping #2309 for 0.17.3)
• In change log of 1.0.0, separate pre-1.0.0 and just 1.0.0 changes (issue In change log of 1.0.0, separate pre-1.0.0 and just 1.0.0 changes #2303) DONE - PR Fixes #2303: Split change log of 1.0.0b1 #2307

Items for 1.0.0 that had been released in 1.0.0b1:

• Resolve open bugs - DONE - no open bugs at the time
• Review current experimental functionality for finalization:
  • Operation recorder support.
    Discussion: Decide whether to finalize -> DONE - Not for this version
  • Mock support.
    Discussion: Decide whether to finalize -> DONE - Not for this version
• Testing:
  • Migrate unit tests from unittest to py.test (see issue Conversion of test cases from unittest to pytest for 1.0.0 #1414) - DONE - remaining work is in separate issues
  • Convert test_indicationlistener.py from unittest to pytest (issue Convert test_indicationlistener.py from unittest to pytest #2179) DONE PR Fixes #2179: Converted listener tests from unittest to pytest; added tests #2193
  • Improve test coverage - DONE - good enough for this version.
    • Starting point as of 0.13.0: 84.9% coverage
    • Current master: 88% coverage
    • e.g. by resolving open 1.0.0 issues marked as test enhancements
  • Unittest_extensions.py issue with RegexpMixin (issue Unittest_extensions.py issue with RegexpMixin #804) DONE - Moved beyond 1.0.0 (see issue Convert run_cim_operations.py into an end2end testcase #2180)
• Mock support:
  • Refactor mock support (issue Refactor pywbem mock to separate components #2062) - DONE in multiple PRs
  • Add concept of provider to mock (issue Add concept of provider to mock #1008) - DONE in multiple PRs
  • Add mock support for deprecated iq and ico parms (issue pywbem_mock add code for deprecated iq and ico per DSP0200 #2065) - DONE in PR Fixes #2065: Instance iq and ico variations #2257
• Functional enhancements to MOF compiler:
  • MOF compiler: CreateClass updates existing class (issue MOF compiler: CreateClass updates existing class #991) - DONE - closed issue as invalid
  • MOF compiler does not roll back changes to qualifier declarations (issue MOF compiler does not roll back changes to qualifier declarations #990) DONE - closed issue as wont fix.
  • Issues in MOF output formatting of qualifiers (issue Issues in MOF output formatting of qualifiers #951) DONE - closed issue as wont fix.
  • compiler requires a destination, even for complete compile and dryrun (issue compiler requires a destination, even for complete compile and dryrun #424) DONE - closed issue as wont fix.
• Enhancements for connectivity & SSL:
  • Move from httplib to requests (issue Replace "httplib/m2crypto" with "requests #280) DONE in PR Fixes #280: Migrated HTTP communication to use requests #2023.
    The following issues become moot if we do this:
    • Return to a single SSL environment for both py2 and py3 (issue Get back to a single SSL environment across Python 2 and 3 #496) DONE - PR Fixes #280: Migrated HTTP communication to use requests #2023.
    • Use of ssl.create_default_context() to auto-adjust to better security (issue Use of ssl.create_default_context() to auto-adjust to better security #893) DONE - PR Fixes #280: Migrated HTTP communication to use requests #2023.
    • Hard coded default directories for CA certificates (issue Hard coded default directories for CA certificates #889) DONE - PR Fixes #280: Migrated HTTP communication to use requests #2023.
    • cim_operations appears to have no disconnect (issue ResourceWarnings in py3 during test #86) DONE - PR Fixes #280: Migrated HTTP communication to use requests #2023.
• Other functional enhancements:
  • SLP support (issue SLP support #78) DONE - closed as wont fix
  • Context data for pywbem exceptions (issue Context data for pywbem exceptions #1423) DONE - PR Fixes #1423: Fixes and context for HTTPError and CIMError exceptions and change to use ModelError #2106.
• Efficiency / speed enhancements:
  • Move away from minidom in pretty-printing (issue Replace minidom-based pretty printing #579) - DONE - PR Fixes #1572, #579: Improved performance when setting WBEMConnection.debug #1924.
  • Performance improvement for equality operator of NocaseDict (issue Performance improvement for equality operator of NocaseDict #1062) DONE - abandoned issue Performance improvement for equality operator of NocaseDict #1062 as wont fix, but did fix issue Performance improvement for equality operator of CIM objects #2041.
• Documentation:
  • Improve README page (issue Improve README page #2198) - DONE - PR Fixes #2198: Updated README page and restructured documentation sections #2201 and Readme: Changed doc links to latest/master version #2205
• Packaging:
  • Test RHEL RPM build (issue python setup.py failed when ran from taged release tarball #1245) - DONE - issue went away after removing use of pbr.
• Cleanup:
  • Remove support for Python 2.6 (issue Remove support for Python 2.6 #330 DONE) (incompatible for py26 users)
  • Remove the **extra argument from the WBEMConnection operation methods (issue Remove the **extra argument from the WBEMConnection operation methods #1415) (incompatible if there were WBEM servers supporting non-standard IPARAMVALUE parameters in operations) - DONE
  • Reduce Pylint findings (issue Pylint issues for 1.0.0 #1413) - DONE PR Fixes #1975,#1980: Fixed various install issues on Python 3.8 on native Windows (lxml,pywin32,flake8,pip) #1976, PR Partly fixes #1413: Fixed Pylint issues #2116
    • Starting point as of 0.13.0: 283 fixme, 4 others
    • As of PR Partly fixes #1413: Fixed Pylint issues #2116: 163 fixme, 16 others
  • Clean up direct access to MOFWBEMConnection instance variables (issue Clean up direct access to MOFWBEMConnection instance variables #369) - DONE PR Fixes #369: Cleaned up direct access of MOFWBEMConnection instance attrs #2239
  • mof_compiler overloads CIMError exception (issue mof_compiler adds file_line attribute to CIMError exceptions #1235) - DONE
  • coveralls and issue with coverage versioning (issue coveralls and issue with coverage versioning. #723) - DONE
• Incompatible changes (originally for pywbem v2) (issue Incompatible changes (originally targeted for pywbem v2) #635) - DONE

Moved to future release:

• Documentation / examples / tutorials:
  • Add tutorials (see issue Ideas for new tutorials #1416)
  • Improve existing tutorials (issue Improve existing tutorials #2197)
• Efficiency / speed enhancements:
  • Indication throughput on windows (issue Indication throughput on windows. #528)
  • Consider moving away from the tuple parser as an interim object (issue Redesign of CIM-XML parsing -> save the code #1679)
• Testing:
  • test_recorder.py test displays 4 logs when none should be displayed (issue test_recorder.py test displays 4 logs when none should be displayed #1222)
  • Convert test_mof_compiler.py from unittest to pytest (issue Convert test_mof_compiler.py from unittest to pytest #2178)
• Functional enhancements to MOF compiler:
  • MOF compiler: Limitation that instances with alias must have initialized key properties (issue MOF compiler: Remove req that instances with alias must have any key props initialized #1079)
  • MOF compiler: Limitation that alias must be defined before its use (issue MOF compiler: Limitation that alias must be defined before its use #1078)
• Cleanup:
  • byte/unicode inconsistencies in stored requests and responses (issue byte/unicode inconsistencies in stored requests and responses #2109)
• Extensions to server and indications:
  • Jobs manager extension (issue Jobs manager extension -> save the code #810)
  • Support WBEM Server profile
  • Discussion point: More ideas / items are needed
  • Discussion point: We want to move support for mgmt profiles into a separate Git repo for profile support.