test: added tests for Comments class

thorsten · Mar 24, 2024 · c234952 · c234952
1 parent dcd037e
commit c234952
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,8 +37,6 @@ This is a log of major user-visible changes in each phpMyFAQ release.
 - updated bundled dependencies (Thorsten)
 - fixed minor bugs (Thorsten)
 
-### phpMyFAQ v3.2.6 - unreleased
-
 ### phpMyFAQ v3.2.5 - 2024-02-05
 
 - fixed multiple security vulnerabilities (Thorsten)

diff --git a/phpmyfaq/src/phpMyFAQ/Comments.php b/phpmyfaq/src/phpMyFAQ/Comments.php
@@ -17,6 +17,7 @@
 
 namespace phpMyFAQ;
 
+use DateTimeInterface;
 use Exception;
 use phpMyFAQ\Entity\CommentType;
 use phpMyFAQ\Services\Gravatar;
@@ -116,7 +117,7 @@ public function getCommentsData(int $referenceId, string $type): array
                     ->setId($row->id_comment)
                     ->setRecordId($row->id)
                     ->setComment($row->comment)
-                    ->setDate(Date::createIsoDate($row->datum, DATE_ISO8601, false))
+                    ->setDate(Date::createIsoDate($row->datum, DateTimeInterface::ATOM, false))
                     ->setUsername($row->usr)
                     ->setEmail($row->email)
                     ->setType($type);
@@ -156,7 +157,7 @@ private function showShortComment(int $id, string $comment): string
     /**
      * Adds a new comment.
      */
-    public function addComment(Comment $comment): bool
+    public function create(Comment $comment): bool
     {
         $query = sprintf(
             "

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Frontend/CommentController.php b/phpmyfaq/src/phpMyFAQ/Controller/Frontend/CommentController.php
@@ -126,9 +126,9 @@ public function create(Request $request): JsonResponse
                 ->setUsername($username)
                 ->setEmail($mailer)
                 ->setComment(nl2br(strip_tags((string) $commentText)))
-                ->setDate($request->server->get('REQUEST_TIME'));
+                ->setDate($request->server->get('tim'));
 
-            if ($comment->addComment($commentEntity)) {
+            if ($comment->create($commentEntity)) {
                 $notification = new Notification($this->configuration);
                 if ('faq' == $type) {
                     $notification->sendFaqCommentNotification($faq, $commentEntity);

diff --git a/tests/phpMyFAQ/CommentsTest.php b/tests/phpMyFAQ/CommentsTest.php
@@ -0,0 +1,79 @@
+<?php
+
+namespace phpMyFAQ;
+
+use DateTime;
+use DateTimeInterface;
+use phpMyFAQ\Database\Sqlite3;
+use phpMyFAQ\Entity\Comment;
+use phpMyFAQ\Entity\CommentType;
+use PHPUnit\Framework\TestCase;
+
+class CommentsTest extends TestCase
+{
+    private Comments $comments;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $dbHandle = new Sqlite3();
+        $dbHandle->connect(PMF_TEST_DIR . '/test.db', '', '');
+        $configuration = new Configuration($dbHandle);
+
+        $this->comments = new Comments($configuration);
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        $this->comments->delete(CommentType::FAQ, 1);
+    }
+
+    public function testCreate(): void
+    {
+        $comment = $this->getComment();
+
+        $this->assertTrue($this->comments->create($comment));
+    }
+
+    public function testDelete(): void
+    {
+        $comment = $this->getComment();
+        $this->comments->create($comment);
+
+        $this->assertTrue($this->comments->delete(CommentType::FAQ, 1));
+    }
+
+    public function testGetNumberOfComments(): void
+    {
+        $comment = $this->getComment();
+        $this->comments->create($comment);
+
+        $this->assertSame([1 => 1], $this->comments->getNumberOfComments());
+    }
+
+    public function testGetAllComments(): void
+    {
+        $comment = $this->getComment();
+        $this->comments->create($comment);
+
+        $this->assertCount(1, $this->comments->getAllComments());
+    }
+
+    private function getComment(): Comment
+    {
+        $comment = new Comment();
+        $comment
+            ->setRecordId(1)
+            ->setType(CommentType::FAQ)
+            ->setUsername('testUser')
+            ->setEmail('test@example.org')
+            ->setComment('This is a test comment')
+            ->setDate((string)time())
+            ->setHelped(true);
+
+        return $comment;
+    }
+}