chef 12.8.1 → 12.9.38

data/lib/chef/util/editor.rb

@@ -1,91 +1,91 @@
-#
-# Author:: Chris Bandy (<bandy.chris@gmail.com>)
-# Copyright:: Copyright 2014-2016, Chef Software Inc.
-# 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.
-#
-
-class Chef
-  class Util
-    class Editor
-      attr_reader :lines
-
-      def initialize(lines)
-        @lines = lines.to_a.clone
-      end
-
-      def append_line_after(search, line_to_append)
-        lines = []
-
-        @lines.each do |line|
-          lines << line
-          lines << line_to_append if line.match(search)
-        end
-
-        (lines.length - @lines.length).tap { @lines = lines }
-      end
-
-      def append_line_if_missing(search, line_to_append)
-        count = 0
-
-        unless @lines.find { |line| line.match(search) }
-          count = 1
-          @lines << line_to_append
-        end
-
-        count
-      end
-
-      def remove_lines(search)
-        count = 0
-
-        @lines.delete_if do |line|
-          count += 1 if line.match(search)
-        end
-
-        count
-      end
-
-      def replace(search, replace)
-        count = 0
-
-        @lines.map! do |line|
-          if line.match(search)
-            count += 1
-            line.gsub!(search, replace)
-          else
-            line
-          end
-        end
-
-        count
-      end
-
-      def replace_lines(search, replace)
-        count = 0
-
-        @lines.map! do |line|
-          if line.match(search)
-            count += 1
-            replace
-          else
-            line
-          end
-        end
-
-        count
-      end
-    end
-  end
-end
+#
+# Author:: Chris Bandy (<bandy.chris@gmail.com>)
+# Copyright:: Copyright 2014-2016, Chef Software Inc.
+# 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.
+#
+
+class Chef
+  class Util
+    class Editor
+      attr_reader :lines
+
+      def initialize(lines)
+        @lines = lines.to_a.clone
+      end
+
+      def append_line_after(search, line_to_append)
+        lines = []
+
+        @lines.each do |line|
+          lines << line
+          lines << line_to_append if line.match(search)
+        end
+
+        (lines.length - @lines.length).tap { @lines = lines }
+      end
+
+      def append_line_if_missing(search, line_to_append)
+        count = 0
+
+        unless @lines.find { |line| line.match(search) }
+          count = 1
+          @lines << line_to_append
+        end
+
+        count
+      end
+
+      def remove_lines(search)
+        count = 0
+
+        @lines.delete_if do |line|
+          count += 1 if line.match(search)
+        end
+
+        count
+      end
+
+      def replace(search, replace)
+        count = 0
+
+        @lines.map! do |line|
+          if line.match(search)
+            count += 1
+            line.gsub!(search, replace)
+          else
+            line
+          end
+        end
+
+        count
+      end
+
+      def replace_lines(search, replace)
+        count = 0
+
+        @lines.map! do |line|
+          if line.match(search)
+            count += 1
+            replace
+          else
+            line
+          end
+        end
+
+        count
+      end
+    end
+  end
+end

data/lib/chef/util/file_edit.rb

@@ -1,100 +1,100 @@
-#
-# Author:: Nuo Yan (<nuo@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
-# 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 "chef/util/editor"
-require "fileutils"
-
-class Chef
-  class Util
-    class FileEdit
-
-      private
-
-      attr_reader :editor, :original_pathname
-
-      public
-
-      def initialize(filepath)
-        raise ArgumentError, "File '#{filepath}' does not exist" unless File.exist?(filepath)
-        @editor = Editor.new(File.open(filepath, &:readlines))
-        @original_pathname = filepath
-        @file_edited = false
-      end
-
-      # return if file has been edited
-      def file_edited?
-        @file_edited
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if matched, replace the whole line with newline.
-      def search_file_replace_line(regex, newline)
-        @changes = (editor.replace_lines(regex, newline) > 0) || @changes
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if matched, replace the match (all occurrences)  with the replace parameter
-      def search_file_replace(regex, replace)
-        @changes = (editor.replace(regex, replace) > 0) || @changes
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if matched, delete the line
-      def search_file_delete_line(regex)
-        @changes = (editor.remove_lines(regex) > 0) || @changes
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if matched, delete the match (all occurrences) from the line
-      def search_file_delete(regex)
-        search_file_replace(regex, "")
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if matched, insert newline after each matching line
-      def insert_line_after_match(regex, newline)
-        @changes = (editor.append_line_after(regex, newline) > 0) || @changes
-      end
-
-      #search the file line by line and match each line with the given regex
-      #if not matched, insert newline at the end of the file
-      def insert_line_if_no_match(regex, newline)
-        @changes = (editor.append_line_if_missing(regex, newline) > 0) || @changes
-      end
-
-      def unwritten_changes?
-        !!@changes
-      end
-
-      #Make a copy of old_file and write new file out (only if file changed)
-      def write_file
-        if @changes
-          backup_pathname = original_pathname + ".old"
-          FileUtils.cp(original_pathname, backup_pathname, :preserve => true)
-          File.open(original_pathname, "w") do |newfile|
-            editor.lines.each do |line|
-              newfile.puts(line)
-            end
-            newfile.flush
-          end
-          @file_edited = true
-        end
-        @changes = false
-      end
-    end
-  end
-end
+#
+# Author:: Nuo Yan (<nuo@chef.io>)
+# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# 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 "chef/util/editor"
+require "fileutils"
+
+class Chef
+  class Util
+    class FileEdit
+
+      private
+
+      attr_reader :editor, :original_pathname
+
+      public
+
+      def initialize(filepath)
+        raise ArgumentError, "File '#{filepath}' does not exist" unless File.exist?(filepath)
+        @editor = Editor.new(File.open(filepath, &:readlines))
+        @original_pathname = filepath
+        @file_edited = false
+      end
+
+      # return if file has been edited
+      def file_edited?
+        @file_edited
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if matched, replace the whole line with newline.
+      def search_file_replace_line(regex, newline)
+        @changes = (editor.replace_lines(regex, newline) > 0) || @changes
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if matched, replace the match (all occurrences)  with the replace parameter
+      def search_file_replace(regex, replace)
+        @changes = (editor.replace(regex, replace) > 0) || @changes
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if matched, delete the line
+      def search_file_delete_line(regex)
+        @changes = (editor.remove_lines(regex) > 0) || @changes
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if matched, delete the match (all occurrences) from the line
+      def search_file_delete(regex)
+        search_file_replace(regex, "")
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if matched, insert newline after each matching line
+      def insert_line_after_match(regex, newline)
+        @changes = (editor.append_line_after(regex, newline) > 0) || @changes
+      end
+
+      #search the file line by line and match each line with the given regex
+      #if not matched, insert newline at the end of the file
+      def insert_line_if_no_match(regex, newline)
+        @changes = (editor.append_line_if_missing(regex, newline) > 0) || @changes
+      end
+
+      def unwritten_changes?
+        !!@changes
+      end
+
+      #Make a copy of old_file and write new file out (only if file changed)
+      def write_file
+        if @changes
+          backup_pathname = original_pathname + ".old"
+          FileUtils.cp(original_pathname, backup_pathname, :preserve => true)
+          File.open(original_pathname, "w") do |newfile|
+            editor.lines.each do |line|
+              newfile.puts(line)
+            end
+            newfile.flush
+          end
+          @file_edited = true
+        end
+        @changes = false
+      end
+    end
+  end
+end

data/lib/chef/util/path_helper.rb

@@ -1,25 +1,25 @@
-#
-# Author:: Bryan McLellan <btm@loftninjas.org>
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
-# 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 "chef-config/path_helper"
-
-class Chef
-  class Util
-    PathHelper = ChefConfig::PathHelper
-  end
-end
+#
+# Author:: Bryan McLellan <btm@loftninjas.org>
+# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+# 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 "chef-config/path_helper"
+
+class Chef
+  class Util
+    PathHelper = ChefConfig::PathHelper
+  end
+end

data/lib/chef/util/powershell/cmdlet.rb

@@ -1,170 +1,170 @@
-#
-# Author:: Adam Edwards (<adamed@chef.io>)
-#
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
-#
-# 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 "mixlib/shellout"
-require "chef/mixin/windows_architecture_helper"
-require "chef/util/powershell/cmdlet_result"
-
-class Chef
-  class Util
-    class Powershell
-      class Cmdlet
-        def initialize(node, cmdlet, output_format = nil, output_format_options = {})
-          @output_format = output_format
-          @node = node
-
-          case output_format
-          when nil
-            @json_format = false
-          when :json
-            @json_format = true
-          when :text
-            @json_format = false
-          when :object
-            @json_format = true
-          else
-            raise ArgumentError, "Invalid output format #{output_format} specified"
-          end
-
-          @cmdlet = cmdlet
-          @output_format_options = output_format_options
-        end
-
-        attr_reader :output_format
-
-        def run(switches = {}, execution_options = {}, *arguments)
-          streams = { :json => CmdletStream.new("json"),
-                      :verbose => CmdletStream.new("verbose"),
-                    }
-
-          arguments_string = arguments.join(" ")
-
-          switches_string = command_switches_string(switches)
-
-          json_depth = 5
-
-          if @json_format && @output_format_options.has_key?(:depth)
-            json_depth = @output_format_options[:depth]
-          end
-
-          json_command = @json_format ? " | convertto-json -compress -depth #{json_depth} "\
-                                        "> #{streams[:json].path}" : ""
-          redirections = "4> '#{streams[:verbose].path}'"
-          command_string = "powershell.exe -executionpolicy bypass -noprofile -noninteractive "\
-                           "-command \"trap [Exception] {write-error -exception "\
-                           "($_.Exception.Message);exit 1};#{@cmdlet} #{switches_string} "\
-                           "#{arguments_string} #{redirections}"\
-                           "#{json_command}\";if ( ! $? ) { exit 1 }"
-
-          augmented_options = { :returns => [0], :live_stream => false }.merge(execution_options)
-          command = Mixlib::ShellOut.new(command_string, augmented_options)
-
-          status = nil
-
-          with_os_architecture(@node) do
-            status = command.run_command
-          end
-
-          CmdletResult.new(status, streams, @output_format)
-        end
-
-        def run!(switches = {}, execution_options = {}, *arguments)
-          result = run(switches, execution_options, arguments)
-
-          if ! result.succeeded?
-            raise Chef::Exceptions::PowershellCmdletException, "Powershell Cmdlet failed: #{result.stderr}"
-          end
-
-          result
-        end
-
-        protected
-
-        include Chef::Mixin::WindowsArchitectureHelper
-
-        def validate_switch_name!(switch_parameter_name)
-          if !!(switch_parameter_name =~ /\A[A-Za-z]+[_a-zA-Z0-9]*\Z/) == false
-            raise ArgumentError, "`#{switch_parameter_name}` is not a valid PowerShell cmdlet switch parameter name"
-          end
-        end
-
-        def escape_parameter_value(parameter_value)
-          parameter_value.gsub(/(`|'|"|#)/, '`\1')
-        end
-
-        def escape_string_parameter_value(parameter_value)
-          "'#{escape_parameter_value(parameter_value)}'"
-        end
-
-        def command_switches_string(switches)
-          command_switches = switches.map do |switch_name, switch_value|
-            if switch_name.class != Symbol
-              raise ArgumentError, "Invalid type `#{switch_name} `for PowerShell switch '#{switch_name}'. The switch must be specified as a Symbol'"
-            end
-
-            validate_switch_name!(switch_name)
-
-            switch_argument = ""
-            switch_present = true
-
-            case switch_value
-            when Numeric
-              switch_argument = switch_value.to_s
-            when Float
-              switch_argument = switch_value.to_s
-            when FalseClass
-              switch_present = false
-            when TrueClass
-            when String
-              switch_argument = escape_string_parameter_value(switch_value)
-            else
-              raise ArgumentError, "Invalid argument type `#{switch_value.class}` specified for PowerShell switch `:#{switch_name}`. Arguments to PowerShell must be of type `String`, `Numeric`, `Float`, `FalseClass`, or `TrueClass`"
-            end
-
-            switch_present ? ["-#{switch_name.to_s.downcase}", switch_argument].join(" ").strip : ""
-          end
-
-          command_switches.join(" ")
-        end
-
-        class CmdletStream
-          def initialize(name)
-            @filename = Dir::Tmpname.create(name) {}
-            ObjectSpace.define_finalizer(self, self.class.destroy(@filename))
-          end
-
-          def path
-            @filename
-          end
-
-          def read
-            if File.exist? @filename
-              File.open(@filename, "rb:bom|UTF-16LE") do |f|
-                f.read.encode("UTF-8")
-              end
-            end
-          end
-
-          def self.destroy(name)
-            proc { File.delete(name) if File.exists? name }
-          end
-        end
-      end
-    end
-  end
-end
+#
+# Author:: Adam Edwards (<adamed@chef.io>)
+#
+# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+#
+# 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 "mixlib/shellout"
+require "chef/mixin/windows_architecture_helper"
+require "chef/util/powershell/cmdlet_result"
+
+class Chef
+  class Util
+    class Powershell
+      class Cmdlet
+        def initialize(node, cmdlet, output_format = nil, output_format_options = {})
+          @output_format = output_format
+          @node = node
+
+          case output_format
+          when nil
+            @json_format = false
+          when :json
+            @json_format = true
+          when :text
+            @json_format = false
+          when :object
+            @json_format = true
+          else
+            raise ArgumentError, "Invalid output format #{output_format} specified"
+          end
+
+          @cmdlet = cmdlet
+          @output_format_options = output_format_options
+        end
+
+        attr_reader :output_format
+
+        def run(switches = {}, execution_options = {}, *arguments)
+          streams = { :json => CmdletStream.new("json"),
+                      :verbose => CmdletStream.new("verbose"),
+                    }
+
+          arguments_string = arguments.join(" ")
+
+          switches_string = command_switches_string(switches)
+
+          json_depth = 5
+
+          if @json_format && @output_format_options.has_key?(:depth)
+            json_depth = @output_format_options[:depth]
+          end
+
+          json_command = @json_format ? " | convertto-json -compress -depth #{json_depth} "\
+                                        "> #{streams[:json].path}" : ""
+          redirections = "4> '#{streams[:verbose].path}'"
+          command_string = "powershell.exe -executionpolicy bypass -noprofile -noninteractive "\
+                           "-command \"trap [Exception] {write-error -exception "\
+                           "($_.Exception.Message);exit 1};#{@cmdlet} #{switches_string} "\
+                           "#{arguments_string} #{redirections}"\
+                           "#{json_command}\";if ( ! $? ) { exit 1 }"
+
+          augmented_options = { :returns => [0], :live_stream => false }.merge(execution_options)
+          command = Mixlib::ShellOut.new(command_string, augmented_options)
+
+          status = nil
+
+          with_os_architecture(@node) do
+            status = command.run_command
+          end
+
+          CmdletResult.new(status, streams, @output_format)
+        end
+
+        def run!(switches = {}, execution_options = {}, *arguments)
+          result = run(switches, execution_options, arguments)
+
+          if ! result.succeeded?
+            raise Chef::Exceptions::PowershellCmdletException, "Powershell Cmdlet failed: #{result.stderr}"
+          end
+
+          result
+        end
+
+        protected
+
+        include Chef::Mixin::WindowsArchitectureHelper
+
+        def validate_switch_name!(switch_parameter_name)
+          if !!(switch_parameter_name =~ /\A[A-Za-z]+[_a-zA-Z0-9]*\Z/) == false
+            raise ArgumentError, "`#{switch_parameter_name}` is not a valid PowerShell cmdlet switch parameter name"
+          end
+        end
+
+        def escape_parameter_value(parameter_value)
+          parameter_value.gsub(/(`|'|"|#)/, '`\1')
+        end
+
+        def escape_string_parameter_value(parameter_value)
+          "'#{escape_parameter_value(parameter_value)}'"
+        end
+
+        def command_switches_string(switches)
+          command_switches = switches.map do |switch_name, switch_value|
+            if switch_name.class != Symbol
+              raise ArgumentError, "Invalid type `#{switch_name} `for PowerShell switch '#{switch_name}'. The switch must be specified as a Symbol'"
+            end
+
+            validate_switch_name!(switch_name)
+
+            switch_argument = ""
+            switch_present = true
+
+            case switch_value
+            when Numeric
+              switch_argument = switch_value.to_s
+            when Float
+              switch_argument = switch_value.to_s
+            when FalseClass
+              switch_present = false
+            when TrueClass
+            when String
+              switch_argument = escape_string_parameter_value(switch_value)
+            else
+              raise ArgumentError, "Invalid argument type `#{switch_value.class}` specified for PowerShell switch `:#{switch_name}`. Arguments to PowerShell must be of type `String`, `Numeric`, `Float`, `FalseClass`, or `TrueClass`"
+            end
+
+            switch_present ? ["-#{switch_name.to_s.downcase}", switch_argument].join(" ").strip : ""
+          end
+
+          command_switches.join(" ")
+        end
+
+        class CmdletStream
+          def initialize(name)
+            @filename = Dir::Tmpname.create(name) {}
+            ObjectSpace.define_finalizer(self, self.class.destroy(@filename))
+          end
+
+          def path
+            @filename
+          end
+
+          def read
+            if File.exist? @filename
+              File.open(@filename, "rb:bom|UTF-16LE") do |f|
+                f.read.encode("UTF-8")
+              end
+            end
+          end
+
+          def self.destroy(name)
+            proc { File.delete(name) if File.exists? name }
+          end
+        end
+      end
+    end
+  end
+end