appmap 2.1.0__tar.gz → 2.1.1__tar.gz

{appmap-2.1.0 → appmap-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: appmap
-Version: 2.1.0
+Version: 2.1.1
 Summary: Create AppMap files by recording a Python application.
 Home-page: https://github.com/applandinc/appmap-python
 License: MIT

{appmap-2.1.0 → appmap-2.1.1}/_appmap/env.py

@@ -39,6 +39,8 @@ class Env(metaclass=SingletonMeta):
 
         self.log_file_creation_failed = False
         self._configure_logging()
+        # This uses _APPMAP, rather than APPMAP, to control whether instrumentation is enabled. The
+        # tests use this split to make it easier to control recording.
         enabled = self._env.get("_APPMAP", "false")
         self._enabled = enabled is None or enabled.lower() != "false"
 

{appmap-2.1.0 → appmap-2.1.1}/_appmap/event.py

@@ -94,7 +94,8 @@ def _describe_schema(name, val, depth, max_depth):
     if islist:
         elts = [(None, v) for v in val]
         schema_key = "items"
-    elif isdict:
+    else:
+        assert isdict
         elts = val.items()
         schema_key = "properties"
 
@@ -479,18 +480,19 @@ class HttpResponseEvent(ReturnEvent):
 
     def __init__(self, status_code, headers=None, **kwargs):
         super().__init__(**kwargs)
+        self.response = {}
+        self.update(status_code, headers)
 
-        response = {"status_code": status_code}
+    def update(self, status_code, headers):
+        if status_code is not None:
+            self.response.update({"status_code": status_code})
 
         if headers is not None:
-            response.update(
-                {
-                    "mime_type": headers.get("Content-Type"),
-                    "headers": none_if_empty(dict(headers)),
-                }
-            )
-
-        self.response = compact_dict(response)
+            if "Content-Type" in headers:
+                self.response.update({"mime_type": headers.get("Content-Type")})
+            updated_headers = dict(headers)
+            if len(updated_headers) > 0:
+                self.response.update({"headers": updated_headers})
 
 
 # pylint: disable=too-few-public-methods

{appmap-2.1.0 → appmap-2.1.1}/_appmap/importer.py

@@ -205,15 +205,17 @@ class Importer:
             for prop_name, (prop, prop_fns) in properties.items():
                 instrumented_fns = {}
                 for k, (fn, auxtype) in prop_fns.items():
-                    if fn is None:
+                    if fn is None or getattr(fn, "_appmap_wrapped", None):
                         continue
                     filterableFn = FilterableFn(filterable, fn, fn, auxtype)
                     new_fn = cls.instrument_function(fn.__name__, filterableFn, selected_functions)
                     if new_fn != fn:
                         new_fn = wrapt.FunctionWrapper(fn, new_fn)
+                        setattr(new_fn, "_appmap_wrapped", True)
                     instrumented_fns[k] = new_fn
-                instrumented_fns["doc"] = prop.__doc__
-                setattr(filterable.obj, prop_name, property(**instrumented_fns))
+                if len(instrumented_fns) > 0:
+                    instrumented_fns["doc"] = prop.__doc__
+                    setattr(filterable.obj, prop_name, property(**instrumented_fns))
 
         # Import Config here, to avoid circular top-level imports.
         from .configuration import Config  # pylint: disable=import-outside-toplevel

{appmap-2.1.0 → appmap-2.1.1}/_appmap/recorder.py

@@ -114,7 +114,8 @@ class Recorder(ABC):
     def check_time(cls, event_time):
         if _MAX_TIME is None:
             return
-        if event_time - cls.get_current()._start_time > _MAX_TIME:
+        delta = event_time - cls.get_current()._start_time  # pylint: disable=protected-access
+        if delta > _MAX_TIME:
             raise AppMapSessionTooLong(f"Session exceeded {_MAX_TIME} seconds")
 
     @classmethod

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/conftest.py

@@ -2,7 +2,7 @@ import importlib
 import os
 import socket
 import sys
-from distutils.dir_util import copy_tree
+from shutil import copytree
 from functools import partial, partialmethod
 from pathlib import Path
 from typing import Any
@@ -14,7 +14,7 @@ from xprocess import ProcessStarter
 
 import _appmap
 import appmap
-from _appmap.test.web_framework import TEST_HOST, TEST_PORT
+from _appmap.test.web_framework import TEST_HOST
 from appmap import generation
 
 from .. import utils
@@ -98,7 +98,7 @@ def git_directory_fixture(tmp_path_factory):
 
 @pytest.fixture(name="git")
 def tmp_git(git_directory, tmp_path):
-    copy_tree(git_directory, str(tmp_path))
+    copytree(git_directory, str(tmp_path), dirs_exist_ok=True)
     return utils.git(cwd=tmp_path)
 
 
@@ -198,14 +198,55 @@ def server_starter(info, name, cmd, pattern, env=None):
 
     return _starter
 
+@pytest.fixture(name="server_port")
+def server_port_fixture(worker_id):
+    if worker_id == "master":
+        offset = "0"
+    else:
+        offset = worker_id[2:]
+    return 8000 + int(offset)
+
 
 @pytest.fixture(name="server_base")
-def server_base_fixture(request):
+def server_base_fixture(request, server_port):
     marker = request.node.get_closest_marker("server")
     debug = marker.kwargs.get("debug", False)
     server_env = os.environ.copy()
     server_env.update(marker.kwargs.get("env", {}))
 
-    info = ServerInfo(debug=debug, host=TEST_HOST, port=TEST_PORT, env=server_env)
+    info = ServerInfo(debug=debug, host=TEST_HOST, port=server_port, env=server_env)
     info.factory = partial(server_starter, info)
     return info
+
+@pytest.fixture(name="testdir")
+def testdir_fixture(request, data_dir, pytester, monkeypatch):
+    # We need to set environment variables to control how tests are run. This will only work
+    # properly if pytester runs pytest in a subprocess.
+    assert (
+        pytester._method == "subprocess"  # pylint:disable=protected-access
+    ), "must run pytest in a subprocess"
+
+    # The init subdirectory contains a sitecustomize.py file that
+    # imports the appmap module. This simulates the way a real
+    # installation works, performing the same function as the the
+    # appmap.pth file that gets put in site-packages.
+    monkeypatch.setenv("PYTHONPATH", "init")
+
+    # Make sure _APPMAP isn't in the environment, to test that recording-by-default is working as
+    # expected. Individual test cases may set it as necessary.
+    monkeypatch.delenv("_APPMAP", raising=False)
+
+    marker = request.node.get_closest_marker("example_dir")
+    test_type = "unittest" if marker is None else marker.args[0]
+    pytester.copy_example(test_type)
+
+    pytester.expected = data_dir / test_type / "expected"
+    pytester.test_type = test_type
+
+    # this is so test_type can be overriden in test cases
+    def output_dir():
+        return pytester.path / "tmp" / "appmap" / pytester.test_type
+
+    pytester.output = output_dir
+
+    return pytester

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/data/flask/flaskapp.py

@@ -6,8 +6,9 @@ testing of record-by-default.
 """
 # pylint: disable=missing-function-docstring
 
-from flask import Flask, make_response
+from flask import Flask, make_response, request
 from markupsafe import escape
+import werkzeug
 
 app = Flask(__name__)
 
@@ -50,3 +51,13 @@ def show_org_user_posts(org, username):
 @app.route("/exception")
 def raise_exception():
     raise Exception("An exception")
+
+@app.post("/do_post")
+def do_post():
+    _ = request.get_json()
+    return "Got post request"
+
+
+@app.errorhandler(werkzeug.exceptions.BadRequest)
+def handle_bad_request(e):
+    return "That's a bad request!", 400

appmap-2.1.1/_appmap/test/data/flask/test_app.py

@@ -0,0 +1,26 @@
+import pytest
+from flaskapp import app
+
+
+@pytest.fixture(name="client")
+def test_client():
+    with app.test_client() as c:  # pylint: disable=no-member
+        yield c
+
+
+def test_request(client):
+    response = client.get("/")
+
+    assert response.status_code == 200
+
+def test_not_found(client):
+    response = client.get("/not_found")
+
+    assert response.status_code == 404
+
+
+def test_errorhandler(client):
+    response = client.post("/do_post", content_type="application/json")
+
+    assert response.status_code == 400
+    assert response.text == "That's a bad request!"

appmap-2.1.1/_appmap/test/data/flask-instrumented/appmap.yml

@@ -0,0 +1,4 @@
+name: FlaskTest
+packages:
+- path: flaskapp
+- path: flask

appmap-2.1.1/_appmap/test/data/flask-instrumented/flaskapp.py

@@ -0,0 +1,30 @@
+"""
+Rudimentary Flask application for testing.
+"""
+# pylint: disable=missing-function-docstring
+
+import werkzeug
+from appmap.flask import AppmapFlask
+from flask import Flask, request
+
+app = Flask(__name__)
+AppmapFlask(app).init_app()
+
+
+@app.route("/")
+def hello_world():
+    return "Hello, World!"
+
+@app.route("/exception")
+def raise_exception():
+    raise Exception("An exception")
+
+@app.post("/do_post")
+def do_post():
+    _ = request.get_json()
+    return "Got post request"
+
+
+@app.errorhandler(werkzeug.exceptions.BadRequest)
+def handle_bad_request(e):
+    return "That's a bad request!", 400

appmap-2.1.1/_appmap/test/data/flask-instrumented/test_app.py

@@ -0,0 +1,31 @@
+import pytest
+from flaskapp import app
+
+
+@pytest.fixture(name="client")
+def test_client():
+    with app.test_client() as c:  # pylint: disable=no-member
+        yield c
+
+
+def test_request(client):
+    response = client.get("/")
+
+    assert response.status_code == 200
+
+def test_exception(client):
+    response = client.get("/exception")
+
+    assert response.status_code == 500
+
+def test_not_found(client):
+    response = client.get("/not_found")
+
+    assert response.status_code == 404
+
+
+def test_errorhandler(client):
+    response = client.post("/do_post", content_type="application/json")
+
+    assert response.status_code == 400
+    assert response.text == "That's a bad request!"

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/helpers.py

@@ -1,6 +1,11 @@
 """Test helpers"""
 
 
+import importlib.metadata
+
+from packaging import version as pkg_version
+
+
 class DictIncluding(dict):
     """A dict that on comparison just checks whether the other dict includes
     all of its items. Any extra ones are ignored.
@@ -26,3 +31,20 @@ class HeadersIncluding(dict):
             if v is None:
                 return False
         return True
+
+
+def package_version(pkg):
+    return pkg_version.parse(importlib.metadata.version(pkg))
+
+
+def check_call_stack(events):
+    """Ensure that the call stack in events has balanced call and return events"""
+    stack = []
+    for e in events:
+        if e.get("event") == "call":
+            stack.append(e)
+        elif e.get("event") == "return":
+            assert len(stack) > 0, "return without call"
+            call = stack.pop()
+            assert call.get("id") == e.get("parent_id")
+    assert len(stack) == 0, "leftover events"

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_command.py

@@ -1,6 +1,6 @@
 import json
 import re
-from distutils.dir_util import copy_tree
+from shutil import copytree
 from importlib.metadata import version
 
 import pytest
@@ -14,7 +14,7 @@ from .helpers import DictIncluding
 @pytest.fixture(name="_cmd_setup")
 def _cmd_setup(request, git, data_dir, monkeypatch):
     repo_root = git.cwd
-    copy_tree(data_dir / request.param, str(repo_root))
+    copytree(data_dir / request.param, str(repo_root), dirs_exist_ok=True)
     monkeypatch.chdir(repo_root)
 
     # pylint: disable=protected-access

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_configuration.py

@@ -2,7 +2,7 @@
 # pylint: disable=missing-function-docstring
 
 from contextlib import contextmanager
-from distutils.dir_util import copy_tree
+from shutil import copytree
 from pathlib import Path
 from textwrap import dedent
 
@@ -154,7 +154,7 @@ class DefaultHelpers:
 class TestDefaultConfig(DefaultHelpers):
     def test_created(self, git, data_dir, monkeypatch):
         repo_root = git.cwd
-        copy_tree(data_dir / "config", str(repo_root))
+        copytree(data_dir / "config", str(repo_root), dirs_exist_ok=True)
         monkeypatch.chdir(repo_root)
 
         # pylint: disable=protected-access
@@ -163,7 +163,7 @@ class TestDefaultConfig(DefaultHelpers):
         self.check_default_config(repo_root.name)
 
     def test_created_outside_repo(self, data_dir, tmpdir, monkeypatch):
-        copy_tree(data_dir / "config", str(tmpdir))
+        copytree(data_dir / "config", str(tmpdir), dirs_exist_ok=True)
         monkeypatch.chdir(tmpdir)
 
         # pylint: disable=protected-access
@@ -180,7 +180,7 @@ class TestDefaultConfig(DefaultHelpers):
         assert not appmap.enabled()
 
     def test_exclusions(self, data_dir, tmpdir, mocker, monkeypatch):
-        copy_tree(data_dir / "config-exclude", str(tmpdir))
+        copytree(data_dir / "config-exclude", str(tmpdir), dirs_exist_ok=True)
         monkeypatch.chdir(tmpdir)
         mocker.patch(
             "_appmap.configuration._get_sys_prefix",
@@ -193,7 +193,7 @@ class TestDefaultConfig(DefaultHelpers):
 
     def test_created_if_missing_and_enabled(self, git, data_dir, monkeypatch, tmpdir):
         repo_root = git.cwd
-        copy_tree(data_dir / "config", str(repo_root))
+        copytree(data_dir / "config", str(repo_root), dirs_exist_ok=True)
         monkeypatch.chdir(repo_root)
 
         path = Path(repo_root / "appmap.yml")
@@ -213,7 +213,7 @@ class TestDefaultConfig(DefaultHelpers):
 
     def test_not_created_if_missing_and_not_enabled(self, git, data_dir, monkeypatch):
         repo_root = git.cwd
-        copy_tree(data_dir / "config", str(repo_root))
+        copytree(data_dir / "config", str(repo_root), dirs_exist_ok=True)
         monkeypatch.chdir(repo_root)
 
         path = Path(repo_root / "appmap.yml")
@@ -229,7 +229,7 @@ class TestDefaultConfig(DefaultHelpers):
 class TestEmpty(DefaultHelpers):
     @pytest.fixture(autouse=True)
     def setup_config(self, data_dir, monkeypatch, tmpdir):
-        copy_tree(data_dir / "config", str(tmpdir))
+        copytree(data_dir / "config", str(tmpdir), dirs_exist_ok=True)
         monkeypatch.chdir(tmpdir)
 
     @contextmanager
@@ -269,7 +269,7 @@ class TestSearchConfig:
     # pylint: disable=too-many-arguments
 
     def test_config_in_parent_folder(self, data_dir, tmpdir, monkeypatch):
-        copy_tree(data_dir / "config-up", str(tmpdir))
+        copytree(data_dir / "config-up", str(tmpdir), dirs_exist_ok=True)
         wd = tmpdir / "project" / "p1"
         monkeypatch.chdir(wd)
 
@@ -279,8 +279,8 @@ class TestSearchConfig:
         assert str(Env.current.output_dir).endswith(str(tmpdir / "tmp" / "appmap"))
 
     def _init_repo(self, data_dir, tmpdir, git_directory, repo_root, appmapdir):
-        copy_tree(data_dir / "config-up", str(tmpdir))
-        copy_tree(git_directory, str(repo_root))
+        copytree(data_dir / "config-up", str(tmpdir), dirs_exist_ok=True)
+        copytree(git_directory, str(repo_root), dirs_exist_ok=True)
         with open(appmapdir / "appmap.yml", "w+", encoding="utf-8") as f:
             f.writelines(
                 dedent("""
@@ -325,7 +325,7 @@ class TestSearchConfig:
         assert Env.current.enabled
 
     def test_config_not_found_in_path_hierarchy(self, data_dir, tmpdir, monkeypatch):
-        copy_tree(data_dir / "config-up", str(tmpdir))
+        copytree(data_dir / "config-up", str(tmpdir), dirs_exist_ok=True)
         wd = tmpdir / "project" / "p1"
         monkeypatch.chdir(wd)
 

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_django.py

@@ -171,9 +171,6 @@ def test_exception(client, events, monkeypatch):
 
     assert events[1].event == "return"
     assert events[1].parent_id == events[0].id
-    assert events[1].exceptions == [
-        DictIncluding({"class": "builtins.RuntimeError", "message": "An error"})
-    ]
 
 
 @pytest.mark.appmap_enabled(env={"APPMAP_RECORD_REQUESTS": "false"})

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_django_simplelazyobject.py

@@ -16,7 +16,8 @@ def test_recording_simplelazyobject_does_not_evaluate():
     doesn't cause incorrect premature evaluation.
     """
     with appmap.Recording():
-        import appmap_testing.django_simplelazyobject as ecds  # pylint: disable=import-outside-toplevel
+        import appmap_testing.django_simplelazyobject as ecds  # pylint: disable=import-outside-toplevel, import-error
+
         ecds.lazy()
 
     # if we're here and the exception wasn't thrown, we're good

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_events.py

@@ -45,7 +45,7 @@ class TestEvents:
     def test_recursion_protection(self):
         r = appmap.Recording()
         with r:
-            from example_class import ExampleClass
+            from example_class import ExampleClass  # pylint: disable=import-outside-toplevel
 
             ExampleClass().instance_method()
 
@@ -56,7 +56,7 @@ class TestEvents:
     def test_when_str_raises(self, mocker):
         r = appmap.Recording()
         with r:
-            from example_class import ExampleClass
+            from example_class import ExampleClass  # pylint: disable=import-outside-toplevel
 
             param = mocker.Mock()
             param.__str__ = mocker.Mock(side_effect=Exception)
@@ -72,7 +72,7 @@ class TestEvents:
     def test_when_both_raise(self, mocker):
         r = appmap.Recording()
         with r:
-            from example_class import ExampleClass
+            from example_class import ExampleClass  # pylint: disable=import-outside-toplevel
 
             param = mocker.Mock()
             param.__str__ = mocker.Mock(side_effect=Exception)
@@ -88,7 +88,7 @@ class TestEvents:
         Env.current.set("APPMAP_DISPLAY_PARAMS", "false")
         r = appmap.Recording()
         with r:
-            from example_class import ExampleClass
+            from example_class import ExampleClass  # pylint: disable=import-outside-toplevel
 
             param = mocker.MagicMock()
 

{appmap-2.1.0 → appmap-2.1.1}/_appmap/test/test_fastapi.py

@@ -24,6 +24,10 @@ class TestRecordRequests(_TestRecordRequests):
 
 @pytest.mark.app(remote_enabled=True)
 class TestRemoteRecording(_TestRemoteRecording):
+    def __init__(self):
+        self.expected_thread_id = None
+        self.expected_content_type = None
+
     def setup_method(self):
         self.expected_thread_id = 1
         self.expected_content_type = "application/json"
@@ -39,7 +43,7 @@ def fastapi_app(data_dir, monkeypatch, request):
 
     Env.current.set("APPMAP_CONFIG", data_dir / "fastapi" / "appmap.yml")
 
-    from fastapiapp import main  # pyright: ignore[reportMissingImports]
+    from fastapiapp import main  # pyright: ignore[reportMissingImports] pylint: disable=import-error,import-outside-toplevel
 
     importlib.reload(main)