cornflow 1.0.7__py3-none-any.whl → 1.0.8a1__py3-none-any.whl

cornflow/cli/schemas.py

@@ -25,7 +25,7 @@ def schemas():
 
 @schemas.command(
     name="generate_from_schema",
-    help="Command to generate models, endpoints and schemas from a jsonschema"
+    help="Command to generate models, endpoints and schemas from a jsonschema",
 )
 @click.option(
     "--path", "-p", type=str, help="The absolute path to the JSONSchema", required=True
@@ -70,7 +70,13 @@ def schemas():
     required=False,
 )
 def generate_from_schema(
-    path, app_name, output_path, remove_methods, one, endpoints_methods, endpoints_access
+    path,
+    app_name,
+    output_path,
+    remove_methods,
+    one,
+    endpoints_methods,
+    endpoints_access,
 ):
     """
     This method is executed for the command and creates all the files for the REST API from the provided JSONSchema
@@ -126,59 +132,64 @@ def generate_from_schema(
         output_path=output_path,
         options=methods_to_add,
         name_table=name_table,
-        endpoints_access=dict_endpoints_access
+        endpoints_access=dict_endpoints_access,
     ).main()
 
 
-@schemas.command(name="schema_from_models", help="Command to generate a jsonschema from a set of models")
-@click.option(
-    "--path",
-    "-p",
-    type=str,
-    help="The absolute path to folder containing the models",
-    required=True,
-)
-@click.option("--output-path", "-o", type=str, help="The output path", required=False)
-@click.option(
-    "--ignore-files",
-    "-i",
-    type=str,
-    help="Files that will be ignored (with the .py extension). "
-    "__init__.py files are automatically ignored. Ex: 'instance.py'",
-    multiple=True,
-    required=False,
-)
-@click.option(
-    "--leave-bases/--no-leave-bases",
-    "-l/-nl",
-    default=False,
-    help="Use this option to leave the bases classes BaseDataModel, "
-    "EmptyModel and TraceAttributes in the schema. By default, they will be deleted",
-)
-def schema_from_models(path, output_path, ignore_files, leave_bases):
-    """
-
-    :param str path: the path to the folder that contains the models
-    :param output_path: the output path where the JSONSchema should be placed
-    :param str ignore_files: files to be ignored.
-    :param str leave_bases: if the JSONSchema should have abstract classes used as the base for other clases.
-    :return: a click status code
-    :rtype: int
-    """
-    path = path.replace("\\", "/")
-    output = None
-    if output_path:
-        output = output_path.replace("\\", "/")
-
-    if ignore_files:
-        ignore_files = list(ignore_files)
-
-    click.echo("Generating JSONSchema file from the REST API")
-    click.echo(f"The path to the JSONSchema is {path}")
-    click.echo(f"The output_path is {output}")
-    click.echo(f"The ignore_files is {ignore_files}")
-    click.echo(f"The leave_bases is {leave_bases}")
-
-    SchemaGenerator(
-        path, output_path=output, ignore_files=ignore_files, leave_bases=leave_bases
-    ).main()
+# @schemas.command(
+#     name="schema_from_models",
+#     help="Command to generate a jsonschema from a set of models",
+# )
+# @click.option(
+#     "--path",
+#     "-p",
+#     type=str,
+#     help="The absolute path to folder containing the models",
+#     required=True,
+# )
+# @click.option("--output-path", "-o", type=str, help="The output path", required=False)
+# @click.option(
+#     "--ignore-files",
+#     "-i",
+#     type=str,
+#     help="Files that will be ignored (with the .py extension). "
+#     "__init__.py files are automatically ignored. Ex: 'instance.py'",
+#     multiple=True,
+#     required=False,
+# )
+# @click.option(
+#     "--leave-bases/--no-leave-bases",
+#     "-l/-nl",
+#     default=False,
+#     help="Use this option to leave the bases classes BaseDataModel, "
+#     "EmptyModel and TraceAttributes in the schema. By default, they will be deleted",
+# )
+# def schema_from_models(path, output_path, ignore_files, leave_bases):
+#     """
+#
+#     :param str path: the path to the folder that contains the models
+#     :param output_path: the output path where the JSONSchema should be placed
+#     :param str ignore_files: files to be ignored.
+#     :param str leave_bases: if the JSONSchema should have abstract classes used as the base for other clases.
+#     :return: a click status code
+#     :rtype: int
+#     """
+#     path = path.replace("\\", "/")
+#     output = None
+#     if output_path:
+#         output = output_path.replace("\\", "/")
+#
+#     if ignore_files:
+#         ignore_files = list(ignore_files)
+#
+#     click.echo("Generating JSONSchema file from the REST API")
+#     click.echo(f"The path to the JSONSchema is {path}")
+#     click.echo(f"The output_path is {output}")
+#     click.echo(f"The ignore_files is {ignore_files}")
+#     click.echo(f"The leave_bases is {leave_bases}")
+#
+#     SchemaGenerator(
+#         path, output_path=output, ignore_files=ignore_files, leave_bases=leave_bases
+#     ).main()
+#
+#     return True

cornflow/cli/tools/schema_generator.py

@@ -6,6 +6,8 @@ import json
 import importlib.util
 from distutils.dir_util import copy_tree
 from unittest.mock import MagicMock
+
+import click
 from flask_sqlalchemy import SQLAlchemy
 import shutil
 from pytups import TupList, SuperDict
@@ -15,7 +17,6 @@ from sqlalchemy.sql.sqltypes import Integer
 
 class SchemaGenerator:
     def __init__(self, path, output_path=None, ignore_files=None, leave_bases=False):
-
         self.path = path
         self.tmp_path = os.path.join(os.getcwd(), "tmp_files")
         self.output_path = output_path or "./output_schema.json"
@@ -76,7 +77,6 @@ class SchemaGenerator:
         db = SQLAlchemy()
         try:
             for file_path, file_name in files:
-
                 spec = importlib.util.spec_from_file_location(file_name, file_path)
                 mod = importlib.util.module_from_spec(spec)
 
@@ -142,7 +142,7 @@ class SchemaGenerator:
 
             db.session.close()
         except Exception as err:
-            print(err)
+            click.echo(err)
 
     def inherit(self):
         all_classes = set(self.parents.keys())

cornflow/endpoints/execution.py

@@ -39,7 +39,11 @@ from cornflow.shared.const import (
     EXEC_STATE_QUEUED,
 )
 from cornflow.shared.exceptions import AirflowError, ObjectDoesNotExist, InvalidData
-from cornflow.shared.validators import json_schema_validate_as_string
+from cornflow.shared.validators import (
+    json_schema_validate_as_string,
+    json_schema_extend_and_validate_as_string,
+)
+
 
 class ExecutionEndpoint(BaseMetaResource):
     """
@@ -76,12 +80,10 @@ class ExecutionEndpoint(BaseMetaResource):
         ]
 
         running_executions = [
-            execution for execution in executions
-            if execution.state in [
-                EXEC_STATE_RUNNING,
-                EXEC_STATE_QUEUED,
-                EXEC_STATE_UNKNOWN
-            ]
+            execution
+            for execution in executions
+            if execution.state
+            in [EXEC_STATE_RUNNING, EXEC_STATE_QUEUED, EXEC_STATE_UNKNOWN]
         ]
 
         for execution in running_executions:
@@ -146,14 +148,6 @@ class ExecutionEndpoint(BaseMetaResource):
             user=self.get_user(), idx=execution.instance_id
         )
 
-        if instance is None:
-            err = "The instance to solve does not exist"
-            raise ObjectDoesNotExist(
-                error=err,
-                log_txt=f"Error while user {self.get_user()} tries to create an execution "
-                f"for instance {execution.instance_id}. " + err,
-            )
-
         current_app.logger.debug(f"The request is: {request.args.get('run')}")
         # this allows testing without airflow interaction:
         if request.args.get("run", "1") == "0":
@@ -184,7 +178,9 @@ class ExecutionEndpoint(BaseMetaResource):
 
         # Validate config before running the dag
         config_schema = DeployedDAG.get_one_schema(config, schema, CONFIG_SCHEMA)
-        config_errors = json_schema_validate_as_string(config_schema, kwargs["config"])
+        new_config, config_errors = json_schema_extend_and_validate_as_string(
+            config_schema, kwargs["config"]
+        )
         if config_errors:
             execution.update_state(
                 EXEC_STATE_ERROR_START,
@@ -197,6 +193,8 @@ class ExecutionEndpoint(BaseMetaResource):
                 log_txt=f"Error while user {self.get_user()} tries to create an execution. "
                 f"Configuration data does not match the jsonschema.",
             )
+        elif new_config != kwargs["config"]:
+            execution.update_config(new_config)
 
         # Validate instance data before running the dag
         instance_schema = DeployedDAG.get_one_schema(config, schema, INSTANCE_SCHEMA)
@@ -326,7 +324,9 @@ class ExecutionRelaunchEndpoint(BaseMetaResource):
             }, 201
 
         # Validate config before running the dag
-        config_schema = DeployedDAG.get_one_schema(config, kwargs["schema"], CONFIG_SCHEMA)
+        config_schema = DeployedDAG.get_one_schema(
+            config, kwargs["schema"], CONFIG_SCHEMA
+        )
         config_errors = json_schema_validate_as_string(config_schema, kwargs["config"])
         if config_errors:
             raise InvalidData(
@@ -444,14 +444,18 @@ class ExecutionDetailsEndpoint(ExecutionDetailsEndpointBase):
         schema = ExecutionModel.get_one_object(user=self.get_user(), idx=idx).schema
 
         if data.get("data") is not None and schema is not None:
-            data_jsonschema = DeployedDAG.get_one_schema(config, schema, SOLUTION_SCHEMA)
-            validation_errors = json_schema_validate_as_string(data_jsonschema, data["data"])
+            data_jsonschema = DeployedDAG.get_one_schema(
+                config, schema, SOLUTION_SCHEMA
+            )
+            validation_errors = json_schema_validate_as_string(
+                data_jsonschema, data["data"]
+            )
 
             if validation_errors:
                 raise InvalidData(
                     payload=dict(jsonschema_errors=validation_errors),
                     log_txt=f"Error while user {self.get_user()} tries to edit execution {idx}. "
-                            f"Solution data does not match the jsonschema.",
+                    f"Solution data does not match the jsonschema.",
                 )
 
         current_app.logger.info(f"User {self.get_user()} edits execution {idx}")

cornflow/models/dag.py

@@ -71,7 +71,8 @@ class DeployedDAG(TraceAttributesModel):
             jsonschema = item.instance_checks_schema
         elif schema == SOLUTION_CHECKS_SCHEMA:
             jsonschema = item.solution_checks_schema
-        else:           # schema == CONFIG_SCHEMA
+        # schema == CONFIG_SCHEMA
+        else:
             jsonschema = item.config_schema
 
         if jsonschema is None:

cornflow/models/execution.py

@@ -99,6 +99,16 @@ class ExecutionModel(BaseDataModel):
             self.checks = None
         super().update(data)
 
+    def update_config(self, config: dict):
+        """
+        Method to update the config of the execution after extending with default values
+
+        :param dict config: The config to store
+        :return: nothing
+        """
+        self.config = config
+        super().update({})
+
     def update_state(self, code, message=None):
         """
         Method to update the state code and message of an execution

cornflow/shared/validators.py

@@ -4,8 +4,9 @@ This file has several validators
 import re
 from typing import Tuple, Union
 
-from jsonschema import Draft7Validator
+from jsonschema import Draft7Validator, validators
 from disposable_email_domains import blocklist
+from jsonschema.protocols import Validator
 
 
 def is_special_character(character):
@@ -66,6 +67,27 @@ def check_email_pattern(email: str) -> Tuple[bool, Union[str, None]]:
     return True, None
 
 
+def extend_with_default(validator_class):
+    """
+    Method to extend a validator, so it extends the data with the default values defined on the jsonschema
+    """
+    validate_properties = validator_class.VALIDATORS["properties"]
+
+    def set_defaults(validator, properties, instance, schema):
+        for prop, sub in properties.items():
+            if "default" in sub:
+                instance.setdefault(prop, sub["default"])
+        for error in validate_properties(
+            validator,
+            properties,
+            instance,
+            schema,
+        ):
+            yield error
+
+    return validators.extend(validator_class, {"properties": set_defaults})
+
+
 def json_schema_validate(schema: dict, data: dict) -> list:
     """
     Method to validate some data against a json schema
@@ -81,6 +103,23 @@ def json_schema_validate(schema: dict, data: dict) -> list:
     return []
 
 
+def json_schema_extend_and_validate(schema: dict, data: dict) -> Tuple[dict, list]:
+    """
+    Method to validate som data, extend it with default values and give back the processed errors
+
+    :param dict schema: the json schema in dict format.
+    :param dict data: the data to validate in dict format
+    :return: a tuple with the data extended and the errors found
+    :rtype: tuple
+    """
+    data_cp = dict(data)
+    default_validator = extend_with_default(Draft7Validator)
+    validator = default_validator(schema)
+    if not validator.is_valid(data_cp):
+        return data_cp, [e for e in validator.iter_errors(data_cp)]
+    return data_cp, []
+
+
 def json_schema_validate_as_string(schema: dict, data: dict) -> list:
     """
     Method to validate some data against a json schema
@@ -91,3 +130,18 @@ def json_schema_validate_as_string(schema: dict, data: dict) -> list:
     :rtype: list
     """
     return [str(e) for e in json_schema_validate(schema, data)]
+
+
+def json_schema_extend_and_validate_as_string(
+    schema: dict, data: dict
+) -> Tuple[dict, list]:
+    """
+    Method to extend the schema with default values and give back the processed error
+
+    :param dict schema: the json schema in dict format.
+    :param dict data: the data to validate in dict format
+    :return: a tuple with the data extended and the errors found
+    :rtype: tuple
+    """
+    data_cp, errors = json_schema_extend_and_validate(schema, data)
+    return data_cp, [str(e) for e in errors]

cornflow/tests/const.py

@@ -16,6 +16,8 @@ INSTANCE_GC_20 = _get_file("./data/gc_20_7.json")
 INSTANCE_FILE_FAIL = _get_file("./unit/test_instances.py")
 
 EXECUTION_PATH = _get_file("./data/new_execution.json")
+BAD_EXECUTION_PATH = _get_file("./data/bad_execution.json")
+EXECUTION_SOLUTION_PATH = _get_file("./data/new_execution_solution.json")
 EXECUTIONS_LIST = [EXECUTION_PATH, _get_file("./data/new_execution_2.json")]
 EXECUTION_URL = PREFIX + "/execution/"
 EXECUTION_URL_NORUN = EXECUTION_URL + "?run=0"
@@ -63,6 +65,8 @@ TABLES_URL = PREFIX + "/table/"
 ALARMS_URL = PREFIX + "/alarms/"
 MAIN_ALARMS_URL = PREFIX + "/main-alarms/"
 
+LICENSES_URL = PREFIX + "/licences/"
+
 PUBLIC_DAGS = [
     "solve_model_dag",
     "gc",

cornflow/tests/unit/test_executions.py

@@ -16,6 +16,8 @@ from cornflow.tests.const import (
     EXECUTION_URL_NORUN,
     INSTANCE_URL,
     DAG_URL,
+    BAD_EXECUTION_PATH,
+    EXECUTION_SOLUTION_PATH,
 )
 from cornflow.tests.custom_test_case import CustomTestCase, BaseTestCases
 from cornflow.tests.unit.tools import patch_af_client
@@ -38,7 +40,9 @@ class TestExecutionsListEndpoint(BaseTestCases.ListFilters):
             return temp
 
         self.payload = load_file_fk(EXECUTION_PATH)
+        self.bad_payload = load_file_fk(BAD_EXECUTION_PATH)
         self.payloads = [load_file_fk(f) for f in EXECUTIONS_LIST]
+        self.solution = load_file_fk(EXECUTION_SOLUTION_PATH)
 
     def test_new_execution(self):
         self.create_new_row(self.url, self.model, payload=self.payload)
@@ -49,6 +53,55 @@ class TestExecutionsListEndpoint(BaseTestCases.ListFilters):
 
         self.create_new_row(EXECUTION_URL, self.model, payload=self.payload)
 
+    @patch("cornflow.endpoints.execution.Airflow")
+    def test_new_execution_bad_config(self, af_client_class):
+        patch_af_client(af_client_class)
+        response = self.create_new_row(
+            EXECUTION_URL,
+            self.model,
+            payload=self.bad_payload,
+            expected_status=400,
+            check_payload=False,
+        )
+        self.assertIn("error", response)
+        self.assertIn("jsonschema_errors", response)
+
+    @patch("cornflow.endpoints.execution.Airflow")
+    def test_new_execution_partial_config(self, af_client_class):
+        patch_af_client(af_client_class)
+        self.payload["config"].pop("solver")
+        response = self.create_new_row(
+            EXECUTION_URL, self.model, payload=self.payload, check_payload=False
+        )
+        self.assertIn("solver", response["config"])
+        self.assertEqual(response["config"]["solver"], "cbc")
+
+    @patch("cornflow.endpoints.execution.Airflow")
+    def test_new_execution_with_solution(self, af_client_class):
+        patch_af_client(af_client_class)
+        self.payload["data"] = self.solution
+        response = self.create_new_row(
+            EXECUTION_URL,
+            self.model,
+            payload=self.payload,
+            check_payload=False,
+        )
+
+    @patch("cornflow.endpoints.execution.Airflow")
+    def test_new_execution_with_solution_bad(self, af_client_class):
+        patch_af_client(af_client_class)
+        patch_af_client(af_client_class)
+        self.payload["data"] = {"message": "THIS IS NOT A VALID SOLUTION"}
+        response = self.create_new_row(
+            EXECUTION_URL,
+            self.model,
+            payload=self.payload,
+            check_payload=False,
+            expected_status=400,
+        )
+        self.assertIn("error", response)
+        self.assertIn("jsonschema_errors", response)
+
     def test_new_execution_no_instance(self):
         payload = dict(self.payload)
         payload["instance_id"] = "bad_id"
@@ -281,11 +334,7 @@ class TestExecutionsDetailEndpoint(
     def test_stop_execution(self, af_client_class):
         patch_af_client(af_client_class)
 
-        idx = self.create_new_row(
-            EXECUTION_URL,
-            self.model,
-            payload=self.payload
-        )
+        idx = self.create_new_row(EXECUTION_URL, self.model, payload=self.payload)
 
         response = self.client.post(
             self.url + str(idx) + "/",
@@ -347,11 +396,13 @@ class TestExecutionsStatusEndpoint(TestExecutionsDetailEndpointMock):
     @patch("cornflow.endpoints.execution.Airflow")
     def test_get_one_status(self, af_client_class):
         patch_af_client(af_client_class)
-    
+
         idx = self.create_new_row(EXECUTION_URL, self.model, self.payload)
         payload = dict(self.payload)
         payload["id"] = idx
-        data = self.get_one_row(EXECUTION_URL + idx + "/status/", payload, check_payload=False)
+        data = self.get_one_row(
+            EXECUTION_URL + idx + "/status/", payload, check_payload=False
+        )
         self.assertEqual(data["state"], 1)
 
     @patch("cornflow.endpoints.execution.Airflow")

cornflow/tests/unit/test_licenses.py

@@ -0,0 +1,45 @@
+from cornflow.endpoints import LicensesEndpoint
+from cornflow.tests.const import LICENSES_URL, _get_file
+from cornflow.tests.custom_test_case import CustomTestCase
+
+
+class TestLicensesListEndpoint(CustomTestCase):
+    @staticmethod
+    def read_requirements():
+        with open(_get_file("../../requirements.txt")) as req:
+            content = req.read()
+            requirements = content.split("\n")
+
+        requirements = [
+            r.split("=")[0].split(">")[0].split("<")[0].lower()
+            for r in requirements
+            if r != ""
+        ]
+        return requirements
+
+    def setUp(self):
+        super().setUp()
+        self.roles_with_access = LicensesEndpoint.ROLES_WITH_ACCESS
+        self.libraries = self.read_requirements()
+
+    def tearDown(self):
+        super().tearDown()
+
+    def test_get_licenses(self):
+        for role in self.roles_with_access:
+            self.token = self.create_user_with_role(role)
+            response = self.client.get(
+                LICENSES_URL,
+                follow_redirects=True,
+                headers={
+                    "Content-Type": "application/json",
+                    "Authorization": "Bearer " + self.token,
+                },
+            )
+
+            self.assertEqual(200, response.status_code)
+            self.assertIsInstance(response.json, list)
+            libraries = [k["library"].lower() for k in response.json]
+
+            for lib in self.libraries:
+                self.assertIn(lib, libraries)

cornflow/tests/unit/test_schema_from_models.py

@@ -1,124 +1,135 @@
-import unittest
-import json
-import os
-
-from click.testing import CliRunner
-
-from cornflow.cli import cli
-
-path_to_tests = os.path.dirname(os.path.abspath(__file__))
-
-
-class SchemaFromModelsTests(unittest.TestCase):
-    def setUp(self):
-        super().setUp()
-        self.models_path = self._get_path("../data/models")
-        self.output_path = self._get_path(os.path.join(os.getcwd(), "test_output.json"))
-
-    @staticmethod
-    def import_schema(path):
-        with open(path, "r") as fd:
-            schema = json.load(fd)
-        return schema
-
-    @staticmethod
-    def _get_path(rel_path):
-        return os.path.join(path_to_tests, rel_path)
-
-    def tearDown(self):
-        if os.path.exists(self.output_path):
-            os.remove(self.output_path)
-
-    def test_base(self):
-        runner = CliRunner()
-        result = runner.invoke(
-            cli,
-            [
-                "schemas",
-                "schema_from_models",
-                "-p",
-                self.models_path,
-                "-o",
-                self.output_path
-            ]
-        )
-
-        self.assertEqual(result.exit_code, 0)
-
-        schema = self.import_schema(self._get_path(self.output_path))
-
-        tables = {
-            "instances": {
-                "id": "string",
-                "data": "object",
-                "checks": "object",
-                "name": "string",
-                "description": "string",
-            },
-            "actions": {"id": "integer", "name": "string"},
-            "permission_dag": {
-                "id": "integer",
-                "dag_id": "string",
-                "user_id": "integer",
-            },
-            "permission_view": {
-                "id": "integer",
-                "action_id": "integer",
-                "api_view_id": "integer",
-                "role_id": "integer",
-            },
-        }
-        required_instance = {"id", "name", "data_hash"}
-        foreign_keys = [
-            ("permission_dag", "dag_id", "deployed_dags.id"),
-            ("permission_dag", "user_id", "users.id"),
-            ("permission_view", "action_id", "actions.id"),
-            ("permission_view", "api_view_id", "api_view.id"),
-        ]
-        for tab_name, tab_checks in tables.items():
-            # All tables exist
-            self.assertIn(tab_name, schema["properties"])
-            # The properties have correct types
-            for prop, type_prop in tab_checks.items():
-                table_props = schema["properties"][tab_name]["items"]["properties"]
-                self.assertIn(prop, table_props)
-                self.assertIn("type", table_props.get(prop, {}).keys())
-                self.assertEqual(
-                    type_prop, table_props.get(prop, {}).get("type", "null")
-                )
-        # The foreign keys are correct
-        for tab, key, foreign_key in foreign_keys:
-            self.assertIn(
-                "foreign_key", schema["properties"][tab]["items"]["properties"][key]
-            )
-            self.assertEqual(
-                schema["properties"][tab]["items"]["properties"][key]["foreign_key"],
-                foreign_key,
-            )
-        # The required property is correct
-        self.assertEqual(
-            required_instance,
-            set(schema["properties"]["instances"]["items"]["required"]),
-        )
-
-    def test_ignore(self):
-        runner = CliRunner()
-        result = runner.invoke(
-            cli,
-            [
-                "schemas",
-                "schema_from_models",
-                "-p",
-                self.models_path,
-                "-o",
-                self.output_path,
-                "-i",
-                "instance.py"
-            ]
-        )
-
-        self.assertEqual(result.exit_code, 0)
-
-        schema = self.import_schema(self.output_path)
-
-        self.assertNotIn("instances", schema["properties"].keys())
+# import json
+# import os
+# import unittest
+#
+# from click.testing import CliRunner
+# from flask_testing import TestCase
+#
+# from cornflow.app import create_app
+# from cornflow.cli import cli
+# from cornflow.shared import db
+#
+# path_to_tests = os.path.dirname(os.path.abspath(__file__))
+#
+#
+# class SchemaFromModelsTests(TestCase):
+#     def create_app(self):
+#         app = create_app("testing")
+#         return app
+#
+#     def setUp(self):
+#         db.create_all()
+#         self.models_path = self._get_path("../../models")
+#         print(self.models_path)
+#         self.output_path = self._get_path(os.path.join(os.getcwd(), "test_output.json"))
+#         print(self.output_path)
+#
+#     @staticmethod
+#     def import_schema(path):
+#         with open(path, "r") as fd:
+#             schema = json.load(fd)
+#         return schema
+#
+#     @staticmethod
+#     def _get_path(rel_path):
+#         return os.path.join(path_to_tests, rel_path)
+#
+#     def tearDown(self):
+#         db.session.remove()
+#         db.drop_all()
+#         if os.path.exists(self.output_path):
+#             os.remove(self.output_path)
+#
+#     def test_base(self):
+#         runner = CliRunner()
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "schemas",
+#                 "schema_from_models",
+#                 "-p",
+#                 self.models_path,
+#                 "-o",
+#                 self.output_path,
+#             ],
+#         )
+#
+#         self.assertEqual(result.exit_code, True)
+#
+#         schema = self.import_schema(self._get_path(self.output_path))
+#
+#         tables = {
+#             "instances": {
+#                 "id": "string",
+#                 "data": "object",
+#                 "checks": "object",
+#                 "name": "string",
+#                 "description": "string",
+#             },
+#             "actions": {"id": "integer", "name": "string"},
+#             "permission_dag": {
+#                 "id": "integer",
+#                 "dag_id": "string",
+#                 "user_id": "integer",
+#             },
+#             "permission_view": {
+#                 "id": "integer",
+#                 "action_id": "integer",
+#                 "api_view_id": "integer",
+#                 "role_id": "integer",
+#             },
+#         }
+#         required_instance = {"id", "name", "data_hash"}
+#         foreign_keys = [
+#             ("permission_dag", "dag_id", "deployed_dags.id"),
+#             ("permission_dag", "user_id", "users.id"),
+#             ("permission_view", "action_id", "actions.id"),
+#             ("permission_view", "api_view_id", "api_view.id"),
+#         ]
+#         for tab_name, tab_checks in tables.items():
+#             # All tables exist
+#             self.assertIn(tab_name, schema["properties"])
+#             # The properties have correct types
+#             for prop, type_prop in tab_checks.items():
+#                 table_props = schema["properties"][tab_name]["items"]["properties"]
+#                 self.assertIn(prop, table_props)
+#                 self.assertIn("type", table_props.get(prop, {}).keys())
+#                 self.assertEqual(
+#                     type_prop, table_props.get(prop, {}).get("type", "null")
+#                 )
+#         # The foreign keys are correct
+#         for tab, key, foreign_key in foreign_keys:
+#             self.assertIn(
+#                 "foreign_key", schema["properties"][tab]["items"]["properties"][key]
+#             )
+#             self.assertEqual(
+#                 schema["properties"][tab]["items"]["properties"][key]["foreign_key"],
+#                 foreign_key,
+#             )
+#         # The required property is correct
+#         self.assertEqual(
+#             required_instance,
+#             set(schema["properties"]["instances"]["items"]["required"]),
+#         )
+#
+#     def test_ignore(self):
+#         runner = CliRunner()
+#         result = runner.invoke(
+#             cli,
+#             [
+#                 "schemas",
+#                 "schema_from_models",
+#                 "-p",
+#                 self.models_path,
+#                 "-o",
+#                 self.output_path,
+#                 "-i",
+#                 "instance.py",
+#             ],
+#         )
+#
+#         self.assertEqual(result.exit_code, True)
+#
+#         schema = self.import_schema(self.output_path)
+#
+#         self.assertNotIn("instances", schema["properties"].keys())

{cornflow-1.0.7.dist-info → cornflow-1.0.8a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cornflow
-Version: 1.0.7
+Version: 1.0.8a1
 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.0.14
+Requires-Dist: cornflow-client ==1.0.16a1
 Requires-Dist: cryptography <=39.0.2
 Requires-Dist: disposable-email-domains >=0.0.86
 Requires-Dist: Flask ==2.3.2
@@ -28,7 +28,6 @@ Requires-Dist: Flask-Migrate <=4.0.4
 Requires-Dist: Flask-RESTful <=0.3.9
 Requires-Dist: Flask-SQLAlchemy ==2.5.1
 Requires-Dist: gevent ==23.9.1
-Requires-Dist: greenlet <=2.0.2
 Requires-Dist: gunicorn <=20.1.0
 Requires-Dist: jsonpatch <=1.32
 Requires-Dist: ldap3 <=2.9.1
@@ -41,6 +40,8 @@ Requires-Dist: requests <=2.29.0
 Requires-Dist: SQLAlchemy ==1.3.21
 Requires-Dist: webargs <=8.2.0
 Requires-Dist: Werkzeug <=2.3.3
+Requires-Dist: greenlet <=2.0.2 ; python_version < "3.11"
+Requires-Dist: greenlet ==3.0.0 ; python_version >= "3.11"
 
 Cornflow
 =========
@@ -84,19 +85,33 @@ Cornflow helps you formalize your problem by proposing development guidelines. I
 Installation instructions
 -------------------------------
 
-Cornflow is tested with Ubuntu 20.04, python >= 3.5 and git.
+Cornflow is tested with Ubuntu 20.04, python >= 3.8 and git.
 
 Download the Cornflow project and install requirements::
 
-    git clone git@github.com:baobabsoluciones/cornflow.git
-    cd cornflow-server
     python3 -m venv venv
-    venv/bin/pip3 install -r requirements-dev.txt
+    venv/bin/pip3 install cornflow
+
+initialize the sqlite database::
+
+    source venv/bin/activate
+    export FLASK_APP=cornflow.app
+    export DATABASE_URL=sqlite:///cornflow.db
+    flask db upgrade
+    flask access_init
+    flask create_service_user  -u airflow -e airflow_test@admin.com -p airflow_test_password
+    flask create_admin_user  -u cornflow -e cornflow_admin@admin.com -p cornflow_admin_password
+
 
 activate the virtual environment and run Cornflow::
 
     source venv/bin/activate
     export FLASK_APP=cornflow.app
+    export SECRET_KEY=THISNEEDSTOBECHANGED
+    export DATABASE_URL=sqlite:///cornflow.db
+    export AIRFLOW_URL=http://127.0.0.1:8080/
+    export AIRFLOW_USER=airflow_user
+    export AIRFLOW_PWD=airflow_pwd
     flask run
 
 **Cornflow needs a running installation of Airflow to operate and more configuration**. Check `the installation docs <https://baobabsoluciones.github.io/cornflow/main/install.html>`_ for more details on installing airflow, configuring the application and initializing the database.
@@ -179,8 +194,7 @@ Using cornflow to deploy a solution method
 
 To deploy a cornflow solution method, the following tasks need to be accomplished:
 
-#. Create I/O schemas for the new problem (e.g., “TSP format”).
-#. Create a solve function (e.g., a 2-opt heuristic).
+#. Create an Application for the new problem
 #. Do a PR to a compatible repo linked to a server instance (e.g., like `this one <https://github.com/baobabsoluciones/cornflow>`_).
 
 For more details on each part, check the `deployment guide <https://baobabsoluciones.github.io/cornflow/guides/deploy_solver.html>`_.

{cornflow-1.0.7.dist-info → cornflow-1.0.8a1.dist-info}/RECORD

@@ -14,7 +14,7 @@ cornflow/cli/config.py,sha256=_7Y6tDo5uu4riymkzMYHnTR9IYxBG_FsjwmB84Du90U,1148
 cornflow/cli/migrations.py,sha256=Stc8H99rG8vgo3yRJcck11zBY_EA4WqyVybglfl8zJE,1624
 cornflow/cli/permissions.py,sha256=4KXKysH4g8YYQIZcPuXFS2g0xEErp-e8I_FAqMGaV7U,1006
 cornflow/cli/roles.py,sha256=NFG__qrlyOT0h4L4nwo9FSV4DKjGtMVh3gwiJxwM37w,411
-cornflow/cli/schemas.py,sha256=M9sbVPgPFgMscrS6OLGSDfiYxfUE7VTgI9_tRFQcvCU,5922
+cornflow/cli/schemas.py,sha256=sxuJOZf12SBZAXDiAYNPB-n9LSxzSwkB3xyhgS_4K9A,6086
 cornflow/cli/service.py,sha256=yhQT860oXmQFU_maHHL276tYubKUs6YcwheWv7x7oh0,9135
 cornflow/cli/users.py,sha256=QvvFJw_tjgYB4GjwXmGTAH_FT_Z6nATg9gmkCbcyLJ8,748
 cornflow/cli/utils.py,sha256=0tF41gTt6LL9XGOizTQg2GXuOXbqLg6gapCr-HWjJ0Q,733
@@ -23,7 +23,7 @@ cornflow/cli/tools/__init__.py,sha256=JtyhYfUfirw78BV1mCsdeY0W25fDPWTmZhNBWdDh0w
 cornflow/cli/tools/api_generator.py,sha256=7ZEEGBdL9Anbj5gnPm3m_eHQm0ehz7Y7YaD952mGh58,16344
 cornflow/cli/tools/endpoint_tools.py,sha256=Xnv-IQWx6szgMzyD7r3unV050S-J7CxVR5p_cMHMO30,12640
 cornflow/cli/tools/models_tools.py,sha256=GGqO8fmksA37jhP_xm1dMMAJRZ8_k9j-0V2J05hJAog,5398
-cornflow/cli/tools/schema_generator.py,sha256=g-TmppguBIOKIo7hn2vefBB_SG2cJL2pSmD_8R5xhik,7540
+cornflow/cli/tools/schema_generator.py,sha256=3zfxQUej8BwPwmrGttjpK0R_oSnXIJQWOqoott-E78E,7557
 cornflow/cli/tools/schemas_tools.py,sha256=56VQfsUC6b1Hm5Ran1X6X4QF4HfTxrcOjWlGUCL7BAw,2245
 cornflow/cli/tools/tools.py,sha256=Qm0X-wHN12vXYJNRHONGjqDZewwXyXy4R_j4UT_XMLs,929
 cornflow/commands/__init__.py,sha256=E-IgJGF9NNYVhyWYh5ZYP6o0QucWVpJ9N2sbSxFkDmI,515
@@ -44,7 +44,7 @@ cornflow/endpoints/case.py,sha256=80Fpv9p8mwIXzjQFuyq1PnPTz3RaOUk932sCUfw7yGA,18
 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/execution.py,sha256=9KOh0OkwYPEoDhqC0ot8Tsh4HpyNQwBqcPKET5iBZEQ,28043
+cornflow/endpoints/execution.py,sha256=TQ-JtgFtYXVXJIbVs12qxWwGigfLrg9PzdTP0fK6k4g,27951
 cornflow/endpoints/health.py,sha256=TWmWjKdQOoDzpqwcfksuaAGOLIb2idxzPQcGMWrdkCY,1610
 cornflow/endpoints/instance.py,sha256=WAnloocXFxSW4vunBJo3CIHx4NzC_0GPJh5bj3ETd9U,11615
 cornflow/endpoints/licenses.py,sha256=82hHWGYvVIiyw9mlwGtMwJMDJ-ShHOi9rvuM6KvfE4U,873
@@ -82,9 +82,9 @@ cornflow/models/action.py,sha256=8MYzQ2qX5bG0zk28OufypzThkR7AU1J1el-5ABoTurg,120
 cornflow/models/alarms.py,sha256=R_g3tkWNSJaAG4gSvthgJlyrueY9VDuIZPoVHk5lDvU,1682
 cornflow/models/base_data_model.py,sha256=WykAv5_t5-xTP--ajYniIyZYN-ahqpRKLlW6pG3ghGg,5467
 cornflow/models/case.py,sha256=CW1UvsrBvKK4ilQ5bWaqPwZbF0P3A1M_910E495nndA,7202
-cornflow/models/dag.py,sha256=jgT_ty91rxKBNxFx8WZM28ZQWZQGROnXvPWbp6BL4tQ,2932
+cornflow/models/dag.py,sha256=DhHpBqJXrLzPoVSyrS_rYI7BotdzITopJDKsql3mQnQ,2930
 cornflow/models/dag_permissions.py,sha256=QkhPxSLKxH5elIMdf-rnRtV_CEZBQDFFKUOWv15RgwI,1716
-cornflow/models/execution.py,sha256=PnIuJroi1-AFhzRD3wmnrsZ7nVbTEX8xLt-6b2stkwU,5687
+cornflow/models/execution.py,sha256=Q0b_m9ACJbgw0lhQ6gkzqY3CjBxRmHO2uU5G75y7wGo,5974
 cornflow/models/instance.py,sha256=JKQndz413eGw6J9HwzyIynVQrqtS4egrJY0_jTBuwZM,3788
 cornflow/models/main_alarms.py,sha256=9S-Ohr2kYFFWB0HomrpSdDIoUr85Eu1rt90Om_Pa8VY,1748
 cornflow/models/meta_models.py,sha256=qeliGdpw0_q0GCeZzansF-09Ay5pueaT-QQPVPZ5aj4,12000
@@ -125,13 +125,13 @@ cornflow/shared/log_config.py,sha256=FM2ajjp2MB4BlFbUHklnWInT7-LLjtrqQ0mo3k_HRmE
 cornflow/shared/query_tools.py,sha256=6yGLCWjv-I2a_ZU4A0IymyJq67fZPZdRcCGOGQQpSXg,1199
 cornflow/shared/utils.py,sha256=g2ZsD3SwsqIHXZ7GWVAVB0F9gX7mT9dQkPgR2Ahsh6M,860
 cornflow/shared/utils_tables.py,sha256=A7bjpt7Metkb0FP7tKXMqOkak2fgi3O9dejYvoJBpb0,2236
-cornflow/shared/validators.py,sha256=uckA39cgSJjJPCj90L6unf18z82IdsGhPZ5cofaQ5wg,2899
+cornflow/shared/validators.py,sha256=aFKAAJ2diElUA8WdDyCcXJI6r3FV7HFVzoOTC6t4f8Y,4803
 cornflow/shared/authentication/__init__.py,sha256=cJIChk5X6hbA_16usEvfHr8g4JDFI6WKo0GPVOOiYHA,137
 cornflow/shared/authentication/auth.py,sha256=VuM8kmjSi2G_4BR9sop6vn13SFEHiixFBOhB_Pm196M,16840
 cornflow/shared/authentication/decorators.py,sha256=_QpwOU1kYzpaK85Dl0Btdj5hG8Ps47PFgySp_gqhlgk,1276
 cornflow/shared/authentication/ldap.py,sha256=QfdC2X_ZMcIJabKC5pYWDGMhS5pIOJJvdZXuuiruq-M,4853
 cornflow/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cornflow/tests/const.py,sha256=c58TRNAQcErq5Git1HKt4xwuhsu_-8XiuLIymR4HNqo,2327
+cornflow/tests/const.py,sha256=_5BYFGN42Xg0PXMR8UU5DBL6dYmYn5rgRBgPyptrKso,2499
 cornflow/tests/custom_liveServer.py,sha256=I_0YNrcKIwVmRov3zCQMWwcCWkMe5V246Hpa4gS8AZE,3079
 cornflow/tests/custom_test_case.py,sha256=3nHflrRoBXSaws0XSdbBaV21mTYL8LzDJs6wOyFBdmQ,24773
 cornflow/tests/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -149,24 +149,25 @@ cornflow/tests/unit/test_commands.py,sha256=QwGHTOxBOwiIYYQg8wcmSR11lKQk0I8Ltr3s
 cornflow/tests/unit/test_dags.py,sha256=Vww3_TDmHUnPvX2BJac6fXMp4y4UOWqnkYuzdVkBa4k,9034
 cornflow/tests/unit/test_data_checks.py,sha256=VjB3AAQOHlqnaRT2jI9L2mNLDAcda6llpiZWkW7nnkk,5471
 cornflow/tests/unit/test_example_data.py,sha256=uaF66FpFNHAgHYH_6RH7Ylu1A6JcBU_qT7pNwS5IMOk,1518
-cornflow/tests/unit/test_executions.py,sha256=1GAfbwDo0hfJU-MTHiKcXh4SgRIerm9g5jjiPfIbBWY,13339
+cornflow/tests/unit/test_executions.py,sha256=tNzkeOgZIdS-11FXNXLODIdfHCKZ5B1I4XuvyN8irj0,15333
 cornflow/tests/unit/test_generate_from_schema.py,sha256=L1EdnASbDJ8SjrX1V4WnUKKwV0sRTwVnNYnxSpyeSeQ,15376
 cornflow/tests/unit/test_health.py,sha256=0E0HXMb63_Z8drbLZdxnJwtTbQyaZS9ZEHut6qsDbh8,1033
 cornflow/tests/unit/test_instances.py,sha256=FWNxeP9LMkeCAoniEHioSFN2W_4yqbI-69pAMLkh-sY,9650
 cornflow/tests/unit/test_instances_file.py,sha256=zXxSlOM_MMkFvpWNX-iatD40xoIAOGQkinCLf1txb0M,1986
+cornflow/tests/unit/test_licenses.py,sha256=9vYkJZw7Ubza2_pvpgrbyiat6hpLsglgoCPdOzdammo,1494
 cornflow/tests/unit/test_log_in.py,sha256=zwVCNO0sGQhpVcUaJnh8cVv2z-qPEYCdI98y61CNyfE,979
 cornflow/tests/unit/test_main_alarms.py,sha256=H1LWQETlSQMsC6Rb3BB9ds7xL705t9aiPyp4gCWMwDQ,1970
 cornflow/tests/unit/test_permissions.py,sha256=4mLj3GI0Bvhy927eXu_RyAmK8i2XD7raYc6W8lyAO04,8782
 cornflow/tests/unit/test_roles.py,sha256=xZ3TohL_sv1ZBPvHv_nnYSsKEhBlrzIchx9soaTb5Ow,16581
-cornflow/tests/unit/test_schema_from_models.py,sha256=EqdlCSNTsuDzNtGPs-zTMDUy8zeE_2KGnTBBuQAUemc,3871
+cornflow/tests/unit/test_schema_from_models.py,sha256=7IfycOGO3U06baX8I-OPJfu-3ZAn5cv8RCdj9wvalMk,4421
 cornflow/tests/unit/test_schemas.py,sha256=nX78H0QhG3fThnw8CqS7EhDyuXWwMiA0pXVy52qhlUk,7177
 cornflow/tests/unit/test_sign_up.py,sha256=-i6VO9z1FwqRHFvaSrpWAzOZx6qa8mHUEmmsjuMXjn8,3481
 cornflow/tests/unit/test_tables.py,sha256=dY55YgaCkyqwJnqn0LbZHNeXBoL4ZxXWwKkCoTF4WVE,8947
 cornflow/tests/unit/test_token.py,sha256=r0hzozPTlYmmWsxbFXQ5QovXIg5sES6b2--2dzlEreI,2068
 cornflow/tests/unit/test_users.py,sha256=_GGnT3ltVEDWJcBUulUflhEx2eKIjbSFi74zY211k1I,21677
 cornflow/tests/unit/tools.py,sha256=ag3sWv2WLi498R1GL5AOUnXqSsszD3UugzLZLC5NqAw,585
-cornflow-1.0.7.dist-info/METADATA,sha256=kxSntrT04xAa0htZNJXZo9Iho07h2F_75ewRt01CFBs,8905
-cornflow-1.0.7.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-cornflow-1.0.7.dist-info/entry_points.txt,sha256=r5wKLHpuyVLMUIZ5I29_tpqYf-RuP-3w_8DhFi8_blQ,47
-cornflow-1.0.7.dist-info/top_level.txt,sha256=Qj9kLFJW1PLb-ZV2s_aCkQ-Wi5W6KC6fFR-LTBrx-rU,24
-cornflow-1.0.7.dist-info/RECORD,,
+cornflow-1.0.8a1.dist-info/METADATA,sha256=7i-UJ_t05Rzs6f3Zji_yrLcyP-r0Hx-brHryZtOYa5A,9404
+cornflow-1.0.8a1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+cornflow-1.0.8a1.dist-info/entry_points.txt,sha256=r5wKLHpuyVLMUIZ5I29_tpqYf-RuP-3w_8DhFi8_blQ,47
+cornflow-1.0.8a1.dist-info/top_level.txt,sha256=Qj9kLFJW1PLb-ZV2s_aCkQ-Wi5W6KC6fFR-LTBrx-rU,24
+cornflow-1.0.8a1.dist-info/RECORD,,