Merge pull request #289 from getappmap/fix/config-packages-key-missin…

…g-value fix: crash due to config packages key with missing value
getappmap · Aug 21, 2024 · 34059ae · 34059ae
2 parents 011a645 + 26714d8
commit 34059ae
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/agent/src/main/java/com/appland/appmap/config/AppMapConfig.java b/agent/src/main/java/com/appland/appmap/config/AppMapConfig.java
@@ -131,9 +131,13 @@ static AppMapConfig load(Path configFile, boolean mustExist) {
     ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
     try {
       singleton = mapper.readValue(inputStream, AppMapConfig.class);
+      if (singleton.packages == null) {
+        logger.error("AppMap: missing value for the 'packages' entry in appmap.yml");
+        return null;
+      }
     } catch (IOException e) {
       logger.error("AppMap: encountered syntax error in appmap.yml {}", e.getMessage());
-      System.exit(1);
+      return null;
     }
     singleton.configFile = configFile;
     logger.debug("config: {}", singleton);

diff --git a/agent/src/test/java/com/appland/appmap/config/AppMapConfigTest.java b/agent/src/test/java/com/appland/appmap/config/AppMapConfigTest.java
@@ -100,6 +100,24 @@ public void hasAppmapDir() throws Exception {
         AppMapConfig.load(configFile, true);
         assertEquals("/appmap", AppMapConfig.get().getAppmapDir());
     }
+
+    @Test
+    public void loadPackagesKeyWithMissingValue() throws Exception {
+        Path configFile = tmpdir.resolve("appmap.yml");
+        final String contents = "name: test\npackages:\npath: xyz";
+        Files.write(configFile, contents.getBytes());
+        String actualErr = tapSystemErr(() -> AppMapConfig.load(configFile, false));
+        assertTrue(actualErr.contains("AppMap: missing value for the 'packages'"));
+    }
+
+    @Test
+    public void loadPackagesKeyWithScalarValue() throws Exception {
+        Path configFile = Files.createTempFile("appmap", ".yml");
+        final String contents = "name:q test\npackages: abc\n";
+        Files.write(configFile, contents.getBytes());
+        String actualErr = tapSystemErr(() -> AppMapConfig.load(configFile, false));
+        assertTrue(actualErr.contains("AppMap: encountered syntax error in appmap.yml"));
+    }
 }
 
 
diff --git a/agent/test/intellij/intellij.bats b/agent/test/intellij/intellij.bats
@@ -31,8 +31,7 @@ setup() {
 }
 
 @test 'it works' {
-  # TODO: remove this ideVersion pin
-  run ./gradlew -PideVersion=IC-2023.3.3 :plugin-core:test --tests 'AppMapConfigFileTest.readConfigWithPath'
+  run ./gradlew :plugin-core:test --tests 'AppMapConfigFileTest.readConfigWithPath'
   assert_success
 
   output="$(< tmp/appmap/junit/appland_config_AppMapConfigFileTest_readConfigWithPath.appmap.json)"