Started unit test for Workflows.py and WorkflowDesigner.py

tests/helpers.py

@@ -420,7 +420,8 @@ def matches(actual, expected, path=""):
       assert matches(actual_child, expected_child)
   
   elif isinstance(expected, NotStr):
-    assert actual.s.lstrip('\n').startswith(expected.s), \
+    to_compare = actual.s.lstrip('\n').lstrip()
+    assert to_compare.startswith(expected.s), \
       f"{print_path(path)}NotStr are different: '{actual.s.lstrip('\n')}' != '{expected.s}'."
   
   elif hasattr(actual, "tag"):
@@ -741,10 +742,20 @@ def _get_element_value(element):
 
 
 def icon(name: str):
+  """
+  Test if an element is an icon
+  :param name:
+  :return:
+  """
   return NotStr(f'<svg name="{name}"')
 
 
 def div_icon(name: str):
+  """
+  Test if an element is an icon wrapped in a div
+  :param name:
+  :return:
+  """
   return Div(NotStr(f'<svg name="{name}"'))
 
 

tests/test_repositories.py

@@ -25,7 +25,7 @@ def tabs_manager():
       self._called_methods: list[tuple] = []
     
     def add_tab(self, *args, **kwargs):
-      self._called_methods.append(("set_tab_content", args, kwargs))
+      self._called_methods.append(("add_tab", args, kwargs))
       
       table_name, content, key = args
       self.tabs.append({"table_name": table_name, "content": content, "key": key})

tests/test_workflow_designer.py

@@ -0,0 +1,151 @@
+import pytest
+from fastcore.basics import NotStr
+from fasthtml.components import *
+from fasthtml.xtend import Script
+
+from components.workflows.components.WorkflowDesigner import WorkflowDesigner, COMPONENT_TYPES
+from components.workflows.constants import ProcessorTypes
+from components.workflows.db_management import WorkflowsDesignerSettings, WorkflowComponent, Connection
+from core.settings_management import SettingsManager, MemoryDbEngine
+from helpers import matches, Contains
+
+TEST_WORKFLOW_DESIGNER_ID = "workflow_designer_id"
+
+
+@pytest.fixture
+def designer(session):
+  return WorkflowDesigner(session=session, _id=TEST_WORKFLOW_DESIGNER_ID,
+                          settings_manager=SettingsManager(engine=MemoryDbEngine()),
+                          key=TEST_WORKFLOW_DESIGNER_ID,
+                          designer_settings=WorkflowsDesignerSettings("Workflow Name"),
+                          boundaries={"height": 500, "width": 800}
+                          )
+
+
+@pytest.fixture
+def producer_component():
+  return WorkflowComponent(
+    "comp_producer",
+    ProcessorTypes.Producer,
+    10,
+    100,
+    COMPONENT_TYPES[ProcessorTypes.Producer]["title"],
+    COMPONENT_TYPES[ProcessorTypes.Producer]["description"],
+    {"processor_name": ProcessorTypes.Producer[0]}
+  )
+
+
+@pytest.fixture
+def filter_component():
+  return WorkflowComponent(
+    "comp_filter",
+    ProcessorTypes.Filter,
+    40,
+    100,
+    COMPONENT_TYPES[ProcessorTypes.Filter]["title"],
+    COMPONENT_TYPES[ProcessorTypes.Filter]["description"],
+    {"processor_name": ProcessorTypes.Filter[0]}
+  )
+
+
+@pytest.fixture
+def presenter_component():
+  return WorkflowComponent(
+    "comp_presenter",
+    ProcessorTypes.Presenter,
+    70,
+    100,
+    COMPONENT_TYPES[ProcessorTypes.Presenter]["title"],
+    COMPONENT_TYPES[ProcessorTypes.Presenter]["description"],
+    {"processor_name": ProcessorTypes.Presenter[0]}
+  )
+
+
+@pytest.fixture
+def components(producer_component, filter_component, presenter_component):
+  return [producer_component, filter_component, presenter_component]
+
+
+def test_i_can_render_no_component(designer):
+  actual = designer.__ft__()
+  expected = Div(
+    H1("Workflow Name"),
+    P("Drag components from the toolbox to the canvas to create your workflow."),
+    Div(id=f"d_{designer.get_id()}"),  # designer container
+    Div(cls="wkf-splitter"),
+    Div(id=f"p_{designer.get_id()}"),  # properties panel
+    Script(f"bindWorkflowDesigner('{designer.get_id()}');"),
+    id=designer.get_id(),
+  )
+  
+  assert matches(actual, expected)
+
+
+def test_i_can_render_a_producer(designer, producer_component):
+  component = producer_component
+  actual = designer._mk_workflow_component(component)
+  expected = Div(
+    # input connection point
+    Div(cls="wkf-connection-point wkf-input-point",
+        data_component_id=component.id,
+        data_point_type="input"
+        ),
+    
+    # Component content
+    Div(
+      Span(COMPONENT_TYPES[component.type]["icon"]),
+      H4(component.title),
+      cls=Contains("wkf-component-content")
+    ),
+    
+    # Output connection point
+    Div(cls="wkf-connection-point wkf-output-point",
+        data_component_id=component.id,
+        data_point_type="output"
+        ),
+    
+    cls=Contains("wkf-workflow-component"),
+    style=f"left: {component.x}px; top: {component.y}px;",
+    data_component_id=component.id,
+    draggable="true"
+  )
+  
+  assert matches(actual, expected)
+
+
+def test_i_can_render_a_connection(designer, components):
+  designer._state.components = {c.id: c for c in components}
+  connection = Connection("conn_1", "comp_producer", "comp_presenter")
+  
+  actual = designer._mk_connection_svg(connection)
+  path = "M 138 132 C 104.0 132, 104.0 132, 70 132"
+  expected = f"""
+      <svg class="wkf-connection-line" style="left: 0; top: 0; width: 100%; height: 100%;"
+           data-from-id="{connection.from_id}" data-to-id="{connection.to_id}">
+          <path d="{path}" class="wkf-connection-path-thick"/>
+          <path d="{path}" class="wkf-connection-path" marker-end="url(#arrowhead)"/>
+
+          <defs>
+              <marker id="arrowhead" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+                  <polygon points="0 0, 10 3.5, 0 7" class="wkf-connection-path-arrowhead"/>
+              </marker>
+          </defs>
+      </svg>
+      """
+  assert actual == expected
+
+
+def test_i_can_render_elements_with_connections(designer, components):
+  designer._state.components = {c.id: c for c in components}
+  designer._state.connections = [Connection("conn_1", components[0].id, components[1].id),
+                                 Connection("conn_2", components[1].id, components[2].id)]
+  actual = designer._mk_elements()
+  expected = Div(
+    NotStr('<svg class="wkf-connection-line"'),  # connection 1
+    NotStr('<svg class="wkf-connection-line"'),  # connection 2
+    Div(cls=Contains("wkf-workflow-component")),
+    Div(cls=Contains("wkf-workflow-component")),
+    Div(cls=Contains("wkf-workflow-component")),
+  )
+  
+  assert matches(actual, expected)

tests/test_workflows.py

@@ -0,0 +1,153 @@
+from unittest.mock import MagicMock
+
+import pytest
+from fasthtml.components import *
+
+from components.form.components.MyForm import FormField, MyForm
+from components.tabs.components.MyTabs import MyTabs
+from components.workflows.components.Workflows import Workflows
+from core.settings_management import SettingsManager, MemoryDbEngine
+from helpers import matches, div_icon, search_elements_by_name, Contains
+
+TEST_WORKFLOWS_ID = "testing_repositories_id"
+
+
+@pytest.fixture
+def tabs_manager():
+  class MockTabsManager(MagicMock):
+    def __init__(self, *args, **kwargs):
+      super().__init__(*args, spec=MyTabs, **kwargs)
+      self.request_new_tab_id = MagicMock(side_effect =["new_tab_id", "new_tab_2", "new_tab_3", StopIteration])
+      self.tabs = {}
+      self.tabs_by_key = {}
+    
+    def add_tab(self, title, content, key: str | tuple = None, tab_id: str = None, icon=None):
+      self.tabs[tab_id] = (title, content)
+      self.tabs_by_key[key] = (title, content)
+    
+    def set_tab_content(self, tab_id, content, title=None, key: str | tuple = None, active=None):
+      self.tabs[tab_id] = (title, content)
+      self.tabs_by_key[key] = (title, content)
+    
+    def refresh(self):
+      return Div(
+        Div(
+          [Div(title) for title in self.tabs.keys()]
+        ),
+        list(self.tabs.values())[-1]
+      )
+  
+  return MockTabsManager()
+
+
+@pytest.fixture
+def workflows(session, tabs_manager):
+  return Workflows(session=session, _id=TEST_WORKFLOWS_ID,
+                   settings_manager=SettingsManager(engine=MemoryDbEngine()),
+                   tabs_manager=tabs_manager)
+
+
+def test_render_no_workflow(workflows):
+  actual = workflows.__ft__()
+  expected = Div(
+    Div(cls="divider"),
+    Div(
+      Div("Workflows"),
+      div_icon("add"),  # icon to add a new workflow
+      cls="flex"
+    ),
+    Div(id=f"w_{workflows.get_id()}", ),  # list of workflow
+    id=workflows.get_id(),
+  )
+  
+  assert matches(actual, expected)
+
+
+def test_render_with_workflows_defined(workflows):
+  workflows.db.add_workflow("workflow 1")
+  workflows.db.add_workflow("workflow 2")
+  
+  actual = workflows.__ft__()
+  expected = Div(
+    Div(cls="divider"),
+    Div(),  # title + icon 'Add'
+    Div(
+      Div("workflow 1"),
+      Div("workflow 2"),
+      id=f"w_{workflows.get_id()}"
+    ),  # list of workflows
+    id=workflows.get_id(),
+  )
+  
+  assert matches(actual, expected)
+
+
+def test_i_can_see_selected_workflow(workflows):
+  workflows.db.add_workflow("workflow 1")
+  workflows.db.add_workflow("workflow 2")
+  workflows.db.select_workflow("workflow 2")
+  
+  actual = workflows.__ft__()
+  to_compare = search_elements_by_name(actual, "div", attrs={"id": f"w_{workflows.get_id()}"})[0]
+  
+  expected = Div(
+    Div("workflow 1"),
+    Div(Div("workflow 2"), cls=Contains("mmt-selected")),
+    id=f"w_{workflows.get_id()}"
+  )
+  
+  assert matches(to_compare, expected)
+
+
+def test_i_can_request_for_a_new_workflow(workflows, tabs_manager):
+  res = workflows.request_new_workflow()
+  
+  tabs_manager.request_new_tab_id.assert_called_once()
+  assert "new_tab_id" in res.tabs
+  tab_def = res.tabs["new_tab_id"]
+  assert tab_def[0] == "Add Workflow"
+  
+  content = tab_def[1]
+  assert isinstance(content, MyForm)
+  assert content.title == "Add Workflow"
+  assert content.fields == [FormField("name", 'Workflow Name', 'input')]
+
+
+def test_i_can_add_a_new_workflow(workflows, tabs_manager):
+  res = workflows.request_new_workflow()
+  tab_id = list(res.tabs.keys())[0]
+  
+  actual = workflows.add_new_workflow(tab_id, "Not relevant here", "New Workflow", {})
+  
+  expected = (
+      Div(
+        Div("New Workflow"),
+        id=f"w_{workflows.get_id()}"
+      ),  # list of workflows
+      Div(),  # Workflow Designer embedded in the tab
+  )
+  
+  assert matches(actual, expected)
+  
+  # check that the workflow was added
+  assert workflows.db.exists_workflow("New Workflow")
+
+
+def test_i_can_select_a_workflow(workflows):
+  workflows.add_new_workflow("tab_id_1", "Not relevant", "workflow 1", {})
+  workflows.add_new_workflow("tab_id_2", "Not relevant", "workflow 2", {})
+  workflows.add_new_workflow("tab_id_3", "Not relevant", "workflow 3", {})
+  
+  actual = workflows.show_workflow("workflow 2", {})
+  
+  expected = (
+      Div(
+        Div("workflow 1"),
+        Div(Div("workflow 2"), cls=Contains("mmt-selected")),
+        Div("workflow 3"),
+        id=f"w_{workflows.get_id()}"
+      ),  # list of workflows
+      Div(),  # Workflow Designer embedded in the tab
+  )
+  
+  assert matches(actual, expected)