cookstyle 5.4.13 → 5.5.7

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

@@ -0,0 +1,54 @@
+#
+# 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
+        # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
+        # methods in Chef 11 and early versions of Chef 12.
+        #
+        # @example
+        #
+        #   # bad
+        #   chef_version '>= 13' if respond_to?(:chef_version)
+        #
+        #   # good
+        #   chef_version '>= 13'
+        #
+        class RespondToInMetadata < Cop
+          MSG = 'It is no longer necessary to use respond_to? in metadata.rb in Chef Infra Client 12.15 and later'.freeze
+
+          def on_if(node)
+            if_respond_to?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def_node_matcher :if_respond_to?, <<~PATTERN
+          (if (send nil? :respond_to? _ ) ... )
+          PATTERN
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.children[1].source)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,33 +17,35 @@
 module RuboCop
   module Cop
     module Chef
-      # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
-      # methods in Chef 11 and early versions of Chef 12.
-      #
-      # @example
-      #
-      #   # bad
-      #   provides :foo if respond_to?(:provides)
-      #
-      #   # good
-      #   provides :foo
-      #
-      class RespondToProvides < Cop
-        MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
+      module ChefModernize
+        # It is not longer necessary respond_to?(:foo) in metadata. This was used to support new metadata
+        # methods in Chef 11 and early versions of Chef 12.
+        #
+        # @example
+        #
+        #   # bad
+        #   provides :foo if respond_to?(:provides)
+        #
+        #   # good
+        #   provides :foo
+        #
+        class RespondToProvides < Cop
+          MSG = 'respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+'.freeze
 
-        def on_if(node)
-          if_respond_to_provides?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_if(node)
+            if_respond_to_provides?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def_node_matcher :if_respond_to_provides?, <<~PATTERN
-        (if (send nil? :respond_to? ( :sym :provides ) ) ... )
-        PATTERN
+          def_node_matcher :if_respond_to_provides?, <<~PATTERN
+          (if (send nil? :respond_to? ( :sym :provides ) ) ... )
+          PATTERN
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, node.children[1].source)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.children[1].source)
+            end
           end
         end
       end

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

@@ -17,34 +17,36 @@
 module RuboCop
   module Cop
     module Chef
-      # Chef 12.5 introduced the resource_name method for resources. Many cookbooks used
-      # respond_to?(:resource_name) to provide backwards compatibility with older chef-client
-      # releases. This backwards compatibility is no longer necessary.
-      #
-      # @example
-      #
-      #   # bad
-      #   resource_name :foo if respond_to?(:resource_name)
-      #
-      #   # good
-      #   resource_name :foo
-      #
-      class RespondToResourceName < Cop
-        MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'.freeze
+      module ChefModernize
+        # Chef 12.5 introduced the resource_name method for resources. Many cookbooks used
+        # respond_to?(:resource_name) to provide backwards compatibility with older chef-client
+        # releases. This backwards compatibility is no longer necessary.
+        #
+        # @example
+        #
+        #   # bad
+        #   resource_name :foo if respond_to?(:resource_name)
+        #
+        #   # good
+        #   resource_name :foo
+        #
+        class RespondToResourceName < Cop
+          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'.freeze
 
-        def on_if(node)
-          if_respond_to_resource_name?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_if(node)
+            if_respond_to_resource_name?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
-        (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
-        PATTERN
+          def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
+          (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
+          PATTERN
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, node.children[1].source)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.children[1].source)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/{effortless/node_save.rb → modernize/seven_zip_archive.rb}

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2019, Chef Software Inc.
+# Copyright:: 2019, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,25 +14,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
 module RuboCop
   module Cop
     module Chef
-      # Do not use node.save with effortless as there is no server to save node state back to
-      #
-      # @example
-      #
-      #   # bad
-      #   node.save
-      class CookbookUsesNodeSave < Cop
-        MSG = 'Do not use node.save with Effortless as there is no server to save node state back to'.freeze
-
-        def_node_matcher :node_save?, <<-PATTERN
-          (send (send nil? :node) :save)
-        PATTERN
+      module ChefModernize
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
+        #
+        # @example
+        #
+        #   # bad
+        #   seven_zip_archive "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class SevenZipArchiveResource < Cop
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'.freeze
 
-        def on_send(node)
-          node_save?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :seven_zip_archive
           end
         end
       end

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

@@ -0,0 +1,59 @@
+#
+# 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
+        # Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'install package foo' do
+        #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
+        #   end
+        #
+        #  powershell_script 'add artifactory choco source' do
+        #    code "choco source add -n=artifactory -s='https://mycorp.jfrog.io/mycorp/api/nuget/chocolatey-remote' -u foo -p bar"x
+        #    not_if 'choco source list | findstr artifactory'
+        #  end
+        #
+        class ShellOutToChocolatey < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              if property_data && property_data.match?(/^choco /i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+
+            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?(/^choco /i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,27 +17,29 @@
 module RuboCop
   module Cop
     module Chef
-      # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
-      #
-      # @example
-      #
-      #   # bad
-      #   def whyrun_supported?
-      #    true
-      #   end
-      #
-      class WhyRunSupportedTrue < Cop
-        MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
+      module ChefModernize
+        # whyrun_supported? no longer needs to be set to true as that is the default in Chef Infra Client 13+
+        #
+        # @example
+        #
+        #   # bad
+        #   def whyrun_supported?
+        #    true
+        #   end
+        #
+        class WhyRunSupportedTrue < Cop
+          MSG = 'whyrun_supported? no longer needs to be set to true as it is the default in Chef Infra Client 13+'.freeze
 
-        def on_def(node)
-          if node.method_name == :whyrun_supported? && node.body == s(:true) # rubocop: disable Lint/BooleanSymbol
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_def(node)
+            if node.method_name == :whyrun_supported? && node.body == s(:true) # rubocop: disable Lint/BooleanSymbol
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -17,31 +17,33 @@
 module RuboCop
   module Cop
     module Chef
-      # Don't include the windows default recipe that is either full of gem install that are part
-      # of the Chef Infra Client, or empty (depends on version).
-      #
-      # @example
-      #
-      #   # bad
-      #   include_recipe 'windows::default'
-      #   include_recipe 'windows'
-      #
-      class IncludingWindowsDefaultRecipe < Cop
-        MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'.freeze
+      module ChefModernize
+        # Don't include the windows default recipe that is either full of gem install that are part
+        # of the Chef Infra Client, or empty (depends on version).
+        #
+        # @example
+        #
+        #   # bad
+        #   include_recipe 'windows::default'
+        #   include_recipe 'windows'
+        #
+        class IncludingWindowsDefaultRecipe < Cop
+          MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'.freeze
 
-        def_node_matcher :windows_recipe_usage?, <<-PATTERN
-          (send nil? :include_recipe (str {"windows" "windows::default"}))
-        PATTERN
+          def_node_matcher :windows_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"windows" "windows::default"}))
+          PATTERN
 
-        def on_send(node)
-          windows_recipe_usage?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            windows_recipe_usage?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.expression)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.loc.expression)
+            end
           end
         end
       end

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

@@ -17,26 +17,28 @@
 module RuboCop
   module Cop
     module Chef
-      # Use node['platform_version] data instead of the Windows::VersionHelper helper from the Windows cookbook.
-      #
-      # @example
-      #
-      #   # bad
-      #   Windows::VersionHelper.nt_version
-      #
-      #   # good
-      #   node['platform_version].to_i
-      #
-      class WindowsVersionHelper < Cop
-        MSG = "Use node['platform_version'] data instead of the Windows::VersionHelper helper from the Windows cookbook.".freeze
+      module ChefModernize
+        # Use node['platform_version] data instead of the Windows::VersionHelper helper from the Windows cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   Windows::VersionHelper.nt_version
+        #
+        #   # good
+        #   node['platform_version].to_i
+        #
+        class WindowsVersionHelper < Cop
+          MSG = "Use node['platform_version'] data instead of the Windows::VersionHelper helper from the Windows cookbook.".freeze
 
-        def_node_matcher :windows_helper?, <<-PATTERN
-          (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) ... )
-        PATTERN
+          def_node_matcher :windows_helper?, <<-PATTERN
+            (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) ... )
+          PATTERN
 
-        def on_send(node)
-          windows_helper?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            windows_helper?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

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

@@ -17,20 +17,22 @@
 module RuboCop
   module Cop
     module Chef
-      # Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
-      #
-      # @example
-      #
-      #   # bad
-      #   windows_zipfile 'C:\\files\\' do
-      #     source 'C:\\Temp\\file.zip'
-      #   end
-      #
-      class WindowsZipfileUsage < Cop
-        MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'.freeze
+      module ChefModernize
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
+        #
+        # @example
+        #
+        #   # bad
+        #   windows_zipfile 'C:\\files\\' do
+        #     source 'C:\\Temp\\file.zip'
+        #   end
+        #
+        class WindowsZipfileUsage < Cop
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'.freeze
 
-        def on_send(node)
-          add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile
+          end
         end
       end
     end