cornflow 1.3.7__tar.gz → 1.3.8__tar.gz

{cornflow-1.3.7/cornflow.egg-info → cornflow-1.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cornflow
-Version: 1.3.7
+Version: 1.3.8
 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
@@ -14,7 +14,7 @@ Requires-Dist: alembic==1.9.2
 Requires-Dist: apispec==6.3.0
 Requires-Dist: cachetools==5.3.3
 Requires-Dist: click==8.1.7
-Requires-Dist: cornflow-client==1.3.7
+Requires-Dist: cornflow-client==1.3.8
 Requires-Dist: cryptography==48.0.1
 Requires-Dist: disposable-email-domains==0.0.162
 Requires-Dist: Flask==2.3.2

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/cli/service.py

@@ -158,12 +158,25 @@ def _setup_environment_variables():
         os.environ["AIRFLOW_PWD"] = airflow_pwd
         os.environ["AIRFLOW_URL"] = airflow_url
     elif cornflow_backend == DATABRICKS_BACKEND:
+        required_databricks_vars = [
+            "DATABRICKS_HOST",
+            "DATABRICKS_CLIENT_SECRET",
+            "DATABRICKS_TOKEN_ENDPOINT",
+            "DATABRICKS_EP_CLUSTERS",
+            "DATABRICKS_CLIENT_ID",
+        ]
+        missing = [var for var in required_databricks_vars if not os.getenv(var)]
+        if missing:
+            sys.exit(
+                "FATAL: the Databricks backend requires the following environment "
+                f"variables to be set: {', '.join(missing)}"
+            )
         databricks_url = os.getenv("DATABRICKS_HOST")
         databricks_auth_secret = os.getenv("DATABRICKS_CLIENT_SECRET")
         databricks_token_endpoint = os.getenv("DATABRICKS_TOKEN_ENDPOINT")
         databricks_ep_clusters = os.getenv("DATABRICKS_EP_CLUSTERS")
         databricks_client_id = os.getenv("DATABRICKS_CLIENT_ID")
-        databricks_health_path = os.getenv("DATABRICKS_HEALTH_PATH")
+        databricks_health_path = os.getenv("DATABRICKS_HEALTH_PATH", "default path")
         os.environ["DATABRICKS_HEALTH_PATH"] = databricks_health_path
         os.environ["DATABRICKS_HOST"] = databricks_url
         os.environ["DATABRICKS_CLIENT_SECRET"] = databricks_auth_secret

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/config.py

@@ -29,7 +29,7 @@ class DefaultConfig(object):
     AUTH_TYPE = int(os.getenv("AUTH_TYPE", AUTH_DB))
     DEFAULT_ROLE = int(os.getenv("DEFAULT_ROLE", PLANNER_ROLE))
     CORS_ORIGINS = os.getenv("CORS_ORIGINS", "*")
-    SQLALCHEMY_TRACK_MODIFICATIONS = True
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
     DEBUG = True
     TESTING = True
     LOG_LEVEL = int(os.getenv("LOG_LEVEL", 20))

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/endpoints/execution.py

@@ -407,7 +407,7 @@ class ExecutionRelaunchEndpoint(OrchestratorMixin):
         )
 
         # If the execution is still running or queued, raise an error
-        if execution.state == 0 or execution.state == -7:
+        if execution.state in (EXEC_STATE_RUNNING, EXEC_STATE_QUEUED):
             return {"message": "This execution is still running"}, 400
 
         # this allows testing without airflow interaction:

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/endpoints/meta_resource.py

@@ -111,16 +111,49 @@ class BaseMetaResource(Resource, MethodResource):
         return {"message": "Created correctly"}, 201
 
     def post_bulk_update(self, data, trace_field="user_id"):
-        """"""
+        """
+        Method to POST a bulk of objects, updating the ones that already exist
+        and creating the ones that do not.
+
+        The rows that already exist are looked up with the fields declared on
+        `self.unique`, regardless of their `deleted_at` value, so a soft deleted
+        row is matched too. On the models that implement the soft delete (the
+        ones with a `deleted_at` column) a match that was deleted is reactivated,
+        clearing its `deleted_at` before applying the update, so it becomes
+        visible again on the reads.
+
+        If no row matches on `self.unique` but the model has soft delete and the
+        payload carries an `id`, the row is looked up by that id as a fallback.
+        A soft deleted row found this way is reactivated the same way as a
+        regular match. If no row is found, or the row found is not deleted, a
+        new instance is created.
+
+        :param dict data: a dictionary with key 'data' that holds a list with all the
+            objects that are going to be created or updated
+        :param str trace_field: the field that tracks the user that created the object
+        :return: a message and a status code of the operation
+        """
         data = [
             {**el, **{trace_field: self.get_user_id()}} for el in dict(data)["data"]
         ]
 
+        has_soft_delete = hasattr(self.data_model, "deleted_at")
+
         instances = []
         for el in data:
             temp_el = dict(SuperDict(el).kfilter(lambda v: v in self.unique))
             temp_instance = self.data_model.query.filter_by(**temp_el).first()
+            if (
+                temp_instance is None
+                and has_soft_delete
+                and el.get("id") is not None
+            ):
+                candidate = self.data_model.query.filter_by(id=el.get("id")).first()
+                if candidate is not None and candidate.deleted_at is not None:
+                    temp_instance = candidate
             if temp_instance is not None:
+                if has_soft_delete and temp_instance.deleted_at is not None:
+                    temp_instance.deleted_at = None
                 temp_instance.pre_update(el)
                 instances.append(temp_instance)
             else:

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/shared/const.py

@@ -7,7 +7,7 @@ AIRFLOW_BACKEND = 1
 DATABRICKS_BACKEND = 2
 
 
-CORNFLOW_VERSION = "1.3.7"
+CORNFLOW_VERSION = "1.3.8"
 INTERNAL_TOKEN_ISSUER = "cornflow"
 
 # endpoints responses for health check

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow/shared/email.py

@@ -31,7 +31,6 @@ def get_email(text: str, subject: str, sender: str, receiver: str):
 
     t = MIMEText(body, "html")
 
-    email.attach(t)
     email.attach(t)
 
     return email.as_string()

cornflow-1.3.8/cornflow/tests/unit/test_meta_resource.py

@@ -0,0 +1,256 @@
+"""
+Unit tests for the BaseMetaResource class.
+
+This module contains tests for the logic that all the resources share, and that no
+endpoint of cornflow exposes on its own: the bulk update. The endpoints that use it
+are the ones that the cli generates (`put_bulk`), so the resource is built here the
+same way `cli/tools/endpoint_tools.py` builds it.
+
+Classes
+-------
+TestPostBulkUpdate
+    Tests for the bulk update on a model with soft delete
+TestPostBulkUpdateNoSoftDelete
+    Tests for the bulk update on a model without soft delete
+TestPostBulkUpdateClientId
+    Tests for the bulk update on the models that take the id from the payload
+"""
+
+# Imports from internal modules
+from cornflow.endpoints.meta_resource import BaseMetaResource
+from cornflow.models import AlarmsModel, RoleModel, ViewModel
+from cornflow.shared.exceptions import InvalidData
+from cornflow.tests.custom_test_case import CustomTestCase
+
+
+class BulkUpdateTestCase(CustomTestCase):
+    """
+    Base test case that builds a resource on top of a model and sends rows to its
+    bulk update.
+    """
+
+    # the model the resource works on, set by each test case
+    data_model = None
+
+    def setUp(self):
+        super().setUp()
+        self.model = self.data_model
+        self.resource = BaseMetaResource()
+        self.resource.data_model = self.data_model
+        # the id is what the generated endpoints use as unique
+        self.resource.unique = ["id"]
+        # the bulk update tracks the user that sends the rows, but there is no request
+        # on these tests, so the user is given directly
+        self.resource.get_user_id = lambda: self.user.id
+
+    def bulk_update(self, rows):
+        """
+        Sends a list of rows to the bulk update of the resource
+
+        :param list rows: the rows to create or update
+        :return: the message and the status code returned by the resource
+        :rtype: Tuple(dict, integer)
+        """
+        return self.resource.post_bulk_update(data={"data": rows})
+
+
+class TestPostBulkUpdate(BulkUpdateTestCase):
+    """
+    Test cases for the bulk update on :class:`AlarmsModel`, a model with soft delete
+    whose id is given by the database.
+    """
+
+    data_model = AlarmsModel
+
+    def create_alarm(self, name, criticality=1, description="Description"):
+        """
+        Creates one alarm directly on the database
+
+        :param str name: the name of the alarm
+        :param float criticality: the criticality of the alarm
+        :param str description: the description of the alarm
+        :return: the created alarm
+        :rtype: :class:`AlarmsModel`
+        """
+        alarm = AlarmsModel(
+            {"name": name, "criticality": criticality, "description": description}
+        )
+        alarm.save()
+        return alarm
+
+    def test_update_existing_row(self):
+        """
+        A row that exists and is not deleted gets updated
+        """
+        alarm = self.create_alarm("Alarm 1")
+
+        _, status = self.bulk_update(
+            [
+                {
+                    "id": alarm.id,
+                    "name": "Alarm 1 edited",
+                    "criticality": 2,
+                    "description": "Description",
+                }
+            ]
+        )
+
+        self.assertEqual(201, status)
+        self.assertEqual(1, AlarmsModel.query.count())
+        self.assertEqual(
+            "Alarm 1 edited", AlarmsModel.get_one_object(idx=alarm.id).name
+        )
+
+    def test_new_row_is_created(self):
+        """
+        A row whose id does not exist yet gets created, and the rows that are already
+        on the table are left alone
+        """
+        kept = self.create_alarm("Alarm 1", description="Keep me")
+
+        _, status = self.bulk_update(
+            [
+                {
+                    "id": kept.id + 100,
+                    "name": "Alarm 2",
+                    "criticality": 1,
+                    "description": "Description",
+                }
+            ]
+        )
+
+        self.assertEqual(201, status)
+        self.assertEqual(2, AlarmsModel.get_all_objects().count())
+        self.assertEqual("Keep me", AlarmsModel.get_one_object(idx=kept.id).description)
+
+    def test_soft_deleted_row_is_reactivated(self):
+        """
+        A row that was soft deleted and is matched by the unique fields is
+        reactivated: its deleted_at is cleared and it is updated with the data sent,
+        instead of a new row being created
+        """
+        self.resource.unique = ["name"]
+        deleted = self.create_alarm("Alarm 1", description="Deleted one")
+        deleted.disable()
+
+        # the row is not visible on the reads any more
+        self.assertEqual(0, AlarmsModel.get_all_objects().count())
+
+        _, status = self.bulk_update(
+            [{"name": "Alarm 1", "criticality": 2, "description": "Resent"}]
+        )
+
+        self.assertEqual(201, status)
+        reactivated = AlarmsModel.query.get(deleted.id)
+        self.assertIsNone(reactivated.deleted_at)
+        self.assertEqual("Resent", reactivated.description)
+        # and it is visible on the reads again
+        visible = AlarmsModel.get_all_objects().all()
+        self.assertEqual(1, len(visible))
+        self.assertEqual(deleted.id, visible[0].id)
+
+
+class TestPostBulkUpdateNoSoftDelete(BulkUpdateTestCase):
+    """
+    Test cases for the bulk update on :class:`ViewModel`, that inherits from
+    EmptyBaseModel and therefore has no deleted_at column.
+    """
+
+    data_model = ViewModel
+
+    def test_update_existing_row(self):
+        """
+        A model without soft delete keeps updating the row that already exists
+        """
+        view = ViewModel.query.first()
+
+        _, status = self.bulk_update(
+            [
+                {
+                    "id": view.id,
+                    "name": view.name,
+                    "url_rule": view.url_rule,
+                    "description": "edited description",
+                }
+            ]
+        )
+
+        self.assertEqual(201, status)
+        self.assertEqual("edited description", ViewModel.query.get(view.id).description)
+
+    def test_new_row_is_created(self):
+        """
+        A model without soft delete keeps creating the rows that do not exist
+        """
+        count = ViewModel.query.count()
+
+        _, status = self.bulk_update(
+            [{"id": 10000, "name": "brand new view", "url_rule": "/brand-new/"}]
+        )
+
+        self.assertEqual(201, status)
+        self.assertEqual(count + 1, ViewModel.query.count())
+        self.assertEqual(1, ViewModel.query.filter_by(name="brand new view").count())
+
+
+class TestPostBulkUpdateClientId(BulkUpdateTestCase):
+    """
+    Test cases for the bulk update on the models that take the id from the payload,
+    the same way the models that the cli generates do.
+    """
+
+    data_model = RoleModel
+
+    def test_id_of_a_soft_deleted_row_is_reactivated(self):
+        """
+        The id of a soft deleted row can be given again to the bulk update: the row
+        that holds it is reactivated and updated with the data sent, instead of
+        failing on the primary key or being left deleted
+        """
+        deleted = RoleModel({"id": 99, "name": "a role"})
+        deleted.save()
+        deleted.disable()
+
+        _, status = self.bulk_update([{"id": 99, "name": "a role resent"}])
+
+        self.assertEqual(201, status)
+        reactivated = RoleModel.query.get(99)
+        self.assertIsNone(reactivated.deleted_at)
+        self.assertEqual("a role resent", reactivated.name)
+        # and it is visible on the reads again
+        self.assertIsNotNone(RoleModel.get_one_object(idx=99))
+
+    def test_id_of_a_live_row_is_not_rejected(self):
+        """
+        An id held by a row that is not deleted is not the case that is rejected: it
+        keeps failing on the primary key, the way it did before
+        """
+        live = RoleModel({"id": 98, "name": "a live role"})
+        live.save()
+        self.resource.unique = ["name"]
+
+        with self.assertRaises(InvalidData):
+            self.bulk_update([{"id": 98, "name": "another role"}])
+
+        self.assertEqual("a live role", RoleModel.query.get(98).name)
+
+    def test_id_of_a_soft_deleted_row_is_reactivated_when_unique_differs(self):
+        """
+        When the unique fields do not match a soft deleted row, its id can still be
+        given again to the bulk update: the row that holds it is reactivated and
+        updated with the data sent, instead of failing on the primary key or a new
+        row being created
+        """
+        self.resource.unique = ["name"]
+        deleted = RoleModel({"id": 97, "name": "a role"})
+        deleted.save()
+        deleted.disable()
+
+        _, status = self.bulk_update([{"id": 97, "name": "a role renamed"}])
+
+        self.assertEqual(201, status)
+        reactivated = RoleModel.query.get(97)
+        self.assertIsNone(reactivated.deleted_at)
+        self.assertEqual("a role renamed", reactivated.name)
+        # and it is visible on the reads again
+        self.assertIsNotNone(RoleModel.get_one_object(idx=97))

{cornflow-1.3.7 → cornflow-1.3.8/cornflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cornflow
-Version: 1.3.7
+Version: 1.3.8
 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
@@ -14,7 +14,7 @@ Requires-Dist: alembic==1.9.2
 Requires-Dist: apispec==6.3.0
 Requires-Dist: cachetools==5.3.3
 Requires-Dist: click==8.1.7
-Requires-Dist: cornflow-client==1.3.7
+Requires-Dist: cornflow-client==1.3.8
 Requires-Dist: cryptography==48.0.1
 Requires-Dist: disposable-email-domains==0.0.162
 Requires-Dist: Flask==2.3.2

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow.egg-info/SOURCES.txt

@@ -180,6 +180,7 @@ cornflow/tests/unit/test_instances_file.py
 cornflow/tests/unit/test_licenses.py
 cornflow/tests/unit/test_log_in.py
 cornflow/tests/unit/test_main_alarms.py
+cornflow/tests/unit/test_meta_resource.py
 cornflow/tests/unit/test_permissions.py
 cornflow/tests/unit/test_roles.py
 cornflow/tests/unit/test_schema_from_models.py

{cornflow-1.3.7 → cornflow-1.3.8}/cornflow.egg-info/requires.txt

@@ -2,7 +2,7 @@ alembic==1.9.2
 apispec==6.3.0
 cachetools==5.3.3
 click==8.1.7
-cornflow-client==1.3.7
+cornflow-client==1.3.8
 cryptography==48.0.1
 disposable-email-domains==0.0.162
 Flask==2.3.2

{cornflow-1.3.7 → cornflow-1.3.8}/requirements.txt

@@ -2,7 +2,7 @@ alembic==1.9.2
 apispec==6.3.0
 cachetools==5.3.3
 click==8.1.7
-cornflow-client==1.3.7
+cornflow-client==1.3.8
 cryptography==48.0.1
 disposable-email-domains==0.0.162
 Flask==2.3.2

{cornflow-1.3.7 → cornflow-1.3.8}/setup.py

@@ -9,7 +9,7 @@ with open("requirements.txt", "r") as fh:
 
 setuptools.setup(
     name="cornflow",
-    version="1.3.7",
+    version="1.3.8",
     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.",