feature #1114 feat: Secret Scanning Alerts (haridarshan)

haridarshan · web-flow · commit 113f6b3c52f9 · 2023-10-17T22:22:42.000+02:00
This PR was squashed before being merged into the 3.12-dev branch. Discussion ---------- Feature: - Secret Scanning Alerts Doc: - Secret Scanning doc Closes #1080 Commits ------- 98053b5 feat: Add Secret Scanning Alerts (Enterprise, Organization & Repository) 7b434a9 chore(styleci): apply styleci patch
diff --git a/doc/README.md b/doc/README.md
@@ -14,6 +14,7 @@ v3 APIs:
   * [Public keys](currentuser/publickeys.md)
   * [Memberships](currentuser/memberships.md)
 * [Enterprise](enterprise.md)
+  * [Secret Scanning Alert](enterprise/secret-scanning.md)
 * [Gists](gists.md)
   * [Comments](gists/comments.md)
 * GitData
@@ -42,6 +43,7 @@ v3 APIs:
   * [Self hosted runners](organization/actions/self_hosted_runners.md)
   * [Secrets](organization/actions/secrets.md)
   * [Variables](organization/actions/variables.md)
+  * [Secret Scanning Alert](organization/secret-scanning.md)
 * [Projects](project/projects.md)
   * [Columns](project/columns.md)
     * [Cards](project/cards.md)
@@ -74,6 +76,7 @@ v3 APIs:
   * [Stargazers](repo/stargazers.md)
   * [Statuses](repo/statuses.md)
   * [Tags](repo/tags.md)
+  * [Secret Scanning Alert](repo/secret-scanning.md)
 * [Search](search.md)
 * [Users](users.md)
 
diff --git a/doc/enterprise/secret-scanning.md b/doc/enterprise/secret-scanning.md
@@ -0,0 +1,10 @@
+## Enterprise / Secret Scanning API
+[Back to the "Enterprise API"](../../enterprise.md) | [Back to the navigation](../../README.md)
+
+# List secret-scanning alerts for an Enterprise
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
+
+```php
+$alerts = $client->api('enterprise')->secretScanning()->alerts('KnpLabs');
+```
diff --git a/doc/organization/secret-scanning.md b/doc/organization/secret-scanning.md
@@ -0,0 +1,10 @@
+## Organization / Secret Scanning API
+[Back to the "Organization API"](../../organization.md) | [Back to the navigation](../../README.md)
+
+# List secret-scanning alerts for an Organization
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-an-organization
+
+```php
+$alerts = $client->api('organization')->secretScanning()->alerts('KnpLabs');
+```
diff --git a/doc/repo/secret-scanning.md b/doc/repo/secret-scanning.md
@@ -0,0 +1,37 @@
+## Repository / Secret Scanning API
+[Back to the "Repos API"](../../repos.md) | [Back to the navigation](../../README.md)
+
+# List secret-scanning alerts for a repository
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-a-repository
+
+```php
+$alerts = $client->api('repos')->secretScanning()->alerts('KnpLabs', 'php-github-api');
+```
+
+# Get a secret-scanning alert
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#get-a-secret-scanning-alert
+
+```php
+$alert = $client->api('repos')->secretScanning()->getAlert('KnpLabs', 'php-github-api', $alertNumber);
+```
+
+# Update a secret-scanning alert
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#update-a-secret-scanning-alert
+
+```php
+$client->api('repos')->secretScanning()->updateAlert('KnpLabs', 'php-github-api', $alertNumber, [
+    'state' => 'resolved',
+    'resolution' => 'wont-fix'
+]);
+```
+
+# List Locations for a secret-scanning alert
+
+https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-locations-for-a-secret-scanning-alert
+
+```php
+$locations = $client->api('repos')->secretScanning()->locations('KnpLabs', 'php-github-api', $alertNumber);
+```
diff --git a/lib/Github/Api/Enterprise.php b/lib/Github/Api/Enterprise.php
@@ -4,6 +4,7 @@
 
 use Github\Api\Enterprise\License;
 use Github\Api\Enterprise\ManagementConsole;
+use Github\Api\Enterprise\SecretScanning;
 use Github\Api\Enterprise\Stats;
 use Github\Api\Enterprise\UserAdmin;
 
@@ -48,4 +49,12 @@ public function userAdmin()
     {
         return new UserAdmin($this->getClient());
     }
+
+    /**
+     * @return SecretScanning
+     */
+    public function secretScanning(): SecretScanning
+    {
+        return new SecretScanning($this->getClient());
+    }
 }
diff --git a/lib/Github/Api/Enterprise/SecretScanning.php b/lib/Github/Api/Enterprise/SecretScanning.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Github\Api\Enterprise;
+
+use Github\Api\AbstractApi;
+
+class SecretScanning extends AbstractApi
+{
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
+     *
+     * @param string $enterprise
+     * @param array  $params
+     *
+     * @return array|string
+     */
+    public function alerts(string $enterprise, array $params = [])
+    {
+        return $this->get('/enterprises/'.rawurlencode($enterprise).'/secret-scanning/alerts', $params);
+    }
+}
diff --git a/lib/Github/Api/Organization.php b/lib/Github/Api/Organization.php
@@ -8,6 +8,7 @@
 use Github\Api\Organization\Hooks;
 use Github\Api\Organization\Members;
 use Github\Api\Organization\OutsideCollaborators;
+use Github\Api\Organization\SecretScanning;
 use Github\Api\Organization\Teams;
 
 /**
@@ -149,4 +150,12 @@ public function runners(): SelfHostedRunners
     {
         return new SelfHostedRunners($this->getClient());
     }
+
+    /**
+     * @return SecretScanning
+     */
+    public function secretScanning(): SecretScanning
+    {
+        return new SecretScanning($this->getClient());
+    }
 }
diff --git a/lib/Github/Api/Organization/SecretScanning.php b/lib/Github/Api/Organization/SecretScanning.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Github\Api\Organization;
+
+class SecretScanning extends \Github\Api\AbstractApi
+{
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-an-organization
+     *
+     * @param string $organization
+     * @param array  $params
+     *
+     * @return array|string
+     */
+    public function alerts(string $organization, array $params = [])
+    {
+        return $this->get('/orgs/'.rawurlencode($organization).'/secret-scanning/alerts', $params);
+    }
+}
diff --git a/lib/Github/Api/Repo.php b/lib/Github/Api/Repo.php
@@ -24,6 +24,7 @@
 use Github\Api\Repository\Projects;
 use Github\Api\Repository\Protection;
 use Github\Api\Repository\Releases;
+use Github\Api\Repository\SecretScanning;
 use Github\Api\Repository\Stargazers;
 use Github\Api\Repository\Statuses;
 use Github\Api\Repository\Traffic;
@@ -897,4 +898,12 @@ public function disableVulnerabilityAlerts(string $username, string $repository)
     {
         return $this->delete('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/vulnerability-alerts');
     }
+
+    /**
+     * @return SecretScanning
+     */
+    public function secretScanning(): SecretScanning
+    {
+        return new SecretScanning($this->getClient());
+    }
 }
diff --git a/lib/Github/Api/Repository/SecretScanning.php b/lib/Github/Api/Repository/SecretScanning.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace Github\Api\Repository;
+
+class SecretScanning extends \Github\Api\AbstractApi
+{
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-secret-scanning-alerts-for-a-repository
+     *
+     * @param string $username
+     * @param string $repository
+     * @param array  $params
+     *
+     * @return array|string
+     */
+    public function alerts(string $username, string $repository, array $params = [])
+    {
+        return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/secret-scanning/alerts', $params);
+    }
+
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#get-a-secret-scanning-alert
+     *
+     * @param string $username
+     * @param string $repository
+     * @param int    $alertNumber
+     *
+     * @return array|string
+     */
+    public function getAlert(string $username, string $repository, int $alertNumber)
+    {
+        return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/secret-scanning/alerts/'.$alertNumber);
+    }
+
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#update-a-secret-scanning-alert
+     *
+     * @param string $username
+     * @param string $repository
+     * @param int    $alertNumber
+     * @param array  $params
+     *
+     * @return array|string
+     */
+    public function updateAlert(string $username, string $repository, int $alertNumber, array $params = [])
+    {
+        return $this->patch('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/secret-scanning/alerts/'.$alertNumber, $params);
+    }
+
+    /**
+     * @link https://docs.github.com/en/enterprise-server@3.5/rest/secret-scanning#list-locations-for-a-secret-scanning-alert
+     *
+     * @param string $username
+     * @param string $repository
+     * @param int    $alertNumber
+     * @param array  $params
+     *
+     * @return array|string
+     */
+    public function locations(string $username, string $repository, int $alertNumber, array $params = [])
+    {
+        return $this->get('/repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/secret-scanning/alerts/'.$alertNumber.'/locations', $params);
+    }
+}
diff --git a/test/Github/Tests/Api/Enterprise/SecretScanningTest.php b/test/Github/Tests/Api/Enterprise/SecretScanningTest.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Github\Tests\Api\Enterprise;
+
+use Github\Api\Enterprise\SecretScanning;
+use Github\Tests\Api\TestCase;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class SecretScanningTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAlerts()
+    {
+        $expectedArray = [
+            ['number' => 1, 'state' => 'resolved', 'resolution' => 'false_positive'],
+            ['number' => 2, 'state' => 'open', 'resolution' => null],
+            ['number' => 3, 'state' => 'resolved', 'resolution' => 'wont_fix'],
+            ['number' => 4, 'state' => 'resolved', 'resolution' => 'revoked'],
+        ];
+
+        /** @var SecretScanning|MockObject $api */
+        $api = $this->getApiMock();
+
+        $api
+            ->expects($this->once())
+            ->method('get')
+            ->with('/enterprises/KnpLabs/secret-scanning/alerts')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->alerts('KnpLabs', [
+            'state' => 'all',
+        ]));
+    }
+
+    protected function getApiClass()
+    {
+        return \Github\Api\Enterprise\SecretScanning::class;
+    }
+}
diff --git a/test/Github/Tests/Api/Organization/SecretScanningTest.php b/test/Github/Tests/Api/Organization/SecretScanningTest.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace Github\Tests\Api\Organization;
+
+use Github\Api\Organization\SecretScanning;
+use Github\Tests\Api\TestCase;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class SecretScanningTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function shouldGetAlerts()
+    {
+        $expectedArray = [
+            ['number' => 1, 'state' => 'resolved', 'resolution' => 'false_positive'],
+            ['number' => 2, 'state' => 'open', 'resolution' => null],
+            ['number' => 3, 'state' => 'resolved', 'resolution' => 'wont_fix'],
+            ['number' => 4, 'state' => 'resolved', 'resolution' => 'revoked'],
+        ];
+
+        /** @var SecretScanning|MockObject $api */
+        $api = $this->getApiMock();
+
+        $api
+            ->expects($this->once())
+            ->method('get')
+            ->with('/orgs/KnpLabs/secret-scanning/alerts')
+            ->will($this->returnValue($expectedArray));
+
+        $this->assertEquals($expectedArray, $api->alerts('KnpLabs', [
+            'state' => 'all',
+        ]));
+    }
+
+    protected function getApiClass()
+    {
+        return \Github\Api\Organization\SecretScanning::class;
+    }
+}
diff --git a/test/Github/Tests/Api/Repository/SecretScanningTest.php b/test/Github/Tests/Api/Repository/SecretScanningTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Github\Api\Enterprise\License;`
`6`	`6`	`use Github\Api\Enterprise\ManagementConsole;`
	`7`	`+use Github\Api\Enterprise\SecretScanning;`
`7`	`8`	`use Github\Api\Enterprise\Stats;`
`8`	`9`	`use Github\Api\Enterprise\UserAdmin;`
`9`	`10`
`@@ -48,4 +49,12 @@ public function userAdmin()`
`48`	`49`	`{`
`49`	`50`	`return new UserAdmin($this->getClient());`
`50`	`51`	`}`
	`52`	`+`
	`53`	`+ /**`
	`54`	`+ * @return SecretScanning`
	`55`	`+ */`
	`56`	`+ public function secretScanning(): SecretScanning`
	`57`	`+ {`
	`58`	`+ return new SecretScanning($this->getClient());`
	`59`	`+ }`
`51`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`use Github\Api\Organization\Hooks;`
`9`	`9`	`use Github\Api\Organization\Members;`
`10`	`10`	`use Github\Api\Organization\OutsideCollaborators;`
	`11`	`+use Github\Api\Organization\SecretScanning;`
`11`	`12`	`use Github\Api\Organization\Teams;`
`12`	`13`
`13`	`14`	`/**`
`@@ -149,4 +150,12 @@ public function runners(): SelfHostedRunners`
`149`	`150`	`{`
`150`	`151`	`return new SelfHostedRunners($this->getClient());`
`151`	`152`	`}`
	`153`	`+`
	`154`	`+ /**`
	`155`	`+ * @return SecretScanning`
	`156`	`+ */`
	`157`	`+ public function secretScanning(): SecretScanning`
	`158`	`+ {`
	`159`	`+ return new SecretScanning($this->getClient());`
	`160`	`+ }`
`152`	`161`	`}`