cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute "Delete chef-client service" do
+        #     command "sc.exe delete chef-client"
+        #     action :run
+        #   end
+        #
+        #   ### correct
+        #   windows_service 'chef-client' do
+        #     action :delete
+        #   end
+        #
+        class ExecuteScExe < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          # non block execute resources
+          def on_send(node)
+            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            return unless node&.arguments.first&.source&.match?(/^("|')sc.exe/)
+
+            add_offense(node, severity: :refactor)
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^sc.exe/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/execute_sleep.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute "sleep 60" do
+        #     command "sleep 60"
+        #     action :run
+        #   end
+        #
+        #   bash 'sleep' do
+        #     user 'root'
+        #     cwd '/tmp'
+        #     code 'sleep 60'
+        #   end
+        #
+        #   ### correct
+        #   chef_sleep '60'
+        #
+        class ExecuteSleep < Cop
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.5'
+
+          MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          # non block execute resources
+          def on_send(node)
+            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            return unless node&.arguments.first&.source&.match?(/^("|')sleep/)
+            add_offense(node, severity: :refactor)
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:bash, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   file '/etc/sysctl.d/ipv4.conf' do
+        #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
+        #     content '9000 65500'
+        #   end
+        #
+        #   execute 'sysctl -p /etc/sysctl.d/ipv4.conf' do
+        #     action :nothing
+        #   end
+        #
+        #   ### correct
+        #   sysctl 'net.ipv4.ip_local_port_range' do
+        #     value '9000 65500'
+        #   end
+        #
+        class ExecuteSysctl < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          # non block execute resources
+          def on_send(node)
+            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            return unless node&.arguments.first&.source&.match?(/^("|')sysctl -p/)
+            add_offense(node, severity: :refactor)
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(%r{^(/sbin/)?sysctl -p}i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Instead of using the execute or powershell_script resources to run the `tzutil` command, use Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'set tz' do
+        #     command 'tzutil.exe /s UTC'
+        #   end
+        #
+        #   execute 'tzutil /s UTC'
+        #
+        #   powershell_script 'set windows timezone' do
+        #     code "tzutil.exe /s UTC"
+        #     not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') }
+        #   end
+        #
+        #   ### correct
+        #   timezone 'UTC'
+        #
+        class ExecuteTzUtil < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.6'
+
+          MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          def_node_matcher :execute_resource?, <<-PATTERN
+            (send nil? :execute $str)
+          PATTERN
+
+          def on_send(node)
+            execute_resource?(node) do
+              return unless node.arguments.first.value.match?(/^tzutil/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              next unless calls_tzutil?(code_property)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              next unless calls_tzutil?(code_property)
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          private
+
+          def calls_tzutil?(ast_obj)
+            property_data = method_arg_ast_to_string(ast_obj)
+            return true if property_data && property_data.match?(/^tzutil/i)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2016-2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   # ~FC013
+        #
+        class FoodcriticComments < Base
+          extend AutoCorrector
+
+          MSG = 'Remove legacy code comments that disable Foodcritic rules'
+
+          def on_new_investigation
+            processed_source.comments.each do |comment|
+              next unless comment.text.match?(/#\s*~FC\d{3}.*/)
+              add_offense(comment, severity: :refactor) do |corrector|
+                corrector.remove(comment)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   default_action :foo if defined?(default_action)
+        #
+        #   ### correct
+        #   default_action :foo
+        #
+        class IfProvidesDefaultAction < Base
+          extend AutoCorrector
+
+          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'
+
+          def on_defined?(node)
+            return unless node.arguments.first == s(:send, nil, :default_action)
+            node = node.parent if node.parent.respond_to?(:if?) && node.parent.if? # we want the whole if statement
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.children[1].source)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chef/mixin/shell_out'
+        #   include Chef::Mixin::ShellOut
+        #   require 'chef/mixin/powershell_out'
+        #   include Chef::Mixin::PowershellOut
+        #
+        class IncludingMixinShelloutInResources < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'
+          RESTRICT_ON_SEND = [:include, :require].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+            (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+            (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
+          PATTERN
+
+          def_node_search :hwrp_classes?, <<-PATTERN
+            (class
+              (const ... )
+              {(const
+                (const
+                  (const nil? :Chef) :Provider) :LWRPBase)
+               (const
+                 (const nil? :Chef) :Provider)
+               }
+              ...)
+          PATTERN
+
+          def check_for_offenses(node)
+            containing_dir = File.basename(File.dirname(processed_source.path))
+
+            # only add offenses when we're in a custom resource or HWRP, but not a plain old library
+            if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def on_send(node)
+            require_shellout?(node) do
+              check_for_offenses(node)
+            end
+
+            include_shellout?(node) do
+              check_for_offenses(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/libarchive_file.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource from the libarchive cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'libarchive'
+        #
+        #   libarchive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        #   ### correct
+        #   archive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class LibarchiveFileResource < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource from the libarchive cookbook'
+          RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
+
+          def_node_matcher :notification_property?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
+          PATTERN
+
+          def on_send(node)
+            # The need for this goes away once https://github.com/rubocop-hq/rubocop/pull/8365 is pulled into Cookstyle
+            if node.method?(:libarchive_file)
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
+              end
+            end
+
+            notification_property?(node) do |val|
+              next unless val.str_content&.start_with?('libarchive_file')
+              add_offense(val, severity: :refactor) do |corrector|
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   mac_os_x_userdefaults 'full keyboard access to all controls' do
+        #     domain 'AppleKeyboardUIMode'
+        #     global true
+        #     value '2'
+        #   end
+        #
+        #   ### correct
+        #   macos_userdefaults 'full keyboard access to all controls' do
+        #     domain 'AppleKeyboardUIMode'
+        #     global true
+        #     value '2'
+        #   end
+        #
+        class MacOsXUserdefaults < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:mac_os_x_userdefaults].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'minitest-handler'
+        #
+        class MinitestHandlerUsage < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :minitest_depends?, <<-PATTERN
+            (send nil? :depends (str "minitest-handler"))
+          PATTERN
+
+          def on_send(node)
+            minitest_depends?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end