chef-dk 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (306) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +190 -190
  3. data/Gemfile +26 -26
  4. data/LICENSE +201 -201
  5. data/README.md +292 -276
  6. data/Rakefile +18 -18
  7. data/bin/chef +25 -25
  8. data/chef-dk.gemspec +62 -0
  9. data/lib/chef-dk.rb +19 -19
  10. data/lib/chef-dk/authenticated_http.rb +40 -40
  11. data/lib/chef-dk/builtin_commands.rb +60 -60
  12. data/lib/chef-dk/chef_runner.rb +98 -98
  13. data/lib/chef-dk/cli.rb +200 -200
  14. data/lib/chef-dk/command/base.rb +79 -79
  15. data/lib/chef-dk/command/clean_policy_cookbooks.rb +116 -116
  16. data/lib/chef-dk/command/clean_policy_revisions.rb +113 -113
  17. data/lib/chef-dk/command/delete_policy.rb +122 -122
  18. data/lib/chef-dk/command/delete_policy_group.rb +122 -122
  19. data/lib/chef-dk/command/diff.rb +316 -316
  20. data/lib/chef-dk/command/env.rb +90 -90
  21. data/lib/chef-dk/command/exec.rb +45 -45
  22. data/lib/chef-dk/command/export.rb +151 -151
  23. data/lib/chef-dk/command/gem.rb +47 -47
  24. data/lib/chef-dk/command/generate.rb +120 -120
  25. data/lib/chef-dk/command/generator_commands.rb +80 -80
  26. data/lib/chef-dk/command/generator_commands/app.rb +107 -107
  27. data/lib/chef-dk/command/generator_commands/attribute.rb +37 -37
  28. data/lib/chef-dk/command/generator_commands/base.rb +121 -121
  29. data/lib/chef-dk/command/generator_commands/cookbook.rb +153 -119
  30. data/lib/chef-dk/command/generator_commands/cookbook_code_file.rb +100 -100
  31. data/lib/chef-dk/command/generator_commands/cookbook_file.rb +45 -45
  32. data/lib/chef-dk/command/generator_commands/generator_generator.rb +177 -177
  33. data/lib/chef-dk/command/generator_commands/lwrp.rb +36 -36
  34. data/lib/chef-dk/command/generator_commands/policyfile.rb +127 -86
  35. data/lib/chef-dk/command/generator_commands/recipe.rb +36 -36
  36. data/lib/chef-dk/command/generator_commands/repo.rb +125 -96
  37. data/lib/chef-dk/command/generator_commands/template.rb +46 -46
  38. data/lib/chef-dk/command/install.rb +121 -121
  39. data/lib/chef-dk/command/provision.rb +438 -438
  40. data/lib/chef-dk/command/push.rb +118 -118
  41. data/lib/chef-dk/command/push_archive.rb +126 -126
  42. data/lib/chef-dk/command/shell_init.rb +180 -180
  43. data/lib/chef-dk/command/show_policy.rb +165 -165
  44. data/lib/chef-dk/command/undelete.rb +155 -155
  45. data/lib/chef-dk/command/update.rb +129 -129
  46. data/lib/chef-dk/command/verify.rb +534 -490
  47. data/lib/chef-dk/commands_map.rb +115 -115
  48. data/lib/chef-dk/completions/bash.sh.erb +5 -5
  49. data/lib/chef-dk/completions/chef.fish.erb +10 -10
  50. data/lib/chef-dk/completions/zsh.zsh.erb +21 -21
  51. data/lib/chef-dk/component_test.rb +173 -171
  52. data/lib/chef-dk/configurable.rb +57 -57
  53. data/lib/chef-dk/cookbook_metadata.rb +45 -45
  54. data/lib/chef-dk/cookbook_omnifetch.rb +32 -32
  55. data/lib/chef-dk/cookbook_profiler/git.rb +151 -151
  56. data/lib/chef-dk/cookbook_profiler/identifiers.rb +72 -72
  57. data/lib/chef-dk/cookbook_profiler/null_scm.rb +32 -32
  58. data/lib/chef-dk/exceptions.rb +126 -113
  59. data/lib/chef-dk/generator.rb +163 -163
  60. data/lib/chef-dk/helpers.rb +159 -159
  61. data/lib/chef-dk/pager.rb +106 -106
  62. data/lib/chef-dk/policyfile/chef_repo_cookbook_source.rb +138 -122
  63. data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb +54 -54
  64. data/lib/chef-dk/policyfile/community_cookbook_source.rb +97 -82
  65. data/lib/chef-dk/policyfile/comparison_base.rb +124 -124
  66. data/lib/chef-dk/policyfile/cookbook_location_specification.rb +141 -133
  67. data/lib/chef-dk/policyfile/cookbook_locks.rb +466 -466
  68. data/lib/chef-dk/policyfile/cookbook_sources.rb +22 -21
  69. data/lib/chef-dk/policyfile/delivery_supermarket_source.rb +90 -0
  70. data/lib/chef-dk/policyfile/differ.rb +266 -266
  71. data/lib/chef-dk/policyfile/dsl.rb +223 -197
  72. data/lib/chef-dk/policyfile/lister.rb +232 -232
  73. data/lib/chef-dk/policyfile/null_cookbook_source.rb +45 -45
  74. data/lib/chef-dk/policyfile/read_cookbook_for_compat_mode_upload.rb +124 -124
  75. data/lib/chef-dk/policyfile/reports/install.rb +70 -70
  76. data/lib/chef-dk/policyfile/reports/table_printer.rb +58 -58
  77. data/lib/chef-dk/policyfile/reports/upload.rb +70 -70
  78. data/lib/chef-dk/policyfile/solution_dependencies.rb +298 -298
  79. data/lib/chef-dk/policyfile/storage_config.rb +100 -100
  80. data/lib/chef-dk/policyfile/undo_record.rb +142 -142
  81. data/lib/chef-dk/policyfile/undo_stack.rb +130 -130
  82. data/lib/chef-dk/policyfile/uploader.rb +213 -213
  83. data/lib/chef-dk/policyfile_compiler.rb +380 -322
  84. data/lib/chef-dk/policyfile_lock.rb +552 -552
  85. data/lib/chef-dk/policyfile_services/clean_policies.rb +95 -95
  86. data/lib/chef-dk/policyfile_services/clean_policy_cookbooks.rb +125 -125
  87. data/lib/chef-dk/policyfile_services/export_repo.rb +309 -309
  88. data/lib/chef-dk/policyfile_services/install.rb +125 -125
  89. data/lib/chef-dk/policyfile_services/push.rb +114 -114
  90. data/lib/chef-dk/policyfile_services/push_archive.rb +173 -173
  91. data/lib/chef-dk/policyfile_services/rm_policy.rb +142 -142
  92. data/lib/chef-dk/policyfile_services/rm_policy_group.rb +86 -86
  93. data/lib/chef-dk/policyfile_services/show_policy.rb +237 -237
  94. data/lib/chef-dk/policyfile_services/undelete.rb +108 -108
  95. data/lib/chef-dk/policyfile_services/update_attributes.rb +104 -104
  96. data/lib/chef-dk/service_exception_inspectors.rb +25 -25
  97. data/lib/chef-dk/service_exception_inspectors/base.rb +40 -40
  98. data/lib/chef-dk/service_exception_inspectors/http.rb +121 -121
  99. data/lib/chef-dk/service_exceptions.rb +143 -143
  100. data/lib/chef-dk/shell_out.rb +36 -36
  101. data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile +3 -3
  102. data/lib/chef-dk/skeletons/code_generator/files/default/chefignore +100 -100
  103. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README-policy.md +9 -9
  104. data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md +54 -54
  105. data/lib/chef-dk/skeletons/code_generator/files/default/gitignore +16 -16
  106. data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md +28 -28
  107. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/README.md +27 -27
  108. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb +7 -7
  109. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb +3 -3
  110. data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb +8 -8
  111. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md +58 -58
  112. data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json +3 -3
  113. data/lib/chef-dk/skeletons/code_generator/files/default/repo/dot-chef-repo.txt +6 -0
  114. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md +9 -9
  115. data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/example.json +12 -12
  116. data/lib/chef-dk/skeletons/code_generator/files/default/repo/policies/README.md +24 -0
  117. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md +9 -9
  118. data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/example.json +12 -12
  119. data/lib/chef-dk/skeletons/code_generator/files/default/serverspec_spec_helper.rb +8 -8
  120. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb +2 -2
  121. data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper_policyfile.rb +2 -0
  122. data/lib/chef-dk/skeletons/code_generator/metadata.rb +8 -8
  123. data/lib/chef-dk/skeletons/code_generator/recipes/app.rb +97 -97
  124. data/lib/chef-dk/skeletons/code_generator/recipes/attribute.rb +12 -12
  125. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb +117 -104
  126. data/lib/chef-dk/skeletons/code_generator/recipes/cookbook_file.rb +24 -24
  127. data/lib/chef-dk/skeletons/code_generator/recipes/lwrp.rb +23 -23
  128. data/lib/chef-dk/skeletons/code_generator/recipes/policyfile.rb +8 -8
  129. data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb +27 -27
  130. data/lib/chef-dk/skeletons/code_generator/recipes/repo.rb +67 -48
  131. data/lib/chef-dk/skeletons/code_generator/recipes/template.rb +32 -32
  132. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.all_rights.erb +3 -3
  133. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.apache2.erb +201 -201
  134. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv2.erb +339 -339
  135. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.gplv3.erb +674 -674
  136. data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.mit.erb +21 -21
  137. data/lib/chef-dk/skeletons/code_generator/templates/default/Policyfile.rb.erb +25 -20
  138. data/lib/chef-dk/skeletons/code_generator/templates/default/README.md.erb +4 -4
  139. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb +21 -16
  140. data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen_policyfile.yml.erb +32 -27
  141. data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb +7 -7
  142. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb +5 -5
  143. data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb +20 -20
  144. data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb +11 -11
  145. data/lib/chef-dk/skeletons/code_generator/templates/default/serverspec_default_spec.rb.erb +9 -9
  146. data/lib/chef-dk/ui.rb +58 -58
  147. data/lib/chef-dk/version.rb +20 -20
  148. data/lib/kitchen/provisioner/policyfile_zero.rb +189 -193
  149. data/spec/shared/a_file_generator.rb +125 -125
  150. data/spec/shared/a_generated_file.rb +12 -12
  151. data/spec/shared/command_with_ui_object.rb +11 -11
  152. data/spec/shared/custom_generator_cookbook.rb +117 -117
  153. data/spec/shared/fixture_cookbook_checksums.rb +47 -47
  154. data/spec/shared/setup_git_cookbooks.rb +53 -53
  155. data/spec/spec_helper.rb +50 -49
  156. data/spec/test_helpers.rb +84 -84
  157. data/spec/unit/chef_runner_spec.rb +111 -111
  158. data/spec/unit/cli_spec.rb +357 -357
  159. data/spec/unit/command/base_spec.rb +169 -169
  160. data/spec/unit/command/clean_policy_cookbooks_spec.rb +181 -181
  161. data/spec/unit/command/clean_policy_revisions_spec.rb +181 -181
  162. data/spec/unit/command/delete_policy_group_spec.rb +207 -207
  163. data/spec/unit/command/delete_policy_spec.rb +207 -207
  164. data/spec/unit/command/diff_spec.rb +312 -312
  165. data/spec/unit/command/env_spec.rb +52 -52
  166. data/spec/unit/command/exec_spec.rb +179 -179
  167. data/spec/unit/command/export_spec.rb +189 -189
  168. data/spec/unit/command/generate_spec.rb +142 -142
  169. data/spec/unit/command/generator_commands/app_spec.rb +169 -169
  170. data/spec/unit/command/generator_commands/attribute_spec.rb +32 -32
  171. data/spec/unit/command/generator_commands/cookbook_file_spec.rb +32 -32
  172. data/spec/unit/command/generator_commands/cookbook_spec.rb +450 -320
  173. data/spec/unit/command/generator_commands/generator_generator_spec.rb +229 -229
  174. data/spec/unit/command/generator_commands/lwrp_spec.rb +32 -32
  175. data/spec/unit/command/generator_commands/policyfile_spec.rb +225 -125
  176. data/spec/unit/command/generator_commands/recipe_spec.rb +34 -34
  177. data/spec/unit/command/generator_commands/repo_spec.rb +367 -283
  178. data/spec/unit/command/generator_commands/template_spec.rb +32 -32
  179. data/spec/unit/command/install_spec.rb +179 -179
  180. data/spec/unit/command/provision_spec.rb +592 -592
  181. data/spec/unit/command/push_archive_spec.rb +153 -153
  182. data/spec/unit/command/push_spec.rb +199 -199
  183. data/spec/unit/command/shell_init_spec.rb +329 -329
  184. data/spec/unit/command/show_policy_spec.rb +235 -235
  185. data/spec/unit/command/undelete_spec.rb +246 -246
  186. data/spec/unit/command/update_spec.rb +251 -251
  187. data/spec/unit/command/verify_spec.rb +325 -323
  188. data/spec/unit/commands_map_spec.rb +57 -57
  189. data/spec/unit/component_test_spec.rb +126 -126
  190. data/spec/unit/cookbook_metadata_spec.rb +98 -98
  191. data/spec/unit/cookbook_profiler/git_spec.rb +176 -176
  192. data/spec/unit/cookbook_profiler/identifiers_spec.rb +83 -83
  193. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb +9 -9
  194. data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb +9 -9
  195. data/spec/unit/fixtures/command/cli_test_command.rb +26 -26
  196. data/spec/unit/fixtures/command/explicit_path_example.rb +7 -7
  197. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  198. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile +3 -3
  199. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  200. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/chefignore +96 -96
  201. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  202. data/spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  203. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/.kitchen.yml +16 -16
  204. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/Berksfile +3 -3
  205. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/README.md +4 -4
  206. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/chefignore +96 -96
  207. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/metadata.rb +8 -8
  208. data/spec/unit/fixtures/cookbook_cache/dep_of_bar-1.2.3/recipes/default.rb +8 -8
  209. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/.kitchen.yml +16 -16
  210. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/Berksfile +3 -3
  211. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/README.md +4 -4
  212. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/chefignore +96 -96
  213. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/metadata.rb +8 -8
  214. data/spec/unit/fixtures/cookbook_cache/foo-1.0.0/recipes/default.rb +8 -8
  215. data/spec/unit/fixtures/cookbooks_api/pruned_small_universe.json +1321 -1321
  216. data/spec/unit/fixtures/cookbooks_api/small_universe.json +2987 -2987
  217. data/spec/unit/fixtures/cookbooks_api/universe.json +1 -1
  218. data/spec/unit/fixtures/cookbooks_api/update_fixtures.rb +36 -36
  219. data/spec/unit/fixtures/dev_cookbooks/README.md +16 -16
  220. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/integration_test +2 -2
  221. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/berkshelf/verify_me +5 -5
  222. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/chef/verify_me +3 -3
  223. data/spec/unit/fixtures/eg_omnibus_dir/valid/embedded/apps/test-kitchen/verify_me +2 -2
  224. data/spec/unit/fixtures/example_cookbook/.gitignore +17 -17
  225. data/spec/unit/fixtures/example_cookbook/.kitchen.yml +16 -16
  226. data/spec/unit/fixtures/example_cookbook/Berksfile +3 -3
  227. data/spec/unit/fixtures/example_cookbook/README.md +4 -4
  228. data/spec/unit/fixtures/example_cookbook/chefignore +96 -96
  229. data/spec/unit/fixtures/example_cookbook/metadata.rb +8 -8
  230. data/spec/unit/fixtures/example_cookbook/recipes/default.rb +8 -8
  231. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore +17 -17
  232. data/spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml +16 -16
  233. data/spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile +3 -3
  234. data/spec/unit/fixtures/example_cookbook_metadata_json_only/README.md +4 -4
  235. data/spec/unit/fixtures/example_cookbook_metadata_json_only/chefignore +96 -96
  236. data/spec/unit/fixtures/example_cookbook_metadata_json_only/metadata.json +5 -5
  237. data/spec/unit/fixtures/example_cookbook_metadata_json_only/recipes/default.rb +8 -8
  238. data/spec/unit/fixtures/example_cookbook_no_metadata/.gitignore +17 -17
  239. data/spec/unit/fixtures/example_cookbook_no_metadata/.kitchen.yml +16 -16
  240. data/spec/unit/fixtures/example_cookbook_no_metadata/Berksfile +3 -3
  241. data/spec/unit/fixtures/example_cookbook_no_metadata/README.md +4 -4
  242. data/spec/unit/fixtures/example_cookbook_no_metadata/chefignore +96 -96
  243. data/spec/unit/fixtures/example_cookbook_no_metadata/recipes/default.rb +8 -8
  244. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/README.md +4 -4
  245. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/chefignore +96 -96
  246. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/metadata.rb +8 -8
  247. data/spec/unit/fixtures/local_path_cookbooks/another-local-cookbook/recipes/default.rb +8 -8
  248. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/Berksfile +3 -3
  249. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/README.md +4 -4
  250. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/chefignore +96 -96
  251. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/metadata.rb +9 -9
  252. data/spec/unit/fixtures/local_path_cookbooks/cookbook-with-a-dep/recipes/default.rb +8 -8
  253. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/.kitchen.yml +16 -16
  254. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/Berksfile +3 -3
  255. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/README.md +4 -4
  256. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/chefignore +96 -96
  257. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/metadata.rb +8 -8
  258. data/spec/unit/fixtures/local_path_cookbooks/local-cookbook/recipes/default.rb +8 -8
  259. data/spec/unit/fixtures/local_path_cookbooks/metadata-missing/README.md +2 -2
  260. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml +16 -16
  261. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md +4 -4
  262. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/metadata.rb +8 -8
  263. data/spec/unit/fixtures/local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/recipes/default.rb +8 -8
  264. data/spec/unit/generator_spec.rb +120 -120
  265. data/spec/unit/helpers_spec.rb +92 -92
  266. data/spec/unit/pager_spec.rb +119 -119
  267. data/spec/unit/policyfile/chef_repo_cookbook_source_spec.rb +93 -66
  268. data/spec/unit/policyfile/chef_server_cookbook_source_spec.rb +34 -34
  269. data/spec/unit/policyfile/community_cookbook_source_spec.rb +84 -51
  270. data/spec/unit/policyfile/comparison_base_spec.rb +343 -343
  271. data/spec/unit/policyfile/cookbook_location_specification_spec.rb +257 -252
  272. data/spec/unit/policyfile/cookbook_locks_spec.rb +529 -529
  273. data/spec/unit/policyfile/delivery_supermarket_source_spec.rb +130 -0
  274. data/spec/unit/policyfile/differ_spec.rb +687 -687
  275. data/spec/unit/policyfile/lister_spec.rb +272 -272
  276. data/spec/unit/policyfile/null_cookbook_source_spec.rb +35 -35
  277. data/spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb +92 -92
  278. data/spec/unit/policyfile/reports/install_spec.rb +115 -115
  279. data/spec/unit/policyfile/reports/upload_spec.rb +96 -96
  280. data/spec/unit/policyfile/solution_dependencies_spec.rb +145 -145
  281. data/spec/unit/policyfile/storage_config_spec.rb +172 -172
  282. data/spec/unit/policyfile/undo_record_spec.rb +260 -260
  283. data/spec/unit/policyfile/undo_stack_spec.rb +266 -266
  284. data/spec/unit/policyfile/uploader_spec.rb +410 -410
  285. data/spec/unit/policyfile_demands_spec.rb +997 -876
  286. data/spec/unit/policyfile_evaluation_spec.rb +557 -441
  287. data/spec/unit/policyfile_lock_build_spec.rb +1056 -1056
  288. data/spec/unit/policyfile_lock_install_spec.rb +138 -138
  289. data/spec/unit/policyfile_lock_serialization_spec.rb +425 -425
  290. data/spec/unit/policyfile_lock_validation_spec.rb +611 -611
  291. data/spec/unit/policyfile_services/clean_policies_spec.rb +236 -236
  292. data/spec/unit/policyfile_services/clean_policy_cookbooks_spec.rb +275 -275
  293. data/spec/unit/policyfile_services/export_repo_spec.rb +439 -439
  294. data/spec/unit/policyfile_services/install_spec.rb +191 -191
  295. data/spec/unit/policyfile_services/push_archive_spec.rb +345 -345
  296. data/spec/unit/policyfile_services/push_spec.rb +233 -233
  297. data/spec/unit/policyfile_services/rm_policy_group_spec.rb +241 -241
  298. data/spec/unit/policyfile_services/rm_policy_spec.rb +266 -266
  299. data/spec/unit/policyfile_services/show_policy_spec.rb +889 -889
  300. data/spec/unit/policyfile_services/undelete_spec.rb +304 -304
  301. data/spec/unit/policyfile_services/update_attributes_spec.rb +217 -217
  302. data/spec/unit/service_exception_inspectors/base_spec.rb +43 -43
  303. data/spec/unit/service_exception_inspectors/http_spec.rb +140 -140
  304. data/spec/unit/shell_out_spec.rb +34 -34
  305. data/warning.txt +9 -0
  306. metadata +18 -5
@@ -1,611 +1,611 @@
1
- #
2
- # Copyright:: Copyright (c) 2014 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 'spec_helper'
19
- require 'chef-dk/policyfile_lock.rb'
20
-
21
- describe ChefDK::PolicyfileLock, "validating locked cookbooks" do
22
-
23
- include ChefDK::Helpers
24
-
25
- let(:pristine_cache_path) do
26
- File.expand_path("spec/unit/fixtures/cookbook_cache", project_root)
27
- end
28
-
29
- let(:cache_path) do
30
- temp_cache_path = File.join(tempdir, "local_cache")
31
- FileUtils.cp_r(pristine_cache_path, temp_cache_path)
32
- temp_cache_path
33
- end
34
-
35
- let(:policyfile_lock_path) { "/fakepath/Policyfile.lock.json" }
36
-
37
- let(:local_cookbooks_root) do
38
- temp_local_path_cookbooks = File.join(tempdir, "local_path_cookbooks")
39
- FileUtils.cp_r(File.join(fixtures_path, "local_path_cookbooks"), temp_local_path_cookbooks)
40
- temp_local_path_cookbooks
41
- end
42
-
43
- let(:name) { "application-server" }
44
-
45
- let(:run_list) { [ 'recipe[erlang::default]', 'recipe[erchef::prereqs]', 'recipe[erchef::app]' ] }
46
-
47
- let(:storage_config) do
48
- ChefDK::Policyfile::StorageConfig.new( cache_path: cache_path, relative_paths_root: local_cookbooks_root )
49
- end
50
-
51
- let(:solution_dependencies) do
52
- {
53
- "Policyfile" => [],
54
- "dependencies" => {
55
- "foo (1.0.0)" => [],
56
- "local-cookbook (2.3.4)" => []
57
- }
58
- }
59
- end
60
-
61
- let(:lock_generator) do
62
- ChefDK::PolicyfileLock.build(storage_config) do |policy|
63
-
64
- policy.name = name
65
-
66
- policy.run_list = run_list
67
-
68
- policy.cached_cookbook("foo") do |c|
69
- c.origin = "https://artifact-server.example/foo/1.0.0"
70
- c.cache_key = "foo-1.0.0"
71
- c.source_options = { artifactserver: "https://artifact-server.example/foo/1.0.0", version: "1.0.0" }
72
- end
73
-
74
- policy.local_cookbook("local-cookbook") do |c|
75
- c.source = "local-cookbook"
76
- c.source_options = { path: "local-cookbook" }
77
- end
78
-
79
- policy.solution_dependencies.consume_lock_data(solution_dependencies)
80
- end
81
- end
82
-
83
- let(:lock_data) do
84
- lock_generator.to_lock
85
- end
86
-
87
- # Eagerly evaluate #policyfile_lock. This is necessary because many of
88
- # the tests follow this general process:
89
- # 1. setup valid state, generate a lockfile in-memory
90
- # 2. make the state invalid
91
- # 3. ensure validation detected the invalid state
92
- #
93
- # With lazy evaluation, #1 may happen after #2.
94
- let!(:policyfile_lock) do
95
- ChefDK::PolicyfileLock.new(storage_config).build_from_lock_data(lock_data)
96
- end
97
-
98
- let(:local_cookbook_path) { File.join(local_cookbooks_root, "local-cookbook") }
99
-
100
- context "when no cookbooks have changed" do
101
-
102
- it "validation succeeds" do
103
- expect(policyfile_lock.validate_cookbooks!).to be true
104
- end
105
-
106
- end
107
-
108
- describe "when a :path sourced cookbook has changed" do
109
-
110
- let(:metadata_path) { File.join(local_cookbook_path, "metadata.rb") }
111
-
112
- let(:cookbook_lock_data) { policyfile_lock.lock_data_for("local-cookbook") }
113
-
114
- # Validate the metadata is correct, so we know the test setup code
115
- # hasn't done something wrong.
116
- def ensure_metadata_as_expected!
117
- expected_metadata_rb=<<-E
118
- name 'local-cookbook'
119
- maintainer ''
120
- maintainer_email ''
121
- license ''
122
- description 'Installs/Configures local-cookbook'
123
- long_description 'Installs/Configures local-cookbook'
124
- version '2.3.4'
125
-
126
- E
127
- expect(IO.read(metadata_path)).to eq(expected_metadata_rb)
128
- end
129
-
130
- context "when the cookbook is missing" do
131
-
132
- before do
133
- FileUtils.rm_rf(local_cookbook_path)
134
- end
135
-
136
- it "reports the missing cookbook and fails validation" do
137
- full_path = File.expand_path(local_cookbook_path)
138
- message = "Cookbook `local-cookbook' not found at path source `local-cookbook` (full path: `#{full_path}')"
139
-
140
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::LocalCookbookNotFound, message)
141
- end
142
-
143
- end
144
-
145
- context "when the cookbook has an incorrect name" do
146
-
147
- let(:new_metadata) do
148
- <<-E
149
- name 'WRONG'
150
- maintainer ''
151
- maintainer_email ''
152
- license ''
153
- description 'Installs/Configures local-cookbook'
154
- long_description 'Installs/Configures local-cookbook'
155
- version '2.3.4'
156
-
157
- E
158
- end
159
-
160
-
161
- before do
162
- ensure_metadata_as_expected!
163
- with_file(metadata_path) { |f| f.print(new_metadata) }
164
- end
165
-
166
- it "reports the unexpected cookbook and fails validation" do
167
- policyfile_lock
168
-
169
- message = "The cookbook at path source `local-cookbook' is expected to be named `local-cookbook', but is now named `WRONG' (full path: #{local_cookbook_path})"
170
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::MalformedCookbook, message)
171
- end
172
-
173
- end
174
-
175
- context "when the cookbook has an updated version that violates no dependency constraints" do
176
-
177
- let(:new_metadata) do
178
- <<-E
179
- name 'local-cookbook'
180
- maintainer ''
181
- maintainer_email ''
182
- license ''
183
- description 'Installs/Configures local-cookbook'
184
- long_description 'Installs/Configures local-cookbook'
185
- version '2.3.5' # changed from 2.3.4
186
-
187
- E
188
- end
189
-
190
- before do
191
- ensure_metadata_as_expected!
192
- with_file(metadata_path) { |f| f.print(new_metadata) }
193
- policyfile_lock.validate_cookbooks! # no error
194
- end
195
-
196
- it "updates the version information in the lockfile" do
197
- expect(cookbook_lock_data.version).to eq("2.3.5")
198
- end
199
-
200
- it "updates the content identifier" do
201
- old_id = lock_generator.lock_data_for("local-cookbook").identifier
202
- expect(cookbook_lock_data.identifier).to_not eq(old_id)
203
- expect(cookbook_lock_data.identifier).to eq("d71622904ed89b1e0066bb4ae823b2a7b49a615a")
204
- end
205
-
206
- it "has an updated version and identifier" do
207
- expect(cookbook_lock_data).to be_updated
208
- expect(cookbook_lock_data.version_updated?).to be true
209
- expect(cookbook_lock_data.identifier_updated?).to be true
210
- end
211
- end
212
-
213
- context "when the cookbook has an updated version that violates other dependency constraints" do
214
-
215
- let(:solution_dependencies) do
216
- {
217
- "Policyfile" => [],
218
- "dependencies" => {
219
- "foo (1.0.0)" => [ [ "local-cookbook", "~> 2.0" ] ]
220
- }
221
- }
222
- end
223
-
224
- let(:new_metadata) do
225
- <<-E
226
- name 'local-cookbook'
227
- maintainer ''
228
- maintainer_email ''
229
- license ''
230
- description 'Installs/Configures local-cookbook'
231
- long_description 'Installs/Configures local-cookbook'
232
- version '3.0.0' # changed from 2.3.4, violates `~> 2.0` constraint
233
-
234
- E
235
- end
236
-
237
- before do
238
- ensure_metadata_as_expected!
239
- with_file(metadata_path) { |f| f.print(new_metadata) }
240
- end
241
-
242
- it "reports the dependency conflict and fails validation" do
243
- expected_message = "Cookbook local-cookbook (3.0.0) conflicts with other dependencies:\nfoo (1.0.0) depends on local-cookbook ~> 2.0"
244
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, expected_message)
245
- end
246
-
247
- end
248
-
249
- context "when a :path sourced cookbook has updated content" do
250
-
251
- let(:recipe_path) { File.join(local_cookbook_path, "recipes/default.rb") }
252
-
253
- let(:new_recipe) do
254
- <<-E
255
- # This is totally new code,
256
- # it is different than the old code
257
-
258
- E
259
- end
260
-
261
- before do
262
- ensure_metadata_as_expected!
263
- with_file(recipe_path) { |f| f.print(new_recipe) }
264
- policyfile_lock.validate_cookbooks! # no error
265
- end
266
-
267
- it "updates the lockfile with the new checksum and validation succeeds" do
268
- old_id = lock_generator.lock_data_for("local-cookbook").identifier
269
-
270
- expect(cookbook_lock_data.identifier).to_not eq(old_id)
271
- expect(cookbook_lock_data.identifier).to eq("08a96e3afbd1eaa1183a2dde8687ca29dbddc94b")
272
- end
273
-
274
- it "has an updated identifier but not an updated version" do
275
- expect(cookbook_lock_data).to be_updated
276
- expect(cookbook_lock_data.version_updated?).to be false
277
- expect(cookbook_lock_data.identifier_updated?).to be true
278
- end
279
-
280
- end
281
-
282
- context "when a :path source cookbook has added a dependency satisfied by the current cookbook set" do
283
-
284
- let(:new_metadata) do
285
- <<-E
286
- name 'local-cookbook'
287
- maintainer ''
288
- maintainer_email ''
289
- license ''
290
- description 'Installs/Configures local-cookbook'
291
- long_description 'Installs/Configures local-cookbook'
292
- version '2.3.4'
293
-
294
- depends "foo", "=1.0.0"
295
-
296
- E
297
- end
298
-
299
- before do
300
- ensure_metadata_as_expected!
301
- with_file(metadata_path) { |f| f.print(new_metadata) }
302
- policyfile_lock.validate_cookbooks! # no error
303
- end
304
-
305
- it "updates the lockfile with the new checksum and validation succeeds" do
306
- old_id = lock_generator.lock_data_for("local-cookbook").identifier
307
-
308
- expect(cookbook_lock_data.identifier).to_not eq(old_id)
309
- expect(cookbook_lock_data.identifier).to eq("da6a1c0f8791df713b7ff8c27285fbe7923901cc")
310
- end
311
-
312
- it "has an updated identifier but not an updated version" do
313
- expect(cookbook_lock_data).to be_updated
314
- expect(cookbook_lock_data.version_updated?).to be false
315
- expect(cookbook_lock_data.identifier_updated?).to be true
316
- end
317
-
318
- it "has an updated dependency set" do
319
- actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
320
- expected = {
321
- "local-cookbook (2.3.4)" => [ ["foo", "= 1.0.0"] ],
322
- "foo (1.0.0)" => []
323
- }
324
- expect(actual).to eq(expected)
325
- end
326
-
327
- end
328
-
329
- context "when a :path source cookbook has added a dependency not satisfied by the current cookbook set" do
330
-
331
- let(:new_metadata) do
332
- <<-E
333
- name 'local-cookbook'
334
- maintainer ''
335
- maintainer_email ''
336
- license ''
337
- description 'Installs/Configures local-cookbook'
338
- long_description 'Installs/Configures local-cookbook'
339
- version '2.3.4'
340
-
341
- depends "not-a-thing"
342
-
343
- E
344
- end
345
-
346
- before do
347
- ensure_metadata_as_expected!
348
- with_file(metadata_path) { |f| f.print(new_metadata) }
349
- end
350
-
351
- it "reports the not-satisfied dependency and validation fails" do
352
- error_message = "Cookbook local-cookbook (2.3.4) has dependency constraints that cannot be met by the existing cookbook set:\n" +
353
- "Cookbook not-a-thing isn't included in the existing cookbook set."
354
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, error_message)
355
- end
356
-
357
- end
358
-
359
- context "when a :path source cookbook has modified a dep constraint and the new constraint is satisfied" do
360
-
361
- let(:solution_dependencies) do
362
- {
363
- "Policyfile" => [],
364
- "dependencies" => {
365
- "foo (1.0.0)" => [],
366
- "local-cookbook (2.3.4)" => [ ["foo", ">= 0.0.0"] ]
367
- }
368
- }
369
- end
370
-
371
- let(:new_metadata) do
372
- <<-E
373
- name 'local-cookbook'
374
- maintainer ''
375
- maintainer_email ''
376
- license ''
377
- description 'Installs/Configures local-cookbook'
378
- long_description 'Installs/Configures local-cookbook'
379
- version '2.3.4'
380
-
381
- depends "foo", ">= 1.0.0"
382
-
383
- E
384
- end
385
-
386
- before do
387
- ensure_metadata_as_expected!
388
- with_file(metadata_path) { |f| f.print(new_metadata) }
389
- policyfile_lock.validate_cookbooks! # no error
390
- end
391
-
392
- it "updates the lockfile with the new checksum and validation succeeds" do
393
- actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
394
- expected = {
395
- "local-cookbook (2.3.4)" => [ ["foo", ">= 1.0.0"] ],
396
- "foo (1.0.0)" => []
397
- }
398
- expect(actual).to eq(expected)
399
- end
400
-
401
- end
402
-
403
- context "when a :path source cookbook has modified a dep constraint and the new constraint is not satisfied" do
404
-
405
- let(:new_metadata) do
406
- <<-E
407
- name 'local-cookbook'
408
- maintainer ''
409
- maintainer_email ''
410
- license ''
411
- description 'Installs/Configures local-cookbook'
412
- long_description 'Installs/Configures local-cookbook'
413
- version '2.3.4'
414
-
415
- depends "foo", "~> 2.0"
416
-
417
- E
418
- end
419
-
420
- before do
421
- ensure_metadata_as_expected!
422
- with_file(metadata_path) { |f| f.print(new_metadata) }
423
- end
424
-
425
- it "reports the not-satisfied dependency and validation fails" do
426
- error_message = "Cookbook local-cookbook (2.3.4) has dependency constraints that cannot be met by the existing cookbook set:\n" +
427
- "Dependency on foo ~> 2.0 conflicts with existing version foo (1.0.0)"
428
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, error_message)
429
- end
430
-
431
-
432
- end
433
-
434
- context "when a :path source cookbook has updated it's version and another path source cookbook has updated its constraint" do
435
-
436
- # The situation we want to test here is when the user modifies a
437
- # cookbook's version, and also the dependency constraint on that cookbook
438
- # in a different cookbook. For example, cookbook A depends on B ~> 1.0,
439
- # then the user updates A to depend on B ~> 2.0, and bumps the version of B to 2.0.
440
-
441
- let(:lock_generator) do
442
- ChefDK::PolicyfileLock.build(storage_config) do |policy|
443
-
444
- policy.name = name
445
-
446
- policy.run_list = run_list
447
-
448
- policy.cached_cookbook("foo") do |c|
449
- c.origin = "https://artifact-server.example/foo/1.0.0"
450
- c.cache_key = "foo-1.0.0"
451
- c.source_options = { artifactserver: "https://artifact-server.example/foo/1.0.0", version: "1.0.0" }
452
- end
453
-
454
- policy.local_cookbook("local-cookbook") do |c|
455
- c.source = "local-cookbook"
456
- c.source_options = { path: "local-cookbook" }
457
- end
458
-
459
- policy.local_cookbook("another-local-cookbook") do |c|
460
- c.source = "another-local-cookbook"
461
- c.source_options = { path: "another-local-cookbook" }
462
- end
463
- policy.solution_dependencies.consume_lock_data(solution_dependencies)
464
- end
465
- end
466
-
467
- # Represents dependencies before modification
468
- let(:solution_dependencies) do
469
- {
470
- "Policyfile" => [],
471
- "dependencies" => {
472
- "foo (1.0.0)" => [],
473
- "local-cookbook (2.3.4)" => [ ],
474
- "another-local-cookbook (0.1.0)" => [ ["local-cookbook", "= 2.3.4"] ]
475
- }
476
- }
477
- end
478
-
479
- let(:new_metadata_local_cookbook) do
480
- <<-E
481
- name 'local-cookbook'
482
- maintainer ''
483
- maintainer_email ''
484
- license ''
485
- description 'Installs/Configures local-cookbook'
486
- long_description 'Installs/Configures local-cookbook'
487
- version '3.0.0' # changed from 2.3.4
488
-
489
- E
490
- end
491
-
492
- let(:new_metadata_another_local_cookbook) do
493
- <<-E
494
- name 'another-local-cookbook'
495
- maintainer ''
496
- maintainer_email ''
497
- license ''
498
- description 'Installs/Configures another-local-cookbook'
499
- long_description 'Installs/Configures another-local-cookbook'
500
- version '0.1.0'
501
-
502
- # This dep now requires the updated version of 'local-cookbook'
503
- depends 'local-cookbook', '= 3.0.0'
504
- E
505
- end
506
-
507
- let(:metadata_path_another_local_cookbook) do
508
- File.join(local_cookbooks_root, 'another-local-cookbook', 'metadata.rb')
509
- end
510
-
511
- before do
512
- ensure_metadata_as_expected!
513
- with_file(metadata_path) { |f| f.print(new_metadata_local_cookbook) }
514
- with_file(metadata_path_another_local_cookbook) { |f| f.print(new_metadata_another_local_cookbook) }
515
- policyfile_lock.validate_cookbooks! # no error
516
- end
517
-
518
- context "and the new constraint is satisfied by they new version" do
519
-
520
- it "updates the version and constraint in the lockfile (validation succeeds)" do
521
- actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
522
- expected = {
523
- "local-cookbook (3.0.0)" => [ ],
524
- "another-local-cookbook (0.1.0)" => [ [ "local-cookbook", "= 3.0.0" ] ],
525
- "foo (1.0.0)" => []
526
- }
527
- expect(actual).to eq(expected)
528
- end
529
-
530
- end
531
-
532
- end
533
-
534
- end
535
-
536
- # Cached cookbook is both supermarket and git
537
- context "when a cached cookbook is modified" do
538
-
539
- let(:cached_cookbook_path) { File.join(cache_path, "foo-1.0.0") }
540
-
541
- let(:metadata_path) { File.join(cached_cookbook_path, "metadata.rb") }
542
-
543
- # Validate the metadata is correct, so we know the test setup code
544
- # hasn't done something wrong.
545
- def ensure_metadata_as_expected!
546
- expected_metadata_rb=<<-E
547
- name 'foo'
548
- maintainer ''
549
- maintainer_email ''
550
- license ''
551
- description 'Installs/Configures foo'
552
- long_description 'Installs/Configures foo'
553
- version '1.0.0'
554
-
555
- E
556
- expect(IO.read(metadata_path)).to eq(expected_metadata_rb)
557
- end
558
-
559
- context "when the cookbook missing" do
560
-
561
- before do
562
- ensure_metadata_as_expected!
563
- FileUtils.rm_rf(cached_cookbook_path)
564
- end
565
-
566
- it "reports the missing cookbook and fails validation" do
567
- message = "Cookbook `foo' not found at expected cache location `foo-1.0.0' (full path: `#{cached_cookbook_path}')"
568
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::CachedCookbookNotFound, message)
569
- end
570
-
571
- end
572
-
573
- context "when the content has changed" do
574
-
575
- # This basically means the user modified the cached cookbook. There's no
576
- # technical reason we need to be whiny about this, but if we treat it like
577
- # we would a path cookbook, you could end up with two cookbooks that look
578
- # like the canonical (e.g.) apache2 1.2.3 cookbook from supermarket with no
579
- # indication of which is which.
580
- #
581
- # We'll treat it like an error, but we need to provide a "pristine"
582
- # function to let the user recover.
583
-
584
- let(:new_metadata) do
585
- <<-E
586
- # This is a cached copy of an upstream cookbook, I should not be editing it but
587
- # YOLO
588
- name 'foo'
589
- maintainer ''
590
- maintainer_email ''
591
- license ''
592
- description 'Installs/Configures foo'
593
- long_description 'Installs/Configures foo'
594
- version '1.0.0'
595
- E
596
- end
597
-
598
- before do
599
- ensure_metadata_as_expected!
600
- policyfile_lock
601
- with_file(metadata_path) { |f| f.print(new_metadata) }
602
- end
603
-
604
- it "reports the modified cached cookbook and validation fails" do
605
- message = "Cached cookbook `foo' (1.0.0) has been modified since the lockfile was generated. Cached cookbooks cannot be modified. (full path: `#{cached_cookbook_path}')"
606
- expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::CachedCookbookModified, message)
607
- end
608
- end
609
- end
610
- end
611
-
1
+ #
2
+ # Copyright:: Copyright (c) 2014 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 'spec_helper'
19
+ require 'chef-dk/policyfile_lock.rb'
20
+
21
+ describe ChefDK::PolicyfileLock, "validating locked cookbooks" do
22
+
23
+ include ChefDK::Helpers
24
+
25
+ let(:pristine_cache_path) do
26
+ File.expand_path("spec/unit/fixtures/cookbook_cache", project_root)
27
+ end
28
+
29
+ let(:cache_path) do
30
+ temp_cache_path = File.join(tempdir, "local_cache")
31
+ FileUtils.cp_r(pristine_cache_path, temp_cache_path)
32
+ temp_cache_path
33
+ end
34
+
35
+ let(:policyfile_lock_path) { "/fakepath/Policyfile.lock.json" }
36
+
37
+ let(:local_cookbooks_root) do
38
+ temp_local_path_cookbooks = File.join(tempdir, "local_path_cookbooks")
39
+ FileUtils.cp_r(File.join(fixtures_path, "local_path_cookbooks"), temp_local_path_cookbooks)
40
+ temp_local_path_cookbooks
41
+ end
42
+
43
+ let(:name) { "application-server" }
44
+
45
+ let(:run_list) { [ 'recipe[erlang::default]', 'recipe[erchef::prereqs]', 'recipe[erchef::app]' ] }
46
+
47
+ let(:storage_config) do
48
+ ChefDK::Policyfile::StorageConfig.new( cache_path: cache_path, relative_paths_root: local_cookbooks_root )
49
+ end
50
+
51
+ let(:solution_dependencies) do
52
+ {
53
+ "Policyfile" => [],
54
+ "dependencies" => {
55
+ "foo (1.0.0)" => [],
56
+ "local-cookbook (2.3.4)" => []
57
+ }
58
+ }
59
+ end
60
+
61
+ let(:lock_generator) do
62
+ ChefDK::PolicyfileLock.build(storage_config) do |policy|
63
+
64
+ policy.name = name
65
+
66
+ policy.run_list = run_list
67
+
68
+ policy.cached_cookbook("foo") do |c|
69
+ c.origin = "https://artifact-server.example/foo/1.0.0"
70
+ c.cache_key = "foo-1.0.0"
71
+ c.source_options = { artifactserver: "https://artifact-server.example/foo/1.0.0", version: "1.0.0" }
72
+ end
73
+
74
+ policy.local_cookbook("local-cookbook") do |c|
75
+ c.source = "local-cookbook"
76
+ c.source_options = { path: "local-cookbook" }
77
+ end
78
+
79
+ policy.solution_dependencies.consume_lock_data(solution_dependencies)
80
+ end
81
+ end
82
+
83
+ let(:lock_data) do
84
+ lock_generator.to_lock
85
+ end
86
+
87
+ # Eagerly evaluate #policyfile_lock. This is necessary because many of
88
+ # the tests follow this general process:
89
+ # 1. setup valid state, generate a lockfile in-memory
90
+ # 2. make the state invalid
91
+ # 3. ensure validation detected the invalid state
92
+ #
93
+ # With lazy evaluation, #1 may happen after #2.
94
+ let!(:policyfile_lock) do
95
+ ChefDK::PolicyfileLock.new(storage_config).build_from_lock_data(lock_data)
96
+ end
97
+
98
+ let(:local_cookbook_path) { File.join(local_cookbooks_root, "local-cookbook") }
99
+
100
+ context "when no cookbooks have changed" do
101
+
102
+ it "validation succeeds" do
103
+ expect(policyfile_lock.validate_cookbooks!).to be true
104
+ end
105
+
106
+ end
107
+
108
+ describe "when a :path sourced cookbook has changed" do
109
+
110
+ let(:metadata_path) { File.join(local_cookbook_path, "metadata.rb") }
111
+
112
+ let(:cookbook_lock_data) { policyfile_lock.lock_data_for("local-cookbook") }
113
+
114
+ # Validate the metadata is correct, so we know the test setup code
115
+ # hasn't done something wrong.
116
+ def ensure_metadata_as_expected!
117
+ expected_metadata_rb=<<-E
118
+ name 'local-cookbook'
119
+ maintainer ''
120
+ maintainer_email ''
121
+ license ''
122
+ description 'Installs/Configures local-cookbook'
123
+ long_description 'Installs/Configures local-cookbook'
124
+ version '2.3.4'
125
+
126
+ E
127
+ expect(IO.read(metadata_path)).to eq(expected_metadata_rb)
128
+ end
129
+
130
+ context "when the cookbook is missing" do
131
+
132
+ before do
133
+ FileUtils.rm_rf(local_cookbook_path)
134
+ end
135
+
136
+ it "reports the missing cookbook and fails validation" do
137
+ full_path = File.expand_path(local_cookbook_path)
138
+ message = "Cookbook `local-cookbook' not found at path source `local-cookbook` (full path: `#{full_path}')"
139
+
140
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::LocalCookbookNotFound, message)
141
+ end
142
+
143
+ end
144
+
145
+ context "when the cookbook has an incorrect name" do
146
+
147
+ let(:new_metadata) do
148
+ <<-E
149
+ name 'WRONG'
150
+ maintainer ''
151
+ maintainer_email ''
152
+ license ''
153
+ description 'Installs/Configures local-cookbook'
154
+ long_description 'Installs/Configures local-cookbook'
155
+ version '2.3.4'
156
+
157
+ E
158
+ end
159
+
160
+
161
+ before do
162
+ ensure_metadata_as_expected!
163
+ with_file(metadata_path) { |f| f.print(new_metadata) }
164
+ end
165
+
166
+ it "reports the unexpected cookbook and fails validation" do
167
+ policyfile_lock
168
+
169
+ message = "The cookbook at path source `local-cookbook' is expected to be named `local-cookbook', but is now named `WRONG' (full path: #{local_cookbook_path})"
170
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::MalformedCookbook, message)
171
+ end
172
+
173
+ end
174
+
175
+ context "when the cookbook has an updated version that violates no dependency constraints" do
176
+
177
+ let(:new_metadata) do
178
+ <<-E
179
+ name 'local-cookbook'
180
+ maintainer ''
181
+ maintainer_email ''
182
+ license ''
183
+ description 'Installs/Configures local-cookbook'
184
+ long_description 'Installs/Configures local-cookbook'
185
+ version '2.3.5' # changed from 2.3.4
186
+
187
+ E
188
+ end
189
+
190
+ before do
191
+ ensure_metadata_as_expected!
192
+ with_file(metadata_path) { |f| f.print(new_metadata) }
193
+ policyfile_lock.validate_cookbooks! # no error
194
+ end
195
+
196
+ it "updates the version information in the lockfile" do
197
+ expect(cookbook_lock_data.version).to eq("2.3.5")
198
+ end
199
+
200
+ it "updates the content identifier" do
201
+ old_id = lock_generator.lock_data_for("local-cookbook").identifier
202
+ expect(cookbook_lock_data.identifier).to_not eq(old_id)
203
+ expect(cookbook_lock_data.identifier).to eq("d71622904ed89b1e0066bb4ae823b2a7b49a615a")
204
+ end
205
+
206
+ it "has an updated version and identifier" do
207
+ expect(cookbook_lock_data).to be_updated
208
+ expect(cookbook_lock_data.version_updated?).to be true
209
+ expect(cookbook_lock_data.identifier_updated?).to be true
210
+ end
211
+ end
212
+
213
+ context "when the cookbook has an updated version that violates other dependency constraints" do
214
+
215
+ let(:solution_dependencies) do
216
+ {
217
+ "Policyfile" => [],
218
+ "dependencies" => {
219
+ "foo (1.0.0)" => [ [ "local-cookbook", "~> 2.0" ] ]
220
+ }
221
+ }
222
+ end
223
+
224
+ let(:new_metadata) do
225
+ <<-E
226
+ name 'local-cookbook'
227
+ maintainer ''
228
+ maintainer_email ''
229
+ license ''
230
+ description 'Installs/Configures local-cookbook'
231
+ long_description 'Installs/Configures local-cookbook'
232
+ version '3.0.0' # changed from 2.3.4, violates `~> 2.0` constraint
233
+
234
+ E
235
+ end
236
+
237
+ before do
238
+ ensure_metadata_as_expected!
239
+ with_file(metadata_path) { |f| f.print(new_metadata) }
240
+ end
241
+
242
+ it "reports the dependency conflict and fails validation" do
243
+ expected_message = "Cookbook local-cookbook (3.0.0) conflicts with other dependencies:\nfoo (1.0.0) depends on local-cookbook ~> 2.0"
244
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, expected_message)
245
+ end
246
+
247
+ end
248
+
249
+ context "when a :path sourced cookbook has updated content" do
250
+
251
+ let(:recipe_path) { File.join(local_cookbook_path, "recipes/default.rb") }
252
+
253
+ let(:new_recipe) do
254
+ <<-E
255
+ # This is totally new code,
256
+ # it is different than the old code
257
+
258
+ E
259
+ end
260
+
261
+ before do
262
+ ensure_metadata_as_expected!
263
+ with_file(recipe_path) { |f| f.print(new_recipe) }
264
+ policyfile_lock.validate_cookbooks! # no error
265
+ end
266
+
267
+ it "updates the lockfile with the new checksum and validation succeeds" do
268
+ old_id = lock_generator.lock_data_for("local-cookbook").identifier
269
+
270
+ expect(cookbook_lock_data.identifier).to_not eq(old_id)
271
+ expect(cookbook_lock_data.identifier).to eq("08a96e3afbd1eaa1183a2dde8687ca29dbddc94b")
272
+ end
273
+
274
+ it "has an updated identifier but not an updated version" do
275
+ expect(cookbook_lock_data).to be_updated
276
+ expect(cookbook_lock_data.version_updated?).to be false
277
+ expect(cookbook_lock_data.identifier_updated?).to be true
278
+ end
279
+
280
+ end
281
+
282
+ context "when a :path source cookbook has added a dependency satisfied by the current cookbook set" do
283
+
284
+ let(:new_metadata) do
285
+ <<-E
286
+ name 'local-cookbook'
287
+ maintainer ''
288
+ maintainer_email ''
289
+ license ''
290
+ description 'Installs/Configures local-cookbook'
291
+ long_description 'Installs/Configures local-cookbook'
292
+ version '2.3.4'
293
+
294
+ depends "foo", "=1.0.0"
295
+
296
+ E
297
+ end
298
+
299
+ before do
300
+ ensure_metadata_as_expected!
301
+ with_file(metadata_path) { |f| f.print(new_metadata) }
302
+ policyfile_lock.validate_cookbooks! # no error
303
+ end
304
+
305
+ it "updates the lockfile with the new checksum and validation succeeds" do
306
+ old_id = lock_generator.lock_data_for("local-cookbook").identifier
307
+
308
+ expect(cookbook_lock_data.identifier).to_not eq(old_id)
309
+ expect(cookbook_lock_data.identifier).to eq("da6a1c0f8791df713b7ff8c27285fbe7923901cc")
310
+ end
311
+
312
+ it "has an updated identifier but not an updated version" do
313
+ expect(cookbook_lock_data).to be_updated
314
+ expect(cookbook_lock_data.version_updated?).to be false
315
+ expect(cookbook_lock_data.identifier_updated?).to be true
316
+ end
317
+
318
+ it "has an updated dependency set" do
319
+ actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
320
+ expected = {
321
+ "local-cookbook (2.3.4)" => [ ["foo", "= 1.0.0"] ],
322
+ "foo (1.0.0)" => []
323
+ }
324
+ expect(actual).to eq(expected)
325
+ end
326
+
327
+ end
328
+
329
+ context "when a :path source cookbook has added a dependency not satisfied by the current cookbook set" do
330
+
331
+ let(:new_metadata) do
332
+ <<-E
333
+ name 'local-cookbook'
334
+ maintainer ''
335
+ maintainer_email ''
336
+ license ''
337
+ description 'Installs/Configures local-cookbook'
338
+ long_description 'Installs/Configures local-cookbook'
339
+ version '2.3.4'
340
+
341
+ depends "not-a-thing"
342
+
343
+ E
344
+ end
345
+
346
+ before do
347
+ ensure_metadata_as_expected!
348
+ with_file(metadata_path) { |f| f.print(new_metadata) }
349
+ end
350
+
351
+ it "reports the not-satisfied dependency and validation fails" do
352
+ error_message = "Cookbook local-cookbook (2.3.4) has dependency constraints that cannot be met by the existing cookbook set:\n" +
353
+ "Cookbook not-a-thing isn't included in the existing cookbook set."
354
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, error_message)
355
+ end
356
+
357
+ end
358
+
359
+ context "when a :path source cookbook has modified a dep constraint and the new constraint is satisfied" do
360
+
361
+ let(:solution_dependencies) do
362
+ {
363
+ "Policyfile" => [],
364
+ "dependencies" => {
365
+ "foo (1.0.0)" => [],
366
+ "local-cookbook (2.3.4)" => [ ["foo", ">= 0.0.0"] ]
367
+ }
368
+ }
369
+ end
370
+
371
+ let(:new_metadata) do
372
+ <<-E
373
+ name 'local-cookbook'
374
+ maintainer ''
375
+ maintainer_email ''
376
+ license ''
377
+ description 'Installs/Configures local-cookbook'
378
+ long_description 'Installs/Configures local-cookbook'
379
+ version '2.3.4'
380
+
381
+ depends "foo", ">= 1.0.0"
382
+
383
+ E
384
+ end
385
+
386
+ before do
387
+ ensure_metadata_as_expected!
388
+ with_file(metadata_path) { |f| f.print(new_metadata) }
389
+ policyfile_lock.validate_cookbooks! # no error
390
+ end
391
+
392
+ it "updates the lockfile with the new checksum and validation succeeds" do
393
+ actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
394
+ expected = {
395
+ "local-cookbook (2.3.4)" => [ ["foo", ">= 1.0.0"] ],
396
+ "foo (1.0.0)" => []
397
+ }
398
+ expect(actual).to eq(expected)
399
+ end
400
+
401
+ end
402
+
403
+ context "when a :path source cookbook has modified a dep constraint and the new constraint is not satisfied" do
404
+
405
+ let(:new_metadata) do
406
+ <<-E
407
+ name 'local-cookbook'
408
+ maintainer ''
409
+ maintainer_email ''
410
+ license ''
411
+ description 'Installs/Configures local-cookbook'
412
+ long_description 'Installs/Configures local-cookbook'
413
+ version '2.3.4'
414
+
415
+ depends "foo", "~> 2.0"
416
+
417
+ E
418
+ end
419
+
420
+ before do
421
+ ensure_metadata_as_expected!
422
+ with_file(metadata_path) { |f| f.print(new_metadata) }
423
+ end
424
+
425
+ it "reports the not-satisfied dependency and validation fails" do
426
+ error_message = "Cookbook local-cookbook (2.3.4) has dependency constraints that cannot be met by the existing cookbook set:\n" +
427
+ "Dependency on foo ~> 2.0 conflicts with existing version foo (1.0.0)"
428
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::DependencyConflict, error_message)
429
+ end
430
+
431
+
432
+ end
433
+
434
+ context "when a :path source cookbook has updated it's version and another path source cookbook has updated its constraint" do
435
+
436
+ # The situation we want to test here is when the user modifies a
437
+ # cookbook's version, and also the dependency constraint on that cookbook
438
+ # in a different cookbook. For example, cookbook A depends on B ~> 1.0,
439
+ # then the user updates A to depend on B ~> 2.0, and bumps the version of B to 2.0.
440
+
441
+ let(:lock_generator) do
442
+ ChefDK::PolicyfileLock.build(storage_config) do |policy|
443
+
444
+ policy.name = name
445
+
446
+ policy.run_list = run_list
447
+
448
+ policy.cached_cookbook("foo") do |c|
449
+ c.origin = "https://artifact-server.example/foo/1.0.0"
450
+ c.cache_key = "foo-1.0.0"
451
+ c.source_options = { artifactserver: "https://artifact-server.example/foo/1.0.0", version: "1.0.0" }
452
+ end
453
+
454
+ policy.local_cookbook("local-cookbook") do |c|
455
+ c.source = "local-cookbook"
456
+ c.source_options = { path: "local-cookbook" }
457
+ end
458
+
459
+ policy.local_cookbook("another-local-cookbook") do |c|
460
+ c.source = "another-local-cookbook"
461
+ c.source_options = { path: "another-local-cookbook" }
462
+ end
463
+ policy.solution_dependencies.consume_lock_data(solution_dependencies)
464
+ end
465
+ end
466
+
467
+ # Represents dependencies before modification
468
+ let(:solution_dependencies) do
469
+ {
470
+ "Policyfile" => [],
471
+ "dependencies" => {
472
+ "foo (1.0.0)" => [],
473
+ "local-cookbook (2.3.4)" => [ ],
474
+ "another-local-cookbook (0.1.0)" => [ ["local-cookbook", "= 2.3.4"] ]
475
+ }
476
+ }
477
+ end
478
+
479
+ let(:new_metadata_local_cookbook) do
480
+ <<-E
481
+ name 'local-cookbook'
482
+ maintainer ''
483
+ maintainer_email ''
484
+ license ''
485
+ description 'Installs/Configures local-cookbook'
486
+ long_description 'Installs/Configures local-cookbook'
487
+ version '3.0.0' # changed from 2.3.4
488
+
489
+ E
490
+ end
491
+
492
+ let(:new_metadata_another_local_cookbook) do
493
+ <<-E
494
+ name 'another-local-cookbook'
495
+ maintainer ''
496
+ maintainer_email ''
497
+ license ''
498
+ description 'Installs/Configures another-local-cookbook'
499
+ long_description 'Installs/Configures another-local-cookbook'
500
+ version '0.1.0'
501
+
502
+ # This dep now requires the updated version of 'local-cookbook'
503
+ depends 'local-cookbook', '= 3.0.0'
504
+ E
505
+ end
506
+
507
+ let(:metadata_path_another_local_cookbook) do
508
+ File.join(local_cookbooks_root, 'another-local-cookbook', 'metadata.rb')
509
+ end
510
+
511
+ before do
512
+ ensure_metadata_as_expected!
513
+ with_file(metadata_path) { |f| f.print(new_metadata_local_cookbook) }
514
+ with_file(metadata_path_another_local_cookbook) { |f| f.print(new_metadata_another_local_cookbook) }
515
+ policyfile_lock.validate_cookbooks! # no error
516
+ end
517
+
518
+ context "and the new constraint is satisfied by they new version" do
519
+
520
+ it "updates the version and constraint in the lockfile (validation succeeds)" do
521
+ actual = policyfile_lock.solution_dependencies.to_lock["dependencies"]
522
+ expected = {
523
+ "local-cookbook (3.0.0)" => [ ],
524
+ "another-local-cookbook (0.1.0)" => [ [ "local-cookbook", "= 3.0.0" ] ],
525
+ "foo (1.0.0)" => []
526
+ }
527
+ expect(actual).to eq(expected)
528
+ end
529
+
530
+ end
531
+
532
+ end
533
+
534
+ end
535
+
536
+ # Cached cookbook is both supermarket and git
537
+ context "when a cached cookbook is modified" do
538
+
539
+ let(:cached_cookbook_path) { File.join(cache_path, "foo-1.0.0") }
540
+
541
+ let(:metadata_path) { File.join(cached_cookbook_path, "metadata.rb") }
542
+
543
+ # Validate the metadata is correct, so we know the test setup code
544
+ # hasn't done something wrong.
545
+ def ensure_metadata_as_expected!
546
+ expected_metadata_rb=<<-E
547
+ name 'foo'
548
+ maintainer ''
549
+ maintainer_email ''
550
+ license ''
551
+ description 'Installs/Configures foo'
552
+ long_description 'Installs/Configures foo'
553
+ version '1.0.0'
554
+
555
+ E
556
+ expect(IO.read(metadata_path)).to eq(expected_metadata_rb)
557
+ end
558
+
559
+ context "when the cookbook missing" do
560
+
561
+ before do
562
+ ensure_metadata_as_expected!
563
+ FileUtils.rm_rf(cached_cookbook_path)
564
+ end
565
+
566
+ it "reports the missing cookbook and fails validation" do
567
+ message = "Cookbook `foo' not found at expected cache location `foo-1.0.0' (full path: `#{cached_cookbook_path}')"
568
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::CachedCookbookNotFound, message)
569
+ end
570
+
571
+ end
572
+
573
+ context "when the content has changed" do
574
+
575
+ # This basically means the user modified the cached cookbook. There's no
576
+ # technical reason we need to be whiny about this, but if we treat it like
577
+ # we would a path cookbook, you could end up with two cookbooks that look
578
+ # like the canonical (e.g.) apache2 1.2.3 cookbook from supermarket with no
579
+ # indication of which is which.
580
+ #
581
+ # We'll treat it like an error, but we need to provide a "pristine"
582
+ # function to let the user recover.
583
+
584
+ let(:new_metadata) do
585
+ <<-E
586
+ # This is a cached copy of an upstream cookbook, I should not be editing it but
587
+ # YOLO
588
+ name 'foo'
589
+ maintainer ''
590
+ maintainer_email ''
591
+ license ''
592
+ description 'Installs/Configures foo'
593
+ long_description 'Installs/Configures foo'
594
+ version '1.0.0'
595
+ E
596
+ end
597
+
598
+ before do
599
+ ensure_metadata_as_expected!
600
+ policyfile_lock
601
+ with_file(metadata_path) { |f| f.print(new_metadata) }
602
+ end
603
+
604
+ it "reports the modified cached cookbook and validation fails" do
605
+ message = "Cached cookbook `foo' (1.0.0) has been modified since the lockfile was generated. Cached cookbooks cannot be modified. (full path: `#{cached_cookbook_path}')"
606
+ expect { policyfile_lock.validate_cookbooks! }.to raise_error(ChefDK::CachedCookbookModified, message)
607
+ end
608
+ end
609
+ end
610
+ end
611
+