cookstyle-ng 8.0.0

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

@@ -0,0 +1,60 @@
+# 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 built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Mixlib::ShellOut.new('foo').run_command
+        #
+        #   ### correct
+        #   shell_out('foo')
+        #
+        class ShellOutHelper < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.11'
+
+          MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
+          RESTRICT_ON_SEND = [:run_command].freeze
+
+          def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
+          (send
+            (send
+              (const
+                (const nil? :Mixlib) :ShellOut) :new
+              $(...)) :run_command)
+          PATTERN
+
+          def on_send(node)
+            mixlib_shellout_run_cmd?(node) do |cmd|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "shell_out(#{cmd.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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 Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   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 < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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
+        # The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net, which should be used to simplify the resource code in your cookbooks.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #    apt_repository 'atom-ppa' do
+        #      uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
+        #      components ['main']
+        #      keyserver 'keyserver.ubuntu.com'
+        #      key 'C2518248EEA14886'
+        #    end
+        #
+        #  ### correct
+        #    apt_repository 'atom-ppa' do
+        #      uri 'ppa:webupd8team/atom'
+        #      components ['main']
+        #      keyserver 'keyserver.ubuntu.com'
+        #      key 'C2518248EEA14886'
+        #    end
+        #
+        class SimplifyAptPpaSetup < Base
+          extend AutoCorrector
+          include RangeHelp
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.'
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'uri', node) do |uri|
+              if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
+                add_offense(uri, severity: :refactor) do |corrector|
+                  next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
+                  corrector.replace(uri, "uri 'ppa:#{replacement_val}'")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   sysctl_param 'fs.aio-max-nr' do
+        #     value '1048576'
+        #   end
+        #
+        #   ### correct
+        #   sysctl 'fs.aio-max-nr' do
+        #     value '1048576'
+        #   end
+        #
+        class SysctlParamResource < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:sysctl_param].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^sysctl_param/, 'sysctl'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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.4+ includes mixlib/shellout automatically in resources and providers.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'mixlib/shellout'
+        #
+        class UnnecessaryMixlibShelloutRequire < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def_node_matcher :require_mixlibshellout?, <<-PATTERN
+          (send nil? :require ( str "mixlib/shellout"))
+          PATTERN
+
+          def on_send(node)
+            require_mixlibshellout?(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/modernize/use_chef_language_cloud_helpers.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 15.5 and later include cloud helpers to make detecting instances that run on public and private clouds easier.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['cloud']['provider'] == 'alibaba'
+        #   node['cloud']['provider'] == 'ec2'
+        #   node['cloud']['provider'] == 'gce'
+        #   node['cloud']['provider'] == 'rackspace'
+        #   node['cloud']['provider'] == 'eucalyptus'
+        #   node['cloud']['provider'] == 'linode'
+        #   node['cloud']['provider'] == 'openstack'
+        #   node['cloud']['provider'] == 'azure'
+        #   node['cloud']['provider'] == 'digital_ocean'
+        #   node['cloud']['provider'] == 'softlayer'
+        #
+        #   ### correct
+        #   alibaba?
+        #   ec2?
+        #   gce?
+        #   rackspace?
+        #   eucalyptus?
+        #   linode?
+        #   openstack?
+        #   azure?
+        #   digital_ocean?
+        #   softlayer?
+        #
+        class UseChefLanguageCloudHelpers < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.5'
+
+          MSG = 'Chef Infra Client 15.5 and later include cloud helpers to make detecting instances that run on public and private clouds easier.'
+          RESTRICT_ON_SEND = [:==, :[]].freeze
+          VALID_CLOUDS = %w(alibaba ec2 gce rackspace eucalyptus linode openstack azure digital_ocean softlayer).freeze
+
+          def_node_matcher :provider_comparison?, <<-PATTERN
+            (send
+              (send
+                (send
+                  (send nil? :node) :[]
+                  (str "cloud")) :[]
+                (str "provider")) :==
+              (str $_))
+          PATTERN
+
+          def_node_matcher :node_cloud?, <<-PATTERN
+            (send
+              (send nil? :node) :[]
+              (str "cloud"))
+          PATTERN
+
+          def on_send(node)
+            provider_comparison?(node) do |cloud_name|
+              # skip it if someone was checking for a bogus cloud provider
+              next unless VALID_CLOUDS.include?(cloud_name)
+
+              # if they were checking for node['cloud'] and the provider replace it all
+              node = node.parent if node.parent.and_type? && node_cloud?(node.left_sibling)
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{cloud_name}?")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 15.5 and later include a large number of new helpers in the Chef Infra Language to simplify checking the system configuration in recipes and resources. These should be used when possible over more complex attributes or ENV var comparisons.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ENV['CI']
+        #   ENV['TEST_KITCHEN']
+        #
+        #   ### correct
+        #   ci?
+        #   kitchen?
+        #
+        class UseChefLanguageEnvHelpers < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.5'
+
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          def_node_matcher :env?, <<-PATTERN
+            (send
+              (const nil? :ENV) :[]
+              (str ${"TEST_KITCHEN" "CI"}))
+          PATTERN
+
+          def on_send(node)
+            env?(node) do |env_value|
+              # we don't handle .nil? checks yet so just skip them
+              next if node.parent.send_type? && node.parent.method?(:nil?)
+
+              case env_value
+              when 'CI'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `ci?` that should be used to see if the `CI` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'ci?')
+                end
+              when 'TEST_KITCHEN'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `kitchen?` that should be used to see if the `TEST_KITCHEN` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'kitchen?')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['init_package'] == 'systemd'
+        #
+        #   ### correct
+        #   systemd?
+        #
+        class UseChefLanguageSystemdHelper < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.5'
+
+          MSG = 'Chef Infra Client 15.5 and later include a `systemd?` helper for checking if a Linux system uses systemd.'
+          RESTRICT_ON_SEND = [:==].freeze
+
+          def_node_matcher :node_init_package?, <<-PATTERN
+              (send
+                (send
+                  (send nil? :node) :[]
+                  (str "init_package")) :==
+                (str "systemd"))
+            PATTERN
+
+          def on_send(node)
+            node_init_package?(node) do |_cloud_name|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, 'systemd?')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# 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
+        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   %w(bmon htop vim curl).each do |pkg|
+        #     package pkg do
+        #       action :install
+        #     end
+        #   end
+        #
+        #   ### correct
+        #   package %w(bmon htop vim curl)
+        #
+        class UseMultipackageInstalls < Base
+          extend AutoCorrector
+
+          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
+          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
+
+          def_node_matcher :platform_or_platform_family?, <<-PATTERN
+            (send (send nil? :node) :[] (str {"platform" "platform_family"}) )
+          PATTERN
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+          (if
+            (send nil? {:platform_family? :platform?} $... )
+            $(block
+              (send
+                $(array ... ) :each)
+              (args ... )
+              {(block
+                (send nil? :package
+                  (lvar ... ))
+                (args)
+                (send nil? :action
+                  (sym :install)))
+                (send nil? :package
+                    (lvar _))}) nil?)
+          PATTERN
+
+          def_node_search :package_array_install, <<-PATTERN
+          $(block
+            (send
+              $(array ... ) :each)
+            (args ... )
+            {(block
+              (send nil? :package
+                (lvar ... ))
+              (args)
+              (send nil? :action
+                (sym :install)))
+              (send nil? :package
+                  (lvar _))})
+          PATTERN
+
+          # see if all platforms in the when condition are multi-package compliant
+          def multipackage_platforms?(condition_obj)
+            condition_obj.all? do |p|
+              # make sure it's a string (not a regex) and it's in the array
+              p.str_type? && MULTIPACKAGE_PLATS.include?(p.value)
+            end
+          end
+
+          def on_when(node)
+            return unless platform_or_platform_family?(node.parent.condition) &&
+                          multipackage_platforms?(node.conditions)
+            return if node.body.nil? # don't blow up on empty whens
+
+            package_array_install(node.body) do |install_block, pkgs|
+              add_offense(install_block, severity: :refactor) do |corrector|
+                corrector.replace(install_block, "package #{pkgs.source}")
+              end
+            end
+          end
+
+          def on_if(node)
+            platform_helper?(node) do |plats, blk, _pkgs|
+              return unless multipackage_platforms?(plats)
+
+              add_offense(blk, severity: :refactor) do |corrector|
+                package_array_install(blk) do |install_block, pkgs|
+                  corrector.replace(install_block, "package #{pkgs.source}")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/use_require_relative.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 Modernize
+        # Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require File.expand_path('../../libraries/helpers', __FILE__)
+        #
+        #   ### correct
+        #   require_relative '../libraries/helpers'
+        #
+        class UseRequireRelative < Base
+          extend AutoCorrector
+
+          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def_node_matcher :require_with_expand_path?, <<-PATTERN
+            (send nil? :require
+              (send
+                (const nil? :File) :expand_path
+                $( str ... )
+                $( str ... )))
+          PATTERN
+
+          def on_send(node)
+            require_with_expand_path?(node) do |file, path|
+              return unless path.source == '__FILE__'
+              add_offense(node, severity: :refactor) do |corrector|
+                corrected_value = file.value
+                corrected_value.slice!(%r{^../}) # take the first ../ off the path
+                corrector.replace(node, "require_relative '#{corrected_value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end