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

PMT fails to install modules on Windows that have long paths

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • PUP 3.8.2, PUP 4.2.2
    • PMT, Windows

    • Puppet Agent Version: 1.2.1 (Gold)
      Module Version: 0.1.1-b20025-dd8e40f3
      Agent: Windows 2012 R2 x64

    • Bug Fix
    • Hide
      PMT fails on long Windows paths - For modules that install on Windows and use a long hierarchical directory structure, the default TEMP path where PMT extracts the modules tarball can be problematic. Windows has a default maximum path length of 260 characters (MAX_PATH).

      By default, the extracted temp location looks like:
      ~~~
      C:\ProgramData\PuppetLabs\puppet\cache\puppet-module\cache\tmp-unpackerYYYYMMDD-XXXX-xxxxxxx
      ~~~
      The default install location of a puppet 4.0+ module is:
      ~~~
      C:\ProgramData\PuppetLabs\code\environments\production\modules
      ~~~

      In using the Temp directory instead we allow for longer path names in the modules. Instead of using over 90 characters before the module path, we only use around 60, allowing for longer module paths during unpacking.
      Show
      PMT fails on long Windows paths - For modules that install on Windows and use a long hierarchical directory structure, the default TEMP path where PMT extracts the modules tarball can be problematic. Windows has a default maximum path length of 260 characters (MAX_PATH). By default, the extracted temp location looks like: ~~~ C:\ProgramData\PuppetLabs\puppet\cache\puppet-module\cache\tmp-unpackerYYYYMMDD-XXXX-xxxxxxx ~~~ The default install location of a puppet 4.0+ module is: ~~~ C:\ProgramData\PuppetLabs\code\environments\production\modules ~~~ In using the Temp directory instead we allow for longer path names in the modules. Instead of using over 90 characters before the module path, we only use around 60, allowing for longer module paths during unpacking.

    Description

      Description

      If a user attempts to install the DSC module from the Forge the installation will fail:

      Notice: Preparing to install into C:/ProgramData/PuppetLabs/code/environments/production/modules ...
      		 
      Notice: Downloading from https://forgeapi.puppetlabs.com ...
      		 
      Error: No such file or directory @ rb_sysopen - C:/ProgramData/PuppetLabs/puppet/cache/puppet-module/cache/tmp-unpacker20150713-2868-1k8nayj/puppetlabs-dsc-0.1.1-b20025-dd8e40f3/vendor/DSCResources/xRemoteDesktopSessionHost/DSCResources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.schema.mof
      		 
      Error: Try 'puppet help module install' for usage

      Attachments

      • PMT Debug Log

      Repro Steps

      1. Install Puppet Agent 1.2.1 on agent node.
      2. Install "puppetlabs-dsc" module on agent: 

        puppet module install puppetlabs-dsc --module_repository https://api-module-staging.puppetlabs.com

      Expect

      The module should install successfully.

      Actual

      The module installation fails:

      Notice: Preparing to install into C:/ProgramData/PuppetLabs/code/environments/production/modules ...
      		 
      Notice: Downloading from https://forgeapi.puppetlabs.com ...
      		 
      Error: No such file or directory @ rb_sysopen - C:/ProgramData/PuppetLabs/puppet/cache/puppet-module/cache/tmp-unpacker20150713-2868-1k8nayj/puppetlabs-dsc-0.1.1-b20025-dd8e40f3/vendor/DSCResources/xRemoteDesktopSessionHost/DSCResources/MSFT_xRDSessionCollectionConfiguration/MSFT_xRDSessionCollectionConfiguration.schema.mof
      		 
      Error: Try 'puppet help module install' for usage

      Attachments

        Issue Links

          blocks

          Bug - A problem which impairs or prevents the functions of the product. MODULES-2182 DSC - Start PowerShell with similar arguments as puppetlabs-powershell

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

          New Feature - A new feature of the product, which has yet to be developed. MODULES-1960 DSC - Use Invoke-DSCResource instead

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

          Task - A task that needs to be done. MODULES-2236 DSC - Enable Work-a-round for Path Length Issue in Acceptance Tests

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

          Task - A task that needs to be done. MODULES-2408 DSC - Document PMT long file name issue

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

          Task - A task that needs to be done. MODULES-2249 DSC - Remove Work-a-round in Acceptance Testing Pre-suite

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PUP-6152 PMT Should Use Long File Name (LFN) Paths on Windows

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PUP-4866 Plugin Sync Should Use Long File Name (LFN) Paths on Windows

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

          Improvement - An improvement or enhancement to an existing feature or task. PUP-4996 PMT Should use Wide Paths for Windows

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

          Bug - A problem which impairs or prevents the functions of the product. PUP-4884 PMT won't install a module on windows if module_working_dir contains backslashes

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

          Bug - A problem which impairs or prevents the functions of the product. PUP-5994 Puppet module install fails when modules have long path names

          • Major - Major loss of function.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. PUP-10924 `module install` can't unpack modules with long paths because of minitar bug

          • High - Serious problem that could block progress.
          • Closed
          links to

          Web Link Puppet 3.x PR #4090

          Web Link Puppet #4091 - fix acceptance

          Web Link Puppet stable PR #4085

          Web Link puppet-specifications #48 - update module_working_dir location

          Activity

            People

              ryan.gard Ryan Gard
              ryan.gard Ryan Gard
              Ryan Gard Ryan Gard
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Zendesk Support