Added Tag Handling

Snooz82 · Snooz82 · commit 02d9f1c37d75 · 2021-08-27T23:10:25.000+02:00
diff --git a/atest/TestCases/Defaults/XLS/defaults_xlsx.xlsx b/atest/TestCases/Defaults/XLS/defaults_xlsx.xlsx
diff --git a/atest/TestCases/Defaults/XLS/defaults_xlsx_data_type.robot b/atest/TestCases/Defaults/XLS/defaults_xlsx_data_type.robot
@@ -0,0 +1,23 @@
+*** Settings ***
+Library    DataDriver    defaults_xlsx.xlsx     sheet_name=DataTypes    preserve_xls_types=True
+Test Template    Check Variables
+
+
+*** Variables ***
+${Default_Tags}=    []
+
+*** Test Cases ***                                    ${var_1}    ${var_2}    ${var_name}   ${var_doc}                           ${var_tags}
+Test: ${var_1} isinstance ${var_2} (${var_name})      a           a           a             This is the Default Documentation    ${Default_Tags}
+    [Documentation]    This is the Default Documentation
+
+*** Keywords ***
+Check Variables
+    [Arguments]    ${var_1}    ${var_2}     ${var_name}
+    Log      ${{type($var_1)}} == ${var_2} => ${{str(type($var_1)) == $var_2}}
+    Verify Variable     ${{type($var_1)}}    ${var_2}     ${var_name}
+
+
+Verify Variable
+    [Arguments]    ${var}    ${exp_var}    ${default}
+    Run Keyword And Continue On Failure   Should Not Be Equal As Strings    ${var}    ${default}
+    Run Keyword And Continue On Failure   Should Be Equal As Strings    ${var}    ${exp_var}
diff --git a/atest/TestCases/Defaults/XLS/defaults_xlsx_sheet_name.robot b/atest/TestCases/Defaults/XLS/defaults_xlsx_sheet_name.robot
@@ -0,0 +1,26 @@
+*** Settings ***
+Library    DataDriver    defaults_xlsx.xlsx     sheet_name=MySheetName
+Test Template    Check Variables
+#Default Tags    tag2
+
+
+*** Variables ***
+${Default_Tags}=    []
+
+*** Test Cases ***            ${var_1}    ${var_2}    ${var_name}   ${var_doc}                           ${var_tags}
+default ${var_1} ${var_2}     a           a           defaults      This is the Default Documentation    ${Default_Tags}
+    [Documentation]    This is the Default Documentation
+
+*** Keywords ***
+Check Variables
+    [Arguments]    ${var_1}    ${var_2}    ${var_name}   ${var_doc}   ${var_tags}
+    Verify Variable    ${var_1}                 ${var_2}          a
+    Verify Variable    ${TEST_DOCUMENTATION}    ${var_doc}        This is the Default Documentation
+    Verify Variable    ${TEST_NAME}             ${var_name}       defaults
+    #Verify Variable    ${TEST_TAGS}             ${var_tags}       ${Default_Tags}
+
+
+Verify Variable
+    [Arguments]    ${var}    ${exp_var}    ${default}
+    Run Keyword And Continue On Failure   Should Not Be Equal    ${var}    ${default}
+    Run Keyword And Continue On Failure   Should Be Equal As Strings    ${var}    ${exp_var}
diff --git a/atest/TestCases/Tags/foo_reader.py b/atest/TestCases/Tags/foo_reader.py
@@ -0,0 +1,24 @@
+from DataDriver.AbstractReaderClass import AbstractReaderClass
+from DataDriver.ReaderConfig import TestCaseData
+
+
+class foo_reader(AbstractReaderClass):
+
+    def get_data_from_source(self):
+        return self._read_file_to_data_table()
+
+    def _read_file_to_data_table(self):
+        test_data = []
+        flipflop = True
+        for i in range(6):
+            args = {'${fooarg}': i}
+            tags = ["included"]
+            if flipflop:
+                tags = ["filtered"]
+                flipflop = False
+            else:
+                flipflop = True
+            if i == 3:
+                tags = []
+            test_data.append(TestCaseData(f"Test {i}", args, tags))
+        return test_data
diff --git a/atest/TestCases/Tags/test.robot b/atest/TestCases/Tags/test.robot
@@ -0,0 +1,14 @@
+*** Settings ***
+Library           DataDriver    reader_class=foo_reader.py     handle_template_tags=DefaultTags
+Test Template     Foo Template
+Force Tags        default
+
+
+*** Test Cases ***
+Execute Toolchain for ${fooarg}
+
+
+*** Keywords ***
+Foo Template
+    [Arguments]    ${fooarg}
+    Log To Console   ${fooarg} - Tags: ${TEST TAGS}
diff --git a/atest/TestCases/custom_reader/custom_reader.robot b/atest/TestCases/custom_reader/custom_reader.robot
@@ -1,6 +1,6 @@
 *** Settings ***
 Library    DataDriver    reader_class=TestCases/custom_reader/custom_reader.py    optimize_pabot=equal
-...            min=0    max=100
+...            min=0    max=83
 Test Template    check vars
 
 
diff --git a/atest/run_atest.bat b/atest/run_atest.bat
@@ -1 +1 @@
-robot -d logs --listener RobotStackTracer --exclude performanceORFailing --loglevel TRACE:INFO --extension robot .
+robot -d logs --listener RobotStackTracer --exclude performanceORfailingORfiltered --loglevel TRACE:INFO --extension robot .
diff --git a/atest/run_atest.sh b/atest/run_atest.sh
@@ -1 +1 @@
-robot -d logs --listener RobotStackTracer --exclude performanceORFailing --loglevel TRACE:INFO --extension robot .
+robot -d logs --listener RobotStackTracer --exclude performanceORfailingORfiltered --loglevel TRACE:INFO --extension robot .
diff --git a/doc/DataDriver.html b/doc/DataDriver.html
diff --git a/src/DataDriver/AbstractReaderClass.py b/src/DataDriver/AbstractReaderClass.py
@@ -42,6 +42,7 @@ def __init__(self, reader_config: ReaderConfig):
         self.lineterminator = reader_config.lineterminator
         self.sheet_name = reader_config.sheet_name
         self.list_separator = reader_config.list_separator
+        self.handle_template_tags = reader_config.handle_template_tags
         self.kwargs = reader_config.kwargs
         for key, value in reader_config.kwargs.items():
             setattr(self, key, value)
diff --git a/src/DataDriver/DataDriver.py b/src/DataDriver/DataDriver.py
@@ -44,7 +44,7 @@
     error,
     equally_partition_test_list,
     binary_partition_test_list,
-    Encodings,
+    Encodings, TagHandling,
 )
 
 __version__ = "1.5.0"
@@ -1349,6 +1349,7 @@ def __init__(
         file_regex: str = r"(?i)(.*?)(\.csv)",
         include: Optional[str] = None,
         exclude: Optional[str] = None,
+        handle_template_tags: TagHandling = TagHandling.UnsetTags,
         listseperator: str = ",",
         config_keyword: Optional[str] = None,
         optimize_pabot: PabotOpt = PabotOpt.Equal,
@@ -1385,6 +1386,7 @@ def __init__(
     ...    file_regex=(?i)(.*?)(\\.csv)
     ...    include=None
     ...    exclude=None
+    ...    handle_template_tags=UnsetTags
     ...    listseperator=,
     ...    config_keyword=None
     ...    optimize_pabot=Equal
@@ -1415,23 +1417,24 @@ def __init__(
 Defines how a csv file is interpreted.
 
 
-Sheet Name
-^^^^^^^^^^
-
-Defines which Excel Sheed has to be taken.
-
-
 Reader Class
 ^^^^^^^^^^^^
 
 Defines which custom DataReader shall be loaded and get handed over all configs to deliver the TestCaseData.
 
+
 Include & Exclude
 ^^^^^^^^^^^^^^^^^
 
 Alternative way to CLI Options of Robot Framework® to filter the specific TestCaseData based on given Tags.
 
 
+Handle Template Tags
+^^^^^^^^^^^^^^^^^^^^
+
+It can be configured how the tags of the template test will be added to the data-driven test cases.
+
+
 List Separator
 ^^^^^^^^^^^^^^
 
@@ -1462,6 +1465,7 @@ def __init__(
         self.robot_options = robot_options()
         self.include = self.robot_options["include"] if not include else include
         self.exclude = self.robot_options["exclude"] if not exclude else exclude
+        self.handle_template_tags = handle_template_tags
         encoding_str = encoding.name if isinstance(encoding, Encodings) else str(encoding)
 
         self.config_dict = DotDict(
@@ -1480,6 +1484,7 @@ def __init__(
             file_regex=file_regex,
             include=self.include,
             exclude=self.exclude,
+            handle_template_tags=self.handle_template_tags,
             list_separator=listseperator,
             config_keyword=config_keyword,
             optimize_pabot=optimize_pabot,
@@ -1549,8 +1554,11 @@ def _get_all_tags(self):
         return all_tags
 
     def _clean_template_test(self):
-        for tag in self._get_all_tags():
-            self.template_test.tags.remove(tag)
+        if self.handle_template_tags == TagHandling.NoTags:
+            self.template_test.tags = Tags()
+        elif self.handle_template_tags == TagHandling.UnsetTags:
+            for tag in self._get_all_tags():
+                self.template_test.tags.remove(tag)
         if self._is_new_model():
             self.template_test.body = None
         else:
@@ -1585,20 +1593,21 @@ def _get_filtered_test_list(self):
 
     def _included_by_tags(self):
         if self.include and isinstance(self.test_case_data.tags, list):
-            tags = Tags()
-            tags.add(self.template_test.tags)
-            tags.add(self.test_case_data.tags)
-            return tags.match(self.include)
+            return self._filter_tag(self.include)
         return True
 
     def _not_excluded_by_tags(self):
         if self.exclude and isinstance(self.test_case_data.tags, list):
-            tags = Tags()
-            tags.add(self.template_test.tags)
-            tags.add(self.test_case_data.tags)
-            return not tags.match(self.exclude)
+            return not self._filter_tag(self.exclude)
         return True
 
+    def _filter_tag(self, filter_setting):
+        tags = Tags()
+        if self.handle_template_tags != TagHandling.DefaultTags or len(self.test_case_data.tags) == 0:
+            tags.add(self.template_test.tags)
+        tags.add(self.test_case_data.tags)
+        return tags.match(filter_setting)
+
     def _create_data_table(self):
         """
         this function creates a dictionary which contains all data from data file.
@@ -1864,6 +1873,8 @@ def _get_template_arguments(self):
 
     def _add_test_case_tags(self):
         if isinstance(self.test_case_data.tags, list):
+            if self.handle_template_tags == TagHandling.DefaultTags and len(self.test_case_data.tags) > 0:
+                self.test.tags = Tags()
             for tag in self.test_case_data.tags:
                 self.test.tags.add(tag.strip())
         self._add_tag_if_pabot_dryrun()
diff --git a/src/DataDriver/ReaderConfig.py b/src/DataDriver/ReaderConfig.py
@@ -16,7 +16,7 @@
 
 from robot.utils import DotDict  # type: ignore
 
-from .utils import PabotOpt
+from .utils import PabotOpt, TagHandling
 
 
 class ReaderConfig:
@@ -40,6 +40,7 @@ def __init__(
         file_regex: Optional[str] = None,
         include: Optional[str] = None,
         exclude: Optional[str] = None,
+        handle_template_tags: TagHandling = TagHandling.UnsetTags,
         list_separator: Optional[str] = ",",
         config_keyword: Optional[str] = None,
         optimize_pabot: PabotOpt = PabotOpt.Equal,
@@ -61,6 +62,7 @@ def __init__(
         self.file_regex = file_regex
         self.include = include
         self.exclude = exclude
+        self.handle_template_tags = handle_template_tags
         self.list_separator = list_separator
         self.config_keyword = config_keyword
         self.optimize_pabot = optimize_pabot
diff --git a/src/DataDriver/utils.py b/src/DataDriver/utils.py
@@ -151,6 +151,23 @@ class PabotOpt(Enum):
     Atomic = auto()
 
 
+class TagHandling(Enum):
+    """
+You can configure how to handle tags from the template in generated tests:
+
+- ForceTags: Will add all tags of the template test to all data-driven test cases.
+- UnsetTags: Will add only these tags from template test to the tests, that are not assigned to any of the test cases.
+- DefaultTags: Will only add tags to data-driven test if no tag is set on that test.
+- NoTags: Will not add any tags from the template to date-driven tests.
+
+    """
+    ForceTags = auto()
+    UnsetTags = auto()
+    DefaultTags = auto()
+    NoTags = auto()
+
+
+
 def debug(msg: Any, newline: bool = True, stream: str = "stdout"):
     if get_variable_value("${LOG LEVEL}") in ["DEBUG", "TRACE"]:
         logger.console(msg, newline, stream)

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-robot -d logs --listener RobotStackTracer --exclude performanceORFailing --loglevel TRACE:INFO --extension robot .`
	`1`	`+robot -d logs --listener RobotStackTracer --exclude performanceORfailingORfiltered --loglevel TRACE:INFO --extension robot .`