cookstyle 5.4.13 → 5.5.7

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

@@ -0,0 +1,41 @@
+#
+# 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 archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource
+        #
+        # @example
+        #
+        #   # bad
+        #   libarchive "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class LibarchiveFileResource < Cop
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource'.freeze
+
+          def on_send(node)
+            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :libarchive_file
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,29 +17,31 @@
 module RuboCop
   module Cop
     module Chef
-      # Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
-      #
-      # @example
-      #
-      #   # bad
-      #   depends 'minitest-handler'
-      #
-      class MinitestHandlerUsage < Cop
-        MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'.freeze
+      module ChefModernize
+        # Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'minitest-handler'
+        #
+        class MinitestHandlerUsage < Cop
+          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'.freeze
 
-        def_node_matcher :minitest_depends?, <<-PATTERN
-          (send nil? :depends (str "minitest-handler"))
-        PATTERN
+          def_node_matcher :minitest_depends?, <<-PATTERN
+            (send nil? :depends (str "minitest-handler"))
+          PATTERN
 
-        def on_send(node)
-          minitest_depends?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            minitest_depends?(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/powershell_expand_archive.rb

@@ -0,0 +1,48 @@
+#
+# 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 archive_file resource built into Chef Infra Client 15+ instead of using the powershell_script
+        # resource to run Expand-Archive
+        #
+        # @example
+        #
+        #   # bad
+        #   powershell_script 'Expand website' do
+        #     code 'Expand-Archive "C:\\file.zip" -DestinationPath "C:\\inetpub\\wwwroot\\" -Force'
+        #   end
+        #
+        class PowershellScriptExpandArchive < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource'.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?(/^expand-archive/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+#
+# 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 powershell_package resource built into Chef Infra Client instead of the powershell_script
+        # resource to run Install-Package
+        #
+        # @example
+        #
+        #   # bad
+        #   powershell_script 'Expand website' do
+        #     code 'Install-Package -Name docker'
+        #   end
+        #
+        #  # good
+        #  powershell_package 'docker'
+        #
+        class PowershellInstallPackage < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'.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?(/^install-package\s/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.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
+        # Use the windows_feature resource built into Chef Infra Client 15+ instead of the powershell_script resource
+        # to run Install-WindowsFeature or Add-WindowsFeature
+        #
+        # @example
+        #
+        #   # bad
+        #   powershell_script 'Install Feature' do
+        #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
+        #   end
+        #
+        #  # good
+        #  windows_feature 'Net-framework-Core' do
+        #    action :install
+        #    install_method :windows_feature_powershell
+        #  end
+        #
+        class PowershellInstallWindowsFeature < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          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
+
+          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?(/^(install|add)-windowsfeature\s/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,30 +18,32 @@
 module RuboCop
   module Cop
     module Chef
-      # set_or_return within a method should not be used to define property in a resource. Instead use
-      # the property method which properly validates and defines properties in a way that works with
-      # reporting and documentation functionality in Chef Infra Client
-      #
-      # @example
-      #
-      #   # bad
-      #    def severity(arg = nil)
-      #      set_or_return(
-      #        :severity, arg,
-      #        :kind_of => String,
-      #        :default => nil
-      #      )
-      #    end
-      #
-      #   # good
-      #   property :severity, String
-      #
-      class SetOrReturnInResources < Cop
-        MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'.freeze
+      module ChefModernize
+        # set_or_return within a method should not be used to define property in a resource. Instead use
+        # the property method which properly validates and defines properties in a way that works with
+        # reporting and documentation functionality in Chef Infra Client
+        #
+        # @example
+        #
+        #   # bad
+        #    def severity(arg = nil)
+        #      set_or_return(
+        #        :severity, arg,
+        #        :kind_of => String,
+        #        :default => nil
+        #      )
+        #    end
+        #
+        #   # good
+        #   property :severity, String
+        #
+        class SetOrReturnInResources < Cop
+          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'.freeze
 
-        def on_send(node)
-          if node.method_name == :set_or_return
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            if node.method_name == :set_or_return
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/modernize/resource_with_allowed_actions.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
+        # In HWRPs and LWRPs it was necessary to define the allowed actions within the resource.
+        # In custom resources this is no longer necessary as Chef will determine it based on the
+        # actions defined in the resource.
+        #
+        # @example
+        #
+        #   # bad
+        #   property :something, String
+        #
+        #   allowed_actions [:create, :remove]
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        #   # also bad
+        #   property :something, String
+        #
+        #   actions [:create, :remove]
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        #   # good
+        #   property :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        class CustomResourceWithAllowedActions < Cop
+          MSG = "Custom Resources don't need to define the allowed actions with allowed_actions or actions methods".freeze
+
+          def_node_matcher :allowed_actions?, <<-PATTERN
+            (send nil? {:allowed_actions :actions} ... )
+          PATTERN
+
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
+
+          def on_send(node)
+            allowed_actions?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
+            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/resource_with_attributes.rb

@@ -18,46 +18,48 @@
 module RuboCop
   module Cop
     module Chef
-      # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to
-      # be properties to avoid confusion with chef recipe attributes. When writing a custom resource
-      # they should be called properties even though the two are aliased.
-      #
-      # @example
-      #
-      #   # bad
-      #   attribute :something, String
-      #
-      #   action :create do
-      #     # some action code because we're in a custom resource
-      #   end
-      #
-      #   # good
-      #   property :something, String
-      #
-      #   action :create do
-      #     # some action code because we're in a custom resource
-      #   end
-      #
-      class CustomResourceWithAttributes < Cop
-        MSG = 'Custom Resources should contain properties not attributes'.freeze
+      module ChefModernize
+        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to
+        # be properties to avoid confusion with chef recipe attributes. When writing a custom resource
+        # they should be called properties even though the two are aliased.
+        #
+        # @example
+        #
+        #   # bad
+        #   attribute :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        #   # good
+        #   property :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        class CustomResourceWithAttributes < Cop
+          MSG = 'Custom Resources should contain properties not attributes'.freeze
 
-        def_node_matcher :attribute?, <<-PATTERN
-          (send nil? $:attribute ... )
-        PATTERN
+          def_node_matcher :attribute?, <<-PATTERN
+            (send nil? $:attribute ... )
+          PATTERN
 
-        def_node_search :resource_actions?, <<-PATTERN
-          (block (send nil? :action ... ) ... )
-        PATTERN
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
 
-        def on_send(node)
-          attribute?(node) do
-            add_offense(node, location: :selector, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
+          def on_send(node)
+            attribute?(node) do
+              add_offense(node, location: :selector, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, 'property')
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.selector, 'property')
+            end
           end
         end
       end