abhinavsp0730/khronos

Khronos

Are your org hotfixes truly considered "hotfixes" if they take longer than 15 minutes to go live because of slow tests workflows running on GitHub Actions? To speed up this imagine benchmarking test durations to identify the slow tests when the total number of tests > 500, it seems impractical to run each test individually and manually record their duration times.

Khronos is a Python library that benchmarks the duration of Django tests. It helps identify slow-running tests in your test suite, allowing you to optimize their performance.


Feautres:

1) Benchmark Report: Create benchmark report in the terminal whenever you run your django tests and shows top 10(this no. can be configured) slowest tests.

2) Parallel Test Execution: Works with --parallel out of the box.

3) Google Sheets Integration: Whole tests benchmark can be automatically uploaded to Google Sheets.

4) CSV Export: Whole tests benchmark can be saved in a CSV.

How to configure:

1. pip install django-khronos or build it locally python -m build and install in your virtual env.
2. Add TEST_RUNNER = "khronos.custom_test_runner.KhronosTestRunner" in your settings.py
3. If you want to increase the number of slowest tests displayed on terminal then set KHRONOS_REPORT_MAX_ROW= in your settings.py.
4. If you want to add Google Sheets integration, add: KHRONOS_SPRAEDSHEET_REPORT_GSHEET_ID = "your-google-sheet-id" and your KHRONOS_GSHEET_CREDS_FILE_PATH = "your-gsheet-cred-path" in your settings.py` .
5. For saving the khronos benchmark report.

Tested on Django 3.2.14. Open an issue if it's not supported in your's django version

Contributors ✨

Thanks go to these wonderful people

Abhinav Prakash

Annay Paul

khronos's Issues

Write Sanity Test.

Write basic tests that blip works in Django 3 and 4. Also, write tests that will ensure it'll work with --parallel flag.

1. Basic Test:
   a) Create two folder Django-3 and Django-4 .
   b) create a requirements.txt and add django 3 and django 4 version and add latest django khronos version(I'll add replace to github repo branch, if you can do it than it's good)
   b) In those folders create a django project.
   c) In settings.py add khronos.
   d) create tests folder inside these two folder.
   Now create two test files compatibility_test_1.py and compatibility_test_2.py. And add test

class CompatibilityTest(TestCase):
    def compatibiality_test:
          ...

After this I'll setup the github action.
There will be two steps
Sanity Test Django 3 / 4 (Creates the venv install django 3/4 and khronos).

The objective is that simply merging a PR will not break due to syntax error etc.

Feel free to ask if you need some more info.

Setup github actions to release django-khronos package to PyPi.

Setup github actions to run test.

Change setup.py to open README.md file from root directory.

Right now there's a bug in setup.py file.

khronos/Khronos/setup.py

Line 7 in a9f09e6

long_description=open("README.md").read(),

So, whenever I have to push a new version to PyPi, I have to manually put README.md file to dir in which setup.py file is.

So, make the changes in

khronos/Khronos/setup.py

Line 7 in a9f09e6

long_description=open("README.md").read(),

in way it'll open the README.md file from root dir.

Handle Exceptions in code

use "with" statement as a context manager to ensure, files or operations are closed successfully

remove magic numbers from code

the save_duration function can be reused inside the code