.devcontainer/copy-kube-config.sh

+#!/bin/bash -i
+
+# Copies localhost's ~/.kube/config file into the container and swap out localhost
+# for host.docker.internal whenever a new shell starts to keep them in sync.
+if [ "$SYNC_LOCALHOST_KUBECONFIG" = "true" ] && [ -d "/usr/local/share/kube-localhost" ]; then
+    mkdir -p $HOME/.kube
+    sudo cp -r /usr/local/share/kube-localhost/* $HOME/.kube
+    sudo chown -R $(id -u) $HOME/.kube
+    sed -i -e "s/localhost/host.docker.internal/g" $HOME/.kube/config
+    sed -i -e "s/127.0.0.1/host.docker.internal/g" $HOME/.kube/config
+
+    # If .minikube was mounted, set up client cert/key
+    if [ -d "/usr/local/share/minikube-localhost" ]; then
+        mkdir -p $HOME/.minikube
+        if [ -f "/usr/local/share/minikube-localhost/ca.crt" ]; then
+            sudo cp -r /usr/local/share/minikube-localhost/ca.crt $HOME/.minikube
+        fi
+        # Location varies between versions of minikube
+        if [ -f "/usr/local/share/minikube-localhost/client.crt" ]; then
+            sudo cp -r /usr/local/share/minikube-localhost/client.crt $HOME/.minikube
+            sudo cp -r /usr/local/share/minikube-localhost/client.key $HOME/.minikube
+        elif [ -f "/usr/local/share/minikube-localhost/profiles/minikube/client.crt" ]; then
+            sudo cp -r /usr/local/share/minikube-localhost/profiles/minikube/client.crt $HOME/.minikube
+            sudo cp -r /usr/local/share/minikube-localhost/profiles/minikube/client.key $HOME/.minikube
+        fi
+        sudo chown -R $(id -u) $HOME/.minikube
+
+        # Point .kube/config to the correct locaiton of the certs
+        sed -i -r "s|(\s*certificate-authority:\s).*|\\1$HOME\/.minikube\/ca.crt|g" $HOME/.kube/config
+        sed -i -r "s|(\s*client-certificate:\s).*|\\1$HOME\/.minikube\/client.crt|g" $HOME/.kube/config
+        sed -i -r "s|(\s*client-key:\s).*|\\1$HOME\/.minikube\/client.key|g" $HOME/.kube/config
+    fi
+fi

.devcontainer/devcontainer.json

+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/python-3
+{
+	"name": "TJTS5901 Dev Environment",
+	// Use docker-compose to setup the container
+	// https://code.visualstudio.com/docs/containers/docker-compose
+	"dockerComposeFile": [
+		"../docker-compose.yml"
+	],
+
+	"service": "tjts5901",
+
+	// Don't start flask app by default.
+	"overrideCommand": true,
+
+	// Use /app -folder as a workspace folder. Otherwise it will depend on repository name.
+	"workspaceFolder": "/app",
+
+	"remoteEnv": {
+		// If you do not want to sync your host .kube folder with the devcontainer, set this to false.
+		// https://github.com/Microsoft/vscode-dev-containers/tree/main/containers/kubernetes-helm
+		"SYNC_LOCALHOST_KUBECONFIG": "true",
+		// Setup flask debug mode to be on in devcontainer
+		"FLASK_DEBUG": "1",
+		// Pass in the host directory for Docker mount commands from inside the container
+		//"HOST_PROJECT_PATH": "${localWorkspaceFolder}"
+	},
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Set *default* container specific settings.json values on container create.
+			"settings": { 
+				"python.defaultInterpreterPath": "/usr/local/bin/python",
+				"python.linting.enabled": true,
+				"python.linting.pylintEnabled": true,
+				"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+				"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+				"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+				"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+				"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+				"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+				"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+				"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+				"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+				"python.unitTest.pyTestEnabled": true,
+				"python.unitTest.pyTestArgs": [
+					"--exitfirst",
+					"--verbose",
+					"--color=auto"
+				],
+				"[python]": {
+					"editor.rulers": [120]
+				},
+				// Enable the terminal to be used as the default shell.
+				"terminal.integrated.shellIntegration.enabled": true,
+				"gitlab.showPipelineUpdateNotifications": true
+			},
+
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"ms-python.python",
+				"ms-azuretools.vscode-docker",
+				"redhat.vscode-yaml",
+				"GitLab.gitlab-workflow",
+				"samuelcolvin.jinjahtml"
+			]
+		}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [ 5001 ],
+
+	// Uncomment the next line if you want start specific services in your Docker Compose config.
+	// "runServices": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// Here we install kube sync support
+	"postCreateCommand": "/bin/sh .devcontainer/post-create.sh",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+
+	"features": {
+		"docker-from-docker": "latest",
+		"kubectl-helm-minikube": {
+			"version": "1.24",
+			"minikube": "none",
+		},
+		// "terraform": "latest",
+		"azure-cli": {
+			"version": "lts"
+		}
+	}
+}

.devcontainer/post-create.sh

+#!/bin/sh
+
+# This file is ran after devcontainer is created.
+
+# Copy kube config to the container
+echo "source $PWD/.devcontainer/copy-kube-config.sh" | tee -a $HOME/.bashrc $HOME/.zshrc >> /dev/null

.gitignore

@@ -159,4 +159,12 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-.env
+# vs code personal workspace file
\ No newline at end of file
+.vscode/settings.json
+
+_docs/
+.env
+.DS_Store
+
+# Ignore certificates
+azure-sp.pem

.gitlab-ci.yml

+## Stage names in the pipeline.
+stages:
+  - build
+  - test
+  - staging
+  - smoketest
+  - deploy
+
+variables:
+  ## Name for the generated image. Change this if you wish, but watch out
+  ## for special characters and spaces!
+  DOCKER_IMAGE_NAME: ${DOCKER_REGISTRY}/tjts5901
+  DOCKER_TAG: ${CI_COMMIT_REF_SLUG}
+
+  ## (Optional) More verbose output from pipeline. Enabling it might reveal secrets.
+  #CI_DEBUG_TRACE: "true"
+
+include:
+  - template: Jobs/SAST.gitlab-ci.yml
+
+## Use buildkit to build the container.
+## Buildkit: https://github.com/moby/buildkit
+## Example gitlab-ci buildkit template: https://gitlab.com/txlab/ci-templates
+build:
+  stage: build
+  image:
+    name: moby/buildkit:v0.10.6-rootless
+    entrypoint: [ "sh", "-c" ]
+  variables:
+    BUILDKITD_FLAGS: --oci-worker-no-process-sandbox
+
+  before_script:
+    ## Make some checks that Docker credentials are configured.
+    - test -z "${DOCKER_REGISTRY}" && (echo "Missing required variable DOCKER_REGISTRY. See 'Pipeline setup.md'"; exit 1)
+    - test -z "${DOCKER_AUTH_CONFIG}" && (echo "Missing required variable DOCKER_AUTH_CONFIG. See 'Pipeline setup.md'"; exit 1)
+    - test -z "${DOCKER_IMAGE_NAME}" && (echo "Missing image name variable."; exit 1)
+    ## Save docker login credentials from gitlab into a place where buildkit is looking for them.
+    - mkdir -p ${HOME}/.docker && echo "${DOCKER_AUTH_CONFIG}" > "${HOME}/.docker/config.json"
+    ## Simple check that the registry exists in login information
+    - grep "\\b${DOCKER_REGISTRY}\\b" "${HOME}/.docker/config.json" || (echo "Could not find docker registry in docker login information. Check DOCKER_AUTH_CONFIG"; exit 1)
+
+  script:
+    # Build the image, and push it to registry.
+    - |
+      buildctl-daemonless.sh build  --progress=plain \
+          --frontend=dockerfile.v0 \
+          --local context=. \
+          --local dockerfile=. \
+          --opt build-arg:CI_COMMIT_SHA=${CI_COMMIT_SHA} \
+          --output type=image,name=${DOCKER_IMAGE_NAME}:${DOCKER_TAG},push=true
+
+
+sast:
+    ## Static Application Security Test
+    ## You can override the included template(s) by including variable overrides
+    ## SAST customization:
+    ##   https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
+    stage: test
+
+
+## Run the tests. If any of the tests fails, pipeline is rejected.
+test:
+  ## Optional: include stage and environment name
+  stage: test
+  image: ${DOCKER_IMAGE_NAME}:${DOCKER_TAG}
+  variables:
+    ## Setup variable pointin to mongo service
+    ## Notice: the `mongo` address might not work.
+    MONGO_URL: mongodb://mongo/tjts5901-test
+
+  ## When job is started, also start these things
+  services:
+    - name: mongo:4.2  # update to reflect same version used on production
+      alias: mongo
+  script:
+      - pip install --disable-pip-version-check -e /app[test]
+      ## Run tests with coverage reporting
+      - coverage run -m pytest
+      ## Run basic reporting for badge
+      - coverage report
+      ## Generate detailed report for gitlab annotations.
+      - coverage xml -o coverage.xml
+
+  coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+
+## Job to setup new staging job.
+deploy to staging:
+    stage: staging
+    ## Only run this stage when main branch receives changes.
+    only:
+        - main
+
+    ## Use microsoft provided azure cli image, that contains az cli.
+    image: mcr.microsoft.com/azure-cli
+
+    ## Setup the environment variables. The can be accessed through the gitlab 
+    ## Deployments -> Environments. Generates url based on the app and branch name.
+    environment:
+        name: $CI_JOB_STAGE
+        url: https://${AZURE_APP_NAME}-${CI_ENVIRONMENT_SLUG}.azurewebsites.net
+
+    before_script:
+        ## Make sanity check that gitlab variables stage is done.
+        - test -z "${AZURE_SP_NAME}" && (echo "Missing required variable AZURE_SP_NAME. See 'Staging.md'"; exit 1)
+        - test -f "${AZURE_SP_CERT}" || ( echo "AZURE_SP_CERT (${AZURE_SP_CERT}) file is missing!"; exit 1)
+
+        - test -z "${AZURE_APP_NAME}" && (echo "Missing required variable AZURE_APP_NAME. See 'Staging.md'"; exit 1)
+        - test -z "${AZURE_RESOURCE_GROUP}" && (echo "Missing required variable DOCKER_AUTH_CONFIG. See 'Staging.md'"; exit 1)        
+        
+        ## Login into azure
+        - az login --service-principal -u "${AZURE_SP_NAME}" -p "${AZURE_SP_CERT}" --tenant "jyu.onmicrosoft.com"
+
+    script:
+        ## Create staging slot and copy settings from production
+        - |
+          az webapp deployment slot create -n "$AZURE_APP_NAME" -g "$AZURE_RESOURCE_GROUP" \
+            --slot "$CI_ENVIRONMENT_SLUG" --configuration-source "$AZURE_APP_NAME"
+
+        ## TODO: Create a snapshot of database, and use it.
+
+        ## If you need to change settings see: https://docs.microsoft.com/en-us/cli/azure/webapp/config/appsettings
+
+        ## Change container tag to reflect branch we're running on
+        - |
+          az webapp config container set -n "$AZURE_APP_NAME" -g "$AZURE_RESOURCE_GROUP" \
+            --docker-custom-image-name "${DOCKER_IMAGE_NAME}:${DOCKER_TAG}" -s "$CI_ENVIRONMENT_SLUG"
+
+        ## In case slot already existed, restart the slot
+        - az webapp restart -n "$AZURE_APP_NAME" -g "$AZURE_RESOURCE_GROUP" -s "$CI_ENVIRONMENT_SLUG"
+
+        ## Restart is not immediate, it takes a sec or two, depending on container changes.
+        - sleep 20
+
+        ## Store server info as artifact for prosperity
+        - curl "$CI_ENVIRONMENT_URL/server-info" -o server-info.json
+
+    artifacts:
+        paths:
+            - server-info.json
+
+
+## Run smoketest to check that staging app is responding as expected.
+staging smoketest:
+    stage: smoketest
+    image: ${DOCKER_IMAGE_NAME}:${DOCKER_TAG}
+    environment:
+        name: staging
+        url: https://${AZURE_APP_NAME}-${CI_ENVIRONMENT_SLUG}.azurewebsites.net
+
+    only:
+        - main
+
+    script:
+        - pip install --disable-pip-version-check -e .[test]
+        ## Environment url can be inherited from CI_ENVIROMNENT_URL, which is one defined
+        ## in the `environment.url:`. Using it here explicitly.
+        - echo "Testing againsta deployment address ${CI_ENVIROMNENT_URL}"
+        - pytest -v --environment-url="${CI_ENVIROMNENT_URL}" tests/test_smoke.py
+
+
+## Push latest image into registry with the `latest` tag.
+docker tag latest:
+  stage: deploy
+
+  environment:
+    name: production
+
+  image: docker:20.10.23
+  only:
+    - main
+  script:
+    ## Copy credentials to container
+    - mkdir -p ${HOME}/.docker && echo "${DOCKER_AUTH_CONFIG}" > "${HOME}/.docker/config.json"
+    ## Add the `latest` tag to the image we have build.
+    - docker buildx imagetools create ${DOCKER_IMAGE_NAME}:${DOCKER_TAG} --tag ${DOCKER_IMAGE_NAME}:latest
+
+
+## Swap the production and staging slots around.
+staging to production:
+    stage: deploy
+    ## Only run this stage when main branch receives changes.
+    only:
+        - main
+
+    ## Use microsoft provided azure cli image, that contains az cli.
+    image: mcr.microsoft.com/azure-cli
+
+    environment:
+        name: production
+        url: https://${AZURE_APP_NAME}.azurewebsites.net/
+
+    before_script:
+        ## Login into azure
+        - az login --service-principal -u "${AZURE_SP_NAME}" -p "${AZURE_SP_CERT}" --tenant "jyu.onmicrosoft.com"
+
+    script:
+        ## Swap production and staging slots.
+        - az webapp deployment slot swap -g "$AZURE_RESOURCE_GROUP" -n "$AZURE_APP_NAME" -s staging --target-slot production

.gitlab/issue_templates/Default.md

+## Summary
+
+Briefly describe the issue and its impact on the project concisely.
+
+
+## Steps to Reproduce
+
+1. List the steps to reproduce the issue
+2. Provide any relevant details such as browser, device, version, etc.
+
+
+## Expected Outcome
+
+What should happen after following the steps?
+
+
+## Actual Outcome
+
+What actually happens after following the steps?
+
+
+## Additional Context
+
+- Include any relevant screenshots, logs, or code snippets
+- Indicate if the issue occurs only in certain conditions, environments, or browsers
+
+
+## Possible fixes
+
+If you are familiar with the issue and in a position to help, it would be appreciated!
+
+
+/label ~bug

.gitlab/issue_templates/User Story.md

+### As a ...
+
+(user role)
+
+### I want to ...
+
+(goal)
+
+### So that ...
+
+(benefit)
+
+
+### I know I'm done when ...
+
+(the thing does thang)
+
+
+
+/label ~"User Story"

.gitmodules

 [submodule "docs/tjts5901"]
 	path = docs/tjts5901
-	url = git@gitlab.jyu.fi:startuplab/courses/tjts5901-continuous-software-engineering/docs.git
+	url = https://gitlab.jyu.fi/startuplab/courses/tjts5901-continuous-software-engineering/docs.git

.pre-commit-config.yaml

+repos:
+  - repo: https://github.com/zricethezav/gitleaks
+    rev: v8.15.2
+    hooks:
+      - id: gitleaks-docker

.vscode/extensions.json

+{
+    "recommendations": [
+        "ms-vscode-remote.remote-containers",
+    ]
+}
\ No newline at end of file

.vscode/launch.json

+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Flask App",
+            "type": "python",
+            "request": "launch",
+            "module": "flask",
+            "env": {
+                "FLASK_DEBUG": "1"
+            },
+            "args": [
+                "run",
+                "--no-debugger",
+                "--no-reload",
+            ],
+            "jinja": true,
+            "justMyCode": true
+        },
+    ]
+}
\ No newline at end of file

.vscode/tasks.json

+{
+	"version": "2.0.0",
+	"tasks": [
+			{
+				"label": "Build Documentation",
+				"type": "shell",
+				"command": "pip install .[docs] && mkdocs build -f docs/mkdocs.yml",
+				"problemMatcher": []
+			}
+	]
+}
\ No newline at end of file

CODE_OF_CONDUCT.md

+# TJTS5901 Code of Conduct
+
+## Equality and Diversity
+
+Our multicultural and international community, which respects each individual,
+is our richness and a source of inspiration. A non-discriminating place for
+working and learning supports the development and success of the members of our
+university community. JYU takes care of the quality and availability of
+guidance as well as the accessibility of education. We behave appropriately,
+are appreciative and support each other also in challenging situations. We do
+not tolerate any inappropriate treatment, harassment, discrimination or
+bullying.
+
+We promote equality and non-discrimination in our university community in 
+accordance with the strategy and legislation as well as the aims set jointly
+with the university community. The aims and development measures are described
+in strategy development programmes and the
+[Equality Plan for 2019–2021][equality plan].
+
+[equality plan]: https://uno.jyu.fi/fi/ohjeet/yliopisto-tyonantajana/tyosuojelu-ja-tasa-arvo/jyu-equality-plan-2019-2021.pdf
+
+## Promoting appropriate conduct in our community
+
+Our university community does not accept any inappropriate treatment, bullying,
+nor sexual or other harassment toward the staff or students. We will intervene
+in and sort out any problematic situations of this kind.
+
+## What is inappropriate behaviour
+
+Inappropriate treatment refers to generally unacceptable demeanour toward
+another person. It may occur, for example, as continuous and unjustified
+criticism toward one’s work, negative or harmful gossip, exclusion from the
+work community or repeated improper behaviour such as taunting or yelling.
+
+Sexual harassment is most strikingly inappropriate behaviour. It is undesirable,
+one-sided sexually-tinged behaviour, which the other person finds unpleasant and
+insulting. Sexual harassment may be verbal or physical. Sexual attention turns
+into harassment if it is continued although the other person expresses that the
+behaviour is undesirable.
+
+## Dealing with inappropriate treatment and harassment cases
+
+If someone experiences inappropriate treatment or feels being harassed, the
+person must express it to the other party. If the misbehaviour continues, the
+issue must be reported to the immediate supervisor and the head of the unit.
+If the harassing person is a supervisor, the matter must be reported to the
+person’s supervisor. Supervisors and/or heads of units are obliged to do their
+best to stop the misbehaviour.
+
+It is essential that the unit management takes responsibility for solving the
+situation. If a harassed person finds it difficult to bring out the matter with
+the harasser or a supervisor, especially in case of sexual or gender-based
+harassment, he/she can contact any of the contact persons listed at the end of
+this brochure. Discussion with a contact person helps to sort out and solve the
+situation. The discussions are always confidential.
+
+## Contact persons
+
+### Students
+
+Student Union’s harassment contact persons:
+
+ * Juulia Saukkonen <hairinta.nainen@jyy.fi>,
+ * Teemu Rahikka <hairinta.mies@jyy.fi>,
+ * General <hairinta@jyy.fi>
+
+University wellbeing advisers:
+
+ * Your unit’s student welfare advisor (goodie)
+   IT-Department:
+   * Niina Ormshaw <goodie-it@jyu.fi>
+   * Eeva, Juuli, Tiina, Ville <hyvis-it@jyu.fi>
+ * Welfare coordinator
+   Hanna Ahola, 040 8054352, <hanna.r.ahola@jyu.fi>
+
+### Staff
+
+ * Equality contact person, Occupational Safety Officer, HR Specialist
+   Piia Löppönen, 0400 247 689, <piia.lopponen@jyu.fi>
+ * Occupational safety representative
+   Heli Niskanen, 040 805 3402, <heli.m.niskanen@jyu.fi>
+ * Occupational safety representative
+   Jorma Lind, 0400 247428, <jorma.lind@norssi.jyu.fi>
+
+## Attribution
+
+This covenant is adopted from [University of Jyväskylä Code of Conduct][code of conduct].
+
+[code of conduct]: https://www.jyu.fi/en/university/organisation-and-managementregulations-and-principles/code-of-conduct]

Dockerfile

+## Template project uses python image provided by Microsoft. It contains additional tools for
+## development, such as pylint, flake8, etc.
+## If team elects to use different image, this file should be updated accordingly. Example for
+## using official node: `FROM node:14-bullseye`
+## You can find devcontainer templates for other languages here:
+## https://github.com/microsoft/vscode-dev-containers/tree/main/containers
+
+## It would be smart to separate development stuff from production stuff, but for now
+## this is enough (fore-shadowing).
+## How to create deriative/multi-stage image: https://docs.docker.com/build/building/multi-stage/
+FROM mcr.microsoft.com/vscode/devcontainers/python:3.10-bullseye
+
+## [Optional] Look into using jemalloc with python for more efficient memory management
+
+## Turns off buffering for easier container logging
+ENV PYTHONUNBUFFERED=1
+
+## Set static working directory. By default, it is set to /workspaces/<project-name> by
+## vscode.
+WORKDIR /app
+
+## Declare default flask app as environment variable
+## https://flask.palletsprojects.com/en/2.2.x/cli/
+ARG FLASK_APP=tjts5901.app:flask_app
+ENV FLASK_APP=${FLASK_APP}
+
+## Setup the default port for flask to listen on
+ARG FLASK_RUN_PORT=5001
+ENV FLASK_RUN_PORT=${FLASK_RUN_PORT}
+
+## Run Flask app when container started, and listen all the interfaces
+## Note: CMD doesn't run command in build, but defines an starting command
+## when container is started (or arguments for ENTRYPOINT).
+#CMD flask run --host=0.0.0.0 # --port=${FLASK_RUN_PORT} --app=${FLASK_APP}
+CMD gunicorn --bind "0.0.0.0:${FLASK_RUN_PORT}" "${FLASK_APP}"
+
+## Examples for other commands:
+## Run nothing, so that the container can be used as a base image
+#CMD ["bash", "-c", "sleep infinity"]
+## Run Flask app using Gunicorn, which unlike Flask, doesn't complain about being development thing.
+
+## Install requirements using pip. This is done before copying the app, so that
+## requirements layer is cached. This way, if app code changes, only app code is
+## copied, and requirements are not re-installed.
+COPY requirements.txt /tmp/pip-tmp/
+RUN pip --disable-pip-version-check install -r /tmp/pip-tmp/requirements.txt && \
+    rm -rf /tmp/pip-tmp
+
+## Copy app to WORKDIR folder
+COPY . .
+
+## Compile translations before installing app. This is done to make sure that
+## translations are compiled before app is installed.
+RUN pybabel compile -f -d src/tjts5901/translations/
+
+## Install self as editable (`-e`) module. In a long run it would be recommeded
+## to remove `COPY` and only install app as a package.
+RUN pip --disable-pip-version-check install -v -e .
+
+## If defined, copy commit id to app environment. This is used to identify
+## which version of the app is running.
+ARG CI_COMMIT_SHA
+ENV CI_COMMIT_SHA=${CI_COMMIT_SHA}
+
+## Download the currency exchange rates from European Central Bank
+RUN flask update-currency-rates
+
+## Save build date and time
+RUN echo "BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> /app/.env
+
+## To prevent vscode constantly re-installing extensions, we need to create a folder for it.
+## In devcontainer.json, we mount volume to this folder so that extensions are not lost.
+## Create vscode extension folder, and change ownership of it.
+ARG USERNAME=vscode
+RUN test ! -z "${USERNAME}" && mkdir -p /home/${USERNAME}/.vscode-server/extensions && \
+    chown -R $USERNAME /home/$USERNAME/.vscode-server
+
+## [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+## [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

LICENSE

+ The MIT License (MIT)
+
+Copyright © 2023 University of Jyväskylä
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

 # TJTS5901 Course Template Project
 
-This is the template for 2023 TJTS5901 Continuous Software Engineering -course.
+Project template for 2023 TJTS5901 Continuous Software Engineering -course.
 
-Sisu: <https://sisu.jyu.fi/student/courseunit/otm-38b7f26b-1cf9-4d2d-a29b-e1dcb5c87f00>
-Moodle: <https://moodle.jyu.fi/course/view.php?id=20888>
+- Sisu: <https://sisu.jyu.fi/student/courseunit/otm-38b7f26b-1cf9-4d2d-a29b-e1dcb5c87f00>
+- Moodle: <https://moodle.jyu.fi/course/view.php?id=20888>
+
+To get started with the project, see [`week_1.md`](./week_1.md)
+
+The application is deployed at <https://tjts5901-app.azurewebsites.net>
+
+## Start the app
+
+Repository provides an `docker-compose` file to start the app. Edit `docker-compose.yml` to uncomment the ports, and run:
+
+```sh
+docker-compose up --build tjts5901
+```
+
+App can be also started from `Dockerfile`, with flask debug turned on, and current folder in editable mode. It has the benefit of automatically reflecting code changes in the app.
+
+```sh
+docker build -t tjts5901 .
+docker run -it -p 5001:5001 -e "FLASK_DEBUG=1" -v "${PWD}:/app" tjts5901
+```
+
+Please see the `docs/tjts5901` folder for more complete documentation.
+
+
+## Reporting issues and bugs
+
+To report bugs, please use [the project "issues" form](https://gitlab.jyu.fi/startuplab/courses/tjts5901-continuous-software-engineering/TJTS5901-K23_template/-/issues/new?issuable_template=Default)

babel.cfg

+[python: **.py]
+[jinja2: **/templates/**.html]

deployment.yaml

+apiVersion: v1
+kind: Service
+metadata:
+  name: tjts5901-service
+spec:
+  selector:
+    app: tjts5901-app
+  ports:
+  - protocol: "TCP"
+    port: 80
+    targetPort: 5001
+  type: LoadBalancer
+
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: tjts5901-app
+spec:
+  selector:
+    matchLabels:
+      app: tjts5901-app
+  replicas: 2
+  template:
+    metadata:
+      labels:
+        app: tjts5901-app
+    spec:
+      containers:
+      - name: tjts5901-app
+        image: tjts5901k23.azurecr.io/tjts5901
+        imagePullPolicy: Always
+        ports:
+        - containerPort: 5001

docker-compose.yml

+# Defines the application's Docker image and additional services
+# https://docs.docker.com/compose/compose-file/
+# To run using docker-compose, use the command:
+#   docker-compose up --build tjts5901
+
+version: '3'
+services:
+  tjts5901:
+    build:
+      context: .
+      dockerfile: Dockerfile
+
+    working_dir: /app
+
+    # Ports to expose to the host. Uncomment if running outside of vscode.
+    # ports:
+      # - 5001:5001
+
+    # Volumes to mount from the host.
+    volumes:
+      # Mount local source folder into container
+      - .:/app
+      # Add volume for vscode extensions
+      - tjts5901-vscode-extensions:/home/vscode/.vscode-server/extensions
+      # mountpoints for kubernetes syncing.
+      - ${HOME}/.kube:/usr/local/share/kube-localhost:cached
+      - ${HOME}/.minikube:/usr/local/share/minikube-localhost:cached
+
+    environment:
+      #FLASK_APP: tjt5901:app
+      FLASK_DEBUG: 1
+      #FLASK_RUN_PORT: 5001
+
+    ## Don't restart container if it exits. Useful for debugging, not for production.
+    restart: 'no'
+
+    ## Start a mongodb container and link it to the app container
+    depends_on:
+      - mongodb
+
+  # MongoDB container
+  mongodb:
+    image: mongo:4.2
+    restart: unless-stopped
+    ports:
+      - 27017:27017
+
+volumes:
+  tjts5901-vscode-extensions:

docs/macros.py

+"""
+Hack to get the hosted gitlab magiclink extension to work with mkdocs.
+
+See: https://github.com/facelessuser/pymdown-extensions/issues/933
+"""
+import pymdownx.magiclink
+base_url = "https://gitlab.jyu.fi"
+pymdownx.magiclink.PROVIDER_INFO["gitlab"].update({
+    "url": base_url,
+    "issue": "%s/{}/{}/issues/{}" % base_url,
+    "pull": "%s/{}/{}/merge_requests/{}" % base_url,
+    "commit": "%s/{}/{}/commit/{}" % base_url,
+    "compare": "%s/{}/{}/compare/{}...{}" % base_url,
+})
+
+def define_env(env):
+    pass