Merge pull request #65 from behave-contrib/james.westfall/fix_decorator_asterix

fallwest · web-flow · commit 19667422f875 · 2025-01-02T13:16:16.000+01:00
Handle decorators correctly
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,26 +6,27 @@
     "configurations": [
         {
             "name": "Python: Current File",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "program": "${file}",
             "console": "integratedTerminal",
             "justMyCode": true
         },
         {
             "name": "Python: Behave",
-            "type": "python",
+            "type": "debugpy",
             "justMyCode": true,
             "request": "launch",
             "module": "behave",
             "cwd" : "${workspaceFolder}/public/",
             "args": [
-                // "-d",
-                // "-f",
-                // "json",
                 "-i",
                 "${relativeFile}",
-                // "-D continue_after_failed_step"
+                "-f=json",
+                "-o=script/reports/feature.json",
+                "--no-summary",
+                "--no-snippets",
+                "-D", "continue_after_failed_step"
             ]
         }
     ]
diff --git a/script/genrep.py b/script/genrep.py
@@ -0,0 +1,65 @@
+"""
+    Prototyping area for Python code run in Pyodide
+"""
+import ast
+import json
+
+def get_json_step_report():
+    with open("script/reports/feature.json", "r", encoding="utf-8") as file:
+        data = file.read()
+    return json.loads(data)
+
+def get_step_locations():
+    report = get_json_step_report()
+    locations = []
+    if len(report) > 0:
+        for element in report[0]["elements"]:
+            for step in element["steps"]:
+                if "match" in step:
+                    locations.append(step["match"]["location"])
+    return locations
+
+def get_function_source(filename, step_decorator):
+    with open(filename, encoding="utf-8") as file:
+        file_contents = file.read()
+    node = None
+    try:
+        node = ast.parse(file_contents, "file", "exec")
+    except:  # pylint: disable=W0702
+        pass
+    if node:
+        for body in node.body:
+            if isinstance(body, ast.FunctionDef):
+                step_text = None
+                try:
+                    step_text = body.decorator_list[0].args[0].value
+                except:  # pylint: disable=W0702
+                    pass
+                if step_text and step_text in step_decorator:
+                    source_snippet = ""
+                    for decorator in body.decorator_list:
+                        source_snippet += "@"
+                        source_snippet += ast.get_source_segment(file_contents, decorator)
+                        source_snippet += "\\n"
+                    source_snippet += ast.get_source_segment(file_contents, body)
+                    return source_snippet
+
+def get_snippets():
+    locations = get_step_locations()
+    snippets = []
+    for location in locations:
+        parts = location.split(":")
+        filename = parts[0]
+        line_no = parts[1]
+        with open(filename, "r", encoding="utf-8") as source_file:
+            file_lines = source_file.readlines()
+        step_decorator = file_lines[int(line_no) -1:int(line_no)][0]
+        function_source = get_function_source(filename, step_decorator)
+        existing_records = [rec for rec in snippets if rec["location"]==location and rec["file_lines"]==function_source]
+        if len(existing_records) == 0:
+            snippets.append({"location": location, "file_lines": function_source})
+    return snippets
+
+code_snippets = get_snippets()
+global snippet_json  # pylint: disable=W0604
+snippet_json = json.dumps(code_snippets)
diff --git a/script/reports/feature.json b/script/reports/feature.json
@@ -0,0 +1,63 @@
+[
+    {
+        "keyword": "Feature",
+        "name": "showing off behave",
+        "tags": [],
+        "location": "public/features/tutorial.feature:6",
+        "status": "passed",
+        "elements": [
+            {
+                "type": "scenario",
+                "keyword": "Scenario",
+                "name": "run a simple test",
+                "tags": [],
+                "location": "public/features/tutorial.feature:8",
+                "steps": [
+                    {
+                        "keyword": "Given",
+                        "step_type": "given",
+                        "name": "we have behave installed",
+                        "location": "public/features/tutorial.feature:9",
+                        "match": {
+                            "location": "public/features/steps/tutorial.py:11",
+                            "arguments": []
+                        },
+                        "result": {
+                            "status": "passed",
+                            "duration": 9.202957153320312e-05
+                        }
+                    },
+                    {
+                        "keyword": "When",
+                        "step_type": "when",
+                        "name": "we implement a test",
+                        "location": "public/features/tutorial.feature:10",
+                        "match": {
+                            "location": "public/features/steps/tutorial.py:15",
+                            "arguments": []
+                        },
+                        "result": {
+                            "status": "passed",
+                            "duration": 5.936622619628906e-05
+                        }
+                    },
+                    {
+                        "keyword": "Then",
+                        "step_type": "then",
+                        "name": "behave will test it for us!",
+                        "location": "public/features/tutorial.feature:11",
+                        "match": {
+                            "location": "public/features/steps/tutorial.py:19",
+                            "arguments": []
+                        },
+                        "result": {
+                            "status": "passed",
+                            "duration": 5.53131103515625e-05
+                        }
+                    }
+                ],
+                "status": "passed"
+            }
+        ]
+    }
+]
diff --git a/src/components/FeatureHolder.js b/src/components/FeatureHolder.js
@@ -69,15 +69,6 @@ class FeatureHolder extends Component {
         });
     }
 
-    fixKeywords(msg) {
-        const keywords = ["and", "but", "given", "step", "then", "when"];
-        for (const kw in keywords) {
-            let curr_kw = keywords[kw];
-            msg = msg.replaceAll(`${curr_kw}(`, `@${curr_kw}(`);
-        }
-        return msg;
-    }
-
     init() {
         this.worker = new Worker(workerUrl);
         this.terminal.current.clearStdout();
@@ -96,8 +87,7 @@ class FeatureHolder extends Component {
                 }
             }
             if (e.data.type === "snippet") {
-                const msg = this.fixKeywords(e.data.msg);
-                const snippets = JSON.parse(msg);
+                const snippets = JSON.parse(e.data.msg);
                 this.setState({ snippets: snippets })
                 this.setState({ ready: true })
                 this.setState({ showSpinner: false })
diff --git a/src/ws.worker.js b/src/ws.worker.js
@@ -32,15 +32,15 @@ const getFeatureJson = (feature) => {
     import json
 
     def get_json_step_report():
-        with open("reports/feature.json", "r") as file:
+        with open("reports/feature.json", "r", encoding="utf-8") as file:
             data = file.read()
         return json.loads(data)
 
     def get_step_locations():
         report = get_json_step_report()
         locations = []
         if len(report) > 0:
-            for element in report[0]["elements"]: 
+            for element in report[0]["elements"]:
                 for step in element["steps"]:
                     if "match" in step:
                         locations.append(step["match"]["location"])
@@ -56,15 +56,16 @@ const getFeatureJson = (feature) => {
             pass
         if node:
             for body in node.body:
-                if type(body) == ast.FunctionDef:
+                if isinstance(body, ast.FunctionDef):
                     step_text = None
                     try:
                         step_text = body.decorator_list[0].args[0].value
-                    except Exception:
+                    except:
                         pass
                     if step_text and step_text in step_decorator:
                         source_snippet = ""
                         for decorator in body.decorator_list:
+                            source_snippet += "@"
                             source_snippet += ast.get_source_segment(file_contents, decorator)
                             source_snippet += "\\n"
                         source_snippet += ast.get_source_segment(file_contents, body)
@@ -77,7 +78,7 @@ const getFeatureJson = (feature) => {
             parts = location.split(":")
             filename = parts[0]
             line_no = parts[1]
-            with open(filename, "r") as source_file:
+            with open(filename, "r", encoding="utf-8") as source_file:
                 file_lines = source_file.readlines()
             step_decorator = file_lines[int(line_no) -1:int(line_no)][0]
             function_source = get_function_source(filename, step_decorator)
@@ -86,9 +87,9 @@ const getFeatureJson = (feature) => {
                 snippets.append({"location": location, "file_lines": function_source})
         return snippets
 
-    snippets = get_snippets()
+    code_snippets = get_snippets()
     global snippet_json
-    snippet_json = json.dumps(snippets)
+    snippet_json = json.dumps(code_snippets)
     `, {});
     const snippet_json = self.pyodide.globals.get("snippet_json");
     return snippet_json;
