openinfra
/
refstack-client
Code Issues Proposed changes

Rename "Refstack" to "RefStack" 

The RefStack team has decided to use "RefStack" as the name of our
project.

Change-Id: Ibd3fa01f0904549f22eaf4883116631a4e5b3d01
This commit is contained in:
cdiep 2015-08-31 16:14:12 -07:00
parent 9f60b94a97
commit 4d141d885e
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.rst
View File

@ -3,7 +3,7 @@ refstack-client
refstack-client is a command line utility that allows you to execute Tempest refstack-client is a command line utility that allows you to execute Tempest
test runs based on configurations you specify. When finished running Tempest test runs based on configurations you specify. When finished running Tempest
it can send the passed test data to a Refstack API server. it can send the passed test data to a RefStack API server.
**Environment setup** **Environment setup**
@ -68,7 +68,7 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
a. Adding the `-v` option will show the summary output. a. Adding the `-v` option will show the summary output.
b. Adding the `-vv` option will show the Tempest test result output. b. Adding the `-vv` option will show the Tempest test result output.
c. Adding the `--upload` option will have your test results be uploaded to the c. Adding the `--upload` option will have your test results be uploaded to the
default Refstack API server or the server specified by `--url`. default RefStack API server or the server specified by `--url`.
d. Adding the `--test-list` option will allow you to specify the file path or URL of d. Adding the `--test-list` option will allow you to specify the file path or URL of
a test list text file. This test list should contain specific test cases that a test list text file. This test list should contain specific test cases that
should be tested. Tests lists passed in using this argument will be normalized should be tested. Tests lists passed in using this argument will be normalized
@ -88,14 +88,14 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
6. Upload your results. 6. Upload your results.
If you previously ran a test with refstack-client without the `--upload` If you previously ran a test with refstack-client without the `--upload`
option, you can upload your results to a Refstack API server by using the option, you can upload your results to a RefStack API server by using the
following command: following command:
`./refstack-client upload <Path of results file>` `./refstack-client upload <Path of results file>`
The results file is a JSON file generated by refstack-client when a test has The results file is a JSON file generated by refstack-client when a test has
completed. This is saved in .tempest/.testrepository. When you use the completed. This is saved in .tempest/.testrepository. When you use the
`upload` command, you can also override the Refstack API server uploaded to `upload` command, you can also override the RefStack API server uploaded to
with the `--url` option. with the `--url` option.
**Note:** **Note:**
@ -108,10 +108,10 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
7. List uploaded test set. 7. List uploaded test set.
You can list previously uploaded data from a Refstack API server by using You can list previously uploaded data from a RefStack API server by using
the following command: the following command:
`./refstack-client list --url <URL of the Refstack API server>` `./refstack-client list --url <URL of the RefStack API server>`
**Tempest Hacking** **Tempest Hacking**

4
refstack-client
View File

@ -17,7 +17,7 @@
""" """
Run Tempest and upload results to Refstack. Run Tempest and upload results to RefStack.
This module runs the Tempest test suite on an OpenStack environment given a This module runs the Tempest test suite on an OpenStack environment given a
Tempest configuration file. Tempest configuration file.
@ -28,4 +28,4 @@ from refstack_client import refstack_client
if __name__ == '__main__': if __name__ == '__main__':
args = refstack_client.parse_cli_args() args = refstack_client.parse_cli_args()
test = refstack_client.RefstackClient(args) test = refstack_client.RefstackClient(args)
getattr(test, args.func)() getattr(test, args.func)()

18
refstack_client/refstack_client.py
View File

@ -17,7 +17,7 @@
""" """
Run Tempest and upload results to Refstack. Run Tempest and upload results to RefStack.
This module runs the Tempest test suite on an OpenStack environment given a This module runs the Tempest test suite on an OpenStack environment given a
Tempest configuration file. Tempest configuration file.
@ -97,7 +97,7 @@ class RefstackClient:
'run_tempest.sh') 'run_tempest.sh')
def _prep_upload(self): def _prep_upload(self):
'''Prepare an upload to the Refstack_api''' '''Prepare an upload to the RefStack_api'''
if not os.path.isfile(self.args.file): if not os.path.isfile(self.args.file):
self.logger.error("File not valid: %s" % self.args.file) self.logger.error("File not valid: %s" % self.args.file)
exit(1) exit(1)
@ -297,7 +297,7 @@ class RefstackClient:
process.returncode) process.returncode)
def upload(self): def upload(self):
'''Perform upload to Refstack URL.''' '''Perform upload to RefStack URL.'''
self._prep_upload() self._prep_upload()
json_file = open(self.upload_file) json_file = open(self.upload_file)
json_data = json.load(json_file) json_data = json.load(json_file)
@ -330,7 +330,7 @@ class RefstackClient:
raise StopIteration raise StopIteration
def list(self): def list(self):
"""Retrieve list with last test results from Refstack.""" """Retrieve list with last test results from RefStack."""
results = self.yield_results(self.args.url, results = self.yield_results(self.args.url,
start_date=self.args.start_date, start_date=self.args.start_date,
end_date=self.args.end_date) end_date=self.args.end_date)
@ -381,7 +381,7 @@ def parse_cli_args(args=None):
'refstack-client <ARG> -h') 'refstack-client <ARG> -h')
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
description='Refstack-client arguments', description='RefStack-client arguments',
formatter_class=argparse.ArgumentDefaultsHelpFormatter, formatter_class=argparse.ArgumentDefaultsHelpFormatter,
usage=usage_string usage=usage_string
) )
@ -409,7 +409,7 @@ def parse_cli_args(args=None):
default=os.environ.get( default=os.environ.get(
'REFSTACK_URL', 'http://refstack.net/api'), 'REFSTACK_URL', 'http://refstack.net/api'),
type=str, type=str,
help='Refstack API URL to upload results to. ' help='RefStack API URL to upload results to. '
'Defaults to env[REFSTACK_URL] or ' 'Defaults to env[REFSTACK_URL] or '
'http://refstack.net/api if it is not set ' 'http://refstack.net/api if it is not set '
'(--url http://localhost:8000).') '(--url http://localhost:8000).')
@ -419,7 +419,7 @@ def parse_cli_args(args=None):
dest='insecure', dest='insecure',
required=False, required=False,
help='Skip SSL checks while interacting ' help='Skip SSL checks while interacting '
'with Refstack API') 'with RefStack API')
network_args.add_argument('-i', '--sign', network_args.add_argument('-i', '--sign',
type=str, type=str,
@ -475,7 +475,7 @@ def parse_cli_args(args=None):
action='store_true', action='store_true',
required=False, required=False,
help='After running Tempest, upload the test ' help='After running Tempest, upload the test '
'results to the default Refstack API server ' 'results to the default RefStack API server '
'or the server specified by --url.') 'or the server specified by --url.')
# This positional argument will allow arbitrary arguments to be passed in # This positional argument will allow arbitrary arguments to be passed in
@ -494,7 +494,7 @@ def parse_cli_args(args=None):
# List command # List command
parser_list = subparsers.add_parser( parser_list = subparsers.add_parser(
'list', parents=[shared_args, network_args], 'list', parents=[shared_args, network_args],
help='List last results from Refstack') help='List last results from RefStack')
parser_list.add_argument('--start-date', parser_list.add_argument('--start-date',
required=False, required=False,
dest='start_date', dest='start_date',

2
setup_env
View File

@ -7,7 +7,7 @@ function usage {
set +x set +x
SCRIPT_NAME="basename ${BASH_SOURCE[0]}" SCRIPT_NAME="basename ${BASH_SOURCE[0]}"
echo "Usage: ${SCRIPT_NAME} [OPTION]..." echo "Usage: ${SCRIPT_NAME} [OPTION]..."
echo "Setup Refstack client with test environment" echo "Setup RefStack client with test environment"
echo "" echo ""
echo " -h, Print this usage message" echo " -h, Print this usage message"
echo " -c Tempest test runner commit. You can specify SHA or branch here" echo " -c Tempest test runner commit. You can specify SHA or branch here"