diff --git a/README.rst b/README.rst index e4651ad..3f16d29 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ refstack-client refstack-client is a command line utility that allows you to execute 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** @@ -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. 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 - 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 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 @@ -88,14 +88,14 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe. 6. Upload your results. 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: `./refstack-client upload ` 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 - `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. **Note:** @@ -108,10 +108,10 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe. 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: - `./refstack-client list --url ` + `./refstack-client list --url ` **Tempest Hacking** diff --git a/refstack-client b/refstack-client index bc70273..39bbd25 100755 --- a/refstack-client +++ b/refstack-client @@ -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 Tempest configuration file. @@ -28,4 +28,4 @@ from refstack_client import refstack_client if __name__ == '__main__': args = refstack_client.parse_cli_args() test = refstack_client.RefstackClient(args) - getattr(test, args.func)() \ No newline at end of file + getattr(test, args.func)() diff --git a/refstack_client/refstack_client.py b/refstack_client/refstack_client.py index c35dc2a..07df844 100755 --- a/refstack_client/refstack_client.py +++ b/refstack_client/refstack_client.py @@ -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 Tempest configuration file. @@ -97,7 +97,7 @@ class RefstackClient: 'run_tempest.sh') 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): self.logger.error("File not valid: %s" % self.args.file) exit(1) @@ -297,7 +297,7 @@ class RefstackClient: process.returncode) def upload(self): - '''Perform upload to Refstack URL.''' + '''Perform upload to RefStack URL.''' self._prep_upload() json_file = open(self.upload_file) json_data = json.load(json_file) @@ -330,7 +330,7 @@ class RefstackClient: raise StopIteration 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, start_date=self.args.start_date, end_date=self.args.end_date) @@ -381,7 +381,7 @@ def parse_cli_args(args=None): 'refstack-client -h') parser = argparse.ArgumentParser( - description='Refstack-client arguments', + description='RefStack-client arguments', formatter_class=argparse.ArgumentDefaultsHelpFormatter, usage=usage_string ) @@ -409,7 +409,7 @@ def parse_cli_args(args=None): default=os.environ.get( 'REFSTACK_URL', 'http://refstack.net/api'), type=str, - help='Refstack API URL to upload results to. ' + help='RefStack API URL to upload results to. ' 'Defaults to env[REFSTACK_URL] or ' 'http://refstack.net/api if it is not set ' '(--url http://localhost:8000).') @@ -419,7 +419,7 @@ def parse_cli_args(args=None): dest='insecure', required=False, help='Skip SSL checks while interacting ' - 'with Refstack API') + 'with RefStack API') network_args.add_argument('-i', '--sign', type=str, @@ -475,7 +475,7 @@ def parse_cli_args(args=None): action='store_true', required=False, 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.') # This positional argument will allow arbitrary arguments to be passed in @@ -494,7 +494,7 @@ def parse_cli_args(args=None): # List command parser_list = subparsers.add_parser( 'list', parents=[shared_args, network_args], - help='List last results from Refstack') + help='List last results from RefStack') parser_list.add_argument('--start-date', required=False, dest='start_date', diff --git a/setup_env b/setup_env index 2fe2017..86f3345 100755 --- a/setup_env +++ b/setup_env @@ -7,7 +7,7 @@ function usage { set +x SCRIPT_NAME="basename ${BASH_SOURCE[0]}" echo "Usage: ${SCRIPT_NAME} [OPTION]..." - echo "Setup Refstack client with test environment" + echo "Setup RefStack client with test environment" echo "" echo " -h, Print this usage message" echo " -c Tempest test runner commit. You can specify SHA or branch here"