akerl-r10k 3.14.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (405) hide show
  1. checksums.yaml +7 -0
  2. data/.gitattributes +1 -0
  3. data/.github/pull_request_template.md +4 -0
  4. data/.github/workflows/docker.yml +64 -0
  5. data/.github/workflows/release.yml +37 -0
  6. data/.github/workflows/rspec_tests.yml +81 -0
  7. data/.github/workflows/stale.yml +21 -0
  8. data/.gitignore +10 -0
  9. data/.travis.yml +42 -0
  10. data/CHANGELOG.mkd +1879 -0
  11. data/CODEOWNERS +2 -0
  12. data/CONTRIBUTING.mkd +105 -0
  13. data/Gemfile +15 -0
  14. data/LICENSE +14 -0
  15. data/README.mkd +139 -0
  16. data/Rakefile +3 -0
  17. data/bin/r10k +17 -0
  18. data/doc/common-patterns.mkd +45 -0
  19. data/doc/dynamic-environments/configuration.mkd +850 -0
  20. data/doc/dynamic-environments/git-environments.mkd +75 -0
  21. data/doc/dynamic-environments/introduction.mkd +69 -0
  22. data/doc/dynamic-environments/master-configuration.mkd +40 -0
  23. data/doc/dynamic-environments/quickstart.mkd +201 -0
  24. data/doc/dynamic-environments/svn-environments.mkd +45 -0
  25. data/doc/dynamic-environments/usage.mkd +163 -0
  26. data/doc/dynamic-environments/workflow-guide.mkd +247 -0
  27. data/doc/dynamic-environments.mkd +31 -0
  28. data/doc/faq.mkd +164 -0
  29. data/doc/git/cloning-and-mirroring.mkd +60 -0
  30. data/doc/git/providers.mkd +133 -0
  31. data/doc/puppetfile.mkd +355 -0
  32. data/doc/updating-your-puppetfile.mkd +38 -0
  33. data/docker/.gitignore +1 -0
  34. data/docker/.rspec +4 -0
  35. data/docker/Gemfile +11 -0
  36. data/docker/Makefile +99 -0
  37. data/docker/README.md +28 -0
  38. data/docker/docker-compose.yml +18 -0
  39. data/docker/r10k/Dockerfile +68 -0
  40. data/docker/r10k/adduser.sh +13 -0
  41. data/docker/r10k/docker-entrypoint.d/10-analytics.sh +30 -0
  42. data/docker/r10k/docker-entrypoint.sh +10 -0
  43. data/docker/r10k/release.Dockerfile +55 -0
  44. data/docker/spec/dockerfile_spec.rb +37 -0
  45. data/docker/spec/fixtures/Puppetfile +2 -0
  46. data/integration/Gemfile +19 -0
  47. data/integration/README.mkd +29 -0
  48. data/integration/Rakefile +79 -0
  49. data/integration/component/pre-suite/05_install_dev_r10k.rb +12 -0
  50. data/integration/files/README.mkd +4 -0
  51. data/integration/files/hiera.yaml +8 -0
  52. data/integration/files/modules/helloworld/manifests/init.pp +3 -0
  53. data/integration/files/modules/hieratest/manifests/init.pp +3 -0
  54. data/integration/files/modules/unicode/files/pretend_unicode +1 -0
  55. data/integration/files/modules/unicode/manifests/init.pp +6 -0
  56. data/integration/files/pre-suite/git_config.pp.erb +19 -0
  57. data/integration/files/pre-suite/prod_env.config +3 -0
  58. data/integration/files/r10k_conf.yaml.erb +9 -0
  59. data/integration/lib/README.mkd +4 -0
  60. data/integration/lib/git_utils.rb +205 -0
  61. data/integration/lib/master_manipulator.rb +205 -0
  62. data/integration/lib/r10k_utils.rb +222 -0
  63. data/integration/manifests/README.mkd +4 -0
  64. data/integration/pre-suite/00_pe_install.rb +6 -0
  65. data/integration/pre-suite/10_git_config.rb +48 -0
  66. data/integration/pre-suite/20_pe_r10k.rb +55 -0
  67. data/integration/pre-suite/README.mkd +5 -0
  68. data/integration/tests/Puppetfile/HTTP_PROXY_affects_forge_source.rb +72 -0
  69. data/integration/tests/Puppetfile/HTTP_PROXY_affects_git_source.rb +70 -0
  70. data/integration/tests/README.mkd +4 -0
  71. data/integration/tests/basic_functionality/basic_deployment.rb +176 -0
  72. data/integration/tests/basic_functionality/install_pe_only_module_with_puppetfile.rb +83 -0
  73. data/integration/tests/basic_functionality/negative/neg_deploy_with_invalid_r10k_yaml.rb +51 -0
  74. data/integration/tests/basic_functionality/negative/neg_deploy_with_missing_r10k_yaml.rb +28 -0
  75. data/integration/tests/basic_functionality/negative/neg_invalid_git_provider.rb +45 -0
  76. data/integration/tests/basic_functionality/negative/negative_bad_proxy.rb +34 -0
  77. data/integration/tests/basic_functionality/proxy_specified_in_configuration.rb +103 -0
  78. data/integration/tests/basic_functionality/proxy_with_pe_only_module.rb +128 -0
  79. data/integration/tests/basic_functionality/proxy_with_puppetfile.rb +61 -0
  80. data/integration/tests/basic_functionality/rugged_git_provider_with_ssh.rb +109 -0
  81. data/integration/tests/basic_functionality/rugged_git_provider_without_ssh.rb +108 -0
  82. data/integration/tests/command_line/deploy_env_without_mod_update.rb +76 -0
  83. data/integration/tests/command_line/negative/neg_deploy_env_with_module_update.rb +77 -0
  84. data/integration/tests/command_line/negative/neg_invalid_cmd_line_arg.rb +23 -0
  85. data/integration/tests/git_source/HTTP_proxy_and_git_source.rb +70 -0
  86. data/integration/tests/git_source/git_source_git.rb +128 -0
  87. data/integration/tests/git_source/git_source_repeated_remote.rb +68 -0
  88. data/integration/tests/git_source/git_source_ssh.rb +87 -0
  89. data/integration/tests/git_source/git_source_submodule.rb +70 -0
  90. data/integration/tests/git_source/negative/neg_git_broken_remote.rb +38 -0
  91. data/integration/tests/git_source/negative/neg_git_unauthorized_https.rb +46 -0
  92. data/integration/tests/git_source/negative/neg_git_unauthorized_ssh.rb +73 -0
  93. data/integration/tests/git_source/negative/neg_git_unicode_branch.rb +35 -0
  94. data/integration/tests/i18n/deploy_module_with_unicode_in_file_name.rb +64 -0
  95. data/integration/tests/purging/content_not_purged_at_root.rb +89 -0
  96. data/integration/tests/purging/default_purging.rb +125 -0
  97. data/integration/tests/purging/does_not_purge_files_on_white_list.rb +93 -0
  98. data/integration/tests/purging/invalid_whitelist_types.rb +63 -0
  99. data/integration/tests/user_scenario/basic_workflow/multi_env_1000_branches.rb +66 -0
  100. data/integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module.rb +112 -0
  101. data/integration/tests/user_scenario/basic_workflow/multi_env_custom_forge_git_module_static.rb +118 -0
  102. data/integration/tests/user_scenario/basic_workflow/multi_env_hiera.rb +100 -0
  103. data/integration/tests/user_scenario/basic_workflow/multi_env_multi_source.rb +133 -0
  104. data/integration/tests/user_scenario/basic_workflow/multi_source_custom_forge_git_module.rb +161 -0
  105. data/integration/tests/user_scenario/basic_workflow/negative/neg_bad_basedir.rb +46 -0
  106. data/integration/tests/user_scenario/basic_workflow/negative/neg_bad_forge_module.rb +48 -0
  107. data/integration/tests/user_scenario/basic_workflow/negative/neg_bad_git_module.rb +45 -0
  108. data/integration/tests/user_scenario/basic_workflow/negative/neg_bad_git_module_ref.rb +43 -0
  109. data/integration/tests/user_scenario/basic_workflow/negative/neg_bad_git_remote.rb +45 -0
  110. data/integration/tests/user_scenario/basic_workflow/negative/neg_branch_name_collision.rb +64 -0
  111. data/integration/tests/user_scenario/basic_workflow/negative/neg_disk_full.rb +75 -0
  112. data/integration/tests/user_scenario/basic_workflow/negative/neg_duplicate_module_names.rb +44 -0
  113. data/integration/tests/user_scenario/basic_workflow/negative/neg_inaccessible_forge.rb +58 -0
  114. data/integration/tests/user_scenario/basic_workflow/negative/neg_invalid_env_name.rb +34 -0
  115. data/integration/tests/user_scenario/basic_workflow/negative/neg_invalid_puppet_file.rb +36 -0
  116. data/integration/tests/user_scenario/basic_workflow/negative/neg_module_specified_at_deleted_release.rb +49 -0
  117. data/integration/tests/user_scenario/basic_workflow/negative/neg_read_only.rb +58 -0
  118. data/integration/tests/user_scenario/basic_workflow/negative/neg_specify_deleted_forge_module.rb +45 -0
  119. data/integration/tests/user_scenario/basic_workflow/single_env_10000_files.rb +75 -0
  120. data/integration/tests/user_scenario/basic_workflow/single_env_custom_forge_git_module.rb +105 -0
  121. data/integration/tests/user_scenario/basic_workflow/single_env_custom_forge_module.rb +81 -0
  122. data/integration/tests/user_scenario/basic_workflow/single_env_custom_module.rb +49 -0
  123. data/integration/tests/user_scenario/basic_workflow/single_env_large_files.rb +75 -0
  124. data/integration/tests/user_scenario/basic_workflow/single_env_module_already_installed.rb +82 -0
  125. data/integration/tests/user_scenario/basic_workflow/single_env_module_last_release_deleted.rb +68 -0
  126. data/integration/tests/user_scenario/basic_workflow/single_env_non-existent_base_dir.rb +94 -0
  127. data/integration/tests/user_scenario/basic_workflow/single_env_purge_unmanaged_modules.rb +89 -0
  128. data/integration/tests/user_scenario/basic_workflow/single_env_switch_forge_git_module.rb +117 -0
  129. data/integration/tests/user_scenario/basic_workflow/single_env_unicode_paths.rb +60 -0
  130. data/integration/tests/user_scenario/basic_workflow/single_env_upgrade_forge_mod_revert_change.rb +166 -0
  131. data/integration/tests/user_scenario/complex_workflow/multi_env_add_change_remove.rb +163 -0
  132. data/integration/tests/user_scenario/complex_workflow/multi_env_remove_re-add.rb +111 -0
  133. data/integration/tests/user_scenario/complex_workflow/multi_env_unamanaged.rb +78 -0
  134. data/integration/tests/user_scenario/complex_workflow/single_env_git_module_update.rb +100 -0
  135. data/lib/r10k/action/base.rb +41 -0
  136. data/lib/r10k/action/cri_runner.rb +72 -0
  137. data/lib/r10k/action/deploy/deploy_helpers.rb +38 -0
  138. data/lib/r10k/action/deploy/display.rb +128 -0
  139. data/lib/r10k/action/deploy/environment.rb +260 -0
  140. data/lib/r10k/action/deploy/module.rb +139 -0
  141. data/lib/r10k/action/deploy.rb +9 -0
  142. data/lib/r10k/action/puppetfile/check.rb +35 -0
  143. data/lib/r10k/action/puppetfile/cri_runner.rb +26 -0
  144. data/lib/r10k/action/puppetfile/install.rb +48 -0
  145. data/lib/r10k/action/puppetfile/purge.rb +37 -0
  146. data/lib/r10k/action/puppetfile.rb +10 -0
  147. data/lib/r10k/action/runner.rb +171 -0
  148. data/lib/r10k/action/visitor.rb +34 -0
  149. data/lib/r10k/cli/deploy.rb +126 -0
  150. data/lib/r10k/cli/ext/logging.rb +15 -0
  151. data/lib/r10k/cli/help.rb +7 -0
  152. data/lib/r10k/cli/puppetfile.rb +73 -0
  153. data/lib/r10k/cli/version.rb +31 -0
  154. data/lib/r10k/cli.rb +51 -0
  155. data/lib/r10k/content_synchronizer.rb +95 -0
  156. data/lib/r10k/deployment/config.rb +56 -0
  157. data/lib/r10k/deployment.rb +132 -0
  158. data/lib/r10k/environment/bare.rb +13 -0
  159. data/lib/r10k/environment/base.rb +230 -0
  160. data/lib/r10k/environment/git.rb +93 -0
  161. data/lib/r10k/environment/name.rb +109 -0
  162. data/lib/r10k/environment/plain.rb +16 -0
  163. data/lib/r10k/environment/svn.rb +98 -0
  164. data/lib/r10k/environment/tarball.rb +78 -0
  165. data/lib/r10k/environment/with_modules.rb +174 -0
  166. data/lib/r10k/environment.rb +39 -0
  167. data/lib/r10k/errors/formatting.rb +28 -0
  168. data/lib/r10k/errors.rb +66 -0
  169. data/lib/r10k/feature/collection.rb +23 -0
  170. data/lib/r10k/feature.rb +56 -0
  171. data/lib/r10k/features.rb +20 -0
  172. data/lib/r10k/forge/module_release.rb +229 -0
  173. data/lib/r10k/git/alternates.rb +63 -0
  174. data/lib/r10k/git/cache.rb +107 -0
  175. data/lib/r10k/git/errors.rb +34 -0
  176. data/lib/r10k/git/rugged/bare_repository.rb +85 -0
  177. data/lib/r10k/git/rugged/base_repository.rb +104 -0
  178. data/lib/r10k/git/rugged/cache.rb +19 -0
  179. data/lib/r10k/git/rugged/credentials.rb +205 -0
  180. data/lib/r10k/git/rugged/thin_repository.rb +96 -0
  181. data/lib/r10k/git/rugged/working_repository.rb +149 -0
  182. data/lib/r10k/git/rugged.rb +17 -0
  183. data/lib/r10k/git/shellgit/bare_repository.rb +43 -0
  184. data/lib/r10k/git/shellgit/base_repository.rb +137 -0
  185. data/lib/r10k/git/shellgit/cache.rb +11 -0
  186. data/lib/r10k/git/shellgit/thin_repository.rb +73 -0
  187. data/lib/r10k/git/shellgit/working_repository.rb +112 -0
  188. data/lib/r10k/git/shellgit.rb +9 -0
  189. data/lib/r10k/git/stateful_repository.rb +109 -0
  190. data/lib/r10k/git.rb +200 -0
  191. data/lib/r10k/initializers.rb +93 -0
  192. data/lib/r10k/instance_cache.rb +32 -0
  193. data/lib/r10k/keyed_factory.rb +39 -0
  194. data/lib/r10k/logging/terminaloutputter.rb +36 -0
  195. data/lib/r10k/logging.rb +186 -0
  196. data/lib/r10k/module/base.rb +182 -0
  197. data/lib/r10k/module/definition.rb +64 -0
  198. data/lib/r10k/module/forge.rb +208 -0
  199. data/lib/r10k/module/git.rb +156 -0
  200. data/lib/r10k/module/local.rb +40 -0
  201. data/lib/r10k/module/metadata_file.rb +31 -0
  202. data/lib/r10k/module/svn.rb +129 -0
  203. data/lib/r10k/module/tarball.rb +101 -0
  204. data/lib/r10k/module.rb +57 -0
  205. data/lib/r10k/module_loader/puppetfile/dsl.rb +42 -0
  206. data/lib/r10k/module_loader/puppetfile.rb +290 -0
  207. data/lib/r10k/puppetfile.rb +211 -0
  208. data/lib/r10k/settings/collection.rb +123 -0
  209. data/lib/r10k/settings/container.rb +97 -0
  210. data/lib/r10k/settings/definition.rb +124 -0
  211. data/lib/r10k/settings/enum_definition.rb +30 -0
  212. data/lib/r10k/settings/helpers.rb +38 -0
  213. data/lib/r10k/settings/list.rb +107 -0
  214. data/lib/r10k/settings/loader.rb +99 -0
  215. data/lib/r10k/settings/mixin.rb +54 -0
  216. data/lib/r10k/settings/uri_definition.rb +19 -0
  217. data/lib/r10k/settings.rb +312 -0
  218. data/lib/r10k/source/base.rb +93 -0
  219. data/lib/r10k/source/exec.rb +51 -0
  220. data/lib/r10k/source/git.rb +178 -0
  221. data/lib/r10k/source/hash.rb +182 -0
  222. data/lib/r10k/source/svn.rb +142 -0
  223. data/lib/r10k/source/yaml.rb +20 -0
  224. data/lib/r10k/source/yamldir.rb +32 -0
  225. data/lib/r10k/source.rb +42 -0
  226. data/lib/r10k/svn/remote.rb +68 -0
  227. data/lib/r10k/svn/working_dir.rb +125 -0
  228. data/lib/r10k/svn.rb +6 -0
  229. data/lib/r10k/tarball.rb +183 -0
  230. data/lib/r10k/util/attempt.rb +84 -0
  231. data/lib/r10k/util/basedir.rb +65 -0
  232. data/lib/r10k/util/cacheable.rb +31 -0
  233. data/lib/r10k/util/cleaner.rb +21 -0
  234. data/lib/r10k/util/commands.rb +31 -0
  235. data/lib/r10k/util/downloader.rb +134 -0
  236. data/lib/r10k/util/exec_env.rb +36 -0
  237. data/lib/r10k/util/license.rb +24 -0
  238. data/lib/r10k/util/platform.rb +42 -0
  239. data/lib/r10k/util/purgeable.rb +154 -0
  240. data/lib/r10k/util/setopts.rb +78 -0
  241. data/lib/r10k/util/subprocess/result.rb +56 -0
  242. data/lib/r10k/util/subprocess/runner/jruby.rb +23 -0
  243. data/lib/r10k/util/subprocess/runner/posix.rb +103 -0
  244. data/lib/r10k/util/subprocess/runner/pump.rb +59 -0
  245. data/lib/r10k/util/subprocess/runner/windows.rb +23 -0
  246. data/lib/r10k/util/subprocess/runner.rb +26 -0
  247. data/lib/r10k/util/subprocess/subprocess_error.rb +24 -0
  248. data/lib/r10k/util/subprocess.rb +85 -0
  249. data/lib/r10k/util/symbolize_keys.rb +35 -0
  250. data/lib/r10k/version.rb +6 -0
  251. data/lib/r10k.rb +11 -0
  252. data/locales/config.yaml +21 -0
  253. data/locales/r10k.pot +693 -0
  254. data/r10k.gemspec +52 -0
  255. data/r10k.yaml.example +140 -0
  256. data/spec/fixtures/empty/.empty +0 -0
  257. data/spec/fixtures/integration/git/puppet-boolean-bare.tar +0 -0
  258. data/spec/fixtures/module/forge/bad_module/metadata.json +1 -0
  259. data/spec/fixtures/module/forge/eight_hundred/Modulefile +8 -0
  260. data/spec/fixtures/module/forge/eight_hundred/metadata.json +19 -0
  261. data/spec/fixtures/tarball/tarball.tar.gz +0 -0
  262. data/spec/fixtures/unit/action/r10k.yaml +5 -0
  263. data/spec/fixtures/unit/action/r10k_cachedir.yaml +2 -0
  264. data/spec/fixtures/unit/action/r10k_creds.yaml +9 -0
  265. data/spec/fixtures/unit/action/r10k_forge_auth.yaml +4 -0
  266. data/spec/fixtures/unit/action/r10k_forge_auth_no_url.yaml +3 -0
  267. data/spec/fixtures/unit/action/r10k_generate_types.yaml +3 -0
  268. data/spec/fixtures/unit/action/r10k_logging.yaml +12 -0
  269. data/spec/fixtures/unit/action/r10k_puppet_path.yaml +3 -0
  270. data/spec/fixtures/unit/puppetfile/argument-error/Puppetfile +1 -0
  271. data/spec/fixtures/unit/puppetfile/default-branch-override/Puppetfile +5 -0
  272. data/spec/fixtures/unit/puppetfile/duplicate-module-error/Puppetfile +10 -0
  273. data/spec/fixtures/unit/puppetfile/forge-override/Puppetfile +8 -0
  274. data/spec/fixtures/unit/puppetfile/invalid-syntax/Puppetfile +1 -0
  275. data/spec/fixtures/unit/puppetfile/load-error/Puppetfile +1 -0
  276. data/spec/fixtures/unit/puppetfile/name-error/Puppetfile +1 -0
  277. data/spec/fixtures/unit/puppetfile/valid-forge-with-version/Puppetfile +1 -0
  278. data/spec/fixtures/unit/puppetfile/valid-forge-without-version/Puppetfile +1 -0
  279. data/spec/fixtures/unit/puppetfile/various-modules/Puppetfile +10 -0
  280. data/spec/fixtures/unit/puppetfile/various-modules/Puppetfile.new +10 -0
  281. data/spec/fixtures/unit/puppetfile/various-modules/modules/apt/.gitkeep +1 -0
  282. data/spec/fixtures/unit/puppetfile/various-modules/modules/baz/.gitkeep +1 -0
  283. data/spec/fixtures/unit/puppetfile/various-modules/modules/buzz/.gitkeep +1 -0
  284. data/spec/fixtures/unit/puppetfile/various-modules/modules/canary/.gitkeep +1 -0
  285. data/spec/fixtures/unit/puppetfile/various-modules/modules/fizz/.gitkeep +1 -0
  286. data/spec/fixtures/unit/puppetfile/various-modules/modules/rpm/.gitkeep +1 -0
  287. data/spec/fixtures/unit/util/purgeable/managed_one/expected_1 +0 -0
  288. data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_symlink_file +1 -0
  289. data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_allowlisted_2/ignored_1 +0 -0
  290. data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_expected_1 +0 -0
  291. data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_unmanaged_1 +0 -0
  292. data/spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/unmanaged_symlink_dir +1 -0
  293. data/spec/fixtures/unit/util/purgeable/managed_one/managed_symlink_dir +1 -0
  294. data/spec/fixtures/unit/util/purgeable/managed_one/unmanaged_1 +0 -0
  295. data/spec/fixtures/unit/util/purgeable/managed_one/unmanaged_symlink_file +1 -0
  296. data/spec/fixtures/unit/util/purgeable/managed_two/.hidden/unmanaged_3 +0 -0
  297. data/spec/fixtures/unit/util/purgeable/managed_two/expected_2 +0 -0
  298. data/spec/fixtures/unit/util/purgeable/managed_two/unmanaged_2 +0 -0
  299. data/spec/fixtures/unit/util/subprocess/runner/no-execute.sh +3 -0
  300. data/spec/integration/git/rugged/bare_repository_spec.rb +13 -0
  301. data/spec/integration/git/rugged/cache_spec.rb +33 -0
  302. data/spec/integration/git/rugged/thin_repository_spec.rb +14 -0
  303. data/spec/integration/git/rugged/working_repository_spec.rb +48 -0
  304. data/spec/integration/git/shellgit/bare_repository_spec.rb +13 -0
  305. data/spec/integration/git/shellgit/thin_repository_spec.rb +14 -0
  306. data/spec/integration/git/shellgit/working_repository_spec.rb +13 -0
  307. data/spec/integration/git/stateful_repository_spec.rb +175 -0
  308. data/spec/integration/util/purageable_spec.rb +41 -0
  309. data/spec/matchers/exit_with.rb +28 -0
  310. data/spec/matchers/match_realpath.rb +18 -0
  311. data/spec/r10k-mocks/mock_config.rb +33 -0
  312. data/spec/r10k-mocks/mock_env.rb +18 -0
  313. data/spec/r10k-mocks/mock_source.rb +17 -0
  314. data/spec/r10k-mocks.rb +3 -0
  315. data/spec/shared-contexts/git-fixtures.rb +55 -0
  316. data/spec/shared-contexts/tarball.rb +32 -0
  317. data/spec/shared-examples/deploy-actions.rb +69 -0
  318. data/spec/shared-examples/git/bare_repository.rb +132 -0
  319. data/spec/shared-examples/git/thin_repository.rb +26 -0
  320. data/spec/shared-examples/git/working_repository.rb +207 -0
  321. data/spec/shared-examples/git-repository.rb +38 -0
  322. data/spec/shared-examples/puppetfile-action.rb +39 -0
  323. data/spec/shared-examples/settings/ancestry.rb +44 -0
  324. data/spec/shared-examples/subprocess-runner.rb +89 -0
  325. data/spec/spec_helper.rb +41 -0
  326. data/spec/unit/action/cri_runner_spec.rb +72 -0
  327. data/spec/unit/action/deploy/deploy_helpers_spec.rb +38 -0
  328. data/spec/unit/action/deploy/display_spec.rb +61 -0
  329. data/spec/unit/action/deploy/environment_spec.rb +640 -0
  330. data/spec/unit/action/deploy/module_spec.rb +476 -0
  331. data/spec/unit/action/puppetfile/check_spec.rb +53 -0
  332. data/spec/unit/action/puppetfile/cri_runner_spec.rb +47 -0
  333. data/spec/unit/action/puppetfile/install_spec.rb +112 -0
  334. data/spec/unit/action/puppetfile/purge_spec.rb +60 -0
  335. data/spec/unit/action/runner_spec.rb +407 -0
  336. data/spec/unit/action/visitor_spec.rb +39 -0
  337. data/spec/unit/cli_spec.rb +9 -0
  338. data/spec/unit/deployment/config_spec.rb +33 -0
  339. data/spec/unit/deployment_spec.rb +162 -0
  340. data/spec/unit/environment/bare_spec.rb +13 -0
  341. data/spec/unit/environment/base_spec.rb +122 -0
  342. data/spec/unit/environment/git_spec.rb +114 -0
  343. data/spec/unit/environment/name_spec.rb +181 -0
  344. data/spec/unit/environment/plain_spec.rb +8 -0
  345. data/spec/unit/environment/svn_spec.rb +146 -0
  346. data/spec/unit/environment/tarball_spec.rb +45 -0
  347. data/spec/unit/environment/with_modules_spec.rb +122 -0
  348. data/spec/unit/errors/formatting_spec.rb +84 -0
  349. data/spec/unit/feature_spec.rb +50 -0
  350. data/spec/unit/forge/module_release_spec.rb +213 -0
  351. data/spec/unit/git/alternates_spec.rb +116 -0
  352. data/spec/unit/git/cache_spec.rb +66 -0
  353. data/spec/unit/git/rugged/cache_spec.rb +48 -0
  354. data/spec/unit/git/rugged/credentials_spec.rb +215 -0
  355. data/spec/unit/git/shellgit/cache_spec.rb +27 -0
  356. data/spec/unit/git/stateful_repository_spec.rb +45 -0
  357. data/spec/unit/git_spec.rb +102 -0
  358. data/spec/unit/initializers_spec.rb +68 -0
  359. data/spec/unit/instance_cache_spec.rb +78 -0
  360. data/spec/unit/keyed_factory_spec.rb +51 -0
  361. data/spec/unit/logging/terminaloutputter_spec.rb +53 -0
  362. data/spec/unit/logging_spec.rb +68 -0
  363. data/spec/unit/module/base_spec.rb +118 -0
  364. data/spec/unit/module/forge_spec.rb +271 -0
  365. data/spec/unit/module/git_spec.rb +387 -0
  366. data/spec/unit/module/metadata_file_spec.rb +68 -0
  367. data/spec/unit/module/svn_spec.rb +208 -0
  368. data/spec/unit/module/tarball_spec.rb +70 -0
  369. data/spec/unit/module_loader/puppetfile_spec.rb +421 -0
  370. data/spec/unit/module_spec.rb +114 -0
  371. data/spec/unit/puppetfile_spec.rb +304 -0
  372. data/spec/unit/settings/collection_spec.rb +123 -0
  373. data/spec/unit/settings/container_spec.rb +92 -0
  374. data/spec/unit/settings/definition_spec.rb +79 -0
  375. data/spec/unit/settings/enum_definition_spec.rb +20 -0
  376. data/spec/unit/settings/inheritance_spec.rb +38 -0
  377. data/spec/unit/settings/list_spec.rb +88 -0
  378. data/spec/unit/settings/loader_spec.rb +110 -0
  379. data/spec/unit/settings/uri_definition_spec.rb +23 -0
  380. data/spec/unit/settings_spec.rb +303 -0
  381. data/spec/unit/source/base_spec.rb +31 -0
  382. data/spec/unit/source/exec_spec.rb +81 -0
  383. data/spec/unit/source/git_spec.rb +233 -0
  384. data/spec/unit/source/hash_spec.rb +54 -0
  385. data/spec/unit/source/svn_spec.rb +196 -0
  386. data/spec/unit/source/yaml_spec.rb +42 -0
  387. data/spec/unit/source_spec.rb +10 -0
  388. data/spec/unit/svn/remote_spec.rb +21 -0
  389. data/spec/unit/svn/working_dir_spec.rb +56 -0
  390. data/spec/unit/tarball_spec.rb +57 -0
  391. data/spec/unit/util/attempt_spec.rb +82 -0
  392. data/spec/unit/util/cacheable_spec.rb +23 -0
  393. data/spec/unit/util/commands_spec.rb +61 -0
  394. data/spec/unit/util/downloader_spec.rb +98 -0
  395. data/spec/unit/util/exec_env_spec.rb +56 -0
  396. data/spec/unit/util/purgeable_spec.rb +267 -0
  397. data/spec/unit/util/setopts_spec.rb +83 -0
  398. data/spec/unit/util/subprocess/result_spec.rb +36 -0
  399. data/spec/unit/util/subprocess/runner/posix_spec.rb +7 -0
  400. data/spec/unit/util/subprocess/runner/pump_spec.rb +79 -0
  401. data/spec/unit/util/subprocess/runner/windows_spec.rb +7 -0
  402. data/spec/unit/util/subprocess/subprocess_error_spec.rb +26 -0
  403. data/spec/unit/util/subprocess_spec.rb +65 -0
  404. data/spec/unit/util/symbolize_keys_spec.rb +67 -0
  405. metadata +637 -0
@@ -0,0 +1,82 @@
1
+ require 'spec_helper'
2
+ require 'r10k/util/attempt'
3
+
4
+ describe R10K::Util::Attempt do
5
+
6
+ describe "with a single truthy value" do
7
+ subject(:attempt) { described_class.new("hello") }
8
+
9
+ it "invokes the next action with the value" do
10
+ value = nil
11
+ attempt.try { |inner| value = inner }
12
+ attempt.run
13
+ expect(attempt).to be_ok
14
+ expect(value).to eq "hello"
15
+ end
16
+
17
+ it "returns the resulting value from the block" do
18
+ attempt.try { |inner| inner + " world" }
19
+ result = attempt.run
20
+ expect(attempt).to be_ok
21
+ expect(result).to eq "hello world"
22
+ end
23
+ end
24
+
25
+ describe "with a false value" do
26
+ subject(:attempt) { described_class.new(nil) }
27
+
28
+ it "does not evaluate the block" do
29
+ value = "outside of block"
30
+ attempt.try { |inner| value = "ran block" }
31
+ attempt.run
32
+ expect(attempt).to be_ok
33
+ expect(value).to eq "outside of block"
34
+ end
35
+
36
+ it "does not continue execution" do
37
+ attempt.try { |_| "something" }.try { raise }
38
+ expect(attempt.run).to be_nil
39
+ end
40
+ end
41
+
42
+ describe "with an array" do
43
+ subject(:attempt) { described_class.new([1, 2, 3, 4, 5]) }
44
+
45
+ it "runs the block for each element in the array" do
46
+ sum = 0
47
+ attempt.try { |inner| sum += inner }
48
+ attempt.run
49
+ expect(attempt).to be_ok
50
+ expect(sum).to eq 15
51
+ end
52
+
53
+ it "returns the result of the operation on each array member" do
54
+ sum = 0
55
+ attempt.try { |inner| sum += inner }
56
+ result = attempt.run
57
+ expect(result).to eq([1, 3, 6, 10, 15])
58
+ end
59
+ end
60
+
61
+ describe "when an exception is raised" do
62
+ subject(:attempt) { described_class.new("initial") }
63
+
64
+ it "returns the exception" do
65
+ attempt.try { |_| raise RuntimeError }
66
+ result = attempt.run
67
+ expect(attempt).to_not be_ok
68
+ expect(result).to be_a_kind_of RuntimeError
69
+ end
70
+
71
+ it "does not continue execution" do
72
+ attempt.try { |_| raise RuntimeError }.try { |_| "This should not be run" }
73
+ result = attempt.run
74
+ expect(result).to be_a_kind_of RuntimeError
75
+ end
76
+
77
+ it "only rescues descendants of StandardError" do
78
+ attempt.try { |_| raise Exception }
79
+ expect { attempt.run }.to raise_error(Exception)
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,23 @@
1
+ require 'spec_helper'
2
+ require 'r10k/util/cacheable'
3
+
4
+ RSpec.describe R10K::Util::Cacheable do
5
+
6
+ subject { Object.new.extend(R10K::Util::Cacheable) }
7
+
8
+ describe "dirname sanitization" do
9
+ let(:input) { 'https://some/git/remote' }
10
+
11
+ it 'sanitizes URL to directory name' do
12
+ expect(subject.sanitized_dirname(input)).to eq('https---some-git-remote')
13
+ end
14
+
15
+ context 'with username and password' do
16
+ let(:input) { 'https://"user:pa$$w0rd:@authenticated/git/remote' }
17
+
18
+ it 'sanitizes authenticated URL to directory name' do
19
+ expect(subject.sanitized_dirname(input)).to eq('https---authenticated-git-remote')
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,61 @@
1
+ require 'r10k/util/commands'
2
+ require 'r10k/util/exec_env'
3
+
4
+ require 'tmpdir'
5
+
6
+ describe R10K::Util::Commands do
7
+ describe "#which" do
8
+
9
+ before do
10
+ allow(File).to receive(:executable?).and_return false
11
+ allow(File).to receive(:file?).and_return false
12
+ end
13
+
14
+ def stub_executable(exe)
15
+ allow(File).to receive(:executable?).with(exe).and_return true
16
+ allow(File).to receive(:file?).with(exe).and_return true
17
+ end
18
+
19
+ describe "when ENV['PATHEXT'] is unset" do
20
+ let(:path) { Dir.mktmpdir }
21
+
22
+ around(:each) do |example|
23
+ R10K::Util::ExecEnv.withenv('PATHEXT' => nil, 'PATH' => path) do
24
+ example.run
25
+ end
26
+ end
27
+
28
+ it "returns the first matching command in PATH" do
29
+ exe = File.join(path, 'git')
30
+ stub_executable(exe)
31
+ expect(described_class.which("git")).to eq exe
32
+ end
33
+
34
+ it "returns nil if the command could not be found" do
35
+ exe = File.join(path, 'git')
36
+ expect(described_class.which("git")).to be_nil
37
+ end
38
+ end
39
+
40
+ describe "when ENV['PATHEXT'] is set" do
41
+ let(:path) { Dir.mktmpdir }
42
+
43
+ around(:each) do |example|
44
+ R10K::Util::ExecEnv.withenv('PATHEXT' => '.bat;.exe;.cmd', 'PATH' => path) do
45
+ example.run
46
+ end
47
+ end
48
+
49
+ it "returns the first matching command in PATH" do
50
+ exe = File.join(path, 'git.exe')
51
+ stub_executable(exe)
52
+ expect(described_class.which("git")).to eq exe
53
+ end
54
+
55
+ it "returns nil if the command could not be found" do
56
+ exe = File.join(path, 'git.exe')
57
+ expect(described_class.which("git")).to be_nil
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,98 @@
1
+ require 'spec_helper'
2
+ require 'r10k/util/downloader'
3
+
4
+ describe R10K::Util::Downloader do
5
+
6
+ subject(:downloader) do
7
+ subj = Object.new
8
+ subj.extend(R10K::Util::Downloader)
9
+ subj.singleton_class.class_eval { public :download }
10
+ subj.singleton_class.class_eval { public :http_get }
11
+ subj.singleton_class.class_eval { public :file_digest }
12
+ subj
13
+ end
14
+
15
+ let(:tmpdir) { Dir.mktmpdir }
16
+ after(:each) { FileUtils.remove_entry_secure(tmpdir) }
17
+
18
+ describe 'http_get' do
19
+ let(:src_url) { 'https://example.com' }
20
+ let(:dst_file) { File.join(tmpdir, 'test.out') }
21
+ let(:tarball_uri) { URI('http://tarball.example.com/tarball.tar.gz') }
22
+ let(:redirect_uri) { URI('http://redirect.example.com/redirect') }
23
+ let(:proxy_uri) { URI('http://user:password@proxy.example.com') }
24
+
25
+ it 'downloads a simple file' do
26
+ mock_session = instance_double('Net::HTTP', active?: true)
27
+ tarball_response = instance_double('Net::HTTPSuccess')
28
+
29
+ expect(Net::HTTP).to receive(:new).with(tarball_uri.host, any_args).and_return(mock_session)
30
+ expect(Net::HTTPSuccess).to receive(:===).with(tarball_response).and_return(true)
31
+
32
+ expect(mock_session).to receive(:request_get).and_yield(tarball_response)
33
+ expect(mock_session).to receive(:start).once
34
+ expect(mock_session).to receive(:finish).once
35
+
36
+ expect { |b| downloader.http_get(tarball_uri, &b) }.to yield_with_args(tarball_response)
37
+ end
38
+
39
+ it 'follows redirects' do
40
+ mock_session_1 = instance_double('Net::HTTP', active?: false)
41
+ mock_session_2 = instance_double('Net::HTTP', active?: true)
42
+ redirect_response = instance_double('Net::HTTPRedirection')
43
+ tarball_response = instance_double('Net::HTTPSuccess')
44
+
45
+ expect(Net::HTTP).to receive(:new).with(redirect_uri.host, any_args).and_return(mock_session_1).once
46
+ expect(Net::HTTP).to receive(:new).with(tarball_uri.host, any_args).and_return(mock_session_2).once
47
+ expect(Net::HTTPRedirection).to receive(:===).with(redirect_response).and_return(true)
48
+ expect(Net::HTTPSuccess).to receive(:===).with(tarball_response).and_return(true)
49
+ allow(Net::HTTPRedirection).to receive(:===).and_call_original
50
+
51
+ expect(mock_session_1).to receive(:request_get).and_yield(redirect_response)
52
+ expect(mock_session_2).to receive(:request_get).and_yield(tarball_response)
53
+
54
+ # The redirect response should be queried for the redirect location
55
+ expect(redirect_response).to receive(:[]).with('location').and_return(tarball_uri.to_s)
56
+
57
+ # Both sessions should start and finish cleanly
58
+ expect(mock_session_1).to receive(:start).once
59
+ expect(mock_session_1).to receive(:finish).once
60
+ expect(mock_session_2).to receive(:start).once
61
+ expect(mock_session_2).to receive(:finish).once
62
+
63
+ expect { |b| downloader.http_get(redirect_uri, &b) }.to yield_with_args(tarball_response)
64
+ end
65
+
66
+ it 'can use a proxy' do
67
+ mock_session = instance_double('Net::HTTP', active?: true)
68
+
69
+ expect(Net::HTTP).to receive(:new)
70
+ .with(tarball_uri.host,
71
+ tarball_uri.port,
72
+ proxy_uri.host,
73
+ proxy_uri.port,
74
+ proxy_uri.user,
75
+ proxy_uri.password,
76
+ any_args)
77
+ .and_return(mock_session)
78
+
79
+ expect(mock_session).to receive(:request_get).and_return(:not_yielded)
80
+ expect(mock_session).to receive(:start).once
81
+ expect(mock_session).to receive(:finish).once
82
+
83
+ downloader.http_get(tarball_uri, proxy: proxy_uri)
84
+ end
85
+ end
86
+
87
+ describe 'checksums' do
88
+ let(:fixture_checksum) { '0bcea17aa0c5e868c18f0fa042feda770e47c1a4223229f82116ccb3ca33c6e3' }
89
+ let(:fixture_tarball) do
90
+ File.expand_path('spec/fixtures/integration/git/puppet-boolean-bare.tar', PROJECT_ROOT)
91
+ end
92
+
93
+ it 'checksums files' do
94
+ expect(downloader.file_digest(fixture_tarball)).to eql(fixture_checksum)
95
+ end
96
+ end
97
+ end
98
+
@@ -0,0 +1,56 @@
1
+ require 'r10k/util/exec_env'
2
+
3
+ describe R10K::Util::ExecEnv do
4
+ describe "withenv" do
5
+ it "adds the keys to the environment during the block" do
6
+ val = nil
7
+ described_class.withenv('VAL' => 'something') do
8
+ val = ENV['VAL']
9
+ end
10
+ expect(val).to eq 'something'
11
+ end
12
+
13
+ it "doesn't modify values that were not modified by the passed hash" do
14
+ origpath = ENV['PATH']
15
+ path = nil
16
+ described_class.withenv('VAL' => 'something') do
17
+ path = ENV['PATH']
18
+ end
19
+ expect(path).to eq origpath
20
+ end
21
+
22
+ it "removes new values after the block" do
23
+ val = nil
24
+ described_class.withenv('VAL' => 'something') { }
25
+ expect(ENV['VAL']).to be_nil
26
+ end
27
+
28
+ it "restores old values after the block" do
29
+ path = ENV['PATH']
30
+ described_class.withenv('PATH' => '/usr/bin') { }
31
+ expect(ENV['PATH']).to eq path
32
+ end
33
+ end
34
+
35
+ describe "reset" do
36
+
37
+ after { ENV.delete('VAL') }
38
+
39
+ it "replaces environment keys with the specified keys" do
40
+ ENV['VAL'] = 'hi'
41
+
42
+ newenv = ENV.to_hash
43
+ newenv['VAL'] = 'bye'
44
+
45
+ described_class.reset(newenv)
46
+ expect(ENV['VAL']).to eq 'bye'
47
+ end
48
+
49
+ it "removes any keys that were not provided" do
50
+ env = ENV.to_hash
51
+ ENV['VAL'] = 'hi'
52
+ described_class.reset(env)
53
+ expect(ENV['VAL']).to be_nil
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,267 @@
1
+ require 'spec_helper'
2
+ require 'r10k/util/purgeable'
3
+ require 'r10k/util/cleaner'
4
+
5
+ RSpec.describe R10K::Util::Purgeable do
6
+ let(:managed_directories) do
7
+ [
8
+ 'spec/fixtures/unit/util/purgeable/managed_one',
9
+ 'spec/fixtures/unit/util/purgeable/managed_two',
10
+ ]
11
+ end
12
+
13
+ let(:desired_contents) do
14
+ [
15
+ 'spec/fixtures/unit/util/purgeable/managed_one/expected_1',
16
+ 'spec/fixtures/unit/util/purgeable/managed_one/new_1',
17
+ 'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1',
18
+ 'spec/fixtures/unit/util/purgeable/managed_one/managed_symlink_dir',
19
+ 'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_expected_1',
20
+ 'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/subdir_new_1',
21
+ 'spec/fixtures/unit/util/purgeable/managed_one/managed_subdir_1/managed_symlink_file',
22
+ 'spec/fixtures/unit/util/purgeable/managed_two/expected_2',
23
+ 'spec/fixtures/unit/util/purgeable/managed_two/new_2',
24
+ 'spec/fixtures/unit/util/purgeable/managed_two/.hidden',
25
+ ]
26
+ end
27
+
28
+ subject { R10K::Util::Cleaner.new(managed_directories, desired_contents) }
29
+
30
+ context 'without recurse option' do
31
+ let(:recurse) { false }
32
+
33
+ describe '#current_contents' do
34
+ it 'collects direct contents of all managed directories' do
35
+ expect(subject.current_contents(recurse)).to contain_exactly(/\/expected_1/, /\/expected_2/, /\/unmanaged_1/, /\/unmanaged_2/,
36
+ /\/managed_subdir_1/, /\/managed_symlink_dir/, /\/unmanaged_symlink_file/)
37
+ end
38
+ end
39
+
40
+ describe '#pending_contents' do
41
+ it 'collects desired_contents that do not yet exist' do
42
+ expect(subject.pending_contents(recurse)).to include(/\/new_1/, /\/new_2/)
43
+ end
44
+ end
45
+
46
+ describe '#stale_contents' do
47
+ context 'with no whitelist or exclusions' do
48
+ let(:exclusions) { [] }
49
+ let(:whitelist) { [] }
50
+
51
+ it 'collects current_contents that should not exist' do
52
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/, /\/unmanaged_symlink_file/)
53
+ end
54
+ end
55
+
56
+ context 'with whitelisted items' do
57
+ let(:exclusions) { [] }
58
+ let(:whitelist) { ['**/unmanaged_1'] }
59
+
60
+ it 'collects current_contents that should not exist except whitelisted items' do
61
+ expect(subject.logger).to receive(:debug).with(/unmanaged_1.*whitelist match/i)
62
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_2/, /\/unmanaged_symlink_file/)
63
+ end
64
+ end
65
+
66
+ context 'with excluded items' do
67
+ let(:exclusions) { ['**/unmanaged_2'] }
68
+ let(:whitelist) { [] }
69
+
70
+ it 'collects current_contents that should not exist except excluded items' do
71
+ expect(subject.logger).to receive(:debug2).with(/unmanaged_2.*internal exclusion match/i)
72
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).to contain_exactly(/\/unmanaged_1/, /\/unmanaged_symlink_file/)
73
+ end
74
+ end
75
+ end
76
+
77
+ describe '#purge!' do
78
+ let(:exclusions) { [] }
79
+ let(:whitelist) { [] }
80
+ let(:purge_opts) { { recurse: recurse, whitelist: whitelist } }
81
+
82
+ it 'does nothing when there is no stale_contents' do
83
+ allow(subject).to receive(:stale_contents).and_return([])
84
+
85
+ expect(FileUtils).to_not receive(:rm_rf)
86
+
87
+ subject.purge!(purge_opts)
88
+ end
89
+
90
+ it 'recursively deletes all stale_contents' do
91
+ subject.stale_contents(recurse, exclusions, whitelist).each do |stale|
92
+ expect(FileUtils).to receive(:rm_r).with(stale, hash_including(secure: true))
93
+ end
94
+
95
+ subject.purge!(purge_opts)
96
+ end
97
+ end
98
+ end
99
+
100
+ context 'with recurse option' do
101
+ let(:recurse) { true }
102
+
103
+ describe '#current_contents' do
104
+ it 'collects contents of all managed directories recursively' do
105
+ expect(subject.current_contents(recurse)).
106
+ to contain_exactly(/\/expected_1/, /\/expected_2/,
107
+ /\/unmanaged_1/, /\/unmanaged_2/,
108
+ /\/managed_symlink_dir/,
109
+ /\/unmanaged_symlink_file/,
110
+ /\/managed_subdir_1/,
111
+ /\/subdir_expected_1/, /\/subdir_unmanaged_1/,
112
+ /\/managed_symlink_file/,
113
+ /\/unmanaged_symlink_dir/,
114
+ /\/subdir_allowlisted_2/, /\/ignored_1/,
115
+ /\/\.hidden/)
116
+ end
117
+ end
118
+
119
+ describe '#pending_contents' do
120
+ it 'collects desired_contents that do not yet exist recursively' do
121
+ expect(subject.pending_contents(recurse)).to include(/\/new_1/, /\/new_2/, /\/subdir_new_1/)
122
+ end
123
+ end
124
+
125
+ describe '#stale_contents' do
126
+ context 'with no whitelist or exclusions' do
127
+ let(:exclusions) { [] }
128
+ let(:whitelist) { [] }
129
+
130
+ it 'collects current_contents that should not exist recursively' do
131
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).
132
+ to contain_exactly(/\/unmanaged_1/, /\/unmanaged_2/, /\/unmanaged_symlink_file/, /\/subdir_unmanaged_1/,
133
+ /\/ignored_1/, /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
134
+ end
135
+ end
136
+
137
+ context 'with whitelisted items' do
138
+ let(:exclusions) { [] }
139
+ let(:whitelist) { ['**/unmanaged_1'] }
140
+
141
+ it 'collects current_contents that should not exist except whitelisted items' do
142
+ expect(subject.logger).to receive(:debug).with(/unmanaged_1.*whitelist match/i)
143
+
144
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).
145
+ to contain_exactly(/\/unmanaged_2/, /\/subdir_unmanaged_1/, /\/unmanaged_symlink_file/, /\/ignored_1/,
146
+ /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
147
+ end
148
+
149
+ it 'does not collect contents that match recursive globbed whitelist items as intermediate values' do
150
+ recursive_whitelist = ['**/managed_subdir_1/**/*']
151
+ expect(subject.logger).not_to receive(:debug).with(/ignored_1/)
152
+
153
+ expect(subject.stale_contents(recurse, exclusions, recursive_whitelist)).
154
+ to contain_exactly(/\/unmanaged_2/, /\/managed_one\/unmanaged_1/, /\/managed_one\/unmanaged_symlink_file/)
155
+ end
156
+ end
157
+
158
+ context 'with excluded items' do
159
+ let(:exclusions) { ['**/unmanaged_2'] }
160
+ let(:whitelist) { [] }
161
+
162
+ it 'collects current_contents that should not exist except excluded items' do
163
+ expect(subject.logger).to receive(:debug2).with(/unmanaged_2.*internal exclusion match/i)
164
+
165
+ expect(subject.stale_contents(recurse, exclusions, whitelist)).
166
+ to contain_exactly(/\/unmanaged_1/, /\/unmanaged_symlink_file/, /\/subdir_unmanaged_1/, /\/ignored_1/,
167
+ /\/subdir_allowlisted_2/, /\/unmanaged_symlink_dir/)
168
+ end
169
+
170
+ it 'does not collect contents that match recursive globbed exclusion items as intermediate values' do
171
+ recursive_exclusions = ['**/managed_subdir_1/**/*']
172
+ expect(subject.logger).not_to receive(:debug).with(/ignored_1/)
173
+
174
+ expect(subject.stale_contents(recurse, recursive_exclusions, whitelist)).
175
+ to contain_exactly(/\/unmanaged_2/, /\/unmanaged_symlink_file/, /\/managed_one\/unmanaged_1/)
176
+ end
177
+ end
178
+ end
179
+
180
+ describe '#purge!' do
181
+ let(:exclusions) { [] }
182
+ let(:whitelist) { [] }
183
+ let(:purge_opts) { { recurse: recurse, whitelist: whitelist } }
184
+
185
+ it 'does nothing when there is no stale_contents' do
186
+ allow(subject).to receive(:stale_contents).and_return([])
187
+
188
+ expect(FileUtils).to_not receive(:rm_r)
189
+
190
+ subject.purge!(purge_opts)
191
+ end
192
+
193
+ it 'recursively deletes all stale_contents' do
194
+ subject.stale_contents(recurse, exclusions, whitelist).each do |stale|
195
+ expect(FileUtils).to receive(:rm_r).with(stale, hash_including(secure: true))
196
+ end
197
+
198
+ subject.purge!(purge_opts)
199
+ end
200
+ end
201
+ end
202
+
203
+ describe "user whitelist functionality" do
204
+ context "non-recursive whitelist glob" do
205
+ let(:whitelist) { managed_directories.collect { |dir| File.join(dir, "*unmanaged*") } }
206
+ let(:purge_opts) { { recurse: true, whitelist: whitelist } }
207
+
208
+ describe '#purge!' do
209
+ it 'does not purge items matching glob at root level' do
210
+ allow(FileUtils).to receive(:rm_r)
211
+ expect(FileUtils).to_not receive(:rm_r).with(/\/unmanaged_[12]/, anything)
212
+ expect(FileUtils).to_not receive(:rm_r).with(/\/unmanaged_symlink_file/, anything)
213
+ expect(subject.logger).to receive(:debug).with(/whitelist match/i).at_least(:once)
214
+
215
+ subject.purge!(purge_opts)
216
+ end
217
+ end
218
+ end
219
+
220
+ context "recursive whitelist glob" do
221
+ let(:whitelist) do
222
+ managed_directories.flat_map do |dir|
223
+ [File.join(dir, "**", "*unmanaged*"), File.join(dir, "**", "subdir_allowlisted_2")]
224
+ end
225
+ end
226
+ let(:purge_opts) { { recurse: true, whitelist: whitelist } }
227
+
228
+ describe '#purge!' do
229
+ it 'does not purge items matching glob at any level' do
230
+ expect(FileUtils).to_not receive(:rm_r)
231
+ expect(subject.logger).to receive(:debug).with(/whitelist match/i).at_least(:once)
232
+
233
+ subject.purge!(purge_opts)
234
+ end
235
+ end
236
+ end
237
+ end
238
+
239
+ describe "internal exclusions functionality" do
240
+ let(:purge_opts) { { recurse: true, whitelist: [] } }
241
+ let(:exclusions) { [ File.join('**', 'unmanaged_1') ] }
242
+
243
+ context "when class implements #purge_exclusions" do
244
+ describe '#purge!' do
245
+ it 'does not purge items matching exclusion glob' do
246
+ expect(subject).to receive(:purge_exclusions).and_return(exclusions)
247
+
248
+ allow(FileUtils).to receive(:rm_r)
249
+ expect(FileUtils).to_not receive(:rm_r).with(/\/unmanaged_1/, anything)
250
+ expect(subject.logger).to receive(:debug2).with(/unmanaged_1.*internal exclusion match/i)
251
+
252
+ subject.purge!(purge_opts)
253
+ end
254
+ end
255
+ end
256
+
257
+ context "when class does not implement #purge_exclusions" do
258
+ describe '#purge!' do
259
+ it 'purges normally' do
260
+ expect(FileUtils).to receive(:rm_r).at_least(4).times
261
+
262
+ subject.purge!(purge_opts)
263
+ end
264
+ end
265
+ end
266
+ end
267
+ end
@@ -0,0 +1,83 @@
1
+ require 'spec_helper'
2
+ require 'r10k/util/setopts'
3
+
4
+ describe R10K::Util::Setopts do
5
+ let(:klass) do
6
+ Class.new do
7
+ include R10K::Util::Setopts
8
+
9
+ attr_reader :valid, :alsovalid, :truthyvalid
10
+
11
+ def initialize(opts = {})
12
+ setopts(opts, {
13
+ :valid => :self,
14
+ :duplicate => :valid,
15
+ :alsovalid => :self,
16
+ :truthyvalid => true,
17
+ :validalias => :valid,
18
+ :ignoreme => nil
19
+ })
20
+ end
21
+ end
22
+ end
23
+
24
+ it "can handle an empty hash of options" do
25
+ o = klass.new()
26
+ expect(o.valid).to be_nil
27
+ expect(o.alsovalid).to be_nil
28
+ end
29
+
30
+ it "can handle a single valid option" do
31
+ o = klass.new(:valid => 'yep')
32
+ expect(o.valid).to eq 'yep'
33
+ expect(o.alsovalid).to be_nil
34
+ end
35
+
36
+ it "can handle multiple valid options" do
37
+ o = klass.new(:valid => 'yep', :alsovalid => 'yarp')
38
+ expect(o.valid).to eq 'yep'
39
+ expect(o.alsovalid).to eq 'yarp'
40
+ end
41
+
42
+ it "can handle options marked with TrueClass" do
43
+ o = klass.new(:truthyvalid => 'so truthy')
44
+ expect(o.truthyvalid).to eq 'so truthy'
45
+ end
46
+
47
+ it "can handle aliases marked with :self" do
48
+ o = klass.new(:validalias => 'yuuup')
49
+ expect(o.valid).to eq 'yuuup'
50
+ end
51
+
52
+
53
+ it "raises an error when given an unhandled option" do
54
+ expect {
55
+ klass.new(:valid => 'yep', :notvalid => 'newp')
56
+ }.to raise_error(ArgumentError, /cannot handle option 'notvalid'/)
57
+ end
58
+
59
+ it "warns when given an unhandled option and raise_on_unhandled=false" do
60
+ test = Class.new { include R10K::Util::Setopts }.new
61
+ allow(test).to receive(:logger).and_return(spy)
62
+
63
+ test.send(:setopts, {valid: :value, invalid: :value},
64
+ {valid: :self},
65
+ raise_on_unhandled: false)
66
+
67
+ expect(test.logger).to have_received(:warn).with(%r{cannot handle option 'invalid'})
68
+ end
69
+
70
+ it "ignores values that are marked as unhandled" do
71
+ klass.new(:ignoreme => "IGNORE ME!")
72
+ end
73
+
74
+ it "warns when given conflicting options" do
75
+ test = Class.new { include R10K::Util::Setopts }.new
76
+ allow(test).to receive(:logger).and_return(spy)
77
+
78
+ test.send(:setopts, {valid: :one, duplicate: :two},
79
+ {valid: :arg, duplicate: :arg})
80
+
81
+ expect(test.logger).to have_received(:warn).with(%r{valid.*duplicate.*conflict.*not both})
82
+ end
83
+ end