Merge branch 'develop' into staging

Author: alfredeen

.github/workflows/ci.yaml

@@ -44,7 +44,7 @@ jobs:
           whoami
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Prepare repository
         run: |

.github/workflows/e2e-tests.yaml

@@ -42,7 +42,7 @@ jobs:
           whoami
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Prepare repository
         run: |
@@ -58,7 +58,7 @@ jobs:
           echo -e "UID=1001\nGID=127" > .env
 
       - name: A job to install MicroK8s
-        uses: balchua/microk8s-actions@v0.3.2
+        uses: balchua/microk8s-actions@v0.4.2
         with:
           channel: '1.28/stable'
           addons: '["dns", "rbac", "hostpath-storage", "ingress", "helm"]'
@@ -143,3 +143,7 @@ jobs:
         with:
           ## If no one connects after 2 minutes, shut down server.
           wait-timeout-minutes: 2
+          ## limits ssh access and adds the ssh public key for the user which triggered the workflow
+          limit-access-to-actor: true
+          ## limits ssh access and adds the ssh public keys of the listed GitHub users
+          limit-access-to-users: sandstromviktor,churnikov,hamzaimran08,alfredeen,akochari

.github/workflows/pre-commit.yaml

@@ -15,10 +15,10 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: 3.8
 

.github/workflows/publish.yaml

@@ -7,6 +7,21 @@ on:
   push:
     tags:
       - 'v*'
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: 'Log level'
+        required: true
+        default: 'warning'
+        type: choice
+        options:
+        - info
+        - warning
+        - debug
+      tags:
+        description: 'Manual run'
+        required: false
+        type: boolean
 
 jobs:
   publish-on-success:
@@ -16,6 +31,8 @@ jobs:
         (github.event_name == 'push' && contains(github.ref, 'refs/tags/'))
         ||
         (github.event.workflow_run.conclusion == 'success')
+        ||
+        (github.event_name == 'workflow_dispatch')
       )
     runs-on: ubuntu-20.04
     strategy:
@@ -31,7 +48,7 @@ jobs:
       contents: read
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set current date as env variable
         run: echo "BUILD_DATE=$(date +'%Y-%m-%d')" >> $GITHUB_ENV
@@ -45,35 +62,35 @@ jobs:
             type=raw,value={{date 'YYYYMMDD'}},prefix=${{ github.ref_name }}-
 
       - name: Set the build date project toml file
-        uses: ciiiii/toml-editor@1.0.0
+        uses: sandstromviktor/toml-editor@2.0.0
         with:
           file: "pyproject.toml"
           key: "tool.serve.build-date"
           value: ${{ env.BUILD_DATE }}
 
       - name: Set the git tag or branch name in the project toml file
-        uses: ciiiii/toml-editor@1.0.0
+        uses: sandstromviktor/toml-editor@2.0.0
         with:
           file: "pyproject.toml"
           key: "tool.serve.gitref"
           value: ${{ github.ref_name }}
 
       - name: Set the image tag in the project toml file
-        uses: ciiiii/toml-editor@1.0.0
+        uses: sandstromviktor/toml-editor@2.0.0
         with:
           file: "pyproject.toml"
           key: "tool.serve.imagetag"
           value: ${{ steps.meta.outputs.version }}
 
       - name: Log in to ghcr.io
-        uses: docker/login-action@v1
+        uses: docker/login-action@v3
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: docker build serve
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: "${{ github.event_name != 'pull_request' }}"

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
   - id: detect-private-key
   - id: mixed-line-ending
   - id: end-of-file-fixer
-    exclude: static/vendor/
+    exclude: static/vendor/|static/wiki/
   - id: pretty-format-json
     exclude: ^fixtures/
     args: [--autofix]

Dockerfile

@@ -27,7 +27,7 @@ RUN apk add --update --no-cache \
 # Installing Pillow separate from the packages in requirements
 # greatly speeds up the docker build.
 RUN python3 -m pip install --upgrade pip \
-    && python3 -m pip install Pillow==10.1.0 --global-option="build_ext" --global-option="--disable-tiff" --global-option="--disable-freetype" --global-option="--disable-lcms" --global-option="--disable-webp" --global-option="--disable-webpmux" --global-option="--disable-imagequant" --global-option="--disable-xcb"
+    && python3 -m pip install Pillow==10.2.0 --global-option="build_ext" --global-option="--disable-tiff" --global-option="--disable-freetype" --global-option="--disable-lcms" --global-option="--disable-webp" --global-option="--disable-webpmux" --global-option="--disable-imagequant" --global-option="--disable-xcb"
 
 FROM bitnami/kubectl:1.28.2 as kubectl
 FROM alpine/helm:3.12.3 as helm

api/APIpermissions.py

@@ -25,6 +25,7 @@ def has_permission(self, request, view):
         """
         Should simply return, or raise a 403 response.
         """
+        # To implement expiring tokens, can access the token here: request.auth
         is_authorized = False
 
         if request.user.is_superuser:

api/public_views.py

@@ -13,3 +13,12 @@ def get_studio_settings(request):
     studio_settings.append(studio_url)
 
     return JsonResponse({"data": studio_settings})
+
+
+def are_you_there(request):
+    """
+    Most simple API endpoint useful for testing
+    and verifications.
+    :returns bool: true
+    """
+    return JsonResponse({"status": True})

api/urls.py

@@ -3,7 +3,7 @@
 from django.urls import path
 from rest_framework_nested import routers
 
-from .public_views import get_studio_settings
+from .public_views import are_you_there, get_studio_settings
 from .views import (
     AppInstanceList,
     AppList,
@@ -21,6 +21,7 @@
     ReleaseNameList,
     ResourceList,
     S3List,
+    update_app_status,
 )
 
 app_name = "api"
@@ -50,6 +51,10 @@
     path("", include(router_drf.urls)),
     path("", include(router.urls)),
     path("", include(models_router.urls)),
+    # Generic API endpoints
+    path("are-you-there/", are_you_there),
+    # Internal API endpoints
     path("token-auth/", CustomAuthToken.as_view(), name="api_token_auth"),
     path("settings/", get_studio_settings),
+    path("app-status/", update_app_status),
 ]

api/views.py

@@ -1,15 +1,19 @@
 import json
 import time
+from datetime import datetime
 
+import pytz
 from django.conf import settings
 from django.contrib.auth.models import User
+from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import Q
 from django.http import HttpResponse
 from django.utils.text import slugify
 from django_filters.rest_framework import DjangoFilterBackend
 from rest_framework import generics
 from rest_framework.authtoken.models import Token
 from rest_framework.authtoken.views import ObtainAuthToken
+from rest_framework.decorators import api_view, permission_classes
 from rest_framework.mixins import (
     CreateModelMixin,
     ListModelMixin,
@@ -20,7 +24,8 @@
 from rest_framework.response import Response
 from rest_framework.viewsets import GenericViewSet
 
-from apps.models import AppCategories, AppInstance, Apps
+from apps.helpers import HandleUpdateStatusResponseCode, handle_update_status_request
+from apps.models import AppCategories, AppInstance, Apps, AppStatus
 from apps.tasks import delete_resource
 from models.models import ObjectType
 from portal.models import PublishedModel
@@ -815,3 +820,97 @@ def create(self, request, *args, **kwargs):
         except Exception as err:
             print(err)
         return HttpResponse("Created new template: {}.".format(name), status=200)
+
+
+@api_view(["GET", "POST"])
+@permission_classes(
+    (
+        IsAuthenticated,
+        AdminPermission,
+    )
+)
+def update_app_status(request):
+    """
+    Manages the app instance status.
+    Implemented as a DRF function based view.
+    Supports GET and POST verbs.
+
+    The service contract for the POST actions is as follows:
+    :param release str: The release id of the app instance, stored in the AppInstance.parameters dict.
+    :param new-status str: The new status code.
+    :param event-ts timestamp: A JSON-formatted timestamp, e.g. 2024-01-25T16:02:50.00Z.
+    :param event-msg json dict: An optional json dict containing pod-msg and/or container-msg.
+    :returns: An http status code and status text.
+    """
+
+    # POST verb
+    if request.method == "POST":
+        print("INFO: API method update_app_status called with POST verb.")
+
+        utc = pytz.UTC
+
+        try:
+            # Parse and validate the input
+
+            # Required input
+            release = request.data["release"]
+            new_status = request.data["new-status"]
+
+            event_ts = datetime.strptime(request.data["event-ts"], "%Y-%m-%dT%H:%M:%S.%fZ")
+            event_ts = utc.localize(event_ts)
+
+            # Optional
+            event_msg = request.data.get("event-msg", None)
+
+        except KeyError as err:
+            print(f"API method called with invalid input. Missing required input parameter: {err}")
+            return Response(f"Invalid input. Missing required input parameter: {err}", 400)
+
+        except Exception as err:
+            print(f"API method called with invalid input:  {err}, {type(err)}")
+            return Response(f"Invalid input. {err}", 400)
+
+        print(f"DEBUG: API method update_app_status input: {release=}, {new_status=}, {event_ts=}, {event_msg=}")
+
+        try:
+            result = handle_update_status_request(release, new_status, event_ts, event_msg)
+
+            if result == HandleUpdateStatusResponseCode.NO_ACTION:
+                return Response(
+                    "OK. NO_ACTION. No action performed. Possibly the event time is older \
+                    than the currently stored time.",
+                    200,
+                )
+
+            elif result == HandleUpdateStatusResponseCode.CREATED_FIRST_STATUS:
+                return Response("OK. CREATED_FIRST_STATUS. Created a missing AppStatus.", 200)
+
+            elif result == HandleUpdateStatusResponseCode.UPDATED_STATUS:
+                return Response(
+                    "OK. UPDATED_STATUS. Updated the app status. \
+                    Determined that the submitted event was newer and different status.",
+                    200,
+                )
+
+            elif result == HandleUpdateStatusResponseCode.UPDATED_TIME_OF_STATUS:
+                return Response(
+                    "OK. UPDATED_TIME_OF_STATUS. Updated only the event time of the status. \
+                    Determined that the new and old status codes are the same.",
+                    200,
+                )
+
+            else:
+                print(f"Unknown return code from handle_update_status_request() = {result}")
+                return Response(f"Unknown return code from handle_update_status_request() = {result}", 500)
+
+        except ObjectDoesNotExist:
+            print(f"The specified app instance was not found {release=}.")
+            return Response(f"The specified app instance was not found {release=}.", 404)
+
+        except Exception as err:
+            print(f"Unable to update the status of the specified app instance {release=}. {err}, {type(err)}")
+            return Response(f"Unable to update the status of the specified app instance {release=}.", 500)
+
+    # GET verb
+    print("API method update_app_status called with GET verb.")
+    return Response({"message": "DEBUG: GET"})

apps/admin.py

@@ -35,7 +35,17 @@ def display_project(self, obj):
         return obj.project.name
 
 
+class AppStatusAdmin(admin.ModelAdmin):
+    list_display = (
+        "appinstance",
+        "status_type",
+        "time",
+    )
+
+    list_filter = ["appinstance", "status_type", "time"]
+
+
 admin.site.register(AppInstance, AppInstanceAdmin)
 admin.site.register(AppCategories)
 admin.site.register(ResourceData)
-admin.site.register(AppStatus)
+admin.site.register(AppStatus, AppStatusAdmin)

apps/controller.py

@@ -22,7 +22,7 @@ def delete(options):
 
 def deploy(options):
     print("STARTING DEPLOY FROM CONTROLLER")
-    _ = os.environ["BASE_PATH"]
+
     app = Apps.objects.get(slug=options["app_slug"], revision=options["app_revision"])
     if app.chart_archive and app.chart_archive != "":
         try:
@@ -41,6 +41,37 @@ def deploy(options):
     if "release" not in options:
         print("Release option not specified.")
         return json.dumps({"status": "failed", "reason": "Option release not set."})
+    if "appconfig" in options:
+        # check if path is root path
+        if "path" in options["appconfig"]:
+            if "/" == options["appconfig"]["path"]:
+                print("Root path cannot be copied.")
+                return json.dumps({"status": "failed", "reason": "Cannot copy / root path."})
+        # check if valid userid
+        if "userid" in options["appconfig"]:
+            try:
+                userid = int(options["appconfig"]["userid"])
+            except Exception as ex:
+                print("Userid not a number.")
+                print(ex)
+                return json.dumps({"status": "failed", "reason": "Userid not an integer."})
+            if userid > 1010 or userid < 999:
+                print("Userid outside of allowed range.")
+                return json.dumps({"status": "failed", "reason": "Userid outside of allowed range."})
+        else:
+            # if no userid, then add default id of 1000
+            options["appconfig"]["userid"] = "1000"
+        # check if valid port
+        if "port" in options["appconfig"]:
+            try:
+                port = int(options["appconfig"]["port"])
+            except Exception as ex:
+                print("Userid not a number.")
+                print(ex)
+                return json.dumps({"status": "failed", "reason": "Port not an integer."})
+            if port > 9999 or port < 3000:
+                print("Port outside of allowed range.")
+                return json.dumps({"status": "failed", "reason": "Port outside of allowed range."})
 
     # Save helm values file for internal reference
     unique_filename = "charts/values/{}-{}.yaml".format(str(uuid.uuid4()), str(options["app_name"]))