Add API unit tests & bump dependencies / packaging (#36)

* flake.lock: Update

* bump requirements.txt

* fix woodpecker pipeline

* build docker image on PR

* fix direnv logic

* update Docker image

* modernize nix setup

* fix nix check

* add API unit tests

* pin nixpkgs

* compose: use CDI for nvidia by default

* update nixpkgs

* test/test_api.py: more accurate docstring

Co-authored-by: Chris G <git@chris-ge.de>

---------

Co-authored-by: Chris G <git@chris-ge.de>

Author: MayNiklas

.envrc

@@ -3,7 +3,7 @@ export using_direnv=true
 
 # Check if the NVIDIA kernel module is loaded
 if [ "$(lsmod | grep nvidia | wc -l)" -ne 0 ]; then
-  use flake #withCUDA
+  use flake .#withCUDA
 else
-  use flake #withoutCUDA
+  use flake .#withoutCUDA
 fi

.github/workflows/image.yml

@@ -1,6 +1,7 @@
 name: Create and publish a Docker image
 
 on:
+  pull_request:
   push:
     branches:
         - 'main'
@@ -31,6 +32,7 @@ jobs:
 
       # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
       - name: Log in to the Container registry
+        if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
@@ -52,14 +54,15 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          push: true
+          push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           cache-from: type=gha
           cache-to: type=gha,mode=max
 
       # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)."
       - name: Generate artifact attestation
+        if: github.event_name != 'pull_request'
         uses: actions/attest-build-provenance@v1
         with:
           subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}

.woodpecker/build-amd64.yml

@@ -7,7 +7,9 @@ steps:
     image: bash
     commands:
       - attic login lounge-rocks https://cache.lounge.rocks $ATTIC_KEY --set-default
-    secrets: [attic_key]
+    environment:
+      ATTIC_KEY:
+        from_secret: attic_key
 
   - name: build whisper_api
     image: bash

Dockerfile

@@ -1,25 +1,22 @@
 # newest version:
 # https://hub.docker.com/r/nvidia/cuda/tags?page=1&name=-base-ubuntu22.04&ordering=name
 
-ARG CUDA_VERSION=12.4.1
-FROM nvidia/cuda:${CUDA_VERSION}-base-ubuntu22.04
-
-ARG PYTHON_VERSION=3.10
+ARG CUDA_VERSION=12.6.2
+FROM nvidia/cuda:${CUDA_VERSION}-base-ubuntu24.04
 
 WORKDIR /workspace
 
 RUN export DEBIAN_FRONTEND=noninteractive && \
     apt-get -qq update && \
     apt-get -qq install --no-install-recommends \
         ffmpeg \
-        python${PYTHON_VERSION} \
-        python${PYTHON_VERSION}-venv \
+        python3 \
+        python3-venv \
         python3-pip && \
-    rm -rf /var/lib/apt/lists/* && \
-    pip3 install --upgrade pip setuptools
+    rm -rf /var/lib/apt/lists/*
 
 COPY requirements.txt requirements.txt
-RUN pip3 install --no-build-isolation -r requirements.txt
+RUN pip3 install -r requirements.txt --break-system-packages
 
 # disabled by default since GitHub Actions do not have enough space
 ARG PREFETCH_MODEL=0
@@ -32,7 +29,7 @@ RUN if [ "$PREFETCH_MODEL" != 0 ]; then \
 COPY . /workspace/code
 
 RUN cd /workspace/code && \
-    pip3 install .
+    pip3 install . --break-system-packages
 
 ENV PORT=3001 \
     LISTEN=0.0.0.0 \

docker-compose.yml

@@ -12,13 +12,22 @@ services:
       - LOAD_MODEL_ON_STARTUP=1
       # - UNLOAD_MODEL_AFTER_S=300
       # - DEVELOP_MODE=0
-    # include the following lines when using a NVIDIA GPU!
-    # make sure to have the NVIDIA Container Toolkit installed
-    # for more information visit:
-    # https://github.com/NVIDIA/nvidia-container-toolkit
-    deploy:
-      resources:
-        reservations:
-          devices:
-            - driver: nvidia
-              capabilities: [gpu]
+    # NVIDIA GPU access — enable exactly one of the two blocks below.
+    #
+    # Option A (preferred): CDI (Container Device Interface). Vendor-neutral
+    # standard where the NVIDIA Container Toolkit installs a spec at
+    # /etc/cdi/nvidia.yaml and the device is addressed by name. Requires
+    # Docker >=25 and Compose >=v2.30. This is what modern setups use.
+    devices:
+      - nvidia.com/gpu=all
+    #
+    # Option B (legacy): the old `nvidia` OCI runtime registered in
+    # /etc/docker/daemon.json by older versions of the NVIDIA Container
+    # Toolkit. Being phased out, but still works on hosts that have the
+    # runtime registered and no CDI spec installed.
+    # deploy:
+    #   resources:
+    #     reservations:
+    #       devices:
+    #         - driver: nvidia
+    #           capabilities: [gpu]

flake.lock

@@ -2,7 +2,9 @@
 
   description = "A simple API for OpenAI's Whisper";
 
-  inputs = { nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; };
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+  };
 
   outputs = { self, nixpkgs, ... }:
     let
@@ -33,8 +35,8 @@
         (system: nixpkgsFor.${system}.nixpkgs-fmt);
 
       overlays.default = final: prev: {
-        devShell = final.callPackage nixos/devShell { inherit self; };
-        whisper_api = final.callPackage nixos/pkgs/whisper_api { inherit self; };
+        devShell = final.python3Packages.callPackage nixos/devShell { };
+        whisper_api = final.python3Packages.callPackage nixos/pkgs/whisper_api { inherit self; };
         # Our code is not compatible with pydantic version 2 yet.
         python3 = prev.python3.override {
           packageOverrides = python-self: python-super: {

flake.nix

@@ -82,7 +82,6 @@ in {
           server.succeed("chown -R whisper_api:whisper_api /var/lib/whisper_api/.cache/whisper")
 
           # wait until the server is up
-          server.wait_for_unit("network-online.target")
           server.wait_for_unit("whisper_api")
 
           # check if server can reach API

nixos/checks/default.nix

@@ -1,16 +1,19 @@
-{ self, pkgs, ... }:
+{ pkgs, ... }:
 let
+  whisper_api = pkgs.whisper_api;
   python-with-packages = pkgs.python3.withPackages (p: with p; [
     # only needed for development
     autopep8
     black
     httpx
     isort
-    pylint
     pip
-  ] ++ self.packages.${pkgs.system}.whisper_api.propagatedBuildInputs);
+    pylint
+    pytest
+  ] ++ whisper_api.propagatedBuildInputs);
 in
 pkgs.mkShell {
+  inputsFrom = [ whisper_api ];
   buildInputs = with pkgs; [
     # only needed for development
     nixpkgs-fmt

nixos/devShell/default.nix

@@ -1,9 +1,24 @@
-{ self
-, lib
-, python3
-,
+{
+  self,
+  lib,
+  buildPythonApplication,
+
+  # build-system
+  setuptools,
+  pythonRelaxDepsHook,
+
+  # dependencies
+  fastapi,
+  ffmpeg-python,
+  openai-whisper,
+  python-multipart,
+  uvicorn,
+
+  # tests
+  pytestCheckHook,
+  httpx,
 }:
-python3.pkgs.buildPythonApplication {
+buildPythonApplication {
 
   pname = "whisper_api";
 
@@ -18,24 +33,28 @@ python3.pkgs.buildPythonApplication {
 
   pythonRelaxDeps = [ ];
 
-  nativeBuildInputs = with python3.pkgs; [
+  nativeBuildInputs = [
     setuptools
     pythonRelaxDepsHook
   ];
 
-  propagatedBuildInputs = with python3.pkgs; [
+  propagatedBuildInputs = [
     fastapi
     ffmpeg-python
     openai-whisper
     python-multipart
     uvicorn
   ];
 
-  nativeCheckInputs = with python3.pkgs; [
-    unittestCheckHook
+  nativeCheckInputs = [
+    pytestCheckHook
     httpx
   ];
 
+  disabledTestPaths = [
+    "test/test_api.py"
+  ];
+
   pythonImportsCheck = [ "whisper_api" ];
 
   meta = with lib; {