chef 16.3.45-universal-mingw32 → 16.5.77-universal-mingw32

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 (424) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Rakefile +2 -2
  4. data/bin/knife +1 -1
  5. data/chef-universal-mingw32.gemspec +0 -1
  6. data/chef.gemspec +2 -1
  7. data/distro/templates/powershell/chef/chef.psm1.erb +18 -18
  8. data/ext/win32-eventlog/Rakefile +2 -2
  9. data/ext/win32-eventlog/chef-log.man.erb +4 -4
  10. data/lib/chef/action_collection.rb +4 -0
  11. data/lib/chef/api_client/registration.rb +2 -2
  12. data/lib/chef/application.rb +20 -18
  13. data/lib/chef/application/apply.rb +17 -12
  14. data/lib/chef/application/base.rb +26 -23
  15. data/lib/chef/application/client.rb +10 -4
  16. data/lib/chef/application/exit_code.rb +13 -4
  17. data/lib/chef/application/knife.rb +22 -11
  18. data/lib/chef/application/solo.rb +2 -1
  19. data/lib/chef/application/windows_service.rb +39 -39
  20. data/lib/chef/application/windows_service_manager.rb +6 -6
  21. data/lib/chef/chef_class.rb +0 -1
  22. data/lib/chef/chef_fs/chef_fs_data_store.rb +55 -55
  23. data/lib/chef/chef_fs/file_system/chef_server/acl_entry.rb +10 -10
  24. data/lib/chef/chef_fs/file_system/chef_server/organization_invites_entry.rb +8 -8
  25. data/lib/chef/chef_fs/file_system/chef_server/organization_members_entry.rb +8 -8
  26. data/lib/chef/chef_fs/file_system/repository/chef_repository_file_system_cookbook_dir.rb +2 -2
  27. data/lib/chef/chef_fs/file_system/repository/chef_repository_file_system_cookbook_entry.rb +2 -2
  28. data/lib/chef/chef_fs/file_system/repository/chef_repository_file_system_root_dir.rb +18 -18
  29. data/lib/chef/chef_fs/file_system/repository/directory.rb +1 -1
  30. data/lib/chef/chef_fs/file_system/repository/file_system_entry.rb +1 -1
  31. data/lib/chef/chef_fs/knife.rb +2 -2
  32. data/lib/chef/chef_fs/parallelizer.rb +0 -1
  33. data/lib/chef/client.rb +21 -22
  34. data/lib/chef/cookbook/cookbook_version_loader.rb +1 -1
  35. data/lib/chef/cookbook/gem_installer.rb +1 -1
  36. data/lib/chef/cookbook/synchronizer.rb +2 -2
  37. data/lib/chef/cookbook_site_streaming_uploader.rb +13 -11
  38. data/lib/chef/cookbook_uploader.rb +1 -1
  39. data/lib/chef/data_collector.rb +6 -5
  40. data/lib/chef/data_collector/config_validation.rb +22 -13
  41. data/lib/chef/data_collector/run_end_message.rb +13 -3
  42. data/lib/chef/data_collector/run_start_message.rb +1 -1
  43. data/lib/chef/deprecated.rb +1 -1
  44. data/lib/chef/deprecation/warnings.rb +2 -2
  45. data/lib/chef/digester.rb +2 -2
  46. data/lib/chef/dsl/chef_vault.rb +1 -1
  47. data/lib/chef/dsl/data_query.rb +2 -2
  48. data/lib/chef/dsl/platform_introspection.rb +9 -9
  49. data/lib/chef/encrypted_data_bag_item.rb +3 -4
  50. data/lib/chef/encrypted_data_bag_item/decryptor.rb +3 -3
  51. data/lib/chef/encrypted_data_bag_item/encryptor.rb +3 -3
  52. data/lib/chef/environment.rb +4 -4
  53. data/lib/chef/event_loggers/windows_eventlog.rb +2 -2
  54. data/lib/chef/exceptions.rb +5 -5
  55. data/lib/chef/file_access_control/windows.rb +5 -1
  56. data/lib/chef/file_content_management/tempfile.rb +10 -10
  57. data/lib/chef/formatters/doc.rb +7 -6
  58. data/lib/chef/formatters/error_inspectors/api_error_formatting.rb +6 -5
  59. data/lib/chef/formatters/error_inspectors/node_load_error_inspector.rb +3 -3
  60. data/lib/chef/formatters/error_inspectors/registration_error_inspector.rb +9 -9
  61. data/lib/chef/formatters/error_inspectors/resource_failure_inspector.rb +2 -2
  62. data/lib/chef/formatters/error_inspectors/run_list_expansion_error_inspector.rb +3 -3
  63. data/lib/chef/formatters/indentable_output_stream.rb +2 -2
  64. data/lib/chef/formatters/minimal.rb +5 -4
  65. data/lib/chef/http.rb +6 -3
  66. data/lib/chef/http/auth_credentials.rb +5 -1
  67. data/lib/chef/http/authenticator.rb +1 -1
  68. data/lib/chef/http/basic_client.rb +4 -2
  69. data/lib/chef/http/decompressor.rb +1 -1
  70. data/lib/chef/http/http_request.rb +7 -5
  71. data/lib/chef/http/socketless_chef_zero_client.rb +5 -2
  72. data/lib/chef/http/ssl_policies.rb +1 -1
  73. data/lib/chef/json_compat.rb +2 -2
  74. data/lib/chef/knife.rb +4 -4
  75. data/lib/chef/knife/bootstrap.rb +18 -16
  76. data/lib/chef/knife/bootstrap/chef_vault_handler.rb +1 -1
  77. data/lib/chef/knife/bootstrap/templates/chef-full.erb +3 -3
  78. data/lib/chef/knife/bootstrap/templates/windows-chef-client-msi.erb +7 -7
  79. data/lib/chef/knife/client_create.rb +3 -3
  80. data/lib/chef/knife/config_get.rb +8 -97
  81. data/lib/chef/knife/config_get_profile.rb +9 -9
  82. data/lib/chef/knife/config_list.rb +139 -0
  83. data/lib/chef/knife/config_list_profiles.rb +8 -98
  84. data/lib/chef/knife/config_show.rb +127 -0
  85. data/lib/chef/knife/config_use.rb +61 -0
  86. data/lib/chef/knife/config_use_profile.rb +9 -24
  87. data/lib/chef/knife/configure.rb +4 -2
  88. data/lib/chef/knife/cookbook_download.rb +1 -1
  89. data/lib/chef/knife/cookbook_metadata.rb +1 -1
  90. data/lib/chef/knife/cookbook_upload.rb +23 -23
  91. data/lib/chef/knife/core/bootstrap_context.rb +2 -2
  92. data/lib/chef/knife/core/generic_presenter.rb +1 -1
  93. data/lib/chef/knife/core/hashed_command_loader.rb +2 -2
  94. data/lib/chef/knife/core/object_loader.rb +1 -1
  95. data/lib/chef/knife/core/ui.rb +1 -1
  96. data/lib/chef/knife/core/windows_bootstrap_context.rb +42 -34
  97. data/lib/chef/knife/delete.rb +15 -15
  98. data/lib/chef/knife/exec.rb +4 -4
  99. data/lib/chef/knife/node_policy_set.rb +2 -2
  100. data/lib/chef/knife/node_run_list_add.rb +1 -1
  101. data/lib/chef/knife/node_run_list_remove.rb +1 -1
  102. data/lib/chef/knife/node_run_list_set.rb +1 -1
  103. data/lib/chef/knife/node_show.rb +2 -2
  104. data/lib/chef/knife/role_env_run_list_add.rb +1 -1
  105. data/lib/chef/knife/role_env_run_list_set.rb +1 -1
  106. data/lib/chef/knife/role_run_list_add.rb +1 -1
  107. data/lib/chef/knife/role_run_list_set.rb +1 -1
  108. data/lib/chef/knife/search.rb +0 -1
  109. data/lib/chef/knife/serve.rb +3 -3
  110. data/lib/chef/knife/ssh.rb +24 -9
  111. data/lib/chef/knife/ssl_check.rb +3 -3
  112. data/lib/chef/knife/status.rb +2 -2
  113. data/lib/chef/knife/tag_create.rb +1 -1
  114. data/lib/chef/knife/tag_delete.rb +1 -1
  115. data/lib/chef/knife/user_create.rb +2 -2
  116. data/lib/chef/knife/xargs.rb +19 -19
  117. data/lib/chef/knife/yaml_convert.rb +1 -1
  118. data/lib/chef/local_mode.rb +2 -2
  119. data/lib/chef/log/syslog.rb +2 -2
  120. data/lib/chef/log/winevt.rb +2 -2
  121. data/lib/chef/mixin/checksum.rb +0 -1
  122. data/lib/chef/mixin/deep_merge.rb +35 -18
  123. data/lib/chef/mixin/openssl_helper.rb +4 -5
  124. data/lib/chef/mixin/shell_out.rb +1 -1
  125. data/lib/chef/mixin/template.rb +3 -3
  126. data/lib/chef/mixin/uris.rb +4 -2
  127. data/lib/chef/mixin/versioned_api.rb +1 -2
  128. data/lib/chef/mixin/which.rb +1 -1
  129. data/lib/chef/monkey_patches/net_http.rb +4 -4
  130. data/lib/chef/monkey_patches/webrick-utils.rb +10 -10
  131. data/lib/chef/node/attribute.rb +2 -4
  132. data/lib/chef/node_map.rb +4 -4
  133. data/lib/chef/platform/service_helpers.rb +1 -1
  134. data/lib/chef/policy_builder/dynamic.rb +2 -0
  135. data/lib/chef/policy_builder/policyfile.rb +2 -2
  136. data/lib/chef/property.rb +1 -1
  137. data/lib/chef/provider.rb +1 -5
  138. data/lib/chef/provider/cron/unix.rb +0 -2
  139. data/lib/chef/provider/file.rb +2 -2
  140. data/lib/chef/provider/git.rb +5 -5
  141. data/lib/chef/provider/group.rb +0 -2
  142. data/lib/chef/provider/group/suse.rb +5 -5
  143. data/lib/chef/provider/ifconfig.rb +1 -4
  144. data/lib/chef/provider/launchd.rb +2 -2
  145. data/lib/chef/provider/link.rb +0 -9
  146. data/lib/chef/provider/mount.rb +0 -2
  147. data/lib/chef/provider/mount/linux.rb +63 -0
  148. data/lib/chef/provider/package.rb +0 -2
  149. data/lib/chef/provider/package/dpkg.rb +3 -12
  150. data/lib/chef/provider/package/homebrew.rb +1 -1
  151. data/lib/chef/provider/package/rubygems.rb +22 -19
  152. data/lib/chef/provider/package/snap.rb +1 -2
  153. data/lib/chef/provider/package/windows.rb +2 -2
  154. data/lib/chef/provider/package/windows/registry_uninstall_entry.rb +12 -10
  155. data/lib/chef/provider/package/zypper.rb +1 -1
  156. data/lib/chef/provider/powershell_script.rb +21 -5
  157. data/lib/chef/provider/remote_file/content.rb +3 -0
  158. data/lib/chef/provider/remote_file/ftp.rb +6 -4
  159. data/lib/chef/provider/remote_file/sftp.rb +6 -4
  160. data/lib/chef/provider/route.rb +2 -6
  161. data/lib/chef/provider/service/arch.rb +1 -1
  162. data/lib/chef/provider/service/debian.rb +1 -1
  163. data/lib/chef/provider/service/gentoo.rb +2 -2
  164. data/lib/chef/provider/service/macosx.rb +4 -4
  165. data/lib/chef/provider/service/openbsd.rb +1 -4
  166. data/lib/chef/provider/service/redhat.rb +3 -3
  167. data/lib/chef/provider/service/upstart.rb +1 -1
  168. data/lib/chef/provider/service/windows.rb +10 -10
  169. data/lib/chef/provider/systemd_unit.rb +0 -2
  170. data/lib/chef/provider/template/content.rb +1 -0
  171. data/lib/chef/provider/template_finder.rb +2 -10
  172. data/lib/chef/provider/user/dscl.rb +7 -7
  173. data/lib/chef/provider/user/mac.rb +12 -12
  174. data/lib/chef/provider/windows_task.rb +1 -5
  175. data/lib/chef/provider/zypper_repository.rb +2 -3
  176. data/lib/chef/provider_resolver.rb +1 -1
  177. data/lib/chef/providers.rb +1 -1
  178. data/lib/chef/recipe.rb +2 -2
  179. data/lib/chef/resource.rb +8 -12
  180. data/lib/chef/resource/apt_repository.rb +5 -12
  181. data/lib/chef/resource/bff_package.rb +22 -0
  182. data/lib/chef/resource/breakpoint.rb +57 -2
  183. data/lib/chef/resource/build_essential.rb +1 -1
  184. data/lib/chef/resource/cab_package.rb +29 -0
  185. data/lib/chef/resource/chef_client_cron.rb +32 -25
  186. data/lib/chef/resource/chef_client_launchd.rb +194 -0
  187. data/lib/chef/resource/chef_client_scheduled_task.rb +21 -18
  188. data/lib/chef/resource/chef_client_systemd_timer.rb +26 -19
  189. data/lib/chef/resource/chef_client_trusted_certificate.rb +101 -0
  190. data/lib/chef/resource/chef_gem.rb +10 -10
  191. data/lib/chef/resource/chef_handler.rb +149 -4
  192. data/lib/chef/resource/chef_sleep.rb +2 -2
  193. data/lib/chef/resource/chef_vault_secret.rb +14 -14
  194. data/lib/chef/resource/cookbook_file.rb +2 -2
  195. data/lib/chef/resource/cron/_cron_shared.rb +1 -0
  196. data/lib/chef/resource/cron/cron_d.rb +0 -1
  197. data/lib/chef/resource/dnf_package.rb +2 -2
  198. data/lib/chef/resource/dsc_resource.rb +0 -1
  199. data/lib/chef/resource/dsc_script.rb +2 -2
  200. data/lib/chef/resource/execute.rb +8 -9
  201. data/lib/chef/resource/file.rb +4 -4
  202. data/lib/chef/resource/gem_package.rb +5 -5
  203. data/lib/chef/resource/homebrew_package.rb +3 -3
  204. data/lib/chef/resource/homebrew_update.rb +7 -7
  205. data/lib/chef/resource/hostname.rb +2 -2
  206. data/lib/chef/resource/launchd.rb +2 -1
  207. data/lib/chef/resource/locale.rb +2 -2
  208. data/lib/chef/resource/macos_userdefaults.rb +3 -3
  209. data/lib/chef/resource/notify_group.rb +0 -1
  210. data/lib/chef/resource/ohai.rb +46 -3
  211. data/lib/chef/resource/ohai_hint.rb +33 -0
  212. data/lib/chef/resource/openssl_dhparam.rb +29 -5
  213. data/lib/chef/resource/openssl_ec_private_key.rb +8 -3
  214. data/lib/chef/resource/openssl_ec_public_key.rb +4 -2
  215. data/lib/chef/resource/openssl_rsa_private_key.rb +8 -3
  216. data/lib/chef/resource/openssl_rsa_public_key.rb +2 -0
  217. data/lib/chef/resource/openssl_x509_certificate.rb +38 -35
  218. data/lib/chef/resource/openssl_x509_crl.rb +21 -10
  219. data/lib/chef/resource/openssl_x509_request.rb +37 -36
  220. data/lib/chef/resource/osx_profile.rb +292 -6
  221. data/lib/chef/resource/plist.rb +1 -1
  222. data/lib/chef/resource/powershell_package_source.rb +6 -6
  223. data/lib/chef/resource/powershell_script.rb +24 -30
  224. data/lib/chef/resource/reboot.rb +2 -2
  225. data/lib/chef/resource/remote_file.rb +3 -3
  226. data/lib/chef/resource/rhsm_register.rb +22 -10
  227. data/lib/chef/resource/ruby_block.rb +2 -2
  228. data/lib/chef/resource/scm/subversion.rb +2 -2
  229. data/lib/chef/resource/service.rb +3 -3
  230. data/lib/chef/resource/ssh_known_hosts_entry.rb +2 -2
  231. data/lib/chef/resource/sudo.rb +1 -1
  232. data/lib/chef/resource/support/cron.d.erb +1 -1
  233. data/lib/chef/resource/support/cron_access.erb +1 -1
  234. data/lib/chef/resource/support/sudoer.erb +1 -1
  235. data/lib/chef/resource/support/ulimit.erb +1 -1
  236. data/lib/chef/resource/sysctl.rb +6 -10
  237. data/lib/chef/resource/systemd_unit.rb +2 -2
  238. data/lib/chef/resource/template.rb +2 -2
  239. data/lib/chef/resource/timezone.rb +112 -73
  240. data/lib/chef/resource/windows_ad_join.rb +12 -3
  241. data/lib/chef/resource/windows_audit_policy.rb +3 -0
  242. data/lib/chef/resource/windows_auto_run.rb +2 -0
  243. data/lib/chef/resource/windows_certificate.rb +8 -4
  244. data/lib/chef/resource/windows_dfs_folder.rb +2 -0
  245. data/lib/chef/resource/windows_dfs_namespace.rb +2 -0
  246. data/lib/chef/resource/windows_dfs_server.rb +2 -0
  247. data/lib/chef/resource/windows_dns_record.rb +10 -7
  248. data/lib/chef/resource/windows_dns_zone.rb +12 -7
  249. data/lib/chef/resource/windows_feature.rb +2 -0
  250. data/lib/chef/resource/windows_feature_dism.rb +10 -0
  251. data/lib/chef/resource/windows_feature_powershell.rb +14 -2
  252. data/lib/chef/resource/windows_firewall_profile.rb +24 -20
  253. data/lib/chef/resource/windows_firewall_rule.rb +5 -3
  254. data/lib/chef/resource/windows_font.rb +3 -1
  255. data/lib/chef/resource/windows_package.rb +28 -5
  256. data/lib/chef/resource/windows_pagefile.rb +4 -0
  257. data/lib/chef/resource/windows_printer.rb +22 -21
  258. data/lib/chef/resource/windows_printer_port.rb +20 -17
  259. data/lib/chef/resource/windows_security_policy.rb +2 -0
  260. data/lib/chef/resource/windows_share.rb +5 -3
  261. data/lib/chef/resource/windows_shortcut.rb +2 -0
  262. data/lib/chef/resource/windows_uac.rb +2 -0
  263. data/lib/chef/resource/windows_user_privilege.rb +54 -53
  264. data/lib/chef/resource/windows_workgroup.rb +5 -6
  265. data/lib/chef/resource/yum_package.rb +2 -2
  266. data/lib/chef/resource_collection/stepable_iterator.rb +1 -2
  267. data/lib/chef/resource_reporter.rb +0 -2
  268. data/lib/chef/resources.rb +3 -1
  269. data/lib/chef/role.rb +2 -2
  270. data/lib/chef/run_context.rb +2 -2
  271. data/lib/chef/run_context/cookbook_compiler.rb +21 -21
  272. data/lib/chef/run_lock.rb +2 -2
  273. data/lib/chef/run_status.rb +2 -6
  274. data/lib/chef/search/query.rb +6 -5
  275. data/lib/chef/shell.rb +32 -27
  276. data/lib/chef/shell/ext.rb +11 -11
  277. data/lib/chef/shell/shell_session.rb +2 -2
  278. data/lib/chef/train_transport.rb +5 -104
  279. data/lib/chef/util/backup.rb +2 -2
  280. data/lib/chef/util/diff.rb +14 -14
  281. data/lib/chef/util/powershell/cmdlet.rb +4 -2
  282. data/lib/chef/util/powershell/ps_credential.rb +18 -14
  283. data/lib/chef/util/threaded_job_queue.rb +0 -2
  284. data/lib/chef/version.rb +1 -1
  285. data/lib/chef/win32/crypto.rb +1 -1
  286. data/lib/chef/win32/file.rb +3 -3
  287. data/lib/chef/win32/file/version_info.rb +5 -5
  288. data/lib/chef/win32/registry.rb +1 -2
  289. data/lib/chef/win32/unicode.rb +1 -1
  290. data/spec/data/shef-config.rb +1 -1
  291. data/spec/data/ssl/chef-rspec.cert +15 -15
  292. data/spec/functional/event_loggers/windows_eventlog_spec.rb +6 -5
  293. data/spec/functional/resource/aix_service_spec.rb +2 -2
  294. data/spec/functional/resource/aixinit_service_spec.rb +8 -8
  295. data/spec/functional/resource/bff_spec.rb +2 -2
  296. data/spec/functional/resource/cookbook_file_spec.rb +1 -1
  297. data/spec/functional/resource/dsc_resource_spec.rb +1 -1
  298. data/spec/functional/resource/dsc_script_spec.rb +0 -1
  299. data/spec/functional/resource/group_spec.rb +6 -6
  300. data/spec/functional/resource/insserv_spec.rb +5 -5
  301. data/spec/functional/resource/link_spec.rb +20 -20
  302. data/spec/functional/resource/powershell_script_spec.rb +4 -4
  303. data/spec/functional/resource/rpm_spec.rb +2 -2
  304. data/spec/functional/resource/user/dscl_spec.rb +1 -1
  305. data/spec/functional/resource/user/mac_user_spec.rb +1 -1
  306. data/spec/functional/resource/windows_certificate_spec.rb +3 -3
  307. data/spec/functional/resource/windows_font_spec.rb +49 -0
  308. data/spec/functional/resource/windows_security_policy_spec.rb +0 -3
  309. data/spec/functional/resource/windows_task_spec.rb +13 -13
  310. data/spec/functional/run_lock_spec.rb +24 -24
  311. data/spec/functional/version_spec.rb +3 -3
  312. data/spec/functional/win32/registry_spec.rb +8 -8
  313. data/spec/functional/win32/service_manager_spec.rb +1 -1
  314. data/spec/integration/client/client_spec.rb +4 -4
  315. data/spec/integration/client/exit_code_spec.rb +3 -2
  316. data/spec/integration/client/ipv6_spec.rb +1 -1
  317. data/spec/integration/knife/common_options_spec.rb +12 -12
  318. data/spec/integration/knife/config_list_spec.rb +220 -0
  319. data/spec/integration/knife/config_show_spec.rb +192 -0
  320. data/spec/integration/knife/config_use_spec.rb +198 -0
  321. data/spec/integration/knife/cookbook_api_ipv6_spec.rb +1 -1
  322. data/spec/integration/knife/diff_spec.rb +3 -1
  323. data/spec/integration/knife/download_spec.rb +3 -1
  324. data/spec/integration/knife/serve_spec.rb +5 -5
  325. data/spec/integration/knife/upload_spec.rb +3 -1
  326. data/spec/integration/ohai/ohai_spec.rb +61 -0
  327. data/spec/integration/recipes/lwrp_inline_resources_spec.rb +1 -1
  328. data/spec/integration/recipes/remote_directory.rb +1 -1
  329. data/spec/integration/solo/solo_spec.rb +5 -5
  330. data/spec/spec_helper.rb +12 -11
  331. data/spec/stress/win32/file_spec.rb +1 -1
  332. data/spec/support/chef_helpers.rb +2 -2
  333. data/spec/support/matchers/leak.rb +2 -2
  334. data/spec/support/platform_helpers.rb +17 -35
  335. data/spec/support/platforms/win32/spec_service.rb +1 -1
  336. data/spec/support/shared/functional/directory_resource.rb +1 -1
  337. data/spec/support/shared/functional/execute_resource.rb +1 -1
  338. data/spec/support/shared/functional/file_resource.rb +20 -20
  339. data/spec/support/shared/functional/securable_resource.rb +108 -27
  340. data/spec/support/shared/functional/win32_service.rb +2 -2
  341. data/spec/support/shared/functional/windows_script.rb +3 -3
  342. data/spec/support/shared/integration/integration_helper.rb +22 -52
  343. data/spec/support/shared/unit/application_dot_d.rb +5 -3
  344. data/spec/support/shared/unit/script_resource.rb +6 -20
  345. data/spec/support/shared/unit/windows_script_resource.rb +15 -28
  346. data/spec/tiny_server.rb +0 -1
  347. data/spec/unit/application/client_spec.rb +2 -2
  348. data/spec/unit/application/exit_code_spec.rb +10 -0
  349. data/spec/unit/application_spec.rb +4 -6
  350. data/spec/unit/chef_fs/config_spec.rb +1 -1
  351. data/spec/unit/chef_fs/data_handler/data_bag_item_data_handler.rb +1 -1
  352. data/spec/unit/chef_fs/parallelizer_spec.rb +5 -1
  353. data/spec/unit/chef_fs/path_util_spec.rb +1 -1
  354. data/spec/unit/cookbook/synchronizer_spec.rb +2 -2
  355. data/spec/unit/cookbook_spec.rb +2 -2
  356. data/spec/unit/data_collector/config_validation_spec.rb +208 -0
  357. data/spec/unit/data_collector_spec.rb +28 -117
  358. data/spec/unit/dsl/declare_resource_spec.rb +1 -1
  359. data/spec/unit/environment_spec.rb +7 -7
  360. data/spec/unit/file_access_control_spec.rb +1 -1
  361. data/spec/unit/knife/bootstrap_spec.rb +20 -20
  362. data/spec/unit/knife/cookbook_download_spec.rb +4 -4
  363. data/spec/unit/knife/cookbook_metadata_from_file_spec.rb +1 -1
  364. data/spec/unit/knife/core/hashed_command_loader_spec.rb +3 -3
  365. data/spec/unit/knife/core/ui_spec.rb +1 -0
  366. data/spec/unit/knife/core/windows_bootstrap_context_spec.rb +21 -12
  367. data/spec/unit/knife/ssh_spec.rb +2 -2
  368. data/spec/unit/knife/supermarket_share_spec.rb +1 -1
  369. data/spec/unit/lwrp_spec.rb +3 -3
  370. data/spec/unit/mixin/deep_merge_spec.rb +15 -0
  371. data/spec/unit/mixin/openssl_helper_spec.rb +1 -1
  372. data/spec/unit/mixin/powershell_exec_spec.rb +1 -1
  373. data/spec/unit/mixin/securable_spec.rb +2 -2
  374. data/spec/unit/mixin/template_spec.rb +30 -30
  375. data/spec/unit/mixin/windows_architecture_helper_spec.rb +4 -4
  376. data/spec/unit/node/immutable_collections_spec.rb +8 -4
  377. data/spec/unit/node_spec.rb +5 -5
  378. data/spec/unit/provider/mount/linux_spec.rb +97 -0
  379. data/spec/unit/provider/package/chocolatey_spec.rb +1 -1
  380. data/spec/unit/provider/package/powershell_spec.rb +1 -1
  381. data/spec/unit/provider/package/rubygems_spec.rb +4 -1
  382. data/spec/unit/provider/powershell_script_spec.rb +11 -4
  383. data/spec/unit/provider/remote_directory_spec.rb +9 -9
  384. data/spec/unit/provider/route_spec.rb +0 -2
  385. data/spec/unit/provider/service/arch_service_spec.rb +3 -2
  386. data/spec/unit/provider/service/debian_service_spec.rb +1 -1
  387. data/spec/unit/provider/service/gentoo_service_spec.rb +7 -7
  388. data/spec/unit/provider/service/macosx_spec.rb +3 -3
  389. data/spec/unit/provider/service/redhat_spec.rb +2 -2
  390. data/spec/unit/provider/service/upstart_service_spec.rb +3 -3
  391. data/spec/unit/provider_resolver_spec.rb +6 -6
  392. data/spec/unit/recipe_spec.rb +1 -1
  393. data/spec/unit/resource/batch_spec.rb +6 -6
  394. data/spec/unit/resource/chef_client_cron_spec.rb +35 -14
  395. data/spec/unit/resource/chef_client_launchd_spec.rb +127 -0
  396. data/spec/unit/resource/chef_client_systemd_timer_spec.rb +36 -1
  397. data/spec/unit/resource/chef_client_trusted_certificate_spec.rb +54 -0
  398. data/spec/unit/resource/execute_spec.rb +113 -118
  399. data/spec/unit/resource/launchd_spec.rb +8 -0
  400. data/spec/unit/resource/osx_profile_spec.rb +299 -0
  401. data/spec/unit/resource/powershell_script_spec.rb +11 -29
  402. data/spec/unit/resource/rhsm_register_spec.rb +56 -18
  403. data/spec/unit/resource/script_spec.rb +6 -1
  404. data/spec/unit/resource/timezone_spec.rb +63 -0
  405. data/spec/unit/resource/windows_feature_powershell_spec.rb +30 -4
  406. data/spec/unit/resource/windows_uac_spec.rb +1 -1
  407. data/spec/unit/resource/windows_user_privilege_spec.rb +55 -0
  408. data/spec/unit/role_spec.rb +11 -11
  409. data/spec/unit/run_lock_spec.rb +5 -1
  410. data/spec/unit/runner_spec.rb +1 -2
  411. data/spec/unit/shell/shell_ext_spec.rb +46 -3
  412. data/spec/unit/shell/shell_session_spec.rb +35 -64
  413. data/spec/unit/shell_spec.rb +16 -19
  414. data/spec/unit/train_transport_spec.rb +14 -13
  415. data/spec/unit/util/selinux_spec.rb +2 -0
  416. data/tasks/rspec.rb +1 -3
  417. metadata +42 -33
  418. data/lib/chef/dist.rb +0 -68
  419. data/lib/chef/provider/osx_profile.rb +0 -255
  420. data/spec/integration/knife/config_get_profile_spec.rb +0 -113
  421. data/spec/integration/knife/config_get_spec.rb +0 -191
  422. data/spec/integration/knife/config_list_profiles_spec.rb +0 -218
  423. data/spec/integration/knife/config_use_profile_spec.rb +0 -154
  424. data/spec/unit/provider/osx_profile_spec.rb +0 -255
@@ -19,8 +19,6 @@
19
19
  #
20
20
 
21
21
  require_relative "exceptions"
22
- require_relative "dsl/data_query"
23
- require_relative "dsl/registry_helper"
24
22
  require_relative "dsl/reboot_pending"
25
23
  require_relative "dsl/resources"
26
24
  require_relative "dsl/declare_resource"
@@ -38,7 +36,7 @@ require_relative "resource/resource_notification"
38
36
  require_relative "provider_resolver"
39
37
  require_relative "resource_resolver"
40
38
  require_relative "provider"
41
- require "set" unless defined?(Set)
39
+ autoload :Set, "set"
42
40
 
43
41
  require_relative "mixin/deprecation"
44
42
  require_relative "mixin/properties"
@@ -53,8 +51,6 @@ class Chef
53
51
  #
54
52
 
55
53
  include Chef::DSL::DeclareResource
56
- include Chef::DSL::DataQuery
57
- include Chef::DSL::RegistryHelper
58
54
  include Chef::DSL::RebootPending
59
55
  extend Chef::Mixin::Provides
60
56
 
@@ -663,17 +659,17 @@ class Chef
663
659
 
664
660
  all_props = {}
665
661
  self.class.state_properties.map do |p|
666
- begin
667
- all_props[p.name.to_s] = p.sensitive? ? '"*sensitive value suppressed*"' : value_to_text(p.get(self))
668
- rescue Chef::Exceptions::ValidationFailed
669
- # This space left intentionally blank, the property was probably required or had an invalid default.
670
- end
662
+
663
+ all_props[p.name.to_s] = p.sensitive? ? '"*sensitive value suppressed*"' : value_to_text(p.get(self))
664
+ rescue Chef::Exceptions::ValidationFailed
665
+ # This space left intentionally blank, the property was probably required or had an invalid default.
666
+
671
667
  end
672
668
 
673
669
  ivars = instance_variables.map(&:to_sym) - HIDDEN_IVARS
674
670
  ivars.each do |ivar|
675
671
  iv = ivar.to_s.sub(/^@/, "")
676
- if all_props.keys.include?(iv)
672
+ if all_props.key?(iv)
677
673
  text << " #{iv} #{all_props[iv]}\n"
678
674
  elsif (value = instance_variable_get(ivar)) && !(value.respond_to?(:empty?) && value.empty?)
679
675
  text << " #{iv} #{value_to_text(value)}\n"
@@ -1484,7 +1480,7 @@ class Chef
1484
1480
  def self.use(partial)
1485
1481
  dirname = ::File.dirname(partial)
1486
1482
  basename = ::File.basename(partial, ".rb")
1487
- basename = basename[1..-1] if basename.start_with?("_")
1483
+ basename = basename[1..] if basename.start_with?("_")
1488
1484
  class_eval IO.read(::File.expand_path("#{dirname}/_#{basename}.rb", ::File.dirname(caller_locations.first.absolute_path)))
1489
1485
  end
1490
1486
 
@@ -19,7 +19,9 @@
19
19
  require_relative "../resource"
20
20
  require_relative "../http/simple"
21
21
  require "tmpdir" unless defined?(Dir.mktmpdir)
22
- require "addressable" unless defined?(Addressable)
22
+ module Addressable
23
+ autoload :URI, "addressable/uri"
24
+ end
23
25
 
24
26
  class Chef
25
27
  class Resource
@@ -168,7 +170,7 @@ class Chef
168
170
  # is the provided ID a key ID from a keyserver. Looks at length and HEX only values
169
171
  # @param [String] id the key value passed by the user that *may* be an ID
170
172
  def is_key_id?(id)
171
- id = id[2..-1] if id.start_with?("0x")
173
+ id = id[2..] if id.start_with?("0x")
172
174
  id =~ /^\h+$/ && [8, 16, 40].include?(id.length)
173
175
  end
174
176
 
@@ -192,16 +194,7 @@ class Chef
192
194
  #
193
195
  # @return [Boolean] is the key valid or not
194
196
  def key_is_valid?(key)
195
- valid = true
196
-
197
- so = shell_out("apt-key", "list")
198
- so.stdout.split(/\n/).map do |t|
199
- if t =~ %r{^\/#{key}.*\[expired: .*\]$}
200
- logger.debug "Found expired key: #{t}"
201
- valid = false
202
- break
203
- end
204
- end
197
+ valid = shell_out("apt-key", "list").stdout.each_line.none?(%r{^\/#{key}.*\[expired: .*\]$})
205
198
 
206
199
  logger.debug "key #{key} #{valid ? "is valid" : "is not valid"}"
207
200
  valid
@@ -17,6 +17,7 @@
17
17
  #
18
18
 
19
19
  require_relative "package"
20
+ require "chef-utils/dist" unless defined?(ChefUtils::Dist)
20
21
 
21
22
  class Chef
22
23
  class Resource
@@ -27,6 +28,27 @@ class Chef
27
28
 
28
29
  description "Use the **bff_package** resource to manage packages for the AIX platform using the installp utility. When a package is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources."
29
30
  introduced "12.0"
31
+ examples <<~DOC
32
+ The **bff_package** resource is the default package provider on the AIX platform. The base **package** resource may be used, and then when the platform is AIX, #{ChefUtils::Dist::Infra::PRODUCT} will identify the correct package provider. The following examples show how to install part of the IBM XL C/C++ compiler.
33
+
34
+ **Installing using the base package resource**
35
+
36
+ ```ruby
37
+ package 'xlccmp.13.1.0' do
38
+ source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
39
+ action :install
40
+ end
41
+ ```
42
+
43
+ **Installing using the bff_package resource**
44
+
45
+ ```ruby
46
+ bff_package 'xlccmp.13.1.0' do
47
+ source '/var/tmp/IBM_XL_C_13.1.0/usr/sys/inst.images/xlccmp.13.1.0'
48
+ action :install
49
+ end
50
+ ```
51
+ DOC
30
52
 
31
53
  property :package_name, String,
32
54
  description: "An optional property to set the package name if it differs from the resource block's name.",
@@ -17,7 +17,7 @@
17
17
  #
18
18
 
19
19
  require_relative "../resource"
20
- require_relative "../dist"
20
+ require "chef-utils/dist" unless defined?(ChefUtils::Dist)
21
21
 
22
22
  class Chef
23
23
  class Resource
@@ -26,8 +26,63 @@ class Chef
26
26
 
27
27
  provides :breakpoint, target_mode: true
28
28
 
29
- description "Use the **breakpoint** resource to add breakpoints to recipes. Run the #{Chef::Dist::SHELL} in #{Chef::Dist::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{Chef::Dist::CLIENT} during an actual #{Chef::Dist::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
29
+ description "Use the **breakpoint** resource to add breakpoints to recipes. Run the #{ChefUtils::Dist::Infra::SHELL} in #{ChefUtils::Dist::Infra::PRODUCT} mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the #{ChefUtils::Dist::Infra::CLIENT} during an actual #{ChefUtils::Dist::Infra::CLIENT} run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server."
30
30
  introduced "12.0"
31
+ examples <<~DOC
32
+ **A recipe without a breakpoint**
33
+
34
+ ```ruby
35
+ yum_key node['yum']['elrepo']['key'] do
36
+ url node['yum']['elrepo']['key_url']
37
+ action :add
38
+ end
39
+
40
+ yum_repository 'elrepo' do
41
+ description 'ELRepo.org Community Enterprise Linux Extras Repository'
42
+ key node['yum']['elrepo']['key']
43
+ mirrorlist node['yum']['elrepo']['url']
44
+ includepkgs node['yum']['elrepo']['includepkgs']
45
+ exclude node['yum']['elrepo']['exclude']
46
+ action :create
47
+ end
48
+ ```
49
+
50
+ **The same recipe with breakpoints**
51
+
52
+ ```ruby
53
+ breakpoint "before yum_key node['yum']['repo_name']['key']" do
54
+ action :break
55
+ end
56
+
57
+ yum_key node['yum']['repo_name']['key'] do
58
+ url node['yum']['repo_name']['key_url']
59
+ action :add
60
+ end
61
+
62
+ breakpoint "after yum_key node['yum']['repo_name']['key']" do
63
+ action :break
64
+ end
65
+
66
+ breakpoint "before yum_repository 'repo_name'" do
67
+ action :break
68
+ end
69
+
70
+ yum_repository 'repo_name' do
71
+ description 'description'
72
+ key node['yum']['repo_name']['key']
73
+ mirrorlist node['yum']['repo_name']['url']
74
+ includepkgs node['yum']['repo_name']['includepkgs']
75
+ exclude node['yum']['repo_name']['exclude']
76
+ action :create
77
+ end
78
+
79
+ breakpoint "after yum_repository 'repo_name'" do
80
+ action :break
81
+ end
82
+ ```
83
+
84
+ where the name of each breakpoint is an arbitrary string. In the previous examples, the names are used to indicate if the breakpoint is before or after a resource, and then also to specify which resource.
85
+ DOC
31
86
 
32
87
  default_action :break
33
88
 
@@ -15,7 +15,7 @@
15
15
  #
16
16
 
17
17
  require_relative "../resource"
18
- require "plist"
18
+ autoload :Plist, "plist"
19
19
 
20
20
  class Chef
21
21
  class Resource
@@ -29,6 +29,35 @@ class Chef
29
29
 
30
30
  description "Use the **cab_package** resource to install or remove Microsoft Windows cabinet (.cab) packages."
31
31
  introduced "12.15"
32
+ examples <<~'DOC'
33
+ **Using local path in source**
34
+
35
+ ```ruby
36
+ cab_package 'Install .NET 3.5 sp1 via KB958488' do
37
+ source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
38
+ action :install
39
+ end
40
+
41
+ cab_package 'Remove .NET 3.5 sp1 via KB958488' do
42
+ source 'C:\Users\xyz\AppData\Local\Temp\Windows6.1-KB958488-x64.cab'
43
+ action :remove
44
+ end
45
+ ```
46
+
47
+ **Using URL in source**
48
+
49
+ ```ruby
50
+ cab_package 'Install .NET 3.5 sp1 via KB958488' do
51
+ source 'https://s3.amazonaws.com/my_bucket/Windows6.1-KB958488-x64.cab'
52
+ action :install
53
+ end
54
+
55
+ cab_package 'Remove .NET 3.5 sp1 via KB958488' do
56
+ source 'https://s3.amazonaws.com/my_bucket/Temp\Windows6.1-KB958488-x64.cab'
57
+ action :remove
58
+ end
59
+ ```
60
+ DOC
32
61
 
33
62
  allowed_actions :install, :remove
34
63
 
@@ -15,9 +15,9 @@
15
15
  #
16
16
 
17
17
  require_relative "../resource"
18
- require_relative "../dist"
18
+ require "chef-utils/dist" unless defined?(ChefUtils::Dist)
19
19
  require_relative "helpers/cron_validations"
20
- require "digest/md5"
20
+ require "digest/md5" unless defined?(Digest::MD5)
21
21
 
22
22
  class Chef
23
23
  class Resource
@@ -26,25 +26,25 @@ class Chef
26
26
 
27
27
  provides :chef_client_cron
28
28
 
29
- description "Use the **chef_client_cron** resource to setup the #{Chef::Dist::PRODUCT} to run as a cron job. This resource will also create the specified log directory if it doesn't already exist."
29
+ description "Use the **chef_client_cron** resource to setup the #{ChefUtils::Dist::Infra::PRODUCT} to run as a cron job. This resource will also create the specified log directory if it doesn't already exist."
30
30
  introduced "16.0"
31
31
  examples <<~DOC
32
- **Setup #{Chef::Dist::PRODUCT} to run using the default 30 minute cadence**:
32
+ **Setup #{ChefUtils::Dist::Infra::PRODUCT} to run using the default 30 minute cadence**:
33
33
 
34
34
  ```ruby
35
- chef_client_cron "Run #{Chef::Dist::PRODUCT} as a cron job"
35
+ chef_client_cron "Run #{ChefUtils::Dist::Infra::PRODUCT} as a cron job"
36
36
  ```
37
37
 
38
- **Run #{Chef::Dist::PRODUCT} twice a day**:
38
+ **Run #{ChefUtils::Dist::Infra::PRODUCT} twice a day**:
39
39
 
40
40
  ```ruby
41
- chef_client_cron "Run #{Chef::Dist::PRODUCT} every 12 hours" do
41
+ chef_client_cron "Run #{ChefUtils::Dist::Infra::PRODUCT} every 12 hours" do
42
42
  minute 0
43
43
  hour "0,12"
44
44
  end
45
45
  ```
46
46
 
47
- **Run #{Chef::Dist::PRODUCT} with extra options passed to the client**:
47
+ **Run #{ChefUtils::Dist::Infra::PRODUCT} with extra options passed to the client**:
48
48
 
49
49
  ```ruby
50
50
  chef_client_cron "Run an override recipe" do
@@ -56,42 +56,42 @@ class Chef
56
56
  extend Chef::ResourceHelpers::CronValidations
57
57
 
58
58
  property :job_name, String,
59
- default: Chef::Dist::CLIENT,
59
+ default: ChefUtils::Dist::Infra::CLIENT,
60
60
  description: "The name of the cron job to create."
61
61
 
62
62
  property :comment, String,
63
63
  description: "A comment to place in the cron.d file."
64
64
 
65
65
  property :user, String,
66
- description: "The name of the user that #{Chef::Dist::PRODUCT} runs as.",
66
+ description: "The name of the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
67
67
  default: "root"
68
68
 
69
69
  property :minute, [Integer, String],
70
- description: "The minute at which #{Chef::Dist::PRODUCT} is to run (0 - 59) or a cron pattern such as '0,30'.",
70
+ description: "The minute at which #{ChefUtils::Dist::Infra::PRODUCT} is to run (0 - 59) or a cron pattern such as '0,30'.",
71
71
  default: "0,30", callbacks: {
72
72
  "should be a valid minute spec" => method(:validate_minute),
73
73
  }
74
74
 
75
75
  property :hour, [Integer, String],
76
- description: "The hour at which #{Chef::Dist::PRODUCT} is to run (0 - 23) or a cron pattern such as '0,12'.",
76
+ description: "The hour at which #{ChefUtils::Dist::Infra::PRODUCT} is to run (0 - 23) or a cron pattern such as '0,12'.",
77
77
  default: "*", callbacks: {
78
78
  "should be a valid hour spec" => method(:validate_hour),
79
79
  }
80
80
 
81
81
  property :day, [Integer, String],
82
- description: "The day of month at which #{Chef::Dist::PRODUCT} is to run (1 - 31) or a cron pattern such as '1,7,14,21,28'.",
82
+ description: "The day of month at which #{ChefUtils::Dist::Infra::PRODUCT} is to run (1 - 31) or a cron pattern such as '1,7,14,21,28'.",
83
83
  default: "*", callbacks: {
84
84
  "should be a valid day spec" => method(:validate_day),
85
85
  }
86
86
 
87
87
  property :month, [Integer, String],
88
- description: "The month in the year on which #{Chef::Dist::PRODUCT} is to run (1 - 12, jan-dec, or *).",
88
+ description: "The month in the year on which #{ChefUtils::Dist::Infra::PRODUCT} is to run (1 - 12, jan-dec, or *).",
89
89
  default: "*", callbacks: {
90
90
  "should be a valid month spec" => method(:validate_month),
91
91
  }
92
92
 
93
93
  property :weekday, [Integer, String],
94
- description: "The day of the week on which #{Chef::Dist::PRODUCT} is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
94
+ description: "The day of the week on which #{ChefUtils::Dist::Infra::PRODUCT} is to run (0-7, mon-sun, or *), where Sunday is both 0 and 7.",
95
95
  default: "*", callbacks: {
96
96
  "should be a valid weekday spec" => method(:validate_dow),
97
97
  }
@@ -100,7 +100,7 @@ class Chef
100
100
  default: 300,
101
101
  coerce: proc { |x| Integer(x) },
102
102
  callbacks: { "should be a positive number" => proc { |v| v > 0 } },
103
- description: "A random number of seconds between 0 and X to add to interval so that all #{Chef::Dist::CLIENT} commands don't execute at the same time."
103
+ description: "A random number of seconds between 0 and X to add to interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time."
104
104
 
105
105
  property :mailto, String,
106
106
  description: "The e-mail address to e-mail any cron task failures to."
@@ -110,12 +110,12 @@ class Chef
110
110
  default: false
111
111
 
112
112
  property :config_directory, String,
113
- default: Chef::Dist::CONF_DIR,
113
+ default: ChefConfig::Config.etc_chef_dir,
114
114
  description: "The path of the config directory."
115
115
 
116
116
  property :log_directory, String,
117
- default: lazy { platform?("mac_os_x") ? "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize}" : "/var/log/#{Chef::Dist::DIR_SUFFIX}" },
118
- default_description: "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize} on macOS and /var/log/#{Chef::Dist::DIR_SUFFIX} otherwise",
117
+ default: lazy { platform?("mac_os_x") ? "/Library/Logs/#{ChefUtils::Dist::Infra::DIR_SUFFIX.capitalize}" : "/var/log/#{ChefUtils::Dist::Infra::DIR_SUFFIX}" },
118
+ default_description: "/Library/Logs/#{ChefUtils::Dist::Infra::DIR_SUFFIX.capitalize} on macOS and /var/log/#{ChefUtils::Dist::Infra::DIR_SUFFIX} otherwise",
119
119
  description: "The path of the directory to create the log file in."
120
120
 
121
121
  property :log_file_name, String,
@@ -127,17 +127,23 @@ class Chef
127
127
  description: "Append to the log file instead of overwriting the log file on each run."
128
128
 
129
129
  property :chef_binary_path, String,
130
- default: "/opt/#{Chef::Dist::DIR_SUFFIX}/bin/#{Chef::Dist::CLIENT}",
131
- description: "The path to the #{Chef::Dist::CLIENT} binary."
130
+ default: "/opt/#{ChefUtils::Dist::Infra::DIR_SUFFIX}/bin/#{ChefUtils::Dist::Infra::CLIENT}",
131
+ description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary."
132
132
 
133
133
  property :daemon_options, Array,
134
134
  default: lazy { [] },
135
- description: "An array of options to pass to the #{Chef::Dist::CLIENT} command."
135
+ description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command."
136
136
 
137
137
  property :environment, Hash,
138
138
  default: lazy { {} },
139
139
  description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`."
140
140
 
141
+ property :nice, [Integer, String],
142
+ description: "The process priority to run the #{ChefUtils::Dist::Infra::CLIENT} process at. A value of -20 is the highest priority and 19 is the lowest priority.",
143
+ introduced: "16.5",
144
+ coerce: proc { |x| Integer(x) },
145
+ callbacks: { "should be an Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
146
+
141
147
  action :add do
142
148
  # TODO: Replace this with a :create_if_missing action on directory when that exists
143
149
  unless ::Dir.exist?(new_resource.log_directory)
@@ -158,7 +164,7 @@ class Chef
158
164
  mailto new_resource.mailto if new_resource.mailto
159
165
  user new_resource.user
160
166
  comment new_resource.comment if new_resource.comment
161
- command cron_command
167
+ command client_command
162
168
  end
163
169
  end
164
170
 
@@ -187,15 +193,16 @@ class Chef
187
193
  #
188
194
  # @return [String]
189
195
  #
190
- def cron_command
196
+ def client_command
191
197
  cmd = ""
192
198
  cmd << "/bin/sleep #{splay_sleep_time(new_resource.splay)}; "
199
+ cmd << "#{which("nice")} -n #{new_resource.nice} " if new_resource.nice
193
200
  cmd << "#{new_resource.chef_binary_path} "
194
201
  cmd << "#{new_resource.daemon_options.join(" ")} " unless new_resource.daemon_options.empty?
195
202
  cmd << "-c #{::File.join(new_resource.config_directory, "client.rb")} "
196
203
  cmd << "--chef-license accept " if new_resource.accept_chef_license
197
204
  cmd << log_command
198
- cmd << " || echo \"#{Chef::Dist::PRODUCT} execution failed\"" if new_resource.mailto
205
+ cmd << " || echo \"#{ChefUtils::Dist::Infra::PRODUCT} execution failed\"" if new_resource.mailto
199
206
  cmd
200
207
  end
201
208
 
@@ -0,0 +1,194 @@
1
+ #
2
+ # Copyright:: Copyright (c) Chef Software Inc.
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+
17
+ require_relative "../resource"
18
+ require "chef-utils/dist" unless defined?(ChefUtils::Dist)
19
+ class Chef
20
+ class Resource
21
+ class ChefClientLaunchd < Chef::Resource
22
+ unified_mode true
23
+
24
+ provides :chef_client_launchd
25
+
26
+ description "Use the **chef_client_launchd** resource to configure the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule."
27
+ introduced "16.5"
28
+ examples <<~DOC
29
+ **Set the #{ChefUtils::Dist::Infra::PRODUCT} to run on a schedule**:
30
+
31
+ ```ruby
32
+ chef_client_launchd 'Setup the #{ChefUtils::Dist::Infra::PRODUCT} to run every 30 minutes' do
33
+ interval 30
34
+ action :enable
35
+ end
36
+ ```
37
+
38
+ **Disable the #{ChefUtils::Dist::Infra::PRODUCT} running on a schedule**:
39
+
40
+ ```ruby
41
+ chef_client_launchd 'Prevent the #{ChefUtils::Dist::Infra::PRODUCT} from running on a schedule' do
42
+ action :disable
43
+ end
44
+ ```
45
+ DOC
46
+
47
+ property :user, String,
48
+ description: "The name of the user that #{ChefUtils::Dist::Infra::PRODUCT} runs as.",
49
+ default: "root"
50
+
51
+ property :working_directory, String,
52
+ description: "The working directory to run the #{ChefUtils::Dist::Infra::PRODUCT} from.",
53
+ default: "/var/root"
54
+
55
+ property :interval, [Integer, String],
56
+ description: "Time in minutes between #{ChefUtils::Dist::Infra::PRODUCT} executions.",
57
+ coerce: proc { |x| Integer(x) },
58
+ callbacks: { "should be a positive number" => proc { |v| v > 0 } },
59
+ default: 30
60
+
61
+ property :splay, [Integer, String],
62
+ default: 300,
63
+ coerce: proc { |x| Integer(x) },
64
+ callbacks: { "should be a positive number" => proc { |v| v > 0 } },
65
+ description: "A random number of seconds between 0 and X to add to interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time."
66
+
67
+ property :accept_chef_license, [true, false],
68
+ description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
69
+ default: false
70
+
71
+ property :config_directory, String,
72
+ description: "The path of the config directory.",
73
+ default: ChefConfig::Config.etc_chef_dir
74
+
75
+ property :log_directory, String,
76
+ description: "The path of the directory to create the log file in.",
77
+ default: "/Library/Logs/Chef"
78
+
79
+ property :log_file_name, String,
80
+ description: "The name of the log file to use.",
81
+ default: "client.log"
82
+
83
+ property :chef_binary_path, String,
84
+ description: "The path to the #{ChefUtils::Dist::Infra::CLIENT} binary.",
85
+ default: "/opt/#{ChefUtils::Dist::Infra::DIR_SUFFIX}/bin/#{ChefUtils::Dist::Infra::CLIENT}"
86
+
87
+ property :daemon_options, Array,
88
+ description: "An array of options to pass to the #{ChefUtils::Dist::Infra::CLIENT} command.",
89
+ default: lazy { [] }
90
+
91
+ property :environment, Hash,
92
+ description: "A Hash containing additional arbitrary environment variables under which the launchd daemon will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
93
+ default: lazy { {} }
94
+
95
+ property :nice, [Integer, String],
96
+ description: "The process priority to run the #{ChefUtils::Dist::Infra::CLIENT} process at. A value of -20 is the highest priority and 19 is the lowest priority.",
97
+ coerce: proc { |x| Integer(x) },
98
+ callbacks: { "should be an Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
99
+
100
+ property :low_priority_io, [true, false],
101
+ description: "Run the #{ChefUtils::Dist::Infra::CLIENT} process with low priority disk IO",
102
+ default: true
103
+
104
+ action :enable do
105
+ unless ::Dir.exist?(new_resource.log_directory)
106
+ directory new_resource.log_directory do
107
+ owner new_resource.user
108
+ mode "0750"
109
+ recursive true
110
+ end
111
+ end
112
+
113
+ launchd "com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}" do
114
+ username new_resource.user
115
+ working_directory new_resource.working_directory
116
+ start_interval new_resource.interval * 60
117
+ program_arguments ["/bin/bash", "-c", client_command]
118
+ environment_variables new_resource.environment unless new_resource.environment.empty?
119
+ nice new_resource.nice
120
+ low_priority_io true
121
+ notifies :sleep, "chef_sleep[Sleep before client restart]", :immediately
122
+ action :create # create only creates the file. No service restart triggering
123
+ end
124
+
125
+ # Launchd doesn't have the concept of a reload aka restart. Instead to update a daemon config you have
126
+ # to unload it and then reload the new plist. That's usually fine, but not if chef-client is trying
127
+ # to restart itself. If the chef-client process uses launchd or macosx_service resources to restart itself
128
+ # we'll end up with a stopped service that will never get started back up. Instead we use this daemon
129
+ # that triggers when the chef-client plist file is updated, and handles the restart outside the run.
130
+ launchd "com.#{ChefUtils::Dist::Infra::SHORT}.restarter" do
131
+ username "root"
132
+ watch_paths ["/Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist"]
133
+ standard_out_path ::File.join(new_resource.log_directory, new_resource.log_file_name)
134
+ standard_error_path ::File.join(new_resource.log_directory, new_resource.log_file_name)
135
+ program_arguments ["/bin/bash",
136
+ "-c",
137
+ "echo; echo #{ChefUtils::Dist::Infra::PRODUCT} launchd daemon config has been updated. Manually unloading and reloading the daemon; echo Now unloading the daemon; launchctl unload /Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist; sleep 2; echo Now loading the daemon; launchctl load /Library/LaunchDaemons/com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}.plist"]
138
+ action :enable # enable creates the plist & triggers service restarts on change
139
+ end
140
+
141
+ # We want to make sure that after we update the chef-client launchd config that we don't move on to another recipe
142
+ # before the restarter daemon can do its thing. This sleep avoids killing the client while it's doing something like
143
+ # installing a package, which could be problematic. It also makes it a bit more clear in the log that the killed process
144
+ # was intentional.
145
+ chef_sleep "Sleep before client restart" do
146
+ seconds 10
147
+ action :nothing
148
+ end
149
+ end
150
+
151
+ action :disable do
152
+ service ChefUtils::Dist::Infra::PRODUCT do
153
+ service_name "com.#{ChefUtils::Dist::Infra::SHORT}.#{ChefUtils::Dist::Infra::CLIENT}"
154
+ action :disable
155
+ end
156
+
157
+ service "com.#{ChefUtils::Dist::Infra::SHORT}.restarter" do
158
+ action :disable
159
+ end
160
+ end
161
+
162
+ action_class do
163
+ #
164
+ # Generate a uniformly distributed unique number to sleep from 0 to the splay time
165
+ #
166
+ # @param [Integer] splay The number of seconds to splay
167
+ #
168
+ # @return [Integer]
169
+ #
170
+ def splay_sleep_time(splay)
171
+ seed = node["shard_seed"] || Digest::MD5.hexdigest(node.name).to_s.hex
172
+ random = Random.new(seed.to_i)
173
+ random.rand(splay)
174
+ end
175
+
176
+ #
177
+ # random sleep time + chef-client + daemon option properties + license acceptance
178
+ #
179
+ # @return [String]
180
+ #
181
+ def client_command
182
+ cmd = ""
183
+ cmd << "/bin/sleep #{splay_sleep_time(new_resource.splay)};"
184
+ cmd << " #{new_resource.chef_binary_path}"
185
+ cmd << " #{new_resource.daemon_options.join(" ")}" unless new_resource.daemon_options.empty?
186
+ cmd << " -c #{::File.join(new_resource.config_directory, "client.rb")}"
187
+ cmd << " -L #{::File.join(new_resource.log_directory, new_resource.log_file_name)}"
188
+ cmd << " --chef-license accept" if new_resource.accept_chef_license
189
+ cmd
190
+ end
191
+ end
192
+ end
193
+ end
194
+ end