cookstyle 8.7.6 → 9.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (272) hide show
  1. checksums.yaml +4 -4
  2. data/config/chefstyle.yml +14 -0
  3. data/config/cookstyle.yml +157 -6
  4. data/lib/cookstyle/version.rb +2 -2
  5. data/lib/cookstyle.rb +5 -6
  6. data/lib/rubocop/chef/autocorrect_helpers.rb +1 -1
  7. data/lib/rubocop/chef/cookbook_helpers.rb +24 -1
  8. data/lib/rubocop/chef/platform_helpers.rb +1 -1
  9. data/lib/rubocop/chef.rb +1 -1
  10. data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb +1 -1
  11. data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb +17 -5
  12. data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb +1 -1
  13. data/lib/rubocop/cop/chef/correctness/conditional_unified_mode_true.rb +91 -0
  14. data/lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb +1 -1
  15. data/lib/rubocop/cop/chef/correctness/empty_resource_guard.rb +18 -2
  16. data/lib/rubocop/cop/chef/correctness/execute_delete_file.rb +127 -0
  17. data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb +1 -1
  18. data/lib/rubocop/cop/chef/correctness/invalid_checksum.rb +79 -0
  19. data/lib/rubocop/cop/chef/correctness/invalid_cookbook_name.rb +1 -1
  20. data/lib/rubocop/cop/chef/correctness/invalid_default_action.rb +1 -1
  21. data/lib/rubocop/cop/chef/correctness/invalid_notification_resource.rb +1 -1
  22. data/lib/rubocop/cop/chef/correctness/invalid_notification_timing.rb +1 -1
  23. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_helper.rb +2 -2
  24. data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb +11 -1
  25. data/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb +1 -1
  26. data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb +1 -1
  27. data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb +11 -1
  28. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb +1 -1
  29. data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb +2 -1
  30. data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb +1 -1
  31. data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb +1 -1
  32. data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb +1 -1
  33. data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb +1 -1
  34. data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb +1 -1
  35. data/lib/rubocop/cop/chef/correctness/metadata_malformed_version.rb +1 -1
  36. data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb +1 -1
  37. data/lib/rubocop/cop/chef/correctness/metadata_missing_version.rb +1 -1
  38. data/lib/rubocop/cop/chef/correctness/node_save.rb +1 -1
  39. data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb +1 -1
  40. data/lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb +1 -1
  41. data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb +1 -1
  42. data/lib/rubocop/cop/chef/correctness/platform_version_string_comparison.rb +66 -0
  43. data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb +6 -6
  44. data/lib/rubocop/cop/chef/correctness/powershell_file_exists.rb +2 -2
  45. data/lib/rubocop/cop/chef/correctness/property_without_type.rb +1 -1
  46. data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb +1 -1
  47. data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb +1 -1
  48. data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb +4 -4
  49. data/lib/rubocop/cop/chef/correctness/ruby_guard_without_block.rb +91 -0
  50. data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb +1 -1
  51. data/lib/rubocop/cop/chef/correctness/service_resource.rb +71 -20
  52. data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb +1 -1
  53. data/lib/rubocop/cop/chef/deprecation/cb_depends_on_self.rb +1 -1
  54. data/lib/rubocop/cop/chef/deprecation/chef_handler_recipe.rb +9 -2
  55. data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb +1 -1
  56. data/lib/rubocop/cop/chef/deprecation/chef_rest.rb +5 -2
  57. data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb +1 -1
  58. data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb +3 -3
  59. data/lib/rubocop/cop/chef/deprecation/chef_sugar_helpers.rb +7 -1
  60. data/lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb +2 -2
  61. data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb +1 -1
  62. data/lib/rubocop/cop/chef/deprecation/cheffile.rb +1 -1
  63. data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb +1 -1
  64. data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb +1 -1
  65. data/lib/rubocop/cop/chef/deprecation/chocolatey_package_uninstall_action.rb +4 -4
  66. data/lib/rubocop/cop/chef/deprecation/delivery.rb +1 -1
  67. data/lib/rubocop/cop/chef/deprecation/depends_chef_nginx_cookbook.rb +1 -1
  68. data/lib/rubocop/cop/chef/deprecation/depends_chef_reporting_cookbook.rb +1 -1
  69. data/lib/rubocop/cop/chef/deprecation/depends_compat_resource.rb +1 -1
  70. data/lib/rubocop/cop/chef/deprecation/depends_omnibus_updater_cookbook.rb +1 -1
  71. data/lib/rubocop/cop/chef/deprecation/depends_partial_search.rb +5 -1
  72. data/lib/rubocop/cop/chef/deprecation/depends_poise.rb +1 -1
  73. data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb +1 -1
  74. data/lib/rubocop/cop/chef/deprecation/deprecated_mixins.rb +3 -3
  75. data/lib/rubocop/cop/chef/deprecation/deprecated_platform_methods.rb +1 -1
  76. data/lib/rubocop/cop/chef/deprecation/deprecated_shellout_methods.rb +1 -1
  77. data/lib/rubocop/cop/chef/deprecation/deprecated_sudo_actions.rb +1 -1
  78. data/lib/rubocop/cop/chef/deprecation/deprecated_windows_version_check.rb +1 -1
  79. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_actions.rb +1 -1
  80. data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb +1 -1
  81. data/lib/rubocop/cop/chef/deprecation/easy_install.rb +1 -1
  82. data/lib/rubocop/cop/chef/deprecation/eol_audit_mode.rb +1 -1
  83. data/lib/rubocop/cop/chef/deprecation/epic_fail.rb +1 -1
  84. data/lib/rubocop/cop/chef/deprecation/erl_call.rb +1 -1
  85. data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb +1 -1
  86. data/lib/rubocop/cop/chef/deprecation/execute_relative_creates_without_cwd.rb +1 -1
  87. data/lib/rubocop/cop/chef/deprecation/foodcritic_file.rb +1 -1
  88. data/lib/rubocop/cop/chef/deprecation/foodcritic_testing.rb +1 -1
  89. data/lib/rubocop/cop/chef/deprecation/hwrp_without_provides.rb +5 -5
  90. data/lib/rubocop/cop/chef/deprecation/hwrp_without_unified_mode_true.rb +3 -3
  91. data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb +4 -4
  92. data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb +1 -1
  93. data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb +1 -1
  94. data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb +10 -2
  95. data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb +1 -1
  96. data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb +6 -1
  97. data/lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb +1 -1
  98. data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb +1 -1
  99. data/lib/rubocop/cop/chef/deprecation/name_property_and_default.rb +1 -1
  100. data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb +1 -1
  101. data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb +1 -1
  102. data/lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb +1 -1
  103. data/lib/rubocop/cop/chef/deprecation/poise_archive.rb +1 -1
  104. data/lib/rubocop/cop/chef/deprecation/policyfile_community_source.rb +1 -1
  105. data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb +1 -1
  106. data/lib/rubocop/cop/chef/deprecation/require_recipe.rb +1 -1
  107. data/lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb +1 -1
  108. data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb +1 -1
  109. data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb +10 -2
  110. data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb +5 -1
  111. data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb +1 -1
  112. data/lib/rubocop/cop/chef/deprecation/resource_without_unified_mode_true.rb +1 -1
  113. data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb +1 -1
  114. data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb +43 -4
  115. data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb +1 -1
  116. data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb +1 -1
  117. data/lib/rubocop/cop/chef/deprecation/use_automatic_resource_name.rb +10 -1
  118. data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb +1 -1
  119. data/lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb +6 -1
  120. data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb +1 -1
  121. data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb +1 -1
  122. data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb +1 -1
  123. data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb +1 -1
  124. data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb +1 -1
  125. data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb +1 -1
  126. data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb +6 -2
  127. data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb +1 -1
  128. data/lib/rubocop/cop/chef/effortless/berksfile.rb +1 -1
  129. data/lib/rubocop/cop/chef/effortless/data_bags.rb +1 -1
  130. data/lib/rubocop/cop/chef/effortless/node_environment.rb +1 -1
  131. data/lib/rubocop/cop/chef/effortless/node_policygroup.rb +1 -1
  132. data/lib/rubocop/cop/chef/effortless/node_roles.rb +1 -1
  133. data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb +1 -1
  134. data/lib/rubocop/cop/chef/effortless/search_used.rb +1 -1
  135. data/lib/rubocop/cop/chef/modernize/action_method_in_resource.rb +1 -1
  136. data/lib/rubocop/cop/chef/modernize/allowed_actions_initializer.rb +1 -1
  137. data/lib/rubocop/cop/chef/modernize/apt_default_recipe.rb +2 -2
  138. data/lib/rubocop/cop/chef/modernize/berksfile_source.rb +1 -1
  139. data/lib/rubocop/cop/chef/modernize/build_essential.rb +5 -2
  140. data/lib/rubocop/cop/chef/modernize/chef_14_resources.rb +9 -1
  141. data/lib/rubocop/cop/chef/modernize/chef_15_resources.rb +12 -1
  142. data/lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb +5 -1
  143. data/lib/rubocop/cop/chef/modernize/class_eval_action_class.rb +1 -1
  144. data/lib/rubocop/cop/chef/modernize/compile_time_resources.rb +1 -1
  145. data/lib/rubocop/cop/chef/modernize/conditional_using_test.rb +11 -4
  146. data/lib/rubocop/cop/chef/modernize/cron_d_file_or_template.rb +7 -5
  147. data/lib/rubocop/cop/chef/modernize/cron_manage_resource.rb +1 -1
  148. data/lib/rubocop/cop/chef/modernize/databag_helpers.rb +7 -4
  149. data/lib/rubocop/cop/chef/modernize/declare_action_class.rb +1 -1
  150. data/lib/rubocop/cop/chef/modernize/default_action_initializer.rb +1 -1
  151. data/lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb +1 -1
  152. data/lib/rubocop/cop/chef/modernize/definitions.rb +1 -1
  153. data/lib/rubocop/cop/chef/modernize/depends_chef_vault_cookbook.rb +5 -1
  154. data/lib/rubocop/cop/chef/modernize/depends_chocolatey_cookbooks.rb +8 -1
  155. data/lib/rubocop/cop/chef/modernize/depends_kernel_module_cookbook.rb +7 -1
  156. data/lib/rubocop/cop/chef/modernize/depends_locale_cookbook.rb +7 -1
  157. data/lib/rubocop/cop/chef/modernize/depends_openssl_cookbook.rb +10 -1
  158. data/lib/rubocop/cop/chef/modernize/depends_timezone_lwrp_cookbook.rb +5 -1
  159. data/lib/rubocop/cop/chef/modernize/depends_windows_firewall_cookbook.rb +9 -1
  160. data/lib/rubocop/cop/chef/modernize/depends_zypper_cookbook.rb +8 -1
  161. data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.rb +2 -2
  162. data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.rb +1 -1
  163. data/lib/rubocop/cop/chef/modernize/execute_apt_update.rb +4 -2
  164. data/lib/rubocop/cop/chef/modernize/execute_archive_extract.rb +121 -0
  165. data/lib/rubocop/cop/chef/modernize/execute_sc_exe.rb +1 -1
  166. data/lib/rubocop/cop/chef/modernize/execute_sleep.rb +1 -1
  167. data/lib/rubocop/cop/chef/modernize/execute_sysctl.rb +1 -1
  168. data/lib/rubocop/cop/chef/modernize/execute_tzutil.rb +1 -1
  169. data/lib/rubocop/cop/chef/modernize/execute_update_alternatives.rb +100 -0
  170. data/lib/rubocop/cop/chef/modernize/foodcritic_comments.rb +1 -1
  171. data/lib/rubocop/cop/chef/modernize/if_provides_default_action.rb +1 -1
  172. data/lib/rubocop/cop/chef/modernize/includes_mixin_shellout.rb +5 -1
  173. data/lib/rubocop/cop/chef/modernize/libarchive_file.rb +6 -4
  174. data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb +1 -1
  175. data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb +1 -1
  176. data/lib/rubocop/cop/chef/modernize/node_init_package.rb +1 -1
  177. data/lib/rubocop/cop/chef/modernize/node_roles_include.rb +1 -1
  178. data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb +7 -2
  179. data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb +1 -1
  180. data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb +1 -1
  181. data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb +1 -1
  182. data/lib/rubocop/cop/chef/modernize/powershell_download_file.rb +64 -0
  183. data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb +9 -2
  184. data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb +5 -5
  185. data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb +1 -1
  186. data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb +1 -1
  187. data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb +1 -1
  188. data/lib/rubocop/cop/chef/modernize/provides_initializer.rb +1 -1
  189. data/lib/rubocop/cop/chef/modernize/resource_name_initializer.rb +1 -1
  190. data/lib/rubocop/cop/chef/modernize/resource_set_or_return.rb +1 -1
  191. data/lib/rubocop/cop/chef/modernize/resource_with_attributes.rb +1 -1
  192. data/lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb +1 -1
  193. data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb +1 -1
  194. data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb +1 -1
  195. data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb +1 -1
  196. data/lib/rubocop/cop/chef/modernize/sc_windows_resource.rb +3 -3
  197. data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb +8 -2
  198. data/lib/rubocop/cop/chef/modernize/shell_out_helper.rb +1 -1
  199. data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb +16 -5
  200. data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb +1 -1
  201. data/lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb +1 -1
  202. data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb +1 -1
  203. data/lib/rubocop/cop/chef/modernize/use_chef_language_cloud_helpers.rb +1 -1
  204. data/lib/rubocop/cop/chef/modernize/use_chef_language_env_helpers.rb +1 -1
  205. data/lib/rubocop/cop/chef/modernize/use_chef_language_systemd_helper.rb +1 -1
  206. data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb +1 -1
  207. data/lib/rubocop/cop/chef/modernize/use_require_relative.rb +2 -2
  208. data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb +1 -1
  209. data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb +2 -2
  210. data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb +1 -1
  211. data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb +9 -3
  212. data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb +8 -2
  213. data/lib/rubocop/cop/chef/modernize/zypper_repo.rb +3 -3
  214. data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb +1 -1
  215. data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb +1 -1
  216. data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb +1 -1
  217. data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb +1 -1
  218. data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb +11 -1
  219. data/lib/rubocop/cop/chef/redundant/double_compile_time.rb +23 -9
  220. data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb +1 -1
  221. data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb +1 -1
  222. data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb +1 -1
  223. data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb +1 -1
  224. data/lib/rubocop/cop/chef/redundant/ohai_attribute_to_string.rb +1 -1
  225. data/lib/rubocop/cop/chef/redundant/property_splat_regex.rb +1 -1
  226. data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb +1 -1
  227. data/lib/rubocop/cop/chef/redundant/provides_metadata.rb +1 -1
  228. data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb +1 -1
  229. data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb +1 -1
  230. data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb +1 -1
  231. data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb +1 -1
  232. data/lib/rubocop/cop/chef/redundant/service_guard_on_stop_disable.rb +117 -0
  233. data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb +3 -3
  234. data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb +1 -1
  235. data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb +1 -1
  236. data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb +2 -2
  237. data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb +1 -1
  238. data/lib/rubocop/cop/chef/security/insecure_remote_file_source.rb +82 -0
  239. data/lib/rubocop/cop/chef/security/ssh_private_key.rb +10 -1
  240. data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb +1 -1
  241. data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb +1 -1
  242. data/lib/rubocop/cop/chef/sharing/empty_property_description.rb +62 -0
  243. data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb +1 -1
  244. data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb +1 -1
  245. data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb +1 -1
  246. data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb +1 -1
  247. data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb +1 -1
  248. data/lib/rubocop/cop/chef/style/chef_whaaat.rb +1 -1
  249. data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb +1 -1
  250. data/lib/rubocop/cop/chef/style/comments_copyright_format.rb +1 -1
  251. data/lib/rubocop/cop/chef/style/comments_default_copyright.rb +1 -1
  252. data/lib/rubocop/cop/chef/style/comments_format.rb +1 -1
  253. data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb +1 -1
  254. data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb +6 -3
  255. data/lib/rubocop/cop/chef/style/negating_only_if.rb +1 -1
  256. data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb +1 -1
  257. data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb +1 -1
  258. data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb +2 -2
  259. data/lib/rubocop/cop/chef/style/unnecessary_os_check.rb +1 -1
  260. data/lib/rubocop/cop/chef/style/unnecessary_platform_case_statement.rb +1 -1
  261. data/lib/rubocop/cop/chef/style/use_platform_helpers.rb +1 -1
  262. data/lib/rubocop/cop/chef.rb +349 -0
  263. data/lib/rubocop/cop/chefstyle/ruby/gemspec_license.rb +1 -1
  264. data/lib/rubocop/cop/chefstyle/ruby/gemspec_require_rubygems.rb +1 -1
  265. data/lib/rubocop/cop/chefstyle/ruby/legacy_powershell_out_methods.rb +1 -1
  266. data/lib/rubocop/cop/chefstyle/ruby/require_net_https.rb +1 -1
  267. data/lib/rubocop/cop/chefstyle/ruby/unless_defined_require.rb +1 -1
  268. data/lib/rubocop/cop/inspec/deprecation/attribute_default.rb +1 -1
  269. data/lib/rubocop/cop/inspec/deprecation/attribute_helper.rb +1 -1
  270. data/lib/rubocop/cop/inspec.rb +31 -0
  271. data/lib/rubocop/monkey_patches/directive_comment.rb +21 -3
  272. metadata +21 -8
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -29,6 +29,16 @@ module RuboCop
29
29
  # # also bad
30
30
  # actions [:create, :remove]
31
31
  #
32
+ # # good
33
+ # # Chef Infra Client derives the allowed actions from the actions you define
34
+ # action :create do
35
+ # # ...
36
+ # end
37
+ #
38
+ # action :remove do
39
+ # # ...
40
+ # end
41
+ #
32
42
  class CustomResourceWithAllowedActions < Base
33
43
  include RangeHelp
34
44
  extend AutoCorrector
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -41,23 +41,37 @@ module RuboCop
41
41
  MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
42
42
  RESTRICT_ON_SEND = [:run_action].freeze
43
43
 
44
- def_node_matcher :compile_time_and_run_action?, <<-PATTERN
44
+ def_node_matcher :run_action_on_resource?, <<-PATTERN
45
45
  (send
46
46
  $(block
47
47
  (send nil? ... )
48
48
  (args)
49
- (begin <
50
- (send nil? :action (sym $_) )
51
- (send nil? :compile_time (true) )
52
- ...
53
- >)
49
+ _
54
50
  ) :run_action (sym $_) )
55
51
  PATTERN
56
52
 
53
+ def_node_search :compile_time_true?, '(send nil? :compile_time (true))'
54
+ def_node_search :action_nodes, '(send nil? :action $(sym _))'
55
+
57
56
  def on_send(node)
58
- compile_time_and_run_action?(node) do |resource, action, run_action|
57
+ run_action_on_resource?(node) do |resource, run_action|
58
+ next unless compile_time_true?(resource.body)
59
+
60
+ # without an explicit action there's nothing to rewrite: the resource runs its
61
+ # default action, and picking the replacement would mean knowing what that is.
62
+ # report it, but leave the fix to a human.
63
+ action = action_nodes(resource.body).first
64
+ unless action
65
+ add_offense(node.loc.selector, severity: :refactor)
66
+ next
67
+ end
68
+
59
69
  add_offense(node.loc.selector, severity: :refactor) do |corrector|
60
- corrector.replace(node, resource.source.gsub(action.to_s, run_action.to_s))
70
+ # rewrite the action's value and drop the trailing .run_action(...). rewriting the
71
+ # whole block source instead would replace the action name wherever else it appears,
72
+ # renaming the resource itself in something like chef_gem 'nothing'
73
+ corrector.replace(action, ":#{run_action}")
74
+ corrector.remove(node.loc.dot.join(node.source_range.end))
61
75
  end
62
76
  end
63
77
  end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -0,0 +1,117 @@
1
+ # frozen_string_literal: true
2
+ #
3
+ # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+ module RuboCop
19
+ module Cop
20
+ module Chef
21
+ module RedundantCode
22
+ # The `:stop` and `:disable` actions of the `service` resource are already no-ops when the service
23
+ # isn't installed, so guarding them with a check for the init script or unit file adds nothing. The
24
+ # base provider only converges these actions when `current_resource.running`/`current_resource.enabled`
25
+ # is set, and the platform providers never set that state for a service they can't find.
26
+ #
27
+ # The guard is also actively harmful because it hardcodes a single path while the provider searches
28
+ # several. A guard on `/usr/local/etc/rc.d/snmpd` skips a FreeBSD host running the service out of
29
+ # `/etc/rc.d`, and the run then reports success while leaving the service enabled.
30
+ #
31
+ # This cop only fires when every action is `:stop` or `:disable`. Actions like `:start`, `:enable`,
32
+ # `:restart`, and `:reload` are asserted against the init script, so a guard there is meaningful. The
33
+ # `systemd_unit` resource shells out unconditionally, so its guards are meaningful as well and are
34
+ # never flagged.
35
+ #
36
+ # @example
37
+ #
38
+ # # bad
39
+ # service 'snmpd' do
40
+ # action %i(stop disable)
41
+ # only_if { ::File.exist?('/usr/local/etc/rc.d/snmpd') }
42
+ # end
43
+ #
44
+ # # good
45
+ # service 'snmpd' do
46
+ # action %i(stop disable)
47
+ # end
48
+ #
49
+ class ServiceGuardOnStopDisable < Base
50
+ include RuboCop::Chef::CookbookHelpers
51
+ include RangeHelp
52
+ extend AutoCorrector
53
+
54
+ MSG = 'A service resource that only stops or disables a service does not need a guard checking for the init script or unit file. Chef Infra Client already skips these actions when the service does not exist, and hardcoding a single path can silently skip services installed elsewhere.'
55
+
56
+ # actions that Chef Infra Client treats as no-ops when the service can't be found
57
+ NO_OP_ACTIONS = %i(stop disable).freeze
58
+
59
+ # the directories the various service providers search for init scripts and unit files
60
+ INIT_SCRIPT_PATH = %r{/(?:etc/init\.d|etc/rc\.d|usr/local/etc/rc\.d|etc/sv|systemd/system)/}.freeze
61
+
62
+ def_node_matcher :file_exist_check, <<~PATTERN
63
+ (send (const {nil? cbase} :File) {:exist? :exists? :executable? :file? :readable?} $_)
64
+ PATTERN
65
+
66
+ def_node_search :action_nodes, '(send nil? :action $...)'
67
+
68
+ def on_block(node)
69
+ match_property_in_resource?(:service, %i(only_if not_if), node) do |guard|
70
+ # a string guard like `only_if 'test -f /etc/init.d/foo'` isn't a Ruby block
71
+ next unless guard.block_type?
72
+ next unless only_no_op_actions?(node)
73
+
74
+ # `guard.body` is only a bare send when the block does nothing but the existence check.
75
+ # Anything more (a `&&`, a second statement) is a guard we shouldn't touch.
76
+ path = file_exist_check(guard.body)
77
+ next unless path && INIT_SCRIPT_PATH.match?(path.source)
78
+
79
+ add_offense(guard, severity: :refactor) do |corrector|
80
+ corrector.remove(range_by_whole_lines(guard.source_range, include_final_newline: true))
81
+ end
82
+ end
83
+ end
84
+
85
+ private
86
+
87
+ # @param [RuboCop::AST::BlockNode] node the resource block
88
+ #
89
+ # @return [Boolean] the resource declares at least one action and all of them are no-ops
90
+ # for a service that isn't installed
91
+ def only_no_op_actions?(node)
92
+ actions = action_nodes(node).flat_map { |args| args.flat_map { |arg| action_symbols(arg) } }
93
+ !actions.empty? && actions.all? { |action| NO_OP_ACTIONS.include?(action) }
94
+ end
95
+
96
+ # Unwrap the ways an action can be written: `action :stop`, `action %i(stop disable)`,
97
+ # and `action [:stop, :disable]`. Anything else (a variable, a node attribute) yields nil,
98
+ # which fails the NO_OP_ACTIONS check and leaves the resource alone.
99
+ #
100
+ # @param [RuboCop::AST::Node] node
101
+ #
102
+ # @return [Array<Symbol, nil>]
103
+ def action_symbols(node)
104
+ case node.type
105
+ when :sym
106
+ [node.value]
107
+ when :array
108
+ node.values.flat_map { |value| action_symbols(value) }
109
+ else
110
+ [nil]
111
+ end
112
+ end
113
+ end
114
+ end
115
+ end
116
+ end
117
+ end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -40,13 +40,13 @@ module RuboCop
40
40
 
41
41
  def_node_matcher :string_property_with_nil_default?, <<-PATTERN
42
42
  (send nil? :property (sym _)
43
- {(const nil? :String) #string_and_nil_like?}
43
+ {(const {nil? cbase} :String) #string_and_nil_like?}
44
44
  (hash <$(pair (sym :default) (nil)) ...>))
45
45
  PATTERN
46
46
 
47
47
  # An array of types that includes String & either NilClass or nil
48
48
  def_node_matcher :string_and_nil_like?, <<-PATTERN
49
- (array <(const nil? :String) {(const nil? :NilClass) (nil)}>)
49
+ (array <(const {nil? cbase} :String) {(const {nil? cbase} :NilClass) (nil)}>)
50
50
  PATTERN
51
51
 
52
52
  def on_send(node)
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -39,7 +39,7 @@ module RuboCop
39
39
  def_node_matcher :name_property?, <<-PATTERN
40
40
  (send nil? {:attribute :property}
41
41
  (sym :name)
42
- (const nil? :String)?
42
+ (const {nil? cbase} :String)?
43
43
  (hash $...)?
44
44
  )
45
45
  PATTERN
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -0,0 +1,82 @@
1
+ # frozen_string_literal: true
2
+ #
3
+ # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+ module RuboCop
19
+ module Cop
20
+ module Chef
21
+ module Security
22
+ # Files downloaded over plain HTTP or FTP can be modified in transit, and the resource will
23
+ # use whatever it receives. Fetch them over HTTPS so the transport is authenticated.
24
+ #
25
+ # Where an HTTPS endpoint genuinely isn't available, a `checksum` on the resource at least
26
+ # detects tampering, since the digest is compared before the file is used.
27
+ #
28
+ # @example
29
+ #
30
+ # # bad
31
+ # remote_file '/tmp/foo.tar.gz' do
32
+ # source 'http://example.com/foo.tar.gz'
33
+ # end
34
+ #
35
+ # # good
36
+ # remote_file '/tmp/foo.tar.gz' do
37
+ # source 'https://example.com/foo.tar.gz'
38
+ # end
39
+ #
40
+ class InsecureRemoteFileSource < Base
41
+ include RuboCop::Chef::CookbookHelpers
42
+
43
+ MSG = 'Fetch remote files over HTTPS. A file downloaded over plain HTTP or FTP can be modified in transit and the resource will use whatever it receives.'
44
+
45
+ # the resources that download a file from the source property
46
+ RESOURCES = %i(remote_file windows_package msu_package dmg_package cab_package).freeze
47
+
48
+ # transports with no authentication of the server or the payload
49
+ INSECURE_SCHEME = %r{\A(?:http|ftp)://}i.freeze
50
+
51
+ def on_block(node)
52
+ match_property_in_resource?(RESOURCES, 'source', node) do |source|
53
+ source.arguments.each do |argument|
54
+ # remote_file also accepts an array of mirrors, any one of which may be insecure
55
+ urls = argument.array_type? ? argument.values : [argument]
56
+ urls.each { |url| add_offense(url, severity: :warning) if insecure_url?(url) }
57
+ end
58
+ end
59
+ end
60
+
61
+ private
62
+
63
+ # A dstr's leading literal is enough to read the scheme off an interpolated URL. Anything
64
+ # that isn't a literal string, such as a node attribute, tells us nothing and is left alone.
65
+ #
66
+ # @param [RuboCop::AST::Node] node
67
+ #
68
+ # @return [Boolean]
69
+ def insecure_url?(node)
70
+ literal = if node.str_type?
71
+ node.value
72
+ elsif node.dstr_type? && node.children.first&.str_type?
73
+ node.children.first.value
74
+ end
75
+
76
+ literal ? INSECURE_SCHEME.match?(literal) : false
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -29,6 +29,15 @@ module RuboCop
29
29
  # mode '600'
30
30
  # end
31
31
  #
32
+ # # good
33
+ # # fetch the key from a secrets management system instead
34
+ # file '/home/bob/.ssh/id_rsa' do
35
+ # content chef_vault_item('ssh_keys', 'bob')['private_key']
36
+ # mode '600'
37
+ # owner 'bob'
38
+ # sensitive true
39
+ # end
40
+ #
32
41
  class SshPrivateKey < Base
33
42
  MSG = 'Do not include plain text SSH private keys in your cookbook code. This sensitive data should be fetched from secrets management systems so that secrets are not uploaded in plain text to the Chef Infra Server or committed to source control systems.'
34
43
 
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+ #
3
+ # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+ module RuboCop
19
+ module Cop
20
+ module Chef
21
+ module Sharing
22
+ # Resource properties should not set an empty `description`. Automated documentation tools have
23
+ # nothing to render from it, so it does no more than a missing field would while looking like the
24
+ # property has been documented.
25
+ #
26
+ # @example
27
+ #
28
+ # # bad
29
+ # property :site_name, String,
30
+ # name_property: true,
31
+ # description: ''
32
+ #
33
+ # # good
34
+ # property :site_name, String,
35
+ # name_property: true,
36
+ # description: 'The name of the site'
37
+ #
38
+ class EmptyPropertyDescription < Base
39
+ MSG = 'Resource properties should not set an empty `description`. Either describe the property or leave the field off entirely.'
40
+ RESTRICT_ON_SEND = [:property].freeze
41
+
42
+ # any method named property being called with a symbol argument and an options hash.
43
+ # capturing the hash rather than searching the whole send keeps us off `description`
44
+ # keys nested inside another option's value, such as `default: { description: '' }`
45
+ def_node_matcher :property_options, '(send nil? :property (sym _) ... $hash)'
46
+
47
+ def on_send(node)
48
+ property_options(node) do |options|
49
+ options.pairs.each do |pair|
50
+ next unless pair.key.sym_type? && pair.key.value == :description
51
+ # a description built by interpolation isn't a literal str node, so we can't tell
52
+ # whether it's empty and leave it alone
53
+ next unless pair.value.str_type? && pair.value.value.strip.empty?
54
+ add_offense(pair, severity: :refactor)
55
+ end
56
+ end
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  #
3
3
  # Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
4
- # Author:: Tim Smith (<tsmith84@gmail.com>)
4
+ # Author:: Tim Smith (<tsmith84@proton.me>)
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.