feat: handle requested environment variables

Author: janbritz

config.example.yml

@@ -64,13 +64,20 @@ permissions:
   #   - package_selector:
   #       origin:
   #         local: true
-  #       namespace: "qpy"
+  #       namespace: qpy
   #     auto_grant_permissions:
   #       memory: 1 GiB
   #     override_permissions:
   #       cpus: 2
   #packages:
 
+environment_variables:
+  # Environment variables that are passed every worker
+  #global:
+
+  # Package- and request-specific environment variables
+  #packages:
+
 cache:
   # Maximum cache size
   #size: 1 GiB

docs/qppe-server.yaml

@@ -1165,6 +1165,7 @@ components:
           type: string
           enum:
             - PACKAGE_PERMISSION_ERROR
+            - PACKAGE_ENVIRONMENT_VARIABLES_ERROR
             - QUEUE_WAITING_TIMEOUT
             - WORKER_TIMEOUT
             - OUT_OF_MEMORY
@@ -1179,6 +1180,7 @@ components:
             - SERVER_ERROR
           description: >
             * `PACKAGE_PERMISSION_ERROR` - The package requested more permissions than allowed.
+            * `PACKAGE_ENVIRONMENT_VARIABLES_ERROR` - The package requires unprovided environment variables.
             * `QUEUE_WAITING_TIMEOUT` - The request has been waiting too long in a job queue. Try again later.
             * `WORKER_TIMEOUT` - Question package did not answer in a reasonable amount of time.
             * `OUT_OF_MEMORY` - Question package reached its memory limit.

questionpy_common/constants.py

@@ -2,9 +2,9 @@
 #  QuestionPy is free software released under terms of the MIT license. See LICENSE.md.
 #  (c) Technische Universität Berlin, innoCampus <info@isis.tu-berlin.de>
 import re
-from typing import Final
+from typing import Annotated, Final
 
-from pydantic import ByteSize
+from pydantic import ByteSize, Field
 
 # General.
 KiB: Final[int] = 1024
@@ -26,3 +26,6 @@
 FORM_REFERENCE_PATTERN: Final[re.Pattern[str]] = re.compile(
     r"^([a-zA-Z_][a-zA-Z0-9_]*|\.\.)(\[([a-zA-Z_][a-zA-Z0-9_]*|\.\.)?])*$"
 )
+
+ENVIRONMENT_VARIABLE_REGEX: Final[str] = r"[a-zA-Z_][a-zA-Z0-9_]*"
+ENVIRONMENT_VARIABLE = Annotated[str, Field(pattern=f"^{ENVIRONMENT_VARIABLE_REGEX}$")]

questionpy_common/manifest.py

@@ -10,6 +10,8 @@
 from pydantic import BaseModel, ByteSize, PositiveInt, StringConstraints, conset, field_validator
 from pydantic.fields import Field
 
+from questionpy_common.constants import ENVIRONMENT_VARIABLE
+
 
 class PackageType(StrEnum):
     LIBRARY = "LIBRARY"
@@ -111,6 +113,7 @@ class SourceManifest(BaseModel):
     type: PackageType = DEFAULT_PACKAGETYPE
     license: str | None = None
     permissions: PartialPackagePermissions | None = None
+    environment_variables: set[ENVIRONMENT_VARIABLE] | None = None
     tags: set[str] = set()
     requirements: str | list[str] | None = None
 

questionpy_server/models.py

@@ -117,6 +117,7 @@ class AttemptScoredResponse(AttemptScoredModel, PackageDependenciesModel):
 
 class RequestErrorCode(Enum):
     PACKAGE_PERMISSION_ERROR = "PACKAGE_PERMISSION_ERROR"
+    PACKAGE_ENVIRONMENT_VARIABLES_ERROR = "PACKAGE_ENVIRONMENT_VARIABLES_ERROR"
     QUEUE_WAITING_TIMEOUT = "QUEUE_WAITING_TIMEOUT"
     WORKER_TIMEOUT = "WORKER_TIMEOUT"
     OUT_OF_MEMORY = "OUT_OF_MEMORY"

questionpy_server/settings.py

@@ -3,15 +3,27 @@
 #  (c) Technische Universität Berlin, innoCampus <info@isis.tu-berlin.de>
 import builtins
 import logging
+import os
+import re
 from datetime import timedelta
 from pathlib import Path
 from pydoc import locate
-from typing import Any, ClassVar, Final, Literal
+from typing import Any, ClassVar, Final, Literal, Self
 
 import semver
 import yaml
-from pydantic import BaseModel, ByteSize, DirectoryPath, HttpUrl, PositiveInt, conset, field_validator
-from pydantic.fields import FieldInfo
+from pydantic import (
+    BaseModel,
+    ByteSize,
+    DirectoryPath,
+    HttpUrl,
+    PositiveInt,
+    RootModel,
+    conset,
+    field_validator,
+    model_validator,
+)
+from pydantic.fields import Field, FieldInfo
 from pydantic_settings import (
     BaseSettings,
     EnvSettingsSource,
@@ -20,7 +32,7 @@
     SettingsConfigDict,
 )
 
-from questionpy_common.constants import MAX_PACKAGE_SIZE, GiB, MiB
+from questionpy_common.constants import ENVIRONMENT_VARIABLE, ENVIRONMENT_VARIABLE_REGEX, MAX_PACKAGE_SIZE, GiB, MiB
 from questionpy_common.manifest import PartialPackagePermissions, ensure_is_valid_name
 from questionpy_server.worker import Worker
 from questionpy_server.worker.impl.subprocess import SubprocessWorker
@@ -155,8 +167,11 @@ def validate_name(cls, value: str) -> str:
 MainProcessExecutionModeValues = {"container", "trusted"}
 
 
-class SpecificPackagePermissions(BaseModel):
+class Selectable(BaseModel):
     package_selector: PackageSelector = PackageSelector()
+
+
+class SpecificPackagePermissions(Selectable):
     auto_grant_permissions: PartialPackagePermissions | None = None
     override_permissions: PartialPackagePermissions | None = None
 
@@ -195,6 +210,35 @@ class PackagePermissionsSettings(BaseModel):
     packages: list[SpecificPackagePermissions] = []
 
 
+class EnvironmentVariables(RootModel[dict[ENVIRONMENT_VARIABLE, str]]):
+    interpolation_pattern: ClassVar[re.Pattern] = re.compile(rf"^\$\{{({ENVIRONMENT_VARIABLE_REGEX})}}$")
+    escaped_interpolation_pattern: ClassVar[re.Pattern] = re.compile(rf"^\$(\$+\{{{ENVIRONMENT_VARIABLE_REGEX}}})$")
+
+    @model_validator(mode="after")
+    def check_environment_variables(self) -> Self:
+        for key, value in self.root.items():
+            if match := self.interpolation_pattern.match(value):
+                interpolated_key = match.group(1)
+                if interpolated_key not in os.environ:
+                    msg = f"Environment variable '{interpolated_key}' not found."
+                    raise ValueError(msg)
+                self.root[key] = os.environ[interpolated_key]
+                _log.debug("Interpolated environment variable: %s=%s.", key, self.root[key])
+            elif match := self.escaped_interpolation_pattern.match(value):
+                self.root[key] = match.group(1)
+                _log.debug("Escaped environment variable: %s=%s.", key, self.root[key])
+        return self
+
+
+class SpecificPackageEnvironmentVariables(Selectable):
+    environment_variables: EnvironmentVariables | None = None
+
+
+class EnvironmentVariablesSettings(BaseModel):
+    global_: EnvironmentVariables = Field(alias="global", default=EnvironmentVariables({}))
+    packages: list[SpecificPackageEnvironmentVariables] = []
+
+
 class CacheSettings(BaseModel):
     size: ByteSize = ByteSize(1 * GiB)
     directory: DirectoryPath = Path("cache").resolve()
@@ -274,6 +318,7 @@ class Settings(BaseSettings):
     webservice: WebserviceSettings
     worker_pool: WorkerPoolSettings
     permissions: PackagePermissionsSettings
+    environment_variables: EnvironmentVariablesSettings
     cache: CacheSettings
     collector: CollectorSettings
     auth: AuthSettings

questionpy_server/web/_routes/_files.py

@@ -9,6 +9,7 @@
 from questionpy_server.web import CURRENT_USER_KEY
 from questionpy_server.web._decorators import ensure_package
 from questionpy_server.web.app import QPyServer
+from questionpy_server.worker.selector import SelectorQuery
 
 file_routes = web.RouteTableDef()
 
@@ -26,10 +27,14 @@ async def serve_static_file(request: web.Request, package: Package) -> web.Respo
         raise HTTPNotImplemented(text="Static file retrieval from non-main packages is not supported yet.")
 
     current_user = request.get(CURRENT_USER_KEY)
-    permissions = qpy_server.package_permissions.get_effective_permissions(package, current_user, "files")
+    selector_query = SelectorQuery(package, current_user, "files")
+    permissions = qpy_server.package_permissions.get(selector_query)
+    environment_variables = qpy_server.environment_variables.get(selector_query)
     location = await package.get_zip_package_location()
 
-    async with qpy_server.worker_pool.get_worker(location, current_user, "files", permissions) as worker:
+    async with qpy_server.worker_pool.get_worker(
+        location, current_user, "files", permissions, environment_variables
+    ) as worker:
         try:
             file = await worker.get_static_file(path)
         except FileNotFoundError as e:

questionpy_server/web/_worker_context.py

@@ -12,6 +12,7 @@
 from questionpy_server.web import CURRENT_USER_KEY
 from questionpy_server.web.app import QPyServer
 from questionpy_server.worker import Worker
+from questionpy_server.worker.selector import SelectorQuery
 
 
 def get_request_info(
@@ -36,14 +37,20 @@ async def worker_context(request: web.Request, package: Package, data: RequestBa
     """Returns the worker context for the given request."""
     qpyserver = request.app[QPyServer.APP_KEY]
     current_user = request.get(CURRENT_USER_KEY)
-    permissions = qpyserver.package_permissions.get_effective_permissions(package, current_user, data.context)
+
+    selector_query = SelectorQuery(package, current_user, data.context)
+    permissions = qpyserver.package_permissions.get(selector_query)
+    environment_variables = qpyserver.environment_variables.get(selector_query)
+
     location = await package.get_zip_package_location()
 
     lms_provided_attributes = None
     if isinstance(data, LmsProvidedAttributesModel):
         lms_provided_attributes = data.lms_provided_attributes
 
-    async with qpyserver.worker_pool.get_worker(location, current_user, data.context, permissions) as worker:
+    async with qpyserver.worker_pool.get_worker(
+        location, current_user, data.context, permissions, environment_variables
+    ) as worker:
         yield WorkerContext(
             worker,
             get_request_info(request, lms_provided_attributes=lms_provided_attributes),

questionpy_server/web/app.py

@@ -14,8 +14,9 @@
 from questionpy_server.collector import PackageCollection
 from questionpy_server.settings import Settings
 from questionpy_server.web.middlewares import middlewares
-from questionpy_server.worker.permissions import PackagePermissionsHandler
 from questionpy_server.worker.pool import WorkerPool
+from questionpy_server.worker.selector.environment_variables import EnvironmentVariablesHandler
+from questionpy_server.worker.selector.permissions import PackagePermissionsHandler
 
 _log = logging.getLogger(__name__)
 
@@ -36,6 +37,7 @@ def __init__(self, settings: Settings):
             settings.worker_pool.max_cpus, settings.worker_pool.max_memory, worker_type=settings.worker_pool.type
         )
         self.package_permissions = PackagePermissionsHandler(settings.permissions)
+        self.environment_variables = EnvironmentVariablesHandler(settings.environment_variables)
 
         cache_supervisor = LRUCacheSupervisor(settings.cache.directory, settings.cache.size)
         self.package_cache = LRUCache(cache_supervisor, Path("packages"), extension=".qpy")

questionpy_server/web/errors.py

@@ -23,6 +23,18 @@ def __init__(self, msg: str, body: RequestError) -> None:
         web_logger.info(msg)
 
 
+class PackageEnvironmentVariablesError(web.HTTPForbidden, _ExceptionMixin):
+    def __init__(self, *, reason: str | None, temporary: bool) -> None:
+        super().__init__(
+            msg="Question package requires environment variables that are not provided by the server",
+            body=RequestError(
+                error_code=RequestErrorCode.PACKAGE_ENVIRONMENT_VARIABLES_ERROR,
+                reason=reason,
+                temporary=temporary,
+            ),
+        )
+
+
 class PackagePermissionError(web.HTTPForbidden, _ExceptionMixin):
     def __init__(self, *, reason: str | None, temporary: bool) -> None:
         super().__init__(
@@ -156,6 +168,7 @@ def __init__(self, *, reason: str | None, temporary: bool) -> None:
 
 QpyWebError = (
     PackagePermissionError
+    | PackageEnvironmentVariablesError
     | WorkerTimeoutError
     | OutOfMemoryError
     | InvalidAttemptStateError