(feat) Add methods to list code scanning alerts on a repository

3 methods added - 1 with no filter, 1 with state filter and 1 with tool
name filter.
[#1133]

Author: akashRindhe

src/main/java/org/kohsuke/github/GHCodeScanningAlertsIterable.java

@@ -0,0 +1,50 @@
+package org.kohsuke.github;
+
+import java.net.MalformedURLException;
+import java.util.Iterator;
+
+import javax.annotation.Nonnull;
+
+class GHCodeScanningAlertsIterable extends PagedIterable<GHCodeScanningAlert> {
+    private final GHRepository owner;
+    private final GitHubRequest request;
+    private GHCodeScanningAlert[] result;
+
+    public GHCodeScanningAlertsIterable(GHRepository owner, GitHubRequest.Builder<?> requestBuilder) {
+        this.owner = owner;
+        try {
+            this.request = requestBuilder.build();
+        } catch (MalformedURLException e) {
+            throw new GHException("Malformed URL", e);
+        }
+    }
+
+    @Nonnull
+    @Override
+    public PagedIterator<GHCodeScanningAlert> _iterator(int pageSize) {
+        return new PagedIterator<>(
+                adapt(GitHubPageIterator
+                        .create(owner.getRoot().getClient(), GHCodeScanningAlert[].class, request, pageSize)),
+                null);
+    }
+
+    protected Iterator<GHCodeScanningAlert[]> adapt(final Iterator<GHCodeScanningAlert[]> base) {
+        return new Iterator<GHCodeScanningAlert[]>() {
+            public boolean hasNext() {
+                return base.hasNext();
+            }
+
+            public GHCodeScanningAlert[] next() {
+                GHCodeScanningAlert[] v = base.next();
+                if (result == null) {
+                    result = v;
+                }
+
+                for (GHCodeScanningAlert alert : result) {
+                    alert.wrap(owner);
+                }
+                return result;
+            }
+        };
+    }
+}

src/main/java/org/kohsuke/github/GHRepository.java

@@ -3511,6 +3511,42 @@ public GHTagObject createTag(String tag, String message, String object, String t
                 .wrap(this);
     }
 
+    /**
+     * Lists the code scanning alerts of this repository.
+     *
+     * @return the paged iterable
+     */
+    public PagedIterable<GHCodeScanningAlert> listCodeScanningAlerts() {
+        return listCodeScanningAlerts(Collections.emptyMap());
+    }
+
+    /**
+     * Lists the code scanning alerts of this repository filtered on the alert status
+     *
+     * @param state
+     *            alert status to filter on
+     * @return the paged iterable
+     */
+    public PagedIterable<GHCodeScanningAlert> listCodeScanningAlerts(GHCodeScanningAlertState state) {
+        return listCodeScanningAlerts(Collections.singletonMap("state", state.name().toLowerCase()));
+    }
+
+    /**
+     * Lists the code scanning alerts of this repository filtered on the code scanning tool name
+     *
+     * @param toolName
+     *            name of code scanning tool that creates alerts
+     * @return the paged iterable
+     */
+    public PagedIterable<GHCodeScanningAlert> listCodeScanningAlerts(String toolName) {
+        return listCodeScanningAlerts(Collections.singletonMap("tool_name", toolName));
+    }
+
+    private PagedIterable<GHCodeScanningAlert> listCodeScanningAlerts(Map<String, Object> filters) {
+        return new GHCodeScanningAlertsIterable(this,
+                root.createRequest().withUrlPath(getApiTailUrl("code-scanning/alerts")).with(filters));
+    }
+
     /**
      * Streams a zip archive of the repository, optionally at a given <code>ref</code>.
      *

src/test/java/org/kohsuke/github/GHCodeScanningAlertTest.java

@@ -0,0 +1,66 @@
+package org.kohsuke.github;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.List;
+
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.not;
+
+/**
+ * <p>
+ * Note : As the code scanning alerts cannot be tailored as part of test setup, lot of the test cases are dependent on
+ * manual setup of the mock repo. Assertions and verifications will often simply check that the values are non-null
+ * rather than depending on hard-coded values, to prevent making the tests flimsy
+ * </p>
+ */
+public class GHCodeScanningAlertTest extends AbstractGitHubWireMockTest {
+    private static final String REPO_NAME = "Pixi";
+    private GHRepository repo;
+
+    @Before
+    public void setUp() throws Exception {
+        repo = gitHub.getRepository(GITHUB_API_TEST_ORG + "/" + REPO_NAME);
+    }
+
+    @Test
+    public void testListCodeScanningAlerts() {
+        // Arrange
+
+        // Act - Search by filtering on code scanning tool
+        List<GHCodeScanningAlert> codeQlAlerts = repo.listCodeScanningAlerts("CodeQL")._iterator(2).nextPage();
+
+        // Assert
+        assertThat(codeQlAlerts.size(), equalTo(2)); // This assertion is based on manual setup done on repo to
+                                                     // guarantee there are atleast 2 issues
+
+        GHCodeScanningAlert alert = codeQlAlerts.get(0);
+
+        // Verify the code scanning tool details
+        assertThat(alert.getTool(), not((Object) null));
+        GHCodeScanningAlert.Tool tool = alert.getTool();
+        assertThat(tool.getName(), is("CodeQL"));
+        assertThat(tool.getVersion(), not((Object) null));
+
+        // Verify the generic values of the code scanning rule
+        assertThat(alert.getRule(), not((Object) null));
+        GHCodeScanningAlert.Rule rule = alert.getRule();
+        assertThat(rule.getId(), not((Object) null));
+        assertThat(rule.getName(), not((Object) null));
+        assertThat(rule.getSeverity(), not((Object) null));
+
+        // Act - Search by filtering on alert status
+        List<GHCodeScanningAlert> openAlerts = repo.listCodeScanningAlerts(GHCodeScanningAlertState.OPEN)
+                ._iterator(2)
+                .nextPage(); // This assertion is based on manual setup done on repo to
+        // guarantee there are atleast 2 issues
+
+        // Assert
+        assertThat(openAlerts.size(), equalTo(2));
+        GHCodeScanningAlert openAlert = openAlerts.get(0);
+        assertThat(openAlert.getState(), is(GHCodeScanningAlertState.OPEN));
+    }
+
+}