cookstyle 5.15.7 → 5.16.10

data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb

@@ -0,0 +1,64 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefDeprecations
+        # Use the :run action in the ruby_block resource instead of the deprecated :create action
+        #
+        # @example
+        #
+        #   # bad
+        #   ruby_block 'my special ruby block' do
+        #     block do
+        #       puts 'running'
+        #     end
+        #     action :create
+        #   end
+        #
+        #   # good
+        #   ruby_block 'my special ruby block' do
+        #     block do
+        #       puts 'running'
+        #     end
+        #     action :run
+        #   end
+        #
+        class RubyBlockCreateAction < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
+              ruby_action.arguments.each do |action|
+                add_offense(action, location: :expression, message: MSG, severity: :refactor) if action.source == ':create'
+              end
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, ':run')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,8 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Don't include the apt default recipe to update apt's package cache when you can
-        # use the apt_update resource built into Chef Infra Client 12.7 and later.
+        # For many users the apt::default cookbook is used only to update apt's package cache. Chef Infra Client 12.7 and later include an apt_update resource which should be used to perform this instead. Keep in mind that some users will want to stick with the apt::default recipe as it also installs packages necessary for using https repositories on Debian systems and manages some configuration files.
         #
         # @example
         #
@@ -31,6 +30,10 @@ module RuboCop
         #   apt_update
         #
         class IncludingAptDefaultRecipe < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.7'
+
           MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'.freeze
 
           def_node_matcher :apt_recipe_usage?, <<-PATTERN

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

@@ -32,6 +32,10 @@ module RuboCop
         #   depends 'sysctl'
         #
         class UnnecessaryDependsChef14 < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
           MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.".freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN

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

@@ -29,6 +29,10 @@ module RuboCop
         #   cron_access 'mike'
         #
         class CronManageResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.4'
+
           MSG = 'The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.'.freeze
 
           def on_send(node)

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

@@ -26,6 +26,10 @@ module RuboCop
         #   depends 'zypper'
         #
         class DependsOnZypperCookbook < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.3'
+
           MSG = "Don't include the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+".freeze
 
           def_node_matcher :zypper_depends?, <<-PATTERN

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

@@ -0,0 +1,66 @@
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefModernize
+        # 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/resource_windows_service.html for additional details on creating services with the windows_service resource.
+        #
+        #   # bad
+        #   execute "Delete chef-client service" do
+        #     command "sc.exe delete chef-client"
+        #     action :run
+        #   end
+        #
+        #   # good
+        #   windows_service 'chef-client' do
+        #     action :delete
+        #   end
+        #
+        class ExecuteScExe < Cop
+          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/resource_windows_service.html for additional details on creating services with the windows_service resource'.freeze
+
+          # non block execute resources
+          def on_send(node)
+            return unless node.method_name == :execute
+
+            # 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
+            if node&.arguments.first&.source&.match?(/^("|')sc.exe/)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          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)
+              if property_data && property_data.match?(/^sc.exe/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+#
+# Copyright:: 2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefModernize
+        # 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.
+        #
+        #   # bad
+        #   execute "sleep 60" do
+        #     command "sleep 60"
+        #     action :run
+        #   end
+        #
+        #   bash 'sleep' do
+        #     user 'root'
+        #     cwd '/tmp'
+        #     code 'sleep 60'
+        #   end
+        #
+        #   # good
+        #   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.'.freeze
+
+          # non block execute resources
+          def on_send(node)
+            return unless node.method_name == :execute
+
+            # 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
+            if node&.arguments.first&.source&.match?(/^("|')sleep/)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          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)
+              if property_data && property_data.match?(/^sleep/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+
+            match_property_in_resource?(:bash, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              if property_data && property_data.match?(/^sleep/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -38,6 +38,9 @@ module RuboCop
         #
         class ExecuteTzUtil < Cop
           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'.freeze
 

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

@@ -0,0 +1,51 @@
+#
+# Copyright:: 2016-2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefModernize
+        # 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
+        #
+        #   # bad
+        #   # ~FC013
+        #
+        class FoodcriticComments < Cop
+          MSG = 'Remove legacy code comments that disable Foodcritic rules'.freeze
+
+          def investigate(processed_source)
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              if comment.text.match?(/#\s*~FC\d{3}.*/)
+                add_offense(comment, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -29,6 +29,10 @@ module RuboCop
         #   end
         #
         class LibarchiveFileResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'.freeze
 
           def on_send(node)

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

@@ -36,6 +36,10 @@ module RuboCop
         #   end
         #
         class MacOsXUserdefaults < Cop
+          extend TargetChefVersion
+
+          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.'.freeze
 
           def on_send(node)

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

@@ -32,6 +32,10 @@ module RuboCop
         #   end
         #
         class OpensslRsaKeyResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
           MSG = 'The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.'.freeze
 
           def on_send(node)

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

@@ -38,6 +38,10 @@ module RuboCop
         #   end
         #
         class OpensslX509Resource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.4'
+
           MSG = 'The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.'.freeze
 
           def on_send(node)

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

@@ -30,6 +30,9 @@ module RuboCop
         #
         class PowershellScriptExpandArchive < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource'.freeze
 

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

@@ -36,6 +36,9 @@ module RuboCop
         class PowerShellGuardInterpreter < Cop
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.0'
 
           MSG = 'PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.'.freeze
 

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

@@ -33,6 +33,9 @@ module RuboCop
         #
         class PowershellInstallPackage < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.16'
 
           MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'.freeze
 

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

@@ -36,6 +36,9 @@ module RuboCop
         #
         class PowershellInstallWindowsFeature < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.0'
 
           MSG = 'Use the windows_feature resource built into Chef Infra Client 13+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'.freeze
 

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

@@ -29,28 +29,26 @@ module RuboCop
         #   property :bob, String, name_property: true
         #
         class PropertyWithNameAttribute < Cop
-          MSG = 'Resource property sets name_attribute not name_property'.freeze
+          MSG = 'Resource property sets name_attribute instead of name_property'.freeze
+
+          # match on a property that has any name and any type and a hash that
+          # contains name_attribute true. The hash pairs are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :property_with_name_attribute?, <<-PATTERN
+            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
+          PATTERN
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if attribute_method_mix?(node)
+            property_with_name_attribute?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
 
           def autocorrect(node)
             lambda do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub('name_attribute', 'name_property'))
-            end
-          end
-
-          private
-
-          def attribute_method_mix?(node)
-            if node.method_name == :property
-              node.arguments.each do |arg|
-                if arg.type == :hash
-                  return true if arg.source.match?(/name_attribute:/)
-                end
+              property_with_name_attribute?(node) do |name_attribute|
+                corrector.replace(name_attribute.loc.expression, 'name_property: true')
               end
-              false # no name_attribute found
             end
           end
         end