From 8b0cc6ea30fe062f5f99f234da494eeafb31a451 Mon Sep 17 00:00:00 2001
From: Michael Vasseur <14887731+vmcj@users.noreply.github.com>
Date: Mon, 30 Oct 2023 07:33:06 +0100
Subject: [PATCH] Allow selfregistration property for groups via API

Expose domjudge only group properties to verify for API upload

The intent is that only priviliged users can view the properties but not
expose those to the generic users (Teams, Public).
---
 webapp/src/Entity/TeamCategory.php            |  2 +-
 webapp/src/Service/ImportExportService.php    |  4 ++
 .../Controller/API/GroupControllerTest.php    | 40 ++++++++++++++-----
 3 files changed, 34 insertions(+), 12 deletions(-)

diff --git a/webapp/src/Entity/TeamCategory.php b/webapp/src/Entity/TeamCategory.php
index 9daf2d5d22b..59f3e49383d 100644
--- a/webapp/src/Entity/TeamCategory.php
+++ b/webapp/src/Entity/TeamCategory.php
@@ -81,7 +81,7 @@ class TeamCategory extends BaseApiEntity implements Stringable
         'comment' => 'Are self-registered teams allowed to choose this category?',
         'default' => 0,
     ])]
-    #[Serializer\Exclude]
+    #[Serializer\Groups([ARC::GROUP_NONSTRICT])]
     private bool $allow_self_registration = false;
 
     /**
diff --git a/webapp/src/Service/ImportExportService.php b/webapp/src/Service/ImportExportService.php
index 464141a9fbc..4391478194f 100644
--- a/webapp/src/Service/ImportExportService.php
+++ b/webapp/src/Service/ImportExportService.php
@@ -618,6 +618,7 @@ public function importGroupsJson(array $data, ?string &$message = null, ?array &
                 'visible' => !($group['hidden'] ?? false),
                 'sortorder' => @$group['sortorder'],
                 'color' => @$group['color'],
+                'allow_self_registration' => @$group['allow_self_registration'],
             ];
         }
 
@@ -661,6 +662,9 @@ protected function importGroupData(array $groupData, ?array &$saved = null): int
                 ->setSortorder($groupItem['sortorder'] ?? 0)
                 ->setColor($groupItem['color'] ?? null)
                 ->setIcpcid($groupItem['icpc_id'] ?? null);
+            if (!empty($groupItem['allow_self_registration'])) {
+                $teamCategory->setAllowSelfRegistration($groupItem['allow_self_registration']);
+            }
             $this->em->flush();
             $this->dj->auditlog('team_category', $teamCategory->getCategoryid(), 'replaced',
                                              'imported from tsv / json');
diff --git a/webapp/tests/Unit/Controller/API/GroupControllerTest.php b/webapp/tests/Unit/Controller/API/GroupControllerTest.php
index 803ff2db1e3..9f66f8b1a77 100644
--- a/webapp/tests/Unit/Controller/API/GroupControllerTest.php
+++ b/webapp/tests/Unit/Controller/API/GroupControllerTest.php
@@ -2,6 +2,8 @@
 
 namespace App\Tests\Unit\Controller\API;
 
+use Generator;
+
 class GroupControllerTest extends BaseTestCase
 {
     protected ?string $apiEndpoint = 'groups';
@@ -33,25 +35,34 @@ class GroupControllerTest extends BaseTestCase
         ]
     ];
 
-    protected array $newGroupPostData = [
-        'name' => 'newGroup',
-        'icpc_id' => 'icpc100',
-        'hidden' => false,
-        'sortorder' => 1,
-        'color' => '#0077B3'
+    protected array $newGroupsPostData = [
+        ['name' => 'newGroup',
+         'icpc_id' => 'icpc100',
+         'hidden' => false,
+         'sortorder' => 1,
+         'color' => '#0077B3'],
+        ['name' => 'newSelfRegister',
+         'hidden' => false,
+         'sortorder' => 2,
+         'color' => 'red',
+         'allow_self_registration' => true],
     ];
+    protected array $restrictedProperties = ['hidden', 'allow_self_registration'];
 
     // We test explicitly for groups 1 and 5 here, which are hidden groups and
     // should not be returned for non-admin users.
     protected array $expectedAbsent = ['4242', 'nonexistent', '1', '5'];
 
-    public function testNewAddedGroup(): void
+    /**
+     * @dataProvider provideNewAddedGroup
+     */
+    public function testNewAddedGroup(array $newGroupPostData): void
     {
         $url = $this->helperGetEndpointURL($this->apiEndpoint);
         $objectsBeforeTest = $this->verifyApiJsonResponse('GET', $url, 200, $this->apiUser);
 
-        $returnedObject = $this->verifyApiJsonResponse('POST', $url, 201, 'admin', $this->newGroupPostData);
-        foreach ($this->newGroupPostData as $key => $value) {
+        $returnedObject = $this->verifyApiJsonResponse('POST', $url, 201, 'admin', $newGroupPostData);
+        foreach ($newGroupPostData as $key => $value) {
             self::assertEquals($value, $returnedObject[$key]);
         }
 
@@ -59,7 +70,7 @@ public function testNewAddedGroup(): void
         $newItems = array_map('unserialize', array_diff(array_map('serialize', $objectsAfterTest), array_map('serialize', $objectsBeforeTest)));
         self::assertEquals(1, count($newItems));
         $listKey = array_keys($newItems)[0];
-        foreach ($this->newGroupPostData as $key => $value) {
+        foreach ($newGroupPostData as $key => $value) {
             self::assertEquals($value, $newItems[$listKey][$key]);
         }
     }
@@ -67,9 +78,16 @@ public function testNewAddedGroup(): void
     public function testNewAddedGroupPostWithId(): void
     {
         $url = $this->helperGetEndpointURL($this->apiEndpoint);
-        $postWithId = $this->newGroupPostData;
+        $postWithId = $this->newGroupsPostData[0];
         $postWithId['id'] = '1';
         // CLICS does not allow POST to set the id value
         $this->verifyApiJsonResponse('POST', $url, 400, 'admin', $postWithId);
     }
+
+    public function provideNewAddedGroup(): Generator
+    {
+        foreach ($this->newGroupsPostData as $group) {
+            yield [$group];
+        }
+    }
 }