cookstyle 6.19.11 → 7.1.2

data/cookstyle.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
     'homepage_uri' => 'https://github.com/chef/cookstyle',
     'changelog_uri' => 'https://github.com/chef/cookstyle/blob/master/CHANGELOG.md',
     'source_code_uri' => 'https://github.com/chef/cookstyle',
-    'documentation_uri' => 'https://docs.chef.io/cookstyle.html',
+    'documentation_uri' => 'https://docs.chef.io/workstation/cookstyle/',
     'bug_tracker_uri' => 'https://github.com/chef/cookstyle/issues',
   }
 end

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.19.11" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.92.0'
+  VERSION = "7.1.2" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.2.0'
 end

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal, which masks the full stack trace of the failure and makes debugging difficult.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Don't use Ruby to shellout in a only_if / not_if conditional when you can just shellout directly. Any string value used with only_if / not_if is executed in your system's shell and the return code of the command is the result for the not_if / only_if determination.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # dnf_package does not support the allow_downgrades property
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.
         #
         # @example

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

@@ -29,7 +29,7 @@ module RuboCop
       #   # good
       #   default_action :create
       #
-      module ChefCorrectness
+      module Correctness
         class InvalidDefaultAction < Base
           MSG = 'Default actions in resources should be symbols or an array of symbols.'
           RESTRICT_ON_SEND = [:default_action].freeze

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Pass valid platform families to the platform_family? helper.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use valid platform family values in case statements.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Pass valid platforms to the platform? helper.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # metadata.rb supports methods should contain valid platforms.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use valid platform values in case statements.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Pass valid platforms families to the value_for_platform_family helper.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Pass valid platforms to the value_for_platform helper.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Cookbook metadata.rb version field should follow X.Y.Z version format.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # 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

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
         #
         # @example

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

@@ -26,7 +26,7 @@ module RuboCop
       #   # good
       #   name 'foo'
       #
-      module ChefCorrectness
+      module Correctness
         class MetadataMissingName < Base
           include RangeHelp
 

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Normal attributes are discouraged since their semantics differ importantly from the
         # default and override levels. Their values persist in the node object even after
         # all code referencing them has been deleted, unlike default and override.

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

@@ -17,7 +17,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Normal attributes are discouraged since their semantics differ importantly from the
         # default and override levels. Their values persist in the node object even after
         # all code referencing them has been deleted, unlike default and override.

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's
         # absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and
         # increases load on the Chef Infra Server."

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # When notifying or subscribing an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
         #
         # @example

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

@@ -0,0 +1,48 @@
+# 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 Correctness
+        # Don't represent file modes as Strings containing octal values.
+        #
+        # @example
+        #
+        #   # bad
+        #   file '/etc/some_file' do
+        #     mode '0o755'
+        #   end
+        #
+        #   # good
+        #   file '/etc/some_file' do
+        #     mode '0755'
+        #   end
+        #
+        class OctalModeAsString < Base
+          MSG = "Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead. For example: '0755'."
+          RESTRICT_ON_SEND = [:mode].freeze
+
+          def on_send(node)
+            return unless node.arguments.first&.str_type? && node.arguments.first.value.match?(/^0o/)
+            add_offense(node, message: MSG, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # The openSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should not longer be used. This helper would generate a random password that would be used when a data bag or attribute was no present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
         #
         #   # bad

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use the `file` or `directory` resources built into Chef Infra Client with the :delete action to remove files/directories instead of using Remove-Item in a powershell_script resource
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Resource properties or attributes should always define a type to help users understand the correct allowed values.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Chef Infra Client uses properties in several resources to track state. These
         # should not be set in recipes as they break the internal workings of the Chef
         # Infra Client

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use name properties instead of setting the name property in a resource. Setting the name property
         # directly causes notification and reporting issues.
         #

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # The :nothing action is often typo'd as :none
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use a service resource to start and stop services
         #
         # @example when command starts a service

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Versions used in metadata.rb supports calls should be floats not integers.
         #
         # @example

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefCorrectness
+      module Correctness
         # Use file_cache_path rather than hard-coding tmp paths
         #
         # @example downloading a large file into /tmp/

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

@@ -18,7 +18,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
         #
         # @example

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

@@ -30,7 +30,7 @@ module RuboCop
       #   # good
       #   name 'foo'
       #
-      module ChefDeprecations
+      module Deprecations
         class CookbooksDependsOnSelf < Base
           extend AutoCorrector
           include RangeHelp

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
         #
         # @example

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

@@ -19,7 +19,7 @@
 module RuboCop
   module Cop
     module Chef
-      module ChefDeprecations
+      module Deprecations
         # Chef::REST was removed in Chef Infra Client 13.
         #
         # @example