get overall coverage to 76%

Controller/ApiController.php

@@ -59,6 +59,7 @@ final class ApiController extends Controller
     {
         $commentList = $this->createCommentList();
         $this->createModel($request->header->account, $commentList, CommentListMapper::class, 'comment_list', $request->getOrigin());
+        $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Comment List', 'Comment list successfully created', $commentList);
     }
 
     /**
@@ -108,9 +109,9 @@ final class ApiController extends Controller
     private function updateCommentListFromRequest(RequestAbstract $request) : CommentList
     {
         $list              = CommentListMapper::get((int) $request->getData('id'));
-        $list->allowEdit   = (bool) ($request->getData('allow_edit') ?? false);
-        $list->allowVoting = (bool) ($request->getData('allow_voting') ?? false);
-        $list->allowFiles  = (bool) ($request->getData('allow_upload') ?? false);
+        $list->allowEdit   = (bool) ($request->getData('allow_edit') ?? $list->allowEdit);
+        $list->allowVoting = (bool) ($request->getData('allow_voting') ?? $list->allowVoting);
+        $list->allowFiles  = (bool) ($request->getData('allow_upload') ?? $list->allowFiles);
         $list->status      = (int) ($request->getData('commentlist_status') ?? $list->status);
 
         return $list;
@@ -132,7 +133,7 @@ final class ApiController extends Controller
     public function apiCommentCreate(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
     {
         if (!empty($val = $this->validateCommentCreate($request))) {
-            $response->set('news_create', new FormValidation($val));
+            $response->set('comment_create', new FormValidation($val));
             $response->header->status = RequestStatusCode::R_400;
 
             return;
@@ -180,8 +181,8 @@ final class ApiController extends Controller
         $comment->title      = (string) ($request->getData('title') ?? '');
         $comment->contentRaw = (string) ($request->getData('plain') ?? '');
         $comment->content    = Markdown::parse((string) ($request->getData('plain') ?? ''));
-        $comment->setRef($request->getData('ref') !== null ? (int) $request->getData('ref') : null);
-        $comment->setList((int) ($request->getData('list') ?? 0));
+        $comment->ref = $request->getData('ref') !== null ? (int) $request->getData('ref') : null;
+        $comment->list = (int) ($request->getData('list') ?? 0);
 
         if (!empty($uploadedFiles = $request->getFiles() ?? [])) {
             $uploaded = $this->app->moduleManager->get('Media')->uploadFiles(
@@ -239,10 +240,10 @@ final class ApiController extends Controller
     private function updateCommentFromRequest(RequestAbstract $request) : Comment
     {
         $comment = CommentMapper::get((int) $request->getData('id'));
-        $comment->setTitle($request->getData('title') ?? $comment->getTitle());
-        $comment->setContentRaw($request->getData('plain') ?? $comment->getContentRaw());
-        $comment->setContent(Markdown::parse((string) ($request->getData('plain') ?? $comment->getPlain())));
-        $comment->setRef($request->getData('ref') ?? $comment->getRef());
+        $comment->title = $request->getData('title') ?? $comment->getTitle();
+        $comment->contentRaw = $request->getData('plain') ?? $comment->getContentRaw();
+        $comment->content = Markdown::parse((string) ($request->getData('plain') ?? $comment->getPlain()));
+        $comment->ref = $request->getData('ref') ?? $comment->ref;
 
         return $comment;
     }
@@ -299,7 +300,7 @@ final class ApiController extends Controller
      *
      * @since 1.0.0
      */
-    private function apiChangeCommentVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
+    public function apiChangeCommentVote(RequestAbstract $request, ResponseAbstract $response, $data = null) : void
     {
         if (!empty($val = $this->validateCommentVote($request))) {
             $response->set('qa_answer_vote', new FormValidation($val));
@@ -314,7 +315,7 @@ final class ApiController extends Controller
             $new            = new CommentVote();
             $new->score     = (int) $request->getData('type');
             $new->comment   = (int) $request->getData('id');
-            $new->createdBy = new NullAccount($request->header->account);
+            $new->createdBy = $request->header->account;
 
             $this->createModel($request->header->account, $new, CommentVoteMapper::class, 'comment_vote', $request->getOrigin());
             $this->fillJsonResponse($request, $response, NotificationLevel::OK, 'Vote', 'Sucessfully voted.', $new);
@@ -339,8 +340,8 @@ final class ApiController extends Controller
     private function validateCommentVote(RequestAbstract $request) : array
     {
         $val = [];
-        if (($val['id'] = ($request->getData('id') === null))
-            || ($val['type'] = ($request->getData('type', 'int') < -1 || $request->getData('type') > 1))
+        if (($val['id'] = empty($request->getData('id')))
+            || ($val['type'] = ($request->getData('type', 'int') < -1 || $request->getData('type', 'int') > 1))
         ) {
             return $val;
         }

Models/CommentVoteMapper.php

@@ -83,6 +83,6 @@ final class CommentVoteMapper extends DataMapperAbstract
 
         $results = self::getAllByQuery($query);
 
-        return \reset($results);
+        return empty($results) ? new NullCommentVote() : \reset($results);
     }
 }

tests/Controller/ApiControllerTest.php

@@ -0,0 +1,249 @@
+<?php
+/**
+ * Orange Management
+ *
+ * PHP Version 8.0
+ *
+ * @package   tests
+ * @copyright Dennis Eichhorn
+ * @license   OMS License 1.0
+ * @version   1.0.0
+ * @link      https://orange-management.org
+ */
+declare(strict_types=1);
+
+namespace Modules\Comments\tests\Controller;
+
+use Model\CoreSettings;
+use Modules\Admin\Models\AccountPermission;
+use phpOMS\DataStorage\Session\HttpSession;
+use phpOMS\Account\Account;
+use phpOMS\Account\AccountManager;
+use phpOMS\Account\PermissionType;
+use phpOMS\Application\ApplicationAbstract;
+use phpOMS\Dispatcher\Dispatcher;
+use phpOMS\Event\EventManager;
+use phpOMS\Module\ModuleAbstract;
+use phpOMS\Module\ModuleManager;
+use phpOMS\Router\WebRouter;
+use phpOMS\Utils\TestUtils;
+use phpOMS\Message\Http\HttpRequest;
+use phpOMS\Message\Http\HttpResponse;
+use phpOMS\Message\Http\RequestStatusCode;
+use phpOMS\Uri\HttpUri;
+use phpOMS\System\MimeType;
+
+/**
+ * @testdox Modules\Comments\tests\Controller\ApiControllerTest: Comments api controller
+ *
+ * @internal
+ */
+final class ApiControllerTest extends \PHPUnit\Framework\TestCase
+{
+    protected ApplicationAbstract $app;
+
+    /**
+     * @var \Modules\Comments\Controller\ApiController
+     */
+    protected ModuleAbstract $module;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function setUp() : void
+    {
+        $this->app = new class() extends ApplicationAbstract
+        {
+            protected string $appName = 'Api';
+        };
+
+        $this->app->dbPool         = $GLOBALS['dbpool'];
+        $this->app->orgId          = 1;
+        $this->app->accountManager = new AccountManager($GLOBALS['session']);
+        $this->app->appSettings    = new CoreSettings();
+        $this->app->moduleManager  = new ModuleManager($this->app, __DIR__ . '/../../../../Modules/');
+        $this->app->dispatcher     = new Dispatcher($this->app);
+        $this->app->eventManager   = new EventManager($this->app->dispatcher);
+        $this->app->eventManager->importFromFile(__DIR__ . '/../../../../Web/Api/Hooks.php');
+        $this->app->sessionManager = new HttpSession(36000);
+
+        $account = new Account();
+        TestUtils::setMember($account, 'id', 1);
+
+        $permission = new AccountPermission();
+        $permission->setUnit(1);
+        $permission->setApp('backend');
+        $permission->setPermission(
+            PermissionType::READ
+            | PermissionType::CREATE
+            | PermissionType::MODIFY
+            | PermissionType::DELETE
+            | PermissionType::PERMISSION
+        );
+
+        $account->addPermission($permission);
+
+        $this->app->accountManager->add($account);
+        $this->app->router = new WebRouter();
+
+        $this->module = $this->app->moduleManager->get('Comments');
+
+        TestUtils::setMember($this->module, 'app', $this->app);
+    }
+
+    /**
+     * @covers Modules\Comments\Controller\ApiController
+     * @group module
+     */
+    public function testApiCommentListCU() : void
+    {
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+
+        $this->module->apiCommentListCreate($request, $response);
+        self::assertGreaterThan(0, $lId = $response->get('')['response']->getId());
+
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('id', $lId);
+        $request->setData('allow_edit', '1');
+        $request->setData('allow_voting', '0');
+        $request->setData('allow_upload', '1');
+        $request->setData('commentlist_status', '2');
+
+        $this->module->apiCommentListUpdate($request, $response);
+        self::assertTrue($response->get('')['response']->allowEdit);
+        self::assertFalse($response->get('')['response']->allowVoting);
+        self::assertTrue($response->get('')['response']->allowFiles);
+        self::assertEquals(2, $response->get('')['response']->status);
+    }
+
+    /**
+     * @covers Modules\Comments\Controller\ApiController
+     * @group module
+     */
+    public function testApiCommentCRU() : void
+    {
+        // create
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+
+        $this->module->apiCommentListCreate($request, $response);
+        self::assertGreaterThan(0, $lId = $response->get('')['response']->getId());
+
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('list', $lId);
+        $request->setData('plain', 'Some **text**.');
+
+        if (!\is_file(__DIR__ . '/test_tmp.md')) {
+            \copy(__DIR__ . '/test.md', __DIR__ . '/test_tmp.md');
+        }
+
+        TestUtils::setMember($request, 'files', [
+            'file1' => [
+                'name'     => 'test.md',
+                'type'     => MimeType::M_TXT,
+                'tmp_name' => __DIR__ . '/test_tmp.md',
+                'error'    => \UPLOAD_ERR_OK,
+                'size'     => \filesize(__DIR__ . '/test_tmp.md'),
+            ],
+        ]);
+
+        $request->setData('media', \json_encode([1]));
+
+        $this->module->apiCommentCreate($request, $response);
+        self::assertGreaterThan(0, $cId = $response->get('')['response']->getId());
+
+        //read
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('id', $cId);
+
+        $this->module->apiCommentGet($request, $response);
+        self::assertEquals('', $response->get('')['response']->title);
+        self::assertEquals('Some **text**.', $response->get('')['response']->contentRaw);
+
+        // update
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('id', $cId);
+        $request->setData('title', 'New title');
+        $request->setData('plain', 'New plain');
+
+        $this->module->apiCommentUpdate($request, $response);
+        self::assertEquals('New title', $response->get('')['response']->title);
+        self::assertEquals('New plain', $response->get('')['response']->contentRaw);
+    }
+
+    /**
+     * @covers Modules\Comments\Controller\ApiController
+     * @group module
+     */
+    public function testApiCommentCreateInvalidData() : void
+    {
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('invalid', '1');
+
+        $this->module->apiCommentCreate($request, $response);
+        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
+    }
+
+    /**
+     * @covers Modules\Comments\Controller\ApiController
+     * @group module
+     */
+    public function testApiCommentVoteCreateInvalidData() : void
+    {
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('invalid', '1');
+
+        $this->module->apiChangeCommentVote($request, $response);
+        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
+    }
+
+    /**
+     * @covers Modules\Comments\Controller\ApiController
+     * @group module
+     */
+    public function testApiCommentVoteCreate() : void
+    {
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('id', '1');
+        $request->setData('type', '1');
+
+        $this->module->apiChangeCommentVote($request, $response);
+        self::assertGreaterThan(0, $vId = $response->get('')['response']->getId());
+
+        $response = new HttpResponse();
+        $request  = new HttpRequest(new HttpUri(''));
+
+        $request->header->account = 1;
+        $request->setData('id', '1');
+        $request->setData('type', '-1');
+
+        $this->module->apiChangeCommentVote($request, $response);
+        self::assertEquals($vId, $response->get('')['response']->getId());
+    }
+}

tests/Controller/test.md

@@ -0,0 +1,3 @@
+# Test Title
+
+Some **test** text.

tests/Models/CommentTest.php

@@ -127,7 +127,7 @@ final class CommentTest extends \PHPUnit\Framework\TestCase
     }
 
     /**
-     * @covers Modules\CMS\Models\PageL11n
+     * @covers Modules\Comments\Models\Comment
      * @group module
      */
     public function testSerialize() : void

tests/Models/CommentVoteMapperTest.php

@@ -28,7 +28,7 @@ use Modules\Comments\Models\CommentVoteMapper;
 final class CommentVoteMapperTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @covers Modules\Comments\Models\CommentVote
+     * @covers Modules\Comments\Models\CommentVoteMapper
      * @group module
      */
     public function testCR() : void