{"id":16106184,"url":"https://github.com/hroncok/utvsapi-benchmark","last_synced_at":"2025-04-06T03:14:32.553Z","repository":{"id":148870561,"uuid":"58087250","full_name":"hroncok/utvsapi-benchmark","owner":"hroncok","description":"Simple benchmark designed to be run against ÚTVS ČVUT APIs implemented in various frameworks","archived":false,"fork":false,"pushed_at":"2016-05-05T15:55:35.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-12T09:23:55.150Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hroncok.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-04T22:11:36.000Z","updated_at":"2016-05-05T00:11:04.000Z","dependencies_parsed_at":"2023-07-10T17:00:59.570Z","dependency_job_id":null,"html_url":"https://github.com/hroncok/utvsapi-benchmark","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hroncok%2Futvsapi-benchmark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hroncok%2Futvsapi-benchmark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hroncok%2Futvsapi-benchmark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hroncok%2Futvsapi-benchmark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hroncok","download_url":"https://codeload.github.com/hroncok/utvsapi-benchmark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427012,"owners_count":20937214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T19:12:14.573Z","updated_at":"2025-04-06T03:14:32.536Z","avatar_url":"https://github.com/hroncok.png","language":"Shell","readme":"utvsapi-benchmark\n=================\n\nSimple benchmark designed to be run against [ÚTVS ČVUT](https://rozvoj.fit.cvut.cz/Main/rozvrhy-utvs-db) APIs\nimplemented in various frameworks.\n\nRequirements\n------------\n\nYou need the actual implementations cloned:\n\n * [utvsapi-django](https://github.com/hroncok/utvsapi-django)\n * [utvsapi-eve](https://github.com/hroncok/utvsapi-eve)\n * [utvsapi-ripozo](https://github.com/hroncok/utvsapi-ripozo)\n * [utvsapi-sandman](https://github.com/hroncok/utvsapi-sandman)\n\nThe `runner.sh` script expects them to be located in `..`, but you can change that in the script.\n\nThe repositories need to be cloned, virtualenvs created in `venv` subdirectory,\ndependencies and `gunicorn` installed in those.\nDatabase credentials in appropriate locations for each project are required as well.\nSee each project's README for details.\n\nOf course, you also need the MySQL/MariaDB database to be running and filled with data,\npreferably on localhost not to screw up the results too much.\nUnfortunately the data is not public for you to use, but if you are interested contact me and we can figure that out somehow.\n\nYou'll also need [utvsapitoken](https://github.com/hroncok/utvsapitoken)'s `fakeserver` to be running on default port (8080).\n\nFor some authentication based tests, you'll need to provide a student's personal number in `$STUDENT`. The number is not hardcoded in the scripts for obvious reasons.\n\nHow-to\n------\n\nRunning an individual test and observing the logs:\n\n    ./runner.sh test_foo\n\nRunning all auth related tests and observing the logs together with saving them to `logs` directory:\n\n    ./run_all_auth.sh\n\nNote that [utvsapi-sandman](https://github.com/hroncok/utvsapi-sandman) does not\nimplement auth and is not included in those tests.\n\nRunning all not auth related tests and observing the logs together with saving them to `logs` directory:\n\n    ./run_all_auth.sh -v  # -v as in grep's option, not verbose or version\n\nNote that in the spirit of fair play, you should disable auth in other implementations\nif you'd like to compare them with [utvsapi-sandman](https://github.com/hroncok/utvsapi-sandman);\nthere is no simple way to do so, but special `noauth` branches are available in the repos.\n\nCustomization\n-------------\n\nIf you'd like to change the total number of requests and the number of concurrent requests being run for each test,\nthere are two bash variables for that at the very beginning of the `runner.sh` script.\n\nCensorship\n----------\n\nThere is a `censor.sh` script provided in order to remove personal information from the logs.\nIt is wise to use it before publishing the logs.\n\nLicense\n-------\n\nThis software is licensed under the terms of the MIT license, see LICENSE for full text and copyright information.\nIt was inspired by [pycnic's benchmark](https://github.com/nullism/pycnic/tree/master/benchmark)\nand [@nullism](https://github.com/nullism) is listed in the copyright notice as well.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhroncok%2Futvsapi-benchmark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhroncok%2Futvsapi-benchmark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhroncok%2Futvsapi-benchmark/lists"}