Refactor user-facing API models

.github/workflows/main.yml

@@ -39,25 +39,40 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
 
+      - name: Export environment variables
+        run: |
+          echo "SECRET_KEY=b6451545d2e4635148d768f07877aade3ad8e7e160d52962badd7587a4b9a150" > .env
+          echo "SMTP_HOST=smtp.gmail.com" >> .env
+          echo "SMTP_PORT=465" >> .env
+          echo "[email protected]" >> .env
+          echo "EMAIL_PASSWORD=random" >> .env
+
+      - name: Build docker images
+        run: docker-compose -f test-docker-compose.yaml build
+
       - name: Run pycodestyle
         run: |
           pycodestyle api/*.py
 
+      - name: Run API containers
+        run: |
+          docker-compose -f test-docker-compose.yaml up -d test
+
       - name: Run pylint
         run: |
-          pylint api.auth
-          pylint api.db
-          pylint api.main
-          pylint api.models
-          pylint api.pubsub
-          pylint api.user_manager
-          pylint api.user_models
-          pylint tests/unit_tests
-          pylint tests/e2e_tests
-
-      - name: Run pytest
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.auth
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.db
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.main
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.models
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.pubsub
+          docker-compose -f test-docker-compose.yaml exec -T test pylint api.user_manager
+          docker-compose -f test-docker-compose.yaml exec -T test pylint tests/unit_tests
+          docker-compose -f test-docker-compose.yaml exec -T test pylint tests/e2e_tests
+
+      - name: Stop docker containers
+        if: always()
         run: |
-          SECRET_KEY=b6451545d2e4635148d768f07877aade3ad8e7e160d52962badd7587a4b9a150 SMTP_HOST=smtp.gmail.com SMTP_PORT=465 EMAIL_SENDER=test@kernelci.org EMAIL_PASSWORD=random pytest -vs tests/unit_tests/
+          docker-compose -f test-docker-compose.yaml down
 
   lint:
     runs-on: ubuntu-22.04

.github/workflows/test.yml

@@ -40,11 +40,15 @@ jobs:
 
       - name: Run API containers
         run: |
-          docker-compose -f test-docker-compose.yaml up -d api db redis storage ssh
+          docker-compose -f test-docker-compose.yaml up -d api db redis storage ssh test
 
-      - name: Run test container
+      - name: Run unit tests
         run: |
-          docker-compose -f test-docker-compose.yaml up --exit-code-from test test
+          docker-compose -f test-docker-compose.yaml exec -T test pytest -vs tests/unit_tests
+
+      - name: Run e2e tests
+        run: |
+          docker-compose -f test-docker-compose.yaml exec -T test pytest -v tests/e2e_tests
 
       - name: Stop docker containers
         if: always()

api/admin.py

@@ -17,10 +17,10 @@
 
 from .auth import Authentication
 from .db import Database
-from .user_models import User
+from .models import User
 
 
 async def setup_admin_user(db, username, email):
     """Create an admin user"""
     user_obj = await db.find_one_by_attributes(User,
                                                {'username': username})
@@ -46,8 +46,8 @@
 
 async def main(args):
     db = Database(args.mongo, args.database)
     await db.initialize_beanie()
     await setup_admin_user(db, args.username, args.email)
     return True
 
 

api/db.py

@@ -10,8 +10,8 @@
 from beanie import init_beanie
 from fastapi_pagination.ext.motor import paginate
 from motor import motor_asyncio
-from .models import Hierarchy, Node, Regression, UserGroup
-from .user_models import User
+from kernelci.api.models import Hierarchy, Node, Regression
+from .models import User, UserGroup
 
 
 class Database:

api/main.py

@@ -27,24 +27,26 @@
 from pymongo.errors import DuplicateKeyError
 from fastapi_users import FastAPIUsers
 from beanie import PydanticObjectId
-from .auth import Authentication
-from .db import Database
-from .models import (
+from kernelci.api.models import (
     Node,
     Hierarchy,
     Regression,
-    UserGroup,
     PublishEvent,
     get_model_from_kind
 )
-from .paginator_models import PageModel
-from .pubsub import PubSub, Subscription, SubscriptionStats
+from .auth import Authentication
+from .db import Database
+from .pubsub import PubSub
 from .user_manager import get_user_manager, create_user_manager
-from .user_models import (
+from .models import (
+    PageModel,
+    Subscription,
+    SubscriptionStats,
     User,
     UserRead,
     UserCreate,
     UserUpdate,
+    UserGroup,
 )