chef-dk 3.9.0 → 3.10.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (377) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +139 -139
  3. data/Gemfile.lock +917 -919
  4. data/LICENSE +201 -201
  5. data/Rakefile +77 -77
  6. data/bin/chef +25 -25
  7. data/chef-dk.gemspec +60 -60
  8. data/lib/chef-dk.rb +19 -19
  9. data/lib/chef-dk/authenticated_http.rb +22 -22
  10. data/lib/chef-dk/builtin_commands.rb +62 -62
  11. data/lib/chef-dk/chef_runner.rb +114 -114
  12. data/lib/chef-dk/chef_server_api_multi.rb +73 -73
  13. data/lib/chef-dk/cli.rb +201 -201
  14. data/lib/chef-dk/command/base.rb +79 -79
  15. data/lib/chef-dk/command/clean_policy_cookbooks.rb +114 -114
  16. data/lib/chef-dk/command/clean_policy_revisions.rb +111 -111
  17. data/lib/chef-dk/command/delete_policy.rb +120 -120
  18. data/lib/chef-dk/command/delete_policy_group.rb +120 -120
  19. data/lib/chef-dk/command/describe_cookbook.rb +95 -95
  20. data/lib/chef-dk/command/diff.rb +315 -315
  21. data/lib/chef-dk/command/env.rb +89 -89
  22. data/lib/chef-dk/command/exec.rb +44 -44
  23. data/lib/chef-dk/command/export.rb +155 -155
  24. data/lib/chef-dk/command/gem.rb +47 -47
  25. data/lib/chef-dk/command/generate.rb +126 -126
  26. data/lib/chef-dk/command/generator_commands.rb +83 -83
  27. data/lib/chef-dk/command/generator_commands/app.rb +106 -106
  28. data/lib/chef-dk/command/generator_commands/attribute.rb +36 -36
  29. data/lib/chef-dk/command/generator_commands/base.rb +157 -157
  30. data/lib/chef-dk/command/generator_commands/build_cookbook.rb +125 -125
  31. data/lib/chef-dk/command/generator_commands/chef_exts/generator_desc_resource.rb +85 -85
  32. data/lib/chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter.rb +38 -38
  33. data/lib/chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext.rb +39 -39
  34. data/lib/chef-dk/command/generator_commands/cookbook.rb +251 -251
  35. data/lib/chef-dk/command/generator_commands/cookbook_code_file.rb +100 -100
  36. data/lib/chef-dk/command/generator_commands/cookbook_file.rb +45 -45
  37. data/lib/chef-dk/command/generator_commands/generator_generator.rb +174 -174
  38. data/lib/chef-dk/command/generator_commands/helpers.rb +36 -36
  39. data/lib/chef-dk/command/generator_commands/policyfile.rb +124 -124
  40. data/lib/chef-dk/command/generator_commands/recipe.rb +36 -36
  41. data/lib/chef-dk/command/generator_commands/repo.rb +123 -123
  42. data/lib/chef-dk/command/generator_commands/resource.rb +36 -36
  43. data/lib/chef-dk/command/generator_commands/template.rb +46 -46
  44. data/lib/chef-dk/command/install.rb +120 -120
  45. data/lib/chef-dk/command/provision.rb +439 -439
  46. data/lib/chef-dk/command/push.rb +117 -117
  47. data/lib/chef-dk/command/push_archive.rb +125 -125
  48. data/lib/chef-dk/command/shell_init.rb +179 -179
  49. data/lib/chef-dk/command/show_policy.rb +163 -163
  50. data/lib/chef-dk/command/undelete.rb +154 -154
  51. data/lib/chef-dk/command/update.rb +139 -139
  52. data/lib/chef-dk/command/verify.rb +638 -638
  53. data/lib/chef-dk/commands_map.rb +113 -113
  54. data/lib/chef-dk/completions/bash.sh.erb +5 -5
  55. data/lib/chef-dk/completions/chef.fish.erb +10 -10
  56. data/lib/chef-dk/completions/zsh.zsh.erb +21 -21
  57. data/lib/chef-dk/component_test.rb +227 -227
  58. data/lib/chef-dk/configurable.rb +88 -88
  59. data/lib/chef-dk/cookbook_metadata.rb +45 -45
  60. data/lib/chef-dk/cookbook_omnifetch.rb +32 -32
  61. data/lib/chef-dk/cookbook_profiler/git.rb +152 -152
  62. data/lib/chef-dk/cookbook_profiler/identifiers.rb +72 -72
  63. data/lib/chef-dk/cookbook_profiler/null_scm.rb +31 -31
  64. data/lib/chef-dk/exceptions.rb +151 -151
  65. data/lib/chef-dk/generator.rb +165 -165
  66. data/lib/chef-dk/helpers.rb +176 -176
  67. data/lib/chef-dk/pager.rb +104 -104
  68. data/lib/chef-dk/policyfile/artifactory_cookbook_source.rb +102 -102
  69. data/lib/chef-dk/policyfile/attribute_merge_checker.rb +110 -110
  70. data/lib/chef-dk/policyfile/chef_repo_cookbook_source.rb +138 -138
  71. data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb +99 -99
  72. data/lib/chef-dk/policyfile/chef_server_lock_fetcher.rb +167 -167
  73. data/lib/chef-dk/policyfile/community_cookbook_source.rb +95 -95
  74. data/lib/chef-dk/policyfile/comparison_base.rb +123 -123
  75. data/lib/chef-dk/policyfile/cookbook_location_specification.rb +154 -154
  76. data/lib/chef-dk/policyfile/cookbook_locks.rb +466 -466
  77. data/lib/chef-dk/policyfile/cookbook_sources.rb +23 -23
  78. data/lib/chef-dk/policyfile/delivery_supermarket_source.rb +89 -89
  79. data/lib/chef-dk/policyfile/differ.rb +263 -263
  80. data/lib/chef-dk/policyfile/dsl.rb +288 -288
  81. data/lib/chef-dk/policyfile/git_lock_fetcher.rb +265 -265
  82. data/lib/chef-dk/policyfile/included_policies_cookbook_source.rb +156 -156
  83. data/lib/chef-dk/policyfile/lister.rb +229 -229
  84. data/lib/chef-dk/policyfile/local_lock_fetcher.rb +132 -129
  85. data/lib/chef-dk/policyfile/lock_applier.rb +80 -80
  86. data/lib/chef-dk/policyfile/lock_fetcher_mixin.rb +37 -0
  87. data/lib/chef-dk/policyfile/null_cookbook_source.rb +49 -49
  88. data/lib/chef-dk/policyfile/policyfile_location_specification.rb +128 -125
  89. data/lib/chef-dk/policyfile/read_cookbook_for_compat_mode_upload.rb +124 -124
  90. data/lib/chef-dk/policyfile/remote_lock_fetcher.rb +108 -0
  91. data/lib/chef-dk/policyfile/reports/install.rb +69 -69
  92. data/lib/chef-dk/policyfile/reports/table_printer.rb +57 -57
  93. data/lib/chef-dk/policyfile/reports/upload.rb +70 -70
  94. data/lib/chef-dk/policyfile/solution_dependencies.rb +311 -311
  95. data/lib/chef-dk/policyfile/source_uri.rb +57 -57
  96. data/lib/chef-dk/policyfile/storage_config.rb +112 -112
  97. data/lib/chef-dk/policyfile/undo_record.rb +139 -139
  98. data/lib/chef-dk/policyfile/undo_stack.rb +128 -128
  99. data/lib/chef-dk/policyfile/uploader.rb +222 -222
  100. data/lib/chef-dk/policyfile_compiler.rb +528 -528
  101. data/lib/chef-dk/policyfile_lock.rb +581 -581
  102. data/lib/chef-dk/policyfile_services/clean_policies.rb +95 -95
  103. data/lib/chef-dk/policyfile_services/clean_policy_cookbooks.rb +123 -123
  104. data/lib/chef-dk/policyfile_services/export_repo.rb +419 -419
  105. data/lib/chef-dk/policyfile_services/install.rb +167 -167
  106. data/lib/chef-dk/policyfile_services/push.rb +112 -112
  107. data/lib/chef-dk/policyfile_services/push_archive.rb +164 -164
  108. data/lib/chef-dk/policyfile_services/rm_policy.rb +141 -141
  109. data/lib/chef-dk/policyfile_services/rm_policy_group.rb +85 -85
  110. data/lib/chef-dk/policyfile_services/show_policy.rb +234 -234
  111. data/lib/chef-dk/policyfile_services/undelete.rb +108 -108
  112. data/lib/chef-dk/policyfile_services/update_attributes.rb +110 -110
  113. data/lib/chef-dk/service_exception_inspectors.rb +24 -24
  114. data/lib/chef-dk/service_exception_inspectors/base.rb +39 -39
  115. data/lib/chef-dk/service_exception_inspectors/http.rb +119 -119
  116. data/lib/chef-dk/service_exceptions.rb +142 -142
  117. data/lib/chef-dk/shell_out.rb +36 -36
  118. data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile +4 -4
  119. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/.kitchen.yml +21 -21
  120. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/README.md +146 -146
  121. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/test-fixture-recipe.rb +9 -9
  122. data/lib/chef-dk/skeletons/code_generator/files/default/chefignore +104 -104
  123. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README-policy.md +9 -9
  124. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md +66 -66
  125. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-config.json +17 -17
  126. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml +36 -36
  127. data/lib/chef-dk/skeletons/code_generator/files/default/gitignore +22 -22
  128. data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md +24 -24
  129. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/README.md +27 -27
  130. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb +8 -8
  131. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb +7 -7
  132. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb +9 -9
  133. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md +56 -56
  134. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json +3 -3
  135. data/lib/chef-dk/skeletons/code_generator/files/default/repo/dot-chef-repo.txt +6 -6
  136. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md +9 -9
  137. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/example.json +12 -12
  138. data/lib/chef-dk/skeletons/code_generator/files/default/repo/policyfiles/README.md +24 -24
  139. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md +9 -9
  140. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/example.json +12 -12
  141. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb +3 -3
  142. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper_policyfile.rb +3 -3
  143. data/lib/chef-dk/skeletons/code_generator/metadata.rb +8 -8
  144. data/lib/chef-dk/skeletons/code_generator/recipes/app.rb +89 -89
  145. data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb +13 -13
  146. data/lib/chef-dk/skeletons/code_generator/recipes/build_cookbook.rb +177 -177
  147. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb +161 -161
  148. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb +25 -25
  149. data/lib/chef-dk/skeletons/code_generator/recipes/helpers.rb +21 -21
  150. data/lib/chef-dk/skeletons/code_generator/recipes/policyfile.rb +9 -9
  151. data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb +52 -52
  152. data/lib/chef-dk/skeletons/code_generator/recipes/repo.rb +68 -68
  153. data/lib/chef-dk/skeletons/code_generator/recipes/resource.rb +13 -13
  154. data/lib/chef-dk/skeletons/code_generator/recipes/template.rb +32 -32
  155. data/lib/chef-dk/skeletons/code_generator/templates/default/CHANGELOG.md.erb +11 -11
  156. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.all_rights.erb +3 -3
  157. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.apachev2.erb +201 -201
  158. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv2.erb +339 -339
  159. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv3.erb +674 -674
  160. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.mit.erb +21 -21
  161. data/lib/chef-dk/skeletons/code_generator/templates/default/Policyfile.rb.erb +25 -25
  162. data/lib/chef-dk/skeletons/code_generator/templates/default/README.md.erb +4 -4
  163. data/lib/chef-dk/skeletons/code_generator/templates/default/attribute.rb.erb +0 -0
  164. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/Berksfile.erb +7 -7
  165. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/metadata.rb.erb +10 -10
  166. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/recipe.rb.erb +8 -8
  167. data/lib/chef-dk/skeletons/code_generator/templates/default/cookbook_file.erb +0 -0
  168. data/lib/chef-dk/skeletons/code_generator/templates/default/helpers.rb.erb +39 -39
  169. data/lib/chef-dk/skeletons/code_generator/templates/default/inspec_default_test.rb.erb +16 -16
  170. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb +26 -26
  171. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_dokken.yml.erb +31 -31
  172. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_policyfile.yml.erb +33 -33
  173. data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb +20 -20
  174. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb +5 -5
  175. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb +35 -35
  176. data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb +128 -128
  177. data/lib/chef-dk/skeletons/code_generator/templates/default/resource.rb.erb +1 -1
  178. data/lib/chef-dk/skeletons/code_generator/templates/default/template.erb +0 -0
  179. data/lib/chef-dk/ui.rb +57 -57
  180. data/lib/chef-dk/version.rb +20 -20
  181. data/lib/kitchen/provisioner/policyfile_zero.rb +195 -195
  182. data/spec/shared/a_file_generator.rb +125 -125
  183. data/spec/shared/a_generated_file.rb +12 -12
  184. data/spec/shared/command_with_ui_object.rb +11 -11
  185. data/spec/shared/custom_generator_cookbook.rb +136 -136
  186. data/spec/shared/fixture_cookbook_checksums.rb +46 -46
  187. data/spec/shared/setup_git_committer_config.rb +54 -54
  188. data/spec/shared/setup_git_cookbooks.rb +53 -53
  189. data/spec/spec_helper.rb +51 -51
  190. data/spec/test_helpers.rb +84 -84
  191. data/spec/unit/chef_runner_spec.rb +139 -139
  192. data/spec/unit/chef_server_api_multi_spec.rb +120 -120
  193. data/spec/unit/cli_spec.rb +377 -377
  194. data/spec/unit/command/base_spec.rb +172 -172
  195. data/spec/unit/command/clean_policy_cookbooks_spec.rb +180 -180
  196. data/spec/unit/command/clean_policy_revisions_spec.rb +180 -180
  197. data/spec/unit/command/delete_policy_group_spec.rb +206 -206
  198. data/spec/unit/command/delete_policy_spec.rb +206 -206
  199. data/spec/unit/command/diff_spec.rb +311 -311
  200. data/spec/unit/command/env_spec.rb +52 -52
  201. data/spec/unit/command/exec_spec.rb +178 -178
  202. data/spec/unit/command/export_spec.rb +199 -199
  203. data/spec/unit/command/generate_spec.rb +142 -142
  204. data/spec/unit/command/generator_commands/app_spec.rb +166 -166
  205. data/spec/unit/command/generator_commands/attribute_spec.rb +31 -31
  206. data/spec/unit/command/generator_commands/base_spec.rb +181 -181
  207. data/spec/unit/command/generator_commands/build_cookbook_spec.rb +377 -377
  208. data/spec/unit/command/generator_commands/chef_exts/generator_desc_resource_spec.rb +97 -97
  209. data/spec/unit/command/generator_commands/chef_exts/recipe_dsl_ext_spec.rb +111 -111
  210. data/spec/unit/command/generator_commands/cookbook_file_spec.rb +31 -31
  211. data/spec/unit/command/generator_commands/cookbook_spec.rb +765 -765
  212. data/spec/unit/command/generator_commands/generator_generator_spec.rb +227 -227
  213. data/spec/unit/command/generator_commands/helpers_spec.rb +31 -31
  214. data/spec/unit/command/generator_commands/policyfile_spec.rb +223 -223
  215. data/spec/unit/command/generator_commands/recipe_spec.rb +37 -37
  216. data/spec/unit/command/generator_commands/repo_spec.rb +374 -374
  217. data/spec/unit/command/generator_commands/resource_spec.rb +31 -31
  218. data/spec/unit/command/generator_commands/template_spec.rb +31 -31
  219. data/spec/unit/command/install_spec.rb +179 -179
  220. data/spec/unit/command/provision_spec.rb +589 -589
  221. data/spec/unit/command/push_archive_spec.rb +153 -153
  222. data/spec/unit/command/push_spec.rb +198 -198
  223. data/spec/unit/command/shell_init_spec.rb +339 -339
  224. data/spec/unit/command/show_policy_spec.rb +234 -234
  225. data/spec/unit/command/undelete_spec.rb +244 -244
  226. data/spec/unit/command/update_spec.rb +283 -283
  227. data/spec/unit/command/verify_spec.rb +342 -342
  228. data/spec/unit/commands_map_spec.rb +57 -57
  229. data/spec/unit/component_test_spec.rb +128 -128
  230. data/spec/unit/configurable_spec.rb +68 -68
  231. data/spec/unit/cookbook_metadata_spec.rb +96 -96
  232. data/spec/unit/cookbook_profiler/git_spec.rb +176 -176
  233. data/spec/unit/cookbook_profiler/identifiers_spec.rb +81 -81
  234. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb +9 -9
  235. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb +9 -9
  236. data/spec/unit/fixtures/command/cli_test_command.rb +26 -26
  237. data/spec/unit/fixtures/command/explicit_path_example.rb +7 -7
  238. data/spec/unit/fixtures/configurable/test_config_loader.rb +5 -5
  239. data/spec/unit/fixtures/configurable/test_configurable.rb +10 -10
  240. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  241. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile +3 -3
  242. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  243. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/chefignore +96 -96
  244. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  245. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  246. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/.kitchen.yml +16 -16
  247. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/Berksfile +3 -3
  248. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/README.md +4 -4
  249. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/chefignore +96 -96
  250. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/metadata.rb +8 -8
  251. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/recipes/default.rb +8 -8
  252. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/.kitchen.yml +16 -16
  253. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/Berksfile +3 -3
  254. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/README.md +4 -4
  255. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/chefignore +96 -96
  256. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/metadata.rb +8 -8
  257. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/recipes/default.rb +8 -8
  258. data/spec/unit/fixtures/cookbooks_api/chef_server_universe.json +56 -56
  259. data/spec/unit/fixtures/cookbooks_api/pruned_chef_server_universe.json +30 -30
  260. data/spec/unit/fixtures/cookbooks_api/pruned_small_universe.json +1321 -1321
  261. data/spec/unit/fixtures/cookbooks_api/small_universe.json +2987 -2987
  262. data/spec/unit/fixtures/cookbooks_api/universe.json +1 -1
  263. data/spec/unit/fixtures/cookbooks_api/update_fixtures.rb +33 -33
  264. data/spec/unit/fixtures/dev_cookbooks/README.md +16 -16
  265. data/spec/unit/fixtures/dev_cookbooks/bar-cookbook.gitbundle +0 -0
  266. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/bin/.keep +0 -0
  267. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/embedded/.keep +0 -0
  268. data/spec/unit/fixtures/eg_omnibus_dir/missing_apps/embedded/bin/.keep +0 -0
  269. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/bin/.keep +0 -0
  270. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/apps/berkshelf/.keep +0 -0
  271. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/apps/test-kitchen/.keep +0 -0
  272. data/spec/unit/fixtures/eg_omnibus_dir/missing_component/embedded/bin/.keep +0 -0
  273. data/spec/unit/fixtures/eg_omnibus_dir/valid/bin/.keep +0 -0
  274. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/integration_test +2 -2
  275. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/verify_me +5 -5
  276. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef-dk/.keep +0 -0
  277. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef/verify_me +3 -3
  278. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/test-kitchen/verify_me +2 -2
  279. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/bin/.keep +0 -0
  280. data/spec/unit/fixtures/example_app/Policyfile.rb +0 -0
  281. data/spec/unit/fixtures/example_cookbook/.gitignore +17 -17
  282. data/spec/unit/fixtures/example_cookbook/.kitchen.yml +16 -16
  283. data/spec/unit/fixtures/example_cookbook/Berksfile +3 -3
  284. data/spec/unit/fixtures/example_cookbook/README.md +4 -4
  285. data/spec/unit/fixtures/example_cookbook/chefignore +96 -96
  286. data/spec/unit/fixtures/example_cookbook/metadata.rb +8 -8
  287. data/spec/unit/fixtures/example_cookbook/recipes/default.rb +8 -8
  288. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore +17 -17
  289. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml +16 -16
  290. data/spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile +3 -3
  291. data/spec/unit/fixtures/example_cookbook_metadata_json_only/README.md +4 -4
  292. data/spec/unit/fixtures/example_cookbook_metadata_json_only/chefignore +96 -96
  293. data/spec/unit/fixtures/example_cookbook_metadata_json_only/metadata.json +5 -5
  294. data/spec/unit/fixtures/example_cookbook_metadata_json_only/recipes/default.rb +8 -8
  295. data/spec/unit/fixtures/example_cookbook_no_metadata/.gitignore +17 -17
  296. data/spec/unit/fixtures/example_cookbook_no_metadata/.kitchen.yml +16 -16
  297. data/spec/unit/fixtures/example_cookbook_no_metadata/Berksfile +3 -3
  298. data/spec/unit/fixtures/example_cookbook_no_metadata/README.md +4 -4
  299. data/spec/unit/fixtures/example_cookbook_no_metadata/chefignore +96 -96
  300. data/spec/unit/fixtures/example_cookbook_no_metadata/recipes/default.rb +8 -8
  301. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/README.md +4 -4
  302. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/chefignore +96 -96
  303. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/metadata.rb +8 -8
  304. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/recipes/default.rb +8 -8
  305. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/Berksfile +3 -3
  306. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/README.md +4 -4
  307. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/chefignore +96 -96
  308. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/metadata.rb +9 -9
  309. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/recipes/default.rb +8 -8
  310. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/.kitchen.yml +16 -16
  311. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/Berksfile +3 -3
  312. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/README.md +4 -4
  313. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/chefignore +96 -96
  314. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/extra/extra_file.txt +0 -0
  315. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/metadata.rb +8 -8
  316. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/recipes/default.rb +8 -8
  317. data/spec/unit/fixtures/local_path_cookbooks/metadata-missing/README.md +2 -2
  318. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  319. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  320. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  321. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  322. data/spec/unit/generator_spec.rb +119 -119
  323. data/spec/unit/pager_spec.rb +117 -117
  324. data/spec/unit/policyfile/artifactory_cookbook_source_spec.rb +59 -59
  325. data/spec/unit/policyfile/attribute_merge_checker_spec.rb +80 -80
  326. data/spec/unit/policyfile/chef_repo_cookbook_source_spec.rb +93 -93
  327. data/spec/unit/policyfile/chef_server_cookbook_source_spec.rb +55 -55
  328. data/spec/unit/policyfile/chef_server_lock_fetcher_spec.rb +161 -161
  329. data/spec/unit/policyfile/community_cookbook_source_spec.rb +83 -83
  330. data/spec/unit/policyfile/comparison_base_spec.rb +340 -340
  331. data/spec/unit/policyfile/cookbook_location_specification_spec.rb +347 -347
  332. data/spec/unit/policyfile/cookbook_locks_spec.rb +527 -527
  333. data/spec/unit/policyfile/delivery_supermarket_source_spec.rb +129 -129
  334. data/spec/unit/policyfile/differ_spec.rb +686 -686
  335. data/spec/unit/policyfile/git_lock_fetcher_spec.rb +155 -155
  336. data/spec/unit/policyfile/included_policies_cookbook_source_spec.rb +242 -242
  337. data/spec/unit/policyfile/lister_spec.rb +268 -268
  338. data/spec/unit/policyfile/local_lock_fetcher_spec.rb +199 -173
  339. data/spec/unit/policyfile/lock_applier_spec.rb +100 -100
  340. data/spec/unit/policyfile/lock_fetcher_mixin_spec.rb +60 -0
  341. data/spec/unit/policyfile/null_cookbook_source_spec.rb +34 -34
  342. data/spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb +92 -92
  343. data/spec/unit/policyfile/remote_lock_fetcher_spec.rb +129 -0
  344. data/spec/unit/policyfile/reports/install_spec.rb +114 -114
  345. data/spec/unit/policyfile/reports/upload_spec.rb +94 -94
  346. data/spec/unit/policyfile/solution_dependencies_spec.rb +170 -170
  347. data/spec/unit/policyfile/source_uri_spec.rb +36 -36
  348. data/spec/unit/policyfile/storage_config_spec.rb +180 -180
  349. data/spec/unit/policyfile/undo_record_spec.rb +258 -258
  350. data/spec/unit/policyfile/undo_stack_spec.rb +265 -265
  351. data/spec/unit/policyfile/uploader_spec.rb +410 -410
  352. data/spec/unit/policyfile_demands_spec.rb +1197 -1197
  353. data/spec/unit/policyfile_evaluation_spec.rb +628 -628
  354. data/spec/unit/policyfile_includes_dsl_spec.rb +220 -159
  355. data/spec/unit/policyfile_includes_spec.rb +720 -720
  356. data/spec/unit/policyfile_install_with_includes_spec.rb +232 -232
  357. data/spec/unit/policyfile_lock_build_spec.rb +1065 -1065
  358. data/spec/unit/policyfile_lock_install_spec.rb +137 -137
  359. data/spec/unit/policyfile_lock_serialization_spec.rb +424 -424
  360. data/spec/unit/policyfile_lock_validation_spec.rb +608 -608
  361. data/spec/unit/policyfile_services/clean_policies_spec.rb +236 -236
  362. data/spec/unit/policyfile_services/clean_policy_cookbooks_spec.rb +272 -272
  363. data/spec/unit/policyfile_services/export_repo_spec.rb +473 -473
  364. data/spec/unit/policyfile_services/install_spec.rb +209 -209
  365. data/spec/unit/policyfile_services/push_archive_spec.rb +359 -359
  366. data/spec/unit/policyfile_services/push_spec.rb +249 -249
  367. data/spec/unit/policyfile_services/rm_policy_group_spec.rb +237 -237
  368. data/spec/unit/policyfile_services/rm_policy_spec.rb +263 -263
  369. data/spec/unit/policyfile_services/show_policy_spec.rb +887 -887
  370. data/spec/unit/policyfile_services/undelete_spec.rb +302 -302
  371. data/spec/unit/policyfile_services/update_attributes_spec.rb +229 -229
  372. data/spec/unit/policyfile_services/update_spec.rb +162 -162
  373. data/spec/unit/service_exception_inspectors/base_spec.rb +41 -41
  374. data/spec/unit/service_exception_inspectors/http_spec.rb +138 -138
  375. data/spec/unit/shell_out_spec.rb +34 -34
  376. data/warning.txt +9 -9
  377. metadata +8 -2
@@ -1,95 +1,95 @@
1
- require "chef-dk/command/base"
2
- require "chef-dk/ui"
3
- require "chef-dk/cookbook_profiler/identifiers"
4
-
5
- module ChefDK
6
- class IdDumper
7
-
8
- attr_reader :cb_path
9
- attr_reader :ui
10
-
11
- def initialize(ui, cb_relpath)
12
- @ui = ui
13
- @cb_path = cb_relpath
14
- end
15
-
16
- def run
17
- id = ChefDK::CookbookProfiler::Identifiers.new(cookbook_version)
18
- ui.msg "Path: #{cookbook_path}"
19
- ui.msg "SemVer version: #{id.semver_version}"
20
- ui.msg "Identifier: #{id.content_identifier}"
21
- ui.msg "File fingerprints:"
22
- ui.msg id.fingerprint_text
23
- end
24
-
25
- def cookbook_version
26
- @cookbook_version ||= cookbook_loader.cookbook_version
27
- end
28
-
29
- def cookbook_path
30
- File.expand_path(cb_path)
31
- end
32
-
33
- def cookbook_loader
34
- @cookbook_loader ||=
35
- begin
36
- loader = Chef::Cookbook::CookbookVersionLoader.new(cookbook_path, chefignore)
37
- loader.load!
38
- loader
39
- end
40
- end
41
-
42
- def chefignore
43
- @chefignore ||= Chef::Cookbook::Chefignore.new(File.join(cookbook_path, "chefignore"))
44
- end
45
- end
46
-
47
- module Command
48
-
49
- class DescribeCookbook < ChefDK::Command::Base
50
-
51
- banner "Usage: chef describe-cookbook <path/to/cookbook>"
52
-
53
- attr_reader :cookbook_path
54
- attr_reader :ui
55
-
56
- def initialize(*args)
57
- super
58
- @cookbook_path = nil
59
- @ui = UI.new
60
- end
61
-
62
- def run(params = [])
63
- return 1 unless apply_params!(params)
64
- return 1 unless check_cookbook_path
65
- IdDumper.new(ui, cookbook_path).run
66
- end
67
-
68
- def check_cookbook_path
69
- unless File.exist?(cookbook_path)
70
- ui.err("Given cookbook path '#{cookbook_path}' does not exist or is not readable")
71
- return false
72
- end
73
-
74
- md_path = File.join(cookbook_path, "metadata.rb")
75
- unless File.exist?(md_path)
76
- ui.err("Given cookbook path '#{cookbook_path}' does not appear to be a cookbook, it does not contain a metadata.rb")
77
- return false
78
- end
79
- true
80
- end
81
-
82
- def apply_params!(params)
83
- remaining_args = parse_options(params)
84
- if remaining_args.size != 1
85
- ui.err(opt_parser)
86
- return false
87
- else
88
- @cookbook_path = File.expand_path(remaining_args.first)
89
- true
90
- end
91
- end
92
-
93
- end
94
- end
95
- end
1
+ require "chef-dk/command/base"
2
+ require "chef-dk/ui"
3
+ require "chef-dk/cookbook_profiler/identifiers"
4
+
5
+ module ChefDK
6
+ class IdDumper
7
+
8
+ attr_reader :cb_path
9
+ attr_reader :ui
10
+
11
+ def initialize(ui, cb_relpath)
12
+ @ui = ui
13
+ @cb_path = cb_relpath
14
+ end
15
+
16
+ def run
17
+ id = ChefDK::CookbookProfiler::Identifiers.new(cookbook_version)
18
+ ui.msg "Path: #{cookbook_path}"
19
+ ui.msg "SemVer version: #{id.semver_version}"
20
+ ui.msg "Identifier: #{id.content_identifier}"
21
+ ui.msg "File fingerprints:"
22
+ ui.msg id.fingerprint_text
23
+ end
24
+
25
+ def cookbook_version
26
+ @cookbook_version ||= cookbook_loader.cookbook_version
27
+ end
28
+
29
+ def cookbook_path
30
+ File.expand_path(cb_path)
31
+ end
32
+
33
+ def cookbook_loader
34
+ @cookbook_loader ||=
35
+ begin
36
+ loader = Chef::Cookbook::CookbookVersionLoader.new(cookbook_path, chefignore)
37
+ loader.load!
38
+ loader
39
+ end
40
+ end
41
+
42
+ def chefignore
43
+ @chefignore ||= Chef::Cookbook::Chefignore.new(File.join(cookbook_path, "chefignore"))
44
+ end
45
+ end
46
+
47
+ module Command
48
+
49
+ class DescribeCookbook < ChefDK::Command::Base
50
+
51
+ banner "Usage: chef describe-cookbook <path/to/cookbook>"
52
+
53
+ attr_reader :cookbook_path
54
+ attr_reader :ui
55
+
56
+ def initialize(*args)
57
+ super
58
+ @cookbook_path = nil
59
+ @ui = UI.new
60
+ end
61
+
62
+ def run(params = [])
63
+ return 1 unless apply_params!(params)
64
+ return 1 unless check_cookbook_path
65
+ IdDumper.new(ui, cookbook_path).run
66
+ end
67
+
68
+ def check_cookbook_path
69
+ unless File.exist?(cookbook_path)
70
+ ui.err("Given cookbook path '#{cookbook_path}' does not exist or is not readable")
71
+ return false
72
+ end
73
+
74
+ md_path = File.join(cookbook_path, "metadata.rb")
75
+ unless File.exist?(md_path)
76
+ ui.err("Given cookbook path '#{cookbook_path}' does not appear to be a cookbook, it does not contain a metadata.rb")
77
+ return false
78
+ end
79
+ true
80
+ end
81
+
82
+ def apply_params!(params)
83
+ remaining_args = parse_options(params)
84
+ if remaining_args.size != 1
85
+ ui.err(opt_parser)
86
+ return false
87
+ else
88
+ @cookbook_path = File.expand_path(remaining_args.first)
89
+ true
90
+ end
91
+ end
92
+
93
+ end
94
+ end
95
+ end
@@ -1,315 +1,315 @@
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/server_api"
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 = self.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 ||= Chef::ServerAPI.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
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/server_api"
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 = self.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 ||= Chef::ServerAPI.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