Dev

.github/workflows/build-image.yml

@@ -5,19 +5,19 @@ on:
 
 jobs:
   build-test:
-    runs-on: [self-hosted, build]
+    runs-on: ubuntu-latest
     steps:
       - name: Workflow run cleanup action
         uses: rokroskar/workflow-run-cleanup-action@ee1451b869ba1e381729b3d40489997021f0d562 # v0.3.3
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
 
       - name: Build and publish image to OCI
         id: build
         uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7
         with:
-          file: ./compose/production/django/Dockerfile
+          file: docker/Dockerfile
           push: false
           load: true
           tags: localbuild/testimage:latest

.github/workflows/codeql-analysis.yml

@@ -35,11 +35,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v6
+      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v4
+      uses: github/codeql-action/init@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4
       with:
         languages: ${{ matrix.language }}
         queries: +security-extended, security-and-quality  
@@ -51,7 +51,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v4
+      uses: github/codeql-action/autobuild@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -65,4 +65,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v4
+      uses: github/codeql-action/analyze@e4fba868fa4b1b91e1fdab776edc8cfbe6e9fb81 # v4

.github/workflows/pip_audit.yml

@@ -10,15 +10,15 @@ jobs:
     runs-on: self-hosted
     steps:
       - name: Checkout PR branch
-        uses: actions/checkout@v4
+        uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Set up Python 3.14
-        uses: actions/setup-python@v6
+        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
         with:
           python-version: 3.14
 
-      - uses: pypa/gh-action-pip-audit@v1.1.0
+      - uses: pypa/gh-action-pip-audit@1220774d901786e6f652ae159f7b6bc8fea6d266 # v1.1.0
         with:
           inputs: FastapiOpenRestyConfigurator/requirements.txt

.github/workflows/publish-docker.yml

@@ -8,8 +8,7 @@ on:
       - 'hotfix/**'
 jobs:
   build:
-    runs-on: [self-hosted,bielefeld]
-    concurrency: api
+    runs-on: ubuntu-latest
     steps:
       - name: Clean up repository directory (with elevated privileges) -.pytest_cache
         shell: bash
@@ -41,6 +40,6 @@ jobs:
       - name: Build and publish image to OCI
         uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7
         with:
-          file: compose/production/django/Dockerfile
+          file: docker/Dockerfile
           push: true
           tags: oci.bi.denbi.de/simplevm/forc:${{ steps.tag.outputs.TAG }}

.github/workflows/release_image.yml

@@ -5,7 +5,7 @@ on:
       - '*'
 jobs:
   build_release:
-    runs-on: [self-hosted, production, build]
+    runs-on: ubuntu-latest
 
     steps:
      - name: Clean up repository directory (with elevated privileges) -.pytest_cache
@@ -31,7 +31,7 @@ jobs:
      - name: Build and publish image to OCI
        uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7
        with:
-          file: compose/production/django/Dockerfile
+          file: docker/Dockerfile
           push: true
           tags: oci.bi.denbi.de/simplevm/forc:${{ steps.get_version.outputs.VERSION }}
           load: true

.gitignore

@@ -12,4 +12,5 @@ ansible/test.json
 */.python-version
 FastapiOpenRestyConfigurator/.env
 template_path
-backend_path
+backend_path
+*/plans

.python-version

@@ -1 +1 @@
-3.14.5
+3.14.6

FastapiOpenRestyConfigurator/app/main/config.py

@@ -1,8 +1,10 @@
 import os
 from functools import lru_cache
 
-from pydantic_settings import BaseSettings
-from pydantic import SecretStr, validator, DirectoryPath
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic import SecretStr, field_validator, DirectoryPath
+from pydantic import field_validator, ValidationInfo
+
 basedir = os.path.abspath(os.path.dirname(__file__))
 
 
@@ -11,40 +13,40 @@ class Settings(BaseSettings):
     Settings object.
     Reads settings from .env file.
     """
-    FORC_VERSION: str = '0.2'
+
+    FORC_VERSION: str = "0.2"
     DEBUG: bool = False
     LOG_LEVEL: str = "INFO"
     FORC_API_KEY: SecretStr
-    FORC_SECRET_KEY: SecretStr = 'my_precious_secret_key'
+    FORC_SECRET_KEY: SecretStr = "my_precious_secret_key"
     FORC_BACKEND_PATH: DirectoryPath
     FORC_TEMPLATE_PATH: DirectoryPath
     FORC_USER_PATH: str = "users"
+    CONTAINERIZED: bool = False
 
-    @validator('FORC_USER_PATH', pre=True)
-    def apply_backend_path(cls, v, values):
+    @field_validator("FORC_USER_PATH", mode="before")
+    @classmethod
+    def apply_backend_path(cls, v, info: ValidationInfo):
         """
         Validates forc user path, as it depends on forc backend path.
         :param v: Value for forc user path.
-        :param values: Values already read for settings object.
+        :param info: Validation context containing already validated fields.
         :return: Updated FORC_USER_PATH.
         """
-        # := assigns and compares a value. (if a := b:) == (a = b; if a:)
-        if FORC_BACKEND_PATH := values.get('FORC_BACKEND_PATH'):
-            return f"{FORC_BACKEND_PATH}/{v}"
-        else:
-            # should only happen when there was an error with FORC_BACKEND_PATH
-            return "/var/forc/backend_path/users"
-
-    class Config:
-        """
-        Config for settings object.
-        """
-        # Enabled case sensitive for reading variables from .env file
-        case_sensitive = True
-        # Path to .env file
-        env_file = ".env"
-        # Encoding of .env file
-        env_file_encoding = "utf-8"
+        forc_backend_path = info.data.get("FORC_BACKEND_PATH")
+
+        if forc_backend_path:
+            return f"{forc_backend_path}/{v}"
+
+        # should only happen when there was an error with FORC_BACKEND_PATH
+        return "/var/forc/backend_path/users"
+
+    model_config = SettingsConfigDict(
+        case_sensitive=True,
+        env_file=".env",
+        env_file_encoding="utf-8",
+        extra="ignore"
+    )
 
 
 @lru_cache()

FastapiOpenRestyConfigurator/app/main/model/serializers.py

@@ -28,9 +28,11 @@
 
 owner_regex = r'^[a-zA-Z0-9@.-]{30,}$'
 user_key_url_regex = r"^[a-zA-Z0-9_-]{3,25}$"
-upstream_url_regex = r"^(https?)://(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):(\d{1,5})$"
+upstream_url_regex = r"^(https?)://(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):(\d{1,5})(/[a-zA-Z0-9_-]+/)?$"
 
 
+# TODO: needs refactoring to comply with python 3.10 and pydantic v2
+
 class BackendBase(BaseModel):
     """
     Base class for backend.
@@ -53,6 +55,12 @@ class BackendBase(BaseModel):
         description="Version of the template the backend refers to.",
         example="v04"
     )
+    auth_enabled: bool = Field(
+        True,
+        title="Authorization for the research environment",
+        description="If set to true, only the owner of the backend is allowed to access it.",
+        example=False
+    )
 
     @validator("owner")
     def owner_validation(cls, owner):
@@ -82,7 +90,7 @@ class BackendIn(BackendBase):
         ...,
         title="Upstream URL",
         description="Inject the full url (with protocol) for the real location of the backend service in the template.",
-        example="http://192.168.0.1:8787/"
+        example="http://192.168.0.1:8787/guacamole/"
     )
 
     @validator("user_key_url")
@@ -113,7 +121,7 @@ class BackendOut(BackendBase):
     """
     Backend class which holds information needed when returning a backend.
     """
-    id: int = Field(
+    id: int = Field( # TODO: needs refactoring: change type to int and rename to backend_id
         ...,
         title="ID",
         description="ID of the backend.",
@@ -136,13 +144,15 @@ class BackendTemp(BackendIn, BackendOut):
     """
     Backend class to temporarily save information. Links BackendIn with BackendOut.
     """
-    id: int = None
+    id: int = None # TODO: also needs refactoring: change type to int and rename to backend_id
     owner: str = None
     location_url: str = None
     template: str = None
     template_version: str = None
     user_key_url: str = None
     upstream_url: str = None
+    auth_enabled: bool = None
+    file_path: str = None
 
 
 class Template(BaseModel):