Number of open issue probe

core/src/main/java/io/jenkins/pluginhealth/scoring/model/updatecenter/Plugin.java

@@ -31,8 +31,31 @@
 
 public record Plugin(String name, VersionNumber version, String scm,
                      ZonedDateTime releaseTimestamp, List<String> labels,
-                     int popularity, String requiredCore, String defaultBranch) {
+                     int popularity, String requiredCore, String defaultBranch, List<IssueTrackers> issueTrackers) {
+
+    /* This builder function is used in test cases when List<IssueTrackers> is not required as a mandatory parameter. */
+    public static Plugin of(String name, VersionNumber version, String scm,
+                            ZonedDateTime releaseTimestamp, List<String> labels,
+                            int popularity, String requiredCore, String defaultBranch) {
+        return new Plugin(name, version, scm, releaseTimestamp,
+            labels, popularity, requiredCore, defaultBranch, List.of());
+    }
+
     public io.jenkins.pluginhealth.scoring.model.Plugin toPlugin() {
         return new io.jenkins.pluginhealth.scoring.model.Plugin(this.name(), this.version(), this.scm(), this.releaseTimestamp());
     }
+
+    public List<IssueTrackers> getIssueTrackers() {
+        return this.issueTrackers;
+    }
+
+    /**
+     * Gets issue tracker details about a plugin.
+     *
+     * @param type      The type of platform used to track issues. For ex: GitHub, JIRA
+     * @param reportUrl An url to report issues about the plugin
+     * @param viewUrl   An url to view all the issues in the plugin
+     */
+    public record IssueTrackers(String type, String viewUrl, String reportUrl) {
+    }
 }

core/src/main/java/io/jenkins/pluginhealth/scoring/probes/AbstractOpenIssuesProbe.java

@@ -0,0 +1,49 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Jenkins Infra
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package io.jenkins.pluginhealth.scoring.probes;
+
+import java.util.Optional;
+
+import io.jenkins.pluginhealth.scoring.model.Plugin;
+import io.jenkins.pluginhealth.scoring.model.ProbeResult;
+
+public abstract class AbstractOpenIssuesProbe extends Probe {
+    public static final int ORDER = IssueTrackerDetectionProbe.ORDER + 100;
+
+    @Override
+    protected ProbeResult doApply(Plugin plugin, ProbeContext context) {
+        final Optional<Integer> openIssuesCount = getCountOfOpenIssues(context);
+        return openIssuesCount.isPresent()
+            ? ProbeResult.success(key(), String.format("%d open issues found in the %s plugin.", openIssuesCount.get(), plugin.getName()))
+            : ProbeResult.failure(key(), String.format("Could not find open issues in the %s plugin.", plugin.getName()));
+    }
+
+    abstract Optional<Integer> getCountOfOpenIssues(ProbeContext context);
+
+    @Override
+    public String[] getProbeResultRequirement() {
+        return new String[] { SCMLinkValidationProbe.KEY, IssueTrackerDetectionProbe.KEY };
+    }
+}

core/src/main/java/io/jenkins/pluginhealth/scoring/probes/GitHubOpenIssuesProbe.java

@@ -0,0 +1,83 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Jenkins Infra
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package io.jenkins.pluginhealth.scoring.probes;
+
+import java.io.IOException;
+import java.util.Optional;
+
+import org.kohsuke.github.GHRepository;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+@Component
+@Order(AbstractOpenIssuesProbe.ORDER)
+class GitHubOpenIssuesProbe extends AbstractOpenIssuesProbe {
+    public static final String KEY = "github-open-issues";
+    private static final Logger LOGGER = LoggerFactory.getLogger(GitHubOpenIssuesProbe.class);
+
+    /**
+     * Get total number of open GitHub issues in a plugin.
+     *
+     * @param context {@link ProbeContext}
+     * @return Optional an Integer value will give total count of open issues.
+     */
+    @Override
+    Optional<Integer> getCountOfOpenIssues(ProbeContext context) {
+        if (context.getIssueTrackerUrlsByNames() == null) {
+            LOGGER.info("IssueTracker has no GitHub open issues for the plugin.");
+            return Optional.empty();
+        }
+        /* Stores the GitHub URL to view all existing issues in the plugin. Ex: https://github.com/jenkinsci/cloudevents-plugin/issues */
+        String issueTrackerViewUrl = context.getIssueTrackerUrlsByNames().get("github");
+
+        if (issueTrackerViewUrl == null) {
+            LOGGER.info("The plugin does not use GitHub issues to track issues.");
+            return Optional.empty();
+        }
+
+        try {
+            final Optional<String> repositoryName = context.getRepositoryName(issueTrackerViewUrl.substring(0, issueTrackerViewUrl.lastIndexOf("/")));
+            if (repositoryName.isPresent()) {
+                final GHRepository ghRepository = context.getGitHub().getRepository(repositoryName.get());
+                return Optional.of(ghRepository.getOpenIssueCount());
+            }
+        } catch (IOException ex) {
+            LOGGER.error("Cannot read open issues on GitHub for the plugin. {}", ex);
+        }
+        return Optional.empty();
+    }
+
+    @Override
+    public String key() {
+        return KEY;
+    }
+
+    @Override
+    public String getDescription() {
+        return "Returns the total number of open issues in GitHub.";
+    }
+}

core/src/main/java/io/jenkins/pluginhealth/scoring/probes/IssueTrackerDetectionProbe.java

@@ -0,0 +1,95 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Jenkins Infra
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package io.jenkins.pluginhealth.scoring.probes;
+
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import io.jenkins.pluginhealth.scoring.model.Plugin;
+import io.jenkins.pluginhealth.scoring.model.ProbeResult;
+import io.jenkins.pluginhealth.scoring.model.updatecenter.Plugin.IssueTrackers;
+import io.jenkins.pluginhealth.scoring.model.updatecenter.UpdateCenter;
+
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+@Component
+@Order(value = IssueTrackerDetectionProbe.ORDER)
+class IssueTrackerDetectionProbe extends Probe {
+    public static final String KEY = "issue-tracker-detection";
+    public static final int ORDER = UpdateCenterPluginPublicationProbe.ORDER + 100;
+
+    @Override
+    protected ProbeResult doApply(Plugin plugin, ProbeContext context) {
+        Map<String, String> issueTrackerDetails = getIssueTrackersForAPlugin(plugin.getName(), context.getUpdateCenter());
+
+        if (issueTrackerDetails.isEmpty()) {
+            return ProbeResult.failure(key(), String.format("No issue tracker data available for %s plugin in Update Center.", plugin.getName()));
+        }
+        context.setIssueTrackerNameAndUrl(issueTrackerDetails);
+        return ProbeResult.success(key(), String.format("Found %d issue trackers configured for the %s plugin.", issueTrackerDetails.size(), plugin.getName()));
+    }
+
+    @Override
+    public String[] getProbeResultRequirement() {
+        return new String[]{UpdateCenterPluginPublicationProbe.KEY};
+    }
+
+    @Override
+    public String key() {
+        return KEY;
+    }
+
+    @Override
+    public String getDescription() {
+        return "Detects the issues tracker type from Update Center.";
+    }
+
+    /**
+     * Gets issue trackers for a specific plugin from Update Center.
+     *
+     * @param pluginName   name of the plugin to fetch issue tracker data for.
+     * @param updateCenter The {@link UpdateCenter}.
+     * @return A Map of filtered data from issue trackers.
+     */
+    private Map<String, String> getIssueTrackersForAPlugin(String pluginName, UpdateCenter updateCenter) {
+        return (updateCenter.plugins().get(pluginName) != null) && (updateCenter.plugins().get(pluginName).getIssueTrackers() != null)
+            ? filterIssueTrackersForTypeAndViewUrl(updateCenter.plugins().get(pluginName).getIssueTrackers())
+            : Map.of();
+    }
+
+    /**
+     * Filters IssueTrackers for "type" and "viewUrl".
+     *
+     * @param issueTrackers Accepts a list of {@link IssueTrackers}.
+     * @return A Map of {@code IssueTrackers::type} and {@code IssueTrackers::viewUrl}.
+     */
+    private Map<String, String> filterIssueTrackersForTypeAndViewUrl(List<IssueTrackers> issueTrackers) {
+        return issueTrackers.stream()
+            .collect(Collectors.toMap(IssueTrackers::type, IssueTrackers::viewUrl));
+    }
+
+}

core/src/main/java/io/jenkins/pluginhealth/scoring/probes/JiraOpenIssuesProbe.java

@@ -0,0 +1,133 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2023 Jenkins Infra
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package io.jenkins.pluginhealth.scoring.probes;
+
+import static java.time.temporal.ChronoUnit.SECONDS;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.Optional;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.core.annotation.Order;
+import org.springframework.stereotype.Component;
+
+@Component
+@Order(AbstractOpenIssuesProbe.ORDER)
+class JiraOpenIssuesProbe extends AbstractOpenIssuesProbe {
+    public static final String KEY = "jira-open-issues";
+    private static final String JIRA_HOST = "https://issues.jenkins.io/rest/api/latest/search?";
+    private static final Logger LOGGER = LoggerFactory.getLogger(JiraOpenIssuesProbe.class);
+    final ObjectMapper objectMapper = new ObjectMapper();
+    HttpClient httpClient;
+    HttpRequest httpRequest;
+
+    /**
+     * Get total number of open JIRA issues in a plugin.
+     *
+     * @param context {@link ProbeContext}
+     * @return Optional of type Integer.
+     */
+    @Override
+    Optional<Integer> getCountOfOpenIssues(ProbeContext context) {
+        if (context.getIssueTrackerUrlsByNames() == null) {
+            LOGGER.info("IssueTracker has no JIRA open issues for the plugin.");
+            return Optional.empty();
+        }
+
+        /* Stores the JIRA URL to view all existing issues in the plugin. Ex: https://github.com/jenkinsci/cloudevents-plugin/issues */
+        String viewJiraIssuesUrl = context.getIssueTrackerUrlsByNames().get("jira");
+
+        if (viewJiraIssuesUrl == null || viewJiraIssuesUrl.isEmpty()) {
+            LOGGER.info("The plugin does not use JIRA to track issues.");
+            return Optional.empty();
+        }
+        try {
+            /* The `url` will contain the JIRA url to view issues.
+               For ex: https://issues.jenkins.io/rest/api/latest/search?jql=component=15979
+            */
+            URL url = new URL(viewJiraIssuesUrl);
+
+            /* Here, the query of the url "?jql=component=1833" is concatenated with " AND status=open".
+               This gives the final API required to fetch JIRA issues.
+               For ex: https://issues.jenkins.io/rest/api/latest/search?jql=component=15979%20and%20status=open
+             */
+            String api = JIRA_HOST.concat(url.getQuery())
+                .concat("%20AND%20")
+                .concat("status=open");
+
+            httpRequest = HttpRequest.newBuilder()
+                .uri(new URI(api))
+                .timeout(Duration.of(5, SECONDS)) // based on manual testing, timeout after 5 seconds works.
+                .GET()
+                .build();
+
+            HttpResponse<String> response = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());
+            String jsonResponse = response.body();
+            JsonNode jsonNode = objectMapper.readTree(jsonResponse);
+
+            if (jsonNode.get("errorMessages") != null) {
+                LOGGER.error("Cannot request JIRA API for the plugin. {}", jsonNode.get("errorMessages"));
+                return Optional.empty();
+            }
+            return Optional.of(jsonNode.get("total").asInt());
+        } catch (JsonMappingException e) {
+            LOGGER.error("Cannot map JSON returned by JIRA API for the plugin. {}", e);
+        } catch (JsonProcessingException e) {
+            LOGGER.error("Cannot process JSON returned by JIRA API for the plugin. {}", e);
+        } catch (MalformedURLException e) {
+            LOGGER.error("Cannot process malformed URL for the plugin. {}", e);
+        } catch (URISyntaxException e) {
+            LOGGER.error("Incorrect URI syntax in the plugin. {}", e);
+        } catch (IOException e) {
+            LOGGER.error("Cannot read HttpResponse for the plugin. {}", e);
+        } catch (InterruptedException e) {
+            LOGGER.error("Interruption occurred when waiting for JIRA API for the plugin. {}", e);
+        }
+        return Optional.empty();
+    }
+
+    @Override
+    public String key() {
+        return KEY;
+    }
+
+    @Override
+    public String getDescription() {
+        return "Returns total number of open issues in JIRA.";
+    }
+}