diff options
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | DOC_CHANGES.md | 19 |
2 files changed, 20 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 73abae07d4..1c8a44b6a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -135,6 +135,7 @@ * Transfer trusted certificates under :trusted_certs_dir during bootstrap. * Set :ssl_verify_mode to :verify_peer by default. * Add homebrew provider for package resource, use it by default on OS X (Issue #1709) +* Add escape_glob method to PathHelper, update glob operations. ## Last Release: 11.14.2 diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md index ad45e4c383..38a8a8c4f6 100644 --- a/DOC_CHANGES.md +++ b/DOC_CHANGES.md @@ -172,3 +172,22 @@ end # the `:immediate` is required for results to be defined. notifies :reboot_now, "reboot[now]", :immediate ``` + +### Escape sensitive characters before globbing +Some paths contain characters reserved by glob and must be escaped so that +glob operations perform as expected. One common example is Windows file paths +separated by `"\\"`. To ensure that your globs work correctly, it is recommended +that you apply `Chef::Util::PathHelper::escape_glob` before globbing file paths. + +```ruby +path = "C:\\Users\\me\\chef-repo\\cookbooks" +Dir.exist?(path) # true +Dir.entries(path) # [".", "..", "apache2", "apt", ...] + +Dir.glob(File.join(path, "*")) # [] +Dir[File.join(path, "*")] # [] + +PathHelper = Chef::Util::PathHelper +Dir.glob(File.join(PathHelper.escape_glob(path), "*")) # ["#{path}\\apache2", "#{path}\\apt", ...] +Dir[PathHelper.escape_glob(path) + "/*"] # ["#{path}\\apache2", "#{path}\\apt", ...] +``` |