openstack
/
syntribos
Code Issues Proposed changes

Updating configuration file 

Added one more example to the configuration file and also
the basic structure of how a config file should be.

Change-Id: Ia99d291eae1f467f3981b6521434eee179d01080
This commit is contained in:
Rahul Nair 2016-08-18 11:46:46 -05:00
parent 29ae6f464a
commit ed9a05c786
3 changed files with 138 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.rst
View File

@ -78,14 +78,9 @@ pip <https://pypi.python.org/pypi/pip>`__ from the git repository.
Configuration
-------------
Modify the configuration files to update your keystone URL, API endpoint
and user credentials.
::
$ vi syntribos/examples/configs/keystone.config
Example configuration file:
This is the basic structure of a Syntribos configuration file.
All config files should have a section ```[Syntribos]``` and a
```[user]``` section, ```[logging]``` is optional.
::
@ -93,45 +88,67 @@ Example configuration file:
#
# End point URLs and versions of the services to be tested.
#
# As keystone is being tested in the example, enter your
# keystone auth endpoint url.
endpoint=http://localhost:5000
# Set payload and templates path
templates=<location_of_templates_dir/file>
payload_dir=<location_of_payload_dir>
[user]
#
# User credentials and endpoint URI to get an AUTH_TOKEN
#
endpoint=
username=<yourusername>
password=<yourpassword>
[logging]
log_dir=<location_to_save_debug_logs>
Testing the Keystone API
::
.
You can modify the file to add your user credentials, log, template
directory etc.
::
$ vi examples/configs/keystone.config
::
[syntribos]
# As keystone is being tested in the example, enter your
# keystone auth endpoint url.
endpoint=http://localhost:5000
# Set payload and templates path
templates=<location_of_templates_dir/file>
payload_dir=<location_of_payload_dir>
# Optional, api version if required.
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#version=v2
[user]
#
# User credentials
#
endpoint=http://localhost:5000
username=<yourusername>
password=<yourpassword>
# Optional, if Keystone V3 API is not used
# Optional, only needed if Keystone V3 API is used
#user_id=<youruserid>
#[alt_user]
#
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#
endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
#user_id=<alt_userid>
[auth]
#
# Config for authorization endpoint, so that the service can
# obtain a valid token, enter your keystone auth endpoint.
#
endpoint=http://localhost:5000
[logging]
#
@ -143,6 +160,33 @@ Example configuration file:
http_request_compression=True
Another example, to test a keystone v3 API, use a configuration like
::
[syntribos]
endpoint=http://localhost:5000
templates=<location_of_template_dir/file>
payload_dir=<location_of_payloads data>
[user]
endpoint=http://localhost:5000
username=<username>
password=<password>
domain_name=default
domain_id=default
[logging]
log_dir=<location_to_store_log_files>
http_request_compression=True
To test any other project, just change the endpoint URI under
```[syntribos]``` to point to the API and also modify the user
credentials if needed. The endpoint URI in the ```[syntribos]```
section is the one being tested by Syntribos and the endpoint URI in
```[user]``` section is just used to get an AUTH_TOKEN.
Syntribos Commands
------------------

89
doc/source/configuration.rst
View File

@ -1,14 +1,9 @@
Configuration
=============
Modify the configuration files to update your Keystone URL, API endpoint
and user credentials.
::
$ vi examples/configs/keystone.config
Example configuration file:
This is the basic structure of a Syntribos configuration file.
All config files should have a section ```[Syntribos]``` and a
```[user]``` section, ```[logging]``` is optional.
::
@ -16,28 +11,54 @@ Example configuration file:
#
# End point URLs and versions of the services to be tested.
#
# As keystone is being tested in the example, enter your
# keystone auth endpoint url.
endpoint=http://localhost:5000
# Set payload and templates path
templates=<location_of_templates_dir/file>
payload_dir=<location_of_payload_dir>
[user]
#
# User credentials and endpoint URI to get an AUTH_TOKEN
#
endpoint=
username=<yourusername>
password=<yourpassword>
[logging]
log_dir=<location_to_save_debug_logs>
Testing the Keystone API
::
.
You can modify the file to add your user credentials, log, template
directory etc.
::
$ vi examples/configs/keystone.config
::
[syntribos]
# As keystone is being tested in the example, enter your
# keystone auth endpoint url.
endpoint=http://localhost:5000
# Set payload and templates path
templates=<location_of_templates_dir/file>
payload_dir=<location_of_payload_dir>
# Optional, api version if required.
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#version=v2
[user]
#
# User credentials
#
endpoint=http://localhost:5000
username=<yourusername>
password=<yourpassword>
# Optional, if Keystone V3 API is not used
# Optional, only needed if Keystone V3 API is used
#user_id=<youruserid>
#[alt_user]
@ -45,17 +66,12 @@ Example configuration file:
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#
endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
#user_id=<alt_userid>
[auth]
#
# Config for authorization endpoint, so that the service can
# obtain a valid token, enter your keystone auth endpoint.
#
endpoint=http://localhost:5000
[logging]
#
@ -65,3 +81,32 @@ Example configuration file:
# Optional, compresses http_request_content,
# if you don't want this, set this option to False.
http_request_compression=True
Another example, to test a keystone v3 API, use a configuration like
::
[syntribos]
endpoint=http://localhost:5000
templates=<location_of_template_dir/file>
payload_dir=<location_of_payloads data>
[user]
endpoint=http://localhost:5000
username=<username>
password=<password>
domain_name=default
domain_id=default
[logging]
log_dir=<location_to_store_log_files>
http_request_compression=True
To test any other project, just change the endpoint URI under
```[syntribos]``` to point to the API and also modify the user
credentials if needed. The endpoint URI in the ```[syntribos]```
section is the one being tested by Syntribos and the endpoint URI in
```[user]``` section is just used to get an AUTH_TOKEN.

20
examples/configs/keystone.config
View File

@ -6,43 +6,33 @@
# As keystone is being tested in the example, enter your
# keystone auth endpoint url.
endpoint=http://localhost:5000
# Set payload and templates path
templates=<location_of_templates_dir/file>
payload_dir=<location_of_payload_dir>
# Optional, api version if required.
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#version=v2
[user]
#
# User credentials
#
endpoint=http://localhost:5000
username=<yourusername>
password=<yourpassword>
# Optional, if keystone V3 API is not used
# Optional, only if keystone V3 API is used
#user_id=<youruserid>
#domain_name=<domain_name>
#domain_id=<domain_id>
#[alt_user]
#
# Used for cross auth tests (-t AUTH_WITH_SOMEONE_ELSE_TOKEN)
#
#endpoint=http://localhost:5000
#username=<alt_username>
#password=<alt_password>
#user_id=<alt_userid>
[auth]
#
# Config for authorization endpoint, so that the service can
# obtain a valid token, enter your keystone auth endpoint.
#
endpoint=http://localhost:5000
[logging]
#
# Logger option goes here