Protects documentation service against potential null pointer excepti…

…on (#383)
jenkins-infra · Oct 12, 2023 · 639d92f · 639d92f
1 parent b65ffa6
commit 639d92f
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 3 deletions.
diff --git a/war/src/main/java/io/jenkins/pluginhealth/scoring/service/PluginDocumentationService.java b/war/src/main/java/io/jenkins/pluginhealth/scoring/service/PluginDocumentationService.java
@@ -52,11 +52,15 @@ public PluginDocumentationService(ObjectMapper objectMapper, ApplicationConfigur
 
     public Map<String, String> fetchPluginDocumentationUrl() {
         try {
-            final Map<String, Link> foo = objectMapper.readValue(new URL(configuration.jenkins().documentationUrls()), new TypeReference<>() {});
-            return foo.entrySet().stream()
+            final Map<String, Link> documentationUrlsMap = objectMapper.readValue(
+                new URL(configuration.jenkins().documentationUrls()),
+                  new TypeReference<>() {
+                  }
+            );
+            return documentationUrlsMap.entrySet().stream()
                 .collect(Collectors.toMap(
                     Map.Entry::getKey,
-                    e -> e.getValue().url()
+                    e -> e.getValue() == null || e.getValue().url() == null ? "" : e.getValue().url()
                 ));
         } catch (MalformedURLException e) {
             LOGGER.error("URL to documentation link is incorrect.", e);

diff --git a/...src/test/java/io/jenkins/pluginhealth/scoring/service/PluginDocumentationServiceTest.java b/...src/test/java/io/jenkins/pluginhealth/scoring/service/PluginDocumentationServiceTest.java
@@ -59,6 +59,24 @@ void shouldBeAbleToParseAvailableFile() {
             .contains(entry("bar", "https://github.com/jenkinsci/bar-plugin"));
     }
 
+    @Test
+    void shouldBeAbleToParseFileWithNullValue() {
+        final URL url = PluginDocumentationService.class.getResource("/documentation-urls/plugin-documentation-urls-with-nulls.json");
+        assertThat(url).isNotNull();
+
+        final ApplicationConfiguration config = new ApplicationConfiguration(
+            new ApplicationConfiguration.Jenkins("foo", url.toString()),
+            new ApplicationConfiguration.GitHub("foo", null, "bar")
+        );
+
+        final PluginDocumentationService service = new PluginDocumentationService(objectMapper, config);
+        final Map<String, String> map = service.fetchPluginDocumentationUrl();
+
+        assertThat(map)
+            .contains(entry("foo", "https://wiki.jenkins-ci.org/display/JENKINS/foo+plugin"))
+            .contains(entry("bar", "https://github.com/jenkinsci/bar-plugin"));
+    }
+
     @Test
     void shouldSurviveIncorrectlyConfiguredDocumentationURL() {
         final ApplicationConfiguration config = new ApplicationConfiguration(

diff --git a/war/src/test/resources/documentation-urls/plugin-documentation-urls-with-nulls.json b/war/src/test/resources/documentation-urls/plugin-documentation-urls-with-nulls.json
@@ -0,0 +1,10 @@
+{
+  "foo": {
+    "url": "https://wiki.jenkins-ci.org/display/JENKINS/foo+plugin"
+  },
+  "bar": {
+    "url": "https://github.com/jenkinsci/bar-plugin"
+  },
+  "test": {
+  }
+}