Merge pull request #184 from getappmap/default-config_20221020

fix: use default values when config is incomplete

Author: apotterri

appmap.pth

@@ -1 +1,2 @@
-import appmap
+# The python runtime suppresses errors from import, but we should fail if something goes wrong. 
+try: import appmap; except Exception: raise

appmap/_implementation/configuration.py

@@ -173,11 +173,17 @@ def labels(self):
 
     @property
     def default(self):
+        return {"name": self.default_name, "packages": self.default_packages}
+
+    @property
+    def default_name(self):
+        root_dir = Env.current.root_dir
+        return default_app_name(root_dir)
+
+    @property
+    def default_packages(self):
         root_dir = Env.current.root_dir
-        return {
-            "name": default_app_name(root_dir),
-            "packages": [{"path": p} for p in find_top_packages(root_dir)],
-        }
+        return [{"path": p} for p in find_top_packages(root_dir)]
 
     def _load_config(self):
         self._config = {"name": None, "packages": []}
@@ -199,6 +205,15 @@ def _load_config(self):
             self.file_valid = False
             try:
                 self._config = yaml.safe_load(path.read_text())
+                if not self._config:
+                    # It parsed, but was (effectively) empty.
+                    self._config = self.default
+                else:
+                    # It parsed, make sure it has name and packages set.
+                    if not self._config.get("name", None):
+                        self._config["name"] = self.default_name
+                    if not self._config.get("packages", None):
+                        self._config["packages"] = self.default_packages
                 self.file_valid = True
                 Env.current.enabled = should_enable
             except ParserError:

appmap/test/test_configuration.py

@@ -1,6 +1,7 @@
 """Test Configuration"""
 # pylint: disable=missing-function-docstring
 
+from contextlib import contextmanager
 from distutils.dir_util import copy_tree
 from pathlib import Path
 
@@ -125,7 +126,7 @@ def test_class_prefix_doesnt_match(self):
         assert cf().filter(f) is False
 
 
-class TestDefaultConfig:
+class DefaultHelpers:
     def check_default_config(self, expected_name):
         assert appmap.enabled()
 
@@ -137,6 +138,8 @@ def check_default_config(self, expected_name):
             {"path": "test"},
         ]
 
+
+class TestDefaultConfig(DefaultHelpers):
     def test_created(self, git, data_dir, monkeypatch):
         repo_root = git.cwd
         copy_tree(data_dir / "config", str(repo_root))
@@ -205,3 +208,43 @@ def test_not_created_if_missing_and_not_enabled(self, git, data_dir, monkeypatch
 
         c = Config()
         assert not path.is_file()
+
+
+class TestEmpty(DefaultHelpers):
+    @pytest.fixture(autouse=True)
+    def setup_config(self, data_dir, monkeypatch, tmpdir):
+        copy_tree(data_dir / "config", str(tmpdir))
+        monkeypatch.chdir(tmpdir)
+
+    @contextmanager
+    def incomplete_config(self):
+        # pylint: disable=protected-access
+        with open("appmap-incomplete.yml", mode="w", buffering=1) as f:
+            print("# Incomplete file", file=f)
+            yield f
+
+    def test_empty(self, tmpdir):
+        with self.incomplete_config():
+            appmap._implementation.initialize(
+                cwd=tmpdir,
+                env={"APPMAP": "true", "APPMAP_CONFIG": "appmap-incomplete.yml"},
+            )
+            self.check_default_config(Path(tmpdir).name)
+
+    def test_missing_name(self, tmpdir):
+        with self.incomplete_config() as f:
+            print('packages: [{"path": "package"}, {"path": "test"}]', file=f)
+            appmap._implementation.initialize(
+                cwd=tmpdir,
+                env={"APPMAP": "true", "APPMAP_CONFIG": "appmap-incomplete.yml"},
+            )
+            self.check_default_config(Path(tmpdir).name)
+
+    def test_missing_packages(self, tmpdir):
+        with self.incomplete_config() as f:
+            print(f"name: {Path(tmpdir).name}", file=f)
+            appmap._implementation.initialize(
+                cwd=tmpdir,
+                env={"APPMAP": "true", "APPMAP_CONFIG": "appmap-incomplete.yml"},
+            )
+            self.check_default_config(Path(tmpdir).name)

ci/run_tests.sh

@@ -1,8 +1,9 @@
 #!/usr/bin/env bash
 
 set -x
-docker run -i --rm\
+t=$([ -t 0 ] && echo 't')
+docker run -i${t} --rm\
   -v $PWD/dist:/dist -v $PWD/appmap/test/data/unittest:/appmap/test/data/unittest\
   -v $PWD/ci:/ci\
   -w /tmp\
-  python:3.9 bash -ce '/ci/smoketest.sh; /ci/test_pipenv.sh'
+  python:3.9 bash -ce "${@:-/ci/smoketest.sh; /ci/test_pipenv.sh}"