implement Full Support for BDD Style keywords

Author: d-biehl

CHANGELOG.md

@@ -47,7 +47,8 @@ All notable changes to the "robotcode" extension will be documented in this file
 - optimize loading of imports and collecting keywords
   - this addresses [#24](https://github.com/d-biehl/robotcode/issues/24)
   - one of the big points here is, beware of namespace pollution ;-)
-
+- Full Support for BDD Style keywords
+  - includes hover, goto, highlight, references, ...
 
 ##  0.5.5
 

package.json

@@ -139,6 +139,9 @@
           "nameCall": [
             "variable.function.keyword-call.robotframework"
           ],
+          "bddPrefix": [
+            "keyword.modifier.bdd-prefix.robotframework"
+          ],
           "continuation": [
             "punctuation.separator.continuation.robotframework"
           ],

robotcode/language_server/robotframework/diagnostics/analyzer.py

@@ -17,6 +17,7 @@
     Range,
 )
 from ...common.text_document import TextDocument
+from ..parts.model_helper import ModelHelperMixin
 from ..utils.ast import (
     Token,
     is_not_variable_token,
@@ -31,7 +32,7 @@
 ROBOTCODE_PATTERN = re.compile(r"(?P<marker>\brobotcode\b)\s*:\s*(?P<rule>\b\w+\b)")
 
 
-class Analyzer(AsyncVisitor):
+class Analyzer(AsyncVisitor, ModelHelperMixin):
     def __init__(self, model: ast.AST, namespace: Namespace) -> None:
         from robot.parsing.model.statements import Template, TestTemplate
 
@@ -109,7 +110,7 @@ async def _analyze_keyword_call(
 
             for e in self.finder.diagnostics:
                 await self.append_diagnostics(
-                    range=range_from_node_or_token(node, keyword_token),
+                    range=range_from_node_or_token(node, self.strip_bdd_prefix(keyword_token)),
                     message=e.message,
                     severity=e.severity,
                     source=DIAGNOSTICS_SOURCE_NAME,
@@ -119,7 +120,7 @@ async def _analyze_keyword_call(
             if result is not None:
                 if result.errors:
                     await self.append_diagnostics(
-                        range=range_from_node_or_token(node, keyword_token),
+                        range=range_from_node_or_token(node, self.strip_bdd_prefix(keyword_token)),
                         message="Keyword definition contains errors.",
                         severity=DiagnosticSeverity.ERROR,
                         source=DIAGNOSTICS_SOURCE_NAME,
@@ -162,7 +163,7 @@ async def _analyze_keyword_call(
 
                 if result.is_deprecated:
                     await self.append_diagnostics(
-                        range=range_from_node_or_token(node, keyword_token),
+                        range=range_from_node_or_token(node, self.strip_bdd_prefix(keyword_token)),
                         message=f"Keyword '{result.name}' is deprecated"
                         f"{f': {result.deprecated_message}' if result.deprecated_message else ''}.",
                         severity=DiagnosticSeverity.HINT,
@@ -171,7 +172,7 @@ async def _analyze_keyword_call(
                     )
                 if result.is_error_handler:
                     await self.append_diagnostics(
-                        range=range_from_node_or_token(node, keyword_token),
+                        range=range_from_node_or_token(node, self.strip_bdd_prefix(keyword_token)),
                         message=f"Keyword definition contains errors: {result.error_handler_message}",
                         severity=DiagnosticSeverity.ERROR,
                         source=DIAGNOSTICS_SOURCE_NAME,
@@ -191,7 +192,7 @@ async def _analyze_keyword_call(
                     except BaseException as e:
                         await self.append_diagnostics(
                             range=Range(
-                                start=range_from_token(keyword_token).start,
+                                start=range_from_token(self.strip_bdd_prefix(keyword_token)).start,
                                 end=range_from_token(argument_tokens[-1]).end
                                 if argument_tokens
                                 else range_from_token(keyword_token).end,

robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -911,44 +911,6 @@ def error_from_exception(ex: BaseException, default_source: Optional[str], defau
     )
 
 
-BUILTIN_VARIABLES = [
-    "${CURDIR}",
-    "${EMPTY}",
-    "${TEMPDIR}",
-    "${EXECDIR}",
-    "${/}",
-    "${:}",
-    "${\\n}",
-    "${SPACE}",
-    "${True}",
-    "${False}",
-    "${None}",
-    "${null}",
-    "${TEST NAME}",
-    "@{TEST TAGS}",
-    "${TEST DOCUMENTATION}",
-    "${TEST STATUS}",
-    "${TEST MESSAGE}",
-    "${PREV TEST NAME}",
-    "${PREV TEST STATUS}",
-    "${PREV TEST MESSAGE}",
-    "${SUITE NAME}",
-    "${SUITE SOURCE}",
-    "${SUITE DOCUMENTATION}",
-    "&{SUITE METADATA}",
-    "${SUITE STATUS}",
-    "${SUITE MESSAGE}",
-    "${KEYWORD STATUS}",
-    "${KEYWORD MESSAGE}",
-    "${LOG LEVEL}",
-    "${OUTPUT FILE}",
-    "${LOG FILE}",
-    "${REPORT FILE}",
-    "${DEBUG FILE}",
-    "${OUTPUT DIR}",
-]
-
-
 @dataclass
 class _Variable(object):
 

robotcode/language_server/robotframework/diagnostics/namespace.py

@@ -48,6 +48,7 @@
     tokenize_variables,
 )
 from ..utils.async_ast import AsyncVisitor
+from ..utils.variables import BUILTIN_VARIABLES
 from .entities import (
     ArgumentDefinition,
     BuiltInVariableDefinition,
@@ -62,7 +63,6 @@
 from .imports_manager import ImportsManager
 from .library_doc import (
     BUILTIN_LIBRARY_NAME,
-    BUILTIN_VARIABLES,
     DEFAULT_LIBRARIES,
     KeywordDoc,
     KeywordError,

robotcode/language_server/robotframework/parts/completion.py

@@ -809,6 +809,9 @@ async def _complete_TestCase_or_Keyword(  # noqa: N802
 
             if len(statement_node.tokens) > index:
                 token = statement_node.tokens[index]
+
+                token = self.strip_bdd_prefix(token)
+
                 r = range_from_token(token)
                 if position.is_in_range(r) or r.end == position:
                     return await create_items(in_assign, in_template, r, token, position)
@@ -821,7 +824,9 @@ async def _complete_TestCase_or_Keyword(  # noqa: N802
 
                     r.end.character += 1
                     if position.is_in_range(r) or r.end == position:
-                        return await create_items(in_assign, in_template, r, token, position)
+                        return await create_items(
+                            in_assign, in_template, r, None if self.is_bdd_token(token) else token, position
+                        )
 
         return None
 
@@ -939,9 +944,26 @@ async def _complete_SuiteSetup_or_SuiteTeardown_or_TestTemplate(  # noqa: N802
 
         if len(statement_node.tokens) > 2:
             token = cast(Token, statement_node.tokens[2])
+
+            token = self.strip_bdd_prefix(token)
+
             r = range_from_token(token)
             if position.is_in_range(r) or r.end == position:
-                return await self.create_keyword_completion_items(token, position, add_reserverd=False)
+                return await self.create_keyword_completion_items(
+                    None if self.is_bdd_token(token) else token, position, add_reserverd=False
+                )
+
+        if len(statement_node.tokens) > 3:
+            second_token = statement_node.tokens[3]
+            ws = whitespace_at_begin_of_token(second_token)
+            if ws < 1:
+                return None
+
+            r.end.character += 1
+            if position.is_in_range(r) or r.end == position:
+                return await self.create_keyword_completion_items(
+                    None if self.is_bdd_token(token) else token, position, add_reserverd=False
+                )
 
         return None
 
@@ -1025,6 +1047,7 @@ async def complete_Setup_or_Teardown_or_Template(  # noqa: N802
         statement_node = cast(Statement, node)
         if len(statement_node.tokens) > 2:
             token = cast(Token, statement_node.tokens[2])
+
             r = range_from_token(token)
             ws = whitespace_at_begin_of_token(token)
             if ws < 2:
@@ -1042,10 +1065,25 @@ async def complete_Setup_or_Teardown_or_Template(  # noqa: N802
 
         if len(statement_node.tokens) > 3:
             token = cast(Token, statement_node.tokens[3])
+
+            token = self.strip_bdd_prefix(token)
+
             r = range_from_token(token)
             if position.is_in_range(r) or r.end == position:
                 return await self.create_keyword_completion_items(token, position, add_reserverd=False)
 
+        if len(statement_node.tokens) > 4:
+            second_token = statement_node.tokens[4]
+            ws = whitespace_at_begin_of_token(second_token)
+            if ws < 1:
+                return None
+
+            r.end.character += 1
+            if position.is_in_range(r) or r.end == position:
+                return await self.create_keyword_completion_items(
+                    None if self.is_bdd_token(token) else token, position, add_reserverd=False
+                )
+
         return None
 
     async def complete_Setup(  # noqa: N802

robotcode/language_server/robotframework/parts/document_highlight.py

@@ -174,6 +174,8 @@ async def highlight_KeywordCall(  # noqa: N802
         if result is not None:
             keyword_doc, keyword_token = result
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -185,7 +187,12 @@ async def highlight_KeywordCall(  # noqa: N802
                 if position in r:
                     # TODO highlight namespaces
                     return None
-            if keyword_doc is not None and not keyword_doc.is_error_handler and keyword_doc.source:
+            if (
+                position in kw_range
+                and keyword_doc is not None
+                and not keyword_doc.is_error_handler
+                and keyword_doc.source
+            ):
                 return [
                     *(
                         [DocumentHighlight(keyword_doc.range, DocumentHighlightKind.TEXT)]
@@ -258,6 +265,9 @@ async def highlight_Fixture(  # noqa: N802
 
         if result is not None:
             keyword_doc, keyword_token = result
+
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -270,7 +280,7 @@ async def highlight_Fixture(  # noqa: N802
                     # TODO highlight namespaces
                     return None
 
-            if keyword_doc is not None and not keyword_doc.is_error_handler:
+            if position in kw_range and keyword_doc is not None and not keyword_doc.is_error_handler:
                 return [
                     *(
                         [DocumentHighlight(keyword_doc.range, DocumentHighlightKind.TEXT)]
@@ -300,6 +310,8 @@ async def _highlight_Template_or_TestTemplate(  # noqa: N802
             if keyword_token is None:
                 return None
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             if position.is_in_range(range_from_token(keyword_token)):
                 namespace = await self.parent.documents_cache.get_namespace(document)
                 if namespace is None:

robotcode/language_server/robotframework/parts/goto.py

@@ -291,6 +291,8 @@ async def definition_KeywordCall(  # noqa: N802
         if result is not None:
             keyword_doc, keyword_token = result
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -321,7 +323,7 @@ async def definition_KeywordCall(  # noqa: N802
                     else:
                         return None
 
-            if keyword_doc is not None and keyword_doc.source:
+            if position in kw_range and keyword_doc is not None and keyword_doc.source:
                 return [
                     LocationLink(
                         origin_selection_range=kw_range,
@@ -355,6 +357,8 @@ async def definition_Fixture(  # noqa: N802
         if result is not None:
             keyword_doc, keyword_token = result
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -385,7 +389,7 @@ async def definition_Fixture(  # noqa: N802
                     else:
                         return None
 
-            if keyword_doc is not None and keyword_doc.source:
+            if position in kw_range and keyword_doc is not None and keyword_doc.source:
                 return [
                     LocationLink(
                         origin_selection_range=kw_range,
@@ -415,6 +419,8 @@ async def _definition_Template_or_TestTemplate(  # noqa: N802
             if keyword_token is None:
                 return None
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             if position.is_in_range(range_from_token(keyword_token)):
                 namespace = await self.parent.documents_cache.get_namespace(document)
                 if namespace is None:

robotcode/language_server/robotframework/parts/hover.py

@@ -266,6 +266,8 @@ async def hover_KeywordCall(  # noqa: N802
         if result is not None:
             keyword_doc, keyword_token = result
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -280,7 +282,7 @@ async def hover_KeywordCall(  # noqa: N802
                         range=r,
                     )
 
-            if keyword_doc is not None and not keyword_doc.is_error_handler:
+            if position in kw_range and keyword_doc is not None and not keyword_doc.is_error_handler:
                 return Hover(
                     contents=MarkupContent(kind=MarkupKind.MARKDOWN, value=keyword_doc.to_markdown()),
                     range=kw_range,
@@ -308,6 +310,9 @@ async def hover_Fixture(  # noqa: N802
 
         if result is not None:
             keyword_doc, keyword_token = result
+
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             lib_entry, kw_namespace = await self.get_namespace_info_from_keyword(namespace, keyword_token)
 
             kw_range = range_from_token(keyword_token)
@@ -322,7 +327,7 @@ async def hover_Fixture(  # noqa: N802
                         range=r,
                     )
 
-            if keyword_doc is not None and not keyword_doc.is_error_handler:
+            if position in kw_range and keyword_doc is not None and not keyword_doc.is_error_handler:
                 return Hover(
                     contents=MarkupContent(kind=MarkupKind.MARKDOWN, value=keyword_doc.to_markdown()),
                     range=kw_range,
@@ -342,6 +347,8 @@ async def _hover_Template_or_TestTemplate(  # noqa: N802
             if keyword_token is None:
                 return None
 
+            keyword_token = self.strip_bdd_prefix(keyword_token)
+
             if position.is_in_range(range_from_token(keyword_token)):
                 namespace = await self.parent.documents_cache.get_namespace(document)
                 if namespace is None:

robotcode/language_server/robotframework/parts/model_helper.py

@@ -420,3 +420,28 @@ def get_expression_statement_types(cls) -> Tuple[Type[Any]]:
                 )
 
         return cls.__expression_statement_types
+
+    BDD_TOKEN_REGEX = re.compile(r"^(Given|When|Then|And|But)\s", flags=re.IGNORECASE)
+    BDD_TOKEN = re.compile(r"^(Given|When|Then|And|But)$", flags=re.IGNORECASE)
+
+    @classmethod
+    def strip_bdd_prefix(cls, token: Token) -> Token:
+        from robot.parsing.lexer import Token as RobotToken
+
+        bdd_match = cls.BDD_TOKEN_REGEX.match(token.value)
+        if bdd_match:
+            bdd_len = len(bdd_match.group(1))
+
+            token = RobotToken(
+                token.type,
+                token.value[bdd_len + 1 :],
+                token.lineno,
+                token.col_offset + bdd_len + 1,
+                token.error,
+            )
+        return token
+
+    @classmethod
+    def is_bdd_token(cls, token: Token) -> bool:
+        bdd_match = cls.BDD_TOKEN.match(token.value)
+        return bool(bdd_match)