cookstyle-ng 8.0.0

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

@@ -0,0 +1,89 @@
+# 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
+        # Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ::File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::File.open('/proc/1/comm').chomp == 'systemd'
+        #   File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.open('/proc/1/comm').chomp == 'systemd'
+        #   IO.read('/proc/1/comm').chomp == 'systemd'
+        #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #   only_if 'test -f /bin/systemctl && /bin/systemctl'
+        #
+        #   ### correct
+        #   node['init_package'] == 'systemd'
+        #   only_if { node['init_package'] == 'systemd' }
+        #
+        class NodeInitPackage < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'"
+          RESTRICT_ON_SEND = [:open, :read, :exist?, :==, :not_if, :only_if].freeze
+
+          def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
+            (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :proc_1_comm_exists?, <<-PATTERN
+            (send
+              (const
+                {(cbase) nil?} :File) :exist?
+              (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :compare_init_system?, <<-PATTERN
+            (send
+              (send {#file_reads_proc_1_comm? (send #file_reads_proc_1_comm? :gets) } :chomp)
+                :== (str "systemd"))
+          PATTERN
+
+          def_node_matcher :file_systemd_conditional?, <<~PATTERN
+            (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
+          PATTERN
+
+          def on_send(node)
+            compare_init_system?(node) do
+              # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
+              node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "node['init_package'] == 'systemd'")
+              end
+            end
+
+            file_systemd_conditional?(node) do |conditional|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(conditional, "{ node['init_package'] == 'systemd' }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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
+        # Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['roles'].include?('foo')
+        #
+        #   ### correct
+        #   node.role?('foo')
+        #
+        class NodeRolesInclude < Base
+          extend AutoCorrector
+
+          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
+          RESTRICT_ON_SEND = [:include?].freeze
+
+          def_node_matcher :node_role_include?, <<-PATTERN
+          (send
+            (send
+              (send nil? :node) :[]
+              (str "roles")) :include?
+            $(...))
+          PATTERN
+
+          def on_send(node)
+            node_role_include?(node) do |val|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "node.role?(#{val.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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 Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which should be used instead as it doesn't require forking the ohai cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'ohai::default'
+        #   include_recipe 'ohai'
+        #
+        class IncludingOhaiDefaultRecipe < Base
+          MSG = "Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely"
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :ohai_recipe_usage?, <<-PATTERN
+            (send nil? :include_recipe (str {"ohai" "ohai::default"}))
+          PATTERN
+
+          def on_send(node)
+            ohai_recipe_usage?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   openssl_rsa_key '/etc/httpd/ssl/server.key' do
+        #     key_length 2048
+        #   end
+        #
+        #   ### correct
+        #   openssl_rsa_private_key '/etc/httpd/ssl/server.key' do
+        #     key_length 2048
+        #   end
+        #
+        class OpensslRsaKeyResource < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:openssl_rsa_key].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.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
+        # The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   openssl_x509 '/etc/httpd/ssl/mycert.pem' do
+        #     common_name 'www.f00bar.com'
+        #     org 'Foo Bar'
+        #     org_unit 'Lab'
+        #     country 'US'
+        #   end
+        #
+        #   ### correct
+        #   openssl_x509_certificate '/etc/httpd/ssl/mycert.pem' do
+        #     common_name 'www.f00bar.com'
+        #     org 'Foo Bar'
+        #     org_unit 'Lab'
+        #     country 'US'
+        #   end
+        #
+        class OpensslX509Resource < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.4'
+
+          MSG = 'The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:openssl_x509].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.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
+        # The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   osx_config_profile 'Install screensaver profile' do
+        #     profile 'screensaver/com.company.screensaver.mobileconfig'
+        #   end
+        #
+        #   ### correct
+        #   osx_profile 'Install screensaver profile' do
+        #     profile 'screensaver/com.company.screensaver.mobileconfig'
+        #   end
+        #
+        class OsxConfigProfileResource < Base
+          extend AutoCorrector
+
+          MSG = 'The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:osx_config_profile].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 using the powershell_script resource to run Expand-Archive
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Expand website' do
+        #     code 'Expand-Archive "C:\\file.zip" -DestinationPath "C:\\inetpub\\wwwroot\\" -Force'
+        #   end
+        #
+        class PowershellScriptExpandArchive < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^expand-archive/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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
+        # PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
+        #     guard_interpreter :powershell_script
+        #   end
+        #
+        #   ### correct
+        #   powershell_script 'Create Directory' do
+        #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
+        #   end
+        #
+        #   batch 'Create Directory' do
+        #     code "mkdir C:\mydir"
+        #   end
+        #
+        class PowerShellGuardInterpreter < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '13.0'
+
+          MSG = 'PowerShell is already set as the default guard interpreter for `powershell_script` and `batch` resources in Chef Infra Client 13 and later and does not need to be specified.'
+
+          def on_block(node)
+            match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
+              return unless interpreter.arguments.first.source == ':powershell_script'
+              add_offense(interpreter, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: interpreter.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/powershell_install_package.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
+        # Use the powershell_package resource built into Chef Infra Client instead of the powershell_script resource to run Install-Package
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Expand website' do
+        #     code 'Install-Package -Name docker'
+        #   end
+        #
+        #  ### correct
+        #  powershell_package 'docker'
+        #
+        class PowershellInstallPackage < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.16'
+
+          MSG = 'Use the powershell_package resource built into Chef Infra Client 12.16+ instead of using Install-Package in a powershell_script resource'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^install-package\s/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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 windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource to run Install-WindowsFeature or Add-WindowsFeature
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Install Feature' do
+        #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
+        #   end
+        #
+        #  ### correct
+        #  windows_feature 'Net-framework-Core' do
+        #    action :install
+        #    install_method :windows_feature_powershell
+        #  end
+        #
+        class PowershellInstallWindowsFeature < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Use the windows_feature resource built into Chef Infra Client 14+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource'
+
+          def on_block(node)
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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 Modernize
+        # When using properties in a custom resource you should use name_property not the legacy name_attribute from the days of attributes
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :bob, String, name_attribute: true
+        #
+        #   ### correct
+        #   property :bob, String, name_property: true
+        #
+        class PropertyWithNameAttribute < Base
+          extend AutoCorrector
+
+          MSG = 'Resource property sets name_attribute instead of name_property'
+          RESTRICT_ON_SEND = [:property].freeze
+
+          # match on a property that has any name and any type and a hash that
+          # contains name_attribute true. The hash pairs are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :property_with_name_attribute?, <<-PATTERN
+            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
+          PATTERN
+
+          def on_send(node)
+            property_with_name_attribute?(node) do |name_attribute|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(name_attribute, 'name_property: true')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end