Better test-local and test-integ

Author: michael-groundlight

Examples.md

@@ -43,10 +43,7 @@ detectors = gl.list_detectors(page=3, page_size=25)
 #### Submit an image query
 
 ```Python
-from groundlight.images import jpeg_from_file # utility function for convenience
-
-image_bytesio = jpeg_from_file("test/assets/dog.jpeg")
-image_query = gl.submit_image_query(detector_id="YOUR_DETECTOR_ID", image_bytesio=image_bytesio)
+image_query = gl.submit_image_query(detector_id="YOUR_DETECTOR_ID", image="path/to/filename.jpeg")
 ```
 
 #### Retrieve an image query

Makefile

@@ -1,3 +1,5 @@
+.PHONY: all test clean
+
 # Java weirdness - see https://github.com/OpenAPITools/openapi-generator/issues/11763#issuecomment-1098337960
 generate:  ## Generate the SDK from our public openapi spec
 	_JAVA_OPTIONS="--add-opens=java.base/java.lang=ALL-UNNAMED \
@@ -6,3 +8,10 @@ generate:  ## Generate the SDK from our public openapi spec
 		-g python \
 		-o ./generated
 	poetry run datamodel-codegen  --input spec/public-api.yaml --output generated/model.py
+
+test-local:  ## Run integration tests against an API server running at http://localhost:8000/device-api (needs GROUNDLIGHT_API_TOKEN)
+	GROUNDLIGHT_TEST_API_ENDPOINT="http://localhost:8000/device-api" poetry run pytest --cov=src test --log-cli-level INFO
+
+
+test-integ:  ## Run integration tests against the integ API server (needs GROUNDLIGHT_API_TOKEN)
+	GROUNDLIGHT_TEST_API_ENDPOINT="https://device.integ.positronix.ai/device-api" poetry run pytest --cov=src test --log-cli-level INFO

README.md

@@ -73,6 +73,38 @@ The auto-generated SDK code is in the `generated/` directory. To re-generate the
 $ make generate
 ```
 
+## Testing
+
+Most tests need an API endpoint to run.
+
+### Local API endpoint
+
+1. Set up a local [janzu API endpoint](https://github.com/positronix-ai/zuuul/blob/main/deploy/README.md#development-using-local-microk8s) running (e.g., on an AWS GPU instance).
+
+1. Set up an ssh tunnel to your laptop. That way, you can access the endpoint at http://localhost:8000/device-api (and the web UI at http://localhost:8000/reef):
+
+    ```Bash
+    $ ssh instance-name -L 8000:localhost:80
+    ```
+
+1. Run the tests (with an API token)
+
+    ```Bash
+    $ export GROUNDLIGHT_API_TOKEN=tok_abc123
+    $ make test-local
+    ```
+
+(Note: in theory, it's possible to run the janzu API server on your laptop without microk8s - but some API methods don't work because of the dependence on GPUs)
+
+### Integ API endpoint
+
+1. Run the tests (with an API token)
+
+    ```Bash
+    $ export GROUNDLIGHT_API_TOKEN=tok_abc123
+    $ make test-integ
+    ```
+
 ## Releases
 
 To publish a new package version to our [internal pypi repository](https://github.com/positronix-ai/packaging/tree/main/aws), you create a release on github.

src/groundlight/client.py

@@ -1,12 +1,15 @@
 import os
 from io import BytesIO
+from typing import Union
 
 from model import Detector, ImageQuery, PaginatedDetectorList, PaginatedImageQueryList
 from openapi_client import ApiClient, Configuration
 from openapi_client.api.detectors_api import DetectorsApi
 from openapi_client.api.image_queries_api import ImageQueriesApi
 from openapi_client.model.detector_creation_input import DetectorCreationInput
 
+from groundlight.images import bytesio_from_jpeg_file
+
 API_TOKEN_WEB_URL = "https://app.positronix.ai/reef/my-account/api-tokens"
 API_TOKEN_VARIABLE_NAME = "GROUNDLIGHT_API_TOKEN"
 
@@ -75,6 +78,16 @@ def list_image_queries(self, page: int = 1, page_size: int = 10) -> PaginatedIma
         obj = self.image_queries_api.list_image_queries(page=page, page_size=page_size)
         return PaginatedImageQueryList.parse_obj(obj.to_dict())
 
-    def submit_image_query(self, detector_id: str, image_bytesio: BytesIO) -> ImageQuery:
+    def submit_image_query(self, detector_id: str, image: Union[str, bytes, BytesIO]) -> ImageQuery:
+        if isinstance(image, str):
+            # Assume it is a filename
+            image_bytesio = bytesio_from_jpeg_file(image)
+        elif isinstance(image, bytes):
+            # Create a BytesIO object
+            image_bytesio = BytesIO(image)
+        elif isinstance(image, BytesIO):
+            # Already in the right format
+            image_bytesio = image
+
         obj = self.image_queries_api.submit_image_query(detector_id=detector_id, body=image_bytesio)
         return ImageQuery.parse_obj(obj.to_dict())

src/groundlight/images.py

@@ -3,7 +3,7 @@
 from PIL import Image
 
 
-def jpeg_from_file(image_filename) -> io.BytesIO:
+def bytesio_from_jpeg_file(image_filename) -> io.BytesIO:
     """
     Get a BytesIO object from a JPEG filename.
     """

test/integration/test_groundlight.py

@@ -1,14 +1,15 @@
+import os
 from datetime import datetime
 
 import pytest
 from groundlight import Groundlight
-from groundlight.images import jpeg_from_file
 from model import Detector, ImageQuery, PaginatedDetectorList, PaginatedImageQueryList
 
 
 @pytest.fixture
 def gl() -> Groundlight:
-    return Groundlight(endpoint="http://localhost:8000/device-api")
+    endpoint = os.environ.get("GROUNDLIGHT_TEST_API_ENDPOINT", "http://localhost:8000/device-api")
+    return Groundlight(endpoint=endpoint)
 
 
 @pytest.fixture
@@ -20,8 +21,7 @@ def detector(gl: Groundlight) -> Detector:
 
 @pytest.fixture
 def image_query(gl: Groundlight, detector: Detector) -> ImageQuery:
-    image_bytesio = jpeg_from_file("test/assets/dog.jpeg")
-    return gl.submit_image_query(detector_id=detector.id, image_bytesio=image_bytesio)
+    return gl.submit_image_query(detector_id=detector.id, image="test/assets/dog.jpeg")
 
 
 @pytest.mark.skip(reason="We don't want to create a million detectors")
@@ -48,8 +48,7 @@ def test_get_detector(gl: Groundlight, detector: Detector):
 
 @pytest.mark.skip(reason="We don't want to create a million detectors and image_queries")
 def test_submit_image_query(gl: Groundlight, detector: Detector):
-    image_bytesio = jpeg_from_file("test/assets/dog.jpeg")
-    _image_query = gl.submit_image_query(detector_id=detector.id, image_bytesio=image_bytesio)
+    _image_query = gl.submit_image_query(detector_id=detector.id, image="test/assets/dog.jpeg")
     assert str(_image_query)
     assert isinstance(_image_query, ImageQuery)