Skip to content

Commit abdae4c

Browse files
Included development how-to on the readme (#102)
* Included development how-to on the readme
1 parent d89095e commit abdae4c

File tree

2 files changed

+45
-13
lines changed

2 files changed

+45
-13
lines changed

Readme.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,46 @@ redis-benchmarks-spec-sc-coordinator RUNNING pid 27842, uptime 0:00:00
323323
```
324324

325325

326+
## Development
327+
328+
1. Install [pypoetry](https://python-poetry.org/) to manage your dependencies and trigger tooling.
329+
```sh
330+
pip install poetry
331+
```
332+
333+
2. Installing dependencies from lock file
334+
335+
```
336+
poetry install
337+
```
338+
339+
### Running formaters
340+
341+
```sh
342+
poetry run black .
343+
```
344+
345+
346+
### Running linters
347+
348+
```sh
349+
poetry run flake8
350+
```
351+
352+
353+
### Running tests
354+
355+
A test suite is provided, and can be run with:
356+
357+
```sh
358+
$ tox
359+
```
360+
361+
To run a specific test:
362+
```sh
363+
$ tox -- utils/tests/test_runner.py
364+
```
365+
326366
## License
327367

328-
redis-benchmark-specifications is distributed under the Apache 2 license - see [LICENSE](LICENSE)
368+
redisbench-admin is distributed under the BSD3 license - see [LICENSE](LICENSE)

redis_benchmarks_specification/__runner__/runner.py

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -402,11 +402,7 @@ def process_self_contained_coordinator_stream(
402402
benchmark_end_time, benchmark_start_time
403403
)
404404
)
405-
logging.info(
406-
"Printing client tool stdout output".format(
407-
client_container_stdout
408-
)
409-
)
405+
logging.info("Printing client tool stdout output")
410406
print()
411407
if args.flushall_on_every_test_end:
412408
logging.info("Sending FLUSHALL to the DB")
@@ -529,15 +525,13 @@ def process_self_contained_coordinator_stream(
529525
else:
530526
if "redis-benchmark" in benchmark_tool:
531527
os.remove(full_result_path)
532-
logging.info(
533-
"Removing temporary JSON file".format(full_result_path)
534-
)
528+
logging.info("Removing temporary JSON file")
535529
shutil.rmtree(temporary_dir_client, ignore_errors=True)
536530
logging.info(
537531
"Removing temporary client dir {}".format(temporary_dir_client)
538532
)
539533

540-
table_name = "Results for entire test-suite".format(test_name)
534+
table_name = "Results for entire test-suite"
541535
results_matrix_headers = [
542536
"Test Name",
543537
"Metric JSON Path",
@@ -557,9 +551,7 @@ def process_self_contained_coordinator_stream(
557551
"aggregate-results.csv",
558552
)
559553
logging.info(
560-
"Storing an aggregated results CSV into {}".format(
561-
full_result_path, dest_fpath
562-
)
554+
"Storing an aggregated results CSV into {}".format(full_result_path)
563555
)
564556

565557
csv_writer = CsvTableWriter(

0 commit comments

Comments
 (0)