cookstyle 6.16.10 → 6.17.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e15b2148d2b58205dc5b6653e3824b59dda2a927c1e0753f42d522105682021
-  data.tar.gz: e2c9f7bb6727c8f97b7de581e29b4f18db002b17f10732e115652e728f844ded
+  metadata.gz: 76d0f2a3917c4ff1035541386d4edaa98f4cb782bd2f43a839d938b66aada708
+  data.tar.gz: ca7aff409b3d786fd71ac630c1d23b36f51a51ba495f7c2c4761c753c5e40624
 SHA512:
-  metadata.gz: f9d1c969323e34fc6c58c987a9b339c625f2cfeb7b6ceeea83e7e7a0b5292dfe8d54e1f05dca2773ec582aaa6ad5b12914715d77b140906f14b8911406396d5e
-  data.tar.gz: e343548e500f20767be5ce478d47969677e31d9ebd1f8661cab493e9777eadd0e8ed09921a22690ef61a5ade718b8ae954bc1fa3464c01abbcd12cd6843e1273
+  metadata.gz: 94bd535e28382dfd08776a053b8c6c9bb46e054a4dc3f10876b470de3755b3d6a78da9c71982ae3a7e0aee3856230e027ffe25457c77b8fd703df839acffeed4
+  data.tar.gz: f80c75e882aa27d4d4d81628c996acd2c2f5b1fc0226fafcd37b2ff86b2f9dddc9aa8f84c0b5cf4c8f71b1333757e2e239699966ac612902b426cae881ca91c1

data/bin/cookstyle

@@ -2,7 +2,7 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
+$LOAD_PATH.unshift File.join(__dir__, %w(.. lib))
 
 require 'cookstyle'
 

data/config/cookstyle.yml

@@ -908,10 +908,11 @@ ChefDeprecations/RubyBlockCreateAction:
     - '**/Berksfile'
 
 ChefDeprecations/DeprecatedPlatformMethods:
-  Description: Use provider_for_action instead of the deprecated Chef::Platform methods in resources.
+  Description: Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources.
   StyleGuide: '#chefdeprecationsdeprecatedplatformmethods'
   Enabled: true
   VersionAdded: '5.16.0'
+  VersionChanged: '6.17.0'
   Include:
     - '**/libraries/*.rb'
     - '**/resources/*.rb'
@@ -1062,6 +1063,46 @@ ChefDeprecations/CookbooksDependsOnSelf:
   Include:
     - '**/metadata.rb'
 
+ChefDeprecations/ChefShellout:
+  Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
+  StyleGuide: '#chefdeprecationschefshellout'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecutePathProperty:
+  Description: In Chef Infra Client 13 and later you must set path env vars in `execute` resources using the `environment` property not the legacy `path` property.
+  StyleGuide: '#chefdeprecationsexecutepathproperty'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecuteRelativeCreatesWithoutCwd:
+  Description: In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+  StyleGuide: '#chefdeprecationsexecuterelativecreateswithoutcwd'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/WindowsPackageInstallerTypeString:
+  Description: In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+  StyleGuide: '#chefdeprecationswindowspackageinstallertypestring'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -2616,4 +2657,4 @@ Style/RedundantAssignment:
 
 # alert on invalid ruby
 Lint/Syntax:
-  Enabled: true
+  Enabled: true

data/lib/cookstyle.rb

@@ -19,7 +19,7 @@ module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(
       /^.*$/,
-      File.realpath(File.join(File.dirname(__FILE__), '..'))
+      File.realpath(File.join(__dir__, '..'))
     )
 
     DEFAULT_FILE.gsub!(
@@ -46,7 +46,7 @@ require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
 # Chef Infra specific cops
-Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|
+Dir.glob(__dir__ + '/rubocop/cop/chef/**/*.rb') do |file|
   next if File.directory?(file)
 
   require_relative file # not actually relative but require_relative is faster

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.16.10" # rubocop: disable Style/StringLiterals
+  VERSION = "6.17.5" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.90.0'
 end

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

@@ -0,0 +1,86 @@
+# 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 ChefDeprecations
+        # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
+        # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
+        # helper provided in chef-utils.
+        #
+        # @example
+        #
+        #   # bad
+        #   include Chef::ShellOut
+        #   require 'chef/shellout'
+        #   Chef::ShellOut.new('some_command')
+        #
+        #   # good
+        #   include Mixlib::ShellOut
+        #   require 'mixlib/shellout'
+        #   Mixlib::ShellOut.new('some_command')
+        #
+        class ChefShellout < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
+          # RESTRICT_ON_SEND = [:new, :require, :include].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const nil? :Chef) :ShellOut))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+          (send nil? :require (str "chef/shellout"))
+          PATTERN
+
+          def_node_matcher :shellout_new?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) :ShellOut) :new
+              ... )
+          PATTERN
+
+          def on_send(node)
+            include_shellout?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_shellout?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            shellout_new?(node) do
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2019, Chef Software Inc.
+# Copyright:: 2019-2020, Chef Software Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,7 +20,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefDeprecations
-        # Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
+        # Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
         #
         # @example
         #
@@ -34,15 +34,19 @@ module RuboCop
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = Chef::Platform.find_provider_for_node(node, resource)
         #
+        #   Chef::Platform.set :platform => :mac_os_x, :resource => :package, :provider => Chef::Provider::Package::Homebrew
+        #
         #   # good
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = resource.provider_for_action(:create)
         #
+        #   # provides :package, platform_family: 'mac_os_x'
+
         class DeprecatedPlatformMethods < Base
-          MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
+          MSG = 'Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
 
           def_node_matcher :platform_method?, <<-PATTERN
-            (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node} ... )
+            (send (const (const nil? :Chef) :Platform) {:provider_for_resource :find_provider :find_provider_for_node :set} ... )
           PATTERN
 
           def on_send(node)

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

@@ -0,0 +1,51 @@
+# 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 ChefDeprecations
+        # In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'some_cmd' do
+        #     path '/foo/bar'
+        #   end
+        #
+        #   # good
+        #   execute 'some_cmd' do
+        #     environment {path: '/foo/bar'}
+        #   end
+        #
+        class ExecutePathProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'In Chef Infra Client 13 and later you must set path env vars in execute resources using the `environment` property not the legacy `path` property.'
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'path', node) do |offense|
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 ChefDeprecations
+        # In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #   end
+        #
+        #   # good
+        #   execute 'some_cmd' do
+        #     creates '/tmp/something'
+        #   end
+        #
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #     cwd '/tmp/'
+        #   end
+        #
+        class ExecuteRelativeCreatesWithoutCwd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'creates', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # we can only analyze simple string args
+
+              # skip any creates that are abs paths https://rubular.com/r/3TbDsgcAa1EaIF
+              return if offense.arguments.first.value.match?(%r{^(/|[a-zA-Z]:)})
+
+              # return if we have a cwd property
+              match_property_in_resource?(:execute, 'cwd', node) do
+                return
+              end
+
+              add_offense(offense.loc.expression, message: MSG, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -57,6 +57,8 @@ module RuboCop
 
           private
 
+          VALID_TYPES = %i(send hash block_pass).freeze
+
           #
           # Are the arguments in the passed node object positional
           #
@@ -68,7 +70,7 @@ module RuboCop
             return false if node.arguments.count < 3
             node.arguments[2..-1].each do |arg|
               # hashes, blocks, or variable/methods are valid. Anything else is not
-              return true unless %i(send hash block_pass).include?(arg.type)
+              return true unless VALID_TYPES.include?(arg.type)
             end
             false
           end
@@ -81,7 +83,7 @@ module RuboCop
           # @return [String]
           #
           def corrected_string(node)
-            args = node.arguments
+            args = node.arguments.dup
 
             # If the 2nd argument is a String and not an Integer as a String
             # then it's the old sort field and we need to delete it. Same thing

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

@@ -48,7 +48,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
-              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.match?(/:servermanagercmd/)
+              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.include?(':servermanagercmd')
             end
           end
         end

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

@@ -0,0 +1,61 @@
+# 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 ChefDeprecations
+        # In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+        #
+        # @example
+        #
+        #   # bad
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type 'msi'
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        #   # good
+        #   windows_package 'AppveyorDeploymentAgent' do
+        #     source 'https://www.example.com/appveyor.msi'
+        #     installer_type :msi
+        #     options "/quiet /qn /norestart /log install.log"
+        #   end
+        #
+        class WindowsPackageInstallerTypeString < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = "In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol."
+
+          def on_block(node)
+            match_property_in_resource?(:windows_package, 'installer_type', node) do |offense|
+              return unless offense.arguments.count == 1 # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # anything else is fine
+
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(offense.arguments.first.source_range, ":#{offense.arguments.first.value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.16.10
+  version: 6.17.5
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -88,6 +88,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb
 - lib/rubocop/cop/chef/deprecation/chef_rest.rb
 - lib/rubocop/cop/chef/deprecation/chef_rewind.rb
+- lib/rubocop/cop/chef/deprecation/chef_shellout.rb
 - lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb
 - lib/rubocop/cop/chef/deprecation/chefdk_generators.rb
 - lib/rubocop/cop/chef/deprecation/cheffile.rb
@@ -107,6 +108,8 @@ files:
 - lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb
 - lib/rubocop/cop/chef/deprecation/epic_fail.rb
 - lib/rubocop/cop/chef/deprecation/erl_call.rb
+- lib/rubocop/cop/chef/deprecation/execute_path_property.rb
+- lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb
 - lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb
 - lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb
 - lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb
@@ -139,6 +142,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/user_supports_property.rb
 - lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb
 - lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb
+- lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb
 - lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb
 - lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb
 - lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb