chef-dk 3.0.36 → 3.1.0

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 +124 -126
  3. data/Gemfile.lock +815 -812
  4. data/LICENSE +201 -201
  5. data/README.md +333 -333
  6. data/Rakefile +74 -74
  7. data/acceptance/.shared/kitchen_acceptance/.kitchen.digitalocean.yml +27 -27
  8. data/acceptance/.shared/kitchen_acceptance/.kitchen.ec2.yml +287 -287
  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 +21 -21
  13. data/acceptance/Gemfile.lock +334 -334
  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 +60 -60
  24. data/lib/chef-dk.rb +19 -19
  25. data/lib/chef-dk/authenticated_http.rb +22 -22
  26. data/lib/chef-dk/builtin_commands.rb +59 -59
  27. data/lib/chef-dk/chef_runner.rb +114 -114
  28. data/lib/chef-dk/chef_server_api_multi.rb +73 -73
  29. data/lib/chef-dk/cli.rb +201 -201
  30. data/lib/chef-dk/command/base.rb +79 -79
  31. data/lib/chef-dk/command/clean_policy_cookbooks.rb +114 -114
  32. data/lib/chef-dk/command/clean_policy_revisions.rb +111 -111
  33. data/lib/chef-dk/command/delete_policy.rb +120 -120
  34. data/lib/chef-dk/command/delete_policy_group.rb +120 -120
  35. data/lib/chef-dk/command/diff.rb +315 -315
  36. data/lib/chef-dk/command/env.rb +89 -89
  37. data/lib/chef-dk/command/exec.rb +44 -44
  38. data/lib/chef-dk/command/export.rb +155 -155
  39. data/lib/chef-dk/command/gem.rb +47 -47
  40. data/lib/chef-dk/command/generate.rb +125 -125
  41. data/lib/chef-dk/command/generator_commands.rb +83 -83
  42. data/lib/chef-dk/command/generator_commands/app.rb +106 -106
  43. data/lib/chef-dk/command/generator_commands/attribute.rb +36 -36
  44. data/lib/chef-dk/command/generator_commands/base.rb +157 -157
  45. data/lib/chef-dk/command/generator_commands/build_cookbook.rb +125 -125
  46. data/lib/chef-dk/command/generator_commands/chef_exts/generator_desc_resource.rb +85 -85
  47. data/lib/chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter.rb +38 -38
  48. data/lib/chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext.rb +39 -39
  49. data/lib/chef-dk/command/generator_commands/cookbook.rb +241 -241
  50. data/lib/chef-dk/command/generator_commands/cookbook_code_file.rb +100 -100
  51. data/lib/chef-dk/command/generator_commands/cookbook_file.rb +45 -45
  52. data/lib/chef-dk/command/generator_commands/generator_generator.rb +174 -174
  53. data/lib/chef-dk/command/generator_commands/helpers.rb +36 -36
  54. data/lib/chef-dk/command/generator_commands/policyfile.rb +124 -124
  55. data/lib/chef-dk/command/generator_commands/recipe.rb +36 -36
  56. data/lib/chef-dk/command/generator_commands/repo.rb +123 -123
  57. data/lib/chef-dk/command/generator_commands/resource.rb +36 -36
  58. data/lib/chef-dk/command/generator_commands/template.rb +46 -46
  59. data/lib/chef-dk/command/install.rb +120 -120
  60. data/lib/chef-dk/command/provision.rb +436 -436
  61. data/lib/chef-dk/command/push.rb +117 -117
  62. data/lib/chef-dk/command/push_archive.rb +125 -125
  63. data/lib/chef-dk/command/shell_init.rb +179 -179
  64. data/lib/chef-dk/command/show_policy.rb +163 -163
  65. data/lib/chef-dk/command/undelete.rb +154 -154
  66. data/lib/chef-dk/command/update.rb +133 -133
  67. data/lib/chef-dk/command/verify.rb +629 -629
  68. data/lib/chef-dk/commands_map.rb +113 -113
  69. data/lib/chef-dk/completions/bash.sh.erb +5 -5
  70. data/lib/chef-dk/completions/chef.fish.erb +10 -10
  71. data/lib/chef-dk/completions/zsh.zsh.erb +21 -21
  72. data/lib/chef-dk/component_test.rb +227 -227
  73. data/lib/chef-dk/configurable.rb +88 -88
  74. data/lib/chef-dk/cookbook_metadata.rb +45 -45
  75. data/lib/chef-dk/cookbook_omnifetch.rb +32 -32
  76. data/lib/chef-dk/cookbook_profiler/git.rb +152 -152
  77. data/lib/chef-dk/cookbook_profiler/identifiers.rb +72 -72
  78. data/lib/chef-dk/cookbook_profiler/null_scm.rb +31 -31
  79. data/lib/chef-dk/exceptions.rb +151 -151
  80. data/lib/chef-dk/generator.rb +165 -165
  81. data/lib/chef-dk/helpers.rb +176 -176
  82. data/lib/chef-dk/pager.rb +104 -104
  83. data/lib/chef-dk/policyfile/artifactory_cookbook_source.rb +102 -102
  84. data/lib/chef-dk/policyfile/attribute_merge_checker.rb +110 -110
  85. data/lib/chef-dk/policyfile/chef_repo_cookbook_source.rb +138 -138
  86. data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb +99 -99
  87. data/lib/chef-dk/policyfile/chef_server_lock_fetcher.rb +167 -167
  88. data/lib/chef-dk/policyfile/community_cookbook_source.rb +95 -95
  89. data/lib/chef-dk/policyfile/comparison_base.rb +123 -123
  90. data/lib/chef-dk/policyfile/cookbook_location_specification.rb +154 -154
  91. data/lib/chef-dk/policyfile/cookbook_locks.rb +466 -466
  92. data/lib/chef-dk/policyfile/cookbook_sources.rb +23 -23
  93. data/lib/chef-dk/policyfile/delivery_supermarket_source.rb +89 -89
  94. data/lib/chef-dk/policyfile/differ.rb +263 -263
  95. data/lib/chef-dk/policyfile/dsl.rb +288 -288
  96. data/lib/chef-dk/policyfile/git_lock_fetcher.rb +265 -265
  97. data/lib/chef-dk/policyfile/included_policies_cookbook_source.rb +156 -156
  98. data/lib/chef-dk/policyfile/lister.rb +229 -229
  99. data/lib/chef-dk/policyfile/local_lock_fetcher.rb +129 -129
  100. data/lib/chef-dk/policyfile/lock_applier.rb +80 -80
  101. data/lib/chef-dk/policyfile/null_cookbook_source.rb +49 -49
  102. data/lib/chef-dk/policyfile/policyfile_location_specification.rb +125 -125
  103. data/lib/chef-dk/policyfile/read_cookbook_for_compat_mode_upload.rb +124 -124
  104. data/lib/chef-dk/policyfile/reports/install.rb +69 -69
  105. data/lib/chef-dk/policyfile/reports/table_printer.rb +57 -57
  106. data/lib/chef-dk/policyfile/reports/upload.rb +70 -70
  107. data/lib/chef-dk/policyfile/solution_dependencies.rb +311 -311
  108. data/lib/chef-dk/policyfile/source_uri.rb +57 -57
  109. data/lib/chef-dk/policyfile/storage_config.rb +112 -112
  110. data/lib/chef-dk/policyfile/undo_record.rb +139 -139
  111. data/lib/chef-dk/policyfile/undo_stack.rb +128 -128
  112. data/lib/chef-dk/policyfile/uploader.rb +213 -213
  113. data/lib/chef-dk/policyfile_compiler.rb +528 -528
  114. data/lib/chef-dk/policyfile_lock.rb +581 -581
  115. data/lib/chef-dk/policyfile_services/clean_policies.rb +95 -95
  116. data/lib/chef-dk/policyfile_services/clean_policy_cookbooks.rb +123 -123
  117. data/lib/chef-dk/policyfile_services/export_repo.rb +419 -419
  118. data/lib/chef-dk/policyfile_services/install.rb +162 -162
  119. data/lib/chef-dk/policyfile_services/push.rb +112 -112
  120. data/lib/chef-dk/policyfile_services/push_archive.rb +164 -164
  121. data/lib/chef-dk/policyfile_services/rm_policy.rb +141 -141
  122. data/lib/chef-dk/policyfile_services/rm_policy_group.rb +85 -85
  123. data/lib/chef-dk/policyfile_services/show_policy.rb +234 -234
  124. data/lib/chef-dk/policyfile_services/undelete.rb +108 -108
  125. data/lib/chef-dk/policyfile_services/update_attributes.rb +110 -110
  126. data/lib/chef-dk/service_exception_inspectors.rb +24 -24
  127. data/lib/chef-dk/service_exception_inspectors/base.rb +39 -39
  128. data/lib/chef-dk/service_exception_inspectors/http.rb +119 -119
  129. data/lib/chef-dk/service_exceptions.rb +142 -142
  130. data/lib/chef-dk/shell_out.rb +36 -36
  131. data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile +4 -4
  132. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/.kitchen.yml +21 -21
  133. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/README.md +146 -146
  134. data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/test-fixture-recipe.rb +9 -9
  135. data/lib/chef-dk/skeletons/code_generator/files/default/chefignore +104 -104
  136. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README-policy.md +9 -9
  137. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md +66 -66
  138. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-config.json +17 -17
  139. data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml +36 -36
  140. data/lib/chef-dk/skeletons/code_generator/files/default/gitignore +22 -22
  141. data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md +24 -24
  142. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/README.md +27 -27
  143. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb +8 -8
  144. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb +7 -7
  145. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb +9 -9
  146. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md +56 -56
  147. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json +3 -3
  148. data/lib/chef-dk/skeletons/code_generator/files/default/repo/dot-chef-repo.txt +6 -6
  149. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md +9 -9
  150. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/example.json +12 -12
  151. data/lib/chef-dk/skeletons/code_generator/files/default/repo/policies/README.md +24 -24
  152. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md +9 -9
  153. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/example.json +12 -12
  154. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb +3 -3
  155. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper_policyfile.rb +3 -3
  156. data/lib/chef-dk/skeletons/code_generator/metadata.rb +8 -8
  157. data/lib/chef-dk/skeletons/code_generator/recipes/app.rb +89 -89
  158. data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb +13 -13
  159. data/lib/chef-dk/skeletons/code_generator/recipes/build_cookbook.rb +177 -177
  160. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb +158 -158
  161. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb +25 -25
  162. data/lib/chef-dk/skeletons/code_generator/recipes/helpers.rb +21 -21
  163. data/lib/chef-dk/skeletons/code_generator/recipes/policyfile.rb +9 -9
  164. data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb +52 -52
  165. data/lib/chef-dk/skeletons/code_generator/recipes/repo.rb +68 -68
  166. data/lib/chef-dk/skeletons/code_generator/recipes/resource.rb +13 -13
  167. data/lib/chef-dk/skeletons/code_generator/recipes/template.rb +32 -32
  168. data/lib/chef-dk/skeletons/code_generator/templates/default/CHANGELOG.md.erb +11 -11
  169. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.all_rights.erb +3 -3
  170. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.apachev2.erb +201 -201
  171. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv2.erb +339 -339
  172. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv3.erb +674 -674
  173. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.mit.erb +21 -21
  174. data/lib/chef-dk/skeletons/code_generator/templates/default/Policyfile.rb.erb +25 -25
  175. data/lib/chef-dk/skeletons/code_generator/templates/default/README.md.erb +4 -4
  176. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/Berksfile.erb +7 -7
  177. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/metadata.rb.erb +10 -10
  178. data/lib/chef-dk/skeletons/code_generator/templates/default/build_cookbook/recipe.rb.erb +8 -8
  179. data/lib/chef-dk/skeletons/code_generator/templates/default/helpers.rb.erb +39 -39
  180. data/lib/chef-dk/skeletons/code_generator/templates/default/inspec_default_test.rb.erb +18 -18
  181. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb +26 -26
  182. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_policyfile.yml.erb +33 -33
  183. data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb +20 -20
  184. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb +5 -5
  185. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb +35 -35
  186. data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb +128 -128
  187. data/lib/chef-dk/skeletons/code_generator/templates/default/resource.rb.erb +1 -1
  188. data/lib/chef-dk/ui.rb +57 -57
  189. data/lib/chef-dk/version.rb +20 -20
  190. data/lib/kitchen/provisioner/policyfile_zero.rb +195 -195
  191. data/omnibus_overrides.rb +25 -25
  192. data/spec/shared/a_file_generator.rb +125 -125
  193. data/spec/shared/a_generated_file.rb +12 -12
  194. data/spec/shared/command_with_ui_object.rb +11 -11
  195. data/spec/shared/custom_generator_cookbook.rb +136 -136
  196. data/spec/shared/fixture_cookbook_checksums.rb +46 -46
  197. data/spec/shared/setup_git_committer_config.rb +54 -54
  198. data/spec/shared/setup_git_cookbooks.rb +53 -53
  199. data/spec/spec_helper.rb +51 -51
  200. data/spec/test_helpers.rb +84 -84
  201. data/spec/unit/chef_runner_spec.rb +139 -139
  202. data/spec/unit/chef_server_api_multi_spec.rb +120 -120
  203. data/spec/unit/cli_spec.rb +377 -377
  204. data/spec/unit/command/base_spec.rb +172 -172
  205. data/spec/unit/command/clean_policy_cookbooks_spec.rb +180 -180
  206. data/spec/unit/command/clean_policy_revisions_spec.rb +180 -180
  207. data/spec/unit/command/delete_policy_group_spec.rb +206 -206
  208. data/spec/unit/command/delete_policy_spec.rb +206 -206
  209. data/spec/unit/command/diff_spec.rb +311 -311
  210. data/spec/unit/command/env_spec.rb +52 -52
  211. data/spec/unit/command/exec_spec.rb +178 -178
  212. data/spec/unit/command/export_spec.rb +199 -199
  213. data/spec/unit/command/generate_spec.rb +142 -142
  214. data/spec/unit/command/generator_commands/app_spec.rb +166 -166
  215. data/spec/unit/command/generator_commands/attribute_spec.rb +31 -31
  216. data/spec/unit/command/generator_commands/base_spec.rb +181 -181
  217. data/spec/unit/command/generator_commands/build_cookbook_spec.rb +377 -377
  218. data/spec/unit/command/generator_commands/chef_exts/generator_desc_resource_spec.rb +97 -97
  219. data/spec/unit/command/generator_commands/chef_exts/recipe_dsl_ext_spec.rb +111 -111
  220. data/spec/unit/command/generator_commands/cookbook_file_spec.rb +31 -31
  221. data/spec/unit/command/generator_commands/cookbook_spec.rb +765 -765
  222. data/spec/unit/command/generator_commands/generator_generator_spec.rb +227 -227
  223. data/spec/unit/command/generator_commands/helpers_spec.rb +31 -31
  224. data/spec/unit/command/generator_commands/policyfile_spec.rb +223 -223
  225. data/spec/unit/command/generator_commands/recipe_spec.rb +37 -37
  226. data/spec/unit/command/generator_commands/repo_spec.rb +374 -374
  227. data/spec/unit/command/generator_commands/resource_spec.rb +31 -31
  228. data/spec/unit/command/generator_commands/template_spec.rb +31 -31
  229. data/spec/unit/command/install_spec.rb +179 -179
  230. data/spec/unit/command/provision_spec.rb +589 -589
  231. data/spec/unit/command/push_archive_spec.rb +153 -153
  232. data/spec/unit/command/push_spec.rb +198 -198
  233. data/spec/unit/command/shell_init_spec.rb +339 -339
  234. data/spec/unit/command/show_policy_spec.rb +234 -234
  235. data/spec/unit/command/undelete_spec.rb +244 -244
  236. data/spec/unit/command/update_spec.rb +283 -283
  237. data/spec/unit/command/verify_spec.rb +341 -341
  238. data/spec/unit/commands_map_spec.rb +57 -57
  239. data/spec/unit/component_test_spec.rb +128 -128
  240. data/spec/unit/configurable_spec.rb +68 -68
  241. data/spec/unit/cookbook_metadata_spec.rb +96 -96
  242. data/spec/unit/cookbook_profiler/git_spec.rb +176 -176
  243. data/spec/unit/cookbook_profiler/identifiers_spec.rb +81 -81
  244. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb +9 -9
  245. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb +9 -9
  246. data/spec/unit/fixtures/command/cli_test_command.rb +26 -26
  247. data/spec/unit/fixtures/command/explicit_path_example.rb +7 -7
  248. data/spec/unit/fixtures/configurable/test_config_loader.rb +5 -5
  249. data/spec/unit/fixtures/configurable/test_configurable.rb +10 -10
  250. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  251. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile +3 -3
  252. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  253. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/chefignore +96 -96
  254. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  255. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  256. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/.kitchen.yml +16 -16
  257. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/Berksfile +3 -3
  258. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/README.md +4 -4
  259. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/chefignore +96 -96
  260. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/metadata.rb +8 -8
  261. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/recipes/default.rb +8 -8
  262. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/.kitchen.yml +16 -16
  263. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/Berksfile +3 -3
  264. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/README.md +4 -4
  265. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/chefignore +96 -96
  266. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/metadata.rb +8 -8
  267. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/recipes/default.rb +8 -8
  268. data/spec/unit/fixtures/cookbooks_api/chef_server_universe.json +56 -56
  269. data/spec/unit/fixtures/cookbooks_api/pruned_chef_server_universe.json +30 -30
  270. data/spec/unit/fixtures/cookbooks_api/pruned_small_universe.json +1321 -1321
  271. data/spec/unit/fixtures/cookbooks_api/small_universe.json +2987 -2987
  272. data/spec/unit/fixtures/cookbooks_api/universe.json +1 -1
  273. data/spec/unit/fixtures/cookbooks_api/update_fixtures.rb +33 -33
  274. data/spec/unit/fixtures/dev_cookbooks/README.md +16 -16
  275. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/integration_test +2 -2
  276. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/verify_me +5 -5
  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/example_cookbook/.gitignore +17 -17
  280. data/spec/unit/fixtures/example_cookbook/.kitchen.yml +16 -16
  281. data/spec/unit/fixtures/example_cookbook/Berksfile +3 -3
  282. data/spec/unit/fixtures/example_cookbook/README.md +4 -4
  283. data/spec/unit/fixtures/example_cookbook/chefignore +96 -96
  284. data/spec/unit/fixtures/example_cookbook/metadata.rb +8 -8
  285. data/spec/unit/fixtures/example_cookbook/recipes/default.rb +8 -8
  286. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore +17 -17
  287. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml +16 -16
  288. data/spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile +3 -3
  289. data/spec/unit/fixtures/example_cookbook_metadata_json_only/README.md +4 -4
  290. data/spec/unit/fixtures/example_cookbook_metadata_json_only/chefignore +96 -96
  291. data/spec/unit/fixtures/example_cookbook_metadata_json_only/metadata.json +5 -5
  292. data/spec/unit/fixtures/example_cookbook_metadata_json_only/recipes/default.rb +8 -8
  293. data/spec/unit/fixtures/example_cookbook_no_metadata/.gitignore +17 -17
  294. data/spec/unit/fixtures/example_cookbook_no_metadata/.kitchen.yml +16 -16
  295. data/spec/unit/fixtures/example_cookbook_no_metadata/Berksfile +3 -3
  296. data/spec/unit/fixtures/example_cookbook_no_metadata/README.md +4 -4
  297. data/spec/unit/fixtures/example_cookbook_no_metadata/chefignore +96 -96
  298. data/spec/unit/fixtures/example_cookbook_no_metadata/recipes/default.rb +8 -8
  299. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/README.md +4 -4
  300. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/chefignore +96 -96
  301. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/metadata.rb +8 -8
  302. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/recipes/default.rb +8 -8
  303. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/Berksfile +3 -3
  304. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/README.md +4 -4
  305. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/chefignore +96 -96
  306. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/metadata.rb +9 -9
  307. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/recipes/default.rb +8 -8
  308. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/.kitchen.yml +16 -16
  309. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/Berksfile +3 -3
  310. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/README.md +4 -4
  311. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/chefignore +96 -96
  312. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/metadata.rb +8 -8
  313. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/recipes/default.rb +8 -8
  314. data/spec/unit/fixtures/local_path_cookbooks/metadata-missing/README.md +2 -2
  315. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  316. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  317. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  318. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  319. data/spec/unit/generator_spec.rb +119 -119
  320. data/spec/unit/pager_spec.rb +117 -117
  321. data/spec/unit/policyfile/artifactory_cookbook_source_spec.rb +59 -59
  322. data/spec/unit/policyfile/attribute_merge_checker_spec.rb +80 -80
  323. data/spec/unit/policyfile/chef_repo_cookbook_source_spec.rb +93 -93
  324. data/spec/unit/policyfile/chef_server_cookbook_source_spec.rb +55 -55
  325. data/spec/unit/policyfile/chef_server_lock_fetcher_spec.rb +161 -161
  326. data/spec/unit/policyfile/community_cookbook_source_spec.rb +83 -83
  327. data/spec/unit/policyfile/comparison_base_spec.rb +340 -340
  328. data/spec/unit/policyfile/cookbook_location_specification_spec.rb +347 -347
  329. data/spec/unit/policyfile/cookbook_locks_spec.rb +527 -527
  330. data/spec/unit/policyfile/delivery_supermarket_source_spec.rb +129 -129
  331. data/spec/unit/policyfile/differ_spec.rb +686 -686
  332. data/spec/unit/policyfile/git_lock_fetcher_spec.rb +155 -155
  333. data/spec/unit/policyfile/included_policies_cookbook_source_spec.rb +242 -242
  334. data/spec/unit/policyfile/lister_spec.rb +268 -268
  335. data/spec/unit/policyfile/local_lock_fetcher_spec.rb +173 -173
  336. data/spec/unit/policyfile/lock_applier_spec.rb +100 -100
  337. data/spec/unit/policyfile/null_cookbook_source_spec.rb +34 -34
  338. data/spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb +92 -92
  339. data/spec/unit/policyfile/reports/install_spec.rb +114 -114
  340. data/spec/unit/policyfile/reports/upload_spec.rb +94 -94
  341. data/spec/unit/policyfile/solution_dependencies_spec.rb +170 -170
  342. data/spec/unit/policyfile/source_uri_spec.rb +36 -36
  343. data/spec/unit/policyfile/storage_config_spec.rb +180 -180
  344. data/spec/unit/policyfile/undo_record_spec.rb +258 -258
  345. data/spec/unit/policyfile/undo_stack_spec.rb +265 -265
  346. data/spec/unit/policyfile/uploader_spec.rb +409 -409
  347. data/spec/unit/policyfile_demands_spec.rb +1197 -1197
  348. data/spec/unit/policyfile_evaluation_spec.rb +628 -628
  349. data/spec/unit/policyfile_includes_dsl_spec.rb +159 -159
  350. data/spec/unit/policyfile_includes_spec.rb +720 -720
  351. data/spec/unit/policyfile_install_with_includes_spec.rb +232 -232
  352. data/spec/unit/policyfile_lock_build_spec.rb +1065 -1065
  353. data/spec/unit/policyfile_lock_install_spec.rb +137 -137
  354. data/spec/unit/policyfile_lock_serialization_spec.rb +424 -424
  355. data/spec/unit/policyfile_lock_validation_spec.rb +608 -608
  356. data/spec/unit/policyfile_services/clean_policies_spec.rb +236 -236
  357. data/spec/unit/policyfile_services/clean_policy_cookbooks_spec.rb +272 -272
  358. data/spec/unit/policyfile_services/export_repo_spec.rb +473 -473
  359. data/spec/unit/policyfile_services/install_spec.rb +209 -209
  360. data/spec/unit/policyfile_services/push_archive_spec.rb +359 -359
  361. data/spec/unit/policyfile_services/push_spec.rb +249 -249
  362. data/spec/unit/policyfile_services/rm_policy_group_spec.rb +237 -237
  363. data/spec/unit/policyfile_services/rm_policy_spec.rb +263 -263
  364. data/spec/unit/policyfile_services/show_policy_spec.rb +887 -887
  365. data/spec/unit/policyfile_services/undelete_spec.rb +302 -302
  366. data/spec/unit/policyfile_services/update_attributes_spec.rb +229 -229
  367. data/spec/unit/policyfile_services/update_spec.rb +140 -140
  368. data/spec/unit/service_exception_inspectors/base_spec.rb +41 -41
  369. data/spec/unit/service_exception_inspectors/http_spec.rb +138 -138
  370. data/spec/unit/shell_out_spec.rb +34 -34
  371. data/tasks/announce.rb +57 -57
  372. data/tasks/bin/bundle-platform.bat +2 -2
  373. data/tasks/dependencies.rb +89 -89
  374. data/tasks/templates/prerelease.md.erb +35 -35
  375. data/tasks/templates/release.md.erb +34 -34
  376. data/warning.txt +9 -9
  377. metadata +2 -2
@@ -1,466 +1,466 @@
1
- #
2
- # Copyright:: Copyright (c) 2014-2018 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 "forwardable"
19
-
20
- require "chef-dk/exceptions"
21
-
22
- require "chef-dk/cookbook_profiler/null_scm"
23
- require "chef-dk/cookbook_profiler/git"
24
-
25
- require "chef-dk/cookbook_profiler/identifiers"
26
- require "chef-dk/policyfile/storage_config"
27
-
28
- require "chef-dk/policyfile/cookbook_location_specification"
29
-
30
- module ChefDK
31
-
32
- module Policyfile
33
-
34
- # Base class for CookbookLock implementations
35
- class CookbookLock
36
-
37
- REQUIRED_LOCK_DATA_KEYS = %w{version identifier dotted_decimal_identifier cache_key source_options}
38
- REQUIRED_LOCK_DATA_KEYS.each(&:freeze)
39
- REQUIRED_LOCK_DATA_KEYS.freeze
40
-
41
- include Policyfile::StorageConfigDelegation
42
-
43
- # The cookbook name (without any version or other info suffixed)
44
- attr_reader :name
45
-
46
- # Options specifying the source and revision of this cookbook. These can
47
- # be passed to a CookbookLocationSpecification to create an object that can install the
48
- # same revision of the cookbook on another machine.
49
- attr_accessor :source_options
50
-
51
- # A string that uniquely identifies the cookbook version. If not
52
- # explicitly set, an identifier is generated based on the cookbook's
53
- # content.
54
- attr_accessor :identifier
55
-
56
- # A string in "X.Y.Z" version number format that uniquely identifies the
57
- # cookbook version. This is for compatibility with Chef Server 11.x,
58
- # where cookbooks are stored by x.y.z version numbers.
59
- attr_accessor :dotted_decimal_identifier
60
-
61
- attr_reader :storage_config
62
-
63
- attr_accessor :version
64
-
65
- def initialize(name, storage_config)
66
- @name = name
67
- @version = nil
68
- @source_options = nil
69
- @identifier = nil
70
- @dotted_decimal_identifier = nil
71
- @storage_config = storage_config
72
- end
73
-
74
- def installed?
75
- cookbook_location_spec.installed?
76
- end
77
-
78
- def install_locked
79
- cookbook_location_spec.ensure_cached
80
- end
81
-
82
- def cookbook_location_spec
83
- raise InvalidCookbookLockData, "Cannot create CookbookLocationSpecification for #{name} without version" if version.nil?
84
- raise InvalidCookbookLockData, "Cannot create CookbookLocationSpecification for #{name} without source options" if source_options.nil?
85
- @location_spec ||= CookbookLocationSpecification.new(name, "= #{version}", source_options, storage_config)
86
- end
87
-
88
- def dependencies
89
- cookbook_location_spec.dependencies
90
- end
91
-
92
- def gather_profile_data
93
- @identifier ||= identifiers.content_identifier
94
- @dotted_decimal_identifier ||= identifiers.dotted_decimal_identifier
95
- @version ||= identifiers.semver_version
96
- end
97
-
98
- def identifiers
99
- @identifiers ||= CookbookProfiler::Identifiers.new(cookbook_version)
100
- end
101
-
102
- def cookbook_path
103
- raise NotImplementedError, "#{self.class} must override #cookbook_path with a specific implementation"
104
- end
105
-
106
- def to_lock
107
- validate!
108
- lock_data
109
- end
110
-
111
- def lock_data
112
- raise NotImplementedError, "#{self.class} must override #lock_data a specific implementation"
113
- end
114
-
115
- def build_from_lock_data(lock_data)
116
- raise NotImplementedError, "#{self.class} must override #build_from_lock_data with a specific implementation"
117
- end
118
-
119
- def validate!
120
- raise NotImplementedError, "#{self.class} must override #validate! with a specific implementation"
121
- end
122
-
123
- def refresh!
124
- raise NotImplementedError, "#{self.class} must override #refresh! with a specific implementation"
125
- end
126
-
127
- def updated?
128
- false
129
- end
130
-
131
- def identifier_updated?
132
- false
133
- end
134
-
135
- def version_updated?
136
- false
137
- end
138
-
139
- def symbolize_source_options_keys(source_options_from_json)
140
- source_options_from_json ||= {}
141
- source_options_from_json.inject({}) do |normalized_source_opts, (key, value)|
142
- normalized_source_opts[key.to_sym] = value
143
- normalized_source_opts
144
- end
145
- end
146
-
147
- def cookbook_version
148
- @cookbook_version ||= cookbook_loader.cookbook_version
149
- end
150
-
151
- def cookbook_loader
152
- @cookbook_loader ||=
153
- begin
154
- loader = Chef::Cookbook::CookbookVersionLoader.new(cookbook_path, chefignore)
155
- loader.load!
156
- loader
157
- end
158
- end
159
-
160
- def chefignore
161
- @chefignore ||= Chef::Cookbook::Chefignore.new(File.join(cookbook_path, "chefignore"))
162
- end
163
-
164
- private
165
-
166
- def assert_required_keys_valid!(lock_data)
167
- missing_keys = REQUIRED_LOCK_DATA_KEYS.reject { |key| lock_data.key?(key) }
168
- unless missing_keys.empty?
169
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} missing required attributes `#{missing_keys.join("', `")}'"
170
- end
171
-
172
- version = lock_data["version"]
173
- unless version.kind_of?(String)
174
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `version' attribute must be a string (got: #{version})"
175
- end
176
-
177
- identifier = lock_data["identifier"]
178
- unless identifier.kind_of?(String)
179
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `identifier' attribute must be a string (got: #{identifier})"
180
- end
181
-
182
- cache_key = lock_data["cache_key"]
183
- unless cache_key.kind_of?(String) || cache_key.nil?
184
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `cache_key' attribute must be a string (got: #{cache_key})"
185
- end
186
-
187
- source_options = lock_data["source_options"]
188
- unless source_options.kind_of?(Hash)
189
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `source_options' attribute must be a Hash (JSON object) (got: #{source_options})"
190
- end
191
- end
192
-
193
- end
194
-
195
- # CachedCookbook objects represent a cookbook that has been fetched from an
196
- # upstream canonical source and stored (presumed unmodified).
197
- class CachedCookbook < CookbookLock
198
-
199
- # The directory name in the cookbook cache where the cookbook is stored.
200
- # By convention, this should be the name of the cookbook followed by a
201
- # hyphen and then some sort of version identifier (depending on the
202
- # cookbook source).
203
- attr_accessor :cache_key
204
-
205
- # A URI pointing to the canonical source of the cookbook.
206
- attr_accessor :origin
207
-
208
- def initialize(name, storage_config)
209
- @name = name
210
- @version = nil
211
- @origin = nil
212
- @source_options = nil
213
- @cache_key = nil
214
- @identifier = nil
215
- @dotted_decimal_identifier = nil
216
- @storage_config = storage_config
217
- end
218
-
219
- def cookbook_path
220
- if cache_key.nil?
221
- raise MissingCookbookLockData, "Cannot locate cached cookbook `#{name}' because the `cache_key' attribute is not set"
222
- end
223
- File.join(cache_path, cache_key)
224
- end
225
-
226
- def build_from_lock_data(lock_data)
227
- assert_required_keys_valid!(lock_data)
228
-
229
- @version = lock_data["version"]
230
- @identifier = lock_data["identifier"]
231
- @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
232
- @cache_key = lock_data["cache_key"]
233
- @origin = lock_data["origin"]
234
- @source_options = symbolize_source_options_keys(lock_data["source_options"])
235
- end
236
-
237
- def lock_data
238
- {
239
- "version" => version,
240
- "identifier" => identifier,
241
- "dotted_decimal_identifier" => dotted_decimal_identifier,
242
- "cache_key" => cache_key,
243
- "origin" => origin,
244
- "source_options" => source_options,
245
- }
246
- end
247
-
248
- def validate!
249
- if cache_key.nil?
250
- raise CachedCookbookNotFound, "Cookbook `#{name}' does not have a `cache_key` set, cannot locate cookbook"
251
- end
252
- unless File.exist?(cookbook_path)
253
- raise CachedCookbookNotFound, "Cookbook `#{name}' not found at expected cache location `#{cache_key}' (full path: `#{cookbook_path}')"
254
- end
255
- end
256
-
257
- # We do not expect the cookbook to get mutated out-of-band, so refreshing
258
- # the data generally should have no affect. If the cookbook has been
259
- # mutated, though, then a CachedCookbookModified exception is raised.
260
- def refresh!
261
- # This behavior fits better with the intent of the #validate! method,
262
- # but we cannot check for modifications there because the user may be
263
- # setting custom identifiers.
264
- if @identifier && identifiers.content_identifier != @identifier
265
- message = "Cached cookbook `#{name}' (#{version}) has been modified since the lockfile was generated. " +
266
- "Cached cookbooks cannot be modified. (full path: `#{cookbook_path}')"
267
- raise CachedCookbookModified, message
268
- end
269
- end
270
-
271
- end
272
-
273
- # LocalCookbook objects represent cookbooks that are sourced from the local
274
- # filesystem and are assumed to be under active development.
275
- class LocalCookbook < CookbookLock
276
-
277
- # A relative or absolute path to the cookbook. If a relative path is
278
- # given, it is resolved relative to #relative_paths_root
279
- attr_accessor :source
280
-
281
- def initialize(name, storage_config)
282
- @name = name
283
- @identifier = nil
284
- @storage_config = storage_config
285
-
286
- @identifier_updated = false
287
- @version_updated = false
288
- @cookbook_in_git_repo = nil
289
- @scm_info = nil
290
- end
291
-
292
- def cookbook_path
293
- File.expand_path(source, relative_paths_root)
294
- end
295
-
296
- def scm_profiler
297
- if cookbook_in_git_repo?
298
- CookbookProfiler::Git.new(cookbook_path)
299
- else
300
- CookbookProfiler::NullSCM.new(cookbook_path)
301
- end
302
- end
303
-
304
- def scm_info
305
- @scm_info
306
- end
307
-
308
- def to_lock
309
- refresh_scm_info
310
- super
311
- end
312
-
313
- def lock_data
314
- {
315
- "version" => version,
316
- "identifier" => identifier,
317
- "dotted_decimal_identifier" => dotted_decimal_identifier,
318
- "source" => source,
319
- "cache_key" => nil,
320
- "scm_info" => scm_info,
321
- "source_options" => source_options,
322
- }
323
- end
324
-
325
- def build_from_lock_data(lock_data)
326
- assert_required_keys_valid!(lock_data)
327
-
328
- @version = lock_data["version"]
329
- @identifier = lock_data["identifier"]
330
- @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
331
- @source = lock_data["source"]
332
- @source_options = symbolize_source_options_keys(lock_data["source_options"])
333
- @scm_info = lock_data["scm_info"]
334
- end
335
-
336
- def validate!
337
- if source.nil?
338
- raise LocalCookbookNotFound, "Cookbook `#{name}' does not have a `source` set, cannot locate cookbook"
339
- end
340
- unless File.exist?(cookbook_path)
341
- raise LocalCookbookNotFound, "Cookbook `#{name}' not found at path source `#{source}` (full path: `#{cookbook_path}')"
342
- end
343
- unless cookbook_version.name.to_s == name
344
- msg = "The cookbook at path source `#{source}' is expected to be named `#{name}', but is now named `#{cookbook_version.name}' (full path: #{cookbook_path})"
345
- raise MalformedCookbook, msg
346
- end
347
- end
348
-
349
- def refresh!
350
- old_identifier, old_version = @identifier, @version
351
- @identifier, @dotted_decimal_identifier, @version = nil, nil, nil
352
- gather_profile_data
353
- if @identifier != old_identifier
354
- @identifier_updated = true
355
- end
356
- if @version != old_version
357
- @version_updated = true
358
- end
359
- self
360
- end
361
-
362
- def updated?
363
- @identifier_updated || @version_updated
364
- end
365
-
366
- def version_updated?
367
- @version_updated
368
- end
369
-
370
- def identifier_updated?
371
- @identifier_updated
372
- end
373
-
374
- private
375
-
376
- def refresh_scm_info
377
- @scm_info = scm_profiler.profile_data
378
- end
379
-
380
- def assert_required_keys_valid!(lock_data)
381
- super
382
-
383
- source = lock_data["source"]
384
- if source.nil?
385
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid. Lock data for a local cookbook must have a `source' attribute"
386
- end
387
-
388
- unless source.kind_of?(String)
389
- raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid: `source' attribute must be a String (got: #{source.inspect})"
390
- end
391
- end
392
-
393
- def cookbook_in_git_repo?
394
- return @cookbook_in_git_repo unless @cookbook_in_git_repo.nil?
395
-
396
- @cookbook_in_git_repo = false
397
-
398
- dot_git = Pathname.new(".git")
399
- Pathname.new(cookbook_path).ascend do |parent_dir|
400
- possbile_git_dir = parent_dir + dot_git
401
- if possbile_git_dir.exist?
402
- @cookbook_in_git_repo = true
403
- break
404
- end
405
- end
406
-
407
- @cookbook_in_git_repo
408
- end
409
-
410
- end
411
-
412
- class ArchivedCookbook < CookbookLock
413
-
414
- extend Forwardable
415
-
416
- def_delegator :@archived_lock, :name
417
- def_delegator :@archived_lock, :source_options
418
- def_delegator :@archived_lock, :identifier
419
- def_delegator :@archived_lock, :dotted_decimal_identifier
420
- def_delegator :@archived_lock, :version
421
- def_delegator :@archived_lock, :source
422
-
423
- # #to_lock calls #validate! which will typically ensure that the cookbook
424
- # is present at the correct path for the lock type. For an archived
425
- # cookbook, the cookbook is located in the archive, so it probably won't
426
- # exist there. Therefore, we bypass #validate! and get the lock data
427
- # directly.
428
- def_delegator :@archived_lock, :lock_data, :to_lock
429
-
430
- def initialize(archived_lock, storage_config)
431
- @archived_lock = archived_lock
432
- @storage_config = storage_config
433
- end
434
-
435
- def build_from_lock_data(lock_data)
436
- raise NotImplementedError, "ArchivedCookbook cannot be built from lock data, it can only wrap an existing lock object"
437
- end
438
-
439
- def installed?
440
- File.exist?(cookbook_path) && File.directory?(cookbook_path)
441
- end
442
-
443
- # The cookbook is assumed to be stored in a Chef Zero compatible repo as
444
- # created by `chef export`. Currently that only creates "compatibility
445
- # mode" repos since Chef Zero doesn't yet support cookbook_artifact APIs.
446
- # So the cookbook will be located in a path like:
447
- # cookbooks/nginx-111.222.333
448
- def cookbook_path
449
- File.join(relative_paths_root, "cookbook_artifacts", "#{name}-#{identifier}")
450
- end
451
-
452
- # We trust that archived cookbooks haven't been modified, so just return
453
- # true for #validate!
454
- def validate!
455
- true
456
- end
457
-
458
- # We trust that archived cookbooks haven't been modified, so just return
459
- # true for #refresh!
460
- def refresh!
461
- true
462
- end
463
- end
464
-
465
- end
466
- end
1
+ #
2
+ # Copyright:: Copyright (c) 2014-2018 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 "forwardable"
19
+
20
+ require "chef-dk/exceptions"
21
+
22
+ require "chef-dk/cookbook_profiler/null_scm"
23
+ require "chef-dk/cookbook_profiler/git"
24
+
25
+ require "chef-dk/cookbook_profiler/identifiers"
26
+ require "chef-dk/policyfile/storage_config"
27
+
28
+ require "chef-dk/policyfile/cookbook_location_specification"
29
+
30
+ module ChefDK
31
+
32
+ module Policyfile
33
+
34
+ # Base class for CookbookLock implementations
35
+ class CookbookLock
36
+
37
+ REQUIRED_LOCK_DATA_KEYS = %w{version identifier dotted_decimal_identifier cache_key source_options}
38
+ REQUIRED_LOCK_DATA_KEYS.each(&:freeze)
39
+ REQUIRED_LOCK_DATA_KEYS.freeze
40
+
41
+ include Policyfile::StorageConfigDelegation
42
+
43
+ # The cookbook name (without any version or other info suffixed)
44
+ attr_reader :name
45
+
46
+ # Options specifying the source and revision of this cookbook. These can
47
+ # be passed to a CookbookLocationSpecification to create an object that can install the
48
+ # same revision of the cookbook on another machine.
49
+ attr_accessor :source_options
50
+
51
+ # A string that uniquely identifies the cookbook version. If not
52
+ # explicitly set, an identifier is generated based on the cookbook's
53
+ # content.
54
+ attr_accessor :identifier
55
+
56
+ # A string in "X.Y.Z" version number format that uniquely identifies the
57
+ # cookbook version. This is for compatibility with Chef Server 11.x,
58
+ # where cookbooks are stored by x.y.z version numbers.
59
+ attr_accessor :dotted_decimal_identifier
60
+
61
+ attr_reader :storage_config
62
+
63
+ attr_accessor :version
64
+
65
+ def initialize(name, storage_config)
66
+ @name = name
67
+ @version = nil
68
+ @source_options = nil
69
+ @identifier = nil
70
+ @dotted_decimal_identifier = nil
71
+ @storage_config = storage_config
72
+ end
73
+
74
+ def installed?
75
+ cookbook_location_spec.installed?
76
+ end
77
+
78
+ def install_locked
79
+ cookbook_location_spec.ensure_cached
80
+ end
81
+
82
+ def cookbook_location_spec
83
+ raise InvalidCookbookLockData, "Cannot create CookbookLocationSpecification for #{name} without version" if version.nil?
84
+ raise InvalidCookbookLockData, "Cannot create CookbookLocationSpecification for #{name} without source options" if source_options.nil?
85
+ @location_spec ||= CookbookLocationSpecification.new(name, "= #{version}", source_options, storage_config)
86
+ end
87
+
88
+ def dependencies
89
+ cookbook_location_spec.dependencies
90
+ end
91
+
92
+ def gather_profile_data
93
+ @identifier ||= identifiers.content_identifier
94
+ @dotted_decimal_identifier ||= identifiers.dotted_decimal_identifier
95
+ @version ||= identifiers.semver_version
96
+ end
97
+
98
+ def identifiers
99
+ @identifiers ||= CookbookProfiler::Identifiers.new(cookbook_version)
100
+ end
101
+
102
+ def cookbook_path
103
+ raise NotImplementedError, "#{self.class} must override #cookbook_path with a specific implementation"
104
+ end
105
+
106
+ def to_lock
107
+ validate!
108
+ lock_data
109
+ end
110
+
111
+ def lock_data
112
+ raise NotImplementedError, "#{self.class} must override #lock_data a specific implementation"
113
+ end
114
+
115
+ def build_from_lock_data(lock_data)
116
+ raise NotImplementedError, "#{self.class} must override #build_from_lock_data with a specific implementation"
117
+ end
118
+
119
+ def validate!
120
+ raise NotImplementedError, "#{self.class} must override #validate! with a specific implementation"
121
+ end
122
+
123
+ def refresh!
124
+ raise NotImplementedError, "#{self.class} must override #refresh! with a specific implementation"
125
+ end
126
+
127
+ def updated?
128
+ false
129
+ end
130
+
131
+ def identifier_updated?
132
+ false
133
+ end
134
+
135
+ def version_updated?
136
+ false
137
+ end
138
+
139
+ def symbolize_source_options_keys(source_options_from_json)
140
+ source_options_from_json ||= {}
141
+ source_options_from_json.inject({}) do |normalized_source_opts, (key, value)|
142
+ normalized_source_opts[key.to_sym] = value
143
+ normalized_source_opts
144
+ end
145
+ end
146
+
147
+ def cookbook_version
148
+ @cookbook_version ||= cookbook_loader.cookbook_version
149
+ end
150
+
151
+ def cookbook_loader
152
+ @cookbook_loader ||=
153
+ begin
154
+ loader = Chef::Cookbook::CookbookVersionLoader.new(cookbook_path, chefignore)
155
+ loader.load!
156
+ loader
157
+ end
158
+ end
159
+
160
+ def chefignore
161
+ @chefignore ||= Chef::Cookbook::Chefignore.new(File.join(cookbook_path, "chefignore"))
162
+ end
163
+
164
+ private
165
+
166
+ def assert_required_keys_valid!(lock_data)
167
+ missing_keys = REQUIRED_LOCK_DATA_KEYS.reject { |key| lock_data.key?(key) }
168
+ unless missing_keys.empty?
169
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} missing required attributes `#{missing_keys.join("', `")}'"
170
+ end
171
+
172
+ version = lock_data["version"]
173
+ unless version.kind_of?(String)
174
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `version' attribute must be a string (got: #{version})"
175
+ end
176
+
177
+ identifier = lock_data["identifier"]
178
+ unless identifier.kind_of?(String)
179
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `identifier' attribute must be a string (got: #{identifier})"
180
+ end
181
+
182
+ cache_key = lock_data["cache_key"]
183
+ unless cache_key.kind_of?(String) || cache_key.nil?
184
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `cache_key' attribute must be a string (got: #{cache_key})"
185
+ end
186
+
187
+ source_options = lock_data["source_options"]
188
+ unless source_options.kind_of?(Hash)
189
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `source_options' attribute must be a Hash (JSON object) (got: #{source_options})"
190
+ end
191
+ end
192
+
193
+ end
194
+
195
+ # CachedCookbook objects represent a cookbook that has been fetched from an
196
+ # upstream canonical source and stored (presumed unmodified).
197
+ class CachedCookbook < CookbookLock
198
+
199
+ # The directory name in the cookbook cache where the cookbook is stored.
200
+ # By convention, this should be the name of the cookbook followed by a
201
+ # hyphen and then some sort of version identifier (depending on the
202
+ # cookbook source).
203
+ attr_accessor :cache_key
204
+
205
+ # A URI pointing to the canonical source of the cookbook.
206
+ attr_accessor :origin
207
+
208
+ def initialize(name, storage_config)
209
+ @name = name
210
+ @version = nil
211
+ @origin = nil
212
+ @source_options = nil
213
+ @cache_key = nil
214
+ @identifier = nil
215
+ @dotted_decimal_identifier = nil
216
+ @storage_config = storage_config
217
+ end
218
+
219
+ def cookbook_path
220
+ if cache_key.nil?
221
+ raise MissingCookbookLockData, "Cannot locate cached cookbook `#{name}' because the `cache_key' attribute is not set"
222
+ end
223
+ File.join(cache_path, cache_key)
224
+ end
225
+
226
+ def build_from_lock_data(lock_data)
227
+ assert_required_keys_valid!(lock_data)
228
+
229
+ @version = lock_data["version"]
230
+ @identifier = lock_data["identifier"]
231
+ @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
232
+ @cache_key = lock_data["cache_key"]
233
+ @origin = lock_data["origin"]
234
+ @source_options = symbolize_source_options_keys(lock_data["source_options"])
235
+ end
236
+
237
+ def lock_data
238
+ {
239
+ "version" => version,
240
+ "identifier" => identifier,
241
+ "dotted_decimal_identifier" => dotted_decimal_identifier,
242
+ "cache_key" => cache_key,
243
+ "origin" => origin,
244
+ "source_options" => source_options,
245
+ }
246
+ end
247
+
248
+ def validate!
249
+ if cache_key.nil?
250
+ raise CachedCookbookNotFound, "Cookbook `#{name}' does not have a `cache_key` set, cannot locate cookbook"
251
+ end
252
+ unless File.exist?(cookbook_path)
253
+ raise CachedCookbookNotFound, "Cookbook `#{name}' not found at expected cache location `#{cache_key}' (full path: `#{cookbook_path}')"
254
+ end
255
+ end
256
+
257
+ # We do not expect the cookbook to get mutated out-of-band, so refreshing
258
+ # the data generally should have no affect. If the cookbook has been
259
+ # mutated, though, then a CachedCookbookModified exception is raised.
260
+ def refresh!
261
+ # This behavior fits better with the intent of the #validate! method,
262
+ # but we cannot check for modifications there because the user may be
263
+ # setting custom identifiers.
264
+ if @identifier && identifiers.content_identifier != @identifier
265
+ message = "Cached cookbook `#{name}' (#{version}) has been modified since the lockfile was generated. " +
266
+ "Cached cookbooks cannot be modified. (full path: `#{cookbook_path}')"
267
+ raise CachedCookbookModified, message
268
+ end
269
+ end
270
+
271
+ end
272
+
273
+ # LocalCookbook objects represent cookbooks that are sourced from the local
274
+ # filesystem and are assumed to be under active development.
275
+ class LocalCookbook < CookbookLock
276
+
277
+ # A relative or absolute path to the cookbook. If a relative path is
278
+ # given, it is resolved relative to #relative_paths_root
279
+ attr_accessor :source
280
+
281
+ def initialize(name, storage_config)
282
+ @name = name
283
+ @identifier = nil
284
+ @storage_config = storage_config
285
+
286
+ @identifier_updated = false
287
+ @version_updated = false
288
+ @cookbook_in_git_repo = nil
289
+ @scm_info = nil
290
+ end
291
+
292
+ def cookbook_path
293
+ File.expand_path(source, relative_paths_root)
294
+ end
295
+
296
+ def scm_profiler
297
+ if cookbook_in_git_repo?
298
+ CookbookProfiler::Git.new(cookbook_path)
299
+ else
300
+ CookbookProfiler::NullSCM.new(cookbook_path)
301
+ end
302
+ end
303
+
304
+ def scm_info
305
+ @scm_info
306
+ end
307
+
308
+ def to_lock
309
+ refresh_scm_info
310
+ super
311
+ end
312
+
313
+ def lock_data
314
+ {
315
+ "version" => version,
316
+ "identifier" => identifier,
317
+ "dotted_decimal_identifier" => dotted_decimal_identifier,
318
+ "source" => source,
319
+ "cache_key" => nil,
320
+ "scm_info" => scm_info,
321
+ "source_options" => source_options,
322
+ }
323
+ end
324
+
325
+ def build_from_lock_data(lock_data)
326
+ assert_required_keys_valid!(lock_data)
327
+
328
+ @version = lock_data["version"]
329
+ @identifier = lock_data["identifier"]
330
+ @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
331
+ @source = lock_data["source"]
332
+ @source_options = symbolize_source_options_keys(lock_data["source_options"])
333
+ @scm_info = lock_data["scm_info"]
334
+ end
335
+
336
+ def validate!
337
+ if source.nil?
338
+ raise LocalCookbookNotFound, "Cookbook `#{name}' does not have a `source` set, cannot locate cookbook"
339
+ end
340
+ unless File.exist?(cookbook_path)
341
+ raise LocalCookbookNotFound, "Cookbook `#{name}' not found at path source `#{source}` (full path: `#{cookbook_path}')"
342
+ end
343
+ unless cookbook_version.name.to_s == name
344
+ msg = "The cookbook at path source `#{source}' is expected to be named `#{name}', but is now named `#{cookbook_version.name}' (full path: #{cookbook_path})"
345
+ raise MalformedCookbook, msg
346
+ end
347
+ end
348
+
349
+ def refresh!
350
+ old_identifier, old_version = @identifier, @version
351
+ @identifier, @dotted_decimal_identifier, @version = nil, nil, nil
352
+ gather_profile_data
353
+ if @identifier != old_identifier
354
+ @identifier_updated = true
355
+ end
356
+ if @version != old_version
357
+ @version_updated = true
358
+ end
359
+ self
360
+ end
361
+
362
+ def updated?
363
+ @identifier_updated || @version_updated
364
+ end
365
+
366
+ def version_updated?
367
+ @version_updated
368
+ end
369
+
370
+ def identifier_updated?
371
+ @identifier_updated
372
+ end
373
+
374
+ private
375
+
376
+ def refresh_scm_info
377
+ @scm_info = scm_profiler.profile_data
378
+ end
379
+
380
+ def assert_required_keys_valid!(lock_data)
381
+ super
382
+
383
+ source = lock_data["source"]
384
+ if source.nil?
385
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid. Lock data for a local cookbook must have a `source' attribute"
386
+ end
387
+
388
+ unless source.kind_of?(String)
389
+ raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid: `source' attribute must be a String (got: #{source.inspect})"
390
+ end
391
+ end
392
+
393
+ def cookbook_in_git_repo?
394
+ return @cookbook_in_git_repo unless @cookbook_in_git_repo.nil?
395
+
396
+ @cookbook_in_git_repo = false
397
+
398
+ dot_git = Pathname.new(".git")
399
+ Pathname.new(cookbook_path).ascend do |parent_dir|
400
+ possbile_git_dir = parent_dir + dot_git
401
+ if possbile_git_dir.exist?
402
+ @cookbook_in_git_repo = true
403
+ break
404
+ end
405
+ end
406
+
407
+ @cookbook_in_git_repo
408
+ end
409
+
410
+ end
411
+
412
+ class ArchivedCookbook < CookbookLock
413
+
414
+ extend Forwardable
415
+
416
+ def_delegator :@archived_lock, :name
417
+ def_delegator :@archived_lock, :source_options
418
+ def_delegator :@archived_lock, :identifier
419
+ def_delegator :@archived_lock, :dotted_decimal_identifier
420
+ def_delegator :@archived_lock, :version
421
+ def_delegator :@archived_lock, :source
422
+
423
+ # #to_lock calls #validate! which will typically ensure that the cookbook
424
+ # is present at the correct path for the lock type. For an archived
425
+ # cookbook, the cookbook is located in the archive, so it probably won't
426
+ # exist there. Therefore, we bypass #validate! and get the lock data
427
+ # directly.
428
+ def_delegator :@archived_lock, :lock_data, :to_lock
429
+
430
+ def initialize(archived_lock, storage_config)
431
+ @archived_lock = archived_lock
432
+ @storage_config = storage_config
433
+ end
434
+
435
+ def build_from_lock_data(lock_data)
436
+ raise NotImplementedError, "ArchivedCookbook cannot be built from lock data, it can only wrap an existing lock object"
437
+ end
438
+
439
+ def installed?
440
+ File.exist?(cookbook_path) && File.directory?(cookbook_path)
441
+ end
442
+
443
+ # The cookbook is assumed to be stored in a Chef Zero compatible repo as
444
+ # created by `chef export`. Currently that only creates "compatibility
445
+ # mode" repos since Chef Zero doesn't yet support cookbook_artifact APIs.
446
+ # So the cookbook will be located in a path like:
447
+ # cookbooks/nginx-111.222.333
448
+ def cookbook_path
449
+ File.join(relative_paths_root, "cookbook_artifacts", "#{name}-#{identifier}")
450
+ end
451
+
452
+ # We trust that archived cookbooks haven't been modified, so just return
453
+ # true for #validate!
454
+ def validate!
455
+ true
456
+ end
457
+
458
+ # We trust that archived cookbooks haven't been modified, so just return
459
+ # true for #refresh!
460
+ def refresh!
461
+ true
462
+ end
463
+ end
464
+
465
+ end
466
+ end