cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/correctness/service_resource.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2016, Chris Henry
+#
+# 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 Correctness
+        # Use a service resource to start and stop services
+        #
+        # @example when command starts a service
+        #
+        #   ### incorrect
+        #   command "/etc/init.d/mysql start"
+        #   command "/sbin/service/memcached start"
+        #
+        class ServiceResource < Base
+          MSG = 'Use a service resource to start and stop services'
+          RESTRICT_ON_SEND = [:command].freeze
+
+          def_node_matcher :execute_command?, <<-PATTERN
+            (send nil? :command $str)
+          PATTERN
+
+          def on_send(node)
+            execute_command?(node) do |command|
+              if starts_service?(command)
+                add_offense(command, severity: :refactor)
+              end
+            end
+          end
+
+          def starts_service?(cmd)
+            cmd_str = cmd.to_s
+            (cmd_str.include?('/etc/init.d') || ['service ', '/sbin/service ',
+                                                 'start ', 'stop ', 'invoke-rc.d '].any? do |service_cmd|
+               cmd_str.start_with?(service_cmd)
+             end) && %w(start stop restart reload).any? { |a| cmd_str.include?(a) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -0,0 +1,52 @@
+# 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 Correctness
+        # Versions used in metadata.rb supports calls should be floats not integers.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   supports 'redhat', '> 8'
+        #
+        #   ### correct
+        #   supports 'redhat', '> 8.0'
+        #
+        class SupportsMustBeFloat < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Versions used in metadata.rb supports calls should be floats not integers.'
+          RESTRICT_ON_SEND = [:supports].freeze
+
+          def_node_matcher :supports_with_constraint?, '(send nil? :supports str $str)'
+
+          def on_send(node)
+            supports_with_constraint?(node) do |ver|
+              return if ver.source.include?('.')
+              add_offense(ver, severity: :refactor) do |corrector|
+                corrector.replace(ver, ver.source.gsub(ver.value, (ver.value + '.0')))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/tmp_path.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2016, Chris Henry
+#
+# 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 Correctness
+        # Use file_cache_path rather than hard-coding system temp paths
+        #
+        # @example downloading a large file into /tmp/
+        #
+        #   ### incorrect
+        #   remote_file '/tmp/large-file.tar.gz' do
+        #
+        #   ### correct
+        #   remote_file "#{Chef::Config[:file_cache_path]}/large-file.tar.gz" do
+        #
+        class TmpPath < Base
+          MSG = 'Use file_cache_path rather than hard-coding tmp paths'
+          RESTRICT_ON_SEND = [:remote_file].freeze
+
+          def_node_matcher :remote_file?, <<-PATTERN
+            (send nil? :remote_file $str)
+          PATTERN
+
+          def on_send(node)
+            remote_file?(node) do |command|
+              return unless hardcoded_tmp?(command) && !file_cache_path?(command)
+              add_offense(command, severity: :refactor)
+            end
+          end
+
+          def hardcoded_tmp?(path)
+            path_str = path.to_s.scan(/"(.*)"/)[0][0]
+            path_str.start_with?('/tmp/')
+          end
+
+          def file_cache_path?(path)
+            path_str = path.to_s.scan(/"(.*)"/)[0][0]
+            path_str.start_with?("\#\{Chef::Config[:file_cache_path]\}")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 Deprecations
+        # Make sure a cookbook doesn't depend on itself. This will fail on Chef Infra Client 13+
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   name 'foo'
+        #   depends 'foo'
+        #
+        #   ### correct
+        #   name 'foo'
+        #
+        class CookbooksDependsOnSelf < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'
+          RESTRICT_ON_SEND = [:name].freeze
+
+          def_node_search :dependencies, '(send nil? :depends str ...)'
+          def_node_matcher :cb_name?, '(send nil? :name str ...)'
+
+          def on_send(node)
+            cb_name?(node) do
+              dependencies(processed_source.ast).each do |dep|
+                next unless dep.arguments == node.arguments
+                add_offense(dep, severity: :refactor) do |corrector|
+                  corrector.remove(range_with_surrounding_space(range: dep.loc.expression, side: :left))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 Deprecations
+        # There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'chef_handler'
+        #   include_recipe 'chef_handler::default'
+        #
+        class ChefHandlerRecipe < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :chef_handler_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str {"chef_handler" "chef_handler::default"}))
+          PATTERN
+
+          def on_send(node)
+            chef_handler_recipe?(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

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

@@ -0,0 +1,55 @@
+# 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 Deprecations
+        # Use the type `property` instead of the deprecated `supports` property in the `chef_handler` resource. The `supports` property was removed in `chef_handler` cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_handler 'whatever' do
+        #     supports start: true, report: true, exception: true
+        #   end0
+        #
+        #   ### correct
+        #   chef_handler 'whatever' do
+        #     type start: true, report: true, exception: true
+        #   end
+        #
+        class ChefHandlerUsesSupports < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = 'Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.'
+
+          def on_block(node)
+            match_property_in_resource?(:chef_handler, 'supports', node) do |prop_node|
+              add_offense(prop_node, severity: :warning) do |corrector|
+                # make sure to delete leading and trailing {}s that would create invalid ruby syntax
+                extracted_val = prop_node.arguments.first.source.gsub(/{|}/, '')
+                corrector.replace(prop_node, "type #{extracted_val}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 Deprecations
+        # The `Chef::REST` class was removed in Chef Infra Client 13.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chef/rest'
+        #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
+        #
+        class UsesChefRESTHelpers < Base
+          MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def_node_matcher :require_rest?, <<-PATTERN
+          (send nil? :require ( str "chef/rest"))
+          PATTERN
+
+          def_node_matcher :rest_const?, <<-PATTERN
+          (const (const nil? :Chef) :REST)
+          PATTERN
+
+          def on_send(node)
+            require_rest?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+
+          def on_const(node)
+            rest_const?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# 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 Deprecations
+        # Use `delete_resource` or `edit_resource` helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated `chef-rewind` gem
+        #
+        # @example
+        #
+        #   chef_gem 'chef-rewind'
+        #
+        #   require 'chef/rewind'
+        #
+        #   rewind "user[postgres]" do
+        #     home '/var/lib/pgsql/9.2'
+        #     cookbook 'my-postgresql'
+        #   end
+        #
+        #   unwind "user[postgres]"
+        #
+        class ChefRewind < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.10'
+
+          MAPPING = {
+            rewind: 'edit_resource',
+            unwind: 'delete_resource',
+          }.freeze
+
+          MSG = 'Use delete_resource or edit_resource helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
+          RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
+
+          def_node_matcher :rewind_gem_install?, <<-PATTERN
+            (send nil? :chef_gem (str "chef-rewind"))
+          PATTERN
+
+          def_node_matcher :require_rewind?, <<-PATTERN
+            (send nil? :require (str "chef/rewind"))
+          PATTERN
+
+          def_node_matcher :rewind_resources?, <<-PATTERN
+            (send nil? ${:rewind :unwind} ... )
+          PATTERN
+
+          def on_send(node)
+            rewind_gem_install?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_rewind?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            rewind_resources?(node) do |string|
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
+              end
+            end
+          end
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+              next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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 Deprecations
+        # Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically or convert to the simpler `shell_out` helper.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include Chef::ShellOut
+        #   require 'chef/shellout'
+        #   Chef::ShellOut.new('some_command')
+        #
+        #   ### correct
+        #   include Mixlib::ShellOut
+        #   require 'mixlib/shellout'
+        #   Mixlib::ShellOut.new('some_command')
+        #
+        class ChefShellout < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically."
+          RESTRICT_ON_SEND = [:new, :require, :include].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const nil? :Chef) :ShellOut))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+          (send nil? :require (str "chef/shellout"))
+          PATTERN
+
+          def_node_matcher :shellout_new?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) :ShellOut) :new
+              ... )
+          PATTERN
+
+          def on_send(node)
+            include_shellout?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_shellout?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            shellout_new?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 Deprecations
+        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   vagrant_key?
+        #   vagrant_domain?
+        #   vagrant_user?
+        #   require_chef_gem
+        #   best_ip_for(node)
+        #   nexus?
+        #   ios_xr?
+        #   ruby_20?
+        #   ruby_19?
+        #   includes_recipe?('foo::bar')
+        #   wrlinux?
+        #   dev_null
+        #   nexentacore_platform?
+        #   opensolaris_platform?
+        #   nexentacore?
+        #   opensolaris?
+        #
+        class ChefSugarHelpers < Base
+          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started'
+          RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 Deprecations
+        # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Chef::Platform.windows?
+        #
+        #   ### correct
+        #   platform?('windows')
+        #   platform_family?('windows')
+        #
+        class ChefWindowsPlatformHelper < Base
+          extend AutoCorrector
+          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
+          RESTRICT_ON_SEND = [:windows?].freeze
+
+          def_node_matcher :chef_platform_windows?, <<-PATTERN
+            (send
+              (const
+                (const nil? :Chef) :Platform) :windows?)
+          PATTERN
+
+          def on_send(node)
+            chef_platform_windows?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, "platform?('windows')")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end