cookstyle-ng 8.0.0

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

@@ -0,0 +1,68 @@
+# 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
+        # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @provides = :foo
+        #   end
+        #
+        #   ### correct
+        #   provides :foo
+        #
+        class ProvidesFromInitialize < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
+
+          def_node_matcher :provides_assignment?, <<-PATTERN
+            (ivasgn :@provides $(sym ...))
+          PATTERN
+
+          def on_ivasgn(node)
+            provides_assignment?(node) do
+              return unless initialize_method(node.parent.parent).any?
+              add_offense(node, severity: :refactor) do |corrector|
+                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+                unless provides_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :provides_method?, '(send nil? :provides ... )'
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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 resource name can now be specified using the `resource_name` helper instead of using the @resource_name variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #     @resource_name = :foo
+        #   end
+        #
+        #  ### correct
+        #  resource_name :create
+
+        class ResourceNameFromInitialize < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
+
+          def on_def(node)
+            return unless node.method?(:initialize)
+            return if node.body.nil? # nil body is an empty initialize method
+
+            node.body.each_node do |x|
+              next unless x.assignment? && !x.node_parts.empty? && x.node_parts.first == :@resource_name
+
+              add_offense(x, severity: :refactor) do |corrector|
+                # insert the new resource_name call above the initialize method
+                initialize_node = initialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "resource_name #{x.descendants.first.source}\n\n")
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# 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
+        # 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
+        #
+        #   ### incorrect
+        #    def severity(arg = nil)
+        #      set_or_return(
+        #        :severity, arg,
+        #        :kind_of => String,
+        #        :default => nil
+        #      )
+        #    end
+        #
+        #   ### correct
+        #   property :severity, String
+        #
+        class SetOrReturnInResources < Base
+          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'
+          RESTRICT_ON_SEND = [:set_or_return].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# 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
+        # 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
+        #
+        #   ### incorrect
+        #   attribute :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        #   ### correct
+        #   property :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        class CustomResourceWithAttributes < Base
+          extend AutoCorrector
+
+          MSG = 'Custom Resources should contain properties not attributes'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def_node_matcher :attribute?, <<-PATTERN
+            (send nil? $:attribute ... )
+          PATTERN
+
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
+
+          def on_send(node)
+            return unless resource_actions?(processed_source.ast)
+            attribute?(node) do
+              add_offense(node.loc.selector, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.selector, 'property')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# 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
+        # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if Chef::Resource::ChefGem.instance_methods(false).include?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true if respond_to?(:compile_time)
+        #     action :nothing
+        #   end
+        #
+        #   ### correct
+        #   chef_gem 'ultradns-sdk' do
+        #     compile_time true
+        #     action :nothing
+        #   end
+        #
+        class RespondToCompileTime < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.1'
+
+          MSG = 'There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.'
+
+          def_node_matcher :compile_time_method_defined?, <<-PATTERN
+          (if
+            {
+              (send
+              (const
+                (const
+                  (const nil? :Chef) :Resource) :ChefGem) :method_defined?
+              (sym :compile_time))
+
+              (send
+                (send
+                  (const
+                    (const
+                      (const nil? :Chef) :Resource) :ChefGem) :instance_methods
+                  (false)) :include?
+                (sym :compile_time))
+
+              (send nil? :respond_to?
+                (sym :compile_time))
+            }
+            (send nil? :compile_time
+              $(_)) nil?)
+          PATTERN
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'compile_time', node) do |compile_time_property|
+              compile_time_method_defined?(compile_time_property.parent) do |val|
+                add_offense(compile_time_property.parent, severity: :refactor) do |corrector|
+                  corrector.replace(compile_time_property.parent, "compile_time #{val.source}")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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
+        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_version '>= 13' if respond_to?(:chef_version)
+        #   chef_version '>= 13' if defined?(chef_version)
+        #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
+        #   if defined(chef_version)
+        #     chef_version '>= 13'
+        #   end
+        #
+        #   ### correct
+        #   chef_version '>= 13'
+        #
+        class RespondToInMetadata < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.15'
+
+          MSG = 'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'
+
+          def on_if(node)
+            if_respond_to?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+                # node.if_branch is the actual method call we want to extract.
+                # If a series of metadata methods are wrapped in an if statement then the content we want
+                # is a block under the if statement and node.parent.if_branch can get us that block
+                node = node.parent unless node.if_type?
+
+                corrector.replace(node, node.if_branch.source)
+              end
+            end
+          end
+
+          def on_defined?(node)
+            # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+            # node.if_branch is the actual method call we want to extract.
+            # If a series of metadata methods are wrapped in an if statement then the content we want
+            # is a block under the if statement and node.parent.if_branch can get us that block
+            node = node.parent if node.parent.conditional? # we want the whole conditional statement
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.if_branch.source)
+            end
+          end
+
+          def_node_matcher :if_respond_to?, <<~PATTERN
+            (if (send nil? :respond_to? _ ) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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
+        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   provides :foo if respond_to?(:provides)
+        #
+        #   provides :foo if defined? provides
+        #
+        #   ### correct
+        #   provides :foo
+        #
+        class RespondToProvides < Base
+          extend AutoCorrector
+
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'
+
+          def on_if(node)
+            if_respond_to_provides?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.children[1].source)
+              end
+            end
+          end
+
+          def_node_matcher :if_respond_to_provides?, <<~PATTERN
+            (if
+              {
+              (send nil? :respond_to?
+                (sym :provides))
+
+              (:defined?
+                (send nil? :provides))
+              }
+              (send nil? :provides
+                (sym _)) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 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
+        #
+        #   ### incorrect
+        #   resource_name :foo if respond_to?(:resource_name)
+        #
+        #   ### correct
+        #   resource_name :foo
+        #
+        class RespondToResourceName < Base
+          extend AutoCorrector
+
+          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
+
+          def on_if(node)
+            if_respond_to_resource_name?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.children[1].source)
+              end
+            end
+          end
+
+          def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
+            (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# 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 sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. 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
+        #   sc_windows 'chef-client' do
+        #     path "C:\\opscode\\chef\\bin"
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   windows_service 'chef-client' do
+        #     action :create
+        #     binary_path_name "C:\\opscode\\chef\\bin"
+        #   end
+        #
+        class WindowsScResource < Cop
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.'
+          RESTRICT_ON_SEND = [:sc_windows].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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 the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   seven_zip_archive "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class SevenZipArchiveResource < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
+          RESTRICT_ON_SEND = [:seven_zip_archive].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end