cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb

@@ -1,116 +1,116 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020-2022, 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 RedundantCode
-        # Use the `:create_if_missing` action instead of `not_if` with a `::File.exist(FOO)` check.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   cookbook_file '/logs/foo/error.log' do
-        #     source 'error.log'
-        #     owner 'root'
-        #     group 'root'
-        #     mode '0644'
-        #     not_if { ::File.exists?('/logs/foo/error.log') }
-        #   end
-        #
-        #   remote_file 'Download file' do
-        #     path '/foo/bar'
-        #     source 'https://foo.com/bar'
-        #     owner 'root'
-        #     group 'root'
-        #     mode '0644'
-        #     not_if { ::File.exist?('/foo/bar') }
-        #   end
-        #
-        #   ### correct
-        #   cookbook_file '/logs/foo/error.log' do
-        #     source 'error.log'
-        #     owner 'root'
-        #     group 'root'
-        #     mode '0644'
-        #     action :create_if_missing
-        #   end
-        #
-        #   remote_file 'Download file' do
-        #     path '/foo/bar'
-        #     source 'https://foo.com/bar'
-        #     owner 'root'
-        #     group 'root'
-        #     mode '0644'
-        #     action :create_if_missing
-        #   end
-        #
-        class UseCreateIfMissing < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
-          RESOURCES = %i(cookbook_file file remote_directory cron_d remote_file template).freeze
-
-          def_node_matcher :file_exist_value, <<-PATTERN
-          (send (const {nil? (cbase)} :File) {:exist? :exists?} $(...))
-          PATTERN
-
-          def_node_search :has_action?, '(send nil? :action ...)'
-
-          def_node_search :create_action, '(send nil? :action $sym)'
-
-          def_node_search :path_property_node, '(send nil? :path $...)'
-
-          def on_block(node)
-            match_property_in_resource?(RESOURCES, :not_if, node) do |prop|
-              # if it's not a block type then it's not a ruby block with a file.exist
-              return unless prop.block_type?
-
-              file_exist_value(prop.body) do |exists_content| # check the contents of the ruby block that's passed
-                # not an offense if:
-                #   - The resource block name (the last arg of the send) doesn't match the exists check content
-                #   - If a path property is used it doesn't match the exists check content
-                return unless exists_content == node.send_node.last_argument ||
-                              exists_content == path_property_node(node)&.first&.first
-
-                # we have an action so check if it is :create. If that's the case we can replace that value
-                # and delete the not_if line. Otherwise it's an action like :remove and while the whole resource
-                # no longer makes sense that's not our problem here.
-                create_action(node) do |create_action|
-                  return unless create_action == s(:sym, :create)
-                  add_offense(prop, severity: :refactor) do |corrector|
-                    corrector.replace(create_action, ':create_if_missing')
-                    corrector.remove(range_by_whole_lines(prop.source_range, include_final_newline: true))
-                  end
-                  return
-                end
-
-                # if we got this far we didn't return above when we had an action
-                # so we can just replace the not_if line with a new :create_if_missing action
-                add_offense(prop, severity: :refactor) do |corrector|
-                  corrector.replace(prop, 'action :create_if_missing')
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020-2022, 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 RedundantCode
+        # Use the `:create_if_missing` action instead of `not_if` with a `::File.exist(FOO)` check.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     not_if { ::File.exists?('/logs/foo/error.log') }
+        #   end
+        #
+        #   remote_file 'Download file' do
+        #     path '/foo/bar'
+        #     source 'https://foo.com/bar'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     not_if { ::File.exist?('/foo/bar') }
+        #   end
+        #
+        #   ### correct
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     action :create_if_missing
+        #   end
+        #
+        #   remote_file 'Download file' do
+        #     path '/foo/bar'
+        #     source 'https://foo.com/bar'
+        #     owner 'root'
+        #     group 'root'
+        #     mode '0644'
+        #     action :create_if_missing
+        #   end
+        #
+        class UseCreateIfMissing < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
+          RESOURCES = %i(cookbook_file file remote_directory cron_d remote_file template).freeze
+
+          def_node_matcher :file_exist_value, <<-PATTERN
+          (send (const {nil? (cbase)} :File) {:exist? :exists?} $(...))
+          PATTERN
+
+          def_node_search :has_action?, '(send nil? :action ...)'
+
+          def_node_search :create_action, '(send nil? :action $sym)'
+
+          def_node_search :path_property_node, '(send nil? :path $...)'
+
+          def on_block(node)
+            match_property_in_resource?(RESOURCES, :not_if, node) do |prop|
+              # if it's not a block type then it's not a ruby block with a file.exist
+              return unless prop.block_type?
+
+              file_exist_value(prop.body) do |exists_content| # check the contents of the ruby block that's passed
+                # not an offense if:
+                #   - The resource block name (the last arg of the send) doesn't match the exists check content
+                #   - If a path property is used it doesn't match the exists check content
+                return unless exists_content == node.send_node.last_argument ||
+                              exists_content == path_property_node(node)&.first&.first
+
+                # we have an action so check if it is :create. If that's the case we can replace that value
+                # and delete the not_if line. Otherwise it's an action like :remove and while the whole resource
+                # no longer makes sense that's not our problem here.
+                create_action(node) do |create_action|
+                  return unless create_action == s(:sym, :create)
+                  add_offense(prop, severity: :refactor) do |corrector|
+                    corrector.replace(create_action, ':create_if_missing')
+                    corrector.remove(range_by_whole_lines(prop.source_range, include_final_newline: true))
+                  end
+                  return
+                end
+
+                # if we got this far we didn't return above when we had an action
+                # so we can just replace the not_if line with a new :create_if_missing action
+                add_offense(prop, severity: :refactor) do |corrector|
+                  corrector.replace(prop, 'action :create_if_missing')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/security/ssh_private_key.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2021-2022, 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 Security
-        # Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   file '/Users/bob_bobberson/.ssh/id_rsa' do
-        #     content '-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----'
-        #     mode '600'
-        #   end
-        #
-        class SshPrivateKey < Base
-          MSG = 'Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.'
-
-          def on_send(node)
-            return unless node.arguments?
-            node.arguments.each do |arg|
-              next unless arg.str_type? || arg.dstr_type?
-
-              if arg.value.start_with?('-----BEGIN RSA PRIVATE', '-----BEGIN EC PRIVATE') # cookstyle: disable Chef/Security/SshPrivateKey
-                add_offense(node, severity: :warning)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2021-2022, 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 Security
+        # Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   file '/Users/bob_bobberson/.ssh/id_rsa' do
+        #     content '-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----'
+        #     mode '600'
+        #   end
+        #
+        class SshPrivateKey < Base
+          MSG = 'Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.'
+
+          def on_send(node)
+            return unless node.arguments?
+            node.arguments.each do |arg|
+              next unless arg.str_type? || arg.dstr_type?
+
+              if arg.value.start_with?('-----BEGIN RSA PRIVATE', '-----BEGIN EC PRIVATE')
+                add_offense(node, severity: :warning)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.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 Sharing
-        # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect that actual maintainer of the cookbook.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   maintainer 'YOUR_COMPANY_NAME'
-        #   maintainer_email 'YOUR_EMAIL'
-        #   maintainer 'The Authors'
-        #   maintainer_email 'you@example.com'
-        #   ### correct
-        #   maintainer 'Bob Bobberson'
-        #   maintainer_email 'bob@bobberson.com'
-        #
-        class DefaultMetadataMaintainer < Base
-          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'
-          RESTRICT_ON_SEND = [:maintainer, :maintainer_email].freeze
-
-          def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
-
-          def on_send(node)
-            default_metadata?(node) do
-              add_offense(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 Sharing
+        # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect that actual maintainer of the cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   maintainer 'YOUR_COMPANY_NAME'
+        #   maintainer_email 'YOUR_EMAIL'
+        #   maintainer 'The Authors'
+        #   maintainer_email 'you@example.com'
+        #   ### correct
+        #   maintainer 'Bob Bobberson'
+        #   maintainer_email 'bob@bobberson.com'
+        #
+        class DefaultMetadataMaintainer < Base
+          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'
+          RESTRICT_ON_SEND = [:maintainer, :maintainer_email].freeze
+
+          def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
+
+          def on_send(node)
+            default_metadata?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb

@@ -1,47 +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 Sharing
-        # metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   license ''
-        #
-        #   ### correct
-        #   license 'Apache-2.0'
-        #
-        class EmptyMetadataField < Base
-          MSG = 'Cookbook metadata.rb contains a field with an empty string.'
-
-          def_node_matcher :field?, '(send nil? _ $str ...)'
-
-          def on_send(node)
-            field?(node) do |str|
-              return unless str.value.empty?
-              add_offense(str, 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 Sharing
+        # metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   license ''
+        #
+        #   ### correct
+        #   license 'Apache-2.0'
+        #
+        class EmptyMetadataField < Base
+          MSG = 'Cookbook metadata.rb contains a field with an empty string.'
+
+          def_node_matcher :field?, '(send nil? _ $str ...)'
+
+          def on_send(node)
+            field?(node) do |str|
+              return unless str.value.empty?
+              add_offense(str, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb

@@ -1,55 +1,55 @@
-# 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 Sharing
-        # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :foo, String
-        #
-        #   ### correct
-        #   property :foo, String, description: "Set the important thing to..."
-        #
-        class IncludePropertyDescriptions < Base
-          extend TargetChefVersion
-
-          minimum_target_chef_version '13.9'
-
-          MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
-          RESTRICT_ON_SEND = [:property].freeze
-
-          # any method named property being called with a symbol argument and anything else
-          def_node_matcher :property?, '(send nil? :property (sym _) ...)'
-
-          # hash that contains description in any order (that's the <> bit)
-          def_node_search :description_hash?, '(hash <(pair (sym :description) ...) ...>)'
-
-          def on_send(node)
-            property?(node) do
-              add_offense(node, severity: :refactor) unless description_hash?(node)
-            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 Sharing
+        # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :foo, String
+        #
+        #   ### correct
+        #   property :foo, String, description: "Set the important thing to..."
+        #
+        class IncludePropertyDescriptions < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '13.9'
+
+          MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
+          RESTRICT_ON_SEND = [:property].freeze
+
+          # any method named property being called with a symbol argument and anything else
+          def_node_matcher :property?, '(send nil? :property (sym _) ...)'
+
+          # hash that contains description in any order (that's the <> bit)
+          def_node_search :description_hash?, '(hash <(pair (sym :description) ...) ...>)'
+
+          def on_send(node)
+            property?(node) do
+              add_offense(node, severity: :refactor) unless description_hash?(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end