Feat/add comments

tested/dsl/ast_translator.py

@@ -27,7 +27,9 @@
 """
 
 import ast
+import tokenize
 from decimal import Decimal
+from io import BytesIO
 from typing import Literal, cast, overload
 
 from attrs import evolve
@@ -333,6 +335,24 @@
         return _convert_statement(statement_or_expression)
 
 
+def extract_comment(code: str) -> str:
+    """
+    Extract the comment from the code.
+
+    :param code: The code to extract the comment from.
+    :return: The comment if it exists, otherwise an empty string.
+    """
+    tokens = tokenize.tokenize(BytesIO(code.encode("utf-8")).readline)
+    comments = list(
+        map(lambda t: t.string, filter(lambda t: t.type == tokenize.COMMENT, tokens))
+    )
+    if len(comments) == 0:
+        return ""
+    comment = comments[0][1:]
+    assert isinstance(comment, str)
+    return comment.strip()
+
+
 @overload
 def parse_string(code: str, is_return: Literal[True]) -> Value: ...
 

tested/dsl/translate_parser.py

@@ -32,7 +32,7 @@
     resolve_to_basic,
 )
 from tested.dodona import ExtendedMessage
-from tested.dsl.ast_translator import InvalidDslError, parse_string
+from tested.dsl.ast_translator import InvalidDslError, extract_comment, parse_string
 from tested.parsing import get_converter, suite_to_json
 from tested.serialisation import (
     BooleanType,
@@ -567,6 +567,7 @@ def _convert_testcase(testcase: YamlDict, context: DslContext) -> Testcase:
     if "statement" in testcase and "return" in testcase:
         testcase["expression"] = testcase.pop("statement")
 
+    line_comment = ""
     _validate_testcase_combinations(testcase)
     if (expr_stmt := testcase.get("statement", testcase.get("expression"))) is not None:
         if isinstance(expr_stmt, dict) or context.language != "tested":
@@ -583,6 +584,7 @@ def _convert_testcase(testcase: YamlDict, context: DslContext) -> Testcase:
             the_input = LanguageLiterals(literals=the_dict, type=the_type)
         else:
             assert isinstance(expr_stmt, str)
+            line_comment = extract_comment(expr_stmt)
             the_input = parse_string(expr_stmt)
         return_channel = IgnoredChannel.IGNORED if "statement" in testcase else None
     else:
@@ -653,6 +655,7 @@ def _convert_testcase(testcase: YamlDict, context: DslContext) -> Testcase:
         input=the_input,
         output=output,
         link_files=context.files,
+        line_comment=line_comment,
     )
 
 

tested/languages/bash/config.py

@@ -38,6 +38,9 @@
     def file_extension(self) -> str:
         return "sh"
 
+    def comment(self, text: str) -> str:
+        return f"# {text}"
+
     def initial_dependencies(self) -> list[str]:
         return []
 

tested/languages/c/config.py

@@ -38,6 +38,9 @@
     def file_extension(self) -> str:
         return "c"
 
+    def comment(self, text: str) -> str:
+        return f"// {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {"global_identifier": "macro_case"}
 

tested/languages/csharp/config.py

@@ -41,6 +41,9 @@
     def file_extension(self) -> str:
         return "cs"
 
+    def comment(self, text: str) -> str:
+        return f"// {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {
             "namespace": "pascal_case",

tested/languages/generation.py

@@ -151,6 +151,9 @@
         text = case.input.get_for(bundle.config.programming_language)
         format_ = bundle.config.programming_language
 
+    if case.line_comment:
+        text = f"{text} {bundle.language.comment(case.line_comment)}"
+
     # If there are no files, return now. This means we don't need to do ugly stuff.
     if not case.link_files:
         return ExtendedMessage(description=text, format=format_), set()

tested/languages/haskell/config.py

@@ -37,6 +37,9 @@
     def file_extension(self) -> str:
         return "hs"
 
+    def comment(self, text: str) -> str:
+        return f"-- {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {
             "namespace": "pascal_case",

tested/languages/java/config.py

@@ -42,6 +42,9 @@
     def file_extension(self) -> str:
         return "java"
 
+    def comment(self, text: str) -> str:
+        return f"// {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {
             "namespace": "pascal_case",

tested/languages/javascript/config.py

@@ -43,6 +43,9 @@ def needs_selector(self):
     def file_extension(self) -> str:
         return "js"
 
+    def comment(self, text: str) -> str:
+        return f"// {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {
             "namespace": "camel_case",

tested/languages/kotlin/config.py

@@ -50,6 +50,9 @@
     def file_extension(self) -> str:
         return "kt"
 
+    def comment(self, text: str) -> str:
+        return f"// {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {
             "namespace": "pascal_case",

tested/languages/language.py

@@ -192,6 +192,16 @@
         """
         raise NotImplementedError
 
+    @abstractmethod
+    def comment(self, text: str) -> str:
+        """
+        Generate a comment for the given text.
+
+        :param text: The text to comment.
+        :return: The comment.
+        """
+        raise NotImplementedError
+
     def is_source_file(self, file: Path) -> bool:
         """
         Check if the given file could be a source file for this programming language.

tested/languages/python/config.py

@@ -51,6 +51,9 @@
     def file_extension(self) -> str:
         return "py"
 
+    def comment(self, text: str) -> str:
+        return f"# {text}"
+
     def naming_conventions(self) -> dict[Conventionable, NamingConventions]:
         return {"class": "pascal_case", "global_identifier": "macro_case"}
 

tested/testsuite.py

@@ -556,6 +556,7 @@ class Testcase(WithFeatures, WithFunctions):
     description: Message | None = None
     output: Output = field(factory=Output)
     link_files: list[FileUrl] = field(factory=list)
+    line_comment: str = ""
 
     def get_used_features(self) -> FeatureSet:
         return combine_features(