cookstyle 5.14.1 → 5.15.7

data/lib/rubocop/chef/platform_helpers.rb

@@ -0,0 +1,70 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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',
+        '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/cop/chef/correctness/invalid_platform_family_helper.rb

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefCorrectness
+        # Pass valid platform families to the platform_family? helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   platform_family?('redhat')
+        #   platform_family?('sles')
+        #
+        #   # bad
+        #   platform_family?('rhel')
+        #   platform_family?('suse')
+        #
+        class InvalidPlatformFamilyHelper < Cop
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platform families to the platform_family? helper.'.freeze
+
+          def_node_matcher :platform_family_helper?, <<-PATTERN
+            (send nil? :platform_family? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_family_helper?(node) do |plat|
+              plat.to_a.each do |p|
+                add_offense(p, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORM_FAMILIES.key?(p.value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefCorrectness
+        # Pass valid platforms to the platform? helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   platform?('darwin')
+        #   platform?('rhel)
+        #   platform?('sles')
+        #
+        #   # good
+        #   platform?('mac_os_x')
+        #   platform?('redhat)
+        #   platform?('suse')
+        class InvalidPlatformHelper < Cop
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platforms to the platform? helper.'.freeze
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+            (send nil? :platform? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_helper?(node) do |plat|
+              plat.to_a.each do |p|
+                add_offense(p, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORMS.key?(p.value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,32 +32,7 @@ module RuboCop
         #   supports 'windows'
         #
         class InvalidPlatformMetadata < Cop
-          COMMON_TYPOS = {
-            "aws": nil,
-            "archlinux": 'arch',
-            "amazonlinux": 'amazon',
-            "darwin": 'mac_os_x',
-            "debuan": nil,
-            "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
+          include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'metadata.rb "supports" platform is invalid'.freeze
 
@@ -65,14 +40,14 @@ module RuboCop
 
           def on_send(node)
             supports?(node) do |plat|
-              if COMMON_TYPOS[plat.str_content.to_sym]
+              if INVALID_PLATFORMS[plat.str_content]
                 add_offense(plat, location: :expression, message: MSG, severity: :refactor)
               end
             end
           end
 
           def autocorrect(node)
-            correct_string = autocorrect_license_string(node.str_content)
+            correct_string = autocorrect_platform_string(node.str_content)
             if correct_string
               lambda do |corrector|
                 corrector.replace(node.loc.expression, "'#{correct_string}'")
@@ -82,8 +57,8 @@ module RuboCop
 
           # private
 
-          def autocorrect_license_string(bad_string)
-            COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
+          def autocorrect_platform_string(bad_string)
+            INVALID_PLATFORMS[bad_string.delete(',').downcase]
           end
         end
       end

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

@@ -0,0 +1,67 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefCorrectness
+        # Pass valid platforms families to the value_for_platform_family helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   value_for_platform_family(
+        #     %w(rhel sles) => 'foo',
+        #     %w(mac) => 'foo'
+        #   )
+        #
+        #   # good
+        #   value_for_platform_family(
+        #     %w(rhel suse) => 'foo',
+        #     %w(mac_os_x) => 'foo'
+        #   )
+        #
+        class InvalidPlatformValueForPlatformFamilyHelper < Cop
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platform families to the value_for_platform_family helper.'.freeze
+
+          def_node_matcher :value_for_platform_family?, <<-PATTERN
+          (send nil? :value_for_platform_family
+            (hash
+              $...
+            )
+          )
+          PATTERN
+
+          def on_send(node)
+            value_for_platform_family?(node) do |plats|
+              plats.each do |p_hash|
+                if p_hash.key.array_type?
+                  p_hash.key.values.each do |plat|
+                    add_offense(plat, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORM_FAMILIES.key?(plat.value)
+                  end
+                elsif INVALID_PLATFORM_FAMILIES.key?(p_hash.key.value)
+                  add_offense(p_hash.key, location: :expression, message: MSG, severity: :refactor)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefCorrectness
+        # Pass valid platforms to the value_for_platform helper.
+        #
+        # @example
+        #
+        #   # bad
+        #   value_for_platform(
+        #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
+        #     %w(sles) => { 'default' => 'bar' }
+        #   )
+        #   # good
+        #   value_for_platform(
+        #     %w(redhat mac_os_x) => { 'default' => 'foo' },
+        #     %w(opensuseleap) => { 'default' => 'bar' }
+        #   )
+        #
+        class InvalidPlatformValueForPlatformHelper < Cop
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platforms to the value_for_platform helper.'.freeze
+
+          def_node_matcher :value_for_platform?, <<-PATTERN
+          (send nil? :value_for_platform
+            (hash
+              $...
+            )
+          )
+          PATTERN
+
+          def on_send(node)
+            value_for_platform?(node) do |plats|
+              plats.each do |p_hash|
+                if p_hash.key.array_type?
+                  p_hash.key.values.each do |plat|
+                    add_offense(plat, location: :expression, message: MSG, severity: :refactor) if INVALID_PLATFORMS.key?(plat.value)
+                  end
+                elsif INVALID_PLATFORMS.key?(p_hash.key.value)
+                  add_offense(p_hash.key, location: :expression, message: MSG, severity: :refactor)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefCorrectness
+        # Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
+        #
+        # @example
+        #
+        #   # bad
+        #   not_if { File.exist?('/etc/foo/bar') }
+        #
+        #   # good
+        #   not_if { ::File.exist?('/etc/foo/bar') }
+        #
+        class ScopedFileExist < Cop
+          MSG = 'Scope file exist to access the correct File class by using ::File.exist? not File.exist?.'.freeze
+
+          def_node_matcher :unscoped_file_exist?, <<-PATTERN
+          (block (send nil? {:not_if :only_if}) (args) (send $(const nil? :File) {:exist? :exists?} (...)))
+          PATTERN
+
+          def on_block(node)
+            unscoped_file_exist?(node) do |m|
+              add_offense(m, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, '::File')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+#
+# Copyright:: 2019, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefModernize
+        # The allowed actions can now be specified using the `allowed_actions` helper instead of using the @actions or @allowed_actions variables in the resource's initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
+        #
+        # @example
+        #
+        #   # bad
+        #   def initialize(*args)
+        #     super
+        #     @actions = [ :create, :add ]
+        #   end
+        #
+        #   # also bad
+        #   def initialize(*args)
+        #     super
+        #     @allowed_actions = [ :create, :add ]
+        #   end
+        #
+        #   # good
+        #   allowed_actions [ :create, :add ]
+        #
+        class AllowedActionsFromInitialize < Cop
+          include RangeHelp
+
+          MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'.freeze
+
+          def on_def(node)
+            return unless node.method_name == :initialize
+            return if node.body.nil? # nil body is an empty initialize method
+
+            node.body.each_node do |x|
+              if x.assignment? && !x.node_parts.empty? && %i(@actions @allowed_actions).include?(x.node_parts.first)
+                add_offense(x, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+
+          def_node_search :action_methods?, '(send nil? {:actions :allowed_actions} ... )'
+
+          def_node_search :intialize_method, '(def :initialize ... )'
+
+          def autocorrect(node)
+            lambda do |corrector|
+              # insert the new allowed_actions call above the initialize method, but not if one already exists (this is sadly common)
+              unless action_methods?(processed_source.ast)
+                initialize_node = intialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "allowed_actions #{node.descendants.first.source}\n\n")
+              end
+
+              # remove the variable from the initialize method
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end