cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/chef/platform_helpers.rb

@@ -1,72 +1,72 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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 Chef
-    # common helpers for Platforms in Chef Infra Cookbooks
-    module PlatformHelpers
-      # a mapping of invalid platform family values to valid platform family
-      INVALID_PLATFORM_FAMILIES = {
-        'archlinux' => 'arch',
-        'centos' => 'rhel',
-        'darwin' => 'mac_os_x',
-        'debuan' => 'debian',
-        'linux' => nil,
-        'mac_os_x_server' => 'mac_os_x',
-        'macos' => 'mac_os_x',
-        'macosx' => 'mac_os_x',
-        'mingw32' => 'windows',
-        'mswin' => 'windows',
-        'opensuse' => 'suse',
-        'opensuseleap' => 'suse',
-        'oracle' => 'rhel',
-        'redhat' => 'rhel',
-        'scientific' => 'rhel',
-        'sles' => 'suse',
-        'ubuntu' => 'debian',
-      }.freeze
-
-      # a mapping of invalid platforms values to valid platforms
-      INVALID_PLATFORMS = {
-        'aws' => nil,
-        'archlinux' => 'arch',
-        'amazonlinux' => 'amazon',
-        'darwin' => 'mac_os_x',
-        'debuan' => 'debian',
-        'mingw32' => 'windows',
-        'mswin' => 'windows',
-        'macos' => 'mac_os_x',
-        'macosx' => 'mac_os_x',
-        'mac_os_x_server' => 'mac_os_x',
-        'mint' => 'linuxmint',
-        'linux' => nil,
-        'oel' => 'oracle',
-        'oraclelinux' => 'oracle',
-        'rhel' => 'redhat',
-        'schientific' => 'scientific',
-        'scientificlinux' => 'scientific',
-        'sles' => 'suse',
-        'solaris' => 'solaris2',
-        'ubundu' => 'ubuntu',
-        'ubunth' => 'ubuntu',
-        'ubunutu' => 'ubuntu',
-        'windwos' => 'windows',
-        'xcp' => nil,
-      }.freeze
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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 Chef
+    # common helpers for Platforms in Chef Infra Cookbooks
+    module PlatformHelpers
+      # a mapping of invalid platform family values to valid platform family
+      INVALID_PLATFORM_FAMILIES = {
+        'archlinux' => 'arch',
+        'centos' => 'rhel',
+        'darwin' => 'mac_os_x',
+        'debuan' => 'debian',
+        'linux' => nil,
+        'mac_os_x_server' => 'mac_os_x',
+        'macos' => 'mac_os_x',
+        'macosx' => 'mac_os_x',
+        'mingw32' => 'windows',
+        'mswin' => 'windows',
+        'opensuse' => 'suse',
+        'opensuseleap' => 'suse',
+        'oracle' => 'rhel',
+        'redhat' => 'rhel',
+        'scientific' => 'rhel',
+        'sles' => 'suse',
+        'ubuntu' => 'debian',
+      }.freeze
+
+      # a mapping of invalid platforms values to valid platforms
+      INVALID_PLATFORMS = {
+        'aws' => nil,
+        'archlinux' => 'arch',
+        'amazonlinux' => 'amazon',
+        'darwin' => 'mac_os_x',
+        'debuan' => 'debian',
+        'mingw32' => 'windows',
+        'mswin' => 'windows',
+        'macos' => 'mac_os_x',
+        'macosx' => 'mac_os_x',
+        'mac_os_x_server' => 'mac_os_x',
+        'mint' => 'linuxmint',
+        'linux' => nil,
+        'oel' => 'oracle',
+        'oraclelinux' => 'oracle',
+        'rhel' => 'redhat',
+        'schientific' => 'scientific',
+        'scientificlinux' => 'scientific',
+        'sles' => 'suse',
+        'solaris' => 'solaris2',
+        'ubundu' => 'ubuntu',
+        'ubunth' => 'ubuntu',
+        'ubunutu' => 'ubuntu',
+        'windwos' => 'windows',
+        'xcp' => nil,
+      }.freeze
+    end
+  end
+end

data/lib/rubocop/chef.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-module RuboCop
-  # RuboCop Chef project namespace
-  module Chef
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'cookstyle.yml').freeze
-    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(*constants(false))
-  end
-end
+# frozen_string_literal: true
+module RuboCop
+  # RuboCop Chef project namespace
+  module Chef
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'cookstyle.yml').freeze
+    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(*constants(false))
+  end
+end

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

@@ -1,61 +1,61 @@
-# 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
-        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   template '/etc/foo' do
-        #     mode '0644'
-        #     source 'foo.erb'
-        #     only_if { 'test -f /etc/foo' }
-        #   end
-        #
-        #   ### correct
-        #   template '/etc/foo' do
-        #     mode '0644'
-        #     source 'foo.erb'
-        #     only_if 'test -f /etc/foo'
-        #   end
-        #
-        class BlockGuardWithOnlyString < Base
-          extend AutoCorrector
-
-          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.'
-
-          def_node_matcher :block_guard_with_only_string?, <<-PATTERN
-            (block (send nil? ${:not_if :only_if}) (args) (str $_) )
-          PATTERN
-
-          def on_block(node)
-            block_guard_with_only_string?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                new_val = "#{node.method_name} #{node.body.source}"
-                corrector.replace(node, new_val)
-              end
-            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
+        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { 'test -f /etc/foo' }
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if 'test -f /etc/foo'
+        #   end
+        #
+        class BlockGuardWithOnlyString < Base
+          extend AutoCorrector
+
+          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.'
+
+          def_node_matcher :block_guard_with_only_string?, <<-PATTERN
+            (block (send nil? ${:not_if :only_if}) (args) (str $_) )
+          PATTERN
+
+          def on_block(node)
+            block_guard_with_only_string?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                new_val = "#{node.method_name} #{node.body.source}"
+                corrector.replace(node, new_val)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# 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
-        # Use `raise` to force Chef Infra Client to fail instead of using `Chef::Application.fatal`, which masks the full stack trace of the failure and makes debugging difficult.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Chef::Application.fatal!('Something horrible happened!')
-        #
-        #   ### correct
-        #   raise "Something horrible happened!"
-        #
-        class ChefApplicationFatal < Base
-          extend AutoCorrector
-
-          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'
-          RESTRICT_ON_SEND = [:fatal!].freeze
-
-          def_node_matcher :application_fatal?, <<-PATTERN
-            (send
-              (const
-                (const nil? :Chef) :Application) :fatal!
-              $( ... ))
-          PATTERN
-
-          def on_send(node)
-            application_fatal?(node) do |val|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "raise(#{val.source})")
-              end
-            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
+        # Use `raise` to force Chef Infra Client to fail instead of using `Chef::Application.fatal`, which masks the full stack trace of the failure and makes debugging difficult.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Chef::Application.fatal!('Something horrible happened!')
+        #
+        #   ### correct
+        #   raise "Something horrible happened!"
+        #
+        class ChefApplicationFatal < Base
+          extend AutoCorrector
+
+          MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'
+          RESTRICT_ON_SEND = [:fatal!].freeze
+
+          def_node_matcher :application_fatal?, <<-PATTERN
+            (send
+              (const
+                (const nil? :Chef) :Application) :fatal!
+              $( ... ))
+          PATTERN
+
+          def on_send(node)
+            application_fatal?(node) do |val|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "raise(#{val.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,69 +1,69 @@
-# 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
-        # Don't use Ruby to shellout in a `only_if` / `not_if` conditional. Any string value used in an `only_if` / `not_if` is executed in your system's shell and the return code of the command is the result for the `not_if` / `only_if` determination.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   cookbook_file '/logs/foo/error.log' do
-        #     source 'error.log'
-        #     only_if { system('wget https://www.bar.com/foobar.txt -O /dev/null') }
-        #   end
-        #
-        #   cookbook_file '/logs/foo/error.log' do
-        #     source 'error.log'
-        #     only_if { shell_out('wget https://www.bar.com/foobar.txt -O /dev/null').exitstatus == 0 }
-        #   end
-        #
-        #   ### correct
-        #   cookbook_file '/logs/foo/error.log' do
-        #     source 'error.log'
-        #     only_if 'wget https://www.bar.com/foobar.txt -O /dev/null'
-        #   end
-        #
-        class ConditionalRubyShellout < Base
-          extend AutoCorrector
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = "Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes."
-
-          def_node_matcher :conditional_shellout?, <<-PATTERN
-          (block
-            (send nil? ${:only_if :not_if})
-            (args)
-            {(send nil? :system $(str ...))
-             (send (send (send nil? :shell_out $(str ...)) :exitstatus) :== (int 0))
-              })
-          PATTERN
-
-          def on_block(node)
-            conditional_shellout?(node) do |type, val|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "#{type} #{val.source}")
-              end
-            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
+        # Don't use Ruby to shellout in a `only_if` / `not_if` conditional. Any string value used in an `only_if` / `not_if` is executed in your system's shell and the return code of the command is the result for the `not_if` / `only_if` determination.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     only_if { system('wget https://www.bar.com/foobar.txt -O /dev/null') }
+        #   end
+        #
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     only_if { shell_out('wget https://www.bar.com/foobar.txt -O /dev/null').exitstatus == 0 }
+        #   end
+        #
+        #   ### correct
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     only_if 'wget https://www.bar.com/foobar.txt -O /dev/null'
+        #   end
+        #
+        class ConditionalRubyShellout < Base
+          extend AutoCorrector
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes."
+
+          def_node_matcher :conditional_shellout?, <<-PATTERN
+          (block
+            (send nil? ${:only_if :not_if})
+            (args)
+            {(send nil? :system $(str ...))
+             (send (send (send nil? :shell_out $(str ...)) :exitstatus) :== (int 0))
+              })
+          PATTERN
+
+          def on_block(node)
+            conditional_shellout?(node) do |type, val|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{type} #{val.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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 Correctness
-        # The `dnf_package` resource does not support the `allow_downgrades` property.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   dnf_package 'nginx' do
-        #     version '1.2.3'
-        #     allow_downgrades true
-        #   end
-        #
-        #   ### correct
-        #   dnf_package 'nginx' do
-        #     version '1.2.3'
-        #   end
-        #
-        class DnfPackageAllowDowngrades < Base
-          include RangeHelp
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = 'dnf_package does not support the allow_downgrades property'
-
-          def on_block(node)
-            match_property_in_resource?(:dnf_package, :allow_downgrades, node) do |prop|
-              add_offense(prop, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: prop.loc.expression, side: :left))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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 Correctness
+        # The `dnf_package` resource does not support the `allow_downgrades` property.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   dnf_package 'nginx' do
+        #     version '1.2.3'
+        #     allow_downgrades true
+        #   end
+        #
+        #   ### correct
+        #   dnf_package 'nginx' do
+        #     version '1.2.3'
+        #   end
+        #
+        class DnfPackageAllowDowngrades < Base
+          include RangeHelp
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = 'dnf_package does not support the allow_downgrades property'
+
+          def on_block(node)
+            match_property_in_resource?(:dnf_package, :allow_downgrades, node) do |prop|
+              add_offense(prop, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: prop.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end