move github to its own class

Author: simonLeary42

resources/autoload.php

@@ -19,6 +19,7 @@
 require_once __DIR__ . "/lib/UnityConfig.php";
 require_once __DIR__ . "/lib/UnityWebhook.php";
 require_once __DIR__ . "/lib/UnityRedis.php";
+require_once __DIR__ . "/lib/UnityGithub.php";
 
 // run init script
 require __DIR__ . "/init.php";

resources/init.php

@@ -12,6 +12,7 @@
 use UnityWebPortal\lib\UnityUser;
 use UnityWebPortal\lib\UnityRedis;
 use UnityWebPortal\lib\UnityWebhook;
+use UnityWebPortal\lib\UnityGithub;
 
 //
 // Initialize Session
@@ -84,6 +85,8 @@
     $CONFIG["site"]["url"] . $CONFIG["site"]["prefix"]
 );
 
+$GITHUB = new UnityGithub();
+
 //
 // SSO Init
 //

resources/lib/UnityGithub.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace UnityWebPortal\lib;
+
+class UnityGithub
+{
+    public function getSshPublicKeys($username)
+    {
+        $url = "https://api.github.com/users/$username/keys";
+        $headers = array(
+        "User-Agent: Unity Cluster User Portal"
+        );
+
+        $curl = curl_init();
+        curl_setopt($curl, CURLOPT_URL, $url);
+        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
+        $keys = json_decode(curl_exec($curl), false);
+        curl_close($curl);
+
+        // normally returns array of objects each with a ->key attribute
+        // if bad URL or no such user, returns status=404 object
+        // if no keys, returns []
+        if ((!is_array($keys)) || (count($keys) == 0)) {
+            return [];
+        }
+        // phpcs:disable
+        return array_map(function($x){return $x->key;}, $keys);
+        // phpcs:enable
+    }
+}

resources/lib/UnitySite.php

@@ -25,31 +25,6 @@ public static function removeTrailingWhitespace($arr)
         return $out;
     }
 
-    public static function getGithubKeys($username)
-    {
-        $url = "https://api.github.com/users/$username/keys";
-        $headers = array(
-        "User-Agent: Unity Cluster User Portal"
-        );
-
-        $curl = curl_init();
-        curl_setopt($curl, CURLOPT_URL, $url);
-        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
-        $keys = json_decode(curl_exec($curl), false);
-        curl_close($curl);
-
-        // normally returns array of objects each with a ->key attribute
-        // if bad URL or no such user, returns status=404 object
-        // if no keys, returns []
-        if ((!is_array($keys)) || (count($keys) == 0)) {
-            return [];
-        }
-        // phpcs:disable
-        return array_map(function($x){return $x->key;}, $keys);
-        // phpcs:enable
-    }
-
     public static function testValidSSHKey($key_str)
     {
         // key loader still throws, these just mute warnings for phpunit

test/phpunit-bootstrap.php

@@ -43,7 +43,7 @@
 
 function switchUser(string $eppn, string $given_name, string $sn, string $mail): void
 {
-    global $CONFIG, $REDIS, $LDAP, $SQL, $MAILER, $WEBHOOK, $SITE, $SSO, $OPERATOR, $USER, $SEND_PIMESG_TO_ADMINS, $LOC_HEADER, $LOC_FOOTER;
+    global $CONFIG, $REDIS, $LDAP, $SQL, $MAILER, $WEBHOOK, $GITHUB, $SITE, $SSO, $OPERATOR, $USER, $SEND_PIMESG_TO_ADMINS, $LOC_HEADER, $LOC_FOOTER;
     session_write_close();
     session_id(str_replace(["_", "@", "."], "-", $eppn));
     // session_start will be called on the first post()
@@ -58,7 +58,7 @@ function switchUser(string $eppn, string $given_name, string $sn, string $mail):
 
 function post(string $phpfile, array $post_data): void
 {
-    global $CONFIG, $REDIS, $LDAP, $SQL, $MAILER, $WEBHOOK, $SITE, $SSO, $OPERATOR, $USER, $SEND_PIMESG_TO_ADMINS, $LOC_HEADER, $LOC_FOOTER;
+    global $CONFIG, $REDIS, $LDAP, $SQL, $MAILER, $WEBHOOK, $GITHUB, $SITE, $SSO, $OPERATOR, $USER, $SEND_PIMESG_TO_ADMINS, $LOC_HEADER, $LOC_FOOTER;
     $_SERVER["REQUEST_METHOD"] = "POST";
     $_POST = $post_data;
     ob_start();
@@ -88,3 +88,8 @@ function getUserHasNotRequestedAccountDeletionHasNoGroups()
 {
     return ["user2@org1.test", "foo", "bar", "user2@org1.test"];
 }
+
+function getUserHasNoSshKeys()
+{
+    return ["user3@org1.test", "foo", "bar", "user3@org1.test"];
+}

test/unit/UnityGithubTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace UnityWebPortal\lib;
+
+use PHPUnit\Framework\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+class UnitySiteTest extends TestCase
+{
+    public static function providerTestGetGithubKeys()
+    {
+        return [
+            # empty
+            ["", []],
+            # nonexistent user
+            ["asdfkljhasdflkjashdflkjashdflkasjd", []],
+            # user with no keys
+            ["sheldor1510", []],
+            # user with 1 key
+            //phpcs:disable
+            ["simonLeary42", ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDGRl6JWPj+Gq2Lz9GjYdUl4/unLoFOyfgeiII1CxutpabPByRJbeuonR0zTpn51tZeYuAUOJBOeKt+Lj4i4UDGl6igpdXXSwkBXl7jxfRPwJ6WuTkDx7Z8ynwnqlDV2q089q4OX/b/uuHgsIhIBwrouKsRQaZIqTbwNMfiqQ2zl14V0KMrTPzOiwR6Q+hqSaR5Z29WKE7ff/OWzSC3/0T6avCmcCbQaRPJdVM+QC17B0vl8FzPwRjorMngwZ0cImdQ/0Ww1d12YAL7UWp1c2egfnthKP3MuQZnNF8ixsAk1eIIwTRdiI87BOoorW8NXhxXmhyheRCsFwyP4LJBqyUVoZJ0UYyk0AO4G9EStnfpiz8YXGK+M1G4tUrWgzs1cdjlHtgCWUmITtgabnYCC4141m7n4GZTk2H/lSrJcvAs3JEiwLTj1lzeGgzeSsz/XKsnOJyzjEVr2Jp3iT+J9PbQpfS0SxTCIGgxMqllovv79pfsF/zc+vaxqSShyHW7oyn7hLMHM60LO/IIX1RWGL3rD9ecXx2pXXQ1RhIkVteIi13XkFt+KW00cstFlAd3EHCoY/XorShd2jeID7tpnYlmNfotYUs6IKefvpNC0PWkh5UXFEv3SUfw4Wd8O0DiHfhkrhxn1W/GajqSIlZ5DKgPzFg8EHexv8lSa7WJg0H3YQ=="]]
+            //phpcs:enable
+        ];
+    }
+
+    #[DataProvider("providerTestGetGithubKeys")]
+    public function testGetGithubKeys(string $username, array $expected)
+    {
+        $GITHUB = new UnityGithub();
+        $this->assertEquals($expected, $GITHUB->getSshPublicKeys($username));
+    }
+}

test/unit/UnitySiteTest.php

@@ -30,26 +30,4 @@ public function testTestValidSSHKey(bool $expected, string $key)
         $this->assertEquals($expected, $SITE->testValidSSHKey($key));
     }
 
-    public static function providerTestGetGithubKeys()
-    {
-        return [
-            # empty
-            ["", []],
-            # nonexistent user
-            ["asdfkljhasdflkjashdflkjashdflkasjd", []],
-            # user with no keys
-            ["sheldor1510", []],
-            # user with 1 key
-            //phpcs:disable
-            ["simonLeary42", ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDGRl6JWPj+Gq2Lz9GjYdUl4/unLoFOyfgeiII1CxutpabPByRJbeuonR0zTpn51tZeYuAUOJBOeKt+Lj4i4UDGl6igpdXXSwkBXl7jxfRPwJ6WuTkDx7Z8ynwnqlDV2q089q4OX/b/uuHgsIhIBwrouKsRQaZIqTbwNMfiqQ2zl14V0KMrTPzOiwR6Q+hqSaR5Z29WKE7ff/OWzSC3/0T6avCmcCbQaRPJdVM+QC17B0vl8FzPwRjorMngwZ0cImdQ/0Ww1d12YAL7UWp1c2egfnthKP3MuQZnNF8ixsAk1eIIwTRdiI87BOoorW8NXhxXmhyheRCsFwyP4LJBqyUVoZJ0UYyk0AO4G9EStnfpiz8YXGK+M1G4tUrWgzs1cdjlHtgCWUmITtgabnYCC4141m7n4GZTk2H/lSrJcvAs3JEiwLTj1lzeGgzeSsz/XKsnOJyzjEVr2Jp3iT+J9PbQpfS0SxTCIGgxMqllovv79pfsF/zc+vaxqSShyHW7oyn7hLMHM60LO/IIX1RWGL3rD9ecXx2pXXQ1RhIkVteIi13XkFt+KW00cstFlAd3EHCoY/XorShd2jeID7tpnYlmNfotYUs6IKefvpNC0PWkh5UXFEv3SUfw4Wd8O0DiHfhkrhxn1W/GajqSIlZ5DKgPzFg8EHexv8lSa7WJg0H3YQ=="]]
-            //phpcs:enable
-        ];
-    }
-
-    #[DataProvider("providerTestGetGithubKeys")]
-    public function testGetGithubKeys(string $username, array $expected)
-    {
-        $SITE = new UnitySite();
-        $this->assertEquals($expected, $SITE->getGithubKeys($username));
-    }
 }

webroot/panel/account.php

@@ -38,7 +38,7 @@
                     break;
                 case "github":
                     $gh_user = $_POST["gh_user"];
-                    $keys = UnitySite::getGithubKeys($gh_user);
+                    $keys = $GITHUB->getSshPublicKeys($gh_user);
                     foreach ($keys as $key) {
                         if (UnitySite::testValidSSHKey($key)) {
                             array_push($added_keys, $key);