vantage6-algorithm-store 4.15.1__tar.gz → 5.0.0__tar.gz

vantage6_algorithm_store-5.0.0/.gitignore

@@ -0,0 +1,37 @@
+
+# documentation
+docs/_build
+docs/api-docs/_autosummary
+
+# Python
+.ipynb_checkpoints
+**/__pycache__
+**/.coverage
+
+# IDE's
+.idea/
+*.sublime-project
+*.sublime-workspace
+.vscode/
+
+# build files
+**/build/
+**/dist/
+*.egg-info
+*.code-workspace
+
+# UI build files
+**/node_modules/
+
+# Ignore DevSpace cache and log folder
+.devspace/
+dev/.data/
+dev/.tasks/
+dev/.db/
+dev/.log/
+
+# Helm
+charts/**/*.tgz
+
+# MacOS
+.DS_Store

vantage6_algorithm_store-5.0.0/Makefile

@@ -0,0 +1,22 @@
+# `make` is expected to be called from the directory that contains
+# this Makefile
+
+TAG ?= latest
+
+rebuild: clean build-dist
+
+build-dist:
+	# Build the PyPI package
+	uv build
+
+publish:
+	# Uploading to pypi.org
+	twine upload --repository pypi dist/*
+
+test:
+	coverage run --source=vantage6 --omit="utest.py" ./utest.py
+
+clean:
+	# Cleaning ...
+	-rm -r build
+	-rm dist/*

vantage6_algorithm_store-5.0.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: vantage6-algorithm-store
+Version: 5.0.0
+Summary: Vantage6 algorithm store
+Author: Vantage6 Team
+Maintainer-email: Frank Martin <f.martin@iknl.nl>, Bart van Beusekom <b.vanbeusekom@iknl.nl>
+License: MIT
+Requires-Python: >=3.13
+Requires-Dist: flask-jwt-extended==4.7.1
+Requires-Dist: flask-principal==0.4.0
+Requires-Dist: flask-restful==0.3.10
+Requires-Dist: flask==3.1.3
+Requires-Dist: gevent==25.4.2
+Requires-Dist: httpx==0.28.1
+Requires-Dist: jsonschema==4.21.1
+Requires-Dist: marshmallow==3.26.2
+Requires-Dist: python-keycloak==5.5.0
+Requires-Dist: requests==2.33.1
+Requires-Dist: schema==0.7.5
+Requires-Dist: sqlalchemy==2.0.37
+Requires-Dist: vantage6-common==5.0.0
+Requires-Dist: vantage6==5.0.0
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: coverage==7.10.2; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+  <br>
+  <a href="https://vantage6.ai"><img src="https://github.com/IKNL/guidelines/blob/master/resources/logos/vantage6.png?raw=true" alt="vantage6" width="350"></a>
+</h1>
+
+<h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
+
+---
+
+# Vantage6 Algorithm Store
+
+This package contains the vantage6 algorithm store application.
+
+## Documentation
+
+For complete documentation, installation instructions, and usage examples, please see
+the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
+.
+
+## About Vantage6
+
+Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
+federated learning and multi-party computation. For more information, visit
+[vantage6.ai](https://vantage6.ai) or view our
+[documentation](https://docs.vantage6.ai).

vantage6_algorithm_store-5.0.0/README.md

@@ -0,0 +1,25 @@
+<h1 align="center">
+  <br>
+  <a href="https://vantage6.ai"><img src="https://github.com/IKNL/guidelines/blob/master/resources/logos/vantage6.png?raw=true" alt="vantage6" width="350"></a>
+</h1>
+
+<h3 align=center> A Privacy Enhancing Technology (PET) Operations platform</h3>
+
+---
+
+# Vantage6 Algorithm Store
+
+This package contains the vantage6 algorithm store application.
+
+## Documentation
+
+For complete documentation, installation instructions, and usage examples, please see
+the **[main Vantage6 README](https://github.com/vantage6/vantage6/blob/main/README.md)**
+.
+
+## About Vantage6
+
+Vantage6 is a Privacy Enhancing Technology (PET) Operations platform that enables
+federated learning and multi-party computation. For more information, visit
+[vantage6.ai](https://vantage6.ai) or view our
+[documentation](https://docs.vantage6.ai).

vantage6_algorithm_store-5.0.0/dev_store.sh

@@ -0,0 +1,37 @@
+#!/bin/sh
+
+echo "*********************************************************************************"
+echo "********************* VANTAGE6 STORE DEVELOPMENT MODE ***************************"
+echo "*********************************************************************************"
+
+# check if environment variable is set
+if [ -z "$VANTAGE6_STORE_CONFIG_LOCATION" ]; then
+    echo "VANTAGE6_STORE_CONFIG_LOCATION is not set"
+    echo "  using default location /mnt/config.yaml"
+    VANTAGE6_STORE_CONFIG_LOCATION="/mnt/config.yaml"
+fi
+
+
+# Run from repo root so module imports don't shadow stdlib modules.
+cd /vantage6
+
+python -m vantage6.algorithm.store.init_db "${VANTAGE6_STORE_CONFIG_LOCATION}"
+status=$?
+if [ "$status" -ne 0 ]; then
+    echo "ERROR: failed to initialize algorithm store database" >&2
+    exit "$status"
+fi
+
+exec uwsgi \
+    --py-autoreload 1 \
+    --reload-mercy 1 \
+    --gevent 100 \
+    --http-websockets \
+    --http :7602 \
+    --master \
+    --callable app \
+    --disable-logging \
+    --wsgi-file /vantage6/vantage6-algorithm-store/vantage6/algorithm/store/wsgi.py \
+    --pyargv "${VANTAGE6_STORE_CONFIG_LOCATION}"
+
+echo "exit dev_store.sh"

vantage6_algorithm_store-5.0.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vantage6-algorithm-store"
+version = "5.0.0"
+description = "Vantage6 algorithm store"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Vantage6 Team"}
+]
+maintainers = [
+    {name = "Frank Martin", email = "f.martin@iknl.nl"},
+    {name = "Bart van Beusekom", email = "b.vanbeusekom@iknl.nl"}
+]
+requires-python = ">=3.13"
+dependencies = [
+    "flask==3.1.3",
+    "Flask-JWT-Extended==4.7.1",
+    "Flask-Principal==0.4.0",
+    "Flask-RESTful==0.3.10",
+    "gevent==25.4.2",
+    # TODO remove httpx once 1.0.0 is released - atm this is added to prevent 1.0.dev3 is installed
+    "httpx==0.28.1",
+    "jsonschema==4.21.1",
+    "marshmallow==3.26.2",
+    "python-keycloak==5.5.0",
+    "requests==2.33.1",
+    "schema==0.7.5",
+    "sqlalchemy==2.0.37",
+    "vantage6-common==5.0.0",
+    "vantage6==5.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage==7.10.2",
+    "black",
+    "pre-commit",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["vantage6"]
+
+[tool.hatch.build.targets.wheel.sources]
+"vantage6" = "vantage6"

vantage6_algorithm_store-5.0.0/server.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+echo "[server.sh start]"
+
+HTTP_PORT="${V6_PROXY_PORT:-80}"
+GEVENT="${UWSGI_GEVENT:-100}"
+
+# check if environment variable is set
+if [ -z "$VANTAGE6_CONFIG_LOCATION" ]; then
+    echo "VANTAGE6_CONFIG_LOCATION is not set"
+    echo "  using default location /mnt/config.yaml"
+    VANTAGE6_CONFIG_LOCATION="/mnt/config.yaml"
+fi
+
+
+# initialize the database
+python -m vantage6.algorithm.store.init_db "${VANTAGE6_CONFIG_LOCATION}"
+status=$?
+if [ "$status" -ne 0 ]; then
+    echo "ERROR: failed to initialize algorithm store database" >&2
+    exit "$status"
+fi
+
+# start the algorithm store
+exec uwsgi \
+    --http ":${HTTP_PORT}" \
+    --gevent "${GEVENT}" \
+    --http-websockets \
+    --master \
+    --callable app \
+    --disable-logging \
+    --wsgi-file /vantage6/vantage6-algorithm-store/vantage6/algorithm/store/wsgi.py \
+    --pyargv "${VANTAGE6_CONFIG_LOCATION}"
+
+echo "[server.sh exit]"

vantage6_algorithm_store-5.0.0/tests_store/base/unittest_base.py

@@ -0,0 +1,149 @@
+import os
+import unittest
+from http import HTTPStatus
+from unittest.mock import Mock, patch
+
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric import rsa
+
+from vantage6.common.globals import InstanceType
+
+from vantage6.backend.common import test_context
+
+from vantage6.algorithm.store import AlgorithmStoreApp
+from vantage6.algorithm.store.default_roles import get_default_roles
+from vantage6.algorithm.store.globals import PACKAGE_FOLDER
+from vantage6.algorithm.store.model.base import Database, DatabaseSessionManager
+from vantage6.algorithm.store.model.policy import Policy
+from vantage6.algorithm.store.model.review import Review
+from vantage6.algorithm.store.model.role import Role
+from vantage6.algorithm.store.model.rule import Rule
+from vantage6.algorithm.store.model.user import User
+
+# Generate a mock RSA key pair for testing
+MOCK_PRIVATE_KEY = rsa.generate_private_key(
+    public_exponent=65537, key_size=2048, backend=default_backend()
+)
+MOCK_PUBLIC_KEY = MOCK_PRIVATE_KEY.public_key()
+MOCK_PRIVATE_KEY_PEM = MOCK_PRIVATE_KEY.private_bytes(
+    encoding=serialization.Encoding.PEM,
+    format=serialization.PrivateFormat.PKCS8,
+    encryption_algorithm=serialization.NoEncryption(),
+)
+MOCK_PUBLIC_KEY_PEM = MOCK_PUBLIC_KEY.public_bytes(
+    encoding=serialization.Encoding.PEM,
+    format=serialization.PublicFormat.SubjectPublicKeyInfo,
+)
+
+
+class TestResources(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        """Called immediately before running a test method."""
+
+        Database().connect("sqlite://", allow_drop_all=True)
+
+        ctx = test_context.TestContext.from_external_config_file(
+            PACKAGE_FOLDER, InstanceType.ALGORITHM_STORE
+        )
+
+        # set required environment variables *before* creating the app
+        os.environ["KEYCLOAK_URL"] = "dummy-keycloak-url"
+        os.environ["KEYCLOAK_REALM"] = "dummy-keycloak-realm"
+        os.environ["KEYCLOAK_ADMIN_USERNAME"] = "dummy-keycloak-admin-username"
+        os.environ["KEYCLOAK_ADMIN_PASSWORD"] = "dummy-keycloak-admin-password"
+        os.environ["KEYCLOAK_ADMIN_CLIENT"] = "dummy-keycloak-admin-client"
+        os.environ["KEYCLOAK_ADMIN_CLIENT_SECRET"] = (
+            "dummy-keycloak-admin-client-secret"
+        )
+
+        # Mock the Keycloak public key fetch
+        with patch(
+            "vantage6.algorithm.store.AlgorithmStoreApp._get_keycloak_public_key"
+        ) as mock_get_key:
+            mock_get_key.return_value = MOCK_PUBLIC_KEY_PEM.decode()
+            # create store instance. Patch the start_background_task method
+            # to prevent the store from starting a ping/pong thread that will
+            # prevent the tests from starting
+            backend_service = AlgorithmStoreApp(ctx)
+            # Configure JWT for container tokens
+            backend_service.app.config["JWT_PRIVATE_KEY"] = MOCK_PRIVATE_KEY_PEM
+            backend_service.app.config["JWT_PUBLIC_KEY"] = MOCK_PUBLIC_KEY_PEM
+
+        cls.backend = backend_service
+        cls.backend.app.testing = True
+        cls.app = cls.backend.app.test_client()
+
+    @classmethod
+    def tearDownClass(cls):
+        Database().clear_data()
+        Database().close()
+
+    @classmethod
+    def setUp(cls):
+        # set session.session
+        DatabaseSessionManager.get_session()
+
+    @classmethod
+    def tearDown(cls):
+        # delete resources from database
+        policies_to_delete = Policy.get()
+        for p in policies_to_delete:
+            p.delete()
+        users_to_delete = User.get()
+        for u in users_to_delete:
+            u.delete()
+        roles_to_delete = Role.get()
+        for r in roles_to_delete:
+            r.delete()
+        reviews_to_delete = Review.get()
+        for r in reviews_to_delete:
+            r.delete()
+
+        # unset session.session
+        DatabaseSessionManager.clear_session()
+
+    def register_user(
+        self,
+        username: str = "test_user",
+        user_roles: list[Role] = None,
+        user_rules: list[Rule] = None,
+        organization_id: int = 1,
+        authenticate_mock: Mock = None,
+        auth: bool = True,
+    ) -> User:
+        user = User(username=username, organization_id=organization_id)
+        if user_roles and len(user_roles) > 0:
+            user.roles = user_roles
+        if user_rules and len(user_rules) > 0:
+            user.rules = user_rules
+        user.save()
+        if authenticate_mock:
+            self._mock_auth(user, authenticate_mock, auth)
+        return user
+
+    def _mock_auth(self, user: User, authenticate_mock: Mock, auth: bool):
+        authenticate_mock.return_value = (
+            (user, HTTPStatus.OK)
+            if auth
+            else ({"msg": "Unauthorized"}, HTTPStatus.UNAUTHORIZED)
+        )
+
+    def create_role(self, rules: list[Rule], name: str = "test_role") -> Role:
+        role = Role(name=name, rules=rules)
+        role.save()
+        return role
+
+    def assign_role_to_user(self, user: User, role: Role):
+        user.roles.append(role)
+        user.save()
+
+    def create_default_roles(self) -> list[Role]:
+        for role in get_default_roles():
+            new_role = Role(
+                name=role["name"],
+                description=role["description"],
+                rules=role["rules"],
+            )
+            new_role.save()