~ci-train-bot/unity/unity-ubuntu-disco-3336

« back to all changes in this revision

Viewing changes to manual-tests/ReadMe.txt

  • Committer: Tim Penhey
  • Date: 2011-11-10 02:57:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1740.
  • Revision ID: tim.penhey@canonical.com-20111110025742-z2f12fy3sxdnrjug
Add the manual-test directory, and a readme file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
==============
 
2
Manual Testing
 
3
==============
 
4
 
 
5
Outline
 
6
-------
 
7
Sometimes it is not possible to easily make an automated test for some
 
8
use-cases.  However just because something isn't easily tested automatically
 
9
doesn't mean that there isn't value in creating a test for it, just that the
 
10
test needs to be executed by a person until it is converted into an automated
 
11
test.
 
12
 
 
13
 
 
14
Format
 
15
------
 
16
Manual tests take the format of text files in this directory (the manual-test
 
17
one).  These files are formatted using `reStructured Text`_.  A very
 
18
comprehensive `quick reference`_ is available.
 
19
 
 
20
.. _reStructured Text: http://en.wikipedia.org/wiki/ReStructuredText
 
21
.. _quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html
 
22
 
 
23
Tests have a header, steps to follow, and an expected outcome, as demonstrated
 
24
by the following example:
 
25
 
 
26
There can be multiple tests in a single file, but they should all be related,
 
27
and the filename should indicate the tests it contains.
 
28
 
 
29
 
 
30
Test Dash
 
31
---------
 
32
This test shows that the dash appears when the super key is pushed.
 
33
 
 
34
#. Start with a clear screen
 
35
#. Press the <super> key
 
36
 
 
37
Outcome
 
38
  The dash appears, and focus is in the search box.  The icons on the laucher
 
39
  are desaturated except for the ubuntu button at the top.  The icons in the
 
40
  panel go white.
 
41
 
 
42
 
 
43
Directory Structure
 
44
-------------------
 
45
It is expected that as we grow a number of manual tests, we will use
 
46
directories to organise them.
 
47