s2-group / upisas

Unified Python interface for self-adaptive systems exemplars.

UPISAS

Unified Python interface for self-adaptive system exemplars.

Prerequisites

Tested with Python 3.9.12

Installation

In a terminal, navigate to the parent folder of the project and issue:

pip install -r requirements.txt

Run unit tests

In a terminal, navigate to the parent folder of the project and issue:

python -m UPISAS.tests.upisas.test_exemplar
python -m UPISAS.tests.upisas.test_strategy
python -m UPISAS.tests.swim.test_swim_interface

Run

In a terminal, navigate to the parent folder of the project and issue:

python run.py

upisas's Issues

The docker interface is too exposed

As it stands you can fairly easily inject malicious code into the Exemplar object. We should protect this by for example making a handle to the singular container in the Exemplar constructor instead of public attributes and methods.

Finish Openapi spec of the interface

Implement SWIM http interface

Python Documentation

Right now I've added some docstrings. Using pydoc you can generate a webpage for the package. However, we should probably have this be online or something hosted by this git repo, updated automatically

Make new Docker image for SWIM, make it work with the Python interface

Testing/Regression Tests

Right now adding functionality needs to verified ourselves afterwards. We should establish basic functionality with (unit) tests and run this after adding stuff.

We should remove the docker ports from the exemplar code, should come from the client

Stop container on exit

Right now if the process ends for any reason the docker container still exists and is still running. It should be stopped and deleted, even if you ctrl+c or crash.