From c661100e03eef762cb51b02be1b309ec47be7002 Mon Sep 17 00:00:00 2001 From: burnettk Date: Thu, 20 Oct 2022 07:19:24 -0400 Subject: [PATCH] Squashed 'spiffworkflow-backend/' changes from af8dd9e2d..f9c2fa21e f9c2fa21e lint 287d10494 only do startswith when it is a string 80c5357b9 lint git-subtree-dir: spiffworkflow-backend git-subtree-split: f9c2fa21ec0e68c5deb240be17aed347ba4867cd --- migrations/env.py | 2 - poetry.lock | 46 ++++++++++++------- .../services/service_task_service.py | 29 ++++++------ .../unit/test_service_task_delegate.py | 33 +++++++++++++ 4 files changed, 78 insertions(+), 32 deletions(-) create mode 100644 tests/spiffworkflow_backend/unit/test_service_task_delegate.py diff --git a/migrations/env.py b/migrations/env.py index 68feded2..630e381a 100644 --- a/migrations/env.py +++ b/migrations/env.py @@ -1,5 +1,3 @@ -from __future__ import with_statement - import logging from logging.config import fileConfig diff --git a/poetry.lock b/poetry.lock index 4ddf730e..0c85c676 100644 --- a/poetry.lock +++ b/poetry.lock @@ -95,7 +95,7 @@ python-versions = ">=3.5" dev = ["cloudpickle", "coverage[toml] (>=5.0.2)", "furo", "hypothesis", "mypy (>=0.900,!=0.940)", "pre-commit", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "sphinx", "sphinx-notfound-page", "zope.interface"] docs = ["furo", "sphinx", "sphinx-notfound-page", "zope.interface"] tests = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "mypy (>=0.900,!=0.940)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "zope.interface"] -tests-no-zope = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "mypy (>=0.900,!=0.940)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins"] +tests_no_zope = ["cloudpickle", "coverage[toml] (>=5.0.2)", "hypothesis", "mypy (>=0.900,!=0.940)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins"] [[package]] name = "Babel" @@ -268,7 +268,7 @@ optional = false python-versions = ">=3.6.0" [package.extras] -unicode-backport = ["unicodedata2"] +unicode_backport = ["unicodedata2"] [[package]] name = "classify-imports" @@ -639,7 +639,7 @@ werkzeug = "*" type = "git" url = "https://github.com/sartography/flask-bpmn" reference = "main" -resolved_reference = "6e1411dd134955a829bb9f3d59b4af121907cd35" +resolved_reference = "bd4b45a842ed63a29e74ff02ea7f2a56d7b2298a" [[package]] name = "Flask-Cors" @@ -1512,7 +1512,7 @@ urllib3 = ">=1.21.1,<1.27" [package.extras] socks = ["PySocks (>=1.5.6,!=1.5.7)"] -use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] +use_chardet_on_py3 = ["chardet (>=3.0.2,<6)"] [[package]] name = "requests-toolbelt" @@ -1625,7 +1625,7 @@ falcon = ["falcon (>=1.4)"] fastapi = ["fastapi (>=0.79.0)"] flask = ["blinker (>=1.1)", "flask (>=0.11)"] httpx = ["httpx (>=0.16.0)"] -pure-eval = ["asttokens", "executing", "pure-eval"] +pure_eval = ["asttokens", "executing", "pure-eval"] pyspark = ["pyspark (>=2.4.4)"] quart = ["blinker (>=1.1)", "quart (>=0.16.1)"] rq = ["rq (>=0.6)"] @@ -1847,8 +1847,8 @@ test = ["pytest"] [[package]] name = "SpiffWorkflow" -version = "1.2.1" -description = "" +version = "1.2.0" +description = "A workflow framework and BPMN/DMN Processor" category = "main" optional = false python-versions = "*" @@ -1858,6 +1858,7 @@ develop = false celery = "*" configparser = "*" dateparser = "*" +importlib-metadata = "<5.0" lxml = "*" pytz = "*" @@ -1883,19 +1884,19 @@ aiomysql = ["aiomysql", "greenlet (!=0.4.17)"] aiosqlite = ["aiosqlite", "greenlet (!=0.4.17)", "typing_extensions (!=3.10.0.1)"] asyncio = ["greenlet (!=0.4.17)"] asyncmy = ["asyncmy (>=0.2.3,!=0.2.4)", "greenlet (!=0.4.17)"] -mariadb-connector = ["mariadb (>=1.0.1,!=1.1.2)"] +mariadb_connector = ["mariadb (>=1.0.1,!=1.1.2)"] mssql = ["pyodbc"] -mssql-pymssql = ["pymssql"] -mssql-pyodbc = ["pyodbc"] +mssql_pymssql = ["pymssql"] +mssql_pyodbc = ["pyodbc"] mypy = ["mypy (>=0.910)", "sqlalchemy2-stubs"] mysql = ["mysqlclient (>=1.4.0)", "mysqlclient (>=1.4.0,<2)"] -mysql-connector = ["mysql-connector-python"] +mysql_connector = ["mysql-connector-python"] oracle = ["cx_oracle (>=7)", "cx_oracle (>=7,<8)"] postgresql = ["psycopg2 (>=2.7)"] -postgresql-asyncpg = ["asyncpg", "greenlet (!=0.4.17)"] -postgresql-pg8000 = ["pg8000 (>=1.16.6,!=1.29.0)"] -postgresql-psycopg2binary = ["psycopg2-binary"] -postgresql-psycopg2cffi = ["psycopg2cffi"] +postgresql_asyncpg = ["asyncpg", "greenlet (!=0.4.17)"] +postgresql_pg8000 = ["pg8000 (>=1.16.6,!=1.29.0)"] +postgresql_psycopg2binary = ["psycopg2-binary"] +postgresql_psycopg2cffi = ["psycopg2cffi"] pymysql = ["pymysql", "pymysql (<1)"] sqlcipher = ["sqlcipher3_binary"] @@ -2029,7 +2030,7 @@ python-versions = "*" name = "types-PyYAML" version = "6.0.12" description = "Typing stubs for PyYAML" -category = "dev" +category = "main" optional = false python-versions = "*" @@ -2233,7 +2234,7 @@ testing = ["func-timeout", "jaraco.itertools", "pytest (>=6)", "pytest-black (>= [metadata] lock-version = "1.1" python-versions = ">=3.9,<3.11" -content-hash = "cff4bcfd10157833f1a0f0bb806c3543267c3e99cc13f311b328d101c30ac553" +content-hash = "2602fd47f14d1163b2590ab01d3adb1ce881c699bb09630e6fdfc56b919a7a4e" [metadata.files] alabaster = [ @@ -3012,7 +3013,18 @@ py = [ {file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"}, ] pyasn1 = [ + {file = "pyasn1-0.4.8-py2.4.egg", hash = "sha256:fec3e9d8e36808a28efb59b489e4528c10ad0f480e57dcc32b4de5c9d8c9fdf3"}, + {file = "pyasn1-0.4.8-py2.5.egg", hash = "sha256:0458773cfe65b153891ac249bcf1b5f8f320b7c2ce462151f8fa74de8934becf"}, + {file = "pyasn1-0.4.8-py2.6.egg", hash = "sha256:5c9414dcfede6e441f7e8f81b43b34e834731003427e5b09e4e00e3172a10f00"}, + {file = "pyasn1-0.4.8-py2.7.egg", hash = "sha256:6e7545f1a61025a4e58bb336952c5061697da694db1cae97b116e9c46abcf7c8"}, {file = "pyasn1-0.4.8-py2.py3-none-any.whl", hash = "sha256:39c7e2ec30515947ff4e87fb6f456dfc6e84857d34be479c9d4a4ba4bf46aa5d"}, + {file = "pyasn1-0.4.8-py3.1.egg", hash = "sha256:78fa6da68ed2727915c4767bb386ab32cdba863caa7dbe473eaae45f9959da86"}, + {file = "pyasn1-0.4.8-py3.2.egg", hash = "sha256:08c3c53b75eaa48d71cf8c710312316392ed40899cb34710d092e96745a358b7"}, + {file = "pyasn1-0.4.8-py3.3.egg", hash = "sha256:03840c999ba71680a131cfaee6fab142e1ed9bbd9c693e285cc6aca0d555e576"}, + {file = "pyasn1-0.4.8-py3.4.egg", hash = "sha256:7ab8a544af125fb704feadb008c99a88805126fb525280b2270bb25cc1d78a12"}, + {file = "pyasn1-0.4.8-py3.5.egg", hash = "sha256:e89bf84b5437b532b0803ba5c9a5e054d21fec423a89952a74f87fa2c9b7bce2"}, + {file = "pyasn1-0.4.8-py3.6.egg", hash = "sha256:014c0e9976956a08139dc0712ae195324a75e142284d5f87f1a87ee1b068a359"}, + {file = "pyasn1-0.4.8-py3.7.egg", hash = "sha256:99fcc3c8d804d1bc6d9a099921e39d827026409a58f2a720dcdb89374ea0c776"}, {file = "pyasn1-0.4.8.tar.gz", hash = "sha256:aef77c9fb94a3ac588e87841208bdec464471d9871bd5050a287cc9a475cd0ba"}, ] pycodestyle = [ diff --git a/src/spiffworkflow_backend/services/service_task_service.py b/src/spiffworkflow_backend/services/service_task_service.py index bb74a3d0..1c30da99 100644 --- a/src/spiffworkflow_backend/services/service_task_service.py +++ b/src/spiffworkflow_backend/services/service_task_service.py @@ -27,19 +27,20 @@ class ServiceTaskDelegate: if isinstance(value, dict): value = json.dumps(value) - secret_prefix = "secret:" # noqa: S105 - if value.startswith(secret_prefix): - key = value.removeprefix(secret_prefix) - secret = SecretService().get_secret(key) - assert secret # noqa: S101 - return secret.value + if isinstance(value, str): + secret_prefix = "secret:" # noqa: S105 + if value.startswith(secret_prefix): + key = value.removeprefix(secret_prefix) + secret = SecretService().get_secret(key) + assert secret # noqa: S101 + return secret.value - file_prefix = "file:" - if value.startswith(file_prefix): - file_name = value.removeprefix(file_prefix) - full_path = FileSystemService.full_path_from_relative_path(file_name) - with open(full_path) as f: - return f.read() + file_prefix = "file:" + if value.startswith(file_prefix): + file_name = value.removeprefix(file_prefix) + full_path = FileSystemService.full_path_from_relative_path(file_name) + with open(full_path) as f: + return f.read() return value @@ -52,7 +53,9 @@ class ServiceTaskDelegate: } params["spiff__task_data"] = json.dumps(task_data) - proxied_response = requests.post(f"{connector_proxy_url()}/v1/do/{name}", params) + proxied_response = requests.post( + f"{connector_proxy_url()}/v1/do/{name}", params + ) if proxied_response.status_code != 200: print("got error from connector proxy") diff --git a/tests/spiffworkflow_backend/unit/test_service_task_delegate.py b/tests/spiffworkflow_backend/unit/test_service_task_delegate.py new file mode 100644 index 00000000..b0022a5d --- /dev/null +++ b/tests/spiffworkflow_backend/unit/test_service_task_delegate.py @@ -0,0 +1,33 @@ +"""Test_various_bpmn_constructs.""" +from flask.app import Flask +from tests.spiffworkflow_backend.helpers.base_test import BaseTest + +from spiffworkflow_backend.services.secret_service import SecretService +from spiffworkflow_backend.services.service_task_service import ServiceTaskDelegate + + +class TestServiceTaskDelegate(BaseTest): + """TestServiceTaskDelegate.""" + + def test_normalize_value_without_secret( + self, app: Flask, with_db_and_bpmn_file_cleanup: None + ) -> None: + """Test_normalize_value_without_secret.""" + result = ServiceTaskDelegate.normalize_value("hey") + assert result == "hey" + + def test_normalize_value_with_int( + self, app: Flask, with_db_and_bpmn_file_cleanup: None + ) -> None: + """Test_normalize_value_with_int.""" + result = ServiceTaskDelegate.normalize_value(1) + assert result == 1 + + def test_normalize_value_with_secret( + self, app: Flask, with_db_and_bpmn_file_cleanup: None + ) -> None: + """Test_normalize_value_with_secret.""" + user = self.find_or_create_user("test_user") + SecretService().add_secret("hot_secret", "my_secret_value", user.id) + result = ServiceTaskDelegate.normalize_value("secret:hot_secret") + assert result == "my_secret_value"