Revision f5f2dc53 docs/setup.rst

b/docs/setup.rst
29 29

  
30 30
* progress 
31 31
    * Attach progress bars to various kamaki commands (e.g. kamaki store upload)
32
    * Since version 0.6.1 kamaki "requires" progress version 1.0.2 or better
32
    * If desired, progress version should be 1.0.2 or better
33 33

  
34 34
Any of the above features can be installed at any time before or after kamaki installation.
35 35

  
......
157 157
Hidden features
158 158
^^^^^^^^^^^^^^^
159 159

  
160
Since version 0.6.1 kamaki contains a test suite for the kamaki.clients API. The test suite can be activated with the following option on the configuration file::
160
The livetest suite
161
""""""""""""""""""
161 162

  
162
    [test]
163
    cli=test_cli
163
Kamaki contains a live test suite for the kamaki.clients API, where "live" means that the tests are performed against active services that up and running. The live test package is named "livetest", it is accessible as kamaki.clients.livetest and it is designed to check the actual relation between kamaki and synnefo services.
164 164

  
165
After that, users can run "kamaki test" commands to unit-test the prepackaged client APIs. Unit-tests are still experimental and there is a high probability of false alarms due to some of the expected values being hard-coded in the testing code.
165
The livetest suite can be activated with the following option on the configuration file::
166 166

  
167
Since version 0.6.3, a quotaholder client is introduced as an advanced feature. Quotaholder client is mostly used as a client library for accessing a synnefo quota service, but it can also be allowed as a kamaki command set, but setting the quotaholder.cli and quotaholder.url methods:
167
    [livetest]
168
    cli=livetest_cli
169

  
170
In most tests, livetest will run as long as an Astakos identity manager service is accessible and kamaki is set up to authenticate a valid token on this server.
171

  
172
In specific, a setup file needs at least the following mandatory settings in the configuration file:
173

  
174
* If authentication information is used for default kamaki clients::
175

  
176
    [astakos]
177
    url=<Astakos Identity Manager URL>
178
    token=<A valid user token>
179

  
180
* else if this authentication information is only for testing add this under [livetest]::
181

  
182
    astakos_url=<Astakos Identity Manager URL>
183
    astakos_token=<A valid user token>
184

  
185
Each service tested in livetest might need some more options under the [livetest] label, as shown bellow:
186

  
187
* kamaki livetest astakos::
188

  
189
    astakos_email = <The valid email of testing user>
190
    astakos_name = <The exact "real" name of testing user>
191
    astakos_username = <The username of the testing user>
192
    astakos_uuid = <The valid unique user id of the testing user>
193

  
194
* kamaki livetest pithos::
195

  
196
    astakos_uuid = <The valid unique user id of the testing user>
197

  
198
* kamaki livetest cyclades / image::
199

  
200
    image_id = <A valid image id used for testing>
201
    image_local_path = <The local path of the testing image>
202
    image_details = <A text file containing testing image details in a python dict>
203

  
204
    - example image.details content:
205
    {
206
        u'id': u'b3e68235-3abd-4d60-adfe-1379a4f8d3fe',
207
        u'metadata': {
208
            u'values': {
209
                u'description': u'Debian 6.0.6 (Squeeze) Base System',
210
                u'gui': u'No GUI',
211
                u'kernel': u'2.6.32',
212
                u'os': u'debian',
213
                u'osfamily': u'linux',
214
                u'root_partition': u'1',
215
                u'sortorder': u'1',
216
                u'users': u'root'
217
            }
218
        },
219
        u'name': u'Debian Base',
220
        u'progress': u'100',
221
        u'status': u'ACTIVE',
222
        u'created': u'2012-11-19T14:54:57+00:00',
223
        u'updated': u'2012-11-19T15:29:51+00:00'
224
    }
225

  
226
    flavor_details = <A text file containing the testing images' flavor details in a python dict>
227

  
228
    - example flavor.details content:
229
    {
230
        u'name': u'C1R1drbd',
231
        u'ram': 1024,
232
        u'id': 1,
233
        u'SNF:disk_template': u'drbd',
234
        u'disk': 20,
235
        u'cpu': 1
236
    }
237

  
238
After setup, kamaki can run all tests::
239

  
240
    $ kamaki livetest all
241

  
242
a specific test (e.g. astakos)::
243

  
244
    $ kamaki livetest astakos
245

  
246
or a specific method from a service (e.g. astakos authenticate)::
247

  
248
    $ kamaki livetest astakos authenticate
249

  
250
The quotaholder client
251
""""""""""""""""""""""
252

  
253
A quotaholder client is introduced as an advanced feature. Quotaholder client is mostly used as a client library for accessing a synnefo quota service, but it can also be allowed as a kamaki command set, but setting the quotaholder.cli and quotaholder.url methods::
168 254

  
169 255
    [quotaholder]
170 256
    cli=quotaholder_cli
171 257
    url=<URL of quotaholder service>
258

  
259
Quotaholder is not tested in livetest

Also available in: Unified diff