Release/2.5.0

.github/workflows/lint-check.yml

@@ -1,7 +1,9 @@
 name: Lint Check
 
 on:
-  push
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ develop ]
 
 jobs:
   lint:

application-templates/django-app/backend/django_baseapp/asgi.py → application-templates/django-base/backend/django_baseapp/asgi.py

@@ -11,7 +11,7 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "__APP_NAME__.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_baseapp.settings")
 
 application = get_asgi_application()
 
@@ -21,6 +21,6 @@
 init_services()
 
 # start the kafka event listener
-from cloudharness_django.services.events import init_listner  # noqa E402
+from cloudharness_django.services.events import init_listener  # noqa E402
 
-init_listner()
+init_listener()

application-templates/django-app/backend/django_baseapp/wsgi.py → application-templates/django-base/backend/django_baseapp/wsgi.py

@@ -21,6 +21,6 @@
 init_services()
 
 # start the kafka event listener
-from cloudharness_django.services.events import init_listner  # noqa E402
+from cloudharness_django.services.events import init_listener  # noqa E402
 
-init_listner()
+init_listener()

application-templates/django-app/Dockerfile → application-templates/django-fastapi/Dockerfile

@@ -7,11 +7,11 @@ ENV APP_DIR=/app
 
 WORKDIR ${APP_DIR}
 COPY frontend/package.json ${APP_DIR}
-COPY frontend/package-lock.json ${APP_DIR}
-RUN npm ci
+COPY frontend/yarn.lock ${APP_DIR}
+RUN yarn install --frozen-lockfile --timeout 60000
 
 COPY frontend ${APP_DIR}
-RUN npm run build
+RUN yarn build
 
 #####
 

application-templates/django-app/README.md → application-templates/django-fastapi/README.md

@@ -31,7 +31,7 @@ See [backend/README.md#Develop]
 
 ### Frontend
 
-Backend code is inside the *frontend* directory.
+Frontend code is inside the *frontend* directory.
 
 Frontend is by default generated as a React web application, but no constraint about this specific technology.
 

application-templates/django-fastapi/api/genapi.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+ROOT_PATH=$(realpath "$(dirname "$BASH_SOURCE")/../../..")
+harness-generate servers --app-name "__APP_NAME__" "$ROOT_PATH"

application-templates/django-ninja/Dockerfile

@@ -0,0 +1,35 @@
+ARG CLOUDHARNESS_FRONTEND_BUILD
+ARG CLOUDHARNESS_DJANGO
+
+FROM $CLOUDHARNESS_FRONTEND_BUILD AS frontend
+
+ARG APP_DIR=/app
+
+WORKDIR ${APP_DIR}
+COPY frontend/package.json .
+COPY frontend/yarn.lock .
+RUN yarn install --timeout 60000
+
+COPY frontend .
+RUN yarn build
+
+#####
+
+FROM $CLOUDHARNESS_DJANGO
+
+WORKDIR ${APP_DIR}
+RUN mkdir -p ${APP_DIR}/static/www
+
+COPY backend/requirements.txt ${APP_DIR}
+RUN --mount=type=cache,target=/root/.cache python -m pip install --upgrade pip &&\
+    pip3 install --no-cache-dir -r requirements.txt --prefer-binary
+
+COPY backend/requirements.txt backend/setup.py ${APP_DIR}
+RUN python3 -m pip install -e .
+
+COPY backend ${APP_DIR}
+RUN python3 manage.py collectstatic --noinput
+
+COPY --from=frontend /app/dist ${APP_DIR}/static/www
+
+ENTRYPOINT uvicorn --workers ${WORKERS} --host 0.0.0.0 --port ${PORT} django_baseapp.asgi:application

application-templates/django-ninja/README.md

@@ -0,0 +1,114 @@
+# __APP_NAME__
+
+Django-Ninja/React-based web application.
+This application is constructed to be deployed inside a cloud-harness Kubernetes.
+It can be also run locally for development and test purpose.
+
+The code is generated with the script `harness-application`.
+
+## Configuration
+
+### Accounts
+
+The CloudHarness Django application template comes with a configuration that can retrieve user account updates from Keycloak (accounts)
+To enable this feature:
+* log in into the accounts admin interface
+* select in the left sidebar Events
+* select the `Config` tab
+* enable "metacell-admin-event-listener" under the `Events Config` - `Event Listeners`
+
+An other option is to enable the "metacell-admin-event-listener" through customizing the Keycloak realm.json from the CloudHarness repository.
+
+## Develop
+
+This application is composed of a Django-Ninja backend and a React frontend.
+
+### Backend
+
+Backend code is inside the *backend* directory.
+See [backend/README.md#Develop]
+
+### Frontend
+
+Frontend code is inside the *frontend* directory.
+
+Frontend is by default generated as a React web application, but no constraint about this specific technology.
+
+See also [frontend/README.md]
+
+#### Generate API client stubs
+All the api stubs are automatically generated in the [frontend/rest](frontend/rest) directory by `harness-application`
+and `harness-generate`.
+
+To update frontend client stubs, run
+
+```
+harness-generate clients __APP_NAME__ -t
+```
+
+Stubs can also be updated using the `genapi.sh` from the api folder.
+
+## Local build & run
+
+### Install Python dependencies 
+1 - Clone cloud-harness into your project root folder 
+
+2 - Run the dev setup script
+```
+cd applications/__APP_NAME__
+source dev-setup.sh
+```
+
+### Prepare backend
+
+Create a Django local superuser account, this you only need to do on initial setup
+```bash
+cd backend
+python3 manage.py migrate # to sync the database with the Django models
+python3 manage.py collectstatic --noinput # to copy all assets to the static folder
+python3 manage.py createsuperuser
+# link the frontend dist to the django static folder, this is only needed once, frontend updates will automatically be applied
+cd static/www
+ln -s ../../../frontend/dist dist
+```
+
+### Run frontend
+
+- `yarn dev` Local dev with no backend (no or mock data, cookie required)
+- `yarn start` Local dev with backend on localhost:8000 -- see next paragraph (cookie required)
+- `yarn start:dev` Local dev with backend on the remote dev deployment  (cookie required)
+- `yarn start:local` Local dev with backend on the local dev deployment on mnp.local (cookie required)
+
+To obtain the login cookie, login in the application with the forwarded backend, copy the `kc-access` cookie and set it into localhost:9000
+
+### Run backend application
+
+start the Django server
+
+```bash
+ACCOUNTS_ADMIN_PASSWORD=metacell ACCOUNTS_ADMIN_USERNAME=admin CH_CURRENT_APP_NAME=__APP_NAME__ CH_VALUES_PATH=../../../deployment/helm/values.yaml DJANGO_SETTINGS_MODULE=django_baseapp.settings KUBERNETES_SERVICE_HOST=a uvicorn --host 0.0.0.0 --port 8000 django_baseapp.asgi:application
+```
+
+Before running this backend, have to:
+- Run `harness-deployment ... -n [NAMESPACE] -i __APP_NAME__` with the setup 
+- port-forward keycloak and the database (see below)
+
+### Running local with port forwardings to a kubernetes cluster
+When you create port forwards to microservices in your k8s cluster you want to forced your local backend server to initialize
+the AuthService and EventService services.
+This can be done by setting the `KUBERNETES_SERVICE_HOST` environment variable to a dummy or correct k8s service host.
+The `KUBERNETES_SERVICE_HOST` switch will activate the creation of the keycloak client and client roles of this microservice.
+
+Run `port-forward.sh` to get the keycloak and database running.
+
+To access those have to map to the hosts file:
+
+```
+127.0.0.1 accounts.[NAMESPACE] __APP_NAME__-db
+```
+
+After running the backend on port 8000, run `yarn start` to get a frontend to it
+
+#### Vs code run configuration
+
+Run configuration is automatically generated for VS code (__APP_NAME__ backend)

application-templates/django-ninja/backend/__APP_NAME__/api/__init__.py

@@ -0,0 +1,40 @@
+import time
+from django.http import HttpRequest
+from ninja import NinjaAPI
+from ..exceptions import Http401, Http403
+
+
+api = NinjaAPI(title='__APP_NAME__ API', version='0.1.0')
+
+
+@api.exception_handler(Http401)
+def unauthorized(request, exc):
+    return api.create_response(
+        request,
+        {'message': 'Unauthorized'},
+        status=401,
+    )
+
+
+@api.exception_handler(Http403)
+def forbidden(request, exc):
+    return api.create_response(
+        request,
+        {'message': 'Forbidden'},
+        status=403,
+    )
+
+
+@api.get('/ping', response={200: float}, tags=['test'])
+def ping(request: HttpRequest):
+    return time.time()
+
+
+@api.get('/live', response={200: str}, tags=['test'])
+def live(request: HttpRequest):
+    return 'OK'
+
+
+@api.get('/ready', response={200: str}, tags=['test'])
+def ready(request: HttpRequest):
+    return 'OK'

application-templates/django-ninja/backend/__APP_NAME__/exceptions.py

@@ -0,0 +1,6 @@
+class Http401(Exception):
+    pass
+
+
+class Http403(Exception):
+    pass

application-templates/django-ninja/backend/__APP_NAME__/schema.py

@@ -0,0 +1,3 @@
+from ninja import Schema
+
+# Create your schema here