cookstyle-ng 8.0.0

data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.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
+        # In Chef Infra Client 13 the "file" variable for use within the verify property was replaced with the "path" variable.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   file '/etc/nginx.conf' do
+        #     verify 'nginx -t -c %{file}'
+        #   end
+        #
+        #   ### correct
+        #   file '/etc/nginx.conf' do
+        #     verify 'nginx -t -c %{path}'
+        #   end
+        #
+        class VerifyPropertyUsesFileExpansion < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.5'
+
+          MSG = "Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13."
+
+          def on_block(node)
+            match_property_in_resource?(nil, 'verify', node) do |verify|
+              return unless verify.source.match?(/%{file}/)
+              add_offense(verify, severity: :warning) do |corrector|
+                corrector.replace(verify.loc.expression, verify.loc.expression.source.gsub('%{file}', '%{path}'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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
+        # The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_feature 'DHCP' do
+        #     install_method :servermanagercmd
+        #   end
+        #
+        #   ### correct
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_dism
+        #   end
+        #
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_powershell
+        #   end
+        #
+        #   windows_feature_dism 'DHCP'
+        #
+        #   windows_feature_powershell 'DHCP'
+        #
+        class WindowsFeatureServermanagercmd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
+
+          def on_block(node)
+            match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
+              add_offense(prop_node, severity: :warning) if prop_node.source.include?(':servermanagercmd')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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
+        # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type 'msi'
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        #   ### correct
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type :msi
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        class WindowsPackageInstallerTypeString < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
+
+          def on_block(node)
+            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # anything else is fine
+
+              add_offense(offense, severity: :warning) do |corrector|
+                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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 :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+
+        # The default action of :create should can now be used to create an update tasks.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   windows_task 'chef ad-join leave start time' do
+        #     task_name 'chef ad-join leave'
+        #     start_day '06/09/2016'
+        #     start_time '01:00'
+        #     action [:change, :create]
+        #   end
+        #
+        #   ### correct
+        #   windows_task 'chef ad-join leave start time' do
+        #     task_name 'chef ad-join leave'
+        #     start_day '06/09/2016'
+        #     start_time '01:00'
+        #     action :create
+        #   end
+        #
+        class WindowsTaskChangeAction < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '13.0'
+
+          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'
+
+          def on_block(node)
+            match_property_in_resource?(:windows_task, 'action', node) do |action_node|
+              action_values = action_node.arguments.first
+
+              if action_values.sym_type? # there's only a single action given
+                check_action(action_values)
+              else # it was an array of actions
+                action_values.node_parts.each { |action| check_action(action) }
+              end
+            end
+          end
+
+          private
+
+          def check_action(ast_obj)
+            if ast_obj.respond_to?(:value) && ast_obj.value == :change
+              add_offense(ast_obj, severity: :warning) do |corrector|
+                if ast_obj.parent.send_type? # :change was the only action
+                  corrector.replace(ast_obj, ':create')
+                # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
+                elsif ast_obj.parent.child_nodes.count == 2 &&
+                      ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
+                  corrector.replace(ast_obj.parent, ':create')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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 node['platform_version'] and node['kernel'] data instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Windows::VersionHelper.nt_version
+        #   Windows::VersionHelper.server_version?
+        #   Windows::VersionHelper.core_version?
+        #   Windows::VersionHelper.workstation_version?
+        #
+        #   ### correct
+        #   node['platform_version'].to_f
+        #   node['kernel']['product_type'] == 'Server'
+        #   node['kernel']['server_core']
+        #   node['kernel']['product_type'] == 'Workstation'
+        #
+        class WindowsVersionHelpers < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = "Use node['platform_version'] and node['kernel'] data introduced in Chef Infra Client 14 instead of the deprecated Windows::VersionHelper helpers from the Windows cookbook."
+          RESTRICT_ON_SEND = [:nt_version, :server_version?, :core_version?, :workstation_version?].freeze
+
+          def_node_matcher :windows_helper?, <<-PATTERN
+            (send ( const ( const {nil? cbase} :Windows ) :VersionHelper ) $_ )
+          PATTERN
+
+          def on_send(node)
+            windows_helper?(node) do |method|
+              add_offense(node, severity: :refactor) do |corrector|
+                case method
+                when :nt_version
+                  corrector.replace(node, 'node[\'platform_version\'].to_f')
+                when :server_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Server\'')
+                when :core_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'server_core\']')
+                when :workstation_version?
+                  corrector.replace(node, 'node[\'kernel\'][\'product_type\'] == \'Workstation\'')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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
+        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'xml::ruby'
+        #
+        class IncludingXMLRubyRecipe < Base
+          extend AutoCorrector
+
+          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :xml_ruby_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str "xml::ruby"))
+          PATTERN
+
+          def on_send(node)
+            xml_ruby_recipe?(node) do
+              node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(node)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.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 Deprecations
+        # Don't include the deprecated yum DNF compatibility recipe, which is no longer necessary
+        # as Chef Infra Client includes DNF package support
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'yum::dnf_yum_compat'
+        #
+        class IncludingYumDNFCompatRecipe < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str "yum::dnf_yum_compat"))
+          PATTERN
+
+          def on_send(node)
+            yum_dnf_compat_recipe_usage?(node) do
+              node = node.parent if node.parent&.conditional? && node.parent&.single_line?
+              add_offense(node, severity: :warning) 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/effortless/berksfile.rb

@@ -0,0 +1,39 @@
+# 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 Effortless
+        # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
+        #
+        class Berksfile < Base
+          include RangeHelp
+
+          MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'
+
+          def on_new_investigation
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@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 Effortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chef-vault'
+        #
+        #   ### incorrect
+        #   ChefVault::Item
+        #
+        #   ### incorrect
+        #   include_recipe 'chef-vault'
+        #
+        #   ### incorrect
+        #   chef_gem 'chef-vault'
+        #
+        #   ### incorrect
+        #   chef_vault_item_for_environment(arg, arg1)
+        #
+        #   ### incorrect
+        #   chef_vault_item(arg, arg1)
+        #
+        class ChefVaultUsed < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:chef_vault_item,
+                              :chef_vault_item_for_environment,
+                              :include_recipe,
+                              :require,
+                              :chef_gem].freeze
+
+          def_node_matcher :require?, <<-PATTERN
+            (send nil? { :require :include_recipe :chef_gem }
+              (str "chef-vault"))
+          PATTERN
+
+          def_node_matcher :vault_const?, <<-PATTERN
+            (const
+              (const nil? :ChefVault)
+              :Item)
+          PATTERN
+
+          def_node_matcher :chef_vault_item_for_environment?, <<-PATTERN
+            (send nil? :chef_vault_item_for_environment _ _)
+          PATTERN
+
+          def_node_matcher :chef_vault_item?, <<-PATTERN
+            (send nil? :chef_vault_item _ _)
+          PATTERN
+
+          def on_send(node)
+            return unless require?(node) ||
+                          chef_vault_item_for_environment?(node) ||
+                          chef_vault_item?(node)
+            add_offense(node.loc.expression, severity: :refactor)
+          end
+
+          def on_const(node)
+            vault_const?(node) do
+              add_offense(node.loc.expression, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/data_bags.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+#
+# Copyright:: 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 Effortless
+        # Data bags cannot be used with the Effortless Infra pattern
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   data_bag_item('admins', login)
+        #   data_bag(data_bag_name)
+        class CookbookUsesDatabags < Base
+          MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'
+          RESTRICT_ON_SEND = [:data_bag, :data_bag_item].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Scott Vidmar (<svidmar@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 Effortless
+        # Chef Vault is not supported in the Effortless pattern, so usage of Chef Vault must be shifted to another secrets management solution before leveraging the Effortless pattern.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'chef-vault'
+        #
+        class DependsChefVault < Base
+          MSG = 'Chef Vault usage is not supported in the Effortless pattern'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :depends?, <<-PATTERN
+            (send nil? :depends
+              (str "chef-vault"))
+          PATTERN
+
+          def on_send(node)
+            depends?(node) do
+              add_offense(node.loc.expression, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end