cookstyle 7.12.2 → 7.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68835852d8021cee74896aa171d78ca5b540fca9fdee42632719d867910c107e
-  data.tar.gz: f71d3a8f4bc874dd86f81b0b01d4caa929ba62c2bf2222ca66a3e726eb398611
+  metadata.gz: 2fb8828f5ea858d36d8aece2ac5de3e469e04fcd86301ebb2fa86aeffd2ec9bc
+  data.tar.gz: 4b1101bab8a823c1a161478dbb1503e9c7cca0d340a33c07aecef0f6c15efdff
 SHA512:
-  metadata.gz: a8ce79400b3866f0ac4b5b94ed0eb39da7a7b19dcd6dcf5fb0e6347affc31a70c0d56d8e2d671b776cea74465b6c715a20d9d88b3941291655ed01833c38796b
-  data.tar.gz: 1d324b44b1ce454718685eb5339e14d4063072b2d66dec6707091a871aa1fbef6f8eb4a13aeee683552b4b6d54f0821b5fa82493b4bde31d62aac48e9577a396
+  metadata.gz: 7308b900c24d494ec617f001a3b83ee3f9491fb38de29ee7491c67c3c58605ba21c43c81419567ddd5b150674221c243ceec1faa075ab3744c2e426097f09624
+  data.tar.gz: 3ba724acde273762b7073740e84f19b8d439d20f73ec73e237fd4cefc5dc7c65d84d7b4d62992d56aedca825e924f32063e6557811401f0e0740de6dc4b80e5f

data/config/cookstyle.yml

@@ -3,8 +3,8 @@ AllCops:
   TargetRubyVersion: 2.5
   TargetChefVersion: ~
   Exclude:
-    - '/**/files/**/*'
-    - '/**/vendor/**/*'
+    - '**/files/**/*'
+    - '**/vendor/**/*'
     - Guardfile
 
 ###############################
@@ -1205,6 +1205,8 @@ Chef/Deprecations/ResourceWithoutUnifiedTrue:
   VersionAdded: '7.12.0'
   Include:
     - '**/resources/*.rb'
+  Exclude:
+    - '**/spec/**/*.rb'
 
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
@@ -2078,6 +2080,27 @@ Chef/Effortless/Berksfile:
   Include:
     - '**/Berksfile'
 
+#### InSpec cops
+
+InSpec/Deprecations:
+  StyleGuideBaseURL: https://docs.chef.io/workstation/cookstyle/
+
+InSpec/Deprecations/AttributeHelper:
+  Description: InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
+  StyleGuide: 'inspec_deprecations_attributehelper'
+  Enabled: true
+  VersionAdded: '7.14.0'
+  Include:
+    - '**/controls/*.rb'
+
+InSpec/Deprecations/AttributeDefault:
+  Description: The InSpec inputs `default` option has been replaced with the `value` option.
+  StyleGuide: 'inspec_deprecations_attributedefaults'
+  Enabled: true
+  VersionAdded: '7.14.0'
+  Include:
+    - '**/controls/*.rb'
+
 #### The base rubocop 0.37 enabled.yml file we started with ####
 
 Layout/AccessModifierIndentation:

data/config/disable_all.yml

@@ -275,6 +275,8 @@ Lint/EmptyExpression:
   Enabled: false
 Lint/EmptyFile:
   Enabled: false
+Lint/EmptyInPattern:
+  Enabled: false
 Lint/EmptyInterpolation:
   Enabled: false
 Lint/EmptyWhen:
@@ -667,6 +669,8 @@ Style/IfWithSemicolon:
   Enabled: false
 Style/ImplicitRuntimeError:
   Enabled: false
+Style/InPatternThen:
+  Enabled: false
 Style/InfiniteLoop:
   Enabled: false
 Style/InverseMethods:
@@ -687,6 +691,8 @@ Style/MethodCallWithoutArgsParentheses:
   Enabled: false
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+Style/MultilineInPatternThen:
+  Enabled: false
 Style/RedundantAssignment:
   Enabled: false
 Style/RedundantFetchBlock:
@@ -787,6 +793,8 @@ Style/PreferredHashMethods:
   Enabled: false
 Style/Proc:
   Enabled: false
+Style/QuotedSymbols:
+  Enabled: false
 Style/RaiseArgs:
   Enabled: false
 Style/RandomWithOffset:
@@ -883,6 +891,8 @@ Style/SymbolProc:
   Enabled: false
 Style/TernaryParentheses:
   Enabled: false
+Style/TopLevelMethodDefinition:
+  Enabled: false
 Style/TrailingBodyOnClass:
   Enabled: false
 Style/TrailingBodyOnMethodDefinition:

data/config/upstream.yml

@@ -377,10 +377,11 @@ Layout/BlockEndNewline:
   VersionAdded: '0.49'
 
 Layout/CaseIndentation:
-  Description: 'Indentation of when in a case/when/[else/]end.'
+  Description: 'Indentation of when in a case/(when|in)/[else/]end.'
   StyleGuide: '#indent-when-to-case'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.16'
   EnforcedStyle: case
   SupportedStyles:
     - case
@@ -771,7 +772,7 @@ Layout/HashAlignment:
   Enabled: true
   AllowMultipleStyles: true
   VersionAdded: '0.49'
-  VersionChanged: '0.77'
+  VersionChanged: '1.16'
   # Alignment of entries using hash rocket as separator. Valid values are:
   #
   # key - left alignment of keys
@@ -1612,7 +1613,7 @@ Lint/EmptyBlock:
   Description: 'This cop checks for blocks without a body.'
   Enabled: pending
   VersionAdded: '1.1'
-  VersionChanged: '1.3'
+  VersionChanged: '1.15'
   AllowComments: true
   AllowEmptyLambdas: true
 
@@ -1645,6 +1646,12 @@ Lint/EmptyFile:
   AllowComments: true
   VersionAdded: '0.90'
 
+Lint/EmptyInPattern:
+  Description: 'Checks for the presence of `in` pattern branches without a body.'
+  Enabled: pending
+  AllowComments: true
+  VersionAdded: '1.16'
+
 Lint/EmptyInterpolation:
   Description: 'Checks for empty string interpolation.'
   Enabled: true
@@ -2092,6 +2099,7 @@ Lint/SymbolConversion:
   Description: 'Checks for unnecessary symbol conversions.'
   Enabled: pending
   VersionAdded: '1.9'
+  VersionChanged: '1.16'
   EnforcedStyle: strict
   SupportedStyles:
     - strict
@@ -3480,6 +3488,7 @@ Style/HashAsLastArrayItem:
 
 Style/HashConversion:
   Description: 'Avoid Hash[] in favor of ary.to_h or literal hashes.'
+  StyleGuide: '#avoid-hash-constructor'
   Enabled: pending
   VersionAdded: '1.10'
   VersionChanged: '1.11'
@@ -3489,8 +3498,10 @@ Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
   StyleGuide: '#hash-each'
   Enabled: true
-  VersionAdded: '0.80'
   Safe: false
+  VersionAdded: '0.80'
+  VersionChanged: '1.16'
+  AllowedReceivers: []
 
 Style/HashExcept:
   Description: >-
@@ -3553,6 +3564,7 @@ Style/IdenticalConditionalBranches:
                  out of the conditional.
   Enabled: true
   VersionAdded: '0.36'
+  VersionChanged: '1.16'
 
 Style/IfInsideElse:
   Description: 'Finds if nodes inside else, which can be converted to elsif.'
@@ -3599,6 +3611,12 @@ Style/ImplicitRuntimeError:
   Enabled: false
   VersionAdded: '0.41'
 
+Style/InPatternThen:
+  Description: 'Checks for `in;` uses in `case` expressions.'
+  StyleGuide: '#no-in-pattern-semicolons'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/InfiniteLoop:
   Description: >-
                  Use Kernel#loop for infinite loops.
@@ -3827,6 +3845,12 @@ Style/MultilineIfThen:
   VersionAdded: '0.9'
   VersionChanged: '0.26'
 
+Style/MultilineInPatternThen:
+  Description: 'Do not use `then` for multi-line `in` statement.'
+  StyleGuide: '#no-then'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/MultilineMemoization:
   Description: 'Wrap multiline memoizations in a `begin` and `end` block.'
   Enabled: true
@@ -3998,6 +4022,7 @@ Style/NilLambda:
   Description: 'Prefer `-> {}` to `-> { nil }`.'
   Enabled: pending
   VersionAdded: '1.3'
+  VersionChanged: '1.15'
 
 Style/NonNilCheck:
   Description: 'Checks for redundant nil checks.'
@@ -4184,6 +4209,16 @@ Style/Proc:
   VersionAdded: '0.9'
   VersionChanged: '0.18'
 
+Style/QuotedSymbols:
+  Description: 'Use a consistent style for quoted symbols.'
+  Enabled: pending
+  VersionAdded: '1.16'
+  EnforcedStyle: same_as_string_literals
+  SupportedStyles:
+    - same_as_string_literals
+    - single_quotes
+    - double_quotes
+
 Style/RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   StyleGuide: '#exception-class-messages'
@@ -4651,6 +4686,12 @@ Style/TernaryParentheses:
     - require_parentheses_when_complex
   AllowSafeAssignment: true
 
+Style/TopLevelMethodDefinition:
+  Description: 'This cop looks for top-level method definitions.'
+  StyleGuide: '#top-level-methods'
+  Enabled: false
+  VersionAdded: '1.15'
+
 Style/TrailingBodyOnClass:
   Description: 'Class body goes below class statement.'
   Enabled: true
@@ -4737,7 +4778,7 @@ Style/TrivialAccessors:
   StyleGuide: '#attr_family'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.77'
+  VersionChanged: '1.15'
   # When set to `false` the cop will suggest the use of accessor methods
   # in situations like:
   #
@@ -4756,7 +4797,7 @@ Style/TrivialAccessors:
   # on_exception :restart
   #
   # Commonly used in DSLs
-  AllowDSLWriters: false
+  AllowDSLWriters: true
   IgnoreClassMethods: false
   AllowedMethods:
     - to_ary

data/lib/cookstyle.rb

@@ -46,7 +46,7 @@ require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
 # Chef Infra specific cops
-Dir.glob(__dir__ + '/rubocop/cop/chef/**/*.rb') do |file|
+Dir.glob(__dir__ + '/rubocop/cop/**/*.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 = "7.12.2" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.14.0'
+  VERSION = "7.14.2" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.17.0'
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright:: 2020, Chef Software, Inc.
+# Copyright:: 2020-2021, Chef Software, Inc.
 # Author:: Tim Smith (<tsmith@chef.io>)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,12 +32,12 @@ module RuboCop
         #     action :create
         #   end
         #
-        #  #### correct
-        #  windows_uac 'Set Windows UAC settings' do
-        #    enable_uac false
-        #    prompt_on_secure_desktop true
-        #    consent_behavior_admins :no_prompt
-        #  end
+        #   #### correct
+        #   windows_uac 'Set Windows UAC settings' do
+        #     enable_uac false
+        #     prompt_on_secure_desktop true
+        #     consent_behavior_admins :no_prompt
+        #   end
         #
         class WindowsRegistryUAC < Base
           include RuboCop::Chef::CookbookHelpers
@@ -47,24 +47,43 @@ module RuboCop
 
           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.'
           RESTRICT_ON_SEND = [:registry_key].freeze
+          VALID_VALUES = %w(EnableLUA ValidateAdminCodeSignatures PromptOnSecureDesktop ConsentPromptBehaviorAdmin ConsentPromptBehaviorUser EnableInstallerDetection).freeze
 
-          # non block execute resources
-          def on_send(node)
-            return unless node&.arguments.first&.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i) &&
-                          node.parent&.method_name != :describe
-
-            # 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
+          # block registry_key resources
+          def on_block(node)
+            return unless node.method_name == :registry_key
+            return unless correct_key?(node)
+            return unless uac_supported_values?(node)
             add_offense(node, message: MSG, severity: :refactor)
           end
 
-          # block execute resources
-          def on_block(node)
+          # make sure the values passed are all the ones in the uac resource
+          # this key has other values we don't support in the windows_uac resource
+          def uac_supported_values?(node)
+            match_property_in_resource?(:registry_key, 'values', node) do |val_prop|
+              return false unless val_prop&.arguments[0].array_type? # make sure values isn't being passed a variable or method
+              val_prop.arguments[0].each_value do |array|
+                array.each_pair do |key, value|
+                  if key == s(:sym, :name)
+                    return false unless value.str_type? # make sure it isn't being a variable or method that we can't parse
+                    return false unless VALID_VALUES.include?(value.value)
+                  end
+                end
+              end
+            end
+            true
+          end
+
+          # make sure the registry_key resource is running against the correct key
+          # check the block name and the key property (registry_key's name property)
+          def correct_key?(node)
+            return true if node.send_node.arguments.first.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+
             match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
               property_data = method_arg_ast_to_string(key_prop)
-              return unless property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
-              add_offense(node, message: MSG, severity: :refactor)
+              return true if property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
             end
+            false
           end
         end
       end

data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 InSpec
+      module Deprecations
+        # The InSpec inputs `default` option has been replaced with the `value` option.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   login_defs_umask = input('login_defs_umask', default: '077', description: 'Default umask to set in login.defs')
+        #
+        #   #### correct
+        #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        class AttributeDefault < Base
+          extend AutoCorrector
+
+          MSG = 'The InSpec inputs `default` option has been replaced with the `value` option.'
+          RESTRICT_ON_SEND = [:attribute, :input].freeze
+
+          def_node_matcher :default?, <<-PATTERN
+            (send nil? {:attribute :input} _ (hash <(pair $(sym :default) ...) ...>) )
+          PATTERN
+
+          def on_send(node)
+            default?(node) do |n|
+              add_offense(n, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(n, 'value')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 InSpec
+      module Deprecations
+        # InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   login_defs_umask = attribute('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        #   #### correct
+        #   login_defs_umask = input('login_defs_umask', value: '077', description: 'Default umask to set in login.defs')
+        #
+        class AttributeHelper < Base
+          extend AutoCorrector
+
+          MSG = 'InSpec attributes have been renamed to inputs. Use the `input` method not the deprecation `attribute` method to access these values.'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def on_send(node)
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
+              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^attribute/, 'input'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.12.2
+  version: 7.14.2
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.17.0
 description: 
 email:
 - thom@chef.io
@@ -275,6 +275,8 @@ files:
 - lib/rubocop/cop/chef/style/unnecessary_os_check.rb
 - lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
+- lib/rubocop/cop/inspec/deprecation/attribute_default.rb
+- lib/rubocop/cop/inspec/deprecation/attribute_helper.rb
 - lib/rubocop/cop/target_chef_version.rb
 - lib/rubocop/monkey_patches/base.rb
 - lib/rubocop/monkey_patches/config.rb