Implement the variable validation logic in the user input node (jsocol#146)

* Implemented get_variable_type on the repository

* Fetching variable type in the user input node execution

* Added test to check for email validation

* Validating email addresses

* Raise an error if the reprompt is not needed but not defined

* Show the cancel quick reply

* Renaming the agent handover failure quick replies logic into a more generic name

* Add Cancel QR texts in all languages

* Do not show the cancel quick reply if the targeted use case is not published

* Upgrade requirements

Author: Wellan89

requirements-base.txt

@@ -1,5 +1,5 @@
 # File generated automatically. Do not update it manually.
 # Update files in the requirements folder instead.
-pip==22.1.1
+pip==22.1.2
 setuptools==62.3.2
 wheel==0.37.1

tests/adapters/database_repository/test_get_use_case_from_uuid.py

@@ -15,6 +15,7 @@ def test_get_use_case_from_uuid_returns_none_if_use_case_does_not_exist():
 
 
 def test_get_use_case_from_uuid_returns_the_proper_use_case_when_it_exists():
+    UseCaseFactory()  # decoy
     db_use_case = UseCaseFactory()
     assert DatabaseRepository().get_use_case_from_uuid(
         use_case_uuid=db_use_case.uuid

tests/adapters/database_repository/test_get_variable_type.py

@@ -0,0 +1,26 @@
+import uuid
+
+import pytest
+
+from tests.factories.variable_factory import VariableFactory
+from use_case_executor.adapters.database_repository.database_repository import (
+    DatabaseRepository,
+)
+from use_case_executor.domain.errors import VariableNotFound
+from use_case_executor.domain.flow_execution.substeps.variable_type import VariableType
+
+
+def test_get_variable_type_raises_if_variable_does_not_exist():
+    VariableFactory()  # decoy
+    with pytest.raises(VariableNotFound):
+        DatabaseRepository().get_variable_type(variable_uuid=uuid.uuid4())
+
+
+@pytest.mark.parametrize("variable_type", VariableType)
+def test_get_variable_type_returns_variable_type(variable_type):
+    VariableFactory()  # decoy
+    db_variable = VariableFactory(type=variable_type)
+    assert (
+        DatabaseRepository().get_variable_type(variable_uuid=db_variable.uuid)
+        == variable_type
+    )

tests/api/namespace/use_case/test_clone_use_case.py

@@ -26,7 +26,7 @@
 )
 from use_case_executor.domain.flow.node_data.node_type import NodeType
 from use_case_executor.domain.flow.node_data.user_input_data import UserInputData
-from use_case_executor.domain.flow_execution.substeps.variable_type import Variabletype
+from use_case_executor.domain.flow_execution.substeps.variable_type import VariableType
 
 
 @pytest.fixture(
@@ -360,10 +360,10 @@ def test_creates_new_variables_if_cloning_to_other_instance(  # pylint: disable=
     )
 
     variable_1 = VariableFactory(
-        instance_id=use_case.instance_id, name="variable_1", type=Variabletype.free_text
+        instance_id=use_case.instance_id, name="variable_1", type=VariableType.free_text
     )
     variable_2 = VariableFactory(
-        instance_id=use_case.instance_id, name="variable_2", type=Variabletype.email
+        instance_id=use_case.instance_id, name="variable_2", type=VariableType.email
     )
     variable_3 = VariableFactory(instance_id=use_case.instance_id, name="variable_3")
     VariableFactory(instance_id=use_case.instance_id, name="unused_variable")

tests/domain/execute_flow_from_position/test_agent_handover_node.py

@@ -19,10 +19,8 @@
 from use_case_executor.domain.flow.node_data.agent_handover_data import (
     AgentHandoverData,
 )
-from use_case_executor.domain.flow.node_data.agent_handover_data import (
-    HandoverFailureQuickReply,
-)
 from use_case_executor.domain.flow.node_data.node_type import NodeType
+from use_case_executor.domain.flow.node_data.quick_reply import QuickReply
 from use_case_executor.domain.flow_execution.answer import Answer
 from use_case_executor.domain.flow_execution.execution_environment import (
     ExecutionEnvironment,
@@ -63,12 +61,12 @@ def flow(
         node for node in _flow.get_nodes() if node.type == NodeType.agent_handover
     )
     handover_node.data.handover_failure_quick_replies = [
-        HandoverFailureQuickReply(
+        QuickReply(
             target_use_case_uuid=target_use_case_uuid,
             target_intent_record_id=None,
             title_translations={content_language: "Content language V2 QR"},
         ),
-        HandoverFailureQuickReply(
+        QuickReply(
             target_use_case_uuid=None,
             target_intent_record_id=target_intent_record_id,
             title_translations={content_language: "Content language Advanced QR"},
@@ -142,7 +140,7 @@ def test_flow_returns_failure_answer_if_agent_unavailable(
         mocker=mocker, return_value=False
     )
     if use_latest is False:
-        mock_repository.set_filter_use_case_uuids_without_production_version(
+        mock_repository.set_filter_use_case_uuids_without_production_version_return_value(
             mocker=mocker,
             return_value={target_use_case_uuid} if has_production_version else set(),
         )
@@ -305,7 +303,7 @@ def test_flow_raises_if_target_use_case_uuid_and_target_intent_record_id_are_bot
 
     with pytest.raises(
         InvalidFlowConfiguration,
-        match="the use case to send the customer to is not filled for an agent handover quick reply",
+        match="the use case to send the customer to is not filled for an agent handover failure quick reply",
     ):
         facade.execute_flow_from_position(
             flow=flow,

tests/domain/execute_flow_from_position/test_go_to_flow.py

@@ -138,7 +138,7 @@ def test_flow_returns_all_go_to_flow_quick_replies_in_the_content_language_when_
     target_intent_record_id: int,
 ):
     execution_environment = dataclasses.replace(execution_environment, use_latest=False)
-    mock_repository.set_filter_use_case_uuids_without_production_version(
+    mock_repository.set_filter_use_case_uuids_without_production_version_return_value(
         mocker=mocker,
         return_value={
             execution_environment.use_case_uuid,