cookstyle 5.21.9 → 5.22.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415ddd30149c8277cf255cd81ceb26835eb969da515e97e748372dc72ba40840
-  data.tar.gz: cf2a3e2be30fff68aabef795aecdb6e489a2ede68f09f21cd3c781c35979846c
+  metadata.gz: dad51325bcc35540eeba663b24105674daa20a35d198427a9331be5d02ca3e3b
+  data.tar.gz: 83e2ab6a718092d10ec8ce423e14c995e5a64bc696cd99b3a447144cf2a10fdb
 SHA512:
-  metadata.gz: 911b2afb60dbf89849e4a3e349ef784d7e2b29a25ed00a9eca07222a4fd002fd7486d9d1e2baac4c94cf486c8423ba53f2d0bd83d85cfa2ba668daf05056cb11
-  data.tar.gz: 8f81cdfd43904b11c7651d29dc4f26e5bd930af8d68c2be477cf3c59f9f5d5a37a0f20c5b41640054d5c2ec817d4a4c87ea17be6cda9a486a5c1ffd4f4dbfeb1
+  metadata.gz: 56cba25a342b3f48f69160838cc03807640b11864ba43c5915c715520b1dd751f6ff263e89fd79d8414f3d9b206adbfa441833373dbcb5aed46e0beb32518b74
+  data.tar.gz: 45af6528c08c91fc29f83542d407a081cd0d6897c9fb42b63a51ad512ca0895aa4e48019fc6bb41fe34a4436cbf58b4c64b1306ae41a6f9faec6c2ec855378fb

data/config/cookstyle.yml

@@ -717,6 +717,15 @@ ChefDeprecations/DeprecatedChefSpecPlatform:
   Include:
     - '**/spec/**/*.rb'
 
+ChefDeprecations/WindowsFeatureServermanagercmd:
+  Description: The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
+  Enabled: true
+  VersionAdded: '5.22.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1115,6 +1124,32 @@ ChefModernize/SimplifyAptPpaSetup:
     - '**/attributes/*.rb'
     - '**/Berksfile'
 
+ChefModernize/UseRequireRelative:
+  Description: Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
+  Enabled: true
+  VersionAdded: '5.22.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefModernize/NodeInitPackage:
+  Description: Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
+  Enabled: true
+  VersionAdded: '5.22.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefModernize/WindowsRegistryUAC:
+  Description: Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.
+  Enabled: true
+  VersionAdded: '5.22.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefRedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################
@@ -1472,8 +1507,6 @@ Style/MethodCallParentheses:
   Enabled: true
 Style/MethodDefParentheses:
   Enabled: true
-Naming/MethodName:
-  Enabled: true
 Style/MultilineBlockChain:
   Enabled: true
 Layout/MultilineBlockLayout:
@@ -1624,8 +1657,6 @@ Style/TrailingUnderscoreVariable:
   Enabled: true
 Style/VariableInterpolation:
   Enabled: true
-Naming/VariableName:
-  Enabled: true
 Style/WhenThen:
   Enabled: true
 Style/WhileUntilDo:

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.21.9".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.22.6".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.75.1'.freeze
 end

data/lib/rubocop/chef/cookbook_only.rb

@@ -63,7 +63,7 @@ module RuboCop
       extend ClassMethods
     end
 
-    def self.CookbookOnly(segments) # rubocop: disable Naming/MethodName
+    def self.CookbookOnly(segments)
       Module.new do |mod|
         mod.define_singleton_method(:included) do |klass|
           super(klass)

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

@@ -0,0 +1,57 @@
+#
+# 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 `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.
+        #
+        # @example
+        #
+        #   # bad
+        #   windows_feature 'DHCP' do
+        #     install_method :servermanagercmd
+        #   end
+        #
+        #   # good
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_dism
+        #   end
+        #
+        #   windows_feature 'DHCP' do
+        #     install_method :windows_feature_powershell
+        #   end
+        #
+        #   windows_feature_dism 'DHCP'
+        #
+        #   windows_feature_powershell 'DHCP'
+        #
+        class WindowsFeatureServermanagercmd < Cop
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'.freeze
+
+          def on_block(node)
+            match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
+              add_offense(prop_node, location: :expression, message: MSG, severity: :refactor) if prop_node.source.match?(/:servermanagercmd/)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# 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");
@@ -24,9 +24,23 @@ module RuboCop
         #   # bad
         #   execute 'apt-get update'
         #
+        #   execute 'Apt all the apt cache' do
+        #     command 'apt-get update'
+        #   end
+        #
+        #   execute 'some execute resource' do
+        #     notifies :run, 'execute[apt-get update]', :immediately
+        #   end
+        #
         #   # good
         #   apt_update
         #
+        #   apt_update 'update apt cache'
+        #
+        #   execute 'some execute resource' do
+        #     notifies :update, 'apt_update[update apt cache]', :immediately
+        #   end
+        #
         class ExecuteAptUpdate < Cop
           MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'.freeze
 
@@ -34,10 +48,26 @@ module RuboCop
             (send nil? :execute (str "apt-get update"))
           PATTERN
 
+          def_node_matcher :notification_property?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
+          PATTERN
+
+          def_node_matcher :execute_command?, <<-PATTERN
+            (send nil? :command $str)
+          PATTERN
+
           def on_send(node)
             execute_apt_update?(node) do
               add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
+
+            notification_property?(node) do |val|
+              add_offense(val, location: :expression, message: MSG, severity: :refactor) if val.str_content&.start_with?('execute[apt-get update]')
+            end
+
+            execute_command?(node) do |val|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if val.str_content == 'apt-get update'
+            end
           end
         end
       end

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

@@ -0,0 +1,79 @@
+#
+# 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 ChefModernize
+        # Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
+        #
+        # @example
+        #
+        #   # bad
+        #   ::File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::File.open('/proc/1/comm').chomp == 'systemd'
+        #   File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.open('/proc/1/comm').chomp == 'systemd'
+        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #
+        #   IO.read('/proc/1/comm').chomp == 'systemd'
+        #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #
+        #   # good
+        #   node['init_package'] == 'systemd'
+        #
+        class NodeInitPackage < Cop
+          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'".freeze
+
+          def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
+            (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :proc_1_comm_exists?, <<-PATTERN
+            (send
+              (const
+                {(cbase) nil?} :File) :exist?
+              (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :compare_init_system?, <<-PATTERN
+            (send
+              (send {#file_reads_proc_1_comm? (send #file_reads_proc_1_comm? :gets) } :chomp)
+                :== (str "systemd"))
+          PATTERN
+
+          def on_send(node)
+            compare_init_system?(node) do
+              # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
+              node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
+
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, "node['init_package'] == 'systemd'")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+#
+# 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 ChefModernize
+        # Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
+        #
+        # @example
+        #
+        #   # bad
+        #   require File.expand_path('../../libraries/helpers', __FILE__)
+        #
+        #   # good
+        #   require_relative '../libraries/helpers'
+        #
+        class UseRequireRelative < Cop
+          MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'.freeze
+
+          def_node_matcher :require_with_expand_path?, <<-PATTERN
+            (send nil? :require
+              (send
+                (const nil? :File) :expand_path
+                $( str ... )
+                $( str ... )))
+          PATTERN
+
+          def on_send(node)
+            require_with_expand_path?(node) do |_file, path|
+              add_offense(node, location: :expression, message: MSG, severity: :refactor) if path.source == '__FILE__'
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              require_with_expand_path?(node) do |file, _path|
+                corrected_value = file.value
+                corrected_value.slice!(%r{^../}) # take the first ../ off the path
+                corrector.replace(node.loc.expression, "require_relative '#{corrected_value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+#
+# 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 ChefModernize
+        # Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.
+        #
+        #   # bad
+        #   registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System' do
+        #     values [{ name: 'EnableLUA', type: :dword, data: 0 },
+        #             { name: 'PromptOnSecureDesktop', type: :dword, data: 0 },
+        #             { name: 'ConsentPromptBehaviorAdmin', type: :dword, data: 0 },
+        #            ]
+        #     action :create
+        #   end
+        #
+        #  # good
+        #  windows_uac 'Set Windows UAC settings' do
+        #    enable_uac false
+        #    prompt_on_secure_desktop true
+        #    consent_behavior_admins :no_prompt
+        #  end
+        #
+        class WindowsRegistryUAC < Cop
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'.freeze
+
+          # non block execute resources
+          def on_send(node)
+            return unless node.method_name == :registry_key
+
+            # use source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            if node&.arguments.first&.source.match?(/HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
+              property_data = method_arg_ast_to_string(key_prop)
+              if property_data && property_data.match?(/HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+                add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb

@@ -24,39 +24,28 @@ module RuboCop
         #
         #   # bad
         #   property :foo, [TrueClass, FalseClass]
-        #   attribute :foo, kind_of: [TrueClass, FalseClass]
         #
         #   # good
         #   property :foo, [true, false]
-        #   attribute :foo, kind_of: [true, false]
         #
         class TrueClassFalseClassResourceProperties < Cop
           MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.".freeze
 
-          def_node_matcher :trueclass_falseclass_array?, <<-PATTERN
-             (array (const nil? :TrueClass) (const nil? :FalseClass))
-          PATTERN
-
-          def_node_matcher :tf_in_kind_of_hash?, <<-PATTERN
-            (hash (pair (sym :kind_of) #trueclass_falseclass_array? ))
-          PATTERN
-
           def_node_matcher :trueclass_falseclass_property?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _)
-
-            ${#tf_in_kind_of_hash? #trueclass_falseclass_array? } ... )
+            (send nil? {:property :attribute} (sym _) $(array (const nil? :TrueClass) (const nil? :FalseClass)) ... )
           PATTERN
 
           def on_send(node)
-            trueclass_falseclass_property?(node) do |tf_match|
-              add_offense(tf_match, location: :expression, message: MSG, severity: :refactor)
+            trueclass_falseclass_property?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
 
           def autocorrect(node)
             lambda do |corrector|
-              replacement_text = node.hash_type? ? 'kind_of: [true, false]' : '[true, false]'
-              corrector.replace(node.loc.expression, replacement_text)
+              trueclass_falseclass_property?(node) do |types|
+                corrector.replace(types.loc.expression, '[true, false]')
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb

@@ -18,7 +18,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic.
+        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `plaform_family`.
         #
         # @example
         #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 5.21.9
+  version: 5.22.6
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -115,6 +115,7 @@ files:
 - lib/rubocop/cop/chef/deprecation/use_inline_resources.rb
 - 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_task_change_action.rb
 - lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb
 - lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb
@@ -150,6 +151,7 @@ files:
 - lib/rubocop/cop/chef/modernize/libarchive_file.rb
 - lib/rubocop/cop/chef/modernize/macos_user_defaults.rb
 - lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb
+- lib/rubocop/cop/chef/modernize/node_init_package.rb
 - lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb
 - lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb
 - lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb
@@ -171,8 +173,10 @@ files:
 - lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb
 - lib/rubocop/cop/chef/modernize/systctl_param_resource.rb
 - lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb
+- lib/rubocop/cop/chef/modernize/use_require_relative.rb
 - lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb
 - lib/rubocop/cop/chef/modernize/windows_default_recipe.rb
+- lib/rubocop/cop/chef/modernize/windows_registry_uac.rb
 - lib/rubocop/cop/chef/modernize/windows_version_helper.rb
 - lib/rubocop/cop/chef/modernize/windows_zipfile.rb
 - lib/rubocop/cop/chef/modernize/zipfile_resource.rb