Split wrong-case-in-keyword-name into itself and wrong-case-in-keyword-call rules (#1552)

feat: Split wrong-case-in-keyword-name into itself and wrong-case-in-keyword-call

Author: bhirsz

docs/releasenotes/changelog.md

@@ -4,6 +4,15 @@
 
 ### Features
 
+- **Breaking change** Split ``wrong-case-in-keyword-name`` rule into two separate rules ([issue #1471](https://github.com/MarketSquare/robotframework-robocop/issues/1471)):
+
+``wrong-case-in-keyword-name`` which checks case convention in keyword definition name
+``wrong-case-in-keyword-call`` which checks case convention in keyword call name
+
+It allows configuring different conventions for keyword definition and keyword call names. If you have existing
+configuration for ``wrong-case-in-keyword-name`` (you are ignoring it or configuring) you need to apply the same
+config to ``wrong-case-in-keyword-call`` to retain old behaviour.
+
 - Extend robocop disablers to the whole node ([issue #1515](https://github.com/MarketSquare/robotframework-robocop/issues/1515)
 
 Robocop will now ignore issues in the whole node (keyword, test case, for loop, keyword call, etc.) when the disabler

src/robocop/linter/rules/naming.py

@@ -63,7 +63,7 @@ class WrongCaseInKeywordNameRule(Rule):
     Keyword name does not follow case convention.
 
     Keyword names need to follow a specific case convention.
-    The convention can be set using ``convention`` parameter and accepts
+    The convention can be set using the `` convention `` parameter and accepts
     one of the 2 values: ``each_word_capitalized`` or ``first_word_capitalized``.
 
     By default, it's configured to ``each_word_capitalized``, which requires each keyword to follow such
@@ -76,7 +76,7 @@ class WrongCaseInKeywordNameRule(Rule):
             Click 'Next' Button
             [Teardown]  Log Form Data
 
-    You can also set it to ``first_word_capitalized`` which requires first word to have first letter capital:
+    You can also set it to ``first_word_capitalized`` which requires capitalising the first word of the keyword:
 
         *** Keywords ***
         Fill out the form
@@ -89,10 +89,12 @@ class WrongCaseInKeywordNameRule(Rule):
     that are accepted in the keyword name, even though they violate the case convention.
 
     ``pattern`` parameter accepts a regex pattern. For example, configuring it to ``robocop\.readthedocs\.io``
-    would make such keyword legal:
+    would make the following keyword legal:
 
         Go To robocop.readthedocs.io Page
 
+    See the sibling rule [wrong-case-in-keyword-call](#wrong-case-in-keyword-call) that checks keyword call
+    naming convention.
     """
 
     name = "wrong-case-in-keyword-name"
@@ -563,6 +565,70 @@ class MixedTaskTestSettingsRule(Rule):
     deprecated_names = ("0326",)
 
 
+class WrongCaseInKeywordCallRule(Rule):
+    r"""
+    Keyword call name does not follow case convention.
+
+    Keyword names need to follow a specific case convention.
+    The convention can be set using the `` convention `` parameter and accepts
+    one of the 2 values: ``each_word_capitalized`` or ``first_word_capitalized``.
+
+    By default, it's configured to ``each_word_capitalized``, which requires each keyword to follow such
+    convention:
+
+        *** Keywords ***
+        Fill out the form
+            Provide Shipping Address
+            Provide Payment Method
+            Click 'Next' Button
+            [Teardown]  Log Form Data
+
+    You can also set it to ``first_word_capitalized`` which requires capitalising the first word of the keyword:
+
+        *** Keywords ***
+        Fill out the form
+            Provide shipping address
+            Provide payment method
+            Click 'Next' button
+            [Teardown]  Log form data
+
+    The rule also accepts another parameter ``pattern`` which can be used to configure words
+    that are accepted in the keyword name, even though they violate the case convention.
+
+    ``pattern`` parameter accepts a regex pattern. For example, configuring it to ``robocop\.readthedocs\.io``
+    would make the following keyword legal:
+
+        Go To robocop.readthedocs.io Page
+
+    See the sibling rule [wrong-case-in-keyword-name](#wrong-case-in-keyword-name) that checks keyword definition
+    naming convention.
+    """
+
+    name = "wrong-case-in-keyword-call"
+    rule_id = "NAME18"
+    message = "Keyword name '{keyword_name}' does not follow case convention"
+    severity = RuleSeverity.WARNING
+    parameters = [
+        RuleParam(
+            name="convention",
+            default="each_word_capitalized",
+            converter=str,
+            desc="possible values: 'each_word_capitalized' (default) or 'first_word_capitalized'",
+        ),
+        RuleParam(
+            name="pattern",
+            default=re.compile(r""),
+            converter=utils.pattern_type,
+            show_type="regex",
+            desc="pattern for accepted words in keyword",
+        ),
+    ]
+    added_in_version = "7.0.0"
+    sonar_qube_attrs = sonar_qube.SonarQubeAttributes(
+        clean_code=sonar_qube.CleanCodeAttribute.IDENTIFIABLE, issue_type=sonar_qube.SonarQubeIssueType.CODE_SMELL
+    )
+
+
 SET_VARIABLE_VARIANTS = {
     "settaskvariable",
     "settestvariable",
@@ -647,6 +713,7 @@ class KeywordNamingChecker(VisitorChecker):
     """Checker for keyword naming violations."""
 
     wrong_case_in_keyword_name: WrongCaseInKeywordNameRule
+    wrong_case_in_keyword_call: WrongCaseInKeywordCallRule
     keyword_name_is_reserved_word: KeywordNameIsReservedWordRule
     underscore_in_keyword_name: UnderscoreInKeywordNameRule
     else_not_upper_case: ElseNotUpperCaseRule
@@ -697,7 +764,7 @@ def visit_Keyword(self, node) -> None:  # noqa: N802
         if not node.name:
             self.report(self.keyword_name_is_empty, node=node)
         else:
-            self.check_keyword_naming(node.name, node)
+            self.check_keyword_naming(node.name, node, is_keyword_definition=True)
         self.generic_visit(node)
 
     def visit_KeywordCall(self, node) -> None:  # noqa: N802
@@ -713,15 +780,19 @@ def visit_If(self, node) -> None:  # noqa: N802
         self.generic_visit(node)
         self.inside_if_block = False
 
-    def check_keyword_naming(self, keyword_name, node) -> None:
+    def check_keyword_naming(self, keyword_name, node, is_keyword_definition: bool = False) -> None:
         if not keyword_name or keyword_name.lstrip().startswith("#"):
             return
         if keyword_name == r"/":  # old for loop, / are interpreted as keywords
             return
         if self.check_if_keyword_is_reserved(keyword_name, node):
             return
+        if is_keyword_definition:
+            case_naming_rule = self.wrong_case_in_keyword_name
+        else:
+            case_naming_rule = self.wrong_case_in_keyword_call
         normalized = utils.remove_robot_vars(keyword_name)
-        normalized = self.wrong_case_in_keyword_name.pattern.sub("", normalized)
+        normalized = case_naming_rule.pattern.sub("", normalized)
         normalized = normalized.split(".")[-1]  # remove any imports ie ExternalLib.SubLib.Log -> Log
         normalized = normalized.replace("'", "")  # replace ' apostrophes
         if "_" in normalized:
@@ -733,11 +804,11 @@ def check_keyword_naming(self, keyword_name, node) -> None:
                 end_col=node.col_offset + len(keyword_name.rstrip()) + 1,
             )
         words = self.letter_pattern.sub(" ", normalized).split(" ")
-        if self.wrong_case_in_keyword_name.convention == "first_word_capitalized":
+        if case_naming_rule.convention == "first_word_capitalized":
             words = words[:1]
         if any(word[0].islower() for word in words if word):
             self.report(
-                self.wrong_case_in_keyword_name,
+                case_naming_rule,
                 keyword_name=keyword_name,
                 node=node,
                 col=node.col_offset + 1,

tests/linter/rules/misc/unused_disabler/expected_extended.txt

@@ -16,15 +16,15 @@ test.robot:3:21 MISC15 Disabler directive found for 'NAME01' rule(s) but no viol
  2 | Inline disablers - not used
  3 |     No Operation  # robocop: off=NAME01
    |                     ^^^^^^^^^^^^^^^^^^^ MISC15
- 4 |     No Operation  # robocop: off=wrong-case-in-keyword-name
+ 4 |     No Operation  # robocop: off=wrong-case-in-keyword-call
  5 |     FOR    ${var}    IN    @{LIST}    # robocop: off=unused-variable
    |
 
-test.robot:4:21 MISC15 Disabler directive found for 'wrong-case-in-keyword-name' rule(s) but no violation found
+test.robot:4:21 MISC15 Disabler directive found for 'wrong-case-in-keyword-call' rule(s) but no violation found
    |
  2 | Inline disablers - not used
  3 |     No Operation  # robocop: off=NAME01
- 4 |     No Operation  # robocop: off=wrong-case-in-keyword-name
+ 4 |     No Operation  # robocop: off=wrong-case-in-keyword-call
    |                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ MISC15
  5 |     FOR    ${var}    IN    @{LIST}    # robocop: off=unused-variable
  6 |         Log    ${var}
@@ -33,7 +33,7 @@ test.robot:4:21 MISC15 Disabler directive found for 'wrong-case-in-keyword-name'
 test.robot:5:41 MISC15 Disabler directive found for 'unused-variable' rule(s) but no violation found
    |
  3 |     No Operation  # robocop: off=NAME01
- 4 |     No Operation  # robocop: off=wrong-case-in-keyword-name
+ 4 |     No Operation  # robocop: off=wrong-case-in-keyword-call
  5 |     FOR    ${var}    IN    @{LIST}    # robocop: off=unused-variable
    |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ MISC15
  6 |         Log    ${var}

tests/linter/rules/misc/unused_disabler/expected_output.txt

@@ -1,5 +1,5 @@
 test.robot:3:21 [I] MISC15 Disabler directive found for 'NAME01' rule(s) but no violation found
-test.robot:4:21 [I] MISC15 Disabler directive found for 'wrong-case-in-keyword-name' rule(s) but no violation found
+test.robot:4:21 [I] MISC15 Disabler directive found for 'wrong-case-in-keyword-call' rule(s) but no violation found
 test.robot:5:41 [I] MISC15 Disabler directive found for 'unused-variable' rule(s) but no violation found
 test.robot:8:21 [I] MISC15 Disabler directive found for 'all' rule(s) but no violation found
 test.robot:17:21 [I] MISC15 Disabler directive found for 'NAME01' rule(s) but no violation found

tests/linter/rules/misc/unused_disabler/expected_output_rf4.txt

@@ -1,5 +1,5 @@
 test.robot:3:21 [I] MISC15 Disabler directive found for 'NAME01' rule(s) but no violation found
-test.robot:4:21 [I] MISC15 Disabler directive found for 'wrong-case-in-keyword-name' rule(s) but no violation found
+test.robot:4:21 [I] MISC15 Disabler directive found for 'wrong-case-in-keyword-call' rule(s) but no violation found
 test.robot:5:41 [I] MISC15 Disabler directive found for 'unused-variable' rule(s) but no violation found
 test.robot:8:21 [I] MISC15 Disabler directive found for 'all' rule(s) but no violation found
 test.robot:17:21 [I] MISC15 Disabler directive found for 'NAME01' rule(s) but no violation found

tests/linter/rules/misc/unused_disabler/test.robot

@@ -1,14 +1,14 @@
 *** Test Cases ***
 Inline disablers - not used
     No Operation  # robocop: off=NAME01
-    No Operation  # robocop: off=wrong-case-in-keyword-name
+    No Operation  # robocop: off=wrong-case-in-keyword-call
     FOR    ${var}    IN    @{LIST}    # robocop: off=unused-variable
         Log    ${var}
     END
     Log    ${var}  # robocop: off
 
 Inline disablers - .used  # robocop: off=NAME01
-    No operation  # robocop: off=wrong-case-in-keyword-name
+    No operation  # robocop: off=wrong-case-in-keyword-call
     FOR    ${var}    IN    @{LIST}    # robocop: off=unused-variable
         Log    I dont use var
     END

tests/linter/rules/misc/unused_disabler/test_rule.py

@@ -5,7 +5,7 @@
     "multiline-inline-if",
     "duplicated-variable",
     "NAME01",
-    "NAME02",
+    "NAME18",
     "VAR02",
 ]
 

tests/linter/rules/naming/wrong_case_in_keyword_call/__init__.py

@@ -0,0 +1 @@
+configure_pattern${/}test.robot:4:3 [W] NAME18 Keyword name 'Not Allowed Dot In Keyword Foo.baz' does not follow case convention

tests/linter/rules/naming/wrong_case_in_keyword_call/configure_pattern/expected_output.txt

@@ -0,0 +1,11 @@
+*** Test Cases ***
+Test
+  Allowed Dot In Name Foo.bar
+  Not Allowed Dot In Keyword Foo.baz
+
+*** Keywords ***
+Allowed Dot In Name Foo.bar
+    No Operation
+
+Not Allowed Dot In Keyword Foo.baz
+    No Operation