Fix variables in tag renamed with NormalizeTags (#642)

Author: bhirsz

docs/releasenotes/unreleased/fixes.2.rst

@@ -0,0 +1,9 @@
+Variables in tags are no longer renamed with NormalizeTags (#638)
+-----------------------------------------------------------------
+
+``NormalizeTags`` transformer incorrectly affected variables used in tags::
+
+  *** Settings ***
+  Test Tags    tag with ${var}
+
+Such variables will be now ignored.

robotidy/transformers/NormalizeTags.py

@@ -3,6 +3,7 @@
 from robotidy.disablers import skip_section_if_disabled
 from robotidy.exceptions import InvalidParameterValueError
 from robotidy.transformers import Transformer
+from robotidy.utils import variable_matcher
 
 
 class NormalizeTags(Transformer):
@@ -39,14 +40,15 @@ class NormalizeTags(Transformer):
 
     def __init__(self, case: str = "lowercase", normalize_case: bool = True, preserve_format: bool = False):
         super().__init__()
-        self.case = case.lower()
+        self.case_function = case.lower()
         self.normalize_case = normalize_case
         self.preserve_format = preserve_format
-        try:
-            self.case_function = self.CASE_FUNCTIONS[self.case]
-        except KeyError:
+        self.validate_case_function()
+
+    def validate_case_function(self):
+        if self.case_function not in self.CASE_FUNCTIONS:
             raise InvalidParameterValueError(
-                self.__class__.__name__, "case", case, "Supported cases: lowercase, uppercase, titlecase."
+                self.__class__.__name__, "case", self.case_function, "Supported cases: lowercase, uppercase, titlecase."
             )
 
     @skip_section_if_disabled
@@ -69,13 +71,28 @@ def normalize_tags(self, node, indent=False):
             return self.normalize_tags_tokens_preserve_formatting(node)
         return self.normalize_tags_tokens_ignore_formatting(node, indent)
 
+    def format_with_case_function(self, string: str) -> str:
+        if "{" not in string:
+            return self.CASE_FUNCTIONS[self.case_function](string)
+        tag = ""
+        var_found = False
+        for match in variable_matcher.VariableMatches(string, ignore_errors=True):
+            var_found = True
+            tag += self.CASE_FUNCTIONS[self.case_function](match.before)
+            tag += match.match
+            tag += self.CASE_FUNCTIONS[self.case_function](match.after)
+        if var_found:
+            return tag
+        else:
+            return self.CASE_FUNCTIONS[self.case_function](string)
+
     def normalize_tags_tokens_preserve_formatting(self, node):
         if not self.normalize_case:
             return node
         for token in node.tokens:
             if token.type != Token.ARGUMENT:
                 continue
-            token.value = self.case_function(token.value)
+            token.value = self.format_with_case_function(token.value)
         return node
 
     def normalize_tags_tokens_ignore_formatting(self, node, indent):
@@ -99,7 +116,7 @@ def normalize_tags_tokens_ignore_formatting(self, node, indent):
         return node
 
     def convert_case(self, tags):
-        return [self.case_function(item) for item in tags]
+        return [self.format_with_case_function(item) for item in tags]
 
     @staticmethod
     def remove_duplicates(tags):

tests/atest/transformers/NormalizeTags/expected/variables_in_tags_lowercase.robot

@@ -0,0 +1,12 @@
+*** Settings ***
+Test Tags    simple    with ${VAR}
+Default Tags    simple    with ${VAR lower}
+
+
+*** Test Cases ***
+No tags
+    Keyword no tags
+
+Tags
+    [Tags]    simple    with ${VAR}    ${tag}    ${tag} after
+    One Tag Keyword

tests/atest/transformers/NormalizeTags/expected/variables_in_tags_titlecase.robot

@@ -0,0 +1,12 @@
+*** Settings ***
+Test Tags    Simple    With ${VAR}
+Default Tags    Simple    With ${VAR lower}
+
+
+*** Test Cases ***
+No tags
+    Keyword no tags
+
+Tags
+    [Tags]    Simple    With ${VAR}    ${tag}    ${tag} After
+    One Tag Keyword

tests/atest/transformers/NormalizeTags/expected/variables_in_tags_uppercase.robot

@@ -0,0 +1,12 @@
+*** Settings ***
+Test Tags    SIMPLE    WITH ${VAR}
+Default Tags    SIMPLE    WITH ${VAR lower}
+
+
+*** Test Cases ***
+No tags
+    Keyword no tags
+
+Tags
+    [Tags]    SIMPLE    WITH ${VAR}    ${tag}    ${tag} AFTER
+    One Tag Keyword

tests/atest/transformers/NormalizeTags/source/variables_in_tags.robot

@@ -0,0 +1,13 @@
+*** Settings ***
+Test Tags          simple    WITH ${VAR}
+Default Tags        SIMPLE    with ${VAR lower}
+
+
+*** Test Cases ***
+No tags
+    Keyword no tags
+
+Tags
+    [Tags]    SIMPLE    with ${VAR}    ${tag}
+    ...    ${tag} after
+    One Tag Keyword

tests/atest/transformers/NormalizeTags/test_transformer.py

@@ -64,3 +64,12 @@ def test_preserve_format_do_not_normalize_case(self):
 
     def test_ignore_format(self):
         self.compare(source="preserve_format.robot", expected="preserve_format_default.robot")
+
+    @pytest.mark.parametrize("case_function", ["lowercase", "uppercase", "titlecase"])
+    def test_variable_in_tag(self, case_function: str):
+        self.compare(
+            source="variables_in_tags.robot",
+            expected=f"variables_in_tags_{case_function}.robot",
+            config=f":case={case_function}",
+            target_version=">=6",
+        )