chef-dk 0.15.16 → 0.16.28

Sign up to get free protection for your applications and to get access to all the features.
Files changed (331) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +1 -26
  3. data/Gemfile +10 -4
  4. data/Gemfile.lock +73 -64
  5. data/LICENSE +201 -201
  6. data/README.md +2 -1
  7. data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +27 -27
  8. data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +288 -288
  9. data/acceptance/.shared/kitchen_acceptance/.kitchen.vagrant.yml +52 -52
  10. data/acceptance/.shared/kitchen_acceptance/libraries/kitchen.rb +51 -51
  11. data/acceptance/.shared/kitchen_acceptance/metadata.rb +1 -1
  12. data/acceptance/Gemfile +3 -0
  13. data/acceptance/Gemfile.lock +24 -24
  14. data/acceptance/README.md +132 -132
  15. data/acceptance/trivial/.acceptance/acceptance-cookbook/.gitignore +2 -2
  16. data/acceptance/trivial/.acceptance/acceptance-cookbook/metadata.rb +2 -2
  17. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/destroy.rb +1 -1
  18. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/provision.rb +1 -1
  19. data/acceptance/trivial/.acceptance/acceptance-cookbook/recipes/verify.rb +1 -1
  20. data/acceptance/trivial/.kitchen.yml +7 -7
  21. data/acceptance/trivial/test/integration/chefdk-current-install/inspec/chef_client_spec.rb +5 -5
  22. data/bin/chef +25 -25
  23. data/chef-dk.gemspec +1 -1
  24. data/lib/chef-dk.rb +19 -19
  25. data/lib/chef-dk/authenticated_http.rb +40 -40
  26. data/lib/chef-dk/chef_runner.rb +12 -4
  27. data/lib/chef-dk/command/base.rb +79 -79
  28. data/lib/chef-dk/command/clean_policy_cookbooks.rb +116 -116
  29. data/lib/chef-dk/command/clean_policy_revisions.rb +113 -113
  30. data/lib/chef-dk/command/delete_policy.rb +122 -122
  31. data/lib/chef-dk/command/delete_policy_group.rb +122 -122
  32. data/lib/chef-dk/command/diff.rb +316 -316
  33. data/lib/chef-dk/command/env.rb +90 -90
  34. data/lib/chef-dk/command/exec.rb +45 -45
  35. data/lib/chef-dk/command/gem.rb +47 -47
  36. data/lib/chef-dk/command/generator_commands/app.rb +107 -107
  37. data/lib/chef-dk/command/generator_commands/attribute.rb +37 -37
  38. data/lib/chef-dk/command/generator_commands/base.rb +3 -0
  39. data/lib/chef-dk/command/generator_commands/build_cookbook.rb +4 -4
  40. data/lib/chef-dk/command/generator_commands/chef_exts/generator_desc_resource.rb +85 -0
  41. data/lib/chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter.rb +39 -0
  42. data/lib/chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext.rb +40 -0
  43. data/lib/chef-dk/command/generator_commands/cookbook.rb +63 -8
  44. data/lib/chef-dk/command/generator_commands/cookbook_code_file.rb +100 -100
  45. data/lib/chef-dk/command/generator_commands/cookbook_file.rb +45 -45
  46. data/lib/chef-dk/command/generator_commands/generator_generator.rb +177 -177
  47. data/lib/chef-dk/command/generator_commands/lwrp.rb +36 -36
  48. data/lib/chef-dk/command/generator_commands/policyfile.rb +127 -127
  49. data/lib/chef-dk/command/generator_commands/recipe.rb +36 -36
  50. data/lib/chef-dk/command/generator_commands/repo.rb +125 -125
  51. data/lib/chef-dk/command/generator_commands/template.rb +46 -46
  52. data/lib/chef-dk/command/install.rb +121 -121
  53. data/lib/chef-dk/command/provision.rb +438 -438
  54. data/lib/chef-dk/command/push.rb +118 -118
  55. data/lib/chef-dk/command/push_archive.rb +126 -126
  56. data/lib/chef-dk/command/shell_init.rb +180 -180
  57. data/lib/chef-dk/command/show_policy.rb +165 -165
  58. data/lib/chef-dk/command/undelete.rb +155 -155
  59. data/lib/chef-dk/command/update.rb +148 -148
  60. data/lib/chef-dk/command/verify.rb +31 -26
  61. data/lib/chef-dk/completions/bash.sh.erb +5 -5
  62. data/lib/chef-dk/completions/chef.fish.erb +10 -10
  63. data/lib/chef-dk/completions/zsh.zsh.erb +21 -21
  64. data/lib/chef-dk/configurable.rb +69 -69
  65. data/lib/chef-dk/cookbook_metadata.rb +45 -45
  66. data/lib/chef-dk/cookbook_omnifetch.rb +32 -32
  67. data/lib/chef-dk/cookbook_profiler/git.rb +151 -151
  68. data/lib/chef-dk/cookbook_profiler/identifiers.rb +72 -72
  69. data/lib/chef-dk/cookbook_profiler/null_scm.rb +32 -32
  70. data/lib/chef-dk/exceptions.rb +129 -129
  71. data/lib/chef-dk/helpers.rb +10 -0
  72. data/lib/chef-dk/pager.rb +106 -106
  73. data/lib/chef-dk/policyfile/chef_repo_cookbook_source.rb +138 -138
  74. data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb +54 -54
  75. data/lib/chef-dk/policyfile/community_cookbook_source.rb +97 -97
  76. data/lib/chef-dk/policyfile/comparison_base.rb +124 -124
  77. data/lib/chef-dk/policyfile/cookbook_location_specification.rb +154 -154
  78. data/lib/chef-dk/policyfile/cookbook_locks.rb +466 -466
  79. data/lib/chef-dk/policyfile/cookbook_sources.rb +22 -22
  80. data/lib/chef-dk/policyfile/delivery_supermarket_source.rb +90 -90
  81. data/lib/chef-dk/policyfile/differ.rb +266 -266
  82. data/lib/chef-dk/policyfile/dsl.rb +261 -261
  83. data/lib/chef-dk/policyfile/lister.rb +232 -232
  84. data/lib/chef-dk/policyfile/null_cookbook_source.rb +45 -45
  85. data/lib/chef-dk/policyfile/read_cookbook_for_compat_mode_upload.rb +124 -124
  86. data/lib/chef-dk/policyfile/reports/install.rb +70 -70
  87. data/lib/chef-dk/policyfile/reports/table_printer.rb +58 -58
  88. data/lib/chef-dk/policyfile/reports/upload.rb +70 -70
  89. data/lib/chef-dk/policyfile/solution_dependencies.rb +298 -298
  90. data/lib/chef-dk/policyfile/storage_config.rb +100 -100
  91. data/lib/chef-dk/policyfile/undo_record.rb +142 -142
  92. data/lib/chef-dk/policyfile/undo_stack.rb +130 -130
  93. data/lib/chef-dk/policyfile/uploader.rb +213 -213
  94. data/lib/chef-dk/policyfile_compiler.rb +419 -419
  95. data/lib/chef-dk/policyfile_lock.rb +552 -552
  96. data/lib/chef-dk/policyfile_services/clean_policies.rb +95 -95
  97. data/lib/chef-dk/policyfile_services/clean_policy_cookbooks.rb +125 -125
  98. data/lib/chef-dk/policyfile_services/export_repo.rb +421 -421
  99. data/lib/chef-dk/policyfile_services/install.rb +126 -126
  100. data/lib/chef-dk/policyfile_services/push_archive.rb +204 -204
  101. data/lib/chef-dk/policyfile_services/rm_policy.rb +142 -142
  102. data/lib/chef-dk/policyfile_services/rm_policy_group.rb +86 -86
  103. data/lib/chef-dk/policyfile_services/show_policy.rb +237 -237
  104. data/lib/chef-dk/policyfile_services/undelete.rb +108 -108
  105. data/lib/chef-dk/policyfile_services/update_attributes.rb +104 -104
  106. data/lib/chef-dk/service_exception_inspectors.rb +25 -25
  107. data/lib/chef-dk/service_exception_inspectors/base.rb +40 -40
  108. data/lib/chef-dk/service_exception_inspectors/http.rb +121 -121
  109. data/lib/chef-dk/service_exceptions.rb +143 -143
  110. data/lib/chef-dk/shell_out.rb +36 -36
  111. data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile +3 -3
  112. data/lib/chef-dk/skeletons/code_generator/files/default/{build-cookbook → build_cookbook}/.kitchen.yml +2 -2
  113. data/lib/chef-dk/skeletons/code_generator/files/default/{build-cookbook → build_cookbook}/README.md +11 -11
  114. data/lib/chef-dk/skeletons/code_generator/files/default/{build-cookbook → build_cookbook}/test-fixture-recipe.rb +0 -0
  115. data/lib/chef-dk/skeletons/code_generator/files/default/chefignore +102 -102
  116. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README-policy.md +9 -9
  117. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md +54 -54
  118. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-config.json +2 -2
  119. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml +21 -0
  120. data/lib/chef-dk/skeletons/code_generator/files/default/gitignore +16 -16
  121. data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md +9 -13
  122. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/README.md +5 -5
  123. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb +7 -7
  124. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb +3 -3
  125. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb +8 -8
  126. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md +3 -5
  127. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json +3 -3
  128. data/lib/chef-dk/skeletons/code_generator/files/default/repo/dot-chef-repo.txt +6 -6
  129. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md +9 -9
  130. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/example.json +12 -12
  131. data/lib/chef-dk/skeletons/code_generator/files/default/repo/policies/README.md +24 -24
  132. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md +9 -9
  133. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/example.json +12 -12
  134. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb +2 -2
  135. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper_policyfile.rb +2 -2
  136. data/lib/chef-dk/skeletons/code_generator/metadata.rb +8 -8
  137. data/lib/chef-dk/skeletons/code_generator/recipes/app.rb +5 -13
  138. data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb +12 -12
  139. data/lib/chef-dk/skeletons/code_generator/recipes/build_cookbook.rb +30 -7
  140. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb +12 -14
  141. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb +24 -24
  142. data/lib/chef-dk/skeletons/code_generator/recipes/lwrp.rb +23 -23
  143. data/lib/chef-dk/skeletons/code_generator/recipes/policyfile.rb +8 -8
  144. data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb +40 -27
  145. data/lib/chef-dk/skeletons/code_generator/recipes/repo.rb +67 -67
  146. data/lib/chef-dk/skeletons/code_generator/recipes/template.rb +1 -1
  147. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.all_rights.erb +3 -3
  148. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv2.erb +339 -339
  149. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv3.erb +674 -674
  150. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.mit.erb +21 -21
  151. data/lib/chef-dk/skeletons/code_generator/templates/default/Policyfile.rb.erb +25 -25
  152. data/lib/chef-dk/skeletons/code_generator/templates/default/README.md.erb +4 -4
  153. data/lib/chef-dk/skeletons/code_generator/templates/default/{build-cookbook → build_cookbook}/Berksfile.erb +0 -0
  154. data/lib/chef-dk/skeletons/code_generator/templates/default/{build-cookbook → build_cookbook}/metadata.rb.erb +1 -1
  155. data/lib/chef-dk/skeletons/code_generator/templates/default/{build-cookbook → build_cookbook}/recipe.rb.erb +1 -1
  156. data/lib/chef-dk/skeletons/code_generator/templates/default/inspec_default_test.rb.erb +18 -0
  157. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb +2 -5
  158. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_policyfile.yml.erb +2 -5
  159. data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb +7 -7
  160. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb +5 -5
  161. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb +20 -20
  162. data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb +11 -11
  163. data/lib/chef-dk/ui.rb +58 -58
  164. data/lib/chef-dk/version.rb +1 -1
  165. data/lib/kitchen/provisioner/policyfile_zero.rb +195 -195
  166. data/omnibus_overrides.rb +3 -3
  167. data/spec/shared/a_file_generator.rb +125 -125
  168. data/spec/shared/a_generated_file.rb +12 -12
  169. data/spec/shared/command_with_ui_object.rb +11 -11
  170. data/spec/shared/fixture_cookbook_checksums.rb +47 -47
  171. data/spec/shared/setup_git_cookbooks.rb +53 -53
  172. data/spec/spec_helper.rb +51 -51
  173. data/spec/test_helpers.rb +84 -84
  174. data/spec/unit/chef_runner_spec.rb +7 -5
  175. data/spec/unit/command/clean_policy_cookbooks_spec.rb +181 -181
  176. data/spec/unit/command/clean_policy_revisions_spec.rb +181 -181
  177. data/spec/unit/command/delete_policy_group_spec.rb +207 -207
  178. data/spec/unit/command/delete_policy_spec.rb +207 -207
  179. data/spec/unit/command/diff_spec.rb +312 -312
  180. data/spec/unit/command/env_spec.rb +52 -52
  181. data/spec/unit/command/exec_spec.rb +179 -179
  182. data/spec/unit/command/export_spec.rb +200 -200
  183. data/spec/unit/command/generate_spec.rb +142 -142
  184. data/spec/unit/command/generator_commands/app_spec.rb +5 -8
  185. data/spec/unit/command/generator_commands/attribute_spec.rb +32 -32
  186. data/spec/unit/command/generator_commands/base_spec.rb +136 -136
  187. data/spec/unit/command/generator_commands/build_cookbook_spec.rb +9 -9
  188. data/spec/unit/command/generator_commands/chef_exts/generator_desc_resource_spec.rb +97 -0
  189. data/spec/unit/command/generator_commands/chef_exts/recipe_dsl_ext_spec.rb +111 -0
  190. data/spec/unit/command/generator_commands/cookbook_file_spec.rb +32 -32
  191. data/spec/unit/command/generator_commands/cookbook_spec.rb +291 -111
  192. data/spec/unit/command/generator_commands/generator_generator_spec.rb +229 -229
  193. data/spec/unit/command/generator_commands/lwrp_spec.rb +32 -32
  194. data/spec/unit/command/generator_commands/policyfile_spec.rb +225 -225
  195. data/spec/unit/command/generator_commands/recipe_spec.rb +36 -34
  196. data/spec/unit/command/generator_commands/template_spec.rb +1 -1
  197. data/spec/unit/command/install_spec.rb +179 -179
  198. data/spec/unit/command/provision_spec.rb +592 -592
  199. data/spec/unit/command/push_archive_spec.rb +153 -153
  200. data/spec/unit/command/push_spec.rb +199 -199
  201. data/spec/unit/command/shell_init_spec.rb +329 -329
  202. data/spec/unit/command/show_policy_spec.rb +235 -235
  203. data/spec/unit/command/undelete_spec.rb +246 -246
  204. data/spec/unit/command/update_spec.rb +275 -275
  205. data/spec/unit/command/verify_spec.rb +0 -1
  206. data/spec/unit/commands_map_spec.rb +57 -57
  207. data/spec/unit/configurable_spec.rb +41 -41
  208. data/spec/unit/cookbook_metadata_spec.rb +98 -98
  209. data/spec/unit/cookbook_profiler/git_spec.rb +176 -176
  210. data/spec/unit/cookbook_profiler/identifiers_spec.rb +83 -83
  211. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb +9 -9
  212. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb +9 -9
  213. data/spec/unit/fixtures/command/cli_test_command.rb +26 -26
  214. data/spec/unit/fixtures/command/explicit_path_example.rb +7 -7
  215. data/spec/unit/fixtures/configurable/test_config_loader.rb +5 -5
  216. data/spec/unit/fixtures/configurable/test_configurable.rb +10 -10
  217. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  218. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile +3 -3
  219. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  220. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/chefignore +96 -96
  221. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  222. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  223. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/.kitchen.yml +16 -16
  224. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/Berksfile +3 -3
  225. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/README.md +4 -4
  226. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/chefignore +96 -96
  227. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/metadata.rb +8 -8
  228. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/recipes/default.rb +8 -8
  229. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/.kitchen.yml +16 -16
  230. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/Berksfile +3 -3
  231. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/README.md +4 -4
  232. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/chefignore +96 -96
  233. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/metadata.rb +8 -8
  234. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/recipes/default.rb +8 -8
  235. data/spec/unit/fixtures/cookbooks_api/pruned_small_universe.json +1321 -1321
  236. data/spec/unit/fixtures/cookbooks_api/small_universe.json +2987 -2987
  237. data/spec/unit/fixtures/cookbooks_api/universe.json +1 -1
  238. data/spec/unit/fixtures/cookbooks_api/update_fixtures.rb +36 -36
  239. data/spec/unit/fixtures/dev_cookbooks/README.md +16 -16
  240. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/integration_test +2 -2
  241. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/verify_me +5 -5
  242. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef/verify_me +3 -3
  243. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/test-kitchen/verify_me +2 -2
  244. data/spec/unit/fixtures/example_cookbook/.gitignore +17 -17
  245. data/spec/unit/fixtures/example_cookbook/.kitchen.yml +16 -16
  246. data/spec/unit/fixtures/example_cookbook/Berksfile +3 -3
  247. data/spec/unit/fixtures/example_cookbook/README.md +4 -4
  248. data/spec/unit/fixtures/example_cookbook/chefignore +96 -96
  249. data/spec/unit/fixtures/example_cookbook/metadata.rb +8 -8
  250. data/spec/unit/fixtures/example_cookbook/recipes/default.rb +8 -8
  251. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore +17 -17
  252. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml +16 -16
  253. data/spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile +3 -3
  254. data/spec/unit/fixtures/example_cookbook_metadata_json_only/README.md +4 -4
  255. data/spec/unit/fixtures/example_cookbook_metadata_json_only/chefignore +96 -96
  256. data/spec/unit/fixtures/example_cookbook_metadata_json_only/metadata.json +5 -5
  257. data/spec/unit/fixtures/example_cookbook_metadata_json_only/recipes/default.rb +8 -8
  258. data/spec/unit/fixtures/example_cookbook_no_metadata/.gitignore +17 -17
  259. data/spec/unit/fixtures/example_cookbook_no_metadata/.kitchen.yml +16 -16
  260. data/spec/unit/fixtures/example_cookbook_no_metadata/Berksfile +3 -3
  261. data/spec/unit/fixtures/example_cookbook_no_metadata/README.md +4 -4
  262. data/spec/unit/fixtures/example_cookbook_no_metadata/chefignore +96 -96
  263. data/spec/unit/fixtures/example_cookbook_no_metadata/recipes/default.rb +8 -8
  264. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/README.md +4 -4
  265. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/chefignore +96 -96
  266. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/metadata.rb +8 -8
  267. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/recipes/default.rb +8 -8
  268. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/Berksfile +3 -3
  269. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/README.md +4 -4
  270. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/chefignore +96 -96
  271. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/metadata.rb +9 -9
  272. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/recipes/default.rb +8 -8
  273. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/.kitchen.yml +16 -16
  274. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/Berksfile +3 -3
  275. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/README.md +4 -4
  276. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/chefignore +96 -96
  277. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/metadata.rb +8 -8
  278. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/recipes/default.rb +8 -8
  279. data/spec/unit/fixtures/local_path_cookbooks/metadata-missing/README.md +2 -2
  280. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  281. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  282. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  283. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  284. data/spec/unit/helpers_spec.rb +14 -5
  285. data/spec/unit/pager_spec.rb +119 -119
  286. data/spec/unit/policyfile/chef_repo_cookbook_source_spec.rb +93 -93
  287. data/spec/unit/policyfile/chef_server_cookbook_source_spec.rb +34 -34
  288. data/spec/unit/policyfile/community_cookbook_source_spec.rb +84 -84
  289. data/spec/unit/policyfile/comparison_base_spec.rb +343 -343
  290. data/spec/unit/policyfile/cookbook_location_specification_spec.rb +277 -277
  291. data/spec/unit/policyfile/cookbook_locks_spec.rb +529 -529
  292. data/spec/unit/policyfile/delivery_supermarket_source_spec.rb +130 -130
  293. data/spec/unit/policyfile/differ_spec.rb +687 -687
  294. data/spec/unit/policyfile/lister_spec.rb +272 -272
  295. data/spec/unit/policyfile/null_cookbook_source_spec.rb +35 -35
  296. data/spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb +92 -92
  297. data/spec/unit/policyfile/reports/install_spec.rb +115 -115
  298. data/spec/unit/policyfile/reports/upload_spec.rb +96 -96
  299. data/spec/unit/policyfile/solution_dependencies_spec.rb +145 -145
  300. data/spec/unit/policyfile/storage_config_spec.rb +172 -172
  301. data/spec/unit/policyfile/undo_record_spec.rb +260 -260
  302. data/spec/unit/policyfile/undo_stack_spec.rb +266 -266
  303. data/spec/unit/policyfile/uploader_spec.rb +410 -410
  304. data/spec/unit/policyfile_demands_spec.rb +1203 -1203
  305. data/spec/unit/policyfile_evaluation_spec.rb +642 -642
  306. data/spec/unit/policyfile_lock_build_spec.rb +1056 -1056
  307. data/spec/unit/policyfile_lock_install_spec.rb +138 -138
  308. data/spec/unit/policyfile_lock_serialization_spec.rb +425 -425
  309. data/spec/unit/policyfile_lock_validation_spec.rb +611 -611
  310. data/spec/unit/policyfile_services/clean_policies_spec.rb +236 -236
  311. data/spec/unit/policyfile_services/clean_policy_cookbooks_spec.rb +275 -275
  312. data/spec/unit/policyfile_services/export_repo_spec.rb +481 -481
  313. data/spec/unit/policyfile_services/install_spec.rb +211 -211
  314. data/spec/unit/policyfile_services/push_archive_spec.rb +378 -378
  315. data/spec/unit/policyfile_services/push_spec.rb +233 -233
  316. data/spec/unit/policyfile_services/rm_policy_group_spec.rb +241 -241
  317. data/spec/unit/policyfile_services/rm_policy_spec.rb +266 -266
  318. data/spec/unit/policyfile_services/show_policy_spec.rb +889 -889
  319. data/spec/unit/policyfile_services/undelete_spec.rb +304 -304
  320. data/spec/unit/policyfile_services/update_attributes_spec.rb +217 -217
  321. data/spec/unit/service_exception_inspectors/base_spec.rb +43 -43
  322. data/spec/unit/service_exception_inspectors/http_spec.rb +140 -140
  323. data/spec/unit/shell_out_spec.rb +34 -34
  324. data/tasks/bin/bundle-platform +0 -0
  325. data/tasks/bin/bundle-platform.bat +0 -0
  326. data/tasks/bin/create-override-gemfile +0 -0
  327. data/version_policy.rb +4 -3
  328. data/warning.txt +9 -9
  329. metadata +23 -10
  330. data/lib/chef-dk/skeletons/code_generator/files/default/serverspec_spec_helper.rb +0 -8
  331. data/lib/chef-dk/skeletons/code_generator/templates/default/serverspec_default_spec.rb.erb +0 -9
@@ -1,122 +1,122 @@
1
- #
2
- # Copyright:: Copyright (c) 2015 Chef Software Inc.
3
- # License:: Apache License, Version 2.0
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
- #
17
-
18
- require 'chef-dk/command/base'
19
- require 'chef-dk/ui'
20
- require 'chef-dk/configurable'
21
- require 'chef-dk/policyfile_services/rm_policy_group'
22
-
23
- module ChefDK
24
- module Command
25
-
26
-
27
- class DeletePolicyGroup < Base
28
-
29
- banner(<<-BANNER)
30
- Usage: chef delete-policy-group POLICY_GROUP [options]
31
-
32
- `chef delete-policy-group POLICY_GROUP` deletes the policy group POLICY_GROUP on
33
- the configured Chef Server. Policy Revisions associated to the policy group are
34
- not deleted. The state of the policy group will be backed up locally, allowing
35
- you to undo this operation via the `chef undelete` command.
36
-
37
- See our detailed README for more information:
38
-
39
- https://github.com/chef/chef-dk/blob/master/POLICYFILE_README.md
40
-
41
- Options:
42
-
43
- BANNER
44
-
45
- option :config_file,
46
- short: "-c CONFIG_FILE",
47
- long: "--config CONFIG_FILE",
48
- description: "Path to configuration file"
49
-
50
- option :debug,
51
- short: "-D",
52
- long: "--debug",
53
- description: "Enable stacktraces and other debug output",
54
- default: false
55
-
56
- include Configurable
57
-
58
- attr_accessor :ui
59
-
60
- attr_reader :policy_group
61
-
62
- def initialize(*args)
63
- super
64
- @policy_group = nil
65
- @rm_policy_group_service = nil
66
- @ui = UI.new
67
- end
68
-
69
- def run(params)
70
- return 1 unless apply_params!(params)
71
- rm_policy_group_service.run
72
- ui.msg("This operation can be reversed by running `chef undelete --last`.")
73
- 0
74
- rescue PolicyfileServiceError => e
75
- handle_error(e)
76
- 1
77
- end
78
-
79
- def rm_policy_group_service
80
- @rm_policy_group_service ||=
81
- PolicyfileServices::RmPolicyGroup.new(config: chef_config,
82
- ui: ui,
83
- policy_group: policy_group)
84
- end
85
-
86
- def debug?
87
- !!config[:debug]
88
- end
89
-
90
- def handle_error(error)
91
- ui.err("Error: #{error.message}")
92
- if error.respond_to?(:reason)
93
- ui.err("Reason: #{error.reason}")
94
- ui.err("")
95
- ui.err(error.extended_error_info) if debug?
96
- ui.err(error.cause.backtrace.join("\n")) if debug?
97
- end
98
- end
99
-
100
- def apply_params!(params)
101
- remaining_args = parse_options(params)
102
-
103
- if remaining_args.size == 1
104
- @policy_group = remaining_args.first
105
- true
106
- elsif remaining_args.empty?
107
- ui.err("You must specify the POLICY_GROUP to delete.")
108
- ui.err("")
109
- ui.err(opt_parser)
110
- false
111
- else
112
- ui.err("Too many arguments")
113
- ui.err("")
114
- ui.err(opt_parser)
115
- false
116
- end
117
- end
118
-
119
- end
120
- end
121
- end
122
-
1
+ #
2
+ # Copyright:: Copyright (c) 2015 Chef Software Inc.
3
+ # License:: Apache License, Version 2.0
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ #
17
+
18
+ require 'chef-dk/command/base'
19
+ require 'chef-dk/ui'
20
+ require 'chef-dk/configurable'
21
+ require 'chef-dk/policyfile_services/rm_policy_group'
22
+
23
+ module ChefDK
24
+ module Command
25
+
26
+
27
+ class DeletePolicyGroup < Base
28
+
29
+ banner(<<-BANNER)
30
+ Usage: chef delete-policy-group POLICY_GROUP [options]
31
+
32
+ `chef delete-policy-group POLICY_GROUP` deletes the policy group POLICY_GROUP on
33
+ the configured Chef Server. Policy Revisions associated to the policy group are
34
+ not deleted. The state of the policy group will be backed up locally, allowing
35
+ you to undo this operation via the `chef undelete` command.
36
+
37
+ See our detailed README for more information:
38
+
39
+ https://github.com/chef/chef-dk/blob/master/POLICYFILE_README.md
40
+
41
+ Options:
42
+
43
+ BANNER
44
+
45
+ option :config_file,
46
+ short: "-c CONFIG_FILE",
47
+ long: "--config CONFIG_FILE",
48
+ description: "Path to configuration file"
49
+
50
+ option :debug,
51
+ short: "-D",
52
+ long: "--debug",
53
+ description: "Enable stacktraces and other debug output",
54
+ default: false
55
+
56
+ include Configurable
57
+
58
+ attr_accessor :ui
59
+
60
+ attr_reader :policy_group
61
+
62
+ def initialize(*args)
63
+ super
64
+ @policy_group = nil
65
+ @rm_policy_group_service = nil
66
+ @ui = UI.new
67
+ end
68
+
69
+ def run(params)
70
+ return 1 unless apply_params!(params)
71
+ rm_policy_group_service.run
72
+ ui.msg("This operation can be reversed by running `chef undelete --last`.")
73
+ 0
74
+ rescue PolicyfileServiceError => e
75
+ handle_error(e)
76
+ 1
77
+ end
78
+
79
+ def rm_policy_group_service
80
+ @rm_policy_group_service ||=
81
+ PolicyfileServices::RmPolicyGroup.new(config: chef_config,
82
+ ui: ui,
83
+ policy_group: policy_group)
84
+ end
85
+
86
+ def debug?
87
+ !!config[:debug]
88
+ end
89
+
90
+ def handle_error(error)
91
+ ui.err("Error: #{error.message}")
92
+ if error.respond_to?(:reason)
93
+ ui.err("Reason: #{error.reason}")
94
+ ui.err("")
95
+ ui.err(error.extended_error_info) if debug?
96
+ ui.err(error.cause.backtrace.join("\n")) if debug?
97
+ end
98
+ end
99
+
100
+ def apply_params!(params)
101
+ remaining_args = parse_options(params)
102
+
103
+ if remaining_args.size == 1
104
+ @policy_group = remaining_args.first
105
+ true
106
+ elsif remaining_args.empty?
107
+ ui.err("You must specify the POLICY_GROUP to delete.")
108
+ ui.err("")
109
+ ui.err(opt_parser)
110
+ false
111
+ else
112
+ ui.err("Too many arguments")
113
+ ui.err("")
114
+ ui.err(opt_parser)
115
+ false
116
+ end
117
+ end
118
+
119
+ end
120
+ end
121
+ end
122
+
@@ -1,316 +1,316 @@
1
- #
2
- # Copyright:: Copyright (c) 2015 Chef Software Inc.
3
- # License:: Apache License, Version 2.0
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
- #
17
-
18
- require 'chef-dk/command/base'
19
- require 'chef-dk/ui'
20
- require 'chef-dk/pager'
21
- require 'chef-dk/policyfile/differ'
22
- require 'chef-dk/policyfile/comparison_base'
23
- require 'chef-dk/policyfile/storage_config'
24
- require 'chef-dk/configurable'
25
- require 'chef-dk/authenticated_http'
26
-
27
- module ChefDK
28
- module Command
29
-
30
- class Diff < Base
31
-
32
- include Configurable
33
- include Policyfile::StorageConfigDelegation
34
-
35
- banner(<<-BANNER)
36
- Usage: chef diff [POLICYFILE] [--head | --git GIT_REF | POLICY_GROUP | POLICY_GROUP...POLICY_GROUP ]
37
-
38
- `chef diff` displays an itemized diff comparing two revisions of a
39
- Policyfile lock.
40
-
41
- When the `--git` option is given, `chef diff` either compares a given
42
- git reference against the current lockfile revision on disk or compares
43
- between two git references. Examples:
44
-
45
- * `chef diff --git HEAD`: compares the current lock with the latest
46
- commit on the current branch.
47
- * `chef diff --git master` compares the current lock with the latest
48
- commit to master.
49
- * `chef diff --git v1.0.0`: compares the current lock with the revision
50
- as of the `v1.0.0` tag.
51
- * `chef diff --git master...dev-branch` compares the Policyfile lock on
52
- master with the revision on the `dev-branch` branch.
53
- * `chef diff --git v1.0.0...master` compares the Policyfile lock at the
54
- `v1.0.0` tag with the lastest revision on the master branch.
55
-
56
- `chef diff --head` is a shortcut for `chef diff --git HEAD`.
57
-
58
- When no git-specific flag is given, `chef diff` either compares the
59
- current lockfile revision on disk to one on the server or compares two
60
- lockfiles on the server. Lockfiles on the Chef Server are specified by
61
- Policy Group. Examples:
62
-
63
- * `chef diff staging`: compares the current lock with the one currently
64
- assigned to the `staging` Policy Group.
65
- * `chef diff production...staging` compares the lock currently assigned
66
- to the `production` Policy Group to the lock currently assigned to the
67
- `staging` Policy Group.
68
-
69
- Options:
70
- BANNER
71
-
72
- option :git,
73
- short: "-g GIT_REF",
74
- long: "--git GIT_REF",
75
- description: "Compare local lock against GIT_REF, or between two git commits"
76
-
77
- option :head,
78
- long: "--head",
79
- description: "Compare local lock against last git commit",
80
- boolean: true
81
-
82
- option :pager,
83
- long: "--[no-]pager",
84
- description: "Enable/disable paged diff ouput (default: enabled)",
85
- default: true,
86
- boolean: true
87
-
88
- option :config_file,
89
- short: "-c CONFIG_FILE",
90
- long: "--config CONFIG_FILE",
91
- description: "Path to configuration file"
92
-
93
- option :debug,
94
- short: "-D",
95
- long: "--debug",
96
- description: "Enable stacktraces and other debug output",
97
- default: false
98
-
99
- attr_accessor :ui
100
-
101
- attr_reader :old_base
102
- attr_reader :new_base
103
-
104
- attr_reader :storage_config
105
-
106
- def initialize(*args)
107
- super
108
-
109
- @ui = UI.new
110
-
111
- @old_base = nil
112
- @new_base = nil
113
- @policyfile_relative_path = nil
114
- @storage_config = nil
115
- @http_client = nil
116
-
117
- @old_lock = nil
118
- @new_lock = nil
119
- end
120
-
121
- def debug?
122
- !!config[:debug]
123
- end
124
-
125
- def run(params = [])
126
- return 1 unless apply_params!(params)
127
- print_diff
128
- 0
129
- rescue PolicyfileServiceError => e
130
- handle_error(e)
131
- 1
132
- end
133
-
134
- def handle_error(error)
135
- ui.err("Error: #{error.message}")
136
- if error.respond_to?(:reason)
137
- ui.err("Reason: #{error.reason}")
138
- ui.err("")
139
- ui.err(error.extended_error_info) if debug?
140
- ui.err(error.cause.backtrace.join("\n")) if debug?
141
- end
142
- end
143
-
144
- def print_diff
145
- # eagerly evaluate locks so we hit any errors before we've entered
146
- # pagerland. Also, git commands behave weirdly when run while the pager
147
- # is active, doing this eagerly also avoids that issue
148
- materialize_locks
149
- Pager.new(enable_pager: config[:pager]).with_pager do |pager|
150
- differ = differ(pager.ui)
151
- differ.run_report
152
- end
153
- end
154
-
155
- def differ(ui = ui())
156
- Policyfile::Differ.new(old_name: old_base.name,
157
- old_lock: old_lock,
158
- new_name: new_base.name,
159
- new_lock: new_lock,
160
- ui: ui)
161
- end
162
-
163
- def http_client
164
- @http_client ||= ChefDK::AuthenticatedHTTP.new(chef_config.chef_server_url,
165
- signing_key_filename: chef_config.client_key,
166
- client_name: chef_config.node_name)
167
- end
168
-
169
- def old_lock
170
- materialize_locks unless @old_lock
171
- @old_lock
172
- end
173
-
174
- def new_lock
175
- materialize_locks unless @new_lock
176
- @new_lock
177
- end
178
-
179
- def policy_name
180
- local_lock["name"]
181
- end
182
-
183
- def local_lock
184
- @local_lock ||= local_lock_comparison_base.lock
185
- end
186
-
187
- # ComparisonBase for the local lockfile. This is used to get the
188
- # policy_name which is needed to query the server for the lockfile of a
189
- # particular policy_group.
190
- def local_lock_comparison_base
191
- Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
192
- end
193
-
194
- def policyfile_lock_relpath
195
- storage_config.policyfile_lock_filename
196
- end
197
-
198
- def apply_params!(params)
199
- remaining_args = parse_options(params)
200
-
201
- if no_comparison_specified?(remaining_args)
202
- ui.err("No comparison specified")
203
- ui.err("")
204
- ui.err(opt_parser)
205
- false
206
- elsif conflicting_args_and_opts_given?(remaining_args)
207
- ui.err("Conflicting arguments and options: git and Policy Group comparisons cannot be mixed")
208
- ui.err("")
209
- ui.err(opt_parser)
210
- false
211
- elsif conflicting_git_options_given?
212
- ui.err("Conflicting git options: --head and --git are exclusive")
213
- ui.err("")
214
- ui.err(opt_parser)
215
-
216
- false
217
- elsif config[:head]
218
- set_policyfile_path_from_args(remaining_args)
219
- @old_base = Policyfile::ComparisonBase::Git.new("HEAD", policyfile_lock_relpath)
220
- @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
221
- true
222
- elsif config[:git]
223
- set_policyfile_path_from_args(remaining_args)
224
- parse_git_comparison(config[:git])
225
- else
226
- set_policyfile_path_from_args(remaining_args)
227
- parse_server_comparison(remaining_args)
228
- end
229
- end
230
-
231
- def parse_server_comparison(args)
232
- comparison_string = args.last
233
- if comparison_string.include?("...")
234
- old_pgroup, new_pgroup, *extra = comparison_string.split("...")
235
- @old_base, @new_base = [old_pgroup, new_pgroup].map do |g|
236
- Policyfile::ComparisonBase::PolicyGroup.new(g, policy_name, http_client)
237
- end
238
-
239
- unless extra.empty?
240
- ui.err("Unable to parse policy group comparison `#{comparison_string}`. Only 2 references can be specified.")
241
- return false
242
- end
243
- else
244
- @old_base = Policyfile::ComparisonBase::PolicyGroup.new(comparison_string, policy_name, http_client)
245
- @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
246
- end
247
- true
248
- end
249
-
250
- def parse_git_comparison(git_ref)
251
- if git_ref.include?("...")
252
- old_ref, new_ref, *extra = git_ref.split("...")
253
- @old_base, @new_base = [old_ref, new_ref].map do |r|
254
- Policyfile::ComparisonBase::Git.new(r, policyfile_lock_relpath)
255
- end
256
-
257
- unless extra.empty?
258
- ui.err("Unable to parse git comparison `#{git_ref}`. Only 2 references can be specified.")
259
- return false
260
- end
261
- else
262
- @old_base = Policyfile::ComparisonBase::Git.new(git_ref, policyfile_lock_relpath)
263
- @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
264
- end
265
- true
266
- end
267
-
268
- def no_comparison_specified?(args)
269
- !policy_group_comparison?(args) && !config[:head] && !config[:git]
270
- end
271
-
272
- def conflicting_args_and_opts_given?(args)
273
- (config[:git] || config[:head]) && policy_group_comparison?(args)
274
- end
275
-
276
- def conflicting_git_options_given?
277
- config[:git] && config[:head]
278
- end
279
-
280
- def comparing_policy_groups?
281
- !(config[:git] || config[:head])
282
- end
283
-
284
- # Try to detect if the only argument given is a policyfile path. This is
285
- # necessary because we support an optional argument with the path to the
286
- # ruby policyfile. It would be easier if we used an option like `-f`, but
287
- # that would be inconsistent with other commands (`chef install`, `chef
288
- # push`, etc.).
289
- def policy_group_comparison?(args)
290
- return false if args.empty?
291
- return true if args.size > 1
292
- !(args.first =~ /\.rb\Z/)
293
- end
294
-
295
- def set_policyfile_path_from_args(args)
296
- policyfile_relative_path =
297
- if !comparing_policy_groups?
298
- args.first || "Policyfile.rb"
299
- elsif args.size == 1
300
- "Policyfile.rb"
301
- else
302
- args.first
303
- end
304
- @storage_config = Policyfile::StorageConfig.new.use_policyfile(policyfile_relative_path)
305
- end
306
-
307
- def materialize_locks
308
- @old_lock = old_base.lock
309
- @new_lock = new_base.lock
310
- end
311
-
312
- end
313
-
314
- end
315
- end
316
-
1
+ #
2
+ # Copyright:: Copyright (c) 2015 Chef Software Inc.
3
+ # License:: Apache License, Version 2.0
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ #
17
+
18
+ require 'chef-dk/command/base'
19
+ require 'chef-dk/ui'
20
+ require 'chef-dk/pager'
21
+ require 'chef-dk/policyfile/differ'
22
+ require 'chef-dk/policyfile/comparison_base'
23
+ require 'chef-dk/policyfile/storage_config'
24
+ require 'chef-dk/configurable'
25
+ require 'chef-dk/authenticated_http'
26
+
27
+ module ChefDK
28
+ module Command
29
+
30
+ class Diff < Base
31
+
32
+ include Configurable
33
+ include Policyfile::StorageConfigDelegation
34
+
35
+ banner(<<-BANNER)
36
+ Usage: chef diff [POLICYFILE] [--head | --git GIT_REF | POLICY_GROUP | POLICY_GROUP...POLICY_GROUP ]
37
+
38
+ `chef diff` displays an itemized diff comparing two revisions of a
39
+ Policyfile lock.
40
+
41
+ When the `--git` option is given, `chef diff` either compares a given
42
+ git reference against the current lockfile revision on disk or compares
43
+ between two git references. Examples:
44
+
45
+ * `chef diff --git HEAD`: compares the current lock with the latest
46
+ commit on the current branch.
47
+ * `chef diff --git master` compares the current lock with the latest
48
+ commit to master.
49
+ * `chef diff --git v1.0.0`: compares the current lock with the revision
50
+ as of the `v1.0.0` tag.
51
+ * `chef diff --git master...dev-branch` compares the Policyfile lock on
52
+ master with the revision on the `dev-branch` branch.
53
+ * `chef diff --git v1.0.0...master` compares the Policyfile lock at the
54
+ `v1.0.0` tag with the lastest revision on the master branch.
55
+
56
+ `chef diff --head` is a shortcut for `chef diff --git HEAD`.
57
+
58
+ When no git-specific flag is given, `chef diff` either compares the
59
+ current lockfile revision on disk to one on the server or compares two
60
+ lockfiles on the server. Lockfiles on the Chef Server are specified by
61
+ Policy Group. Examples:
62
+
63
+ * `chef diff staging`: compares the current lock with the one currently
64
+ assigned to the `staging` Policy Group.
65
+ * `chef diff production...staging` compares the lock currently assigned
66
+ to the `production` Policy Group to the lock currently assigned to the
67
+ `staging` Policy Group.
68
+
69
+ Options:
70
+ BANNER
71
+
72
+ option :git,
73
+ short: "-g GIT_REF",
74
+ long: "--git GIT_REF",
75
+ description: "Compare local lock against GIT_REF, or between two git commits"
76
+
77
+ option :head,
78
+ long: "--head",
79
+ description: "Compare local lock against last git commit",
80
+ boolean: true
81
+
82
+ option :pager,
83
+ long: "--[no-]pager",
84
+ description: "Enable/disable paged diff ouput (default: enabled)",
85
+ default: true,
86
+ boolean: true
87
+
88
+ option :config_file,
89
+ short: "-c CONFIG_FILE",
90
+ long: "--config CONFIG_FILE",
91
+ description: "Path to configuration file"
92
+
93
+ option :debug,
94
+ short: "-D",
95
+ long: "--debug",
96
+ description: "Enable stacktraces and other debug output",
97
+ default: false
98
+
99
+ attr_accessor :ui
100
+
101
+ attr_reader :old_base
102
+ attr_reader :new_base
103
+
104
+ attr_reader :storage_config
105
+
106
+ def initialize(*args)
107
+ super
108
+
109
+ @ui = UI.new
110
+
111
+ @old_base = nil
112
+ @new_base = nil
113
+ @policyfile_relative_path = nil
114
+ @storage_config = nil
115
+ @http_client = nil
116
+
117
+ @old_lock = nil
118
+ @new_lock = nil
119
+ end
120
+
121
+ def debug?
122
+ !!config[:debug]
123
+ end
124
+
125
+ def run(params = [])
126
+ return 1 unless apply_params!(params)
127
+ print_diff
128
+ 0
129
+ rescue PolicyfileServiceError => e
130
+ handle_error(e)
131
+ 1
132
+ end
133
+
134
+ def handle_error(error)
135
+ ui.err("Error: #{error.message}")
136
+ if error.respond_to?(:reason)
137
+ ui.err("Reason: #{error.reason}")
138
+ ui.err("")
139
+ ui.err(error.extended_error_info) if debug?
140
+ ui.err(error.cause.backtrace.join("\n")) if debug?
141
+ end
142
+ end
143
+
144
+ def print_diff
145
+ # eagerly evaluate locks so we hit any errors before we've entered
146
+ # pagerland. Also, git commands behave weirdly when run while the pager
147
+ # is active, doing this eagerly also avoids that issue
148
+ materialize_locks
149
+ Pager.new(enable_pager: config[:pager]).with_pager do |pager|
150
+ differ = differ(pager.ui)
151
+ differ.run_report
152
+ end
153
+ end
154
+
155
+ def differ(ui = ui())
156
+ Policyfile::Differ.new(old_name: old_base.name,
157
+ old_lock: old_lock,
158
+ new_name: new_base.name,
159
+ new_lock: new_lock,
160
+ ui: ui)
161
+ end
162
+
163
+ def http_client
164
+ @http_client ||= ChefDK::AuthenticatedHTTP.new(chef_config.chef_server_url,
165
+ signing_key_filename: chef_config.client_key,
166
+ client_name: chef_config.node_name)
167
+ end
168
+
169
+ def old_lock
170
+ materialize_locks unless @old_lock
171
+ @old_lock
172
+ end
173
+
174
+ def new_lock
175
+ materialize_locks unless @new_lock
176
+ @new_lock
177
+ end
178
+
179
+ def policy_name
180
+ local_lock["name"]
181
+ end
182
+
183
+ def local_lock
184
+ @local_lock ||= local_lock_comparison_base.lock
185
+ end
186
+
187
+ # ComparisonBase for the local lockfile. This is used to get the
188
+ # policy_name which is needed to query the server for the lockfile of a
189
+ # particular policy_group.
190
+ def local_lock_comparison_base
191
+ Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
192
+ end
193
+
194
+ def policyfile_lock_relpath
195
+ storage_config.policyfile_lock_filename
196
+ end
197
+
198
+ def apply_params!(params)
199
+ remaining_args = parse_options(params)
200
+
201
+ if no_comparison_specified?(remaining_args)
202
+ ui.err("No comparison specified")
203
+ ui.err("")
204
+ ui.err(opt_parser)
205
+ false
206
+ elsif conflicting_args_and_opts_given?(remaining_args)
207
+ ui.err("Conflicting arguments and options: git and Policy Group comparisons cannot be mixed")
208
+ ui.err("")
209
+ ui.err(opt_parser)
210
+ false
211
+ elsif conflicting_git_options_given?
212
+ ui.err("Conflicting git options: --head and --git are exclusive")
213
+ ui.err("")
214
+ ui.err(opt_parser)
215
+
216
+ false
217
+ elsif config[:head]
218
+ set_policyfile_path_from_args(remaining_args)
219
+ @old_base = Policyfile::ComparisonBase::Git.new("HEAD", policyfile_lock_relpath)
220
+ @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
221
+ true
222
+ elsif config[:git]
223
+ set_policyfile_path_from_args(remaining_args)
224
+ parse_git_comparison(config[:git])
225
+ else
226
+ set_policyfile_path_from_args(remaining_args)
227
+ parse_server_comparison(remaining_args)
228
+ end
229
+ end
230
+
231
+ def parse_server_comparison(args)
232
+ comparison_string = args.last
233
+ if comparison_string.include?("...")
234
+ old_pgroup, new_pgroup, *extra = comparison_string.split("...")
235
+ @old_base, @new_base = [old_pgroup, new_pgroup].map do |g|
236
+ Policyfile::ComparisonBase::PolicyGroup.new(g, policy_name, http_client)
237
+ end
238
+
239
+ unless extra.empty?
240
+ ui.err("Unable to parse policy group comparison `#{comparison_string}`. Only 2 references can be specified.")
241
+ return false
242
+ end
243
+ else
244
+ @old_base = Policyfile::ComparisonBase::PolicyGroup.new(comparison_string, policy_name, http_client)
245
+ @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
246
+ end
247
+ true
248
+ end
249
+
250
+ def parse_git_comparison(git_ref)
251
+ if git_ref.include?("...")
252
+ old_ref, new_ref, *extra = git_ref.split("...")
253
+ @old_base, @new_base = [old_ref, new_ref].map do |r|
254
+ Policyfile::ComparisonBase::Git.new(r, policyfile_lock_relpath)
255
+ end
256
+
257
+ unless extra.empty?
258
+ ui.err("Unable to parse git comparison `#{git_ref}`. Only 2 references can be specified.")
259
+ return false
260
+ end
261
+ else
262
+ @old_base = Policyfile::ComparisonBase::Git.new(git_ref, policyfile_lock_relpath)
263
+ @new_base = Policyfile::ComparisonBase::Local.new(policyfile_lock_relpath)
264
+ end
265
+ true
266
+ end
267
+
268
+ def no_comparison_specified?(args)
269
+ !policy_group_comparison?(args) && !config[:head] && !config[:git]
270
+ end
271
+
272
+ def conflicting_args_and_opts_given?(args)
273
+ (config[:git] || config[:head]) && policy_group_comparison?(args)
274
+ end
275
+
276
+ def conflicting_git_options_given?
277
+ config[:git] && config[:head]
278
+ end
279
+
280
+ def comparing_policy_groups?
281
+ !(config[:git] || config[:head])
282
+ end
283
+
284
+ # Try to detect if the only argument given is a policyfile path. This is
285
+ # necessary because we support an optional argument with the path to the
286
+ # ruby policyfile. It would be easier if we used an option like `-f`, but
287
+ # that would be inconsistent with other commands (`chef install`, `chef
288
+ # push`, etc.).
289
+ def policy_group_comparison?(args)
290
+ return false if args.empty?
291
+ return true if args.size > 1
292
+ !(args.first =~ /\.rb\Z/)
293
+ end
294
+
295
+ def set_policyfile_path_from_args(args)
296
+ policyfile_relative_path =
297
+ if !comparing_policy_groups?
298
+ args.first || "Policyfile.rb"
299
+ elsif args.size == 1
300
+ "Policyfile.rb"
301
+ else
302
+ args.first
303
+ end
304
+ @storage_config = Policyfile::StorageConfig.new.use_policyfile(policyfile_relative_path)
305
+ end
306
+
307
+ def materialize_locks
308
+ @old_lock = old_base.lock
309
+ @new_lock = new_base.lock
310
+ end
311
+
312
+ end
313
+
314
+ end
315
+ end
316
+