https://github.com/kernelci/kernelci-api
KernelCI API - Database - Pub/Sub
https://github.com/kernelci/kernelci-api
Last synced: about 1 year ago
JSON representation
KernelCI API - Database - Pub/Sub
- Host: GitHub
- URL: https://github.com/kernelci/kernelci-api
- Owner: kernelci
- License: lgpl-2.1
- Created: 2021-10-08T13:44:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T08:25:36.000Z (over 1 year ago)
- Last Synced: 2024-11-26T08:35:50.756Z (over 1 year ago)
- Language: Python
- Size: 594 KB
- Stars: 9
- Watchers: 19
- Forks: 17
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
KernelCI API
============
This repository is a work-in-progress implementation of a new API and database
interface for KernelCI, to replace
[kernelci-backend](https://github.com/kernelci/kernelci-backend.git). It's
mainly based on [FastAPI](https://fastapi.tiangolo.com/), [Mongo
DB](https://www.mongodb.com/) and [Redis](https://redis.io/).
Please refer to the [architecture](https://docs.kernelci.org/api_pipeline/api/design/#api-architecture) for more details.
## Getting started with docker-compose
Please refer to [start Docker containers](https://docs.kernelci.org/api_pipeline/api/local-instance/#start-docker-compose) of all the services.
Note that the FastAPI server is running on port 8000 inside the container, but
it's exposed to the host via port 8001 to avoid conflicts with other services.
This can be adjusted for each setup in
[`docker-compose.yaml`](docker-compose.yaml).
## Authentication
Generate a new key for [Authentication](https://docs.kernelci.org/api_pipeline/api/local-instance/#create-the-environment-file)
).
After that, please refer to [create and add a user](https://docs.kernelci.org/api_pipeline/api/local-instance/#create-an-admin-user-account) in Mongo DB.
The user can also generate an [API token](https://docs.kernelci.org/api_pipeline/api/local-instance/#create-an-admin-pipeline-token) to use API endpoints.
Ultimately, there will be a web frontend to provide a login form. We don't
have that yet as this new KernelCI API implementation is still in its early
stages.
## API Documentation
The FastAPI server will automatically generate documentation for the API itself
and serve it directly: http://localhost:8001/latest/docs
To use the generated documentation, first [open
it](http://localhost:8001/latest/docs) with a web browser. Then click on
"Authorize 🔓", enter the user name and password and click on the new
"Authorize" button.
This is based on OpenAPI, and you can also download the `openapi.json` file to
use it with other tools: http://localhost:8001/latest/openapi.json
## API Testing
Please follow the below instructions to test API endpoints.
Install Python requirements with additional packages for testing:
```
pip install -r docker/api/requirements-dev.txt
```
We have already created .env file from [Authentication](#authentication) section.
Export the file with SECRET_KEY environment variable in it:
```
export $(cat .env)
```
Run the below command from kernelci-api directory:
```
pytest -v tests/unit_tests/
```
This will start running unit test cases from kernelci-api/test directory and display results.
In addition to the unit tests, end-to-end tests for API has been developed.
A Github action check `test` is running on every push and pull to execute the end-to-end tests.
In order to ease the execution of the tests locally, a shell script `run_e2e_tests.sh` has been introduced.
Run the below command from kernelci-api directory:
```
./run_e2e_tests.sh
```
This will start running e2e test cases in a `docker-compose` environment from kernelci-api/e2e_tests directory and display results.