Shotplan

Usage Command Examples

Usage

shotplan -h

shotplan -h

Run tests

shotplan [ -R | -T ] [ -a ] [ -C <category> ] [ -y ] <test plan file>

shotplan -T

Run all tests without generating report files (no screenshots, no video capture), requesting user to press a key to continue between tests

shotplan -T --from=dnslookup

Run all tests from test case 'dnslookup', without generating report files (no screenshots, no video capture)

shotplan -T -a

Run all tests automatically without reports and without any user intervention, skipping those tests involving a video capture

User may still be prompted for the entry of planned input data (‘input’ property)

shotplan -T -a -C=automatic --force-defaults

Run all tests of category 'automatic' automatically without generating reports, skipping those tests involving a video capture

shotplan -T -a --force-defaults

Same as -T -a above, except user won’t be prompted for the entry of planned input data (input property), assuming the value assigned to the variable upstream by the user’s program.

shotplan -R

Run all tests and produce report files with screenshots and videos, requesting user to press a key to continue between tests

shotplan -R -a

Run all tests automatically and produce report files with screenshots, without any user intervention, skipping those tests involving a video capture,

User may still be prompted for the entry of planned input data (‘input’ property)

shotplan -R -a --force-defaults

Same as -R -a above, except user won’t be prompted for the entry of planned input data (input property), assuming the value assigned to the variable upstream by the user’s program.

List of test case IDs

shotplan -P <test plan file>

shotplan -P shotplan.yml

Lists all test case IDs defined in plan file

List of categories

shotplan --cat <test plan file>

shotplan --cat shotplan.yml

Lists all categories defined in plan file. If <ENTER> is pressed, lists all test case IDs too

Generate examples for man pages

shotplan -M <test plan file>

shotplan -M shotplan.yml

This generates usage examples set up from the test plan, suitable to be included in the *__man() function of bash applications generated with genapp. The first line repeats the test case title, then for each test step, the step description and the first comment line. For instance:

Display current revision

  # The revision is displayed. It should be 4. The short log is also displayed.
   $ av rev

Generate album images file list for bookmake generator

shotplan -F <test plan file>

shotplan -F shotplan.yml

This generates a list of image and video files as as it can be used by bookmake to generate a multimedia album. Sample:

arcv_sshot_displayrev_1.png:
  chapter: Display current revision
  title: Example of showing current revision
  comment: |
             The revision is displayed. It should be 4. The short log is also displayed.