Uploaded image for project: 'Puppet Development Kit'
  1. Puppet Development Kit
  2. PDK-1587

PDK validate/build should reject for unprintable characters in filenames

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PDK 1.16.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Release Notes:
      Enhancement
    • Release Notes Summary:
      `pdk module build` will now reject files that contain non-ASCII characters in their name in order to ensure that the module is compatible with all puppet masters regardless of their locale.
    • QA Risk Assessment:
      Needs Assessment

      Description

      PE LTS 2018.1 (and maybe others?) choke on unprintable chars in filenames in installed modules:

      2020-01-09T02:25:31.353Z ERROR [clojure-agent-send-off-pool-16] [p.e.s.f.file-sync-storage-core] Fatal error during file sync commit, requesting shutdown.
      java.nio.file.InvalidPathException: Malformed input or input contains unmappable characters: /etc/puppetlabs/code-staging/environments/production/modules/postgresql/REFERENCE.md???
      

      This was reported on slack by Laura Macchi. See https://github.com/puppetlabs/puppetlabs-postgresql/pull/1108 for details on this particular instance.

      The PDK should not allow building a module with such files in it, and could already reject those files on validate, so that a CI run detects it.

        Attachments

          Activity

            People

            Assignee:
            tim.sharpe Tim Sharpe
            Reporter:
            david.schmitt David Schmitt
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support