cookstyle 6.12.6 → 6.15.9

data/cookstyle.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['thom@chef.io', 'tsmith@chef.io']
   spec.summary       = 'Cookstyle is a code linting tool that helps you to write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.'
   spec.license       = 'Apache-2.0'
+  spec.homepage      = 'https://docs.chef.io/workstation/cookstyle/'
   spec.required_ruby_version = '>= 2.4'
 
   # the gemspec and Gemfile are necessary for appbundling of the gem

data/lib/cookstyle.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 require_relative 'cookstyle/version'
 
-require 'pathname'
-require 'yaml'
+require 'pathname' unless defined?(Pathname)
+require 'yaml' unless defined?(YAML)
 
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
-require 'rubocop/monkey_patches/comment_config.rb'
+require_relative 'rubocop/monkey_patches/comment_config.rb'
 
 # monkey patches needed for the TargetChefVersion config option
-require 'rubocop/monkey_patches/config.rb'
-require 'rubocop/monkey_patches/cop.rb'
-require 'rubocop/monkey_patches/team.rb'
-require 'rubocop/monkey_patches/registry_cop.rb'
+require_relative 'rubocop/monkey_patches/config.rb'
+require_relative 'rubocop/monkey_patches/base.rb'
+require_relative 'rubocop/monkey_patches/team.rb'
+require_relative 'rubocop/monkey_patches/registry_cop.rb'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.12.6" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.88.0'
+  VERSION = "6.15.9" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.89.1'
 end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, 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
+      # Default actions in resources should be symbols or an array of symbols.
+      #
+      # @example
+      #
+      #   # bad
+      #   default_action 'create'
+      #
+      #   # good
+      #   default_action :create
+      #
+      module ChefCorrectness
+        class InvalidDefaultAction < Cop
+          MSG = 'Default actions in resources should be symbols or an array of symbols.'
+
+          def_node_matcher :default_action?, '(send nil? :default_action $_)'
+
+          def on_send(node)
+            default_action?(node) do |match|
+              return if %i(send sym array).include?(match.type)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,6 +33,7 @@ module RuboCop
         #
         class InvalidPlatformFamilyHelper < Cop
           include ::RuboCop::Chef::PlatformHelpers
+          include RangeHelp
 
           MSG = 'Pass valid platform families to the platform_family? helper.'
 
@@ -41,9 +42,31 @@ module RuboCop
           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)
+            platform_family_helper?(node) do |plats|
+              plats.to_a.each do |p|
+                next unless INVALID_PLATFORM_FAMILIES.key?(p.value)
+                add_offense(p, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+
+          def autocorrect(node)
+            replacement_platform = INVALID_PLATFORM_FAMILIES[node.value]
+            all_passed_platforms = node.parent.arguments.map(&:value)
+
+            # see if we have a replacement platform in our hash. If not we can't autocorrect
+            if replacement_platform
+              # if the replacement platform was one of the other platforms passed we can just delete this bad platform
+              if all_passed_platforms.include?(replacement_platform)
+                all_passed_platforms.delete(node.value)
+                lambda do |corrector|
+                  arg_range = node.parent.arguments.first.loc.expression.join(node.parent.arguments[-1].loc.expression.end)
+                  corrector.replace(arg_range, all_passed_platforms.map { |x| "'#{x}'" }.join(', '))
+                end
+              else
+                lambda do |corrector|
+                  corrector.replace(node.loc.expression, node.value.gsub(node.value, "'#{replacement_platform}'")) # gsub to retain quotes
+                end
               end
             end
           end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2020, 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
+        # The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".
+        #
+        # @example
+        #
+        #   # bad
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'boolean'
+        #   end
+        #
+        #   # good
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'bool'
+        #   end
+        #
+        class MacosUserdefaultsInvalidType < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend RuboCop::Cop::AutoCorrector
+
+          VALID_VALUES = %w(array bool dict float int string).freeze
+          INVALID_VALUE_MAP = {
+            'boolean' => 'bool',
+            'str' => 'string',
+            'integer' => 'int',
+          }.freeze
+
+          MSG = 'The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".'
+
+          def on_block(node)
+            match_property_in_resource?(:macos_userdefaults, 'type', node) do |type|
+              type_val = method_arg_ast_to_string(type)
+              return if VALID_VALUES.include?(type_val)
+              add_offense(type.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                if INVALID_VALUE_MAP[type_val]
+                  corrector.replace(type.loc.expression, "type '#{INVALID_VALUE_MAP[type_val]}'")
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,20 +25,20 @@ module RuboCop
         # @example
         #
         #   # bad
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     notifies 'restart', 'service[httpd]', 'delayed'
         #   end
         #
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     subscribes 'restart', 'service[httpd]', 'delayed'
         #   end
         #
         #   # good
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     notifies :restart, 'service[httpd]', 'delayed'
         #   end
         #
-        #   execute 'some commmand' do
+        #   execute 'some command' do
         #     subscribes :restart, 'service[httpd]', 'delayed'
         #   end
         #

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, 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
+        # Versions used in metadata.rb supports calls should be floats not integers.
+        #
+        # @example
+        #
+        #   # bad
+        #   supports 'redhat', '> 8'
+        #
+        #   # good
+        #   supports 'redhat', '> 8.0'
+        #
+        class SupportsMustBeFloat < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Versions used in metadata.rb supports calls should be floats not integers.'
+
+          def_node_matcher :supports_with_constraint?, '(send nil? :supports str $str)'
+
+          def on_send(node)
+            supports_with_constraint?(node) do |ver|
+              return if ver.source.include?('.')
+              add_offense(ver.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(ver.loc.expression, ver.source.gsub(ver.value, (ver.value + '.0')))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/cheffile.rb

@@ -19,13 +19,13 @@
 module RuboCop
   module Cop
     module Chef
-      # The Libarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Bershelf offers a more similar, and still supported, experience to Librarian-Chef.
+      # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
       #
       module ChefDeprecations
         class Cheffile < Cop
           include RangeHelp
 
-          MSG = 'The Libarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
+          MSG = 'The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
 
           def investigate(processed_source)
             return if processed_source.blank?

data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb

@@ -65,25 +65,26 @@ module RuboCop
             'opensuse' => {
               '< 14' => true,
               '~> 42.0' => true,
+              '= 15.0' => '15',
             },
             'debian' => {
               '< 8' => true,
-              '> 8.0, < 8.10' => '8',
-              '> 9.0, < 9.9' => '9',
+              '> 8.0, < 8.11' => '8',
+              '> 9.0, < 9.11' => '9',
             },
             'centos' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6 ' => '7',
             },
             'redhat' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6' => '7',
             },
             'oracle' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6 ' => '7',
             },
           }.freeze

data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # The beta Audit Mode for Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more informmation.
+        # The beta Audit Mode for Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
         #
         # @example
         #
@@ -33,7 +33,7 @@ module RuboCop
         #   end
 
         class EOLAuditModeUsage < Cop
-          MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more informmation.'
+          MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.'
 
           def_node_matcher :control_group?, '(send nil? :control_group ...)'
 

data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2020, 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 ChefDeprecations
+        # The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. This property was never properly implemented and caused failures under many conditions. Omitting the `domain` property will now set global defaults.
+        #
+        # @example
+        #
+        #   # bad
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     value 'value'
+        #   end
+        #
+        #   # good
+        #   macos_userdefaults 'set a value' do
+        #     key 'key'
+        #     value 'value'
+        #   end
+        #
+        class MacosUserdefaultsGlobalProperty < Base
+          extend TargetChefVersion
+          include RangeHelp
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          minimum_target_chef_version '16.3'
+
+          MSG = 'The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. Omitting the `domain` property will now set global defaults.'
+
+          def on_block(node)
+            match_property_in_resource?(:macos_userdefaults, 'global', node) do |global|
+              add_offense(global.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: global.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/poise_archive.rb

@@ -25,16 +25,18 @@ module RuboCop
         #
         #   # bad
         #   poise_archive 'https://example.com/myapp.tgz' do
-        #     destination '/opt/myapp'
+        #     destination '/opt/my_app'
         #   end
         #
         #   # good
         #   archive_file 'https://example.com/myapp.tgz' do
-        #     destination '/opt/myapp'
+        #     destination '/opt/my_app'
         #   end
         #
         class PoiseArchiveUsage < Cop
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          minimum_target_chef_version '15.0'
 
           MSG = 'The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+'
 

data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb

@@ -39,9 +39,9 @@ module RuboCop
 
           def_node_search :provides, '(send nil? :provides (sym $_) ...)'
 
-          # determine the cookbook name either by parsing metdata.rb or by parsing metata.json
+          # determine the cookbook name either by parsing metadata.rb or by parsing metadata.json
           #
-          # @returns [String] the cookbook name
+          # @return [String] the cookbook name
           def cookbook_name
             cb_path = File.expand_path(File.join(processed_source.file_path, '../..'))
 
@@ -55,7 +55,7 @@ module RuboCop
 
           # given a resource name make sure there's a provides that matches that name
           #
-          # @returns [TrueClass, FalseClass]
+          # @return [TrueClass, FalseClass]
           def valid_provides?(resource_name)
             provides_ast = provides(processed_source.ast)
             return false unless provides_ast