knife 18.0.185 → 18.1.0

data/lib/chef/knife/diff.rb

@@ -1,83 +1,83 @@
-#
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../chef_fs/knife"
-
-class Chef
-  class Knife
-    class Diff < Chef::ChefFS::Knife
-      banner "knife diff PATTERNS"
-
-      category "path-based"
-
-      deps do
-        require "chef/chef_fs/command_line" unless defined?(Chef::ChefFS::CommandLine)
-      end
-
-      option :recurse,
-        long: "--[no-]recurse",
-        boolean: true,
-        default: true,
-        description: "List directories recursively."
-
-      option :name_only,
-        long: "--name-only",
-        boolean: true,
-        description: "Only show names of modified files."
-
-      option :name_status,
-        long: "--name-status",
-        boolean: true,
-        description: "Only show names and statuses of modified files: Added, Deleted, Modified, and Type Changed."
-
-      option :diff_filter,
-        long: "--diff-filter=[(A|D|M|T)...[*]]",
-        description: "Select only files that are Added (A), Deleted (D), Modified (M), or have their type (i.e. regular file, directory) changed (T). Any combination of the filter characters (including none) can be used. When * (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected."
-
-      option :cookbook_version,
-        long: "--cookbook-version VERSION",
-        description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)."
-
-      def run
-        if config[:name_only]
-          output_mode = :name_only
-        end
-        if config[:name_status]
-          output_mode = :name_status
-        end
-        patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
-
-        # Get the matches (recursively)
-        error = false
-        begin
-          patterns.each do |pattern|
-            found_error = Chef::ChefFS::CommandLine.diff_print(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, output_mode, proc { |entry| format_path(entry) }, config[:diff_filter], ui ) do |diff|
-              stdout.print diff
-            end
-            error = true if found_error
-          end
-        rescue Chef::ChefFS::FileSystem::OperationFailedError => e
-          ui.error "Failed on #{format_path(e.entry)} in #{e.operation}: #{e.message}"
-          error = true
-        end
-
-        if error
-          exit 1
-        end
-      end
-    end
-  end
-end
+#
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../chef_fs/knife"
+
+class Chef
+  class Knife
+    class Diff < Chef::ChefFS::Knife
+      banner "knife diff PATTERNS"
+
+      category "path-based"
+
+      deps do
+        require "chef/chef_fs/command_line" unless defined?(Chef::ChefFS::CommandLine)
+      end
+
+      option :recurse,
+        long: "--[no-]recurse",
+        boolean: true,
+        default: true,
+        description: "List directories recursively."
+
+      option :name_only,
+        long: "--name-only",
+        boolean: true,
+        description: "Only show names of modified files."
+
+      option :name_status,
+        long: "--name-status",
+        boolean: true,
+        description: "Only show names and statuses of modified files: Added, Deleted, Modified, and Type Changed."
+
+      option :diff_filter,
+        long: "--diff-filter=[(A|D|M|T)...[*]]",
+        description: "Select only files that are Added (A), Deleted (D), Modified (M), or have their type (i.e. regular file, directory) changed (T). Any combination of the filter characters (including none) can be used. When * (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected."
+
+      option :cookbook_version,
+        long: "--cookbook-version VERSION",
+        description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)."
+
+      def run
+        if config[:name_only]
+          output_mode = :name_only
+        end
+        if config[:name_status]
+          output_mode = :name_status
+        end
+        patterns = pattern_args_from(name_args.length > 0 ? name_args : [ "" ])
+
+        # Get the matches (recursively)
+        error = false
+        begin
+          patterns.each do |pattern|
+            found_error = Chef::ChefFS::CommandLine.diff_print(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, output_mode, proc { |entry| format_path(entry) }, config[:diff_filter], ui ) do |diff|
+              stdout.print diff
+            end
+            error = true if found_error
+          end
+        rescue Chef::ChefFS::FileSystem::OperationFailedError => e
+          ui.error "Failed on #{format_path(e.entry)} in #{e.operation}: #{e.message}"
+          error = true
+        end
+
+        if error
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/download.rb

@@ -1,84 +1,85 @@
-#
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../chef_fs/knife"
-
-class Chef
-  class Knife
-    class Download < Chef::ChefFS::Knife
-      banner "knife download PATTERNS"
-
-      category "path-based"
-
-      deps do
-        require "chef/chef_fs/command_line" unless defined?(Chef::ChefFS::CommandLine)
-      end
-
-      option :recurse,
-        long: "--[no-]recurse",
-        boolean: true,
-        default: true,
-        description: "List directories recursively."
-
-      option :purge,
-        long: "--[no-]purge",
-        boolean: true,
-        default: false,
-        description: "Delete matching local files and directories that do not exist remotely."
-
-      option :force,
-        long: "--[no-]force",
-        boolean: true,
-        default: false,
-        description: "Force download of files even if they match (quicker and harmless, but doesn't print out what it changed)."
-
-      option :dry_run,
-        long: "--dry-run",
-        short: "-n",
-        boolean: true,
-        default: false,
-        description: "Don't take action, only print what would happen."
-
-      option :diff,
-        long: "--[no-]diff",
-        boolean: true,
-        default: true,
-        description: "Turn off to avoid downloading existing files; only new (and possibly deleted) files with --no-diff."
-
-      option :cookbook_version,
-        long: "--cookbook-version VERSION",
-        description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)."
-
-      def run
-        if name_args.length == 0
-          show_usage
-          ui.fatal("You must specify at least one argument. If you want to download everything in this directory, run \"knife download .\"")
-          exit 1
-        end
-
-        error = false
-        pattern_args.each do |pattern|
-          if Chef::ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config, ui, proc { |entry| format_path(entry) })
-            error = true
-          end
-        end
-        if error
-          exit 1
-        end
-      end
-    end
-  end
-end
+#
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../chef_fs/knife"
+
+class Chef
+  class Knife
+    class Download < Chef::ChefFS::Knife
+      banner "knife download PATTERNS"
+
+      category "path-based"
+
+      deps do
+        require "chef/chef_fs/command_line" unless defined?(Chef::ChefFS::CommandLine)
+      end
+
+      option :recurse,
+        long: "--[no-]recurse",
+        boolean: true,
+        default: true,
+        description: "List directories recursively."
+
+      option :purge,
+        long: "--[no-]purge",
+        boolean: true,
+        default: false,
+        description: "Delete matching local files and directories that do not exist remotely."
+
+      option :force,
+        long: "--[no-]force",
+        boolean: true,
+        default: false,
+        description: "Force download of files even if they match (quicker and harmless, but doesn't print out what it changed)."
+
+      option :dry_run,
+        long: "--dry-run",
+        short: "-n",
+        boolean: true,
+        default: false,
+        description: "Don't take action, only print what would happen."
+
+      option :diff,
+        long: "--[no-]diff",
+        boolean: true,
+        default: true,
+        description: "Turn off to avoid downloading existing files; only new (and possibly deleted) files with --no-diff."
+
+      option :cookbook_version,
+        long: "--cookbook-version VERSION",
+        description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)."
+
+      def run
+        if name_args.length == 0
+          show_usage
+          ui.fatal("You must specify at least one argument. If you want to download everything in this directory, run \"knife download .\"")
+          exit 1
+        end
+
+        error = false
+        pattern_args.each do |pattern|
+          fs_error, result = Chef::ChefFS::FileSystem.copy_to(pattern, chef_fs, local_fs, config[:recurse] ? nil : 1, config, ui, proc { |entry| format_path(entry) })
+          if fs_error
+            error = true
+          end
+        end
+        if error
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/edit.rb

@@ -1,88 +1,88 @@
-#
-# License:: Apache License, Version 2.0
-#
-# 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.
-#
-
-require_relative "../chef_fs/knife"
-
-class Chef
-  class Knife
-    class Edit < Chef::ChefFS::Knife
-      banner "knife edit [PATTERN1 ... PATTERNn]"
-
-      category "path-based"
-
-      deps do
-        require "chef/chef_fs/file_system" unless defined?(Chef::ChefFS::FileSystem)
-        require "chef/chef_fs/file_system/exceptions" unless defined?(Chef::ChefFS::FileSystem::Exceptions)
-      end
-
-      option :local,
-        long: "--local",
-        boolean: true,
-        description: "Show local files instead of remote."
-
-      def run
-        # Get the matches (recursively)
-        error = false
-        pattern_args.each do |pattern|
-          Chef::ChefFS::FileSystem.list(config[:local] ? local_fs : chef_fs, pattern).each do |result|
-            if result.dir?
-              ui.error "#{format_path(result)}: is a directory" if pattern.exact_path
-              error = true
-            else
-              begin
-                new_value = edit_text(result.read, File.extname(result.name))
-                if new_value
-                  result.write(new_value)
-                  output "Updated #{format_path(result)}"
-                else
-                  output "#{format_path(result)} unchanged"
-                end
-              rescue Chef::ChefFS::FileSystem::OperationNotAllowedError => e
-                ui.error "#{format_path(e.entry)}: #{e.reason}."
-                error = true
-              rescue Chef::ChefFS::FileSystem::NotFoundError => e
-                ui.error "#{format_path(e.entry)}: No such file or directory"
-                error = true
-              end
-            end
-          end
-        end
-        if error
-          exit 1
-        end
-      end
-
-      def edit_text(text, extension)
-        unless config[:disable_editing]
-          Tempfile.open([ "knife-edit-", extension ]) do |file|
-            # Write the text to a temporary file
-            file.write(text)
-            file.close
-
-            # Let the user edit the temporary file
-            unless system("#{config[:editor]} #{file.path}")
-              raise "Please set EDITOR environment variable. See https://docs.chef.io/workstation/knife_setup/#setting-your-text-editor for details."
-            end
-
-            result_text = IO.read(file.path)
-
-            return result_text if result_text != text
-          end
-        end
-      end
-    end
-  end
-end
+#
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require_relative "../chef_fs/knife"
+
+class Chef
+  class Knife
+    class Edit < Chef::ChefFS::Knife
+      banner "knife edit [PATTERN1 ... PATTERNn]"
+
+      category "path-based"
+
+      deps do
+        require "chef/chef_fs/file_system" unless defined?(Chef::ChefFS::FileSystem)
+        require "chef/chef_fs/file_system/exceptions" unless defined?(Chef::ChefFS::FileSystem::Exceptions)
+      end
+
+      option :local,
+        long: "--local",
+        boolean: true,
+        description: "Show local files instead of remote."
+
+      def run
+        # Get the matches (recursively)
+        error = false
+        pattern_args.each do |pattern|
+          Chef::ChefFS::FileSystem.list(config[:local] ? local_fs : chef_fs, pattern).each do |result|
+            if result.dir?
+              ui.error "#{format_path(result)}: is a directory" if pattern.exact_path
+              error = true
+            else
+              begin
+                new_value = edit_text(result.read, File.extname(result.name))
+                if new_value
+                  result.write(new_value)
+                  output "Updated #{format_path(result)}"
+                else
+                  output "#{format_path(result)} unchanged"
+                end
+              rescue Chef::ChefFS::FileSystem::OperationNotAllowedError => e
+                ui.error "#{format_path(e.entry)}: #{e.reason}."
+                error = true
+              rescue Chef::ChefFS::FileSystem::NotFoundError => e
+                ui.error "#{format_path(e.entry)}: No such file or directory"
+                error = true
+              end
+            end
+          end
+        end
+        if error
+          exit 1
+        end
+      end
+
+      def edit_text(text, extension)
+        unless config[:disable_editing]
+          Tempfile.open([ "knife-edit-", extension ]) do |file|
+            # Write the text to a temporary file
+            file.write(text)
+            file.close
+
+            # Let the user edit the temporary file
+            unless system("#{config[:editor]} #{file.path}")
+              raise "Please set EDITOR environment variable. See https://docs.chef.io/workstation/knife_setup/#setting-your-text-editor for details."
+            end
+
+            result_text = IO.read(file.path)
+
+            return result_text if result_text != text
+          end
+        end
+      end
+    end
+  end
+end