AlexCline / puppet-dirtree

A module to provide a dirtree function which returns an array of a directory tree from a path string.

dirtree

This module provides the dirtree function.

The dirtree function accepts a string containing an absolute directory path and will return an array of the tree containing all the directories of that path.

The first parameter can also be an array of absolute directory paths, which will be transformed into an array of all trees containing all directories in the paths.

An optional second parameter can be supplied that contains a path to exclude from the resulting array.

Best efforts have been made to make this function compatible with both Windows and Linux systems.

Examples

dirtree('/usr/share/puppet')
Will return: ['/usr', '/usr/share', '/usr/share/puppet']

dirtree('C:\\windows\\system32\\drivers')
Will return: ["C:\\windows", "C:\\windows\\system32", "C:\\windows\\system32\\drivers"]

dirtree(['/usr/share/puppet', '/var/lib/puppet/ssl', '/var/lib/puppet/modules'])
Will return: ['/usr', '/usr/share', '/usr/share/puppet',
              '/var', '/var/lib', '/var/lib/puppet', '/var/lib/puppet/ssl',
              '/var/lib/puppet/modules']

dirtree('/usr/share/puppet', '/usr')
Will return: ['/usr/share', '/usr/share/puppet']

dirtree('C:\\windows\\system32\\drivers', 'C:\\windows')
Will return: ['C:\\windows\\system32', 'C:\\windows\\system32\\drivers']

You can use the dirtree function in a class to enumerate all required directories if needed.

class dirtree {
  # rubysitedir = /usr/lib/ruby/site_ruby/1.8
  $dirtree = dirtree("/var/lib/puppet/ssl", '/var/lib')

  # $dirtree = ['/usr/lib/puppet', '/var/lib/puppet/ssl']
  ensure_resource('file', $dirtree, {'ensure' => 'directory'})
}

With the puppetlabs-stdlib 1.4.0 module, the ensure_resource function accepts an array, which will create new resources with the names specified if they don't already exist.

Changes

dirtree v0.2.1

• Added the ability to pass an array of paths. Thanks to Ben Ford

dirtree v0.2.0

• Added optional second parameter specifying portion of the path to exclude.

Support

Please file tickets and issues using GitHub Issues

License

Copyright 2013 Alex Cline [e-mail]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.