cookstyle 6.20.1 → 7.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -3
- data/config/cookstyle.yml +277 -241
- data/config/disable_all.yml +28 -0
- data/config/upstream.yml +214 -81
- data/lib/cookstyle/version.rb +2 -2
- data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/node_normal.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/node_normal_unless.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/node_save.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb +48 -0
- data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/property_without_type.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/service_resource.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb +1 -1
- data/lib/rubocop/cop/chef/correctness/tmp_path.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/ use_automatic_resource_name.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_rest.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/cheffile.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/depends_poise.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/easy_install.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/epic_fail.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/erl_call.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb +43 -0
- data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb +42 -0
- data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb +3 -3
- data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/name_property_and_default.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/node_deep_fetch.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/node_set.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/node_set_unless.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/node_set_without_level.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/poise_archive.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/require_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb +47 -0
- data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/berksfile.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/data_bags.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/node_environment.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/node_policygroup.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/node_roles.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb +1 -1
- data/lib/rubocop/cop/chef/effortless/search_used.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/apt_default_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/berksfile_source.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/build_essential.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/chef_14_resources.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/cron_manage_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/databag_helpers.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/default_action_initializer.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/definitions.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/execute_apt_update.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/execute_sleep.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/libarchive_file.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/node_init_package.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/node_roles_include.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/provides_initializer.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/resource_name_initializer.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/resource_set_or_return.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/resource_with_attributes.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/sc_windows_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/shell_out_helper.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb +17 -13
- data/lib/rubocop/cop/chef/modernize/use_require_relative.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb +4 -4
- data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb +1 -1
- data/lib/rubocop/cop/chef/modernize/zypper_repo.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/double_compile_time.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/provides_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb +13 -12
- data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb +1 -1
- data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb +1 -1
- data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb +1 -1
- data/lib/rubocop/cop/chef/style/attribute_keys.rb +1 -1
- data/lib/rubocop/cop/chef/style/chef_whaaat.rb +1 -1
- data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb +1 -1
- data/lib/rubocop/cop/chef/style/comments_copyright_format.rb +4 -3
- data/lib/rubocop/cop/chef/style/comments_default_copyright.rb +1 -1
- data/lib/rubocop/cop/chef/style/comments_format.rb +1 -1
- data/lib/rubocop/cop/chef/style/file_mode.rb +1 -1
- data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb +1 -1
- data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb +1 -1
- data/lib/rubocop/cop/chef/style/negating_only_if.rb +1 -1
- data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb +1 -1
- data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb +1 -1
- data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb +1 -1
- data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb +1 -1
- data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb +1 -1
- data/lib/rubocop/cop/chef/style/use_platform_helpers.rb +1 -1
- data/lib/rubocop/monkey_patches/comment_config.rb +1 -1
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8088b6d9be87be39e75eb71adcaf0ce5d1470f2fc560313d33a023b46de609f4
|
4
|
+
data.tar.gz: d62c2c523a653133a5926ada9ec9bfcee1fc17bb9f37bc1095e140f4bf106c38
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2dfdc60f0577fd7d2e9445e321f8412a0b8711a9f6b4e0ac8611d98519f809df02d2d4c1614e56dc613eb271230a754b5fef5eb4d61a8265090183d803dcda68
|
7
|
+
data.tar.gz: 628882e2d671e86016e303782139fbf7b3cc8f1715e73f1228fcb6d5eb15dcb19319e3f556533d7a048d2bb613bdcc2cc55d01aa52e45ef70c32548e53bbbfad
|
data/Gemfile
CHANGED
data/config/cookstyle.yml
CHANGED
@@ -7,13 +7,13 @@ AllCops:
|
|
7
7
|
- Guardfile
|
8
8
|
|
9
9
|
###############################
|
10
|
-
#
|
10
|
+
# Chef/Style: Making cookbooks look better
|
11
11
|
###############################
|
12
12
|
|
13
|
-
|
14
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
13
|
+
Chef/Style:
|
14
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_style.md
|
15
15
|
|
16
|
-
|
16
|
+
Chef/Style/AttributeKeys:
|
17
17
|
Description: Check which style of keys are used to access node attributes.
|
18
18
|
StyleGuide: '#chefstyleattributekeys'
|
19
19
|
Enabled: true
|
@@ -25,19 +25,19 @@ ChefStyle/AttributeKeys:
|
|
25
25
|
Exclude:
|
26
26
|
- '**/metadata.rb'
|
27
27
|
|
28
|
-
|
28
|
+
Chef/Style/CopyrightCommentFormat:
|
29
29
|
Description: Properly format copyright dates in comment blocks and ensure dates are up to date
|
30
30
|
StyleGuide: '#chefstylecopyrightcommentformat'
|
31
31
|
Enabled: false
|
32
32
|
VersionAdded: '5.0.0'
|
33
33
|
|
34
|
-
|
34
|
+
Chef/Style/CommentSentenceSpacing:
|
35
35
|
Description: Use a single space after sentences in comments
|
36
36
|
StyleGuide: '#chefstylecommentsentencespacing'
|
37
37
|
Enabled: false
|
38
38
|
VersionAdded: '5.1.0'
|
39
39
|
|
40
|
-
|
40
|
+
Chef/Style/CommentFormat:
|
41
41
|
Description: Use Chef's unique format for comment headers
|
42
42
|
StyleGuide: '#chefstylecommentformat'
|
43
43
|
Enabled: true
|
@@ -45,7 +45,7 @@ ChefStyle/CommentFormat:
|
|
45
45
|
Exclude:
|
46
46
|
- '**/Berksfile'
|
47
47
|
|
48
|
-
|
48
|
+
Chef/Style/FileMode:
|
49
49
|
Description: Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
|
50
50
|
StyleGuide: '#chefstylefilemode'
|
51
51
|
Enabled: true
|
@@ -55,7 +55,7 @@ ChefStyle/FileMode:
|
|
55
55
|
- '**/metadata.rb'
|
56
56
|
- '**/Berksfile'
|
57
57
|
|
58
|
-
|
58
|
+
Chef/Style/UsePlatformHelpers:
|
59
59
|
Description: Use platform? and platform_family? helpers to check node platform in resources and recipes
|
60
60
|
StyleGuide: '#chefstyleuseplatformhelpers'
|
61
61
|
Enabled: true
|
@@ -65,7 +65,7 @@ ChefStyle/UsePlatformHelpers:
|
|
65
65
|
- '**/libraries/*'
|
66
66
|
- '**/Berksfile'
|
67
67
|
|
68
|
-
|
68
|
+
Chef/Style/SimplifyPlatformMajorVersionCheck:
|
69
69
|
Description: Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]
|
70
70
|
StyleGuide: '#chefstylesimplifyplatformmajorversioncheck'
|
71
71
|
Enabled: true
|
@@ -74,13 +74,13 @@ ChefStyle/SimplifyPlatformMajorVersionCheck:
|
|
74
74
|
- '**/metadata.rb'
|
75
75
|
- '**/Berksfile'
|
76
76
|
|
77
|
-
|
77
|
+
Chef/Style/DefaultCopyrightComments:
|
78
78
|
Description: Cookbook copyright comment headers should be updated for a real person or organization.
|
79
79
|
StyleGuide: '#chefstyledefaultcopyrightcomments'
|
80
80
|
Enabled: true
|
81
81
|
VersionAdded: '5.12.0'
|
82
82
|
|
83
|
-
|
83
|
+
Chef/Style/UnnecessaryPlatformCaseStatement:
|
84
84
|
Description: Use the platform?() and platform_family?() helpers instead of a case statement that only includes a single when statement.
|
85
85
|
StyleGuide: '#chefstyleunnecessaryplatformcasestatement'
|
86
86
|
Enabled: true
|
@@ -89,7 +89,7 @@ ChefStyle/UnnecessaryPlatformCaseStatement:
|
|
89
89
|
- '**/metadata.rb'
|
90
90
|
- '**/Berksfile'
|
91
91
|
|
92
|
-
|
92
|
+
Chef/Style/ImmediateNotificationTiming:
|
93
93
|
Description: Use :immediately instead of :immediate for resource notification timing.
|
94
94
|
StyleGuide: '#chefstyleimmediatenotificationtiming'
|
95
95
|
Enabled: true
|
@@ -99,7 +99,7 @@ ChefStyle/ImmediateNotificationTiming:
|
|
99
99
|
- '**/metadata.rb'
|
100
100
|
- '**/Berksfile'
|
101
101
|
|
102
|
-
|
102
|
+
Chef/Style/TrueClassFalseClassResourceProperties:
|
103
103
|
Description: 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.
|
104
104
|
StyleGuide: '#chefstyletrueclassfalseclassresourceproperties'
|
105
105
|
Enabled: true
|
@@ -108,7 +108,7 @@ ChefStyle/TrueClassFalseClassResourceProperties:
|
|
108
108
|
- '**/libraries/*.rb'
|
109
109
|
- '**/resources/*.rb'
|
110
110
|
|
111
|
-
|
111
|
+
Chef/Style/OverlyComplexSupportsDependsMetadata:
|
112
112
|
Description: Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set.
|
113
113
|
StyleGuide: '#chefstyleovercomplexsupportsdependsmetadata'
|
114
114
|
Enabled: true
|
@@ -116,13 +116,13 @@ ChefStyle/OverlyComplexSupportsDependsMetadata:
|
|
116
116
|
Include:
|
117
117
|
- '**/metadata.rb'
|
118
118
|
|
119
|
-
|
119
|
+
Chef/Style/ChefWhaaat:
|
120
120
|
Description: Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?
|
121
121
|
StyleGuide: '#chefstylechefwhaaat'
|
122
122
|
Enabled: false
|
123
123
|
VersionAdded: '5.20.0'
|
124
124
|
|
125
|
-
|
125
|
+
Chef/Style/UnnecessaryOSCheck:
|
126
126
|
Description: 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.
|
127
127
|
StyleGuide: '#chefstyleunnecessaryoscheck'
|
128
128
|
Enabled: true
|
@@ -131,7 +131,7 @@ ChefStyle/UnnecessaryOSCheck:
|
|
131
131
|
- '**/metadata.rb'
|
132
132
|
- '**/Berksfile'
|
133
133
|
|
134
|
-
|
134
|
+
Chef/Style/NegatingOnlyIf:
|
135
135
|
Description: Use not_if instead of only_if that negates the Ruby statement with a !
|
136
136
|
StyleGuide: '#chefstylenegatingonlyif'
|
137
137
|
VersionAdded: '6.2.0'
|
@@ -140,7 +140,7 @@ ChefStyle/NegatingOnlyIf:
|
|
140
140
|
- '**/metadata.rb'
|
141
141
|
- '**/Berksfile'
|
142
142
|
|
143
|
-
|
143
|
+
Chef/Style/IncludeRecipeWithParentheses:
|
144
144
|
Description: There is no need to wrap the recipe in parentheses when using the include_recipe helper
|
145
145
|
StyleGuide: '#includerecipewithparentheses'
|
146
146
|
VersionAdded: '6.11.0'
|
@@ -151,13 +151,13 @@ ChefStyle/IncludeRecipeWithParentheses:
|
|
151
151
|
- '**/Berksfile'
|
152
152
|
|
153
153
|
###############################
|
154
|
-
#
|
154
|
+
# Chef/Correctness: Avoiding potential problems
|
155
155
|
###############################
|
156
156
|
|
157
|
-
|
158
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
157
|
+
Chef/Correctness:
|
158
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_correctness.md
|
159
159
|
|
160
|
-
|
160
|
+
Chef/Correctness/ServiceResource:
|
161
161
|
Description: Use a service resource to start and stop services instead of execute resources
|
162
162
|
StyleGuide: '#chefcorrectnessserviceresource'
|
163
163
|
Enabled: true
|
@@ -167,7 +167,7 @@ ChefCorrectness/ServiceResource:
|
|
167
167
|
- '**/metadata.rb'
|
168
168
|
- '**/Berksfile'
|
169
169
|
|
170
|
-
|
170
|
+
Chef/Correctness/NodeNormal:
|
171
171
|
Description: Do not use the node.normal method
|
172
172
|
StyleGuide: '#chefcorrectnessnodenormal'
|
173
173
|
Enabled: true
|
@@ -176,7 +176,7 @@ ChefCorrectness/NodeNormal:
|
|
176
176
|
- '**/metadata.rb'
|
177
177
|
- '**/Berksfile'
|
178
178
|
|
179
|
-
|
179
|
+
Chef/Correctness/NodeNormalUnless:
|
180
180
|
Description: Do not use the node.normal_unless method
|
181
181
|
Enabled: true
|
182
182
|
VersionAdded: '5.1.0'
|
@@ -184,7 +184,7 @@ ChefCorrectness/NodeNormalUnless:
|
|
184
184
|
- '**/metadata.rb'
|
185
185
|
- '**/Berksfile'
|
186
186
|
|
187
|
-
|
187
|
+
Chef/Correctness/TmpPath:
|
188
188
|
Description: Use file_cache_path rather than hard-coding tmp paths
|
189
189
|
StyleGuide: '#chefcorrectnessnodenormalunless'
|
190
190
|
Enabled: true
|
@@ -193,7 +193,7 @@ ChefCorrectness/TmpPath:
|
|
193
193
|
- '**/metadata.rb'
|
194
194
|
- '**/Berksfile'
|
195
195
|
|
196
|
-
|
196
|
+
Chef/Correctness/InvalidPlatformMetadata:
|
197
197
|
Description: metadata.rb "supports" platform is invalid
|
198
198
|
StyleGuide: '#chefcorrectnessinvalidplatformmetadata'
|
199
199
|
Enabled: true
|
@@ -201,7 +201,7 @@ ChefCorrectness/InvalidPlatformMetadata:
|
|
201
201
|
Include:
|
202
202
|
- '**/metadata.rb'
|
203
203
|
|
204
|
-
|
204
|
+
Chef/Correctness/CookbookUsesNodeSave:
|
205
205
|
Description: 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.
|
206
206
|
StyleGuide: '#chefcorrectnesscookbookusesnodesave'
|
207
207
|
Enabled: true
|
@@ -210,7 +210,7 @@ ChefCorrectness/CookbookUsesNodeSave:
|
|
210
210
|
- '**/metadata.rb'
|
211
211
|
- '**/Berksfile'
|
212
212
|
|
213
|
-
|
213
|
+
Chef/Correctness/MetadataMissingName:
|
214
214
|
Description: The metadata.rb file is missing the name field which is required by Chef Infra Client 12 and later
|
215
215
|
StyleGuide: '#chefcorrectnessmetadatamissingname'
|
216
216
|
Enabled: true
|
@@ -218,7 +218,7 @@ ChefCorrectness/MetadataMissingName:
|
|
218
218
|
Include:
|
219
219
|
- '**/metadata.rb'
|
220
220
|
|
221
|
-
|
221
|
+
Chef/Correctness/BlockGuardWithOnlyString:
|
222
222
|
Description: 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.
|
223
223
|
StyleGuide: '#chefcorrectnessblockguardwithonlystring'
|
224
224
|
Enabled: true
|
@@ -228,7 +228,7 @@ ChefCorrectness/BlockGuardWithOnlyString:
|
|
228
228
|
- '**/metadata.rb'
|
229
229
|
- '**/Berksfile'
|
230
230
|
|
231
|
-
|
231
|
+
Chef/Correctness/ResourceSetsInternalProperties:
|
232
232
|
Description: Do not set properties used internally by Chef Infra Client to track the system state.
|
233
233
|
StyleGuide: '#chefcorrectnessresourcesetsinternalproperties'
|
234
234
|
Enabled: true
|
@@ -238,7 +238,7 @@ ChefCorrectness/ResourceSetsInternalProperties:
|
|
238
238
|
- '**/metadata.rb'
|
239
239
|
- '**/Berksfile'
|
240
240
|
|
241
|
-
|
241
|
+
Chef/Correctness/ResourceSetsNameProperty:
|
242
242
|
Description: Resource sets the name property in the resource instead of using a name_property.
|
243
243
|
StyleGuide: '#chefcorrectnessresourcesetsnameproperty'
|
244
244
|
Enabled: true
|
@@ -248,7 +248,7 @@ ChefCorrectness/ResourceSetsNameProperty:
|
|
248
248
|
- '**/metadata.rb'
|
249
249
|
- '**/Berksfile'
|
250
250
|
|
251
|
-
|
251
|
+
Chef/Correctness/ResourceWithNoneAction:
|
252
252
|
Description: Resource uses the nonexistent :none action instead of the :nothing action
|
253
253
|
StyleGuide: '#chefcorrectnessresourcewithnoneaction'
|
254
254
|
Enabled: true
|
@@ -258,7 +258,7 @@ ChefCorrectness/ResourceWithNoneAction:
|
|
258
258
|
- '**/metadata.rb'
|
259
259
|
- '**/Berksfile'
|
260
260
|
|
261
|
-
|
261
|
+
Chef/Correctness/InvalidVersionMetadata:
|
262
262
|
Description: Cookbook metadata.rb version field should follow X.Y.Z version format.
|
263
263
|
StyleGuide: '#chefcorrectnessinvalidversionmetadata'
|
264
264
|
Enabled: true
|
@@ -266,7 +266,7 @@ ChefCorrectness/InvalidVersionMetadata:
|
|
266
266
|
Include:
|
267
267
|
- '**/metadata.rb'
|
268
268
|
|
269
|
-
|
269
|
+
Chef/Correctness/NotifiesActionNotSymbol:
|
270
270
|
Description: 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.
|
271
271
|
StyleGuide: '#chefcorrectnessnotifiesactionnotsymbol'
|
272
272
|
Enabled: true
|
@@ -276,7 +276,7 @@ ChefCorrectness/NotifiesActionNotSymbol:
|
|
276
276
|
- '**/metadata.rb'
|
277
277
|
- '**/Berksfile'
|
278
278
|
|
279
|
-
|
279
|
+
Chef/Correctness/IncorrectLibraryInjection:
|
280
280
|
Description: Libraries should be injected into the Chef::DSL::Recipe or Chef::DSL::Resource classes and not Recipe/Resource/Provider classes directly.
|
281
281
|
StyleGuide: '#chefcorrectnessincorrectlibraryinjection'
|
282
282
|
Enabled: true
|
@@ -285,7 +285,7 @@ ChefCorrectness/IncorrectLibraryInjection:
|
|
285
285
|
- '**/metadata.rb'
|
286
286
|
- '**/Berksfile'
|
287
287
|
|
288
|
-
|
288
|
+
Chef/Correctness/InvalidPlatformHelper:
|
289
289
|
Description: Pass valid platforms to the platform? helper.
|
290
290
|
StyleGuide: '#chefcorrectnessinvalidplatformhelper'
|
291
291
|
Enabled: true
|
@@ -294,7 +294,7 @@ ChefCorrectness/InvalidPlatformHelper:
|
|
294
294
|
- '**/metadata.rb'
|
295
295
|
- '**/Berksfile'
|
296
296
|
|
297
|
-
|
297
|
+
Chef/Correctness/InvalidPlatformFamilyHelper:
|
298
298
|
Description: Pass valid platform families to the platform_family? helper.
|
299
299
|
StyleGuide: '#chefcorrectnessinvalidplatformfamilyhelper'
|
300
300
|
Enabled: true
|
@@ -303,7 +303,7 @@ ChefCorrectness/InvalidPlatformFamilyHelper:
|
|
303
303
|
- '**/metadata.rb'
|
304
304
|
- '**/Berksfile'
|
305
305
|
|
306
|
-
|
306
|
+
Chef/Correctness/ScopedFileExist:
|
307
307
|
Description: Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
|
308
308
|
StyleGuide: '#chefcorrectnessscopedfileexist'
|
309
309
|
Enabled: true
|
@@ -313,7 +313,7 @@ ChefCorrectness/ScopedFileExist:
|
|
313
313
|
- '**/metadata.rb'
|
314
314
|
- '**/Berksfile'
|
315
315
|
|
316
|
-
|
316
|
+
Chef/Correctness/InvalidPlatformValueForPlatformFamilyHelper:
|
317
317
|
Description: Pass valid platforms families to the value_for_platform_family helper.
|
318
318
|
StyleGuide: '#chefcorrectnessinvalidplatformvalueforplatformfamilyhelper'
|
319
319
|
Enabled: true
|
@@ -322,7 +322,7 @@ ChefCorrectness/InvalidPlatformValueForPlatformFamilyHelper:
|
|
322
322
|
- '**/metadata.rb'
|
323
323
|
- '**/Berksfile'
|
324
324
|
|
325
|
-
|
325
|
+
Chef/Correctness/InvalidPlatformValueForPlatformHelper:
|
326
326
|
Description: Pass valid platforms to the value_for_platform helper.
|
327
327
|
StyleGuide: '#chefcorrectnessinvalidplatformvalueforplatformhelper'
|
328
328
|
Enabled: true
|
@@ -331,7 +331,7 @@ ChefCorrectness/InvalidPlatformValueForPlatformHelper:
|
|
331
331
|
- '**/metadata.rb'
|
332
332
|
- '**/Berksfile'
|
333
333
|
|
334
|
-
|
334
|
+
Chef/Correctness/InvalidNotificationTiming:
|
335
335
|
Description: Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
|
336
336
|
StyleGuide: '#chefcorrectnessinvalidnotificationtiming'
|
337
337
|
Enabled: true
|
@@ -341,7 +341,7 @@ ChefCorrectness/InvalidNotificationTiming:
|
|
341
341
|
- '**/metadata.rb'
|
342
342
|
- '**/Berksfile'
|
343
343
|
|
344
|
-
|
344
|
+
Chef/Correctness/MalformedPlatformValueForPlatformHelper:
|
345
345
|
Description: 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'.
|
346
346
|
StyleGuide: '#chefcorrectnessmalformedplatformvalueforplatformhelper'
|
347
347
|
Enabled: true
|
@@ -350,7 +350,7 @@ ChefCorrectness/MalformedPlatformValueForPlatformHelper:
|
|
350
350
|
- '**/metadata.rb'
|
351
351
|
- '**/Berksfile'
|
352
352
|
|
353
|
-
|
353
|
+
Chef/Correctness/DnfPackageAllowDowngrades:
|
354
354
|
Description: dnf_package does not support the allow_downgrades property
|
355
355
|
StyleGuide: '#chefcorrectnessdnfpackageallowdowngrades'
|
356
356
|
Enabled: true
|
@@ -360,7 +360,7 @@ ChefCorrectness/DnfPackageAllowDowngrades:
|
|
360
360
|
- '**/metadata.rb'
|
361
361
|
- '**/Berksfile'
|
362
362
|
|
363
|
-
|
363
|
+
Chef/Correctness/ChefApplicationFatal:
|
364
364
|
Description: Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal
|
365
365
|
StyleGuide: '#chefcorrectnesschefapplicationfatal'
|
366
366
|
Enabled: true
|
@@ -369,7 +369,7 @@ ChefCorrectness/ChefApplicationFatal:
|
|
369
369
|
- '**/metadata.rb'
|
370
370
|
- '**/Berksfile'
|
371
371
|
|
372
|
-
|
372
|
+
Chef/Correctness/PowershellScriptDeleteFile:
|
373
373
|
Description: 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
|
374
374
|
StyleGuide: '#chefcorrectnesspowershellscriptdeletefiles'
|
375
375
|
Enabled: true
|
@@ -379,7 +379,7 @@ ChefCorrectness/PowershellScriptDeleteFile:
|
|
379
379
|
- '**/metadata.rb'
|
380
380
|
- '**/Berksfile'
|
381
381
|
|
382
|
-
|
382
|
+
Chef/Correctness/ConditionalRubyShellout:
|
383
383
|
Description: Don't use Ruby to shellout in an only_if / not_if conditional when you can shellout directly by wrapping the command in quotes.
|
384
384
|
StyleGuide: '#chefcorrectnessconditionalrubyshellout'
|
385
385
|
Enabled: true
|
@@ -389,7 +389,7 @@ ChefCorrectness/ConditionalRubyShellout:
|
|
389
389
|
- '**/metadata.rb'
|
390
390
|
- '**/Berksfile'
|
391
391
|
|
392
|
-
|
392
|
+
Chef/Correctness/LazyEvalNodeAttributeDefaults:
|
393
393
|
Description: When setting a node attribute as a default value for a custom resource property, make sure to wrap the node attribute in `lazy {}` so that the node attribute is available when the resource executes.
|
394
394
|
StyleGuide: '#chefcorrectnesslazyevalnodeattributedefaults'
|
395
395
|
Enabled: true
|
@@ -398,7 +398,7 @@ ChefCorrectness/LazyEvalNodeAttributeDefaults:
|
|
398
398
|
- '**/libraries/*.rb'
|
399
399
|
- '**/resources/*.rb'
|
400
400
|
|
401
|
-
|
401
|
+
Chef/Correctness/OpenSSLPasswordHelpers:
|
402
402
|
Description: The secure_password helper from the openssl cookbooks Opscode::OpenSSL::Password class should not be used to generate passwords.
|
403
403
|
StyleGuide: '#chefcorrectnessopensslpasswordhelpers'
|
404
404
|
Enabled: true
|
@@ -407,7 +407,7 @@ ChefCorrectness/OpenSSLPasswordHelpers:
|
|
407
407
|
- '**/metadata.rb'
|
408
408
|
- '**/Berksfile'
|
409
409
|
|
410
|
-
|
410
|
+
Chef/Correctness/InvalidPlatformFamilyInCase:
|
411
411
|
Description: Use valid platform family values in case statements.
|
412
412
|
StyleGuide: '#chefcorrectnessinvalidplatformfamilyincase'
|
413
413
|
Enabled: true
|
@@ -416,7 +416,7 @@ ChefCorrectness/InvalidPlatformFamilyInCase:
|
|
416
416
|
- '**/metadata.rb'
|
417
417
|
- '**/Berksfile'
|
418
418
|
|
419
|
-
|
419
|
+
Chef/Correctness/InvalidPlatformInCase:
|
420
420
|
Description: Use valid platform values in case statements.
|
421
421
|
StyleGuide: '#chefcorrectnessinvalidplatformincase'
|
422
422
|
Enabled: true
|
@@ -425,7 +425,7 @@ ChefCorrectness/InvalidPlatformInCase:
|
|
425
425
|
- '**/metadata.rb'
|
426
426
|
- '**/Berksfile'
|
427
427
|
|
428
|
-
|
428
|
+
Chef/Correctness/InvalidDefaultAction:
|
429
429
|
Description: Default actions in resources should be a symbol or an array of symbols.
|
430
430
|
StyleGuide: '#chefcorrectnessinvaliddefaultaction'
|
431
431
|
Enabled: true
|
@@ -434,7 +434,7 @@ ChefCorrectness/InvalidDefaultAction:
|
|
434
434
|
- '**/libraries/*.rb'
|
435
435
|
- '**/resources/*.rb'
|
436
436
|
|
437
|
-
|
437
|
+
Chef/Correctness/SupportsMustBeFloat:
|
438
438
|
Description: Versions used in metadata.rb supports calls should be floats not integers.
|
439
439
|
StyleGuide: '#chefcorrectnesssupportsmustbefloat'
|
440
440
|
Enabled: true
|
@@ -442,7 +442,7 @@ ChefCorrectness/SupportsMustBeFloat:
|
|
442
442
|
Include:
|
443
443
|
- '**/metadata.rb'
|
444
444
|
|
445
|
-
|
445
|
+
Chef/Correctness/MacosUserdefaultsInvalidType:
|
446
446
|
Description: 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'.
|
447
447
|
StyleGuide: '#chefcorrectnessmacosuserdefaultsinvalidtype'
|
448
448
|
Enabled: true
|
@@ -451,7 +451,7 @@ ChefCorrectness/MacosUserdefaultsInvalidType:
|
|
451
451
|
- '**/metadata.rb'
|
452
452
|
- '**/Berksfile'
|
453
453
|
|
454
|
-
|
454
|
+
Chef/Correctness/LazyInResourceGuard:
|
455
455
|
Description: Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
|
456
456
|
StyleGuide: '#chefcorrectnesslazyinresourceguard'
|
457
457
|
Enabled: true
|
@@ -460,7 +460,7 @@ ChefCorrectness/LazyInResourceGuard:
|
|
460
460
|
- '**/metadata.rb'
|
461
461
|
- '**/Berksfile'
|
462
462
|
|
463
|
-
|
463
|
+
Chef/Correctness/PropertyWithoutType:
|
464
464
|
Description: Custom resource properties or attributes should always define a type to help users understand the correct allowed values.
|
465
465
|
StyleGuide: '#chefcorrectnesspropertywithouttype'
|
466
466
|
Enabled: true
|
@@ -469,14 +469,24 @@ ChefCorrectness/PropertyWithoutType:
|
|
469
469
|
- '**/libraries/*.rb'
|
470
470
|
- '**/resources/*.rb'
|
471
471
|
|
472
|
+
Chef/Correctness/OctalModeAsString:
|
473
|
+
Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
|
474
|
+
StyleGuide: '#chefcorrectnessoctalmodeasstring'
|
475
|
+
Enabled: true
|
476
|
+
VersionAdded: '6.21.0'
|
477
|
+
Exclude:
|
478
|
+
- '**/attributes/*.rb'
|
479
|
+
- '**/metadata.rb'
|
480
|
+
- '**/Berksfile'
|
481
|
+
|
472
482
|
###############################
|
473
|
-
#
|
483
|
+
# Chef/Sharing: Issues that prevent sharing code with other teams or with the Chef community in general
|
474
484
|
###############################
|
475
485
|
|
476
|
-
|
477
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
486
|
+
Chef/Sharing:
|
487
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_sharing.md
|
478
488
|
|
479
|
-
|
489
|
+
Chef/Sharing/InsecureCookbookURL:
|
480
490
|
Description: Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields
|
481
491
|
StyleGuide: '#chefsharinginsecurecookbookurl'
|
482
492
|
Enabled: true
|
@@ -485,7 +495,7 @@ ChefSharing/InsecureCookbookURL:
|
|
485
495
|
Include:
|
486
496
|
- '**/metadata.rb'
|
487
497
|
|
488
|
-
|
498
|
+
Chef/Sharing/InvalidLicenseString:
|
489
499
|
Description: Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved"
|
490
500
|
StyleGuide: '#chefsharinginvalidlicensestring'
|
491
501
|
Enabled: true
|
@@ -494,7 +504,7 @@ ChefSharing/InvalidLicenseString:
|
|
494
504
|
Include:
|
495
505
|
- '**/metadata.rb'
|
496
506
|
|
497
|
-
|
507
|
+
Chef/Sharing/DefaultMetadataMaintainer:
|
498
508
|
Description: Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.
|
499
509
|
StyleGuide: '#chefsharingdefaultmetadatamaintainer'
|
500
510
|
Enabled: true
|
@@ -503,7 +513,7 @@ ChefSharing/DefaultMetadataMaintainer:
|
|
503
513
|
Include:
|
504
514
|
- '**/metadata.rb'
|
505
515
|
|
506
|
-
|
516
|
+
Chef/Sharing/EmptyMetadataField:
|
507
517
|
Description: metadata.rb should not include fields with an empty string. Either don't include the field or add a value.
|
508
518
|
StyleGuide: '#chefsharingemptymetadatafield'
|
509
519
|
Enabled: true
|
@@ -512,7 +522,7 @@ ChefSharing/EmptyMetadataField:
|
|
512
522
|
Include:
|
513
523
|
- '**/metadata.rb'
|
514
524
|
|
515
|
-
|
525
|
+
Chef/Sharing/IncludePropertyDescriptions:
|
516
526
|
Description: Properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
517
527
|
StyleGuide: '#chefsharingincludepropetydescriptions'
|
518
528
|
Enabled: false
|
@@ -521,7 +531,7 @@ ChefSharing/IncludePropertyDescriptions:
|
|
521
531
|
- '**/libraries/*.rb'
|
522
532
|
- '**/resources/*.rb'
|
523
533
|
|
524
|
-
|
534
|
+
Chef/Sharing/IncludeResourceDescriptions:
|
525
535
|
Description: Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
526
536
|
StyleGuide: '#chefsharingincluderesourcedescriptions'
|
527
537
|
Enabled: false
|
@@ -529,7 +539,7 @@ ChefSharing/IncludeResourceDescriptions:
|
|
529
539
|
Include:
|
530
540
|
- '**/resources/*.rb'
|
531
541
|
|
532
|
-
|
542
|
+
Chef/Sharing/IncludeResourceExamples:
|
533
543
|
Description: Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
|
534
544
|
StyleGuide: '#chefsharingincluderesourceexamples'
|
535
545
|
Enabled: false
|
@@ -538,13 +548,13 @@ ChefSharing/IncludeResourceExamples:
|
|
538
548
|
- '**/resources/*.rb'
|
539
549
|
|
540
550
|
###############################
|
541
|
-
#
|
551
|
+
# Chef/Deprecations: Resolving Deprecations that block upgrading Chef Infra Client
|
542
552
|
###############################
|
543
553
|
|
544
|
-
|
545
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
554
|
+
Chef/Deprecations:
|
555
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_deprecations.md
|
546
556
|
|
547
|
-
|
557
|
+
Chef/Deprecations/NodeDeepFetch:
|
548
558
|
Description: Do not use the deprecated chef-sugar node.deep_fetch methods
|
549
559
|
StyleGuide: '#chefdeprecationsnodedeepfetch'
|
550
560
|
Enabled: true
|
@@ -553,7 +563,7 @@ ChefDeprecations/NodeDeepFetch:
|
|
553
563
|
- '**/metadata.rb'
|
554
564
|
- '**/Berksfile'
|
555
565
|
|
556
|
-
|
566
|
+
Chef/Deprecations/NodeSet:
|
557
567
|
Description: Do not use the deprecated node.set method
|
558
568
|
StyleGuide: '#chefdeprecationsnodeset'
|
559
569
|
Enabled: true
|
@@ -562,7 +572,7 @@ ChefDeprecations/NodeSet:
|
|
562
572
|
- '**/metadata.rb'
|
563
573
|
- '**/Berksfile'
|
564
574
|
|
565
|
-
|
575
|
+
Chef/Deprecations/NodeSetUnless:
|
566
576
|
Description: Do not use the deprecated node.set_unless method
|
567
577
|
StyleGuide: '#chefdeprecationsnodesetunless'
|
568
578
|
Enabled: true
|
@@ -571,7 +581,7 @@ ChefDeprecations/NodeSetUnless:
|
|
571
581
|
- '**/metadata.rb'
|
572
582
|
- '**/Berksfile'
|
573
583
|
|
574
|
-
|
584
|
+
Chef/Deprecations/EpicFail:
|
575
585
|
Description: Use ignore_failure method instead of the deprecated epic_fail method
|
576
586
|
StyleGuide: '#chefdeprecationsepicfail'
|
577
587
|
Enabled: true
|
@@ -581,7 +591,7 @@ ChefDeprecations/EpicFail:
|
|
581
591
|
- '**/metadata.rb'
|
582
592
|
- '**/Berksfile'
|
583
593
|
|
584
|
-
|
594
|
+
Chef/Deprecations/CookbookDependsOnPoise:
|
585
595
|
Description: Cookbooks should not depend on the deprecated Poise framework
|
586
596
|
StyleGuide: '#chefdeprecationscookbookdependsonpoise'
|
587
597
|
Enabled: true
|
@@ -589,7 +599,7 @@ ChefDeprecations/CookbookDependsOnPoise:
|
|
589
599
|
Include:
|
590
600
|
- '**/metadata.rb'
|
591
601
|
|
592
|
-
|
602
|
+
Chef/Deprecations/CookbookDependsOnCompatResource:
|
593
603
|
Description: Don't depend on the deprecated compat_resource cookbook made obsolete by Chef Infra Client 12.19+
|
594
604
|
StyleGuide: '#chefdeprecationscookbookdependsoncompatresource'
|
595
605
|
Enabled: true
|
@@ -597,7 +607,7 @@ ChefDeprecations/CookbookDependsOnCompatResource:
|
|
597
607
|
Include:
|
598
608
|
- '**/metadata.rb'
|
599
609
|
|
600
|
-
|
610
|
+
Chef/Deprecations/CookbookDependsOnPartialSearch:
|
601
611
|
Description: Don't depend on the deprecated partial_search cookbook made obsolete by Chef Infra Client 13+
|
602
612
|
StyleGuide: '#chefdeprecationscookbookdependsonpartialsearch'
|
603
613
|
Enabled: true
|
@@ -605,7 +615,7 @@ ChefDeprecations/CookbookDependsOnPartialSearch:
|
|
605
615
|
Include:
|
606
616
|
- '**/metadata.rb'
|
607
617
|
|
608
|
-
|
618
|
+
Chef/Deprecations/EasyInstallResource:
|
609
619
|
Description: Don't use the deprecated easy_install resource resource removed in Chef Infra Client 13
|
610
620
|
StyleGuide: '#chefdeprecationseasyinstallresource'
|
611
621
|
Enabled: true
|
@@ -615,7 +625,7 @@ ChefDeprecations/EasyInstallResource:
|
|
615
625
|
- '**/metadata.rb'
|
616
626
|
- '**/Berksfile'
|
617
627
|
|
618
|
-
|
628
|
+
Chef/Deprecations/ErlCallResource:
|
619
629
|
Description: Don't use the deprecated erl_call resource removed in Chef Infra Client 13
|
620
630
|
StyleGuide: '#chefdeprecationserlcallresource'
|
621
631
|
Enabled: true
|
@@ -625,7 +635,7 @@ ChefDeprecations/ErlCallResource:
|
|
625
635
|
- '**/metadata.rb'
|
626
636
|
- '**/Berksfile'
|
627
637
|
|
628
|
-
|
638
|
+
Chef/Deprecations/RequireRecipe:
|
629
639
|
Description: Use include_recipe instead of the require_recipe method
|
630
640
|
StyleGuide: '#chefdeprecationsrequirerecipe'
|
631
641
|
Enabled: true
|
@@ -635,7 +645,7 @@ ChefDeprecations/RequireRecipe:
|
|
635
645
|
- '**/metadata.rb'
|
636
646
|
- '**/Berksfile'
|
637
647
|
|
638
|
-
|
648
|
+
Chef/Deprecations/NodeMethodsInsteadofAttributes:
|
639
649
|
Description: Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.
|
640
650
|
StyleGuide: '#chefdeprecationsnodemethodsinsteadofattributes'
|
641
651
|
Enabled: true
|
@@ -644,7 +654,7 @@ ChefDeprecations/NodeMethodsInsteadofAttributes:
|
|
644
654
|
- '**/metadata.rb'
|
645
655
|
- '**/Berksfile'
|
646
656
|
|
647
|
-
|
657
|
+
Chef/Deprecations/UsesDeprecatedMixins:
|
648
658
|
Description: Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.
|
649
659
|
StyleGuide: '#chefdeprecationsusesdeprecatedmixins'
|
650
660
|
Enabled: true
|
@@ -654,7 +664,7 @@ ChefDeprecations/UsesDeprecatedMixins:
|
|
654
664
|
- '**/providers/*.rb'
|
655
665
|
- '**/resources/*.rb'
|
656
666
|
|
657
|
-
|
667
|
+
Chef/Deprecations/IncludingXMLRubyRecipe:
|
658
668
|
Description: The xml::ruby recipe installs nokogiri which is included in Chef Infra Client 12 and later.
|
659
669
|
StyleGuide: '#chefdeprecationsincludingxmlrubyrecipe'
|
660
670
|
Enabled: true
|
@@ -664,7 +674,7 @@ ChefDeprecations/IncludingXMLRubyRecipe:
|
|
664
674
|
- '**/metadata.rb'
|
665
675
|
- '**/Berksfile'
|
666
676
|
|
667
|
-
|
677
|
+
Chef/Deprecations/LegacyYumCookbookRecipes:
|
668
678
|
Description: The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).
|
669
679
|
StyleGuide: '#chefdeprecationslegacyyumcookbookrecipes'
|
670
680
|
Enabled: true
|
@@ -672,7 +682,7 @@ ChefDeprecations/LegacyYumCookbookRecipes:
|
|
672
682
|
Exclude:
|
673
683
|
- '**/metadata.rb'
|
674
684
|
|
675
|
-
|
685
|
+
Chef/Deprecations/UsesChefRESTHelpers:
|
676
686
|
Description: Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13
|
677
687
|
StyleGuide: '#chefdeprecationsuseschefresthelpers'
|
678
688
|
Enabled: true
|
@@ -680,7 +690,7 @@ ChefDeprecations/UsesChefRESTHelpers:
|
|
680
690
|
Exclude:
|
681
691
|
- '**/metadata.rb'
|
682
692
|
|
683
|
-
|
693
|
+
Chef/Deprecations/ChocolateyPackageUninstallAction:
|
684
694
|
Description: Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
|
685
695
|
StyleGuide: '#chefdeprecationschocolateypackageuninstallaction'
|
686
696
|
Enabled: true
|
@@ -688,7 +698,7 @@ ChefDeprecations/ChocolateyPackageUninstallAction:
|
|
688
698
|
Exclude:
|
689
699
|
- '**/metadata.rb'
|
690
700
|
|
691
|
-
|
701
|
+
Chef/Deprecations/LaunchdDeprecatedHashProperty:
|
692
702
|
Description: The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
|
693
703
|
StyleGuide: '#chefdeprecationslaunchddeprecatedhashproperty'
|
694
704
|
Enabled: true
|
@@ -696,7 +706,7 @@ ChefDeprecations/LaunchdDeprecatedHashProperty:
|
|
696
706
|
Exclude:
|
697
707
|
- '**/metadata.rb'
|
698
708
|
|
699
|
-
|
709
|
+
Chef/Deprecations/LocaleDeprecatedLcAllProperty:
|
700
710
|
Description: The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 16
|
701
711
|
StyleGuide: '#chefdeprecationslocaledeprecatedlcallproperty'
|
702
712
|
Enabled: true
|
@@ -704,7 +714,7 @@ ChefDeprecations/LocaleDeprecatedLcAllProperty:
|
|
704
714
|
Exclude:
|
705
715
|
- '**/metadata.rb'
|
706
716
|
|
707
|
-
|
717
|
+
Chef/Deprecations/UserDeprecatedSupportsProperty:
|
708
718
|
Description: The supports property was removed in Chef Infra Client 13 in favor of individual 'manage_home' and 'non_unique' properties.
|
709
719
|
StyleGuide: '#chefdeprecationsuserdeprecatedsupportsproperty'
|
710
720
|
Enabled: true
|
@@ -712,7 +722,7 @@ ChefDeprecations/UserDeprecatedSupportsProperty:
|
|
712
722
|
Exclude:
|
713
723
|
- '**/metadata.rb'
|
714
724
|
|
715
|
-
|
725
|
+
Chef/Deprecations/UseInlineResourcesDefined:
|
716
726
|
Description: use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.
|
717
727
|
StyleGuide: '#chefdeprecationsuseinlineresourcesdefined'
|
718
728
|
Enabled: true
|
@@ -722,7 +732,7 @@ ChefDeprecations/UseInlineResourcesDefined:
|
|
722
732
|
- '**/providers/*.rb'
|
723
733
|
- '**/resources/*.rb'
|
724
734
|
|
725
|
-
|
735
|
+
Chef/Deprecations/IncludingYumDNFCompatRecipe:
|
726
736
|
Description: Do not include the yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF.
|
727
737
|
StyleGuide: '#chefdeprecationsincludingyumdnfcompatrecipe'
|
728
738
|
Enabled: true
|
@@ -730,7 +740,7 @@ ChefDeprecations/IncludingYumDNFCompatRecipe:
|
|
730
740
|
Exclude:
|
731
741
|
- '**/metadata.rb'
|
732
742
|
|
733
|
-
|
743
|
+
Chef/Deprecations/WindowsTaskChangeAction:
|
734
744
|
Description: The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.
|
735
745
|
StyleGuide: '#chefdeprecationswindowstaskchangeaction'
|
736
746
|
Enabled: true
|
@@ -738,7 +748,7 @@ ChefDeprecations/WindowsTaskChangeAction:
|
|
738
748
|
Exclude:
|
739
749
|
- '**/metadata.rb'
|
740
750
|
|
741
|
-
|
751
|
+
Chef/Deprecations/ResourceOverridesProvidesMethod:
|
742
752
|
Description: Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later.
|
743
753
|
StyleGuide: '#chefdeprecationsresourceoverridesprovidesmethod'
|
744
754
|
Enabled: true
|
@@ -748,7 +758,7 @@ ChefDeprecations/ResourceOverridesProvidesMethod:
|
|
748
758
|
- '**/providers/*.rb'
|
749
759
|
- '**/resources/*.rb'
|
750
760
|
|
751
|
-
|
761
|
+
Chef/Deprecations/ResourceUsesDslNameMethod:
|
752
762
|
Description: Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.
|
753
763
|
StyleGuide: '#chefdeprecationsresourceusesdslnamemethod'
|
754
764
|
Enabled: true
|
@@ -758,7 +768,7 @@ ChefDeprecations/ResourceUsesDslNameMethod:
|
|
758
768
|
- '**/providers/*.rb'
|
759
769
|
- '**/resources/*.rb'
|
760
770
|
|
761
|
-
|
771
|
+
Chef/Deprecations/ResourceUsesUpdatedMethod:
|
762
772
|
Description: Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later.
|
763
773
|
StyleGuide: '#chefdeprecationsresourceusesupdatedmethod'
|
764
774
|
Enabled: false # has a high potential for false positives
|
@@ -768,7 +778,7 @@ ChefDeprecations/ResourceUsesUpdatedMethod:
|
|
768
778
|
- '**/providers/*.rb'
|
769
779
|
- '**/resources/*.rb'
|
770
780
|
|
771
|
-
|
781
|
+
Chef/Deprecations/NamePropertyWithDefaultValue:
|
772
782
|
Description: A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later.
|
773
783
|
StyleGuide: '#chefdeprecationsnamepropertywithdefaultvalue'
|
774
784
|
Enabled: true
|
@@ -777,7 +787,7 @@ ChefDeprecations/NamePropertyWithDefaultValue:
|
|
777
787
|
- '**/libraries/*.rb'
|
778
788
|
- '**/resources/*.rb'
|
779
789
|
|
780
|
-
|
790
|
+
Chef/Deprecations/ResourceUsesProviderBaseMethod:
|
781
791
|
Description: Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later.
|
782
792
|
StyleGuide: '#chefdeprecationsresourceusesproviderbasemethod'
|
783
793
|
Enabled: true
|
@@ -786,7 +796,7 @@ ChefDeprecations/ResourceUsesProviderBaseMethod:
|
|
786
796
|
- '**/libraries/*.rb'
|
787
797
|
- '**/resources/*.rb'
|
788
798
|
|
789
|
-
|
799
|
+
Chef/Deprecations/ChefSpecCoverageReport:
|
790
800
|
Description: Don't use the deprecated ChefSpec coverage report functionality in your specs.
|
791
801
|
StyleGuide: '#chefdeprecationschefspeccoveragereport'
|
792
802
|
Enabled: true
|
@@ -794,7 +804,7 @@ ChefDeprecations/ChefSpecCoverageReport:
|
|
794
804
|
Include:
|
795
805
|
- '**/spec/*.rb'
|
796
806
|
|
797
|
-
|
807
|
+
Chef/Deprecations/ChefSpecLegacyRunner:
|
798
808
|
Description: Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.
|
799
809
|
StyleGuide: '#chefdeprecationschefspeclegacyrunner'
|
800
810
|
Enabled: true
|
@@ -802,7 +812,7 @@ ChefDeprecations/ChefSpecLegacyRunner:
|
|
802
812
|
Include:
|
803
813
|
- '**/spec/*.rb'
|
804
814
|
|
805
|
-
|
815
|
+
Chef/Deprecations/UsesRunCommandHelper:
|
806
816
|
Description: Use 'shell_out!' instead of the legacy 'run_command' helper for shelling out. The run_command helper was removed in Chef Infra Client 13.
|
807
817
|
StyleGuide: '#chefdeprecationsusesruncommandhelper'
|
808
818
|
Enabled: true
|
@@ -811,7 +821,7 @@ ChefDeprecations/UsesRunCommandHelper:
|
|
811
821
|
- '**/metadata.rb'
|
812
822
|
- 'Rakefile'
|
813
823
|
|
814
|
-
|
824
|
+
Chef/Deprecations/ChefHandlerUsesSupports:
|
815
825
|
Description: 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.
|
816
826
|
StyleGuide: '#chefdeprecationschefhandlerusessupports'
|
817
827
|
Enabled: true
|
@@ -819,7 +829,7 @@ ChefDeprecations/ChefHandlerUsesSupports:
|
|
819
829
|
Exclude:
|
820
830
|
- '**/metadata.rb'
|
821
831
|
|
822
|
-
|
832
|
+
Chef/Deprecations/DeprecatedYumRepositoryProperties:
|
823
833
|
Description: With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource were renamed. url -> baseurl, keyurl -> gpgkey, and mirrorexpire -> mirror_expire.
|
824
834
|
StyleGuide: '#chefdeprecationsdeprecatedyumrepositoryproperties'
|
825
835
|
Enabled: true
|
@@ -827,7 +837,7 @@ ChefDeprecations/DeprecatedYumRepositoryProperties:
|
|
827
837
|
Exclude:
|
828
838
|
- '**/metadata.rb'
|
829
839
|
|
830
|
-
|
840
|
+
Chef/Deprecations/EOLAuditModeUsage:
|
831
841
|
Description: 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.
|
832
842
|
StyleGuide: '#chefdeprecationseolauditmodeusage'
|
833
843
|
Enabled: true
|
@@ -835,7 +845,7 @@ ChefDeprecations/EOLAuditModeUsage:
|
|
835
845
|
Exclude:
|
836
846
|
- '**/metadata.rb'
|
837
847
|
|
838
|
-
|
848
|
+
Chef/Deprecations/ResourceInheritsFromCompatResource:
|
839
849
|
Description: HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
|
840
850
|
StyleGuide: '#chefdeprecationsresourceinheritsfromcompatresource'
|
841
851
|
Enabled: true
|
@@ -843,7 +853,7 @@ ChefDeprecations/ResourceInheritsFromCompatResource:
|
|
843
853
|
Include:
|
844
854
|
- '**/libraries/*.rb'
|
845
855
|
|
846
|
-
|
856
|
+
Chef/Deprecations/VerifyPropertyUsesFileExpansion:
|
847
857
|
Description: Use the 'path' variable in the verify property and not the 'file' variable which was removed in Chef Infra Client 13.
|
848
858
|
StyleGuide: '#chefdeprecationsverifypropertyusesfileexpansion'
|
849
859
|
Enabled: true
|
@@ -851,13 +861,13 @@ ChefDeprecations/VerifyPropertyUsesFileExpansion:
|
|
851
861
|
Exclude:
|
852
862
|
- '**/metadata.rb'
|
853
863
|
|
854
|
-
|
864
|
+
Chef/Deprecations/PoiseArchiveUsage:
|
855
865
|
Description: The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+.
|
856
866
|
StyleGuide: '#chefdeprecationspoisearchiveusage'
|
857
867
|
Enabled: true
|
858
868
|
VersionAdded: '5.11.0'
|
859
869
|
|
860
|
-
|
870
|
+
Chef/Deprecations/PartialSearchHelperUsage:
|
861
871
|
Description: Legacy partial_search usage should be updated to use :filter_result in the search helper instead.
|
862
872
|
StyleGuide: '#chefdeprecationspartialsearchhelperusage'
|
863
873
|
Enabled: true
|
@@ -865,7 +875,7 @@ ChefDeprecations/PartialSearchHelperUsage:
|
|
865
875
|
Exclude:
|
866
876
|
- '**/metadata.rb'
|
867
877
|
|
868
|
-
|
878
|
+
Chef/Deprecations/SearchUsesPositionalParameters:
|
869
879
|
Description: Don't use deprecated positional parameters in cookbook search queries.
|
870
880
|
StyleGuide: '#chefdeprecationssearchusespositionalparameters'
|
871
881
|
Enabled: true
|
@@ -873,7 +883,7 @@ ChefDeprecations/SearchUsesPositionalParameters:
|
|
873
883
|
Exclude:
|
874
884
|
- '**/metadata.rb'
|
875
885
|
|
876
|
-
|
886
|
+
Chef/Deprecations/PartialSearchClassUsage:
|
877
887
|
Description: Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.
|
878
888
|
StyleGuide: '#chefdeprecationspartialsearchclassusage'
|
879
889
|
Enabled: true
|
@@ -881,7 +891,7 @@ ChefDeprecations/PartialSearchClassUsage:
|
|
881
891
|
Exclude:
|
882
892
|
- '**/metadata.rb'
|
883
893
|
|
884
|
-
|
894
|
+
Chef/Deprecations/Cheffile:
|
885
895
|
Description: The Libarian-Chef depsolving project is no longer maintained and should not be used for cookbook depsolving. Consider using Policyfiles instead.
|
886
896
|
StyleGuide: '#chefdeprecationscheffile'
|
887
897
|
Enabled: true
|
@@ -889,7 +899,7 @@ ChefDeprecations/Cheffile:
|
|
889
899
|
Include:
|
890
900
|
- '**/Cheffile'
|
891
901
|
|
892
|
-
|
902
|
+
Chef/Deprecations/LegacyNotifySyntax:
|
893
903
|
Description: Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
|
894
904
|
StyleGuide: '#chefdeprecationslegacynotifysyntax'
|
895
905
|
Enabled: true
|
@@ -897,7 +907,7 @@ ChefDeprecations/LegacyNotifySyntax:
|
|
897
907
|
Exclude:
|
898
908
|
- '**/metadata.rb'
|
899
909
|
|
900
|
-
|
910
|
+
Chef/Deprecations/NodeSetWithoutLevel:
|
901
911
|
Description: When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
|
902
912
|
StyleGuide: '#chefdeprecationsnodesetwithoutlevel'
|
903
913
|
Enabled: true
|
@@ -906,7 +916,7 @@ ChefDeprecations/NodeSetWithoutLevel:
|
|
906
916
|
- '**/metadata.rb'
|
907
917
|
- '**/attributes/*.rb'
|
908
918
|
|
909
|
-
|
919
|
+
Chef/Deprecations/ChefRewind:
|
910
920
|
Description: Use delete_resource / edit_resource instead of functionality in the deprecated chef-rewind gem
|
911
921
|
StyleGuide: '#chefdeprecationschefrewind'
|
912
922
|
Enabled: true
|
@@ -915,7 +925,7 @@ ChefDeprecations/ChefRewind:
|
|
915
925
|
- '**/metadata.rb'
|
916
926
|
- '**/attributes/*.rb'
|
917
927
|
|
918
|
-
|
928
|
+
Chef/Deprecations/RubyBlockCreateAction:
|
919
929
|
Description: Use the :run action in the ruby_block resource instead of the deprecated :create action
|
920
930
|
StyleGuide: '#chefdeprecationsrubyblockcreateaction'
|
921
931
|
Enabled: true
|
@@ -925,7 +935,7 @@ ChefDeprecations/RubyBlockCreateAction:
|
|
925
935
|
- '**/attributes/*.rb'
|
926
936
|
- '**/Berksfile'
|
927
937
|
|
928
|
-
|
938
|
+
Chef/Deprecations/DeprecatedPlatformMethods:
|
929
939
|
Description: Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources.
|
930
940
|
StyleGuide: '#chefdeprecationsdeprecatedplatformmethods'
|
931
941
|
Enabled: true
|
@@ -936,7 +946,7 @@ ChefDeprecations/DeprecatedPlatformMethods:
|
|
936
946
|
- '**/resources/*.rb'
|
937
947
|
- '**/providers/*.rb'
|
938
948
|
|
939
|
-
|
949
|
+
Chef/Deprecations/DeprecatedChefSpecPlatform:
|
940
950
|
Description: Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3
|
941
951
|
StyleGuide: '#chefdeprecationsdeprecatedchefspecplatform'
|
942
952
|
Enabled: true
|
@@ -944,7 +954,7 @@ ChefDeprecations/DeprecatedChefSpecPlatform:
|
|
944
954
|
Include:
|
945
955
|
- '**/spec/**/*.rb'
|
946
956
|
|
947
|
-
|
957
|
+
Chef/Deprecations/WindowsFeatureServermanagercmd:
|
948
958
|
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.
|
949
959
|
StyleGuide: '#chefdeprecationswindowsfeatureservermanagercmd'
|
950
960
|
Enabled: true
|
@@ -954,7 +964,7 @@ ChefDeprecations/WindowsFeatureServermanagercmd:
|
|
954
964
|
- '**/attributes/*.rb'
|
955
965
|
- '**/Berksfile'
|
956
966
|
|
957
|
-
|
967
|
+
Chef/Deprecations/DeprecatedWindowsVersionCheck:
|
958
968
|
Description: Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false.
|
959
969
|
StyleGuide: '#chefdeprecationsdeprecatedwindowsversioncheck'
|
960
970
|
Enabled: true
|
@@ -963,7 +973,7 @@ ChefDeprecations/DeprecatedWindowsVersionCheck:
|
|
963
973
|
- '**/metadata.rb'
|
964
974
|
- '**/Berksfile'
|
965
975
|
|
966
|
-
|
976
|
+
Chef/Deprecations/ChefWindowsPlatformHelper:
|
967
977
|
Description: Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper.
|
968
978
|
StyleGuide: '#chefdeprecationschefwindowsplatformhelper'
|
969
979
|
Enabled: true
|
@@ -972,7 +982,7 @@ ChefDeprecations/ChefWindowsPlatformHelper:
|
|
972
982
|
- '**/metadata.rb'
|
973
983
|
- '**/Berksfile'
|
974
984
|
|
975
|
-
|
985
|
+
Chef/Deprecations/LogResourceNotifications:
|
976
986
|
Description: In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource instead to aggregate notifications.
|
977
987
|
StyleGuide: '#chefdeprecationslogresourcenotifications'
|
978
988
|
Enabled: true
|
@@ -981,7 +991,7 @@ ChefDeprecations/LogResourceNotifications:
|
|
981
991
|
- '**/metadata.rb'
|
982
992
|
- '**/Berksfile'
|
983
993
|
|
984
|
-
|
994
|
+
Chef/Deprecations/HWRPWithoutProvides:
|
985
995
|
Description: In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
|
986
996
|
StyleGuide: '#chefdeprecationsresourcewithoutnameorprovides'
|
987
997
|
Enabled: true
|
@@ -990,7 +1000,7 @@ ChefDeprecations/HWRPWithoutProvides:
|
|
990
1000
|
Include:
|
991
1001
|
- '**/libraries/*.rb'
|
992
1002
|
|
993
|
-
|
1003
|
+
Chef/Deprecations/WindowsVersionHelpers:
|
994
1004
|
Description: Use node['platform_version'] data instead of the Windows::VersionHelper helper from the Windows cookbook.
|
995
1005
|
StyleGuide: '#chefdeprecationswindowsversionhelpers'
|
996
1006
|
Enabled: true
|
@@ -999,7 +1009,7 @@ ChefDeprecations/WindowsVersionHelpers:
|
|
999
1009
|
- '**/metadata.rb'
|
1000
1010
|
- '**/Berksfile'
|
1001
1011
|
|
1002
|
-
|
1012
|
+
Chef/Deprecations/PowershellCookbookHelpers:
|
1003
1013
|
Description: Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 16+ instead of the deprecated PowerShell cookbook helpers.
|
1004
1014
|
StyleGuide: '#chefdeprecationspowershellcookbookhelpers'
|
1005
1015
|
Enabled: true
|
@@ -1008,7 +1018,7 @@ ChefDeprecations/PowershellCookbookHelpers:
|
|
1008
1018
|
- '**/metadata.rb'
|
1009
1019
|
- '**/Berksfile'
|
1010
1020
|
|
1011
|
-
|
1021
|
+
Chef/Deprecations/DeprecatedShelloutMethods:
|
1012
1022
|
Description: Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.
|
1013
1023
|
StyleGuide: '#chefdeprecationsdeprecatedshelloutmethods'
|
1014
1024
|
Enabled: true
|
@@ -1018,7 +1028,7 @@ ChefDeprecations/DeprecatedShelloutMethods:
|
|
1018
1028
|
- '**/attributes/*.rb'
|
1019
1029
|
- '**/Berksfile'
|
1020
1030
|
|
1021
|
-
|
1031
|
+
Chef/Deprecations/Ruby27KeywordArgumentWarnings:
|
1022
1032
|
Description: Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
|
1023
1033
|
StyleGuide: '#chefdeprecationsruby27keywordargumentwarnings'
|
1024
1034
|
Enabled: true
|
@@ -1027,7 +1037,7 @@ ChefDeprecations/Ruby27KeywordArgumentWarnings:
|
|
1027
1037
|
- '**/metadata.rb'
|
1028
1038
|
- '**/Berksfile'
|
1029
1039
|
|
1030
|
-
|
1040
|
+
Chef/Deprecations/ResourceUsesOnlyResourceName:
|
1031
1041
|
Description: Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Use `provides` to change the name of the resource instead and omit `resource_name` entirely if it matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.
|
1032
1042
|
StyleGuide: '#chefdeprecationsresourceusesonlyresourcename'
|
1033
1043
|
Enabled: true
|
@@ -1036,7 +1046,7 @@ ChefDeprecations/ResourceUsesOnlyResourceName:
|
|
1036
1046
|
- '**/libraries/*.rb'
|
1037
1047
|
- '**/resources/*.rb'
|
1038
1048
|
|
1039
|
-
|
1049
|
+
Chef/Deprecations/ChefDKGenerators:
|
1040
1050
|
Description: Chef Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
|
1041
1051
|
StyleGuide: '#chefdeprecationschefdkgenerators'
|
1042
1052
|
Enabled: true
|
@@ -1045,7 +1055,7 @@ ChefDeprecations/ChefDKGenerators:
|
|
1045
1055
|
- '**/metadata.rb'
|
1046
1056
|
- '**/Berksfile'
|
1047
1057
|
|
1048
|
-
|
1058
|
+
Chef/Deprecations/ChefHandlerRecipe:
|
1049
1059
|
Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
|
1050
1060
|
StyleGuide: '#chefdeprecationschefhandlerrecipe'
|
1051
1061
|
Enabled: true
|
@@ -1054,7 +1064,7 @@ ChefDeprecations/ChefHandlerRecipe:
|
|
1054
1064
|
- '**/metadata.rb'
|
1055
1065
|
- '**/Berksfile'
|
1056
1066
|
|
1057
|
-
|
1067
|
+
Chef/Deprecations/UseAutomaticResourceName:
|
1058
1068
|
Description: The use_automatic_resource_name method was removed in Chef Infra Client 16. The resource name/provides should be set explicitly instead.
|
1059
1069
|
StyleGuide: '#chefdeprecationsuseautomaticresourcename'
|
1060
1070
|
Enabled: true
|
@@ -1063,7 +1073,7 @@ ChefDeprecations/UseAutomaticResourceName:
|
|
1063
1073
|
- '**/libraries/*.rb'
|
1064
1074
|
- '**/resources/*.rb'
|
1065
1075
|
|
1066
|
-
|
1076
|
+
Chef/Deprecations/MacosUserdefaultsGlobalProperty:
|
1067
1077
|
Description: 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.
|
1068
1078
|
StyleGuide: '#chefdeprecationsmacosuserdefaultsglobalproperty'
|
1069
1079
|
Enabled: true
|
@@ -1072,7 +1082,7 @@ ChefDeprecations/MacosUserdefaultsGlobalProperty:
|
|
1072
1082
|
- '**/metadata.rb'
|
1073
1083
|
- '**/Berksfile'
|
1074
1084
|
|
1075
|
-
|
1085
|
+
Chef/Deprecations/CookbooksDependsOnSelf:
|
1076
1086
|
Description: A cookbook cannot depend on itself in Chef Infra Client 13 or later.
|
1077
1087
|
StyleGuide: '#chefdeprecationscookbooksdependonself'
|
1078
1088
|
Enabled: true
|
@@ -1081,7 +1091,7 @@ ChefDeprecations/CookbooksDependsOnSelf:
|
|
1081
1091
|
Include:
|
1082
1092
|
- '**/metadata.rb'
|
1083
1093
|
|
1084
|
-
|
1094
|
+
Chef/Deprecations/ChefShellout:
|
1085
1095
|
Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
|
1086
1096
|
StyleGuide: '#chefdeprecationschefshellout'
|
1087
1097
|
Enabled: true
|
@@ -1091,7 +1101,7 @@ ChefDeprecations/ChefShellout:
|
|
1091
1101
|
- '**/attributes/*.rb'
|
1092
1102
|
- '**/Berksfile'
|
1093
1103
|
|
1094
|
-
|
1104
|
+
Chef/Deprecations/ExecutePathProperty:
|
1095
1105
|
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.
|
1096
1106
|
StyleGuide: '#chefdeprecationsexecutepathproperty'
|
1097
1107
|
Enabled: true
|
@@ -1101,7 +1111,7 @@ ChefDeprecations/ExecutePathProperty:
|
|
1101
1111
|
- '**/attributes/*.rb'
|
1102
1112
|
- '**/Berksfile'
|
1103
1113
|
|
1104
|
-
|
1114
|
+
Chef/Deprecations/ExecuteRelativeCreatesWithoutCwd:
|
1105
1115
|
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.
|
1106
1116
|
StyleGuide: '#chefdeprecationsexecuterelativecreateswithoutcwd'
|
1107
1117
|
Enabled: true
|
@@ -1111,7 +1121,7 @@ ChefDeprecations/ExecuteRelativeCreatesWithoutCwd:
|
|
1111
1121
|
- '**/attributes/*.rb'
|
1112
1122
|
- '**/Berksfile'
|
1113
1123
|
|
1114
|
-
|
1124
|
+
Chef/Deprecations/WindowsPackageInstallerTypeString:
|
1115
1125
|
Description: In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
|
1116
1126
|
StyleGuide: '#chefdeprecationswindowspackageinstallertypestring'
|
1117
1127
|
Enabled: true
|
@@ -1121,14 +1131,37 @@ ChefDeprecations/WindowsPackageInstallerTypeString:
|
|
1121
1131
|
- '**/attributes/*.rb'
|
1122
1132
|
- '**/Berksfile'
|
1123
1133
|
|
1134
|
+
Chef/Deprecations/UseYamlDump:
|
1135
|
+
Description: Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library.
|
1136
|
+
StyleGuide: '#chefdeprecationsuseyamldump'
|
1137
|
+
Enabled: true
|
1138
|
+
VersionAdded: '6.21.0'
|
1139
|
+
|
1140
|
+
Chef/Deprecations/LibrarianChefSpec:
|
1141
|
+
Description: The Librarian-Chef depsolving project is no longer maintained and ChefSpec should not use Librarian-Chef for cookbook depsolving. Consider using Policyfiles instead.
|
1142
|
+
StyleGuide: '#chefdeprecationslibrarianchefspec'
|
1143
|
+
Enabled: true
|
1144
|
+
VersionAdded: '7.1.0'
|
1145
|
+
Include:
|
1146
|
+
- '**/specs/*.rb'
|
1147
|
+
|
1148
|
+
Chef/Deprecations/FoodcriticTesting:
|
1149
|
+
Description: The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks
|
1150
|
+
StyleGuide: '#chefdeprecationsfoodcritictesting'
|
1151
|
+
Enabled: true
|
1152
|
+
VersionAdded: '7.1.0'
|
1153
|
+
Include:
|
1154
|
+
- '**/Rakefile'
|
1155
|
+
- '**/Gemfile'
|
1156
|
+
|
1124
1157
|
###############################
|
1125
|
-
#
|
1158
|
+
# Chef/Modernize: Cleaning up legacy code and using new built-in resources
|
1126
1159
|
###############################
|
1127
1160
|
|
1128
|
-
|
1129
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
1161
|
+
Chef/Modernize:
|
1162
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_modernize.md
|
1130
1163
|
|
1131
|
-
|
1164
|
+
Chef/Modernize/LegacyBerksfileSource:
|
1132
1165
|
Description: Do not use legacy Berksfile community sources. Use Chef Supermarket instead.
|
1133
1166
|
StyleGuide: '#chefmodernizelegacyberksfilesource'
|
1134
1167
|
Enabled: true
|
@@ -1136,7 +1169,7 @@ ChefModernize/LegacyBerksfileSource:
|
|
1136
1169
|
Include:
|
1137
1170
|
- '**/Berksfile'
|
1138
1171
|
|
1139
|
-
|
1172
|
+
Chef/Modernize/WhyRunSupportedTrue:
|
1140
1173
|
Description: whyrun_supported? no longer needs to be set to true as it is the default in Chef 13+
|
1141
1174
|
StyleGuide: '#chefmodernizewhyrunsupportedtrue'
|
1142
1175
|
Enabled: true
|
@@ -1146,7 +1179,7 @@ ChefModernize/WhyRunSupportedTrue:
|
|
1146
1179
|
- '**/providers/*.rb'
|
1147
1180
|
- '**/libraries/*.rb'
|
1148
1181
|
|
1149
|
-
|
1182
|
+
Chef/Modernize/UnnecessaryDependsChef14:
|
1150
1183
|
Description: Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself.
|
1151
1184
|
StyleGuide: '#chefmodernizeunnecessarydependschef14'
|
1152
1185
|
Enabled: true
|
@@ -1154,7 +1187,7 @@ ChefModernize/UnnecessaryDependsChef14:
|
|
1154
1187
|
Include:
|
1155
1188
|
- '**/metadata.rb'
|
1156
1189
|
|
1157
|
-
|
1190
|
+
Chef/Modernize/RespondToInMetadata:
|
1158
1191
|
Description: It is no longer necessary to use respond_to? in metadata.rb in Chef Infra Client 12.15 and later
|
1159
1192
|
StyleGuide: '#chefmodernizerespondtoinmetadata'
|
1160
1193
|
Enabled: true
|
@@ -1162,7 +1195,7 @@ ChefModernize/RespondToInMetadata:
|
|
1162
1195
|
Include:
|
1163
1196
|
- '**/metadata.rb'
|
1164
1197
|
|
1165
|
-
|
1198
|
+
Chef/Modernize/RespondToResourceName:
|
1166
1199
|
Description: respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+
|
1167
1200
|
StyleGuide: '#chefmodernizerespondtoresourcename'
|
1168
1201
|
Enabled: true
|
@@ -1171,7 +1204,7 @@ ChefModernize/RespondToResourceName:
|
|
1171
1204
|
- '**/resources/*.rb'
|
1172
1205
|
- '**/libraries/*.rb'
|
1173
1206
|
|
1174
|
-
|
1207
|
+
Chef/Modernize/RespondToProvides:
|
1175
1208
|
Description: respond_to?(:provides) in resources is no longer necessary in Chef Infra Client 12+
|
1176
1209
|
StyleGuide: '#chefmodernizerespondtoprovides'
|
1177
1210
|
Enabled: true
|
@@ -1180,7 +1213,7 @@ ChefModernize/RespondToProvides:
|
|
1180
1213
|
- '**/providers/*.rb'
|
1181
1214
|
- '**/libraries/*.rb'
|
1182
1215
|
|
1183
|
-
|
1216
|
+
Chef/Modernize/SetOrReturnInResources:
|
1184
1217
|
Description: Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality.
|
1185
1218
|
StyleGuide: '#chefmodernizesetorreturninresources'
|
1186
1219
|
Enabled: true
|
@@ -1189,7 +1222,7 @@ ChefModernize/SetOrReturnInResources:
|
|
1189
1222
|
- '**/resources/*.rb'
|
1190
1223
|
- '**/libraries/*.rb'
|
1191
1224
|
|
1192
|
-
|
1225
|
+
Chef/Modernize/CustomResourceWithAttributes:
|
1193
1226
|
Description: Custom Resources should contain properties not attributes.
|
1194
1227
|
StyleGuide: '#chefmodernizecustomresourcewithattributes'
|
1195
1228
|
Enabled: true
|
@@ -1197,7 +1230,7 @@ ChefModernize/CustomResourceWithAttributes:
|
|
1197
1230
|
Include:
|
1198
1231
|
- '**/resources/*.rb'
|
1199
1232
|
|
1200
|
-
|
1233
|
+
Chef/Modernize/IncludingAptDefaultRecipe:
|
1201
1234
|
Description: Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.
|
1202
1235
|
StyleGuide: '#chefmodernizeincludingaptdefaultrecipe'
|
1203
1236
|
Enabled: true
|
@@ -1205,7 +1238,7 @@ ChefModernize/IncludingAptDefaultRecipe:
|
|
1205
1238
|
Exclude:
|
1206
1239
|
- '**/metadata.rb'
|
1207
1240
|
|
1208
|
-
|
1241
|
+
Chef/Modernize/IncludingWindowsDefaultRecipe:
|
1209
1242
|
Description: Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client
|
1210
1243
|
StyleGuide: '#chefmodernizeincludingwindowsdefaultrecipe'
|
1211
1244
|
Enabled: true
|
@@ -1213,7 +1246,7 @@ ChefModernize/IncludingWindowsDefaultRecipe:
|
|
1213
1246
|
Exclude:
|
1214
1247
|
- '**/metadata.rb'
|
1215
1248
|
|
1216
|
-
|
1249
|
+
Chef/Modernize/DefinesChefSpecMatchers:
|
1217
1250
|
Description: ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook
|
1218
1251
|
StyleGuide: '#chefmodernizedefineschefspecmatchers'
|
1219
1252
|
Enabled: true
|
@@ -1221,7 +1254,7 @@ ChefModernize/DefinesChefSpecMatchers:
|
|
1221
1254
|
Include:
|
1222
1255
|
- '**/libraries/*.rb'
|
1223
1256
|
|
1224
|
-
|
1257
|
+
Chef/Modernize/ExecuteAptUpdate:
|
1225
1258
|
Description: Use the apt_update resource instead of the execute resource to run an apt-get update package cache update
|
1226
1259
|
StyleGuide: '#chefmodernizeexecuteaptupdate'
|
1227
1260
|
Enabled: true
|
@@ -1229,7 +1262,7 @@ ChefModernize/ExecuteAptUpdate:
|
|
1229
1262
|
Exclude:
|
1230
1263
|
- '**/metadata.rb'
|
1231
1264
|
|
1232
|
-
|
1265
|
+
Chef/Modernize/MinitestHandlerUsage:
|
1233
1266
|
Description: Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
|
1234
1267
|
StyleGuide: '#chefmodernizeminitesthandlerusage'
|
1235
1268
|
Enabled: true
|
@@ -1237,7 +1270,7 @@ ChefModernize/MinitestHandlerUsage:
|
|
1237
1270
|
Include:
|
1238
1271
|
- '**/metadata.rb'
|
1239
1272
|
|
1240
|
-
|
1273
|
+
Chef/Modernize/IncludingMixinShelloutInResources:
|
1241
1274
|
Description: There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
|
1242
1275
|
StyleGuide: '#chefmodernizeincludingmixinshelloutinresources'
|
1243
1276
|
Enabled: true
|
@@ -1247,7 +1280,7 @@ ChefModernize/IncludingMixinShelloutInResources:
|
|
1247
1280
|
- '**/providers/*.rb'
|
1248
1281
|
- '**/libraries/*.rb'
|
1249
1282
|
|
1250
|
-
|
1283
|
+
Chef/Modernize/UseBuildEssentialResource:
|
1251
1284
|
Description: Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+
|
1252
1285
|
StyleGuide: '#chefmodernizeusebuildessentialresource'
|
1253
1286
|
Enabled: true
|
@@ -1255,7 +1288,7 @@ ChefModernize/UseBuildEssentialResource:
|
|
1255
1288
|
Exclude:
|
1256
1289
|
- '**/metadata.rb'
|
1257
1290
|
|
1258
|
-
|
1291
|
+
Chef/Modernize/WindowsZipfileUsage:
|
1259
1292
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook
|
1260
1293
|
StyleGuide: '#chefmodernizewindowszipfileusage'
|
1261
1294
|
Enabled: true
|
@@ -1263,7 +1296,7 @@ ChefModernize/WindowsZipfileUsage:
|
|
1263
1296
|
Exclude:
|
1264
1297
|
- '**/metadata.rb'
|
1265
1298
|
|
1266
|
-
|
1299
|
+
Chef/Modernize/SevenZipArchiveResource:
|
1267
1300
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
|
1268
1301
|
StyleGuide: '#chefmodernizesevenziparchiveresource'
|
1269
1302
|
Enabled: true
|
@@ -1271,7 +1304,7 @@ ChefModernize/SevenZipArchiveResource:
|
|
1271
1304
|
Exclude:
|
1272
1305
|
- '**/metadata.rb'
|
1273
1306
|
|
1274
|
-
|
1307
|
+
Chef/Modernize/LibarchiveFileResource:
|
1275
1308
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource
|
1276
1309
|
StyleGuide: '#chefmodernizelibarchivefileresource'
|
1277
1310
|
Enabled: true
|
@@ -1279,7 +1312,7 @@ ChefModernize/LibarchiveFileResource:
|
|
1279
1312
|
Exclude:
|
1280
1313
|
- '**/metadata.rb'
|
1281
1314
|
|
1282
|
-
|
1315
|
+
Chef/Modernize/PowershellScriptExpandArchive:
|
1283
1316
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of using Expand-Archive in a powershell_script resource
|
1284
1317
|
StyleGuide: '#chefmodernizepowershellscriptexpandarchive'
|
1285
1318
|
Enabled: true
|
@@ -1287,7 +1320,7 @@ ChefModernize/PowershellScriptExpandArchive:
|
|
1287
1320
|
Exclude:
|
1288
1321
|
- '**/metadata.rb'
|
1289
1322
|
|
1290
|
-
|
1323
|
+
Chef/Modernize/PowershellInstallPackage:
|
1291
1324
|
Description: Use the package resource built into Chef Infra Client instead of using Install-Package in a powershell_script resource
|
1292
1325
|
StyleGuide: '#chefmodernizepowershellinstallpackage'
|
1293
1326
|
Enabled: true
|
@@ -1295,7 +1328,7 @@ ChefModernize/PowershellInstallPackage:
|
|
1295
1328
|
Exclude:
|
1296
1329
|
- '**/metadata.rb'
|
1297
1330
|
|
1298
|
-
|
1331
|
+
Chef/Modernize/PowershellInstallWindowsFeature:
|
1299
1332
|
Description: Use the windows_feature resource built into Chef Infra Client 13+ instead of using Install-WindowsFeature or Add-WindowsFeature in a powershell_script resource
|
1300
1333
|
StyleGuide: '#chefmodernizepowershellinstallwindowsfeature'
|
1301
1334
|
Enabled: true
|
@@ -1303,7 +1336,7 @@ ChefModernize/PowershellInstallWindowsFeature:
|
|
1303
1336
|
Exclude:
|
1304
1337
|
- '**/metadata.rb'
|
1305
1338
|
|
1306
|
-
|
1339
|
+
Chef/Modernize/ShellOutToChocolatey:
|
1307
1340
|
Description: Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command
|
1308
1341
|
StyleGuide: '#chefmodernizeshellouttochocolatey'
|
1309
1342
|
Enabled: true
|
@@ -1311,7 +1344,7 @@ ChefModernize/ShellOutToChocolatey:
|
|
1311
1344
|
Exclude:
|
1312
1345
|
- '**/metadata.rb'
|
1313
1346
|
|
1314
|
-
|
1347
|
+
Chef/Modernize/CronManageResource:
|
1315
1348
|
Description: The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.
|
1316
1349
|
StyleGuide: '#chefmodernizecronmanageresource'
|
1317
1350
|
Enabled: true
|
@@ -1319,7 +1352,7 @@ ChefModernize/CronManageResource:
|
|
1319
1352
|
Exclude:
|
1320
1353
|
- '**/metadata.rb'
|
1321
1354
|
|
1322
|
-
|
1355
|
+
Chef/Modernize/UsesZypperRepo:
|
1323
1356
|
Description: The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.
|
1324
1357
|
StyleGuide: '#chefmodernizeuseszypperrepo'
|
1325
1358
|
Enabled: true
|
@@ -1327,7 +1360,7 @@ ChefModernize/UsesZypperRepo:
|
|
1327
1360
|
Exclude:
|
1328
1361
|
- '**/metadata.rb'
|
1329
1362
|
|
1330
|
-
|
1363
|
+
Chef/Modernize/DependsOnZypperCookbook:
|
1331
1364
|
Description: Don't include the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+
|
1332
1365
|
StyleGuide: '#chefmodernizedependsonzyppercookbook'
|
1333
1366
|
Enabled: true
|
@@ -1335,7 +1368,7 @@ ChefModernize/DependsOnZypperCookbook:
|
|
1335
1368
|
Exclude:
|
1336
1369
|
- '**/metadata.rb'
|
1337
1370
|
|
1338
|
-
|
1371
|
+
Chef/Modernize/ExecuteTzUtil:
|
1339
1372
|
Description: Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil
|
1340
1373
|
StyleGuide: '#chefmodernizeexecutetzutil'
|
1341
1374
|
Enabled: true
|
@@ -1343,7 +1376,7 @@ ChefModernize/ExecuteTzUtil:
|
|
1343
1376
|
Exclude:
|
1344
1377
|
- '**/metadata.rb'
|
1345
1378
|
|
1346
|
-
|
1379
|
+
Chef/Modernize/OpensslRsaKeyResource:
|
1347
1380
|
Description: The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.
|
1348
1381
|
StyleGuide: '#chefmodernizeopensslrsakeyresource'
|
1349
1382
|
Enabled: true
|
@@ -1351,7 +1384,7 @@ ChefModernize/OpensslRsaKeyResource:
|
|
1351
1384
|
Exclude:
|
1352
1385
|
- '**/metadata.rb'
|
1353
1386
|
|
1354
|
-
|
1387
|
+
Chef/Modernize/OpensslX509Resource:
|
1355
1388
|
Description: The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.
|
1356
1389
|
StyleGuide: '#chefmodernizeopensslx509resource'
|
1357
1390
|
Enabled: true
|
@@ -1359,7 +1392,7 @@ ChefModernize/OpensslX509Resource:
|
|
1359
1392
|
Exclude:
|
1360
1393
|
- '**/metadata.rb'
|
1361
1394
|
|
1362
|
-
|
1395
|
+
Chef/Modernize/OsxConfigProfileResource:
|
1363
1396
|
Description: The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.
|
1364
1397
|
StyleGuide: '#chefmodernizeosxconfigprofileresource'
|
1365
1398
|
Enabled: true
|
@@ -1367,7 +1400,7 @@ ChefModernize/OsxConfigProfileResource:
|
|
1367
1400
|
Exclude:
|
1368
1401
|
- '**/metadata.rb'
|
1369
1402
|
|
1370
|
-
|
1403
|
+
Chef/Modernize/SysctlParamResource:
|
1371
1404
|
Description: The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
|
1372
1405
|
StyleGuide: '#chefmodernizesysctlparamresource'
|
1373
1406
|
Enabled: true
|
@@ -1375,7 +1408,7 @@ ChefModernize/SysctlParamResource:
|
|
1375
1408
|
Exclude:
|
1376
1409
|
- '**/metadata.rb'
|
1377
1410
|
|
1378
|
-
|
1411
|
+
Chef/Modernize/MacOsXUserdefaults:
|
1379
1412
|
Description: The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
|
1380
1413
|
StyleGuide: '#chefmodernizemacosxuserdefaults'
|
1381
1414
|
Enabled: true
|
@@ -1383,7 +1416,7 @@ ChefModernize/MacOsXUserdefaults:
|
|
1383
1416
|
Exclude:
|
1384
1417
|
- '**/metadata.rb'
|
1385
1418
|
|
1386
|
-
|
1419
|
+
Chef/Modernize/PowerShellGuardInterpreter:
|
1387
1420
|
Description: PowerShell is already set as the default guard interpreter for powershell_script resources in Chef Infra Client 13 and later and does not need to be specified.
|
1388
1421
|
StyleGuide: '#chefmodernizepowershellguardinterpreter'
|
1389
1422
|
Enabled: true
|
@@ -1391,7 +1424,7 @@ ChefModernize/PowerShellGuardInterpreter:
|
|
1391
1424
|
Exclude:
|
1392
1425
|
- '**/metadata.rb'
|
1393
1426
|
|
1394
|
-
|
1427
|
+
Chef/Modernize/DefaultActionFromInitialize:
|
1395
1428
|
Description: The default actions can now be specified using the `default_action` helper instead of using the @action variable in the resource provider initialize method.
|
1396
1429
|
StyleGuide: '#chefmodernizedefaultactionfrominitialize'
|
1397
1430
|
Enabled: true
|
@@ -1401,7 +1434,7 @@ ChefModernize/DefaultActionFromInitialize:
|
|
1401
1434
|
- '**/providers/*.rb'
|
1402
1435
|
- '**/libraries/*.rb'
|
1403
1436
|
|
1404
|
-
|
1437
|
+
Chef/Modernize/ResourceNameFromInitialize:
|
1405
1438
|
Description: The name of a resource can be set with the "resource_name" helper instead of using the initialize method.
|
1406
1439
|
StyleGuide: '#chefmodernizeresourcenamefrominitialize'
|
1407
1440
|
Enabled: true
|
@@ -1411,7 +1444,7 @@ ChefModernize/ResourceNameFromInitialize:
|
|
1411
1444
|
- '**/providers/*.rb'
|
1412
1445
|
- '**/libraries/*.rb'
|
1413
1446
|
|
1414
|
-
|
1447
|
+
Chef/Modernize/Definitions:
|
1415
1448
|
Description: Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.
|
1416
1449
|
StyleGuide: '#chefmodernizedefinitions'
|
1417
1450
|
Enabled: true
|
@@ -1419,7 +1452,7 @@ ChefModernize/Definitions:
|
|
1419
1452
|
Include:
|
1420
1453
|
- '**/definitions/*.rb'
|
1421
1454
|
|
1422
|
-
|
1455
|
+
Chef/Modernize/IfProvidesDefaultAction:
|
1423
1456
|
Description: if defined?(default_action) is no longer necessary in Chef Infra resources as default_action shipped in Chef Infra Client 10.8.
|
1424
1457
|
StyleGuide: '#chefmodernizeifprovidesdefaultaction'
|
1425
1458
|
Enabled: true
|
@@ -1428,13 +1461,13 @@ ChefModernize/IfProvidesDefaultAction:
|
|
1428
1461
|
- '**/resources/*.rb'
|
1429
1462
|
- '**/libraries/*.rb'
|
1430
1463
|
|
1431
|
-
|
1464
|
+
Chef/Modernize/ZipfileResource:
|
1432
1465
|
Description: Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.
|
1433
1466
|
StyleGuide: '#chefmodernizezipfileresource'
|
1434
1467
|
Enabled: true
|
1435
1468
|
VersionAdded: '5.12.0'
|
1436
1469
|
|
1437
|
-
|
1470
|
+
Chef/Modernize/UnnecessaryMixlibShelloutRequire:
|
1438
1471
|
Description: Chef Infra Client 12.4 and later include mixlib/shellout automatically in resources and providers.
|
1439
1472
|
StyleGuide: '#chefmodernizeunnecessarymixlibshelloutrequire'
|
1440
1473
|
Enabled: true
|
@@ -1443,7 +1476,7 @@ ChefModernize/UnnecessaryMixlibShelloutRequire:
|
|
1443
1476
|
- '**/resources/*.rb'
|
1444
1477
|
- '**/providers/*.rb'
|
1445
1478
|
|
1446
|
-
|
1479
|
+
Chef/Modernize/EmptyResourceInitializeMethod:
|
1447
1480
|
Description: There is no need for an empty initialize method in a resource
|
1448
1481
|
StyleGuide: '#chefmodernizeemptyresourceinitializemethod'
|
1449
1482
|
Enabled: true
|
@@ -1452,7 +1485,7 @@ ChefModernize/EmptyResourceInitializeMethod:
|
|
1452
1485
|
- '**/resources/*.rb'
|
1453
1486
|
- '**/providers/*.rb'
|
1454
1487
|
|
1455
|
-
|
1488
|
+
Chef/Modernize/ChefGemNokogiri:
|
1456
1489
|
Description: The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.
|
1457
1490
|
StyleGuide: '#chefmodernizechefgemnokogiri'
|
1458
1491
|
Enabled: true
|
@@ -1461,7 +1494,7 @@ ChefModernize/ChefGemNokogiri:
|
|
1461
1494
|
- '**/metadata.rb'
|
1462
1495
|
- '**/attributes/*.rb'
|
1463
1496
|
|
1464
|
-
|
1497
|
+
Chef/Modernize/PropertyWithNameAttribute:
|
1465
1498
|
Description: Resource property sets name_attribute not name_property
|
1466
1499
|
StyleGuide: '#chefmodernizepropertywithnameattribute'
|
1467
1500
|
Enabled: true
|
@@ -1471,7 +1504,7 @@ ChefModernize/PropertyWithNameAttribute:
|
|
1471
1504
|
- '**/resources/*.rb'
|
1472
1505
|
- '**/libraries/*.rb'
|
1473
1506
|
|
1474
|
-
|
1507
|
+
Chef/Modernize/IncludingOhaiDefaultRecipe:
|
1475
1508
|
Description: Use the ohai_plugin resource to ship custom Ohai plugins instead of using the ohai::default recipe. If you're not shipping custom Ohai plugins, then you can remove this recipe entirely.
|
1476
1509
|
StyleGuide: '#chefmodernizeincludingohaidefaultrecipe'
|
1477
1510
|
Enabled: true
|
@@ -1481,7 +1514,7 @@ ChefModernize/IncludingOhaiDefaultRecipe:
|
|
1481
1514
|
- '**/metadata.rb'
|
1482
1515
|
- '**/Berksfile'
|
1483
1516
|
|
1484
|
-
|
1517
|
+
Chef/Modernize/AllowedActionsFromInitialize:
|
1485
1518
|
Description: The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.
|
1486
1519
|
StyleGuide: '#chefmodernizeallowedactionsfrominitialize'
|
1487
1520
|
Enabled: true
|
@@ -1490,7 +1523,7 @@ ChefModernize/AllowedActionsFromInitialize:
|
|
1490
1523
|
- '**/resources/*.rb'
|
1491
1524
|
- '**/libraries/*.rb'
|
1492
1525
|
|
1493
|
-
|
1526
|
+
Chef/Modernize/FoodcriticComments:
|
1494
1527
|
Description: Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
|
1495
1528
|
StyleGuide: '#chefmodernizefoodcriticcomments'
|
1496
1529
|
Enabled: true
|
@@ -1498,7 +1531,7 @@ ChefModernize/FoodcriticComments:
|
|
1498
1531
|
Exclude:
|
1499
1532
|
- '**/Berksfile'
|
1500
1533
|
|
1501
|
-
|
1534
|
+
Chef/Modernize/ExecuteScExe:
|
1502
1535
|
Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource
|
1503
1536
|
StyleGuide: '#chefmodernizeexecutescexe'
|
1504
1537
|
Enabled: true
|
@@ -1508,7 +1541,7 @@ ChefModernize/ExecuteScExe:
|
|
1508
1541
|
- '**/attributes/*.rb'
|
1509
1542
|
- '**/Berksfile'
|
1510
1543
|
|
1511
|
-
|
1544
|
+
Chef/Modernize/WindowsScResource:
|
1512
1545
|
Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.
|
1513
1546
|
StyleGuide: '#chefmodernizewindowsscresource'
|
1514
1547
|
Enabled: true
|
@@ -1518,7 +1551,7 @@ ChefModernize/WindowsScResource:
|
|
1518
1551
|
- '**/attributes/*.rb'
|
1519
1552
|
- '**/Berksfile'
|
1520
1553
|
|
1521
|
-
|
1554
|
+
Chef/Modernize/ExecuteSleep:
|
1522
1555
|
Description: Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
|
1523
1556
|
StyleGuide: '#chefmodernizeexecutesleep'
|
1524
1557
|
Enabled: true
|
@@ -1528,7 +1561,7 @@ ChefModernize/ExecuteSleep:
|
|
1528
1561
|
- '**/attributes/*.rb'
|
1529
1562
|
- '**/Berksfile'
|
1530
1563
|
|
1531
|
-
|
1564
|
+
Chef/Modernize/DslIncludeInResource:
|
1532
1565
|
Description: 'There is no need to include Chef::DSL::Recipe or Chef::DSL::IncludeRecipe classes in resources or providers as this is done automatically.'
|
1533
1566
|
StyleGuide: '#chefmodernizedslincludeinresource'
|
1534
1567
|
Enabled: true
|
@@ -1537,7 +1570,7 @@ ChefModernize/DslIncludeInResource:
|
|
1537
1570
|
- '**/resources/*.rb'
|
1538
1571
|
- '**/providers/*.rb'
|
1539
1572
|
|
1540
|
-
|
1573
|
+
Chef/Modernize/ResourceForcingCompileTime:
|
1541
1574
|
Description: The hostname, build_essential, chef_gem, and ohai_hint resources include 'compile_time' properties, which should be used to force the resources to run at compile time by setting `compile_time true`.
|
1542
1575
|
StyleGuide: '#chefmodernizeresourceforcingcompiletime'
|
1543
1576
|
Enabled: true
|
@@ -1547,7 +1580,7 @@ ChefModernize/ResourceForcingCompileTime:
|
|
1547
1580
|
- '**/attributes/*.rb'
|
1548
1581
|
- '**/Berksfile'
|
1549
1582
|
|
1550
|
-
|
1583
|
+
Chef/Modernize/ExecuteSysctl:
|
1551
1584
|
Description: Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
|
1552
1585
|
StyleGuide: '#chefmodernizeexecutesysctl'
|
1553
1586
|
Enabled: true
|
@@ -1557,7 +1590,7 @@ ChefModernize/ExecuteSysctl:
|
|
1557
1590
|
- '**/attributes/*.rb'
|
1558
1591
|
- '**/Berksfile'
|
1559
1592
|
|
1560
|
-
|
1593
|
+
Chef/Modernize/SimplifyAptPpaSetup:
|
1561
1594
|
Description: The apt_repository resource allows setting up PPAs without using the full URL to ppa.launchpad.net.
|
1562
1595
|
StyleGuide: '#chefmodernizesimplifyaptppasetup'
|
1563
1596
|
Enabled: true
|
@@ -1567,7 +1600,7 @@ ChefModernize/SimplifyAptPpaSetup:
|
|
1567
1600
|
- '**/attributes/*.rb'
|
1568
1601
|
- '**/Berksfile'
|
1569
1602
|
|
1570
|
-
|
1603
|
+
Chef/Modernize/UseRequireRelative:
|
1571
1604
|
Description: Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.
|
1572
1605
|
StyleGuide: '#chefmodernizeuserequirerelative'
|
1573
1606
|
Enabled: true
|
@@ -1577,7 +1610,7 @@ ChefModernize/UseRequireRelative:
|
|
1577
1610
|
- '**/attributes/*.rb'
|
1578
1611
|
- '**/Berksfile'
|
1579
1612
|
|
1580
|
-
|
1613
|
+
Chef/Modernize/NodeInitPackage:
|
1581
1614
|
Description: Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
|
1582
1615
|
StyleGuide: '#chefmodernizenodeinitpackage'
|
1583
1616
|
Enabled: true
|
@@ -1586,7 +1619,7 @@ ChefModernize/NodeInitPackage:
|
|
1586
1619
|
- '**/metadata.rb'
|
1587
1620
|
- '**/Berksfile'
|
1588
1621
|
|
1589
|
-
|
1622
|
+
Chef/Modernize/WindowsRegistryUAC:
|
1590
1623
|
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.
|
1591
1624
|
StyleGuide: '#chefmodernizewindowsregistryuac'
|
1592
1625
|
Enabled: true
|
@@ -1596,7 +1629,7 @@ ChefModernize/WindowsRegistryUAC:
|
|
1596
1629
|
- '**/attributes/*.rb'
|
1597
1630
|
- '**/Berksfile'
|
1598
1631
|
|
1599
|
-
|
1632
|
+
Chef/Modernize/UseMultipackageInstalls:
|
1600
1633
|
Description: Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
|
1601
1634
|
StyleGuide: '#chefmodernizeusemultipackageinstalls'
|
1602
1635
|
Enabled: true
|
@@ -1606,7 +1639,7 @@ ChefModernize/UseMultipackageInstalls:
|
|
1606
1639
|
- '**/attributes/*.rb'
|
1607
1640
|
- '**/Berksfile'
|
1608
1641
|
|
1609
|
-
|
1642
|
+
Chef/Modernize/ProvidesFromInitialize:
|
1610
1643
|
Description: Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
|
1611
1644
|
StyleGuide: '#chefmodernizeprovidesfrominitialize'
|
1612
1645
|
Enabled: true
|
@@ -1616,7 +1649,7 @@ ChefModernize/ProvidesFromInitialize:
|
|
1616
1649
|
- '**/providers/*.rb'
|
1617
1650
|
- '**/libraries/*.rb'
|
1618
1651
|
|
1619
|
-
|
1652
|
+
Chef/Modernize/DatabagHelpers:
|
1620
1653
|
Description: Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.
|
1621
1654
|
StyleGuide: '#chefmodernizedatabaghelpers'
|
1622
1655
|
Enabled: true
|
@@ -1625,7 +1658,7 @@ ChefModernize/DatabagHelpers:
|
|
1625
1658
|
- '**/metadata.rb'
|
1626
1659
|
- '**/Berksfile'
|
1627
1660
|
|
1628
|
-
|
1661
|
+
Chef/Modernize/NodeRolesInclude:
|
1629
1662
|
Description: Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
|
1630
1663
|
StyleGuide: '#chefmodernizenoderolesinclude'
|
1631
1664
|
Enabled: true
|
@@ -1634,7 +1667,7 @@ ChefModernize/NodeRolesInclude:
|
|
1634
1667
|
- '**/metadata.rb'
|
1635
1668
|
- '**/Berksfile'
|
1636
1669
|
|
1637
|
-
|
1670
|
+
Chef/Modernize/RespondToCompileTime:
|
1638
1671
|
Description: There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
|
1639
1672
|
StyleGuide: '#chefmodernizeresondtocompiletime'
|
1640
1673
|
Enabled: true
|
@@ -1643,7 +1676,7 @@ ChefModernize/RespondToCompileTime:
|
|
1643
1676
|
- '**/metadata.rb'
|
1644
1677
|
- '**/Berksfile'
|
1645
1678
|
|
1646
|
-
|
1679
|
+
Chef/Modernize/ShellOutHelper:
|
1647
1680
|
Description: Use the built-in shell_out helper available in Chef Infra Client 12.11+ instead of calling Mixlib::ShellOut.new('foo').run_command.
|
1648
1681
|
StyleGuide: '#chefmodernizeshellouthelper'
|
1649
1682
|
Enabled: true
|
@@ -1653,7 +1686,7 @@ ChefModernize/ShellOutHelper:
|
|
1653
1686
|
- '**/Berksfile'
|
1654
1687
|
- '**/libraries/*.rb'
|
1655
1688
|
|
1656
|
-
|
1689
|
+
Chef/Modernize/ConditionalUsingTest:
|
1657
1690
|
Description: Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out.
|
1658
1691
|
StyleGuide: '#chefmodernizeconditionalusingtest'
|
1659
1692
|
Enabled: true
|
@@ -1663,7 +1696,7 @@ ChefModernize/ConditionalUsingTest:
|
|
1663
1696
|
- '**/Berksfile'
|
1664
1697
|
- '**/attributes/*.rb'
|
1665
1698
|
|
1666
|
-
|
1699
|
+
Chef/Modernize/CronDFileOrTemplate:
|
1667
1700
|
Description: Use the cron_d resource that ships with Chef Infra Client 14.4+ instead of manually creating the file with template, file, or cookbook_file resources
|
1668
1701
|
StyleGuide: '#chefmodernizecrondfileortemplate'
|
1669
1702
|
Enabled: true
|
@@ -1673,7 +1706,7 @@ ChefModernize/CronDFileOrTemplate:
|
|
1673
1706
|
- '**/Berksfile'
|
1674
1707
|
- '**/attributes/*.rb'
|
1675
1708
|
|
1676
|
-
|
1709
|
+
Chef/Modernize/ActionMethodInResource:
|
1677
1710
|
Description: Use the custom resource language's `action :my_action` blocks instead of creating actions with methods.
|
1678
1711
|
StyleGuide: '#chefmodernizeactionmethodinresource'
|
1679
1712
|
Enabled: true
|
@@ -1684,13 +1717,13 @@ ChefModernize/ActionMethodInResource:
|
|
1684
1717
|
- '**/libraries/*.rb'
|
1685
1718
|
|
1686
1719
|
###############################
|
1687
|
-
#
|
1720
|
+
# Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
|
1688
1721
|
###############################
|
1689
1722
|
|
1690
|
-
|
1691
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
1723
|
+
Chef/RedundantCode:
|
1724
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_redundantcode.md
|
1692
1725
|
|
1693
|
-
|
1726
|
+
Chef/RedundantCode/ConflictsMetadata:
|
1694
1727
|
Description: Don't use the deprecated 'conflicts' metadata value
|
1695
1728
|
StyleGuide: '#chefredundantcodeconflictsmetadata'
|
1696
1729
|
Enabled: true
|
@@ -1699,7 +1732,7 @@ ChefRedundantCode/ConflictsMetadata:
|
|
1699
1732
|
Include:
|
1700
1733
|
- '**/metadata.rb'
|
1701
1734
|
|
1702
|
-
|
1735
|
+
Chef/RedundantCode/SuggestsMetadata:
|
1703
1736
|
Description: The suggests metadata.rb method is not used and is unnecessary in cookbooks.
|
1704
1737
|
StyleGuide: '#chefredundantcodesuggestsmetadata'
|
1705
1738
|
Enabled: true
|
@@ -1708,7 +1741,7 @@ ChefRedundantCode/SuggestsMetadata:
|
|
1708
1741
|
Include:
|
1709
1742
|
- '**/metadata.rb'
|
1710
1743
|
|
1711
|
-
|
1744
|
+
Chef/RedundantCode/ProvidesMetadata:
|
1712
1745
|
Description: The provides metadata.rb method is not used and is unnecessary in cookbooks.
|
1713
1746
|
StyleGuide: '#chefredundantcodeprovidesmetadata'
|
1714
1747
|
Enabled: true
|
@@ -1717,7 +1750,7 @@ ChefRedundantCode/ProvidesMetadata:
|
|
1717
1750
|
Include:
|
1718
1751
|
- '**/metadata.rb'
|
1719
1752
|
|
1720
|
-
|
1753
|
+
Chef/RedundantCode/ReplacesMetadata:
|
1721
1754
|
Description: The replaces metadata.rb method is not used and is unnecessary in cookbooks.
|
1722
1755
|
StyleGuide: '#chefredundantcodereplacesmetadata'
|
1723
1756
|
Enabled: true
|
@@ -1726,7 +1759,7 @@ ChefRedundantCode/ReplacesMetadata:
|
|
1726
1759
|
Include:
|
1727
1760
|
- '**/metadata.rb'
|
1728
1761
|
|
1729
|
-
|
1762
|
+
Chef/RedundantCode/AttributeMetadata:
|
1730
1763
|
Description: The attribute metadata.rb method is not used and is unnecessary in cookbooks.
|
1731
1764
|
StyleGuide: '#chefredundantcodeattributemetadata'
|
1732
1765
|
Enabled: true
|
@@ -1735,7 +1768,7 @@ ChefRedundantCode/AttributeMetadata:
|
|
1735
1768
|
Include:
|
1736
1769
|
- '**/metadata.rb'
|
1737
1770
|
|
1738
|
-
|
1771
|
+
Chef/RedundantCode/LongDescriptionMetadata:
|
1739
1772
|
Description: The long_description metadata.rb method is not used and is unnecessary in cookbooks
|
1740
1773
|
StyleGuide: '#chefredundantcodelongdescriptionmetadata'
|
1741
1774
|
Enabled: true
|
@@ -1744,7 +1777,7 @@ ChefRedundantCode/LongDescriptionMetadata:
|
|
1744
1777
|
Include:
|
1745
1778
|
- '**/metadata.rb'
|
1746
1779
|
|
1747
|
-
|
1780
|
+
Chef/RedundantCode/RecipeMetadata:
|
1748
1781
|
Description: The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the README.md file instead.
|
1749
1782
|
StyleGuide: '#chefredundantcoderecipemetadata'
|
1750
1783
|
Enabled: true
|
@@ -1753,7 +1786,7 @@ ChefRedundantCode/RecipeMetadata:
|
|
1753
1786
|
Include:
|
1754
1787
|
- '**/metadata.rb'
|
1755
1788
|
|
1756
|
-
|
1789
|
+
Chef/RedundantCode/ResourceWithNothingAction:
|
1757
1790
|
Description: There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.
|
1758
1791
|
StyleGuide: '#chefredundantcoderesourcewithnothingaction'
|
1759
1792
|
Enabled: true
|
@@ -1764,7 +1797,7 @@ ChefRedundantCode/ResourceWithNothingAction:
|
|
1764
1797
|
- '**/resources/*.rb'
|
1765
1798
|
- '**/providers/*.rb'
|
1766
1799
|
|
1767
|
-
|
1800
|
+
Chef/RedundantCode/UnnecessaryNameProperty:
|
1768
1801
|
Description: There is no need to define a property named :name in a resource as Chef Infra defines that property for all resources by default.
|
1769
1802
|
StyleGuide: '#chefredundantcodeunnecessarynameproperty'
|
1770
1803
|
Enabled: true
|
@@ -1774,7 +1807,7 @@ ChefRedundantCode/UnnecessaryNameProperty:
|
|
1774
1807
|
- '**/resources/*.rb'
|
1775
1808
|
- '**/libraries/*.rb'
|
1776
1809
|
|
1777
|
-
|
1810
|
+
Chef/RedundantCode/PropertyWithRequiredAndDefault:
|
1778
1811
|
Description: Resource property should not be both required and have a default value
|
1779
1812
|
StyleGuide: '#chefredundantcodepropertywithrequiredanddefault'
|
1780
1813
|
Enabled: true
|
@@ -1784,7 +1817,7 @@ ChefRedundantCode/PropertyWithRequiredAndDefault:
|
|
1784
1817
|
- '**/resources/*.rb'
|
1785
1818
|
- '**/libraries/*.rb'
|
1786
1819
|
|
1787
|
-
|
1820
|
+
Chef/RedundantCode/NamePropertyIsRequired:
|
1788
1821
|
Description: Resource properties marked as name properties should not also be required properties
|
1789
1822
|
StyleGuide: '#chefredundantcodenamepropertyisrequired'
|
1790
1823
|
Enabled: true
|
@@ -1794,7 +1827,7 @@ ChefRedundantCode/NamePropertyIsRequired:
|
|
1794
1827
|
- '**/resources/*.rb'
|
1795
1828
|
- '**/libraries/*.rb'
|
1796
1829
|
|
1797
|
-
|
1830
|
+
Chef/RedundantCode/CustomResourceWithAllowedActions:
|
1798
1831
|
Description: It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
|
1799
1832
|
StyleGuide: '#chefredundantcodecustomresourcewithallowedactions'
|
1800
1833
|
Enabled: true
|
@@ -1803,7 +1836,7 @@ ChefRedundantCode/CustomResourceWithAllowedActions:
|
|
1803
1836
|
Include:
|
1804
1837
|
- '**/resources/*.rb'
|
1805
1838
|
|
1806
|
-
|
1839
|
+
Chef/RedundantCode/SensitivePropertyInResource:
|
1807
1840
|
Description: Every Chef Infra resources already include a sensitive property with a default value of false.
|
1808
1841
|
StyleGuide: '#chefredundantcodesensitivepropertyinresource'
|
1809
1842
|
Enabled: true
|
@@ -1812,7 +1845,7 @@ ChefRedundantCode/SensitivePropertyInResource:
|
|
1812
1845
|
- '**/resources/*.rb'
|
1813
1846
|
- '**/libraries/*.rb'
|
1814
1847
|
|
1815
|
-
|
1848
|
+
Chef/RedundantCode/UnnecessaryDesiredState:
|
1816
1849
|
Description: 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
|
1817
1850
|
StyleGuide: '#chefredundantcodeunnecessarydesiredstate'
|
1818
1851
|
Enabled: true
|
@@ -1821,7 +1854,7 @@ ChefRedundantCode/UnnecessaryDesiredState:
|
|
1821
1854
|
- '**/resources/*.rb'
|
1822
1855
|
- '**/libraries/*.rb'
|
1823
1856
|
|
1824
|
-
|
1857
|
+
Chef/RedundantCode/AptRepositoryNotifiesAptUpdate:
|
1825
1858
|
Description: There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
|
1826
1859
|
StyleGuide: '#chefredundantcodeaptrepositorynotifiesaptupdate'
|
1827
1860
|
Enabled: true
|
@@ -1831,7 +1864,7 @@ ChefRedundantCode/AptRepositoryNotifiesAptUpdate:
|
|
1831
1864
|
- '**/attributes/*.rb'
|
1832
1865
|
- '**/Berksfile'
|
1833
1866
|
|
1834
|
-
|
1867
|
+
Chef/RedundantCode/AptRepositoryDistributionDefault:
|
1835
1868
|
Description: There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
|
1836
1869
|
StyleGuide: '#chefredundantcodeaptrepositorydistributiondefault'
|
1837
1870
|
Enabled: true
|
@@ -1841,7 +1874,7 @@ ChefRedundantCode/AptRepositoryDistributionDefault:
|
|
1841
1874
|
- '**/attributes/*.rb'
|
1842
1875
|
- '**/Berksfile'
|
1843
1876
|
|
1844
|
-
|
1877
|
+
Chef/RedundantCode/GroupingMetadata:
|
1845
1878
|
Description: The grouping metadata.rb method is not used and is unnecessary in cookbooks.
|
1846
1879
|
StyleGuide: '#chefredundantcodegroupingmetadata'
|
1847
1880
|
Enabled: true
|
@@ -1849,7 +1882,7 @@ ChefRedundantCode/GroupingMetadata:
|
|
1849
1882
|
Include:
|
1850
1883
|
- '**/metadata.rb'
|
1851
1884
|
|
1852
|
-
|
1885
|
+
Chef/RedundantCode/StringPropertyWithNilDefault:
|
1853
1886
|
Description: Properties have a nil value by default so there is no need to set the default value to nil.
|
1854
1887
|
StyleGuide: '#chefredundantcodestringpropertywithnildefault'
|
1855
1888
|
Enabled: true
|
@@ -1858,7 +1891,7 @@ ChefRedundantCode/StringPropertyWithNilDefault:
|
|
1858
1891
|
- '**/resources/*.rb'
|
1859
1892
|
- '**/libraries/*.rb'
|
1860
1893
|
|
1861
|
-
|
1894
|
+
Chef/RedundantCode/PropertySplatRegex:
|
1862
1895
|
Description: There is no need to validate the input of properties in resources using a regex value that will always pass.
|
1863
1896
|
StyleGuide: '#chefredundantcodepropertysplatregex'
|
1864
1897
|
Enabled: true
|
@@ -1867,7 +1900,7 @@ ChefRedundantCode/PropertySplatRegex:
|
|
1867
1900
|
- '**/resources/*.rb'
|
1868
1901
|
- '**/libraries/*.rb'
|
1869
1902
|
|
1870
|
-
|
1903
|
+
Chef/RedundantCode/UseCreateIfMissing:
|
1871
1904
|
Description: Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.
|
1872
1905
|
StyleGuide: '#chefredundantcodeusecreateifmissing'
|
1873
1906
|
Enabled: true
|
@@ -1877,7 +1910,7 @@ ChefRedundantCode/UseCreateIfMissing:
|
|
1877
1910
|
- '**/attributes/*.rb'
|
1878
1911
|
- '**/Berksfile'
|
1879
1912
|
|
1880
|
-
|
1913
|
+
Chef/RedundantCode/OhaiAttributeToString:
|
1881
1914
|
Description: Many Ohai node attributes are already strings and don't need to be cast to strings again
|
1882
1915
|
StyleGuide: '#chefredundantcodeohaiattributetostring'
|
1883
1916
|
Enabled: true
|
@@ -1886,7 +1919,7 @@ ChefRedundantCode/OhaiAttributeToString:
|
|
1886
1919
|
- '**/metadata.rb'
|
1887
1920
|
- '**/Berksfile'
|
1888
1921
|
|
1889
|
-
|
1922
|
+
Chef/RedundantCode/MultiplePlatformChecks:
|
1890
1923
|
Description: You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
|
1891
1924
|
StyleGuide: '#chefredundantcodemultipleplatformchecks'
|
1892
1925
|
Enabled: true
|
@@ -1895,7 +1928,7 @@ ChefRedundantCode/MultiplePlatformChecks:
|
|
1895
1928
|
- '**/metadata.rb'
|
1896
1929
|
- '**/Berksfile'
|
1897
1930
|
|
1898
|
-
|
1931
|
+
Chef/RedundantCode/DoubleCompileTime:
|
1899
1932
|
Description: If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
|
1900
1933
|
StyleGuide: '#chefredundantcodedoublecompiletime'
|
1901
1934
|
Enabled: true
|
@@ -1906,13 +1939,13 @@ ChefRedundantCode/DoubleCompileTime:
|
|
1906
1939
|
- '**/Berksfile'
|
1907
1940
|
|
1908
1941
|
###############################
|
1909
|
-
#
|
1942
|
+
# Chef/Effortless: Migrating to new patterns
|
1910
1943
|
###############################
|
1911
1944
|
|
1912
|
-
|
1913
|
-
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/
|
1945
|
+
Chef/Effortless:
|
1946
|
+
StyleGuideBaseURL: https://github.com/chef/cookstyle/blob/master/docs/cops_chef_effortless.md
|
1914
1947
|
|
1915
|
-
|
1948
|
+
Chef/Effortless/CookbookUsesSearch:
|
1916
1949
|
Description: Cookbook uses search, which cannot be used in the Effortless Infra pattern
|
1917
1950
|
StyleGuide: '#chefeffortlesscookbookusessearch'
|
1918
1951
|
Enabled: false
|
@@ -1921,7 +1954,7 @@ ChefEffortless/CookbookUsesSearch:
|
|
1921
1954
|
- '**/metadata.rb'
|
1922
1955
|
- '**/Berksfile'
|
1923
1956
|
|
1924
|
-
|
1957
|
+
Chef/Effortless/CookbookUsesDatabags:
|
1925
1958
|
Description: Cookbook uses data bags, which cannot be used in the Effortless Infra pattern
|
1926
1959
|
StyleGuide: '#chefeffortlesscookbookusesdatabags'
|
1927
1960
|
Enabled: false
|
@@ -1931,7 +1964,7 @@ ChefEffortless/CookbookUsesDatabags:
|
|
1931
1964
|
- '**/Berksfile'
|
1932
1965
|
|
1933
1966
|
# https://github.com/chef/cookstyle/issues/346
|
1934
|
-
|
1967
|
+
Chef/Effortless/ChefVaultUsed:
|
1935
1968
|
Description: Cookbook uses Chef Vault, which cannot be used in the Effortless Infra pattern
|
1936
1969
|
StyleGuide: '#chefeffortlesscookbookuseschefvault'
|
1937
1970
|
Enabled: false
|
@@ -1941,7 +1974,7 @@ ChefEffortless/ChefVaultUsed:
|
|
1941
1974
|
- '**/Berksfile'
|
1942
1975
|
|
1943
1976
|
# https://github.com/chef/cookstyle/issues/346
|
1944
|
-
|
1977
|
+
Chef/Effortless/DependsChefVault:
|
1945
1978
|
Description: Cookbook depends on Chef Vault, which cannot be used in the Effortless Infra pattern
|
1946
1979
|
StyleGuide: '#chefeffortlesscookbookdependschefvault'
|
1947
1980
|
Enabled: false
|
@@ -1949,7 +1982,7 @@ ChefEffortless/DependsChefVault:
|
|
1949
1982
|
Include:
|
1950
1983
|
- '**/metadata.rb'
|
1951
1984
|
|
1952
|
-
|
1985
|
+
Chef/Effortless/CookbookUsesEnvironments:
|
1953
1986
|
Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern
|
1954
1987
|
StyleGuide: '#chefeffortlesscookbookusesenvironments'
|
1955
1988
|
Enabled: false
|
@@ -1958,7 +1991,7 @@ ChefEffortless/CookbookUsesEnvironments:
|
|
1958
1991
|
- '**/metadata.rb'
|
1959
1992
|
- '**/Berksfile'
|
1960
1993
|
|
1961
|
-
|
1994
|
+
Chef/Effortless/CookbookUsesPolicygroups:
|
1962
1995
|
Description: Cookbook uses Policy Groups, which cannot be used in the Effortless Infra pattern
|
1963
1996
|
StyleGuide: '#chefeffortlesscookbookusespolicygroups'
|
1964
1997
|
Enabled: false
|
@@ -1967,7 +2000,7 @@ ChefEffortless/CookbookUsesPolicygroups:
|
|
1967
2000
|
- '**/metadata.rb'
|
1968
2001
|
- '**/Berksfile'
|
1969
2002
|
|
1970
|
-
|
2003
|
+
Chef/Effortless/CookbookUsesRoles:
|
1971
2004
|
Description: Cookbook uses Roles, which cannot be used in the Effortless Infra pattern
|
1972
2005
|
StyleGuide: '#chefeffortlesscookbookusesroles'
|
1973
2006
|
Enabled: false
|
@@ -1976,7 +2009,7 @@ ChefEffortless/CookbookUsesRoles:
|
|
1976
2009
|
- '**/metadata.rb'
|
1977
2010
|
- '**/Berksfile'
|
1978
2011
|
|
1979
|
-
|
2012
|
+
Chef/Effortless/SearchForEnvironmentsOrRoles:
|
1980
2013
|
Description: Cookbook uses search with a node query that looks for a role or environment
|
1981
2014
|
StyleGuide: '#chefeffortlesssearchforenvironmentsorroles'
|
1982
2015
|
Enabled: false
|
@@ -1985,7 +2018,7 @@ ChefEffortless/SearchForEnvironmentsOrRoles:
|
|
1985
2018
|
- '**/metadata.rb'
|
1986
2019
|
- '**/Berksfile'
|
1987
2020
|
|
1988
|
-
|
2021
|
+
Chef/Effortless/Berksfile:
|
1989
2022
|
Description: Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
|
1990
2023
|
StyleGuide: '#chefeffortlessberksfile'
|
1991
2024
|
Enabled: false
|
@@ -2477,10 +2510,9 @@ Style/EachForSimpleLoop:
|
|
2477
2510
|
Style/EmptyCaseCondition:
|
2478
2511
|
Enabled: true
|
2479
2512
|
|
2480
|
-
#
|
2513
|
+
# It doesn't matter if people use the friendly helpers or not for overall readability
|
2481
2514
|
Style/NumericPredicate:
|
2482
|
-
Enabled:
|
2483
|
-
EnforcedStyle: comparison
|
2515
|
+
Enabled: false
|
2484
2516
|
|
2485
2517
|
# this is bad %w(something another_thing one_more)
|
2486
2518
|
Layout/SpaceInsideArrayPercentLiteral:
|
@@ -2731,4 +2763,8 @@ Style/ExpandPathArguments:
|
|
2731
2763
|
|
2732
2764
|
# Avoid a safe navigation operator if we don't need it
|
2733
2765
|
Lint/RedundantSafeNavigation:
|
2766
|
+
Enabled: true
|
2767
|
+
|
2768
|
+
# Avoid using blocks to remove nils from a Hash/Array
|
2769
|
+
Style/CollectionCompact:
|
2734
2770
|
Enabled: true
|