Merge branch 'meta-testing' into validation-bugfixes

Author: eceltov

app/V1Module/presenters/UploadedFilesPresenter.php

@@ -264,6 +264,7 @@ public function actionContent(string $id, ?string $entry = null)
         // Remove UTF BOM prefix...
         $utf8bom = "\xef\xbb\xbf";
         $contents = Strings::replace($contents, "~^$utf8bom~");
+        $contents = str_replace("\r\n", "\n", $contents); // normalize line endings
 
         $fixedContents = @mb_convert_encoding($contents, 'UTF-8', 'UTF-8');
 

app/config/permissions.neon

@@ -309,7 +309,7 @@ permissions:
 
     - allow: true
       resource: group
-      role: empowered-supervisor
+      role: supervisor
       actions:
           - viewExamLocksIPs
       conditions:

app/helpers/MetaFormats/MetaFormat.php

@@ -2,6 +2,7 @@
 
 namespace App\Helpers\MetaFormats;
 
+use App\Exceptions\BadRequestException;
 use App\Exceptions\InternalServerException;
 use App\Exceptions\InvalidApiArgumentException;
 
@@ -42,29 +43,26 @@ public function checkedAssign(string $fieldName, mixed $value)
 
     /**
      * Validates the given format.
-     * @return bool Returns whether the format and all nested formats are valid.
+     * @throws InvalidApiArgumentException Thrown when a value is not assignable.
+     * @throws BadRequestException Thrown when the structural constraints were not met.
      */
     public function validate()
     {
         // check whether all higher level contracts hold
         if (!$this->validateStructure()) {
-            return false;
+            throw new BadRequestException("The structural constraints of the format were not met.");
         }
 
         // go through all fields and check whether they were assigned properly
         $fieldFormats = FormatCache::getFieldDefinitions(get_class($this));
         foreach ($fieldFormats as $fieldName => $fieldFormat) {
-            if (!$this->checkIfAssignable($fieldName, $this->$fieldName)) {
-                return false;
-            }
+            $this->checkIfAssignable($fieldName, $this->$fieldName);
 
             // check nested formats recursively
-            if ($this->$fieldName instanceof MetaFormat && !$this->$fieldName->validate()) {
-                return false;
+            if ($this->$fieldName instanceof MetaFormat) {
+                $this->$fieldName->validate();
             }
         }
-
-        return true;
     }
 
     /**

app/helpers/Mocks/MockHelper.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Helpers\Mocks;
+
+use App\Helpers\MetaFormats\FormatCache;
+use App\Helpers\MetaFormats\MetaFormatHelper;
+use App\Helpers\Mocks\MockUserStorage;
+use App\V1Module\Presenters\BasePresenter;
+use Nette\Application\Application;
+use Nette\Application\PresenterFactory;
+use Nette\Application\Routers\RouteList;
+use Nette\Http\Response;
+use Nette\Http\UrlScript;
+use Nette\Security\User;
+use Nette;
+use ReflectionProperty;
+
+class MockHelper
+{
+    /**
+     * Initializes a presenter object with empty http request, response, and user objects.
+     * This is intended to be called right after presenter instantiation and before calling the Presenter::run method.
+     * @param BasePresenter $presenter The presenter to be initialized.
+     */
+    public static function initPresenter(BasePresenter $presenter)
+    {
+        $httpRequest = new \Nette\Http\Request(new UrlScript());
+        $httpResponse = new Response();
+        $user = new User(new MockUserStorage());
+
+        $application = new Application(new PresenterFactory(), new RouteList("V1"), $httpRequest, $httpResponse);
+        $presenter->application = $application;
+
+        $factory = new MockTemplateFactory();
+
+        $presenter->injectPrimary($httpRequest, $httpResponse, user: $user, templateFactory: $factory);
+    }
+
+    /**
+     * Injects a Format class to the FormatCache.
+     * This method must not be used outside of testing, normal Format classes are discovered automatically.
+     * @param string $format The Format class name.
+     */
+    public static function injectFormat(string $format)
+    {
+        // make sure the cache is initialized (it uses lazy loading)
+        FormatCache::getFormatToFieldDefinitionsMap();
+        FormatCache::getFormatNamesHashSet();
+
+        // inject the format name
+        $hashSetReflector = new ReflectionProperty(FormatCache::class, "formatNamesHashSet");
+        $hashSetReflector->setAccessible(true);
+        $formatNamesHashSet = $hashSetReflector->getValue();
+        $formatNamesHashSet[$format] = true;
+        $hashSetReflector->setValue(null, $formatNamesHashSet);
+
+        // inject the format definitions
+        $formatMapReflector = new ReflectionProperty(FormatCache::class, "formatToFieldFormatsMap");
+        $formatMapReflector->setAccessible(true);
+        $formatToFieldFormatsMap = $formatMapReflector->getValue();
+        $formatToFieldFormatsMap[$format] = MetaFormatHelper::createNameToFieldDefinitionsMap($format);
+        $formatMapReflector->setValue(null, $formatToFieldFormatsMap);
+    }
+}

app/helpers/Mocks/MockTemplate.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Helpers\Mocks;
+
+use Nette\Application\UI\Template;
+
+class MockTemplate implements Template
+{
+    public function render(): void
+    {
+    }
+
+    public function setFile(string $file): static
+    {
+        return $this;
+    }
+
+    public function getFile(): ?string
+    {
+        return "test";
+    }
+}

app/helpers/Mocks/MockTemplateFactory.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Helpers\Mocks;
+
+use Nette\Application\UI\Control;
+use Nette\Application\UI\Template;
+use Nette\Application\UI\TemplateFactory;
+
+class MockTemplateFactory implements TemplateFactory
+{
+    public function createTemplate(?Control $control = null): Template
+    {
+        return new MockTemplate();
+    }
+}

app/helpers/Mocks/MockUserStorage.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Helpers\Mocks;
+
+use Nette;
+use Nette\Security\IIdentity;
+
+class MockUserStorage implements Nette\Security\UserStorage
+{
+    public function setExpiration(?string $expire, bool $clearIdentity): void
+    {
+    }
+
+    public function saveAuthentication(IIdentity $identity): void
+    {
+    }
+
+    public function clearAuthentication(bool $clearIdentity): void
+    {
+    }
+
+    public function getState(): array
+    {
+        return [false, null, 0];
+    }
+}

recodex-api.spec

@@ -1,9 +1,9 @@
 %define name recodex-core
 %define short_name api
 %define install_dir /opt/%{name}
-%define version 2.16.1
-%define unmangled_version 1e145d5253dacbe64a8ed1050883834b05a8deeb
-%define release 2
+%define version 2.17.0
+%define unmangled_version 8886b04634ad87c2657f7efed1211c2e4d2bbb65
+%define release 1
 
 Summary: ReCodEx core API component
 Name: %{name}

tests/Presenters/GroupsPresenter.phpt

@@ -1788,40 +1788,9 @@ class TestGroupsPresenter extends Tester\TestCase
         );
     }
 
-    public function testGetExamLocks()
-    {
-        $group = $this->prepExamGroup(); // logged in as supervisor
-        $student = $this->presenter->users->getByEmail("demoGroupMember1@example.com");
-
-        $now = (new DateTime())->getTimestamp();
-        $begin = $now - 7200;
-        $end = $now - 3600;
-        $group->setExamPeriod(DateTime::createFromFormat('U', $begin), DateTime::createFromFormat('U', $end));
-        $this->presenter->groups->persist($group);
-
-        $exam = new GroupExam($group, DateTime::createFromFormat('U', $begin), DateTime::createFromFormat('U', $end), false);
-        $this->presenter->groupExams->persist($exam);
-
-        $lock = new GroupExamLock($exam, $student, '1.2.3.4');
-        $this->presenter->groupExamLocks->persist($lock);
-
-        $payload = PresenterTestHelper::performPresenterRequest(
-            $this->presenter,
-            'V1:Groups',
-            'GET',
-            ['action' => 'getExamLocks', 'id' => $group->getId(), 'examId' => $exam->getId()],
-        );
-
-        Assert::count(1, $payload);
-        Assert::equal($exam->getId(), $payload[0]['groupExamId']);
-        Assert::equal($student->getId(), $payload[0]['studentId']);
-        Assert::false(array_key_exists('remoteAddr', $payload[0])); // supervisor cannot se IPs
-    }
-
     public function testGetExamLocksWithIPs()
     {
         $group = $this->prepExamGroup();
-        PresenterTestHelper::loginDefaultAdmin($this->container); // admin can see IPs
         $student = $this->presenter->users->getByEmail("demoGroupMember1@example.com");
 
         $now = (new DateTime())->getTimestamp();