I can't find anything in the User Guide that explains what resources are made available to me by default in the test environment. Nor is there anything in the Developer Guide to explain how the test environment is set up, or how to make new resources available. How do I? 1. Check if I can communicate with the lab controller? 2. Upload a log file? 3. Report pass or fail of a test step? (Surprisingly, http://beaker-project.org/guide/User_Guide-Getting_Started-Process-Tests-Reporting_Results.html *doesn't* provide this critical piece of information. It appears to assume the reader already knows this, since it jumps straight in to hugely complicated scenarios)
I *think* the key missing pieces that need to be documented are: * The BEAKER environment variable will be set to refer to the appropriate host for reporting results (etc). * The relevant commands in http://git.beaker-project.org/cgit/rhts/tree/bin will be available (or can be made available by configuring your task appropriately)
(In reply to comment #0) > I can't find anything in the User Guide that explains what resources are > made available to me by default in the test environment. Aren't these set by the harness? > Nor is there > anything in the Developer Guide to explain how the test environment is set > up, or how to make new resources available. > > How do I? > > 1. Check if I can communicate with the lab controller? > > 2. Upload a log file? > > 3. Report pass or fail of a test step? (Surprisingly, > http://beaker-project.org/guide/User_Guide-Getting_Started-Process-Tests- > Reporting_Results.html *doesn't* provide this critical piece of information. > It appears to assume the reader already knows this, since it jumps straight > in to hugely complicated scenarios) Rightyly or wrongly, that document it seems was never intended as a n00bs guide to how to report a pass or fail, rather as a thought provoker for experienced writers of beaker tests.
(In reply to comment #1) > I *think* the key missing pieces that need to be documented are: > > * The BEAKER environment variable will be set to refer to the appropriate > host for reporting results (etc). > > * The relevant commands in http://git.beaker-project.org/cgit/rhts/tree/bin > will be available (or can be made available by configuring your task > appropriately) I *think* these commands are not meant to be used directly, but via the Makefile that beaker-wizard generates. At least some of them uses environment variables which are set by this Makefile.
OK, the missing docs appear to be on the beakerlib wiki: https://fedorahosted.org/beakerlib/wiki/Manual Our docs should reference those from a "Writing your first test" getting started section.
(In reply to comment #4) > OK, the missing docs appear to be on the beakerlib wiki: > https://fedorahosted.org/beakerlib/wiki/Manual > > Our docs should reference those from a "Writing your first test" getting > started section. beakerlib is just a convenience library, it's also perfectly possible to write tests using the rhts-test-env commands directly (for example our /distribution/inventory and /distribution/beaker/dogfood tasks). beakerlib is just a layer wrapped around those. So we should document the rhts-test-env stuff, and then point at beakerlib as a more convenient way of writing complicated test scripts.
On Gerrit: http://gerrit.beaker-project.org/1919
*** Bug 855164 has been marked as a duplicate of this bug. ***
This is now included in the development version of Beaker's documentation: http://beaker-project.org/docs-develop/user-guide/task-environment.html
Beaker 0.13.1 has been released.