Merge branch 'dev' into 'main'

Dev

See merge request oscar.krause/fastapi-dls!34

.gitlab-ci.yml

@@ -297,13 +297,17 @@ gemnasium-python-dependency_scanning:
 
 deploy:docker:
   extends: .deploy
+  image: docker:dind
   stage: deploy
+  tags: [ docker ]
   before_script:
     - echo "Building docker image for commit $CI_COMMIT_SHA with version $CI_COMMIT_REF_NAME"
+    - docker buildx inspect
+    - docker buildx create --use
   script:
     - echo "========== GitLab-Registry =========="
     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-    - IMAGE=$CI_REGISTRY/$CI_PROJECT_PATH/$CI_COMMIT_REF_NAME
+    - IMAGE=$CI_REGISTRY/$CI_PROJECT_PATH
     - docker buildx build --progress=plain --platform $DOCKER_BUILDX_PLATFORM --build-arg VERSION=$CI_COMMIT_REF_NAME --build-arg COMMIT=$CI_COMMIT_SHA --tag $IMAGE:$CI_COMMIT_REF_NAME --push .
     - docker buildx build --progress=plain --platform $DOCKER_BUILDX_PLATFORM --build-arg VERSION=$CI_COMMIT_REF_NAME --build-arg COMMIT=$CI_COMMIT_SHA --tag $IMAGE:latest --push .
     - echo "========== Docker-Hub =========="

README.md

@@ -26,7 +26,7 @@ Only the clients need a connection to this service on configured port.
 
 ---
 
-[TOC]
+[[_TOC_]]
 
 # Setup (Service)
 

app/main.py

@@ -1,42 +1,39 @@
 import logging
 from base64 import b64encode as b64enc
-from calendar import timegm
-from contextlib import asynccontextmanager
-from datetime import datetime, timedelta
 from hashlib import sha256
-from json import loads as json_loads
-from os import getenv as env
-from os.path import join, dirname
 from uuid import uuid4
+from os.path import join, dirname
+from os import getenv as env
 
-from dateutil.relativedelta import relativedelta
 from dotenv import load_dotenv
 from fastapi import FastAPI
 from fastapi.requests import Request
+from json import loads as json_loads
+from datetime import datetime, timedelta
+from dateutil.relativedelta import relativedelta
+from calendar import timegm
 from jose import jws, jwk, jwt, JWTError
 from jose.constants import ALGORITHMS
-from sqlalchemy import create_engine
-from sqlalchemy.orm import sessionmaker
 from starlette.middleware.cors import CORSMiddleware
 from starlette.responses import StreamingResponse, JSONResponse as JSONr, HTMLResponse as HTMLr, Response, RedirectResponse
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
 
-from orm import Origin, Lease, init as db_init, migrate
 from util import load_key, load_file
+from orm import Origin, Lease, init as db_init, migrate
 
-# Load variables
 load_dotenv('../version.env')
 
-# Get current timezone
 TZ = datetime.now().astimezone().tzinfo
 
-# Load basic variables
 VERSION, COMMIT, DEBUG = env('VERSION', 'unknown'), env('COMMIT', 'unknown'), bool(env('DEBUG', False))
 
-# Database connection
+config = dict(openapi_url=None, docs_url=None, redoc_url=None)  # dict(openapi_url='/-/openapi.json', docs_url='/-/docs', redoc_url='/-/redoc')
+app = FastAPI(title='FastAPI-DLS', description='Minimal Delegated License Service (DLS).', version=VERSION, **config)
 db = create_engine(str(env('DATABASE', 'sqlite:///db.sqlite')))
 db_init(db), migrate(db)
 
-# Load DLS variables (all prefixed with "INSTANCE_*" is used as "SERVICE_INSTANCE_*" or "SI_*" in official dls service)
+# everything prefixed with "INSTANCE_*" is used as "SERVICE_INSTANCE_*" or "SI_*" in official dls service
 DLS_URL = str(env('DLS_URL', 'localhost'))
 DLS_PORT = int(env('DLS_PORT', '443'))
 SITE_KEY_XID = str(env('SITE_KEY_XID', '00000000-0000-0000-0000-000000000000'))
@@ -54,32 +51,6 @@ CORS_ORIGINS = str(env('CORS_ORIGINS', '')).split(',') if (env('CORS_ORIGINS'))
 jwt_encode_key = jwk.construct(INSTANCE_KEY_RSA.export_key().decode('utf-8'), algorithm=ALGORITHMS.RS256)
 jwt_decode_key = jwk.construct(INSTANCE_KEY_PUB.export_key().decode('utf-8'), algorithm=ALGORITHMS.RS256)
 
-
-# FastAPI
-@asynccontextmanager
-async def lifespan(_: FastAPI):
-    # on startup
-    logger.info(f'''
-    
-    Using timezone: {str(TZ)}. Make sure this is correct and match your clients!
-    
-    Your clients renew their license every {str(Lease.calculate_renewal(LEASE_RENEWAL_PERIOD, LEASE_RENEWAL_DELTA))}.
-    If the renewal fails, the license is {str(LEASE_RENEWAL_DELTA)} valid.
-    
-    Your client-token file (.tok) is valid for {str(CLIENT_TOKEN_EXPIRE_DELTA)}.
-    ''')
-
-    logger.info(f'Debug is {"enabled" if DEBUG else "disabled"}.')
-
-    yield
-
-    # on shutdown
-    logger.info(f'Shutting down ...')
-
-
-config = dict(openapi_url=None, docs_url=None, redoc_url=None)  # dict(openapi_url='/-/openapi.json', docs_url='/-/docs', redoc_url='/-/redoc')
-app = FastAPI(title='FastAPI-DLS', description='Minimal Delegated License Service (DLS).', version=VERSION, lifespan=lifespan, **config)
-
 app.debug = DEBUG
 app.add_middleware(
     CORSMiddleware,
@@ -89,24 +60,17 @@ app.add_middleware(
     allow_headers=['*'],
 )
 
-# Logging
+logging.basicConfig()
-LOG_LEVEL = logging.DEBUG if DEBUG else logging.INFO
-logging.basicConfig(format='[{levelname:^7}] [{module:^15}] {message}', style='{')
 logger = logging.getLogger(__name__)
-logger.setLevel(LOG_LEVEL)
+logger.setLevel(logging.DEBUG if DEBUG else logging.INFO)
-logging.getLogger('util').setLevel(LOG_LEVEL)
-logging.getLogger('NV').setLevel(LOG_LEVEL)
 
 
-# Helper
 def __get_token(request: Request) -> dict:
     authorization_header = request.headers.get('authorization')
     token = authorization_header.split(' ')[1]
     return jwt.decode(token=token, key=jwt_decode_key, algorithms=ALGORITHMS.RS256, options={'verify_aud': False})
 
 
-# Endpoints
-
 @app.get('/', summary='Index')
 async def index():
     return RedirectResponse('/-/readme')
@@ -144,7 +108,7 @@ async def _config():
 @app.get('/-/readme', summary='* Readme')
 async def _readme():
     from markdown import markdown
-    content = load_file(join(dirname(__file__), '../README.md')).decode('utf-8')
+    content = load_file('../README.md').decode('utf-8')
     return HTMLr(markdown(text=content, extensions=['tables', 'fenced_code', 'md_in_html', 'nl2br', 'toc']))
 
 
@@ -576,6 +540,18 @@ async def leasing_v1_lessor_shutdown(request: Request):
     return JSONr(response)
 
 
+@app.on_event('startup')
+async def app_on_startup():
+    logger.info(f'''
+    Using timezone: {str(TZ)}. Make sure this is correct and match your clients!
+    
+    Your clients renew their license every {str(Lease.calculate_renewal(LEASE_RENEWAL_PERIOD, LEASE_RENEWAL_DELTA))}.
+    If the renewal fails, the license is {str(LEASE_RENEWAL_DELTA)} valid.
+    
+    Your client-token file (.tok) is valid for {str(CLIENT_TOKEN_EXPIRE_DELTA)}.
+    ''')
+
+
 if __name__ == '__main__':
     import uvicorn
 

app/orm.py

@@ -1,12 +1,10 @@
 from datetime import datetime, timedelta
-
 from dateutil.relativedelta import relativedelta
+
 from sqlalchemy import Column, VARCHAR, CHAR, ForeignKey, DATETIME, update, and_, inspect, text
 from sqlalchemy.engine import Engine
 from sqlalchemy.orm import sessionmaker, declarative_base
 
-from util import NV
-
 Base = declarative_base()
 
 
@@ -25,8 +23,6 @@ class Origin(Base):
         return f'Origin(origin_ref={self.origin_ref}, hostname={self.hostname})'
 
     def serialize(self) -> dict:
-        _ = NV().find(self.guest_driver_version)
-
         return {
             'origin_ref': self.origin_ref,
             # 'service_instance_xid': self.service_instance_xid,
@@ -34,7 +30,6 @@ class Origin(Base):
             'guest_driver_version': self.guest_driver_version,
             'os_platform': self.os_platform,
             'os_version': self.os_version,
-            '$driver': _ if _ is not None else None,
         }
 
     @staticmethod

app/util.py

@@ -1,17 +1,10 @@
-import logging
+def load_file(filename) -> bytes:
-
-logging.basicConfig()
-
-
-def load_file(filename: str) -> bytes:
-    log = logging.getLogger(f'{__name__}')
-    log.debug(f'Loading contents of file "{filename}')
     with open(filename, 'rb') as file:
         content = file.read()
     return content
 
 
-def load_key(filename: str) -> "RsaKey":
+def load_key(filename) -> "RsaKey":
     try:
         # Crypto | Cryptodome on Debian
         from Crypto.PublicKey import RSA
@@ -20,8 +13,6 @@ def load_key(filename: str) -> "RsaKey":
         from Cryptodome.PublicKey import RSA
         from Cryptodome.PublicKey.RSA import RsaKey
 
-    log = logging.getLogger(__name__)
-    log.debug(f'Importing RSA-Key from "{filename}"')
     return RSA.import_key(extern_key=load_file(filename), passphrase=None)
 
 
@@ -33,50 +24,5 @@ def generate_key() -> "RsaKey":
     except ModuleNotFoundError:
         from Cryptodome.PublicKey import RSA
         from Cryptodome.PublicKey.RSA import RsaKey
-    log = logging.getLogger(__name__)
+
-    log.debug(f'Generating RSA-Key')
     return RSA.generate(bits=2048)
-
-
-class NV:
-    __DRIVER_MATRIX_FILENAME = 'static/driver_matrix.json'
-    __DRIVER_MATRIX: None | dict = None  # https://docs.nvidia.com/grid/ => "Driver Versions"
-
-    def __init__(self):
-        self.log = logging.getLogger(self.__class__.__name__)
-
-        if NV.__DRIVER_MATRIX is None:
-            from json import load as json_load
-            try:
-                file = open(NV.__DRIVER_MATRIX_FILENAME)
-                NV.__DRIVER_MATRIX = json_load(file)
-                file.close()
-                self.log.debug(f'Successfully loaded "{NV.__DRIVER_MATRIX_FILENAME}".')
-            except Exception as e:
-                NV.__DRIVER_MATRIX = {}  # init empty dict to not try open file everytime, just when restarting app
-                # self.log.warning(f'Failed to load "{NV.__DRIVER_MATRIX_FILENAME}": {e}')
-
-    @staticmethod
-    def find(version: str) -> dict | None:
-        if NV.__DRIVER_MATRIX is None:
-            return None
-        for idx, (key, branch) in enumerate(NV.__DRIVER_MATRIX.items()):
-            for release in branch.get('$releases'):
-                linux_driver = release.get('Linux Driver')
-                windows_driver = release.get('Windows Driver')
-                if version == linux_driver or version == windows_driver:
-                    tmp = branch.copy()
-                    tmp.pop('$releases')
-
-                    is_latest = release.get('vGPU Software') == branch.get('Latest Release in Branch')
-
-                    return {
-                        'software_branch': branch.get('vGPU Software Branch'),
-                        'branch_version': release.get('vGPU Software'),
-                        'driver_branch': branch.get('Driver Branch'),
-                        'branch_status': branch.get('vGPU Branch Status'),
-                        'release_date': release.get('Release Date'),
-                        'eol': branch.get('EOL Date') if is_latest else None,
-                        'is_latest': is_latest,
-                    }
-        return None

test/create_driver_matrix_json.py

@@ -1,137 +0,0 @@
-import logging
-
-logging.basicConfig()
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
-
-URL = 'https://docs.nvidia.com/grid/'
-
-BRANCH_STATUS_KEY, SOFTWARE_BRANCH_KEY, = 'vGPU Branch Status', 'vGPU Software Branch'
-VGPU_KEY, GRID_KEY, DRIVER_BRANCH_KEY = 'vGPU Software', 'vGPU Software', 'Driver Branch'
-LINUX_VGPU_MANAGER_KEY, LINUX_DRIVER_KEY = 'Linux vGPU Manager', 'Linux Driver'
-WINDOWS_VGPU_MANAGER_KEY, WINDOWS_DRIVER_KEY = 'Windows vGPU Manager', 'Windows Driver'
-ALT_VGPU_MANAGER_KEY = 'vGPU Manager'
-RELEASE_DATE_KEY, LATEST_KEY, EOL_KEY = 'Release Date', 'Latest Release in Branch', 'EOL Date'
-JSON_RELEASES_KEY = '$releases'
-
-
-def __driver_versions(html: 'BeautifulSoup'):
-    def __strip(_: str) -> str:
-        # removes content after linebreak (e.g. "Hello\n World" to "Hello")
-        _ = _.strip()
-        tmp = _.split('\n')
-        if len(tmp) > 0:
-            return tmp[0]
-        return _
-
-    # find wrapper for "DriverVersions" and find tables
-    data = html.find('div', {'id': 'DriverVersions'})
-    tables = data.findAll('table')
-    for table in tables:
-        # parse software-branch (e.g. "vGPU software 17 Releases" and remove " Releases" for "matrix_key")
-        software_branch = table.parent.find_previous_sibling('button', {'class': 'accordion'}).text.strip()
-        software_branch = software_branch.replace(' Releases', '')
-        matrix_key = software_branch.lower()
-
-        # driver version info from table-heads (ths) and table-rows (trs)
-        ths, trs = table.find_all('th'), table.find_all('tr')
-        headers, releases = [header.text.strip() for header in ths], []
-        for trs in trs:
-            tds = trs.find_all('td')
-            if len(tds) == 0:  # skip empty
-                continue
-            # create dict with table-heads as key and cell content as value
-            x = {headers[i]: __strip(cell.text) for i, cell in enumerate(tds)}
-            releases.append(x)
-
-        # add to matrix
-        MATRIX.update({matrix_key: {JSON_RELEASES_KEY: releases}})
-
-
-def __release_branches(html: 'BeautifulSoup'):
-    # find wrapper for "AllReleaseBranches" and find table
-    data = html.find('div', {'id': 'AllReleaseBranches'})
-    table = data.find('table')
-
-    # branch releases info from table-heads (ths) and table-rows (trs)
-    ths, trs = table.find_all('th'), table.find_all('tr')
-    headers = [header.text.strip() for header in ths]
-    for trs in trs:
-        tds = trs.find_all('td')
-        if len(tds) == 0:  # skip empty
-            continue
-        # create dict with table-heads as key and cell content as value
-        x = {headers[i]: cell.text.strip() for i, cell in enumerate(tds)}
-
-        # get matrix_key
-        software_branch = x.get(SOFTWARE_BRANCH_KEY)
-        matrix_key = software_branch.lower()
-
-        # add to matrix
-        MATRIX.update({matrix_key: MATRIX.get(matrix_key) | x})
-
-
-def __debug():
-    # print table head
-    s = f'{SOFTWARE_BRANCH_KEY:^21} | {BRANCH_STATUS_KEY:^21} | {VGPU_KEY:^13} | {LINUX_VGPU_MANAGER_KEY:^21} | {LINUX_DRIVER_KEY:^21} | {WINDOWS_VGPU_MANAGER_KEY:^21} | {WINDOWS_DRIVER_KEY:^21} | {RELEASE_DATE_KEY:>21} | {EOL_KEY:>21}'
-    print(s)
-
-    # iterate over dict & format some variables to not overload table
-    for idx, (key, branch) in enumerate(MATRIX.items()):
-        branch_status = branch.get(BRANCH_STATUS_KEY)
-        branch_status = branch_status.replace('Branch ', '')
-        branch_status = branch_status.replace('Long-Term Support', 'LTS')
-        branch_status = branch_status.replace('Production', 'Prod.')
-
-        software_branch = branch.get(SOFTWARE_BRANCH_KEY).replace('NVIDIA ', '')
-        for release in branch.get(JSON_RELEASES_KEY):
-            version = release.get(VGPU_KEY, release.get(GRID_KEY, ''))
-            linux_manager = release.get(LINUX_VGPU_MANAGER_KEY, release.get(ALT_VGPU_MANAGER_KEY, ''))
-            linux_driver = release.get(LINUX_DRIVER_KEY)
-            windows_manager = release.get(WINDOWS_VGPU_MANAGER_KEY, release.get(ALT_VGPU_MANAGER_KEY, ''))
-            windows_driver = release.get(WINDOWS_DRIVER_KEY)
-            release_date = release.get(RELEASE_DATE_KEY)
-            is_latest = release.get(VGPU_KEY) == branch.get(LATEST_KEY)
-
-            version = f'{version} *' if is_latest else version
-            eol = branch.get(EOL_KEY) if is_latest else ''
-            s = f'{software_branch:^21} | {branch_status:^21} | {version:<13} | {linux_manager:<21} | {linux_driver:<21} | {windows_manager:<21} | {windows_driver:<21} | {release_date:>21} | {eol:>21}'
-            print(s)
-
-
-def __dump(filename: str):
-    import json
-
-    file = open(filename, 'w')
-    json.dump(MATRIX, file)
-    file.close()
-
-
-if __name__ == '__main__':
-    MATRIX = {}
-
-    try:
-        import httpx
-        from bs4 import BeautifulSoup
-    except Exception as e:
-        logger.error(f'Failed to import module: {e}')
-        logger.info('Run "pip install beautifulsoup4 httpx"')
-        exit(1)
-
-    r = httpx.get(URL)
-    if r.status_code != 200:
-        logger.error(f'Error loading "{URL}" with status code {r.status_code}.')
-        exit(2)
-
-    # parse html
-    soup = BeautifulSoup(r.text, features='html.parser')
-
-    # build matrix
-    __driver_versions(soup)
-    __release_branches(soup)
-
-    # debug output
-    __debug()
-
-    # dump data to file
-    __dump('../app/static/driver_matrix.json')