beaker 2.47.1 → 2.48.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +8 -8
  2. data/CONTRIBUTING.md +5 -5
  3. data/HISTORY.md +288 -2
  4. data/README.md +36 -15
  5. data/Rakefile +4 -4
  6. data/acceptance/tests/base/dsl/helpers/host_helpers/archive_file_from_test.rb +35 -0
  7. data/acceptance/tests/base/host_test.rb +16 -16
  8. data/acceptance/tests/install/from_file.rb +20 -0
  9. data/acceptance/tests/puppet/stub_host.rb +47 -0
  10. data/beaker.gemspec +1 -6
  11. data/docs/README.md +16 -26
  12. data/docs/{Argument-Processing-and-Precedence.md → concepts/argument_processing_and_precedence.md} +9 -9
  13. data/docs/{Beaker-Libraries.md → concepts/beaker_libraries.md} +0 -0
  14. data/docs/{beaker-vs.-beaker-rspec.md → concepts/beaker_vs_beaker_rspec.md} +0 -0
  15. data/docs/{Beaker-with-Masterless-Puppet.md → concepts/masterless_puppet.md} +0 -0
  16. data/docs/{Roles-What-Are-They.md → concepts/roles_what_are_they.md} +0 -0
  17. data/docs/{Shared-Options-for-Executing-Beaker-Commands.md → concepts/shared_options_for_executing_beaker_commands.md} +1 -1
  18. data/docs/{Beaker-Test-Tagging.md → concepts/test_tagging.md} +0 -0
  19. data/docs/{meta → concepts}/ticket_process.md +0 -0
  20. data/docs/{Types,-Puppet-4,-and-the-All-In-One-Agent.md → concepts/types_puppet_4_and_the_all_in_one_agent.md} +0 -0
  21. data/docs/{Access-the-Live-Test-Console-with-Pry.md → how_to/access_the_live_test_console_with_pry.md} +0 -0
  22. data/docs/{dsl → how_to}/confine.md +0 -0
  23. data/docs/{hosts → how_to/hosts}/README.md +0 -0
  24. data/docs/{hosts → how_to/hosts}/cisco.md +0 -0
  25. data/docs/{hosts → how_to/hosts}/eos.md +0 -0
  26. data/docs/{hypervisors → how_to/hypervisors}/README.md +0 -0
  27. data/docs/{hypervisors → how_to/hypervisors}/aws.md +0 -0
  28. data/docs/{hypervisors → how_to/hypervisors}/docker.md +0 -0
  29. data/docs/{hypervisors → how_to/hypervisors}/ec2.md +0 -0
  30. data/docs/{hypervisors → how_to/hypervisors}/google_compute_engine.md +0 -0
  31. data/docs/{hypervisors → how_to/hypervisors}/openstack.md +0 -0
  32. data/docs/{hypervisors → how_to/hypervisors}/solaris.md +0 -0
  33. data/docs/{hypervisors → how_to/hypervisors}/vagrant.md +0 -0
  34. data/docs/{hypervisors → how_to/hypervisors}/vagrant_hosts_file_examples.md +0 -0
  35. data/docs/{hypervisors → how_to/hypervisors}/vmware_fusion.md +0 -0
  36. data/docs/{hypervisors → how_to/hypervisors}/vsphere.md +0 -0
  37. data/docs/{dsl → how_to}/platform_specific_tag_confines.md +0 -0
  38. data/docs/how_to/preserve_hosts.md +80 -0
  39. data/docs/how_to/rake_tasks.md +49 -0
  40. data/docs/{Beaker-Recipes.md → how_to/recipes.md} +0 -0
  41. data/docs/{runner → how_to}/run_in_parallel.md +0 -0
  42. data/docs/{The-Beaker-DSL.md → how_to/the_beaker_dsl.md} +0 -0
  43. data/docs/{How-To-Use-User-Password-Authentication-with-Beaker.md → how_to/use_user_password_authentication.md} +0 -0
  44. data/docs/{How-to-Write-a-Beaker-Test-for-a-Module.md → how_to/write_a_beaker_test_for_a_module.md} +2 -2
  45. data/docs/{Creating-A-Test-Environment.md → tutorials/creating_a_test_environment.md} +13 -10
  46. data/docs/tutorials/how_to_beaker.md +6 -0
  47. data/docs/{Beaker-Installation.md → tutorials/installation.md} +0 -0
  48. data/docs/{Lets-Write-a-Test.md → tutorials/lets_write_a_test.md} +18 -11
  49. data/docs/{runner → tutorials}/test_run.md +0 -0
  50. data/docs/{runner → tutorials}/test_suites.md +0 -0
  51. data/docs/{The-Command-Line.md → tutorials/the_command_line.md} +0 -0
  52. data/lib/beaker/dsl/helpers/host_helpers.rb +39 -0
  53. data/lib/beaker/dsl/helpers/puppet_helpers.rb +22 -17
  54. data/lib/beaker/dsl/install_utils/foss_utils.rb +19 -11
  55. data/lib/beaker/dsl/install_utils/windows_utils.rb +39 -0
  56. data/lib/beaker/host/mac/pkg.rb +20 -2
  57. data/lib/beaker/host/unix/exec.rb +4 -4
  58. data/lib/beaker/host/unix/pkg.rb +1 -1
  59. data/lib/beaker/test_suite.rb +12 -5
  60. data/lib/beaker/version.rb +1 -1
  61. data/spec/beaker/dsl/helpers/puppet_helpers_spec.rb +33 -9
  62. data/spec/beaker/dsl/install_utils/foss_utils_spec.rb +24 -0
  63. data/spec/beaker/host_spec.rb +10 -10
  64. data/spec/beaker/test_suite_spec.rb +23 -0
  65. metadata +46 -99
  66. data/docs/How-To-Beaker.md +0 -6
  67. data/docs/meta/README.md +0 -6
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- N2EyOTk3ODFjZGY3YzkxYjRiZDQ3MmMzODdiYjk5YTgyZDAxYzE3Mw==
4
+ ZDM0MmY4ZTg1ODM1YzAyY2YzYTYzOTkzMDdlMDg0OTU0ZTNlMmRhNg==
5
5
  data.tar.gz: !binary |-
6
- ZjFhMjEzOWI0NWVlODMwZDA5NmVhMDA2YjI4YmM4M2U3NzNkM2I1ZA==
6
+ MzI5YzAyNTNkOWE2N2M5ZDE2MTA5NGQ3ZjE3MzE3ZmU4MWZlYzA3NA==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- NGMwOTlmYTEwYzA5ZDE3YTJkYmNjYTRkYjZiMTgzMGYzNTAwOGFkNGU0Nzkz
10
- MWFiZjlhNmU1Zjk2YmFkN2Y0NjJjYjIwMjBjMjkzYTUxYjM5OGI1ZjcwNTU3
11
- MDk2NTIwMTcxYjFjYzJhZGFmNTRkZWFmYjU3MjE0MWExNjQ2ZjI=
9
+ MWVkNTFjZjQ4ZmQ1ZjJiYzhmM2ZkMDE2NDAyODM4ZTYwOGFmZmRjYTUzZjQw
10
+ ZWVlMzBmZjAzOGY1OGYxZWFjMzkyOTM4MDBlODU2MTdhNDEyMzljMDYwZWY5
11
+ Zjk4Mjk2MzczMmJkN2U0MWNlZjdmMmY1Njc4OWRkOGIwNzI0OGE=
12
12
  data.tar.gz: !binary |-
13
- ZDU1ZDUyNmI4ODAwYWRjYTg3ZGNlYTM5Y2IyYzhhNWU1YTIyY2E1MjMzZTk1
14
- Yjg1OTE5ZGIxN2EzNTkyYTBkN2MzMGNjNmVjYmNhMWQ5YTI3YjAyNzI5MzM3
15
- MDkwZmMyODgzNjMxYTBkNWFkZjMyOThhNjMwZGVkNDdmZTVjMzc=
13
+ ZGRhMTg4MTQ5NTFiMDIxY2VmNGNlNTdkODg4NDY5YThkZDJmZTk1ZTUzODNh
14
+ YTZlNmI4MDY3YzQ0MDE4YjJhYzkxMjVmYWExZjU1M2NiNGUzOTU4NGI1Mzc3
15
+ OWVkN2RmZDJlMjU3MTZiNDJjOGRiYmVhYzdjNzM2MWFlMzhlMGY=
data/CONTRIBUTING.md CHANGED
@@ -32,19 +32,19 @@
32
32
  why this is a problem, and how the patch fixes the problem when applied.
33
33
  ````
34
34
 
35
- * During the time that you are working on your patch the master Beaker branch may have changed - you'll want to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) before you submit your PR with `git rebase master`. A successful rebase ensures that your patch will cleanly merge into Beaker.
36
- * Submitted patches will be smoke tested through a series of acceptance level tests that ensures basic Beaker functionality - the results of these tests will be evaluated by a Beaker team member. Failures associated with the submitted patch will result in the patch being rejected.
35
+ * During the time that you are working on your patch the master Beaker branch may have changed - you'll want to [rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) on top of [Beaker's](https://github.com/puppetlabs/beaker) master branch before you submit your PR. A successful rebase ensures that your PR will cleanly merge into Beaker.
37
36
 
38
37
  ### Testing
39
38
 
39
+ * Submitted PR's will be tested in a series of spec and acceptance level tests - the results of these tests will be evaluated by a Beaker team member, as test results are currently not accessible by the public. Testing failures that require code changes will be communicated in the PR discussion.
40
40
  * Make sure you have added [RSpec](http://rspec.info/) tests that exercise your new code. These test should be located in the appropriate `beaker/spec/` subdirectory. The addition of new methods/classes or the addition of code paths to existing methods/classes requires additional RSpec coverage.
41
- * Beaker uses RSpec 3.1.0+, and you should **NOT USE** deprecated `should`/`stub` methods - **USE** `expect`/`allow`. Use of deprecated RSpec methods will result in your patch being rejected. See a nice blog post from 2013 on [RSpec's new message expectation syntax](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/).
41
+ * Beaker uses RSpec 3.1.0+, and you should **NOT USE** deprecated `should`/`stub` methods - **USE** `expect`/`allow`. See a nice blog post from 2013 on [RSpec's new message expectation syntax](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/).
42
42
  * Run the tests to assure nothing else was accidentally broken, using `rake test`
43
- * **Bonus**: if possible ensure that `rake test` runs without failures for additional Ruby versions (1.9, 2.0, etc). Beaker supports Ruby 1.9+, and breakage of support for older/newer rubies will cause a patch to be rejected.
43
+ * **Bonus**: if possible ensure that `rake test` runs without failures for additional Rubies (versions 1.9.3 and above).
44
44
 
45
45
  ### Documentation
46
46
 
47
- * Make sure that you have added documentation using [Yard](http://yardoc.org/), new methods/classes without appropriate documentation will be rejected.
47
+ * Make sure that you have added documentation using [Yard](http://yardoc.org/) as necessary for any new code introduced.
48
48
  * More user friendly documentation will be required for PRs unless exempted. Documentation lives in the [docs/ folder](docs).
49
49
 
50
50
  ## Making Trivial Changes
data/HISTORY.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # default - History
2
2
  ## Tags
3
- * [LATEST - 15 Jul, 2016 (7c89a4d0)](#LATEST)
3
+ * [LATEST - 27 Jul, 2016 (f4d394e2)](#LATEST)
4
+ * [2.47.1 - 15 Jul, 2016 (da89c35b)](#2.47.1)
4
5
  * [2.47.0 - 13 Jul, 2016 (bf4cbcf0)](#2.47.0)
5
6
  * [2.46.0 - 8 Jul, 2016 (3a650c95)](#2.46.0)
6
7
  * [2.45.0 - 29 Jun, 2016 (c0b56972)](#2.45.0)
@@ -124,7 +125,292 @@
124
125
  * [pe1.2 - 6 Sep, 2011 (ba3dadd2)](#pe1.2)
125
126
 
126
127
  ## Details
127
- ### <a name = "LATEST">LATEST - 15 Jul, 2016 (7c89a4d0)
128
+ ### <a name = "LATEST">LATEST - 27 Jul, 2016 (f4d394e2)
129
+
130
+ * (GEM) update beaker version to 2.48.0 (f4d394e2)
131
+
132
+ * Merge pull request #1198 from kevpl/docs_in_parallel_link (dbc5be2d)
133
+
134
+
135
+ ```
136
+ Merge pull request #1198 from kevpl/docs_in_parallel_link
137
+
138
+ (MAINT) fixed broken link to run_in_parallel.md
139
+ ```
140
+ * (MAINT) fixed broken link to run_in_parallel.md (ad883530)
141
+
142
+
143
+ ```
144
+ (MAINT) fixed broken link to run_in_parallel.md
145
+
146
+ [skip ci]
147
+ ```
148
+ * Merge pull request #1195 from kevpl/docs_parallel_mv (cdb3aa5b)
149
+
150
+
151
+ ```
152
+ Merge pull request #1195 from kevpl/docs_parallel_mv
153
+
154
+ (MAINT) moved run_in_parallel doc for re-org - BKR-846
155
+ ```
156
+ * Merge pull request #1196 from johnduarte/maint-skip-file-install-test (5452e132)
157
+
158
+
159
+ ```
160
+ Merge pull request #1196 from johnduarte/maint-skip-file-install-test
161
+
162
+ (MAINT) confined file install acceptance to win/osx
163
+ ```
164
+ * (MAINT) confined file install acceptance to win/osx (dfd22f1f)
165
+
166
+
167
+ ```
168
+ (MAINT) confined file install acceptance to win/osx
169
+
170
+ This commit confines the `acceptance/tests/install/from_file.rb`
171
+ test to Windows and OSX which are currently the only platforms supported
172
+ by the test.
173
+ ```
174
+ * (MAINT) moved run_in_parallel doc for re-org - BKR-846 (3c83094a)
175
+
176
+
177
+ ```
178
+ (MAINT) moved run_in_parallel doc for re-org - BKR-846
179
+
180
+ [skip ci]
181
+ ```
182
+ * Merge pull request #1192 from johnduarte/generic-pkg-installers (8e923264)
183
+
184
+
185
+ ```
186
+ Merge pull request #1192 from johnduarte/generic-pkg-installers
187
+
188
+ (MAINT) add generic dmg and msi installers
189
+ ```
190
+ * Merge pull request #1189 from tvpartytonight/maint_add_ci_test_description (746e87eb)
191
+
192
+
193
+ ```
194
+ Merge pull request #1189 from tvpartytonight/maint_add_ci_test_description
195
+
196
+ (MAINT) Improve CONTRIBUTING.md testing section
197
+ ```
198
+ * Merge pull request #1171 from kevpl/docs_big_reorg (b4937b06)
199
+
200
+
201
+ ```
202
+ Merge pull request #1171 from kevpl/docs_big_reorg
203
+
204
+ (BKR-846) re-organized docs
205
+ ```
206
+ * Merge pull request #1186 from kevpl/bkr745_rhel6_install (755ecbe4)
207
+
208
+
209
+ ```
210
+ Merge pull request #1186 from kevpl/bkr745_rhel6_install
211
+
212
+ (BKR-745) added el support for s390x dev installs
213
+ ```
214
+ * Merge pull request #1190 from samwoods1/print_line (72df3b1a)
215
+
216
+
217
+ ```
218
+ Merge pull request #1190 from samwoods1/print_line
219
+
220
+ (BKR-556) Print line number from test file in stack in summary on fail
221
+ ```
222
+ * Merge pull request #1188 from er0ck/docs/master/maint-remove_TODO_from_lets_write_a_test_doc (dc906de4)
223
+
224
+
225
+ ```
226
+ Merge pull request #1188 from er0ck/docs/master/maint-remove_TODO_from_lets_write_a_test_doc
227
+
228
+ (maint) remove TODO from lets_write_a_test doc
229
+ ```
230
+ * Merge pull request #1194 from dylanratcliffe/BKR-891 (75587154)
231
+
232
+
233
+ ```
234
+ Merge pull request #1194 from dylanratcliffe/BKR-891
235
+
236
+ (BKR-891) Remove uppercasing
237
+ ```
238
+ * Merge pull request #1185 from kevpl/docs_preserved_hosts (afc21313)
239
+
240
+
241
+ ```
242
+ Merge pull request #1185 from kevpl/docs_preserved_hosts
243
+
244
+ (MAINT) added preserved hosts doc
245
+ ```
246
+ * Merge pull request #1193 from puppetlabs/qeng3198/simple-archiving-mechanism (ea263617)
247
+
248
+
249
+ ```
250
+ Merge pull request #1193 from puppetlabs/qeng3198/simple-archiving-mechanism
251
+
252
+ (QENG-3198) Mechanism for archiving SUT files
253
+ ```
254
+ * (BKR-891) Removed uppercasing assumptions (b5aff42c)
255
+
256
+ * (BKR-891) Removed more uppercasing (c62c915b)
257
+
258
+ * (BRK-891) Fixed Tests (986934ac)
259
+
260
+ * (BKR-891) Remove uppercasing (64c6e1fe)
261
+
262
+ * Merge pull request #1148 from johnduarte/bkr-847-forgeapi-puppet-com (5f145359)
263
+
264
+
265
+ ```
266
+ Merge pull request #1148 from johnduarte/bkr-847-forgeapi-puppet-com
267
+
268
+ (BKR-847) Support puppet.com in forge stubs
269
+ ```
270
+ * (QENG-3198) Mechanism for archiving SUT files (f51f66a4)
271
+
272
+
273
+ ```
274
+ (QENG-3198) Mechanism for archiving SUT files
275
+
276
+ This commit adds a new host helpers method called `archive_file_from`
277
+ that is intended to be used in post-suites for grabbing arbitrary files
278
+ from the SUTs and puts them in a known location where the Jenkins
279
+ Archive Artifact plugin can find them and present them with the build
280
+ results.
281
+
282
+ The implementation is basically thin wrapper around `scp_from` that sets
283
+ up a particular directory structure with a hardcoded root directory.
284
+ This hardcoded root directory will need to be added to the Jenkins
285
+ acceptance job configurations so they can be published along with the
286
+ rest of the build results.
287
+ ```
288
+ * (MAINT) Improve CONTRIBUTING.md testing section (7828489c)
289
+
290
+ * (BKR-556) Print line number from test file in stack in summary on fail (f45c57ec)
291
+
292
+ * (maint) remove TODO from lets write a test doc (d2b739f5)
293
+
294
+
295
+ ```
296
+ (maint) remove TODO from lets write a test doc
297
+
298
+ [skip ci]
299
+ ```
300
+ * (BKR-745) added el support for s390x dev installs (6fa03aa0)
301
+
302
+ * Merge pull request #1182 from tvpartytonight/QENG-4068 (7df594b2)
303
+
304
+
305
+ ```
306
+ Merge pull request #1182 from tvpartytonight/QENG-4068
307
+
308
+ (QENG-4068) Remove unnecessary gem documentation dependencies
309
+ ```
310
+ * Merge pull request #1179 from randomvariable/BKR-882 (afa4d84c)
311
+
312
+
313
+ ```
314
+ Merge pull request #1179 from randomvariable/BKR-882
315
+
316
+ (BKR-882) Explicitly refer to AWS SDK v1 gem
317
+ ```
318
+ * (MAINT) add generic dmg and msi installers (d89dceb0)
319
+
320
+
321
+ ```
322
+ (MAINT) add generic dmg and msi installers
323
+
324
+ This commit adds a generic dmg installer to the OS X package facility.
325
+ This allows either a either a local file location or a URL to be specified
326
+ to install a dmg on an OS X host. It is based on the existing `install_dmg`
327
+ method, but requires the Volume location and package name to be specified by
328
+ the caller. These values cannot be introspected without making assumptions
329
+ about the packaging.
330
+
331
+ It also adds a generic msi installer as a helper. It is based on the
332
+ `install_msi_on` helper. The additional helper requirements make it a larger
333
+ effort to port to the Windows package facility which is not pursued in this
334
+ commit. The interface of the `generic_install_msi_on` method is the same as
335
+ the `install_msi_on`, it simply removes the validations that are puppet
336
+ specific.
337
+ ```
338
+ * (MAINT) added preserved hosts doc (e279c34a)
339
+
340
+
341
+ ```
342
+ (MAINT) added preserved hosts doc
343
+
344
+ [skip ci]
345
+ ```
346
+ * (BKR-883) Add docs for Beaker rake tasks (#1180) (8eed7d02)
347
+
348
+
349
+ ```
350
+ (BKR-883) Add docs for Beaker rake tasks (#1180)
351
+
352
+ * (BKR-883) Add docs for Beaker rake tasks
353
+
354
+ * (BKR-883) - moving doc to the right location
355
+
356
+ * Added unit test.
357
+
358
+ * Revert "Added unit test."
359
+
360
+ This reverts commit dc5fba2ee1015a7d0b808ef786676d90bbae52e6.
361
+ ```
362
+ * (QENG-4068) Remove yardoc testing in 1.9.3 (1e1a29ae)
363
+
364
+
365
+ ```
366
+ (QENG-4068) Remove yardoc testing in 1.9.3
367
+
368
+ This commit removes yardoc testing with ruby 1.9.3, allowing us
369
+ to remove gems necessary for yardoc in 1.9.3 only.
370
+ ```
371
+ * (QENG-4068) Remove unnecessary gem documentation dependencies (6e70277d)
372
+
373
+
374
+ ```
375
+ (QENG-4068) Remove unnecessary gem documentation dependencies
376
+
377
+ These gems are not necessary for beaker itself, and they do not need to
378
+ be specified in the the gemspec.
379
+ ```
380
+ * (BKR-882) Explicitly refer to AWS SDK v1 gem (e801cac8)
381
+
382
+
383
+ ```
384
+ (BKR-882) Explicitly refer to AWS SDK v1 gem
385
+
386
+ The AWS SDK gem has had a backwards compatible major release.
387
+ However, in projects that want to use both v1 and v2 of the SDK gem, the .gemspec must refer to 'aws-sdk-v1' to satisfy Bundler dependency management.
388
+ ```
389
+ * (BKR-846) re-organized docs (f3e01b0c)
390
+
391
+
392
+ ```
393
+ (BKR-846) re-organized docs
394
+
395
+ [skip ci]
396
+ ```
397
+ * (BKR-847) Support puppet.com in forge stubs (41a95e89)
398
+
399
+
400
+ ```
401
+ (BKR-847) Support puppet.com in forge stubs
402
+
403
+ This commit adds an `alias_spec` parameter to the `stub_hosts_on`
404
+ and the `with_host_stubbed_on` to facilitate adding multiple host aliases when
405
+ stubbing hosts.
406
+
407
+ This commit also updates the `stub_forge_on` and `with_forge_stubbed_on`
408
+ methods to add the `puppet.com` and `puppetlabs.com` variants of `forge`
409
+ and `forgeapi` in order to support both domain names.
410
+ ```
411
+ ### <a name = "2.47.1">2.47.1 - 15 Jul, 2016 (da89c35b)
412
+
413
+ * (HISTORY) update beaker history for gem release 2.47.1 (da89c35b)
128
414
 
129
415
  * (GEM) update beaker version to 2.47.1 (7c89a4d0)
130
416
 
data/README.md CHANGED
@@ -1,27 +1,44 @@
1
1
  # Beaker
2
2
 
3
- Beaker is an acceptance testing harness for Puppet PE and other Puppet Projects. It can also be used as a virtual machine provisioner - setting up machines, running any configuration on those machines and then exiting.
3
+ Beaker is a test harness focused on acceptance testing via interactions
4
+ between multiple (virtual) machines. It provides platform abstraction between
5
+ different Systems Under Test (SUTs), and it can also be used as a virtual machine
6
+ provisioner - setting up machines, running any commands on those machines,
7
+ and then exiting.
4
8
 
5
- Beaker runs tests written in Ruby with an additional DSL API. This gives you access to all standard Ruby along with acceptance testing specific commands.
9
+ Beaker runs tests written in Ruby, and provides additional Domain-Specific
10
+ Language (DSL) methods. This gives you access to all standard Ruby along with
11
+ acceptance testing specific commands.
6
12
 
7
13
  # Installation
8
14
 
9
- See [Beaker Installation](docs/Beaker-Installation.md).
15
+ See [Beaker Installation](docs/tutorials/installation.md).
10
16
 
11
17
  # Documentation
12
18
 
13
- Documentation for Beaker can be found in this repository in [the docs/ folder](docs/README.md).
19
+ Documentation for Beaker can be found in this repository in
20
+ [the docs/ folder](docs/README.md).
14
21
 
15
- The [Getting Started](docs/How-To-Beaker.md) is a great place to start for new Beaker users.
22
+ ## Table of Contents
16
23
 
17
- #Beaker Libraries
18
-
19
- Beaker functionality has been extended through the use of libraries available as gems. See the
20
- [complete list](docs/Beaker-Libraries.md) for available gems. See the [beaker-template documentation](https://github.com/puppetlabs/beaker-template/blob/master/README.md) for documentation on creating beaker-libraries.
24
+ - [Tutorials](docs/tutorials) take you by the hand through the steps to setup a
25
+ beaker run. Start here if you’re new to Beaker or test development.
26
+ - [Concepts](docs/concepts) discuss key topics and concepts at a fairly high
27
+ level and provide useful background information and explanation.
28
+ - [Rubydocs](http://rubydoc.info/github/puppetlabs/beaker/frames) contains the
29
+ technical reference for APIs and other aspects of Beaker. They describe how it
30
+ works and how to use it but assume that you have a basic understanding of key concepts.
31
+ - [How-to guides](docs/how_to) are recipes. They guide you through the steps
32
+ involved in addressing key problems and use-cases. They are more advanced than
33
+ tutorials and assume some knowledge of how Beaker works.
21
34
 
22
- # Beaker API
35
+ #Beaker Libraries
23
36
 
24
- [RubyDoc Beaker Documentation Server](http://rubydoc.info/github/puppetlabs/beaker/frames)
37
+ Beaker functionality has been extended through the use of libraries available as
38
+ gems. See the [complete list](docs/concepts/beaker_libraries.md) for available
39
+ gems. See the
40
+ [beaker-template documentation](https://github.com/puppetlabs/beaker-template/blob/master/README.md)
41
+ for documentation on creating beaker-libraries.
25
42
 
26
43
  # License
27
44
 
@@ -29,11 +46,15 @@ See [LICENSE](LICENSE) file.
29
46
 
30
47
  # Support & Issues
31
48
 
32
- Please log tickets and issues at our [Beaker Issue Tracker](https://tickets.puppetlabs.com/issues/?jql=project%20%3D%20BKR). In addition there is an active #puppet-dev channel on Freenode.
49
+ Please log tickets and issues at our
50
+ [Beaker Issue Tracker](https://tickets.puppetlabs.com/issues/?jql=project%20%3D%20BKR).
51
+ In addition there is an active #puppet-dev channel on Freenode.
33
52
 
34
- For additional information on filing tickets, please check out our [CONTRIBUTOR doc](CONTRIBUTING.md),
35
- and for ticket lifecycle information, checkout our [ticket process doc](docs/meta/ticket_process.md).
53
+ For additional information on filing tickets, please check out our
54
+ [CONTRIBUTOR doc](CONTRIBUTING.md), and for ticket lifecycle information,
55
+ checkout our [ticket process doc](docs/concepts/ticket_process.md).
36
56
 
37
57
  # Maintainers
38
58
 
39
- For information on project maintainers, please check out our [MAINTAINERS doc](MAINTAINERS.md).
59
+ For information on project maintainers, please check out our
60
+ [MAINTAINERS doc](MAINTAINERS.md).
data/Rakefile CHANGED
@@ -1,7 +1,7 @@
1
1
  require 'open3'
2
2
  require 'securerandom'
3
3
  require 'beaker-hostgenerator'
4
-
4
+ require 'beaker'
5
5
  HOSTS_PRESERVED = 'log/latest/hosts_preserved.yml'
6
6
 
7
7
  task :default => [ 'test:spec' ]
@@ -27,7 +27,7 @@ task :history do
27
27
  end
28
28
 
29
29
  task :travis do
30
- Rake::Task['yard'].invoke
30
+ Rake::Task['yard'].invoke if !Beaker::Shared::Semvar.version_is_less(RUBY_VERSION, '2.0.0')
31
31
  Rake::Task['spec'].invoke
32
32
  end
33
33
 
@@ -256,8 +256,8 @@ end
256
256
  #
257
257
  ###########################################################
258
258
  DOCS_DIR = 'yard_docs'
259
- DOCS_DAEMON = "yard server --reload --daemon --server thin --docroot #{DOCS_DIR}"
260
- FOREGROUND_SERVER = "bundle exec yard server --reload --verbose --server thin lib/beaker --docroot #{DOCS_DIR}"
259
+ DOCS_DAEMON = "yard server --reload --daemon --docroot #{DOCS_DIR}"
260
+ FOREGROUND_SERVER = "bundle exec yard server --reload --verbose lib/beaker --docroot #{DOCS_DIR}"
261
261
 
262
262
  def running?( cmdline )
263
263
  ps = `ps -ef`