Statistics
| Branch: | Tag: | Revision:

root / snf-tools / docs / index.rst @ 16b22352

History | View | Annotate | Download (5.3 kB)

1
snf-burnin documentation
2
=========================
3

    
4
**snf-burnin** is an integration testing tool for a running Synnefo deployment. It runs test scenarios from the following categories:
5

    
6
* Authentication 
7
* Images
8
* Flavors
9
* Servers
10
* Networking
11

    
12
.. toctree::
13
   :maxdepth: 2
14

    
15
Usage
16
=====
17
**Example:**
18

    
19
::
20

    
21
   snf-burnin --api=API_URL --token=TOKEN --image-id=IMAGE-ID --log-folder=LOG_FOLDER --plankton=PLANKTON_API --plankton-user=PLANKTON_SYSTEM_USER
22

    
23
For more info 
24

    
25
::
26

    
27

    
28
   snf-burnin --help
29

    
30
::
31

    
32

    
33
  Options:
34
  
35
  -h, --help                        show this help message and exit
36
  --api=API             	    The API URI to use to reach the Synnefo API
37
  --plankton=PLANKTON   	    The API URI to use to reach the Plankton API
38
  --plankton-user=PLANKTON_USER	    Owner of system images
39
  --token=TOKEN                     The token to use for authentication to the API
40
  --nofailfast          	    Do not fail immediately if one of the tests fails (EXPERIMENTAL)
41
  --no-ipv6             	    Disables ipv6 related tests
42
  --action-timeout=TIMEOUT	    Wait SECONDS seconds for a server action to complete, then the test is considered failed
43
  --build-warning=TIMEOUT           Warn if TIMEOUT seconds have passed and a build operation is still pending
44
  --build-fail=BUILD_TIMEOUT  	    Fail the test if TIMEOUT seconds have passed and a build operation is still incomplete
45
  --query-interval=INTERVAL 	    Query server status when requests are pending every INTERVAL seconds
46
  --fanout=COUNT             	    Spawn up to COUNT child processes to execute in parallel, essentially have up to COUNT server build requests outstanding (EXPERIMENTAL)
47
  --force-flavor=FLAVOR ID	    Force all server creations to use the specified FLAVOR ID instead of a randomly chosen one, useful if disk space is scarce 
48
  --image-id=IMAGE ID               Test the specified image id, use 'all' to test all available images (mandatory argument)
49
  --show-stale          	    Show stale servers from previous runs, whose name starts with `snf-test-'
50
  --delete-stale        	    Delete stale servers from previous runs, whose name starts with `snf-test-'
51
  --force-personality=PERSONALITY_PATH
52
                                    Force a personality file injection. File path required.
53
  --log-folder=LOG_FOLDER           Define the absolute path where the output log is stored.
54

    
55

    
56

    
57

    
58
Detailed description of testcases
59
=================================
60

    
61
ImagesTestCase
62
---------------
63
* Test image list actually returns images
64
* Test detailed image list actually returns images
65
* Test simple and detailed image lists have the same length
66
* Test simple and detailed images have the same names
67
* Test system images have the same name
68
* Test system images have unique names
69
* Test every image has specific metadata
70

    
71
FlavorsTestCase
72
----------------
73
* Test flavor list actually returns flavors
74
* Test simple and detailed flavor lists have the same length
75
* Test simple and detailed flavors have the same names
76
* Test flavors have unique names
77
* Test flavor names have correct format 
78

    
79
ServersTestCase
80
----------------
81
* Test simple and detailed server list have the same length
82
* Test simple and detailed servers have the same names
83

    
84
SpawnServerTestcase
85
--------------------
86
* Submit create server
87
* Test server is in BUILD state in server list
88
* Test server is in BUILD state in details
89
* Change server metadata
90
* Verify the changed metadata are correct
91
* Verify server metadata are set based on image metadata
92
* Wait until server change state to ACTIVE, and verify state
93
* Test if OOB server console works
94
* Test server has IPv4
95
* Test server has IPv6
96
* Test server responds to ping on IPv4 address
97
* Test server responds to ping on IPv6 address
98
* Submit shutdown request
99
* Verify server status is STOPPED
100
* Submit start request 
101
* Test server status is ACTIVE
102
* Test server responds to ping on IPv4 address (verify if is actually up and running)
103
* Test server responds to ping on IPv6 address (verify if is actually up and running)
104
* Test SSH to server and verify hostname (IPv4)
105
* Test SSH to server and verify hostname (IPv6)
106
* Test RDP connection to server (only available to Windows Images) (IPv4)
107
* Test RDP connection to server (only available to Windows Images) (IPv6)
108
* Test file injection for personality enforcement
109
* Submit server delete request
110
* Test server becomes DELETED
111
* Test server is no longer in server list
112

    
113
NetworkTestCase
114
===============
115
* Submit create server A request
116
* Test server A becomes ACTIVE
117
* Submit create server B request
118
* Test server B becomes ACTIVE
119
* Submit create private network request
120
* Connect VMs to private network
121
* Test if VMs are connected to network
122
* Submit reboot request to server A
123
* Test server A responds to ping on IPv4 address (verify if is actually up and running)
124
* Submit reboot request to server B
125
* Test server B responds to ping on IPv4 address (verify if is actually up and running)
126
* Connect via SSH and setup the new network interface in server A
127
* Connect via SSH and setup the new network interface in server B
128
* Connect via SSH to server A and test if server B responds to ping on IPv4 address
129
* Disconnect servers from network and verify the network details
130
* Send delete network request and verify that the network is deleted from the list
131
* Send request to delete servers and wait until they are actually deleted
132

    
133

    
134

    
135

    
136
Indices and tables
137
==================
138

    
139
* :ref:`genindex`
140
* :ref:`search`
141