Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-3837

Work around Ruby string encoding behavior exercised during registry calls in win32/registry

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 4.0.0
    • Component/s: Windows
    • Labels:
    • Template:
    • Epic Link:
    • Story Points:
      3
    • Sprint:
      Windows 2015-01-28, Windows 2015-02-11

      Description

      There is a lot of encoding issues surrounding the use of win32/registry.rb from Ruby v2.1 and above. Prior to 2.1, there was some craziness, but it didn't affect us in a negative way. The recommendation is that we stop using that and instead make the calls to the registry directly using FFI.

      Quite a bit of background is on the PR for PUP-3779 - https://github.com/puppetlabs/puppet/pull/3459#discussion_r22838455

      The issues surrounding ruby's win32/registry.rb could also impact:

      • registry module
      • Any custom facts that make registry calls

        Attachments

          Issue Links

          blocks

          New Feature - A new feature of the product, which has yet to be developed. PUP-3818 Execute Windows acceptance pre-suite against Ruby 2.1.5

          • Critical - Crashes, loss of data, severe memory leak.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PUP-3915 Remove win32console for Windows Ruby 2.1.5

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed
          relates to

          Bug - A problem which impairs or prevents the functions of the product. PUP-2154 Puppet Resource Package not work with Windows OS (russian localization)

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. PUP-2937 Windows: Unable to reference packages with UTF-8 Characters in their names

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed

          Task - A task that needs to be done. PUP-3779 Verify spec tests in dev env for Ruby 2.1.5

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PUP-2564 Specify UTF-8 as a default encoding for puppet

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PUP-3951 Prefer api_types.read_wide_str(length, encoding) in Windows calls

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. MODULES-1921 Ruby 2.1.5 / Puppet 4 registry corruption when writing REG_MULTI_SZ values

          • Blocker - Blocks development and/or testing work, production could not run.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. PUP-4325 Gem provider fails to run on Ruby 2.1.5 / Puppet 4 on Windows

          • Critical - Crashes, loss of data, severe memory leak.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. MODULES-2005 Registry - Hyphen in Array causes random characters appended to value (failure in should_manage_values.rb)

          • Major - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. ENTERPRISE-459 Package Resource will not recognize a package's displayname containing special charcters

          • Trivial - Cosmetic problem like misspelt words or misaligned text.
          • Closed

          Task - A task that needs to be done. MODULES-1723 Windows Registry module needs to be updated with FFI calls to avoid Ruby 2.1.5 encoding issues

          • Critical - Crashes, loss of data, severe memory leak.
          • Resolved
          links to

          Web Link GH PR #3459

          Web Link Puppet master PR #3540

          Web Link Ruby bug #8508 - Invalid byte sequence in UTF-8 (ArgumentError) in win32/registry.rb

          Web Link Ruby bug #8943 - Invalid encoding for Windows Registry

          Web Link Ruby bug #10300 - Encoding error in conversion from UTF-16LE to UTF-8 to CP850

          Web Link Ruby Issue 10820 - Win32 Registry Delete uses ANSI instead of Wide APIs

          Web Link Ruby Issue 11410 - Win32 Registry enumeration performs unnecessary string re-encoding which cause UndefinedConversionError exceptions

            Activity

              People

              Assignee:
              Unassigned
              Reporter:
              rob Rob Reynolds
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support