Uploaded image for project: 'Puppet Agent'
  1. Puppet Agent
  2. PA-2942

hocon gem's spec test filename breaks some backup software

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: puppet-agent 5.5.16, puppet-agent 6.9.0
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None
    • Template:
    • Acceptance Criteria:
      Hide

      Users either can backup Puppet successfully or understand whether a file that could break backup software is required.

      Show
      Users either can backup Puppet successfully or understand whether a file that could break backup software is required.
    • Team:
      Night's Watch
    • Story Points:
      1
    • Sprint:
      NW - 2019-10-16, NW - 2019-10-30
    • Method Found:
      Customer Feedback
    • Release Notes:
      Bug Fix
    • Release Notes Summary:
      Hide
      Spec folder is not shipped anymore with the hocon gem.
      This fixes an issues where systems that does not fully support UTF-8 characters could fail.
      Show
      Spec folder is not shipped anymore with the hocon gem. This fixes an issues where systems that does not fully support UTF-8 characters could fail.
    • QA Risk Assessment:
      Needs Assessment

      Description

      Problem statement

      Some backup software with incomplete support for UTF8 characters, such as Quorum onQ, fails when attempting to backup this hocon-1.2.5 gem spec test:

      /opt/puppetlabs/puppet/lib/ruby/vendor_gems/gems/hocon-1.2.5/spec/fixtures/test_utils/resources/ᚠᛇᚻ.conf

      This test was added by Puppet in work on HC-82, which is about BOM detection. Does this test require a runic filename?

      HC-82 includes a test that confirms that UTF8 filenames are incompatible.

      Suggested fix

      Is the test required? It does not appear to have been updated since July 2016, and as far as I can gather it only confirms that ruby-hocon does not support UTF8 filenames.

      it "shouldacceptUTF8FileNames" do
          skip('UTF-8 filenames not currently supported') do
            expect { Hocon::ConfigFactory.parse_file(TestUtils.resource_file("ᚠᛇᚻ.conf")) }.to raise_error
      

      If the test does not require the spec test's filename to use UTF8 characters, please rename it.

      If the test is not required, can it be safely removed by the customer? By us?

      If the test is required, please document a rationale in the test or file, or at least confirm internally that the file is not strictly required for a backup.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              gheorghe.popescu Gheorghe Popescu
              Reporter:
              garrett.guillotte Garrett Guillotte
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support