elixir-cloud-aai / TESK

GA4GH Task Execution Service Root Project + Deployment scripts on Kubernetes
https://tesk.readthedocs.io
Apache License 2.0
39 stars 28 forks source link

feat: add base classes and docs #191

Closed JaeAeich closed 3 days ago

JaeAeich commented 3 weeks ago

Summary by Sourcery

This pull request introduces new base classes for the TESK API, including TeskApp for application initialization and running, BaseValidator for custom validation logic, and BaseTeskRequest for common TES API endpoint logic. Additionally, it refactors the existing application initialization logic to utilize the new TeskApp class.

sourcery-ai[bot] commented 3 weeks ago

Reviewer's Guide by Sourcery

This pull request introduces new base classes TESK, requests, and model validators. It also includes significant enhancements to the documentation, Helm chart configurations, and Kubernetes Ingress settings. Additionally, new unit tests have been added for various modules, and a GitHub Actions workflow has been set up to check for vulnerabilities.

File-Level Changes

Files Changes
tesk/app.py
tesk/tesk_app.py
Refactored the application initialization to use the new TeskApp class, simplifying the main entry point and configuration loading.
tesk/api/ga4gh/tes/models/base/base_validator.py
tesk/api/ga4gh/tes/base/base_tesk_request.py
tesk/api/ga4gh/tes/base/__init__.py
tesk/api/ga4gh/tes/models/base/__init__.py
Introduced new base classes for TES API requests and custom Pydantic validators, providing a structured approach for request handling and validation.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.21%. Comparing base (c5128a9) to head (bf33bc8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #191 +/- ## ======================================= Coverage 98.21% 98.21% ======================================= Files 8 8 Lines 561 561 ======================================= Hits 551 551 Misses 10 10 ``` | [Flag](https://app.codecov.io/gh/elixir-cloud-aai/TESK/pull/191/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elixir-cloud-aai) | Coverage Δ | | |---|---|---| | [test_unit](https://app.codecov.io/gh/elixir-cloud-aai/TESK/pull/191/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elixir-cloud-aai) | `98.21% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=elixir-cloud-aai#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

JaeAeich commented 3 weeks ago

@sourcery-ai review

sourcery-ai[bot] commented 3 weeks ago

I'm sorry, I don't understand the command @sourcery-ai review

Please use @sourcery-ai review to request a review

JaeAeich commented 3 weeks ago

@sourcery-ai review

sourcery-ai[bot] commented 3 weeks ago

🧙 Sourcery is reviewing your pull request!


Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - You can change your review settings at any time by accessing your [dashboard](https://sourcery.ai/dashboard): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
JaeAeich commented 3 days ago

please check #198