feat: add process recording

Author: apotterri

_appmap/__init__.py

@@ -1,6 +1,6 @@
 from . import configuration
 from . import env as appmapenv
-from . import event, importer, metadata, recorder, web_framework
+from . import event, importer, metadata, recorder, recording, web_framework
 from .py_version_check import check_py_version
 
 
@@ -13,6 +13,7 @@ def initialize(**kwargs):
     configuration.initialize()  # needs to be initialized after recorder
     metadata.initialize()
     web_framework.initialize()
+    recording.initialize()
 
 
 initialize()

_appmap/recording.py

@@ -1,3 +1,11 @@
+import atexit
+import datetime
+import os
+from tempfile import NamedTemporaryFile
+
+from _appmap import generation
+from _appmap.web_framework import APPMAP_SUFFIX, HASH_LEN, NAME_MAX, name_hash
+
 from .env import Env
 from .recorder import Recorder
 
@@ -68,3 +76,25 @@ def write_appmap(
     appmap_file = basedir / filename
     logger.info("info, writing %s", appmap_file)
     os.replace(tmp.name, appmap_file)
+
+
+def initialize():
+    if Env.current.enables("process", "false"):
+        r = Recording()
+        r.start()
+
+        def save_at_exit():
+            nonlocal r
+            r.stop()
+            appmap_name = datetime.utcnow().isoformat(timespec='seconds') + "Z"
+            recorder_type = "process"
+            metadata = {
+                "name": appmap_name,
+                "recorder": {
+                    "name": "process",
+                    "type": recorder_type,
+                }
+            }
+            write_appmap(r, appmap_name, recorder_type, metadata)
+
+        atexit.register(save_at_exit)

_appmap/test/data/package1/package2/__main__.py

@@ -0,0 +1,9 @@
+import sys
+
+from .mod1 import Mod1Class
+
+def main():
+    print(Mod1Class().func())
+    return 0
+
+sys.exit(main())

_appmap/test/test_recording.py

@@ -3,6 +3,8 @@
 
 import json
 import os
+from distutils.dir_util import copy_tree
+from distutils.file_util import copy_file
 from threading import Thread
 
 import pytest
@@ -168,9 +170,7 @@ def add_event(name):
             r.add_event(Event({"name": name}))
             recorders[name] = r
 
-        threads = [
-            Thread(target=add_event, args=(f"thread{i}",)) for i in range(thread_count)
-        ]
+        threads = [Thread(target=add_event, args=(f"thread{i}",)) for i in range(thread_count)]
         for _, t in enumerate(threads):
             t.start()
         for _, t in enumerate(threads):
@@ -188,3 +188,27 @@ def add_event(name):
             events = recorders[f"thread{n}"].events
             assert len(events) == 1
             assert events[0].event["name"] == f"thread{n}"
+
+
+def test_process_recording(data_dir, shell, tmp_path):
+    fixture = data_dir / "package1"
+    tmp = tmp_path / "process"
+    copy_tree(fixture, str(tmp / "package1"))
+    copy_file(data_dir / "appmap.yml", str(tmp))
+    copy_tree(data_dir / "flask" / "init", str(tmp / "init"))
+
+    ret = shell.run(
+        "python",
+        "-m",
+        "package1.package2",
+        env={"PYTHONPATH": "init", "APPMAP_RECORD_PROCESS": "true"},
+        cwd=tmp,
+    )
+    assert ret.returncode == 0
+
+    appmap_dir = tmp / "tmp" / "appmap" / "process"
+    appmap_files = list(appmap_dir.glob("*.appmap.json"))
+    assert len(appmap_files) == 1
+    actual = json.loads(appmap_files[0].read_text())
+    assert len(actual["events"]) > 0
+    assert len(actual["classMap"]) > 0

pyproject.toml

@@ -80,6 +80,7 @@ python-decouple = "^3.5"
 black = "^22.8.0"
 isort = "^5.10.1"
 pylint = "^2.16.2"
+pytest-shell-utilities = "^1.8.0"
 
 [build-system]
 requires = ["poetry-core>=1.1.0"]