cornflow 1.1.0a1__tar.gz → 1.1.0a2__tar.gz

{cornflow-1.1.0a1/cornflow.egg-info → cornflow-1.1.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: cornflow
-Version: 1.1.0a1
+Version: 1.1.0a2
 Summary: Cornflow is an open source multi-solver optimization server with a REST API built using flask.
 Home-page: https://github.com/baobabsoluciones/cornflow
 Author: baobab soluciones

{cornflow-1.1.0a1 → cornflow-1.1.0a2}/cornflow/endpoints/__init__.py

@@ -4,8 +4,8 @@ All references to endpoints should be imported from here
 The login resource gets created on app startup as it depends on configuration
 """
 from .action import ActionListEndpoint
+from .alarms import AlarmsEndpoint
 from .apiview import ApiViewListEndpoint
-
 from .case import (
     CaseEndpoint,
     CaseFromInstanceExecutionEndpoint,
@@ -15,7 +15,6 @@ from .case import (
     CaseToInstance,
     CaseCompare,
 )
-
 from .dag import (
     DAGDetailEndpoint,
     DAGEndpointManual,
@@ -24,7 +23,12 @@ from .dag import (
     DeployedDAGEndpoint,
     DeployedDagDetailEndpoint,
 )
-
+from .data_check import (
+    DataCheckExecutionEndpoint,
+    DataCheckInstanceEndpoint,
+    DataCheckCaseEndpoint,
+)
+from .example_data import ExampleDataListEndpoint, ExampleDataDetailEndpoint
 from .execution import (
     ExecutionEndpoint,
     ExecutionDetailsEndpoint,
@@ -33,36 +37,22 @@ from .execution import (
     ExecutionLogEndpoint,
     ExecutionRelaunchEndpoint,
 )
-
 from .health import HealthEndpoint
-
 from .instance import (
     InstanceEndpoint,
     InstanceDetailsEndpoint,
     InstanceFileEndpoint,
     InstanceDataEndpoint,
 )
-
-from .data_check import (
-    DataCheckExecutionEndpoint,
-    DataCheckInstanceEndpoint,
-    DataCheckCaseEndpoint,
-)
 from .licenses import LicensesEndpoint
+from .main_alarms import MainAlarmsEndpoint
 from .permission import PermissionsViewRoleEndpoint, PermissionsViewRoleDetailEndpoint
-
 from .roles import RolesListEndpoint, RoleDetailEndpoint
-
 from .schemas import SchemaDetailsEndpoint, SchemaEndpoint
+from .tables import TablesEndpoint, TablesDetailsEndpoint
 from .token import TokenEndpoint
-from .example_data import ExampleDataDetailsEndpoint
 from .user import UserEndpoint, UserDetailsEndpoint, ToggleUserAdmin, RecoverPassword
 from .user_role import UserRoleListEndpoint, UserRoleDetailEndpoint
-from .alarms import AlarmsEndpoint
-from .main_alarms import MainAlarmsEndpoint
-
-from .tables import TablesEndpoint, TablesDetailsEndpoint
-
 
 resources = [
     dict(resource=InstanceEndpoint, urls="/instance/", endpoint="instance"),
@@ -157,10 +147,15 @@ resources = [
         endpoint="schema-details",
     ),
     dict(
-        resource=ExampleDataDetailsEndpoint,
+        resource=ExampleDataListEndpoint,
         urls="/example/<string:dag_name>/",
         endpoint="example-data",
     ),
+    dict(
+        resource=ExampleDataDetailEndpoint,
+        urls="/example/<string:dag_name>/<string:example_name>/",
+        endpoint="example-data-detail",
+    ),
     dict(resource=HealthEndpoint, urls="/health/", endpoint="health"),
     dict(
         resource=CaseFromInstanceExecutionEndpoint,

cornflow-1.1.0a2/cornflow/endpoints/example_data.py

@@ -0,0 +1,119 @@
+"""
+Endpoints to get the example data from a DAG
+"""
+import json
+
+from cornflow_client.airflow.api import Airflow
+from flask import current_app, request
+from flask_apispec import marshal_with, doc
+
+from cornflow.endpoints.meta_resource import BaseMetaResource
+from cornflow.models import PermissionsDAG
+from cornflow.schemas.example_data import ExampleListData, ExampleDetailData
+from cornflow.shared.authentication import Auth, authenticate
+from cornflow.shared.const import VIEWER_ROLE, PLANNER_ROLE, ADMIN_ROLE
+from cornflow.shared.exceptions import AirflowError, NoPermission, ObjectDoesNotExist
+
+
+class ExampleDataListEndpoint(BaseMetaResource):
+    """
+    Endpoint used to obtain schemas for one app
+    """
+
+    ROLES_WITH_ACCESS = [VIEWER_ROLE, PLANNER_ROLE, ADMIN_ROLE]
+
+    @doc(description="Get lsit of example data from DAG", tags=["DAG"])
+    @authenticate(auth_class=Auth())
+    @marshal_with(ExampleListData(many=True))
+    def get(self, dag_name):
+        """
+        API method to get example data for a given dag
+
+        :return: A dictionary with the names and descriptions of available data examples
+            and an integer with the HTTP status code
+        :rtype: Tuple(dict, integer)
+        """
+        user = Auth().get_user_from_header(request.headers)
+        permission = PermissionsDAG.check_if_has_permissions(
+            user_id=user.id, dag_id=dag_name
+        )
+
+        if permission:
+            af_client = Airflow.from_config(current_app.config)
+            if not af_client.is_alive():
+                current_app.logger.error(
+                    "Airflow not accessible when getting data {}".format(dag_name)
+                )
+                raise AirflowError(error="Airflow is not accessible")
+
+            # try airflow and see if dag_name exists
+            af_client.get_dag_info(dag_name)
+
+            current_app.logger.info("User gets example data from {}".format(dag_name))
+
+            variable_name = f"z_{dag_name}_examples"
+            response = af_client.get_one_variable(variable_name)
+
+            return json.loads(response["value"])
+        else:
+            err = "User does not have permission to access this dag."
+            raise NoPermission(
+                error=err,
+                status_code=403,
+                log_txt=f"Error while user {user} tries to get example data for dag {dag_name}. "
+                + err,
+            )
+
+
+class ExampleDataDetailEndpoint(BaseMetaResource):
+    @doc(description="Get example data from DAG", tags=["DAG"])
+    @authenticate(auth_class=Auth())
+    @marshal_with(ExampleDetailData)
+    def get(self, dag_name, example_name):
+        """
+        API method to get one example data for a given dag
+
+        :return: A dictionary with a message and a integer with the HTTP status code
+        :rtype: Tuple(dict, integer)
+        """
+        user = Auth().get_user_from_header(request.headers)
+        permission = PermissionsDAG.check_if_has_permissions(
+            user_id=user.id, dag_id=dag_name
+        )
+
+        if permission:
+            af_client = Airflow.from_config(current_app.config)
+            if not af_client.is_alive():
+                current_app.logger.error(
+                    "Airflow not accessible when getting data {}".format(dag_name)
+                )
+                raise AirflowError(error="Airflow is not accessible")
+
+            # try airflow and see if dag_name exists
+            af_client.get_dag_info(dag_name)
+
+            current_app.logger.info("User gets example data from {}".format(dag_name))
+
+            variable_name = f"z_{dag_name}_examples"
+            response = af_client.get_one_variable(variable_name)
+
+            example = None
+            for item in json.loads(response["value"]):
+                if item["name"] == example_name:
+                    example = item
+                    break
+
+            if example is None:
+                raise ObjectDoesNotExist(
+                    error="The example does not exist", status_code=404
+                )
+
+            return example
+        else:
+            err = "User does not have permission to access this dag."
+            raise NoPermission(
+                error=err,
+                status_code=403,
+                log_txt=f"Error while user {user} tries to get example data for dag {dag_name}. "
+                + err,
+            )

cornflow-1.1.0a2/cornflow/schemas/example_data.py

@@ -0,0 +1,11 @@
+from marshmallow import fields, Schema
+
+
+class ExampleListData(Schema):
+    name = fields.Str(required=True)
+    description = fields.Str(required=False)
+
+
+class ExampleDetailData(ExampleListData):
+    instance = fields.Raw(required=True)
+    solution = fields.Raw(required=False)

{cornflow-1.1.0a1 → cornflow-1.1.0a2}/cornflow/tests/unit/test_cli.py

@@ -131,7 +131,7 @@ class CLITests(TestCase):
         result = runner.invoke(cli, ["views", "init", "-v"])
         self.assertEqual(result.exit_code, 0)
         views = ViewModel.get_all_objects().all()
-        self.assertEqual(len(views), 48)
+        self.assertEqual(len(views), 49)
 
     def test_permissions_entrypoint(self):
         runner = CliRunner()
@@ -155,8 +155,8 @@ class CLITests(TestCase):
         permissions = PermissionViewRoleModel.get_all_objects().all()
         self.assertEqual(len(actions), 5)
         self.assertEqual(len(roles), 4)
-        self.assertEqual(len(views), 48)
-        self.assertEqual(len(permissions), 530)
+        self.assertEqual(len(views), 49)
+        self.assertEqual(len(permissions), 546)
 
     def test_permissions_base_command(self):
         runner = CliRunner()
@@ -171,8 +171,8 @@ class CLITests(TestCase):
         permissions = PermissionViewRoleModel.get_all_objects().all()
         self.assertEqual(len(actions), 5)
         self.assertEqual(len(roles), 4)
-        self.assertEqual(len(views), 48)
-        self.assertEqual(len(permissions), 530)
+        self.assertEqual(len(views), 49)
+        self.assertEqual(len(permissions), 546)
 
     def test_service_entrypoint(self):
         runner = CliRunner()

cornflow-1.1.0a2/cornflow/tests/unit/test_example_data.py

@@ -0,0 +1,124 @@
+import json
+
+
+from unittest.mock import patch
+
+from cornflow.models import PermissionsDAG
+from cornflow.tests.const import EXAMPLE_URL, INSTANCE_PATH
+from cornflow.tests.custom_test_case import CustomTestCase
+
+
+class TestExampleDataEndpoint(CustomTestCase):
+    def setUp(self):
+        super().setUp()
+
+        def load_file(_file):
+            with open(_file) as f:
+                temp = json.load(f)
+            return temp
+
+        self.example = [
+            {
+                "name": "test_example_1",
+                "description": "some_description",
+                "instance": load_file(INSTANCE_PATH),
+            },
+            {
+                "name": "test_example_2",
+                "description": "some_description",
+                "instance": load_file(INSTANCE_PATH),
+            },
+        ]
+        self.url = EXAMPLE_URL
+        self.schema_name = "solve_model_dag"
+
+    def patch_af_client(self, Airflow_mock):
+        af_client = Airflow_mock.return_value
+        af_client.is_alive.return_value = True
+        af_client.get_dag_info.return_value = {}
+        af_client.get_one_variable.return_value = {
+            "value": json.dumps(self.example),
+            "key": self.schema_name,
+        }
+        af_client.get_all_schemas.return_value = [{"name": self.schema_name}]
+        return af_client
+
+    def patch_af_client_not_alive(self, Airflow_mock):
+        af_client = Airflow_mock.return_value
+        af_client.is_alive.return_value = False
+        af_client.is_alive.return_value = False
+        return af_client
+
+    @patch("cornflow.endpoints.example_data.Airflow.from_config")
+    def test_get_list_of_examples(self, airflow_init):
+        af_client = self.patch_af_client(airflow_init)
+        examples = self.get_one_row(
+            f"{self.url}/{self.schema_name}/",
+            {},
+            expected_status=200,
+            check_payload=False,
+        )
+
+        for pos, item in enumerate(examples):
+            self.assertIn("name", item)
+            self.assertEqual(self.example[pos]["name"], item["name"])
+            self.assertIn("description", item)
+            self.assertEqual(self.example[pos]["description"], item["description"])
+
+    @patch("cornflow.endpoints.example_data.Airflow.from_config")
+    def test_get_one_example(self, airflow_init):
+        def load_file(_file):
+            with open(_file) as f:
+                temp = json.load(f)
+            return temp
+
+        af_client = self.patch_af_client(airflow_init)
+        keys_to_check = ["name", "examples"]
+        example = self.get_one_row(
+            f"{self.url}/{self.schema_name}/test_example_1/",
+            {},
+            expected_status=200,
+            check_payload=False,
+            keys_to_check=keys_to_check,
+        )
+
+        self.assertIn("name", example)
+        self.assertEqual("test_example_1", example["name"])
+        self.assertIn("description", example)
+        self.assertIn("instance", example)
+        self.assertEqual(load_file(INSTANCE_PATH), example["instance"])
+
+    @patch("cornflow.endpoints.example_data.Airflow.from_config")
+    def test_airflow_not_available(self, airflow_init):
+        af_client = self.patch_af_client_not_alive(airflow_init)
+        self.get_one_row(
+            f"{self.url}/{self.schema_name}/test_example_1/",
+            {},
+            expected_status=400,
+            check_payload=False,
+        )
+
+        self.get_one_row(
+            f"{self.url}/{self.schema_name}/",
+            {},
+            expected_status=400,
+            check_payload=False,
+        )
+
+    def test_if_no_permission(self):
+        with patch.object(
+            PermissionsDAG, "check_if_has_permissions", return_value=False
+        ) as mock_permission:
+            self.get_one_row(
+                f"{self.url}/{self.schema_name}/",
+                {},
+                expected_status=403,
+                check_payload=False,
+            )
+
+            self.get_one_row(
+                f"{self.url}/{self.schema_name}/test_example_1/",
+                {},
+                expected_status=403,
+                check_payload=False,
+            )

{cornflow-1.1.0a1 → cornflow-1.1.0a2/cornflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: cornflow
-Version: 1.1.0a1
+Version: 1.1.0a2
 Summary: Cornflow is an open source multi-solver optimization server with a REST API built using flask.
 Home-page: https://github.com/baobabsoluciones/cornflow
 Author: baobab soluciones

{cornflow-1.1.0a1 → cornflow-1.1.0a2}/cornflow.egg-info/requires.txt

@@ -1,7 +1,7 @@
 alembic==1.9.2
 apispec<=6.2.0
 click<=8.1.3
-cornflow-client==1.1.0a1
+cornflow-client==1.1.0a2
 cryptography<=42.0.5
 disposable-email-domains>=0.0.86
 Flask==2.3.2

{cornflow-1.1.0a1 → cornflow-1.1.0a2}/setup.py

@@ -9,7 +9,7 @@ with open("requirements.txt", "r") as fh:
 
 setuptools.setup(
     name="cornflow",
-    version="1.1.0a1",
+    version="1.1.0a2",
     author="baobab soluciones",
     author_email="cornflow@baobabsoluciones.es",
     description="Cornflow is an open source multi-solver optimization server with a REST API built using flask.",

cornflow-1.1.0a1/cornflow/endpoints/example_data.py

@@ -1,68 +0,0 @@
-"""
-Endpoints to get the example data from a DAG
-"""
-
-# Import from libraries
-from cornflow_client.airflow.api import Airflow
-from flask import current_app, request
-from flask_apispec import marshal_with, doc
-import json
-
-# Import from internal modules
-from cornflow.endpoints.meta_resource import BaseMetaResource
-from cornflow.models import PermissionsDAG
-from cornflow.schemas.example_data import ExampleData
-from cornflow.shared.authentication import Auth, authenticate
-from cornflow.shared.const import VIEWER_ROLE, PLANNER_ROLE, ADMIN_ROLE
-from cornflow.shared.exceptions import AirflowError, NoPermission
-
-
-class ExampleDataDetailsEndpoint(BaseMetaResource):
-    """
-    Endpoint used to obtain schemas for one app
-    """
-
-    ROLES_WITH_ACCESS = [VIEWER_ROLE, PLANNER_ROLE, ADMIN_ROLE]
-
-    @doc(description="Get example data from DAG", tags=["DAG"])
-    @authenticate(auth_class=Auth())
-    @marshal_with(ExampleData)
-    def get(self, dag_name):
-        """
-        API method to get example data for a given dag
-
-        :return: A dictionary with a message and a integer with the HTTP status code
-        :rtype: Tuple(dict, integer)
-        """
-        user = Auth().get_user_from_header(request.headers)
-        permission = PermissionsDAG.check_if_has_permissions(
-            user_id=user.id, dag_id=dag_name
-        )
-
-        if permission:
-            af_client = Airflow.from_config(current_app.config)
-            if not af_client.is_alive():
-                current_app.logger.error(
-                    "Airflow not accessible when getting data {}".format(dag_name)
-                )
-                raise AirflowError(error="Airflow is not accessible")
-
-            # try airflow and see if dag_name exists
-            af_client.get_dag_info(dag_name)
-
-            current_app.logger.info("User gets example data from {}".format(dag_name))
-
-            variable_name = f"z_{dag_name}_examples"
-            response = af_client.get_one_variable(variable_name)
-            result = dict()
-            result["examples"] = json.loads(response["value"])
-            result["name"] = response["key"]
-
-            return result
-        else:
-            err = "User does not have permission to access this dag."
-            raise NoPermission(
-                error=err,
-                status_code=403,
-                log_txt=f"Error while user {user} tries to get example data for dag {dag_name}. " + err
-            )

cornflow-1.1.0a1/cornflow/schemas/example_data.py

@@ -1,6 +0,0 @@
-from marshmallow import fields, Schema
-
-
-class ExampleData(Schema):
-    name = fields.Str(required=True)
-    examples = fields.Raw(required=True)

cornflow-1.1.0a1/cornflow/tests/unit/test_example_data.py

@@ -1,54 +0,0 @@
-"""
-
-"""
-
-# General imports
-import json
-
-# Partial imports
-from unittest.mock import patch
-
-
-# Imports from internal modules
-from cornflow.tests.const import EXAMPLE_URL, INSTANCE_PATH
-from cornflow.tests.custom_test_case import CustomTestCase
-
-
-class TestExampleDataEndpoint(CustomTestCase):
-    def setUp(self):
-        super().setUp()
-
-        def load_file(_file):
-            with open(_file) as f:
-                temp = json.load(f)
-            return temp
-
-        self.example = load_file(INSTANCE_PATH)
-        self.url = EXAMPLE_URL
-        self.schema_name = "solve_model_dag"
-
-    def patch_af_client(self, Airflow_mock):
-        af_client = Airflow_mock.return_value
-        af_client.is_alive.return_value = True
-        af_client.get_dag_info.return_value = {}
-        af_client.get_one_variable.return_value = {
-            "value": json.dumps(self.example),
-            "key": self.schema_name,
-        }
-        af_client.get_all_schemas.return_value = [{"name": self.schema_name}]
-        return af_client
-
-    @patch("cornflow.endpoints.example_data.Airflow.from_config")
-    def test_get_example(self, airflow_init):
-        af_client = self.patch_af_client(airflow_init)
-        keys_to_check = ["name", "examples"]
-        example = self.get_one_row(
-            self.url + "{}/".format(self.schema_name),
-            {},
-            expected_status=200,
-            check_payload=False,
-            keys_to_check=keys_to_check,
-        )
-        self.assertIn("examples", example)
-        self.assertIn("name", example)
-        self.assertEqual(example["examples"], self.example)