cornflow 1.1.0a1__py3-none-any.whl → 1.1.0a2__py3-none-any.whl

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/endpoints/example_data.py

@@ -1,36 +1,78 @@
 """
 Endpoints to get the example data from a DAG
 """
+import json
 
-# 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.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
+from cornflow.shared.exceptions import AirflowError, NoPermission, ObjectDoesNotExist
 
 
-class ExampleDataDetailsEndpoint(BaseMetaResource):
+class ExampleDataListEndpoint(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"])
+    @doc(description="Get lsit of example data from DAG", tags=["DAG"])
     @authenticate(auth_class=Auth())
-    @marshal_with(ExampleData)
+    @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)
         """
@@ -54,15 +96,24 @@ class ExampleDataDetailsEndpoint(BaseMetaResource):
 
             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
+            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
+                log_txt=f"Error while user {user} tries to get example data for dag {dag_name}. "
+                + err,
             )

cornflow/schemas/example_data.py

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

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/tests/unit/test_example_data.py

@@ -1,15 +1,9 @@
-"""
-
-"""
-
-# General imports
 import json
 
-# Partial imports
-from unittest.mock import patch
 
+from unittest.mock import patch
 
-# Imports from internal modules
+from cornflow.models import PermissionsDAG
 from cornflow.tests.const import EXAMPLE_URL, INSTANCE_PATH
 from cornflow.tests.custom_test_case import CustomTestCase
 
@@ -23,7 +17,18 @@ class TestExampleDataEndpoint(CustomTestCase):
                 temp = json.load(f)
             return temp
 
-        self.example = load_file(INSTANCE_PATH)
+        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"
 
@@ -38,17 +43,82 @@ class TestExampleDataEndpoint(CustomTestCase):
         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_example(self, airflow_init):
+    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(
-            self.url + "{}/".format(self.schema_name),
+            f"{self.url}/{self.schema_name}/test_example_1/",
             {},
             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)
+        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.dist-info → cornflow-1.1.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 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
@@ -15,7 +15,7 @@ Requires-Python: >=3.8
 Requires-Dist: alembic ==1.9.2
 Requires-Dist: apispec <=6.2.0
 Requires-Dist: click <=8.1.3
-Requires-Dist: cornflow-client ==1.1.0a1
+Requires-Dist: cornflow-client ==1.1.0a2
 Requires-Dist: cryptography <=42.0.5
 Requires-Dist: disposable-email-domains >=0.0.86
 Requires-Dist: Flask ==2.3.2

{cornflow-1.1.0a1.dist-info → cornflow-1.1.0a2.dist-info}/RECORD

@@ -37,14 +37,14 @@ cornflow/commands/roles.py,sha256=Oux-UkswkQ74zqaMEJYIEsZpQZGBcGaSahVzx9feAHU,15
 cornflow/commands/schemas.py,sha256=QjLXLw5So3f8ZqTg5_uvXxwpo4vE0dMT4_gFMKZHGvQ,1828
 cornflow/commands/users.py,sha256=MEfqMm2ujso0NQgdUm-crOet-G0M43GNqVCx2Ls-2HY,2591
 cornflow/commands/views.py,sha256=K2Ld1-l1ZKn9m6e2W1LCxmN44QokwR-8u8rIrviiEf8,2276
-cornflow/endpoints/__init__.py,sha256=EGUIDL5EGsDQtm1YQ4aKkmRG1roW_3Ki87MeZr79Lx0,7168
+cornflow/endpoints/__init__.py,sha256=RI-cNRxYFCuYELPdM0kDDgJhopMMX88HJe-ArTTilNM,7346
 cornflow/endpoints/action.py,sha256=ksHK3F919cjkONLcFV2tUIbG-eZw5XbYkqVjYx9iq5I,1359
 cornflow/endpoints/alarms.py,sha256=3FN7mosBFP_DcJQxfg1h5_phy755FYESXyQ62XpvFbs,1956
 cornflow/endpoints/apiview.py,sha256=cpxZFkWy6yrRHiAq2tseyVAK1r8uvjnFuOgJjGT0rKI,1370
 cornflow/endpoints/case.py,sha256=80Fpv9p8mwIXzjQFuyq1PnPTz3RaOUk932sCUfw7yGA,18670
 cornflow/endpoints/dag.py,sha256=MRthA2pnZCAFfoPbHCLDW2j1BsQ3WdjRGC17Szl4b28,10390
 cornflow/endpoints/data_check.py,sha256=ZyYR84IT9snjXxUrQfrlv_RzOec_AYeTsijuHYdLAcA,16496
-cornflow/endpoints/example_data.py,sha256=fzolSYl1sYCSCR4Ctr7QD9JM3NdxCjBiiQLVxCPCbJg,2441
+cornflow/endpoints/example_data.py,sha256=1_qAtZfp51N9sU8WCFDZCXOQiOlxCKJjWbXxDOFZ0C8,4372
 cornflow/endpoints/execution.py,sha256=5SWwgbxBUj_gDU6Yb7Z-iKNakr9vr3g5qU82Bw9y5wQ,27998
 cornflow/endpoints/health.py,sha256=TWmWjKdQOoDzpqwcfksuaAGOLIb2idxzPQcGMWrdkCY,1610
 cornflow/endpoints/instance.py,sha256=WAnloocXFxSW4vunBJo3CIHx4NzC_0GPJh5bj3ETd9U,11615
@@ -101,7 +101,7 @@ cornflow/schemas/alarms.py,sha256=Y-VQ93jbDLtEv49qkNDHwrhwkG7OzEQ0nceqJCqeScQ,54
 cornflow/schemas/case.py,sha256=OXRsDi_sdB47MQJ59S_1eMjDmLlpUtG7kTFNInV2-cI,2909
 cornflow/schemas/common.py,sha256=QYuxWcOl4smXFZr_vL07OVgH9H50ZywCrXxycVNr1qA,473
 cornflow/schemas/dag.py,sha256=0ENA75X9L8YqjJW6ZO1Sb4zE8OxB15_O49_nwA6eAVw,901
-cornflow/schemas/example_data.py,sha256=7BeaujSgj10RHK6Z__4wRZ273-QmVjVOs6uEvYw7PnE,146
+cornflow/schemas/example_data.py,sha256=hbE8TJakFqOweHXiA3mduNETM6FCX6xLTiQuH3EkSTc,281
 cornflow/schemas/execution.py,sha256=GSRHzikVPlhxMdiKrGnTuGfen8_Lf4wSfheJwvcavTs,4718
 cornflow/schemas/health.py,sha256=D2NsP9i6nA1hLema-bvegrrdH4JY7pZlYxPcqRJOvao,141
 cornflow/schemas/instance.py,sha256=qr4km0AlAhoNf9G1Il-pfHphT_vAiiLDpv7A9S3FKAw,1870
@@ -146,11 +146,11 @@ cornflow/tests/unit/test_actions.py,sha256=Fg33PyzNTK4B4NjARelMxLQpQl9nE9Jppolkk
 cornflow/tests/unit/test_alarms.py,sha256=J4Hp2xIZqpFrojx_RvQCSU1ilDk-iC0vm2z8wZNXwIw,1343
 cornflow/tests/unit/test_apiview.py,sha256=G5DpUPaKVXgbCOaXXTCjBAeGeCtfR8niltp7B0NNB6o,2107
 cornflow/tests/unit/test_cases.py,sha256=lXLgvHbNGw8qUoCtYUwwXE_O2AWSmSXxLVlxE-hc9Oc,25974
-cornflow/tests/unit/test_cli.py,sha256=IK7nhPpVy2dSXGRSies_Lh9DImNaL2SFCXb-gxKUmDI,12578
+cornflow/tests/unit/test_cli.py,sha256=qYcMGAdLIOhTgWV4q0rGu0bv5Bs7JUIsyRd5qt6pcOI,12578
 cornflow/tests/unit/test_commands.py,sha256=QwGHTOxBOwiIYYQg8wcmSR11lKQk0I8Ltr3sbFERufw,8776
 cornflow/tests/unit/test_dags.py,sha256=5lTJW_fgh7XXE11Zo9yVsQ7wsmbCPxCCRwna2vkPEuA,10350
 cornflow/tests/unit/test_data_checks.py,sha256=VjB3AAQOHlqnaRT2jI9L2mNLDAcda6llpiZWkW7nnkk,5471
-cornflow/tests/unit/test_example_data.py,sha256=TR6b7ekpc6pLOpDnlKl3fHe-FD7gXw5M1JGVj-Dlfvk,1605
+cornflow/tests/unit/test_example_data.py,sha256=D-Tgnqw7NZlnBXaDcUU0reNhAca5JlJP2Sdn3KdS4Sw,4127
 cornflow/tests/unit/test_executions.py,sha256=_hIaiZri7Blyx4DYhBDHh-0peU1HQh66RSPqQJFveE8,17501
 cornflow/tests/unit/test_generate_from_schema.py,sha256=L1EdnASbDJ8SjrX1V4WnUKKwV0sRTwVnNYnxSpyeSeQ,15376
 cornflow/tests/unit/test_health.py,sha256=0E0HXMb63_Z8drbLZdxnJwtTbQyaZS9ZEHut6qsDbh8,1033
@@ -168,8 +168,8 @@ cornflow/tests/unit/test_tables.py,sha256=dY55YgaCkyqwJnqn0LbZHNeXBoL4ZxXWwKkCoT
 cornflow/tests/unit/test_token.py,sha256=OEVPgG8swSMkUbuGJGfGF5Z27utMLICn1eIyma1cM9E,3760
 cornflow/tests/unit/test_users.py,sha256=WfaMcybPpR7rspXyvzHGgw25p751hMPAV0DOp_caSPM,22430
 cornflow/tests/unit/tools.py,sha256=ag3sWv2WLi498R1GL5AOUnXqSsszD3UugzLZLC5NqAw,585
-cornflow-1.1.0a1.dist-info/METADATA,sha256=TFEqw1OCDTa8w9adMHT5zMsibVdTOrokQgEYHG6wRkc,9402
-cornflow-1.1.0a1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-cornflow-1.1.0a1.dist-info/entry_points.txt,sha256=r5wKLHpuyVLMUIZ5I29_tpqYf-RuP-3w_8DhFi8_blQ,47
-cornflow-1.1.0a1.dist-info/top_level.txt,sha256=Qj9kLFJW1PLb-ZV2s_aCkQ-Wi5W6KC6fFR-LTBrx-rU,24
-cornflow-1.1.0a1.dist-info/RECORD,,
+cornflow-1.1.0a2.dist-info/METADATA,sha256=Q3l-3geC8Y0gRpUe4cqdRz8NTtZ53IZ8eo6s_wdqyNc,9402
+cornflow-1.1.0a2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+cornflow-1.1.0a2.dist-info/entry_points.txt,sha256=r5wKLHpuyVLMUIZ5I29_tpqYf-RuP-3w_8DhFi8_blQ,47
+cornflow-1.1.0a2.dist-info/top_level.txt,sha256=Qj9kLFJW1PLb-ZV2s_aCkQ-Wi5W6KC6fFR-LTBrx-rU,24
+cornflow-1.1.0a2.dist-info/RECORD,,