cookstyle 7.32.8 → 8.1.1

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

@@ -1,46 +1,46 @@
-# frozen_string_literal: true
-
-#
-# Copyright:: Copyright 2020, Chef Software Inc.
-#
-# 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
-        # The OpenSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should no longer be used. This helper would generate a random password that would be used when a data bag or attribute was no present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
-        #
-        #   ### incorrect
-        #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
-        #   basic_auth_password = secure_password
-        #
-        class OpenSSLPasswordHelpers < Base
-          MSG = 'The `secure_password` helper from the openssl cookbooks `Opscode::OpenSSL::Password` class should not be used to generate passwords.'
-
-          def_node_matcher :openssl_helper?, <<~PATTERN
-            (const
-              (const
-                (const nil? :Opscode) :OpenSSL) :Password)
-          PATTERN
-
-          def on_const(node)
-            openssl_helper?(node) do
-              add_offense(node, severity: :warning)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+# Copyright:: Copyright 2020, Chef Software Inc.
+#
+# 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
+        # The OpenSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should no longer be used. This helper would generate a random password that would be used when a data bag or attribute was no present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
+        #
+        #   ### incorrect
+        #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
+        #   basic_auth_password = secure_password
+        #
+        class OpenSSLPasswordHelpers < Base
+          MSG = 'The `secure_password` helper from the openssl cookbooks `Opscode::OpenSSL::Password` class should not be used to generate passwords.'
+
+          def_node_matcher :openssl_helper?, <<~PATTERN
+            (const
+              (const
+                (const nil? :Opscode) :OpenSSL) :Password)
+          PATTERN
+
+          def on_const(node)
+            openssl_helper?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-# 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
-        # Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   powershell_script 'Cleanup old files' do
-        #     code 'Remove-Item C:\Windows\foo\bar.txt'
-        #     only_if { ::File.exist?('C:\\Windows\\foo\\bar.txt') }
-        #   end
-        #
-        #  ### correct
-        #  file 'C:\Windows\foo\bar.txt' do
-        #    action :delete
-        #  end
-        #
-        class PowershellScriptDeleteFile < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item 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?(/^remove-item/i) &&
-                            !property_data.include?('*')
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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
+        # Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   powershell_script 'Cleanup old files' do
+        #     code 'Remove-Item C:\Windows\foo\bar.txt'
+        #     only_if { ::File.exist?('C:\\Windows\\foo\\bar.txt') }
+        #   end
+        #
+        #  ### correct
+        #  file 'C:\Windows\foo\bar.txt' do
+        #    action :delete
+        #  end
+        #
+        class PowershellScriptDeleteFile < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item 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?(/^remove-item/i) &&
+                            !property_data.include?('*')
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,50 +1,50 @@
-# 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 Correctness
-        # Use Ruby's built-in `File.exist?('C:\somefile')` method instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load.
-        #
-        # @example
-        #
-        #  ### incorrect
-        #  powershell_out('Test-Path "C:\\Program Files\\LAPS\\CSE\\AdmPwd.dll"').stdout.strip == 'True'
-        #
-        #  ### correct
-        #  ::File.exist?('C:\Program Files\LAPS\CSE\AdmPwd.dll')
-        #
-        class PowershellFileExists < Base
-          RESTRICT_ON_SEND = [:powershell_out, :powershell_out!].freeze
-          MSG = "Use Ruby's built-in `File.exist?('C:\\somefile')` method instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load."
-
-          def_node_matcher :powershell_out_exists?, <<-PATTERN
-            (send nil? {:powershell_out :powershell_out!} (str $_))
-          PATTERN
-
-          def on_send(node)
-            powershell_out_exists?(node) do |exists_string|
-              return unless exists_string.match?(/^Test-Path/)
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # Use Ruby's built-in `File.exist?('C:\somefile')` method instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #  powershell_out('Test-Path "C:\\Program Files\\LAPS\\CSE\\AdmPwd.dll"').stdout.strip == 'True'
+        #
+        #  ### correct
+        #  ::File.exist?('C:\Program Files\LAPS\CSE\AdmPwd.dll')
+        #
+        class PowershellFileExists < Base
+          RESTRICT_ON_SEND = [:powershell_out, :powershell_out!].freeze
+          MSG = "Use Ruby's built-in `File.exist?('C:\\somefile')` method instead of executing PowerShell's `Test-Path` cmdlet, which takes longer to load."
+
+          def_node_matcher :powershell_out_exists?, <<-PATTERN
+            (send nil? {:powershell_out :powershell_out!} (str $_))
+          PATTERN
+
+          def on_send(node)
+            powershell_out_exists?(node) do |exists_string|
+              return unless exists_string.match?(/^Test-Path/)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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
-        # Resource properties or attributes should always define a type to help users understand the correct allowed values.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :size, regex: /^\d+[KMGTP]$/
-        #   attribute :size, regex: /^\d+[KMGTP]$/
-        #
-        #   ### correct
-        #   property :size, String, regex: /^\d+[KMGTP]$/
-        #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
-        #
-        class PropertyWithoutType < Base
-          MSG = 'Resource properties or attributes should always define a type to help users understand the correct allowed values.'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :property_without_type?, <<-PATTERN
-          (send nil? {:property :attribute}
-            (sym _)
-            $(hash
-
-              ...
-            )?
-          )
-          PATTERN
-
-          def on_send(node)
-            property_without_type?(node) do |hash_vals|
-              return if hash_vals&.first&.keys&.include?(s(:sym, :kind_of))
-
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # Resource properties or attributes should always define a type to help users understand the correct allowed values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :size, regex: /^\d+[KMGTP]$/
+        #   attribute :size, regex: /^\d+[KMGTP]$/
+        #
+        #   ### correct
+        #   property :size, String, regex: /^\d+[KMGTP]$/
+        #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
+        #
+        class PropertyWithoutType < Base
+          MSG = 'Resource properties or attributes should always define a type to help users understand the correct allowed values.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :property_without_type?, <<-PATTERN
+          (send nil? {:property :attribute}
+            (sym _)
+            $(hash
+
+              ...
+            )?
+          )
+          PATTERN
+
+          def on_send(node)
+            property_without_type?(node) do |hash_vals|
+              return if hash_vals&.first&.keys&.include?(s(:sym, :kind_of))
+
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# 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 Correctness
-        # Chef Infra Client uses properties in several resources to track state. These should not be set in recipes as they break the internal workings of the Chef Infra Client
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   service 'foo' do
-        #     running true
-        #     action [:start, :enable]
-        #   end
-        #
-        #   ### correct
-        #   service 'foo' do
-        #     action [:start, :enable]
-        #   end
-        #
-        class ResourceSetsInternalProperties < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'
-
-          def on_block(node)
-            match_property_in_resource?(:service, 'running', node) do |prop|
-              add_offense(prop, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # Chef Infra Client uses properties in several resources to track state. These should not be set in recipes as they break the internal workings of the Chef Infra Client
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   service 'foo' do
+        #     running true
+        #     action [:start, :enable]
+        #   end
+        #
+        #   ### correct
+        #   service 'foo' do
+        #     action [:start, :enable]
+        #   end
+        #
+        class ResourceSetsInternalProperties < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Do not set properties used internally by Chef Infra Client to track the system state.'
+
+          def on_block(node)
+            match_property_in_resource?(:service, 'running', node) do |prop|
+              add_offense(prop, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,50 +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 Correctness
-        # Use name properties instead of setting the name property in a resource. Setting the name property directly causes notification and reporting issues.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   service 'foo' do
-        #    name 'bar'
-        #   end
-        #
-        #   ### correct
-        #   service 'foo' do
-        #    service_name 'bar'
-        #   end
-        #
-        class ResourceSetsNameProperty < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'Resource sets the name property in the resource instead of using a name_property.'
-
-          def on_block(node)
-            match_property_in_resource?(nil, 'name', node) do |name_node|
-              add_offense(name_node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # Use name properties instead of setting the name property in a resource. Setting the name property directly causes notification and reporting issues.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   service 'foo' do
+        #    name 'bar'
+        #   end
+        #
+        #   ### correct
+        #   service 'foo' do
+        #    service_name 'bar'
+        #   end
+        #
+        class ResourceSetsNameProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'Resource sets the name property in the resource instead of using a name_property.'
+
+          def on_block(node)
+            match_property_in_resource?(nil, 'name', node) do |name_node|
+              add_offense(name_node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end