hybrid_platforms_conductor 32.17.1 → 33.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +36 -0
  3. data/README.md +6 -3
  4. data/bin/check-node +0 -1
  5. data/bin/deploy +0 -1
  6. data/bin/get_impacted_nodes +0 -1
  7. data/bin/last_deploys +12 -8
  8. data/bin/nodes_to_deploy +6 -6
  9. data/bin/setup +6 -6
  10. data/bin/topograph +1 -1
  11. data/docs/config_dsl.md +45 -1
  12. data/docs/executables.md +6 -7
  13. data/docs/executables/check-node.md +3 -3
  14. data/docs/executables/deploy.md +3 -3
  15. data/docs/executables/dump_nodes_json.md +3 -3
  16. data/docs/executables/test.md +3 -3
  17. data/docs/executables/topograph.md +3 -3
  18. data/docs/gen/mermaid/README.md-0.png +0 -0
  19. data/docs/gen/mermaid/docs/executables/check-node.md-0.png +0 -0
  20. data/docs/gen/mermaid/docs/executables/deploy.md-0.png +0 -0
  21. data/docs/gen/mermaid/docs/executables/free_ips.md-0.png +0 -0
  22. data/docs/gen/mermaid/docs/executables/get_impacted_nodes.md-0.png +0 -0
  23. data/docs/gen/mermaid/docs/executables/last_deploys.md-0.png +0 -0
  24. data/docs/gen/mermaid/docs/executables/nodes_to_deploy.md-0.png +0 -0
  25. data/docs/gen/mermaid/docs/executables/report.md-0.png +0 -0
  26. data/docs/gen/mermaid/docs/executables/run.md-0.png +0 -0
  27. data/docs/gen/mermaid/docs/executables/ssh_config.md-0.png +0 -0
  28. data/docs/gen/mermaid/docs/executables/test.md-0.png +0 -0
  29. data/docs/plugins.md +46 -0
  30. data/docs/plugins/log/remote_fs.md +26 -0
  31. data/docs/plugins/secrets_reader/cli.md +31 -0
  32. data/docs/plugins/secrets_reader/thycotic.md +46 -0
  33. data/lib/hybrid_platforms_conductor/action.rb +4 -4
  34. data/lib/hybrid_platforms_conductor/actions_executor.rb +45 -43
  35. data/lib/hybrid_platforms_conductor/bitbucket.rb +5 -4
  36. data/lib/hybrid_platforms_conductor/cmd_runner.rb +13 -12
  37. data/lib/hybrid_platforms_conductor/cmdb.rb +2 -2
  38. data/lib/hybrid_platforms_conductor/common_config_dsl/bitbucket.rb +2 -1
  39. data/lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb +2 -1
  40. data/lib/hybrid_platforms_conductor/common_config_dsl/file_system_tests.rb +5 -4
  41. data/lib/hybrid_platforms_conductor/common_config_dsl/github.rb +4 -3
  42. data/lib/hybrid_platforms_conductor/common_config_dsl/idempotence_tests.rb +2 -2
  43. data/lib/hybrid_platforms_conductor/config.rb +8 -4
  44. data/lib/hybrid_platforms_conductor/confluence.rb +1 -1
  45. data/lib/hybrid_platforms_conductor/connector.rb +5 -2
  46. data/lib/hybrid_platforms_conductor/core_extensions/cleanroom/fix_kwargs.rb +116 -0
  47. data/lib/hybrid_platforms_conductor/core_extensions/symbol/zero.rb +24 -0
  48. data/lib/hybrid_platforms_conductor/credentials.rb +39 -36
  49. data/lib/hybrid_platforms_conductor/current_dir_monitor.rb +4 -1
  50. data/lib/hybrid_platforms_conductor/deployer.rb +275 -225
  51. data/lib/hybrid_platforms_conductor/executable.rb +20 -15
  52. data/lib/hybrid_platforms_conductor/hpc_plugins/cmdb/config.rb +10 -7
  53. data/lib/hybrid_platforms_conductor/hpc_plugins/cmdb/host_ip.rb +1 -1
  54. data/lib/hybrid_platforms_conductor/hpc_plugins/cmdb/host_keys.rb +2 -2
  55. data/lib/hybrid_platforms_conductor/hpc_plugins/cmdb/platform_handlers.rb +4 -4
  56. data/lib/hybrid_platforms_conductor/hpc_plugins/connector/local.rb +2 -0
  57. data/lib/hybrid_platforms_conductor/hpc_plugins/connector/ssh.rb +45 -49
  58. data/lib/hybrid_platforms_conductor/hpc_plugins/log/my_log_plugin.rb.sample +100 -0
  59. data/lib/hybrid_platforms_conductor/hpc_plugins/log/remote_fs.rb +180 -0
  60. data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef.rb +68 -66
  61. data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef/dsl_parser.rb +13 -0
  62. data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef/recipes_tree_builder.rb +39 -38
  63. data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/yaml_inventory.rb +5 -4
  64. data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/docker.rb +43 -45
  65. data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/podman.rb +18 -20
  66. data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/proxmox.rb +119 -118
  67. data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/proxmox/proxmox_waiter.rb +39 -43
  68. data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/proxmox/reserve_proxmox_container +9 -13
  69. data/lib/hybrid_platforms_conductor/hpc_plugins/report/confluence.rb +2 -2
  70. data/lib/hybrid_platforms_conductor/hpc_plugins/report/mediawiki.rb +28 -21
  71. data/lib/hybrid_platforms_conductor/hpc_plugins/report/stdout.rb +26 -22
  72. data/lib/hybrid_platforms_conductor/hpc_plugins/secrets_reader/cli.rb +77 -0
  73. data/lib/hybrid_platforms_conductor/hpc_plugins/secrets_reader/my_secrets_reader_plugin.rb.sample +46 -0
  74. data/lib/hybrid_platforms_conductor/hpc_plugins/secrets_reader/thycotic.rb +90 -0
  75. data/lib/hybrid_platforms_conductor/hpc_plugins/test/bitbucket_conf.rb +3 -3
  76. data/lib/hybrid_platforms_conductor/hpc_plugins/test/check_deploy_and_idempotence.rb +4 -2
  77. data/lib/hybrid_platforms_conductor/hpc_plugins/test/deploy_freshness.rb +7 -21
  78. data/lib/hybrid_platforms_conductor/hpc_plugins/test/deploy_removes_root_access.rb +21 -19
  79. data/lib/hybrid_platforms_conductor/hpc_plugins/test/divergence.rb +2 -2
  80. data/lib/hybrid_platforms_conductor/hpc_plugins/test/executables.rb +2 -2
  81. data/lib/hybrid_platforms_conductor/hpc_plugins/test/file_system.rb +19 -21
  82. data/lib/hybrid_platforms_conductor/hpc_plugins/test/file_system_hdfs.rb +19 -21
  83. data/lib/hybrid_platforms_conductor/hpc_plugins/test/github_ci.rb +2 -3
  84. data/lib/hybrid_platforms_conductor/hpc_plugins/test/idempotence.rb +2 -2
  85. data/lib/hybrid_platforms_conductor/hpc_plugins/test/ip.rb +1 -1
  86. data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_conf.rb +21 -22
  87. data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_masters_ok.rb +10 -12
  88. data/lib/hybrid_platforms_conductor/hpc_plugins/test/linear_strategy.rb +9 -9
  89. data/lib/hybrid_platforms_conductor/hpc_plugins/test/local_users.rb +2 -2
  90. data/lib/hybrid_platforms_conductor/hpc_plugins/test/mounts.rb +2 -2
  91. data/lib/hybrid_platforms_conductor/hpc_plugins/test/orphan_files.rb +10 -9
  92. data/lib/hybrid_platforms_conductor/hpc_plugins/test/ports.rb +2 -2
  93. data/lib/hybrid_platforms_conductor/hpc_plugins/test/private_ips.rb +5 -5
  94. data/lib/hybrid_platforms_conductor/hpc_plugins/test/public_ips.rb +5 -5
  95. data/lib/hybrid_platforms_conductor/hpc_plugins/test/spectre.rb +4 -6
  96. data/lib/hybrid_platforms_conductor/hpc_plugins/test/veids.rb +3 -3
  97. data/lib/hybrid_platforms_conductor/hpc_plugins/test/vulnerabilities.rb +25 -24
  98. data/lib/hybrid_platforms_conductor/hpc_plugins/test_report/confluence.rb +2 -2
  99. data/lib/hybrid_platforms_conductor/hpc_plugins/test_report/stdout.rb +8 -6
  100. data/lib/hybrid_platforms_conductor/io_router.rb +14 -13
  101. data/lib/hybrid_platforms_conductor/json_dumper.rb +2 -2
  102. data/lib/hybrid_platforms_conductor/log.rb +31 -0
  103. data/lib/hybrid_platforms_conductor/logger_helpers.rb +19 -16
  104. data/lib/hybrid_platforms_conductor/nodes_handler.rb +89 -71
  105. data/lib/hybrid_platforms_conductor/parallel_threads.rb +7 -11
  106. data/lib/hybrid_platforms_conductor/platform_handler.rb +7 -7
  107. data/lib/hybrid_platforms_conductor/platforms_handler.rb +5 -3
  108. data/lib/hybrid_platforms_conductor/plugin.rb +2 -2
  109. data/lib/hybrid_platforms_conductor/plugins.rb +14 -8
  110. data/lib/hybrid_platforms_conductor/provisioner.rb +4 -4
  111. data/lib/hybrid_platforms_conductor/report.rb +2 -2
  112. data/lib/hybrid_platforms_conductor/reports_handler.rb +3 -2
  113. data/lib/hybrid_platforms_conductor/secrets_reader.rb +31 -0
  114. data/lib/hybrid_platforms_conductor/services_handler.rb +32 -29
  115. data/lib/hybrid_platforms_conductor/test_only_remote_node.rb +1 -1
  116. data/lib/hybrid_platforms_conductor/test_report.rb +15 -18
  117. data/lib/hybrid_platforms_conductor/tests_runner.rb +116 -118
  118. data/lib/hybrid_platforms_conductor/thycotic.rb +28 -19
  119. data/lib/hybrid_platforms_conductor/topographer.rb +200 -190
  120. data/lib/hybrid_platforms_conductor/topographer/plugins/graphviz.rb +8 -8
  121. data/lib/hybrid_platforms_conductor/topographer/plugins/json.rb +4 -4
  122. data/lib/hybrid_platforms_conductor/version.rb +1 -1
  123. data/spec/hybrid_platforms_conductor_test.rb +51 -12
  124. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/bash_spec.rb +18 -11
  125. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/interactive_spec.rb +2 -2
  126. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/remote_bash_spec.rb +32 -21
  127. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/ruby_spec.rb +75 -49
  128. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/scp_spec.rb +27 -15
  129. data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions_spec.rb +90 -59
  130. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connection_spec.rb +46 -44
  131. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/local/connectable_nodes_spec.rb +12 -8
  132. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/local/remote_actions_spec.rb +4 -7
  133. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/cli_options_spec.rb +21 -22
  134. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/config_dsl_spec.rb +23 -24
  135. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/connectable_nodes_spec.rb +10 -6
  136. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/connections_spec.rb +106 -75
  137. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/global_helpers_spec.rb +145 -126
  138. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/node_helpers_spec.rb +3 -3
  139. data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/remote_actions_spec.rb +29 -25
  140. data/spec/hybrid_platforms_conductor_test/api/actions_executor/logging_spec.rb +167 -142
  141. data/spec/hybrid_platforms_conductor_test/api/actions_executor/parallel_spec.rb +272 -244
  142. data/spec/hybrid_platforms_conductor_test/api/actions_executor/timeout_spec.rb +16 -16
  143. data/spec/hybrid_platforms_conductor_test/api/cmd_runner_spec.rb +36 -36
  144. data/spec/hybrid_platforms_conductor_test/api/config_spec.rb +24 -22
  145. data/spec/hybrid_platforms_conductor_test/api/deployer/check_spec.rb +4 -2
  146. data/spec/hybrid_platforms_conductor_test/api/deployer/config_dsl_spec.rb +43 -5
  147. data/spec/hybrid_platforms_conductor_test/api/deployer/deploy_spec.rb +199 -216
  148. data/spec/hybrid_platforms_conductor_test/api/deployer/log_plugins/remote_fs_spec.rb +223 -0
  149. data/spec/hybrid_platforms_conductor_test/api/deployer/parse_deploy_output_spec.rb +55 -59
  150. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioner_spec.rb +36 -62
  151. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/podman_spec.rb +17 -17
  152. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/config_dsl_spec.rb +4 -4
  153. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/create_spec.rb +44 -51
  154. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/destroy_spec.rb +3 -3
  155. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/ip_spec.rb +12 -16
  156. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/destroy_vm_spec.rb +31 -19
  157. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/expired_containers_spec.rb +324 -266
  158. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/ips_assignment_spec.rb +89 -61
  159. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/other_lxc_containers_resources_spec.rb +117 -93
  160. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/pve_node_resources_spec.rb +71 -54
  161. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/retries_spec.rb +10 -8
  162. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/reserve_proxmox_container/vm_ids_assignment_spec.rb +80 -60
  163. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/start_spec.rb +1 -1
  164. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/state_spec.rb +1 -1
  165. data/spec/hybrid_platforms_conductor_test/api/deployer/provisioners/proxmox/stop_spec.rb +1 -1
  166. data/spec/hybrid_platforms_conductor_test/api/deployer/secrets_reader_plugins/cli_spec.rb +64 -0
  167. data/spec/hybrid_platforms_conductor_test/api/deployer/secrets_reader_plugins/thycotic_spec.rb +268 -0
  168. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/cmdbs/config_spec.rb +8 -10
  169. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/cmdbs/host_ip_spec.rb +33 -24
  170. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/cmdbs/host_keys_spec.rb +64 -51
  171. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/cmdbs/platform_handlers_spec.rb +3 -3
  172. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/cmdbs_plugins_api_spec.rb +50 -51
  173. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/common_spec.rb +91 -81
  174. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/config_dsl_spec.rb +14 -16
  175. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/git_diff_impacts_spec.rb +51 -75
  176. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/nodes_selectors_spec.rb +35 -26
  177. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/platform_handlers_plugins_api_spec.rb +24 -16
  178. data/spec/hybrid_platforms_conductor_test/api/nodes_handler/several_platforms_spec.rb +29 -19
  179. data/spec/hybrid_platforms_conductor_test/api/platform_handler_spec.rb +4 -4
  180. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/config_dsl_spec.rb +2 -2
  181. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/deploy_output_parsing_spec.rb +6 -6
  182. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/diff_impacts_spec.rb +57 -99
  183. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/inventory_spec.rb +4 -4
  184. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/packaging_spec.rb +32 -35
  185. data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/services_deployment_spec.rb +10 -10
  186. data/spec/hybrid_platforms_conductor_test/api/platforms_handler_spec.rb +38 -27
  187. data/spec/hybrid_platforms_conductor_test/api/plugins_spec.rb +46 -52
  188. data/spec/hybrid_platforms_conductor_test/api/reports_handler_spec.rb +2 -2
  189. data/spec/hybrid_platforms_conductor_test/api/services_handler/actions_to_deploy_spec.rb +90 -58
  190. data/spec/hybrid_platforms_conductor_test/api/services_handler/deploy_allowed_spec.rb +38 -34
  191. data/spec/hybrid_platforms_conductor_test/api/services_handler/log_info_spec.rb +11 -9
  192. data/spec/hybrid_platforms_conductor_test/api/services_handler/package_spec.rb +193 -171
  193. data/spec/hybrid_platforms_conductor_test/api/services_handler/parse_deploy_output_spec.rb +66 -54
  194. data/spec/hybrid_platforms_conductor_test/api/services_handler/prepare_for_deploy_spec.rb +147 -133
  195. data/spec/hybrid_platforms_conductor_test/api/tests_runner/common_spec.rb +69 -49
  196. data/spec/hybrid_platforms_conductor_test/api/tests_runner/global_spec.rb +5 -4
  197. data/spec/hybrid_platforms_conductor_test/api/tests_runner/node_check_spec.rb +8 -5
  198. data/spec/hybrid_platforms_conductor_test/api/tests_runner/node_spec.rb +8 -5
  199. data/spec/hybrid_platforms_conductor_test/api/tests_runner/node_ssh_spec.rb +30 -27
  200. data/spec/hybrid_platforms_conductor_test/api/tests_runner/platform_spec.rb +12 -9
  201. data/spec/hybrid_platforms_conductor_test/api/tests_runner/reports_spec.rb +48 -47
  202. data/spec/hybrid_platforms_conductor_test/api/tests_runner/test_plugins/bitbucket_conf_spec.rb +5 -5
  203. data/spec/hybrid_platforms_conductor_test/api/tests_runner/test_plugins/github_ci_spec.rb +5 -5
  204. data/spec/hybrid_platforms_conductor_test/api/tests_runner/test_reports_plugins/confluence_spec.rb +5 -5
  205. data/spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb.rb +9 -9
  206. data/spec/hybrid_platforms_conductor_test/cmdb_plugins/{test_cmdb2.rb → test_cmdb_2.rb} +6 -6
  207. data/spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb_others.rb +3 -3
  208. data/spec/hybrid_platforms_conductor_test/cmdb_plugins/{test_cmdb_others2.rb → test_cmdb_others_2.rb} +2 -2
  209. data/spec/hybrid_platforms_conductor_test/docs_spec.rb +1 -1
  210. data/spec/hybrid_platforms_conductor_test/executables/{check-node_spec.rb → check_node_spec.rb} +4 -6
  211. data/spec/hybrid_platforms_conductor_test/executables/deploy_spec.rb +4 -6
  212. data/spec/hybrid_platforms_conductor_test/executables/get_impacted_nodes_spec.rb +76 -77
  213. data/spec/hybrid_platforms_conductor_test/executables/last_deploys_spec.rb +159 -113
  214. data/spec/hybrid_platforms_conductor_test/executables/nodes_to_deploy_spec.rb +299 -160
  215. data/spec/hybrid_platforms_conductor_test/executables/options/actions_executor_spec.rb +4 -6
  216. data/spec/hybrid_platforms_conductor_test/executables/options/cmd_runner_spec.rb +3 -5
  217. data/spec/hybrid_platforms_conductor_test/executables/options/common_spec.rb +8 -8
  218. data/spec/hybrid_platforms_conductor_test/executables/options/deployer_spec.rb +12 -196
  219. data/spec/hybrid_platforms_conductor_test/executables/options/nodes_handler_spec.rb +9 -10
  220. data/spec/hybrid_platforms_conductor_test/executables/options/nodes_selectors_spec.rb +9 -10
  221. data/spec/hybrid_platforms_conductor_test/executables/options/reports_handler_spec.rb +1 -1
  222. data/spec/hybrid_platforms_conductor_test/executables/options/tests_runner_spec.rb +22 -22
  223. data/spec/hybrid_platforms_conductor_test/executables/report_spec.rb +22 -16
  224. data/spec/hybrid_platforms_conductor_test/executables/run_spec.rb +32 -32
  225. data/spec/hybrid_platforms_conductor_test/executables/ssh_config_spec.rb +7 -9
  226. data/spec/hybrid_platforms_conductor_test/executables/test_spec.rb +3 -5
  227. data/spec/hybrid_platforms_conductor_test/helpers/actions_executor_helpers.rb +2 -2
  228. data/spec/hybrid_platforms_conductor_test/helpers/cmd_runner_helpers.rb +4 -3
  229. data/spec/hybrid_platforms_conductor_test/helpers/cmdb_helpers.rb +2 -2
  230. data/spec/hybrid_platforms_conductor_test/helpers/config_helpers.rb +1 -1
  231. data/spec/hybrid_platforms_conductor_test/helpers/connector_ssh_helpers.rb +12 -13
  232. data/spec/hybrid_platforms_conductor_test/helpers/deployer_helpers.rb +245 -56
  233. data/spec/hybrid_platforms_conductor_test/helpers/executables_helpers.rb +11 -11
  234. data/spec/hybrid_platforms_conductor_test/helpers/nodes_handler_helpers.rb +1 -1
  235. data/spec/hybrid_platforms_conductor_test/helpers/platforms_handler_helpers.rb +39 -28
  236. data/spec/hybrid_platforms_conductor_test/helpers/plugins_helpers.rb +1 -1
  237. data/spec/hybrid_platforms_conductor_test/helpers/provisioner_proxmox_helpers.rb +86 -111
  238. data/spec/hybrid_platforms_conductor_test/helpers/reports_handler_helpers.rb +1 -1
  239. data/spec/hybrid_platforms_conductor_test/helpers/serverless_chef_helpers.rb +3 -3
  240. data/spec/hybrid_platforms_conductor_test/helpers/services_handler_helpers.rb +1 -1
  241. data/spec/hybrid_platforms_conductor_test/helpers/tests_runner_helpers.rb +1 -1
  242. data/spec/hybrid_platforms_conductor_test/mocked_lib/my_test_gem/hpc_plugins/test_plugin_type/{test_plugin_id1.rb → test_plugin_id_1.rb} +0 -0
  243. data/spec/hybrid_platforms_conductor_test/mocked_lib/my_test_gem/hpc_plugins/test_plugin_type/{test_plugin_id2.rb → test_plugin_id_2.rb} +0 -0
  244. data/spec/hybrid_platforms_conductor_test/mocked_lib/my_test_gem2/sub_dir/hpc_plugins/test_plugin_type/{test_plugin_id3.rb → test_plugin_id_3.rb} +0 -0
  245. data/spec/hybrid_platforms_conductor_test/mocked_lib/my_test_gem2/sub_dir/hpc_plugins/{test_plugin_type2/test_plugin_id4.rb → test_plugin_type_2/test_plugin_id_4.rb} +0 -0
  246. data/spec/hybrid_platforms_conductor_test/platform_handler_plugins/test.rb +1 -1
  247. data/spec/hybrid_platforms_conductor_test/platform_handler_plugins/{test2.rb → test_2.rb} +0 -0
  248. data/spec/hybrid_platforms_conductor_test/rubocop_spec.rb +31 -0
  249. data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/1_node/nodes/node.json +3 -3
  250. data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/data_bags/nodes/node.json +3 -3
  251. data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_2/libraries/default.rb +1 -0
  252. data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/several_cookbooks/other_cookbooks/test_cookbook_2/libraries/default.rb +1 -0
  253. data/spec/hybrid_platforms_conductor_test/shared_examples/deployer.rb +952 -0
  254. data/spec/hybrid_platforms_conductor_test/test_connector.rb +4 -3
  255. data/spec/hybrid_platforms_conductor_test/test_log_no_read_plugin.rb +84 -0
  256. data/spec/hybrid_platforms_conductor_test/test_log_plugin.rb +105 -0
  257. data/spec/hybrid_platforms_conductor_test/test_plugins/global.rb +1 -0
  258. data/spec/hybrid_platforms_conductor_test/test_plugins/node.rb +1 -0
  259. data/spec/hybrid_platforms_conductor_test/test_plugins/node_check.rb +1 -0
  260. data/spec/hybrid_platforms_conductor_test/test_plugins/platform.rb +1 -0
  261. data/spec/hybrid_platforms_conductor_test/test_plugins/several_checks.rb +2 -2
  262. data/spec/hybrid_platforms_conductor_test/test_secrets_reader_plugin.rb +45 -0
  263. data/spec/hybrid_platforms_conductor_test/tests_report_plugin.rb +5 -6
  264. data/spec/spec_helper.rb +17 -18
  265. data/tools/check_md +16 -20
  266. data/tools/generate_mermaid +1 -1
  267. metadata +194 -144
  268. data/spec/hybrid_platforms_conductor_test/helpers/deployer_test_helpers.rb +0 -916
@@ -3,15 +3,12 @@ require 'futex'
3
3
  require 'json'
4
4
  require 'securerandom'
5
5
  require 'time'
6
- require 'thread'
7
6
  require 'hybrid_platforms_conductor/actions_executor'
8
7
  require 'hybrid_platforms_conductor/cmd_runner'
9
- require 'hybrid_platforms_conductor/executable'
10
8
  require 'hybrid_platforms_conductor/logger_helpers'
11
9
  require 'hybrid_platforms_conductor/nodes_handler'
12
10
  require 'hybrid_platforms_conductor/services_handler'
13
11
  require 'hybrid_platforms_conductor/plugins'
14
- require 'hybrid_platforms_conductor/thycotic'
15
12
 
16
13
  module HybridPlatformsConductor
17
14
 
@@ -21,12 +18,26 @@ module HybridPlatformsConductor
21
18
  # Extend the Config DSL
22
19
  module ConfigDSLExtension
23
20
 
21
+ # List of log plugins. Each info has the following properties:
22
+ # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule.
23
+ # * *log_plugins* (Array<Symbol>): List of log plugins to be used to store deployment logs.
24
+ # Array< Hash<Symbol, Object> >
25
+ attr_reader :deployment_logs
26
+
27
+ # List of secrets reader plugins. Each info has the following properties:
28
+ # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule.
29
+ # * *secrets_readers* (Array<Symbol>): List of log plugins to be used to store deployment logs.
30
+ # Array< Hash<Symbol, Object> >
31
+ attr_reader :secrets_readers
32
+
24
33
  # Integer: Timeout (in seconds) for packaging repositories
25
34
  attr_reader :packaging_timeout_secs
26
35
 
27
36
  # Mixin initializer
28
37
  def init_deployer_config
29
38
  @packaging_timeout_secs = 60
39
+ @deployment_logs = []
40
+ @secrets_readers = []
30
41
  end
31
42
 
32
43
  # Set the packaging timeout
@@ -37,6 +48,28 @@ module HybridPlatformsConductor
37
48
  @packaging_timeout_secs = packaging_timeout_secs
38
49
  end
39
50
 
51
+ # Set the deployment log plugins to be used
52
+ #
53
+ # Parameters::
54
+ # * *log_plugins* (Symbol or Array<Symbol>): The list of (or single) log plugins to be used
55
+ def send_logs_to(*log_plugins)
56
+ @deployment_logs << {
57
+ nodes_selectors_stack: current_nodes_selectors_stack,
58
+ log_plugins: log_plugins.flatten
59
+ }
60
+ end
61
+
62
+ # Set the secrets readers
63
+ #
64
+ # Parameters::
65
+ # * *secrets_readers* (Symbol or Array<Symbol>): The list of (or single) secrets readers plugins to be used
66
+ def read_secrets_from(*secrets_readers)
67
+ @secrets_readers << {
68
+ nodes_selectors_stack: current_nodes_selectors_stack,
69
+ secrets_readers: secrets_readers.flatten
70
+ }
71
+ end
72
+
40
73
  end
41
74
 
42
75
  include LoggerHelpers
@@ -55,10 +88,6 @@ module HybridPlatformsConductor
55
88
  # Boolean
56
89
  attr_accessor :concurrent_execution
57
90
 
58
- # The list of JSON secrets
59
- # Array<Hash>
60
- attr_accessor :secrets
61
-
62
91
  # Are we deploying in a local environment?
63
92
  # Boolean
64
93
  attr_accessor :local_environment
@@ -78,8 +107,8 @@ module HybridPlatformsConductor
78
107
  # * *actions_executor* (ActionsExecutor): Actions Executor to be used. [default: ActionsExecutor.new]
79
108
  # * *services_handler* (ServicesHandler): Services Handler to be used. [default: ServicesHandler.new]
80
109
  def initialize(
81
- logger: Logger.new(STDOUT),
82
- logger_stderr: Logger.new(STDERR),
110
+ logger: Logger.new($stdout),
111
+ logger_stderr: Logger.new($stderr),
83
112
  config: Config.new,
84
113
  cmd_runner: CmdRunner.new,
85
114
  nodes_handler: NodesHandler.new,
@@ -92,8 +121,36 @@ module HybridPlatformsConductor
92
121
  @nodes_handler = nodes_handler
93
122
  @actions_executor = actions_executor
94
123
  @services_handler = services_handler
95
- @secrets = []
124
+ @override_secrets = nil
125
+ @secrets_readers = Plugins.new(
126
+ :secrets_reader,
127
+ logger: @logger,
128
+ logger_stderr: @logger_stderr,
129
+ init_plugin: proc do |plugin_class|
130
+ plugin_class.new(
131
+ logger: @logger,
132
+ logger_stderr: @logger_stderr,
133
+ config: @config,
134
+ cmd_runner: @cmd_runner,
135
+ nodes_handler: @nodes_handler
136
+ )
137
+ end
138
+ )
96
139
  @provisioners = Plugins.new(:provisioner, logger: @logger, logger_stderr: @logger_stderr)
140
+ @log_plugins = Plugins.new(
141
+ :log,
142
+ logger: @logger,
143
+ logger_stderr: @logger_stderr,
144
+ init_plugin: proc do |plugin_class|
145
+ plugin_class.new(
146
+ logger: @logger,
147
+ logger_stderr: @logger_stderr,
148
+ config: @config,
149
+ nodes_handler: @nodes_handler,
150
+ actions_executor: @actions_executor
151
+ )
152
+ end
153
+ )
97
154
  # Default values
98
155
  @use_why_run = false
99
156
  @timeout = nil
@@ -112,42 +169,32 @@ module HybridPlatformsConductor
112
169
  def options_parse(options_parser, parallel_switch: true, why_run_switch: false, timeout_options: true)
113
170
  options_parser.separator ''
114
171
  options_parser.separator 'Deployer options:'
115
- options_parser.on(
116
- '-e', '--secrets SECRETS_LOCATION',
117
- 'Specify a secrets location. Can be specified several times. Location can be:',
118
- '* Local path to a JSON file',
119
- '* URL of the form http[s]://<url>:<secret_id> to get a secret JSON file from a Thycotic Secret Server at the given URL.'
120
- ) do |secrets_location|
121
- @secrets << JSON.parse(
122
- if secrets_location =~ /^(https?:\/\/.+):(\d+)$/
123
- url = $1
124
- secret_id = $2
125
- secret = nil
126
- Thycotic.with_thycotic(url, @logger, @logger_stderr) do |thycotic|
127
- secret_file_item_id = thycotic.get_secret(secret_id).dig(:secret, :items, :secret_item, :id)
128
- raise "Unable to fetch secret file ID #{secrets_location}" if secret_file_item_id.nil?
129
- secret = thycotic.download_file_attachment_by_item_id(secret_id, secret_file_item_id)
130
- raise "Unable to fetch secret file attachment from #{secrets_location}" if secret.nil?
131
- end
132
- secret
133
- else
134
- raise "Missing secret file: #{secrets_location}" unless File.exist?(secrets_location)
135
- File.read(secrets_location)
136
- end
137
- )
172
+ if parallel_switch
173
+ options_parser.on('-p', '--parallel', 'Execute the commands in parallel (put the standard output in files <hybrid-platforms-dir>/run_logs/*.stdout)') do
174
+ @concurrent_execution = true
175
+ end
176
+ end
177
+ if timeout_options
178
+ options_parser.on('-t', '--timeout SECS', "Timeout in seconds to wait for each chef run. Only used in why-run mode. (defaults to #{@timeout.nil? ? 'no timeout' : @timeout})") do |nbr_secs|
179
+ @timeout = nbr_secs.to_i
180
+ end
181
+ end
182
+ if why_run_switch
183
+ options_parser.on('-W', '--why-run', 'Use the why-run mode to see what would be the result of the deploy instead of deploying it for real.') do
184
+ @use_why_run = true
185
+ end
138
186
  end
139
- options_parser.on('-p', '--parallel', 'Execute the commands in parallel (put the standard output in files <hybrid-platforms-dir>/run_logs/*.stdout)') do
140
- @concurrent_execution = true
141
- end if parallel_switch
142
- options_parser.on('-t', '--timeout SECS', "Timeout in seconds to wait for each chef run. Only used in why-run mode. (defaults to #{@timeout.nil? ? 'no timeout' : @timeout})") do |nbr_secs|
143
- @timeout = nbr_secs.to_i
144
- end if timeout_options
145
- options_parser.on('-W', '--why-run', 'Use the why-run mode to see what would be the result of the deploy instead of deploying it for real.') do
146
- @use_why_run = true
147
- end if why_run_switch
148
187
  options_parser.on('--retries-on-error NBR', "Number of retries in case of non-deterministic errors (defaults to #{@nbr_retries_on_error})") do |nbr_retries|
149
188
  @nbr_retries_on_error = nbr_retries.to_i
150
189
  end
190
+ # Display options secrets readers might have
191
+ @secrets_readers.each do |secret_reader_name, secret_reader|
192
+ next unless secret_reader.respond_to?(:options_parse)
193
+
194
+ options_parser.separator ''
195
+ options_parser.separator "Secrets reader #{secret_reader_name} options:"
196
+ secret_reader.options_parse(options_parser)
197
+ end
151
198
  end
152
199
 
153
200
  # Validate that parsed parameters are valid
@@ -158,6 +205,16 @@ module HybridPlatformsConductor
158
205
  # String: File used as a Futex for packaging
159
206
  PACKAGING_FUTEX_FILE = "#{Dir.tmpdir}/hpc_packaging"
160
207
 
208
+ # Override the secrets with a given JSON.
209
+ # When using this method with a secrets Hash, further deployments will not query secrets readers, but will use those secrets directly.
210
+ # Useful to override secrets in test conditions when using dummy secrets for example.
211
+ #
212
+ # Parameters::
213
+ # * *secrets* (Hash or nil): Secrets to take into account in place of secrets readers, or nil to cancel a previous overriding and use secrets readers instead.
214
+ def override_secrets(secrets)
215
+ @override_secrets = secrets
216
+ end
217
+
161
218
  # Deploy on a given list of nodes selectors.
162
219
  # The workflow is the following:
163
220
  # 1. Package the services to be deployed, considering the nodes, services and context (options, secrets, environment...)
@@ -171,16 +228,26 @@ module HybridPlatformsConductor
171
228
  def deploy_on(*nodes_selectors)
172
229
  # Get the sorted list of services to be deployed, per node
173
230
  # Hash<String, Array<String> >
174
- services_to_deploy = Hash[@nodes_handler.select_nodes(nodes_selectors.flatten).map do |node|
231
+ services_to_deploy = @nodes_handler.select_nodes(nodes_selectors.flatten).map do |node|
175
232
  [node, @nodes_handler.get_services_of(node)]
176
- end]
233
+ end.to_h
177
234
 
178
235
  # Get the secrets to be deployed
179
236
  secrets = {}
180
- @secrets.each do |secret_json|
181
- secrets.merge!(secret_json) do |key, value1, value2|
182
- raise "Secret #{key} has conflicting values between different secret JSON files." if value1 != value2
183
- value1
237
+ if @override_secrets
238
+ secrets = @override_secrets
239
+ else
240
+ services_to_deploy.each do |node, services|
241
+ # If there is no config for secrets, just use cli
242
+ (@config.secrets_readers.empty? ? [{ secrets_readers: %i[cli] }] : @nodes_handler.select_confs_for_node(node, @config.secrets_readers)).inject([]) do |secrets_readers, secrets_readers_info|
243
+ secrets_readers + secrets_readers_info[:secrets_readers]
244
+ end.sort.uniq.each do |secrets_reader|
245
+ services.each do |service|
246
+ node_secrets = @secrets_readers[secrets_reader].secrets_for(node, service)
247
+ conflicting_path = safe_merge(secrets, node_secrets)
248
+ raise "Secret set at path #{conflicting_path.join('->')} by #{secrets_reader} for service #{service} on node #{node} has conflicting values (#{log_debug? ? "#{node_secrets.dig(*conflicting_path)} != #{secrets.dig(*conflicting_path)}" : 'set debug for value details'})." unless conflicting_path.nil?
249
+ end
250
+ end
184
251
  end
185
252
  end
186
253
 
@@ -188,7 +255,6 @@ module HybridPlatformsConductor
188
255
  unless @use_why_run
189
256
  reason_for_interdiction = @services_handler.deploy_allowed?(
190
257
  services: services_to_deploy,
191
- secrets: secrets,
192
258
  local_environment: @local_environment
193
259
  )
194
260
  raise "Deployment not allowed: #{reason_for_interdiction}" unless reason_for_interdiction.nil?
@@ -226,51 +292,50 @@ module HybridPlatformsConductor
226
292
  remaining_nodes_to_deploy = services_to_deploy.keys
227
293
  while nbr_retries >= 0 && !remaining_nodes_to_deploy.empty?
228
294
  last_deploy_results = deploy(services_to_deploy.slice(*remaining_nodes_to_deploy))
229
- if nbr_retries > 0
295
+ if nbr_retries.positive?
230
296
  # Check if we need to retry deployment on some nodes
231
297
  # Only parse the last deployment attempt logs
232
- retriable_nodes = Hash[
233
- remaining_nodes_to_deploy.
234
- map do |node|
235
- exit_status, stdout, stderr = last_deploy_results[node]
236
- if exit_status == 0
298
+ retriable_nodes = remaining_nodes_to_deploy.
299
+ map do |node|
300
+ exit_status, stdout, stderr = last_deploy_results[node]
301
+ if exit_status.zero?
302
+ nil
303
+ else
304
+ retriable_errors = retriable_errors_from(node, exit_status, stdout, stderr)
305
+ if retriable_errors.empty?
237
306
  nil
238
307
  else
239
- retriable_errors = retriable_errors_from(node, exit_status, stdout, stderr)
240
- if retriable_errors.empty?
241
- nil
242
- else
243
- # Log the issue in the stderr of the deployment
244
- stderr << "!!! #{retriable_errors.size} retriable errors detected in this deployment:\n#{retriable_errors.map { |error| "* #{error}" }.join("\n")}\n"
245
- [node, retriable_errors]
246
- end
308
+ # Log the issue in the stderr of the deployment
309
+ stderr << "!!! #{retriable_errors.size} retriable errors detected in this deployment:\n#{retriable_errors.map { |error| "* #{error}" }.join("\n")}\n"
310
+ [node, retriable_errors]
247
311
  end
248
- end.
249
- compact
250
- ]
312
+ end
313
+ end.
314
+ compact.
315
+ to_h
251
316
  unless retriable_nodes.empty?
252
- log_warn <<~EOS.strip
317
+ log_warn <<~EO_LOG.strip
253
318
  Retry deployment for #{retriable_nodes.size} nodes as they got non-deterministic errors (#{nbr_retries} retries remaining):
254
319
  #{retriable_nodes.map { |node, retriable_errors| " * #{node}:\n#{retriable_errors.map { |error| " - #{error}" }.join("\n")}" }.join("\n")}
255
- EOS
320
+ EO_LOG
256
321
  end
257
322
  remaining_nodes_to_deploy = retriable_nodes.keys
258
323
  end
259
324
  # Merge deployment results
260
- results.merge!(last_deploy_results) do |node, (exit_status_1, stdout_1, stderr_1), (exit_status_2, stdout_2, stderr_2)|
325
+ results.merge!(last_deploy_results) do |_node, (exit_status_1, stdout_1, stderr_1), (exit_status_2, stdout_2, stderr_2)|
261
326
  [
262
327
  exit_status_2,
263
- <<~EOS,
328
+ <<~EO_STDOUT,
264
329
  #{stdout_1}
265
330
  Deployment exit status code: #{exit_status_1}
266
331
  !!! Retry deployment due to non-deterministic error (#{nbr_retries} remaining attempts)...
267
332
  #{stdout_2}
268
- EOS
269
- <<~EOS
333
+ EO_STDOUT
334
+ <<~EO_STDERR
270
335
  #{stderr_1}
271
336
  !!! Retry deployment due to non-deterministic error (#{nbr_retries} remaining attempts)...
272
337
  #{stderr_2}
273
- EOS
338
+ EO_STDERR
274
339
  ]
275
340
  end
276
341
  nbr_retries -= 1
@@ -325,7 +390,7 @@ module HybridPlatformsConductor
325
390
  sub_executable.config.sudo_procs.replace(sub_executable.config.sudo_procs.map do |sudo_proc_info|
326
391
  {
327
392
  nodes_selectors_stack: sudo_proc_info[:nodes_selectors_stack].map do |nodes_selector|
328
- @nodes_handler.select_nodes(nodes_selector).select { |selected_node| selected_node != node }
393
+ @nodes_handler.select_nodes(nodes_selector).reject { |selected_node| selected_node == node }
329
394
  end,
330
395
  sudo_proc: sudo_proc_info[:sudo_proc]
331
396
  }
@@ -338,13 +403,13 @@ module HybridPlatformsConductor
338
403
  deployer.local_environment = true
339
404
  # Ignore secrets that might have been given: in Docker containers we always use dummy secrets
340
405
  dummy_secrets_file = "#{@config.hybrid_platforms_dir}/dummy_secrets.json"
341
- deployer.secrets = File.exist?(dummy_secrets_file) ? [JSON.parse(File.read(dummy_secrets_file))] : []
406
+ deployer.override_secrets(File.exist?(dummy_secrets_file) ? JSON.parse(File.read(dummy_secrets_file)) : {})
342
407
  yield deployer, instance
343
408
  end
344
409
  rescue
345
410
  # Make sure Docker logs are being output to better investigate errors if we were not already outputing them in debug mode
346
411
  stdouts = sub_executable.stdouts_to_s
347
- log_error "[ #{node}/#{environment} ] - Encountered unhandled exception #{$!}\n#{$!.backtrace.join("\n")}\n-----\n#{stdouts}" unless stdouts.nil?
412
+ log_error "[ #{node}/#{environment} ] - Encountered unhandled exception #{$ERROR_INFO}\n#{$ERROR_INFO.backtrace.join("\n")}\n-----\n#{stdouts}" unless stdouts.nil?
348
413
  raise
349
414
  end
350
415
  end
@@ -355,72 +420,31 @@ module HybridPlatformsConductor
355
420
  # * *nodes* (Array<String>): Nodes to get info from
356
421
  # Result::
357
422
  # * Hash<String, Hash<Symbol,Object>: The deployed info, per node name.
358
- # Properties are defined by the Deployer#save_logs method, and additionally to them the following properties can be set:
359
- # * *error* (String): Optional property set in case of error
423
+ # * *error* (String): Error string in case deployment logs could not be retrieved. If set then further properties will be ignored. [optional]
424
+ # * *services* (Array<String>): List of services deployed on the node
425
+ # * *deployment_info* (Hash<Symbol,Object>): Deployment metadata
426
+ # * *exit_status* (Integer or Symbol): Deployment exit status
427
+ # * *stdout* (String): Deployment stdout
428
+ # * *stderr* (String): Deployment stderr
360
429
  def deployment_info_from(*nodes)
430
+ nodes = nodes.flatten
361
431
  @actions_executor.max_threads = 64
362
- Hash[@actions_executor.
363
- execute_actions(
364
- Hash[nodes.flatten.map do |node|
365
- [
366
- node,
367
- { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" }
368
- ]
369
- end],
370
- log_to_stdout: false,
371
- concurrent: true,
372
- timeout: 10,
373
- progress_name: 'Getting deployment info'
374
- ).
375
- map do |node, (exit_status, stdout, stderr)|
376
- # Expected format for stdout:
377
- # Property1: Value1
378
- # ...
379
- # PropertyN: ValueN
380
- # ===== STDOUT =====
381
- # ...
382
- deploy_info = {}
383
- if exit_status.is_a?(Symbol)
384
- deploy_info[:error] = "Error: #{exit_status}\n#{stderr}"
385
- else
386
- stdout_lines = stdout.split("\n")
387
- if stdout_lines.first =~ /No such file or directory/
388
- deploy_info[:error] = '/var/log/deployments missing'
389
- else
390
- stdout_lines.each do |line|
391
- if line =~ /^([^:]+): (.+)$/
392
- key_str, value = $1, $2
393
- key = key_str.to_sym
394
- # Type-cast some values
395
- case key_str
396
- when 'date'
397
- # Date and time values
398
- # Thu Nov 23 18:43:01 UTC 2017
399
- deploy_info[key] = Time.parse(value)
400
- when 'debug'
401
- # Boolean values
402
- # Yes
403
- deploy_info[key] = (value == 'Yes')
404
- when /^diff_files_.+$/, 'services'
405
- # Array of strings
406
- # my_file.txt, other_file.txt
407
- deploy_info[key] = value.split(', ')
408
- else
409
- deploy_info[key] = value
410
- end
411
- else
412
- deploy_info[:unknown_lines] = [] unless deploy_info.key?(:unknown_lines)
413
- deploy_info[:unknown_lines] << line
414
- end
415
- end
416
- end
417
- end
418
- [
419
- node,
420
- deploy_info
421
- ]
422
- end
423
- ]
432
+ read_actions_results = @actions_executor.execute_actions(
433
+ nodes.map do |node|
434
+ master_log_plugin = @log_plugins[log_plugins_for(node).first]
435
+ master_log_plugin.respond_to?(:actions_to_read_logs) ? [node, master_log_plugin.actions_to_read_logs(node)] : nil
436
+ end.compact.to_h,
437
+ log_to_stdout: false,
438
+ concurrent: true,
439
+ timeout: 10,
440
+ progress_name: 'Read deployment logs'
441
+ )
442
+ nodes.map do |node|
443
+ [
444
+ node,
445
+ @log_plugins[log_plugins_for(node).first].logs_for(node, *(read_actions_results[node] || [nil, nil, nil]))
446
+ ]
447
+ end.to_h
424
448
  end
425
449
 
426
450
  # Parse stdout and stderr of a given deploy run and get the list of tasks with their status
@@ -436,12 +460,41 @@ module HybridPlatformsConductor
436
460
  # * *:changed*: The task has been changed
437
461
  # * *:identical*: The task has not been changed
438
462
  # * *diffs* (String): Differences, if any
439
- def parse_deploy_output(node, stdout, stderr)
463
+ def parse_deploy_output(_node, stdout, stderr)
440
464
  @services_handler.parse_deploy_output(stdout, stderr).map { |deploy_info| deploy_info[:tasks] }.flatten
441
465
  end
442
466
 
443
467
  private
444
468
 
469
+ # Safe-merge 2 hashes.
470
+ # Safe-merging is done by:
471
+ # * Merging values that are hashes.
472
+ # * Reporting errors when values conflict.
473
+ # When values are conflicting, the initial hash won't modify those conflicting values and will stop the merge.
474
+ #
475
+ # Parameters::
476
+ # * *hash* (Hash): Hash to be modified merging hash_to_merge
477
+ # * *hash_to_merge* (Hash): Hash to be merged into hash
478
+ # Result::
479
+ # * nil or Array<Object>: nil in case of success, or the keys path leading to a conflicting value in case of error
480
+ def safe_merge(hash, hash_to_merge)
481
+ conflicting_path = nil
482
+ hash_to_merge.each do |key, value_to_merge|
483
+ if hash.key?(key)
484
+ if hash[key].is_a?(Hash) && value_to_merge.is_a?(Hash)
485
+ sub_conflicting_path = safe_merge(hash[key], value_to_merge)
486
+ conflicting_path = [key] + sub_conflicting_path unless sub_conflicting_path.nil?
487
+ elsif hash[key] != value_to_merge
488
+ conflicting_path = [key]
489
+ end
490
+ else
491
+ hash[key] = value_to_merge
492
+ end
493
+ break unless conflicting_path.nil?
494
+ end
495
+ conflicting_path
496
+ end
497
+
445
498
  # Get the list of retriable errors a node got from deployment logs.
446
499
  # Useful to know if an error is non-deterministic (due to external and temporary factors).
447
500
  #
@@ -452,7 +505,7 @@ module HybridPlatformsConductor
452
505
  # * *stderr* (String): Deployment stderr
453
506
  # Result::
454
507
  # * Array<String>: List of retriable errors that have been matched
455
- def retriable_errors_from(node, exit_status, stdout, stderr)
508
+ def retriable_errors_from(node, _exit_status, stdout, stderr)
456
509
  # List of retriable errors for this node, as exact string match or regexps.
457
510
  # Array<String or Regexp>
458
511
  retriable_errors_on_stdout = []
@@ -483,59 +536,55 @@ module HybridPlatformsConductor
483
536
  # Result::
484
537
  # * Hash<String, [Integer or Symbol, String, String]>: Exit status code (or Symbol in case of error or dry run), standard output and error for each node.
485
538
  def deploy(services)
486
- outputs = {}
487
-
488
539
  # Get the ssh user directly from the connector
489
540
  ssh_user = @actions_executor.connector(:ssh).ssh_user
490
541
 
491
542
  # Deploy for real
492
543
  @nodes_handler.prefetch_metadata_of services.keys, :image
493
544
  outputs = @actions_executor.execute_actions(
494
- Hash[services.map do |node, node_services|
545
+ services.map do |node, node_services|
495
546
  image_id = @nodes_handler.get_image_of(node)
496
547
  sudo = (ssh_user == 'root' ? '' : "#{@nodes_handler.sudo_on(node)} ")
497
- # Install My_company corporate certificates if present
548
+ # Install corporate certificates if present
498
549
  certificate_actions =
499
550
  if @local_environment && ENV['hpc_certificates']
500
- if File.exist?(ENV['hpc_certificates'])
501
- log_debug "Deploy certificates from #{ENV['hpc_certificates']}"
502
- case image_id
503
- when 'debian_9', 'debian_10'
504
- [
505
- {
506
- remote_bash: "#{sudo}apt update && #{sudo}apt install -y ca-certificates"
507
- },
508
- {
509
- scp: {
510
- ENV['hpc_certificates'] => '/usr/local/share/ca-certificates',
511
- :sudo => ssh_user != 'root'
512
- },
513
- remote_bash: "#{sudo}update-ca-certificates"
514
- }
515
- ]
516
- when 'centos_7'
517
- [
518
- {
519
- remote_bash: "#{sudo}yum install -y ca-certificates"
551
+ raise "Missing path referenced by the hpc_certificates environment variable: #{ENV['hpc_certificates']}" unless File.exist?(ENV['hpc_certificates'])
552
+
553
+ log_debug "Deploy certificates from #{ENV['hpc_certificates']}"
554
+ case image_id
555
+ when 'debian_9', 'debian_10'
556
+ [
557
+ {
558
+ remote_bash: "#{sudo}apt update && #{sudo}apt install -y ca-certificates"
559
+ },
560
+ {
561
+ scp: {
562
+ ENV['hpc_certificates'] => '/usr/local/share/ca-certificates',
563
+ :sudo => ssh_user != 'root'
520
564
  },
521
- {
522
- scp: Hash[Dir.glob("#{ENV['hpc_certificates']}/*.crt").map do |cert_file|
523
- [
524
- cert_file,
525
- '/etc/pki/ca-trust/source/anchors'
526
- ]
527
- end].merge(sudo: ssh_user != 'root'),
528
- remote_bash: [
529
- "#{sudo}update-ca-trust enable",
530
- "#{sudo}update-ca-trust extract"
565
+ remote_bash: "#{sudo}update-ca-certificates"
566
+ }
567
+ ]
568
+ when 'centos_7'
569
+ [
570
+ {
571
+ remote_bash: "#{sudo}yum install -y ca-certificates"
572
+ },
573
+ {
574
+ scp: Dir.glob("#{ENV['hpc_certificates']}/*.crt").map do |cert_file|
575
+ [
576
+ cert_file,
577
+ '/etc/pki/ca-trust/source/anchors'
531
578
  ]
532
- }
533
- ]
534
- else
535
- raise "Unknown image ID for node #{node}: #{image_id}. Check metadata for this node."
536
- end
579
+ end.to_h.merge(sudo: ssh_user != 'root'),
580
+ remote_bash: [
581
+ "#{sudo}update-ca-trust enable",
582
+ "#{sudo}update-ca-trust extract"
583
+ ]
584
+ }
585
+ ]
537
586
  else
538
- raise "Missing path referenced by the hpc_certificates environment variable: #{ENV['hpc_certificates']}"
587
+ raise "Unknown image ID for node #{node}: #{image_id}. Check metadata for this node."
539
588
  end
540
589
  else
541
590
  []
@@ -552,19 +601,19 @@ module HybridPlatformsConductor
552
601
  certificate_actions +
553
602
  @services_handler.actions_to_deploy_on(node, node_services, @use_why_run)
554
603
  ]
555
- end],
604
+ end.to_h,
556
605
  timeout: @timeout,
557
606
  concurrent: @concurrent_execution,
558
607
  log_to_stdout: !@concurrent_execution
559
608
  )
560
609
  # Free eventual locks
561
610
  @actions_executor.execute_actions(
562
- Hash[services.keys.map do |node|
611
+ services.keys.map do |node|
563
612
  [
564
613
  node,
565
614
  { remote_bash: "#{ssh_user == 'root' ? '' : "#{@nodes_handler.sudo_on(node)} "}./mutex_dir unlock /tmp/hybrid_platforms_conductor_deploy_lock" }
566
615
  ]
567
- end],
616
+ end.to_h,
568
617
  timeout: 10,
569
618
  concurrent: true,
570
619
  log_to_dir: nil
@@ -584,47 +633,48 @@ module HybridPlatformsConductor
584
633
  # * *services* (Hash<String, Array<String>>): List of services that have been deployed, per node
585
634
  def save_logs(logs, services)
586
635
  section "Saving deployment logs for #{logs.size} nodes" do
587
- Dir.mktmpdir('hybrid_platforms_conductor-logs') do |tmp_dir|
588
- ssh_user = @actions_executor.connector(:ssh).ssh_user
589
- @actions_executor.execute_actions(
590
- Hash[logs.map do |node, (exit_status, stdout, stderr)|
591
- # Create a log file to be scp with all relevant info
592
- now = Time.now.utc
593
- log_file = "#{tmp_dir}/#{node}_#{now.strftime('%F_%H%M%S')}_#{ssh_user}"
594
- services_info = @services_handler.log_info_for(node, services[node])
595
- File.write(
596
- log_file,
597
- services_info.merge(
598
- date: now.strftime('%F %T'),
599
- user: ssh_user,
600
- debug: log_debug? ? 'Yes' : 'No',
601
- services: services[node].join(', '),
602
- exit_status: exit_status
603
- ).map { |property, value| "#{property}: #{value}" }.join("\n") +
604
- "\n===== STDOUT =====\n" +
605
- (stdout || '') +
606
- "\n===== STDERR =====\n" +
607
- (stderr || '')
608
- )
609
- [
610
- node,
611
- {
612
- remote_bash: "#{ssh_user == 'root' ? '' : "#{@nodes_handler.sudo_on(node)} "}mkdir -p /var/log/deployments",
613
- scp: {
614
- log_file => '/var/log/deployments',
615
- :sudo => ssh_user != 'root',
616
- :owner => 'root',
617
- :group => 'root'
618
- }
619
- }
620
- ]
621
- end],
622
- timeout: 10,
623
- concurrent: true,
624
- log_to_dir: nil
625
- )
626
- end
636
+ ssh_user = @actions_executor.connector(:ssh).ssh_user
637
+ @actions_executor.execute_actions(
638
+ logs.map do |node, (exit_status, stdout, stderr)|
639
+ [
640
+ node,
641
+ log_plugins_for(node).
642
+ map do |log_plugin|
643
+ @log_plugins[log_plugin].actions_to_save_logs(
644
+ node,
645
+ services[node],
646
+ @services_handler.log_info_for(node, services[node]).merge(
647
+ date: Time.now.utc.strftime('%F %T'),
648
+ user: ssh_user
649
+ ),
650
+ exit_status,
651
+ stdout,
652
+ stderr
653
+ )
654
+ end.
655
+ flatten(1)
656
+ ]
657
+ end.to_h,
658
+ timeout: 10,
659
+ concurrent: true,
660
+ log_to_dir: nil,
661
+ progress_name: 'Saving logs'
662
+ )
663
+ end
664
+ end
665
+
666
+ # Get the list of log plugins to be used for a given node
667
+ #
668
+ # Parameters::
669
+ # * *node* (String): The node for which log plugins are queried
670
+ # Result::
671
+ # * Array<Symbol>: The list of log plugins
672
+ def log_plugins_for(node)
673
+ node_log_plugins = @nodes_handler.select_confs_for_node(node, @config.deployment_logs).inject([]) do |log_plugins, deployment_logs_info|
674
+ log_plugins + deployment_logs_info[:log_plugins]
627
675
  end
676
+ node_log_plugins << :remote_fs if node_log_plugins.empty?
677
+ node_log_plugins
628
678
  end
629
679
 
630
680
  end