desdeo 1.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

desdeo/api/schema.py

@@ -0,0 +1,94 @@
+"""Pydantic schemas for the API."""
+
+from enum import Enum
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class UserRole(str, Enum):
+    """Enum of user roles."""
+
+    GUEST = "guest"
+    DM = "dm"
+    ANALYST = "analyst"
+
+
+class UserPrivileges(str, Enum):
+    """Enum of user privileges."""
+
+    CREATE_PROBLEMS = "Create problems"
+    CREATE_USERS = "Create users"
+    ACCESS_ALL_PROBLEMS = "Access all problems"
+    EDIT_USERS = "Change user privileges, roles, groups, etc."
+
+
+class ProblemKind(str, Enum):
+    """Enum of problem kinds."""
+
+    CONTINUOUS = "continuous"
+    DISCRETE = "discrete"
+    MIXED = "mixed"
+    BINARY = "binary"
+
+
+class ObjectiveKind(str, Enum):
+    """Enum of objective kinds."""
+
+    ANALYTICAL = "analytical"
+    DATABASED = "databased"
+    SIMULATED = "simulated"
+    SURROGATE = "surrogate"
+
+
+class Methods(str, Enum):
+    """Enum of methods."""
+
+    NIMBUS = "nimbus"
+    NAUTILUS = "nautilus"
+    NAUT_NAVIGATOR = "NAUTILUS navigator"
+    NAUTILUSII = "nautilusII"
+    RVEA = "RVEA"
+    NSGAIII = "NSGAIII"
+
+
+class MethodProperties(str, Enum):
+    """Enum of method properties."""
+
+    INTERACTIVE = "interactive"
+    REFERENCE_POINT = "reference_point"
+    CLASSIFICATION = "classification"
+    # TODO: Add more properties as needed.
+
+
+class User(BaseModel):
+    """Model for a user. Temporary."""
+
+    username: str = Field(description="Username of the user.")
+    index: int | None = Field(
+        description=(
+            "Index of the user in the database. "
+            "Supposed to be automatically generated by the database. "
+            "So the programmer should not have to worry about it."
+        )
+    )
+    password_hash: str = Field(description="SHA256 Hash of the user's password.")
+    role: UserRole = Field(description="Role of the user.")
+    privileges: list[UserPrivileges] = Field(description="List of privileges the user has.")
+    user_group: str = Field(description="User group of the user. Used for group decision making.")
+    # To allows for User to be initialized from database instead of just dicts.
+    model_config = ConfigDict(from_attributes=True)
+
+
+class Solvers(Enum):
+    """Enum of available solvers."""
+
+    # These should match available_solvers in desdeo.tools.utils
+
+    SCIPY_MIN = "scipy_minimize"
+    SCIPY_DE = "scipy_de"
+    PROXIMAL = "proximal"
+    NEVERGRAD = "nevergrad"
+    PYOMO_BONMIN = "pyomo_bonmin"
+    PYOMO_IPOPT = "pyomo_ipopt"
+    PYOMO_GUROBI = "pyomo_gurobi"
+    GUROBIPY = "gurobipy"

desdeo/api/tests/conftest.py

@@ -0,0 +1,59 @@
+"""General fixtures for API tests are defined here."""
+
+import pytest
+from fastapi.testclient import TestClient
+from sqlmodel import Session, SQLModel, create_engine
+from sqlmodel.pool import StaticPool
+
+from desdeo.api.app import app
+from desdeo.api.db import get_session
+from desdeo.api.models import ProblemDB, User, UserRole
+from desdeo.api.routers.user_authentication import get_password_hash
+from desdeo.problem.testproblems import dtlz2, river_pollution_problem
+
+
+@pytest.fixture(name="session_and_user", scope="function")
+def session_fixture():
+    """Create a session for testing."""
+    engine = create_engine("sqlite://", connect_args={"check_same_thread": False}, poolclass=StaticPool)
+
+    SQLModel.metadata.create_all(engine)
+
+    with Session(engine) as session:
+        user_analyst = User(
+            username="analyst",
+            password_hash=get_password_hash("analyst"),
+            role=UserRole.analyst,
+            group="test",
+        )
+        session.add(user_analyst)
+        session.commit()
+        session.refresh(user_analyst)
+
+        problem_db = ProblemDB.from_problem(dtlz2(5, 3), user=user_analyst)
+        session.add(problem_db)
+        session.commit()
+        session.refresh(problem_db)
+
+        problem_db_river = ProblemDB.from_problem(river_pollution_problem(), user=user_analyst)
+        session.add(problem_db_river)
+        session.commit()
+        session.refresh(problem_db_river)
+
+        yield {"session": session, "user": user_analyst}
+        session.rollback()
+
+
+@pytest.fixture(name="client", scope="function")
+def client_fixture(session_and_user):
+    """Create a client for testing."""
+
+    def get_session_override():
+        return session_and_user["session"]
+
+    app.dependency_overrides[get_session] = get_session_override
+    client = TestClient(app)
+
+    yield client
+
+    app.dependency_overrides.clear()