test(likes): like action behavior (#3512)

Signed-off-by: Sami Mazouz <ilyasmazouz@gmail.com>

.github/workflows/flarum-likes-backend.yml

@@ -6,6 +6,6 @@ jobs:
   run:
     uses: ./.github/workflows/REUSABLE_backend.yml
     with:
-      enable_backend_testing: false
+      enable_backend_testing: true
 
       backend_directory: ./extensions/likes

extensions/likes/composer.json

@@ -51,7 +51,7 @@
                 "prettier": true,
                 "typescript": false,
                 "bundlewatch": false,
-                "backendTesting": false,
+                "backendTesting": true,
                 "editorConfig": true,
                 "styleci": true
             }
@@ -64,5 +64,28 @@
         }
     ],
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "autoload-dev": {
+        "psr-4": {
+            "Flarum\\Likes\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "test": [
+            "@test:unit",
+            "@test:integration"
+        ],
+        "test:unit": "phpunit -c tests/phpunit.unit.xml",
+        "test:integration": "phpunit -c tests/phpunit.integration.xml",
+        "test:setup": "@php tests/integration/setup.php"
+    },
+    "scripts-descriptions": {
+        "test": "Runs all tests.",
+        "test:unit": "Runs all unit tests.",
+        "test:integration": "Runs all integration tests.",
+        "test:setup": "Sets up a database for use with integration tests. Execute this only once."
+    },
+    "require-dev": {
+        "flarum/testing": "^1.0.0"
+    }
 }

extensions/likes/tests/integration/api/LikePostTest.php

@@ -0,0 +1,144 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+namespace Flarum\Likes\Tests\integration\api;
+
+use Carbon\Carbon;
+use Flarum\Post\CommentPost;
+use Flarum\Testing\integration\RetrievesAuthorizedUsers;
+use Flarum\Testing\integration\TestCase;
+use Psr\Http\Message\ResponseInterface;
+
+class LikePostTest extends TestCase
+{
+    use RetrievesAuthorizedUsers;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->extension('flarum-likes');
+
+        $this->prepareDatabase([
+            'users' => [
+                ['id' => 1, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1],
+                $this->normalUser(),
+                ['id' => 3, 'username' => 'Acme', 'email' => 'acme@machine.local', 'is_email_confirmed' => 1],
+            ],
+            'discussions' => [
+                ['id' => 1, 'title' => __CLASS__, 'created_at' => Carbon::now(), 'last_posted_at' => Carbon::now(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 2],
+            ],
+            'posts' => [
+                ['id' => 1, 'number' => 1, 'discussion_id' => 1, 'created_at' => Carbon::now(), 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>something</p></t>'],
+                ['id' => 3, 'number' => 2, 'discussion_id' => 1, 'created_at' => Carbon::now(), 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>something</p></t>'],
+                ['id' => 5, 'number' => 3, 'discussion_id' => 1, 'created_at' => Carbon::now(), 'user_id' => 3, 'type' => 'discussionRenamed', 'content' => '<t><p>something</p></t>'],
+                ['id' => 6, 'number' => 4, 'discussion_id' => 1, 'created_at' => Carbon::now(), 'user_id' => 1, 'type' => 'comment', 'content' => '<t><p>something</p></t>'],
+            ],
+            'groups' => [
+                ['id' => 5, 'name_singular' => 'Acme', 'name_plural' => 'Acme', 'is_hidden' => 0],
+                ['id' => 6, 'name_singular' => 'Acme1', 'name_plural' => 'Acme1', 'is_hidden' => 0]
+            ],
+            'group_user' => [
+                ['user_id' => 3, 'group_id' => 5]
+            ]
+        ]);
+
+        $this->database()->table('group_permission')->where('permission', 'discussion.likePosts')->delete();
+        $this->database()->table('group_permission')->insert(['permission' => 'discussion.likePosts', 'group_id' => 5]);
+    }
+
+    /**
+     * @dataProvider allowedUsersToLike
+     * @test
+     */
+    public function can_like_a_post_if_allowed(int $postId, ?int $authenticatedAs, string $message)
+    {
+        $response = $this->sendLikeRequest($postId, $authenticatedAs);
+
+        $post = CommentPost::query()->find($postId);
+
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertNotNull($post->likes->where('id', $authenticatedAs)->first(), $message);
+    }
+
+    /**
+     * @dataProvider unallowedUsersToLike
+     * @test
+     */
+    public function cannot_like_a_post_if_not_allowed(int $postId, ?int $authenticatedAs, string $message)
+    {
+        $response = $this->sendLikeRequest($postId, $authenticatedAs);
+
+        $post = CommentPost::query()->find($postId);
+
+        $this->assertEquals(403, $response->getStatusCode(), $message);
+        $this->assertNull($post->likes->where('id', $authenticatedAs)->first());
+    }
+
+    /**
+     * @dataProvider allowedUsersToLike
+     * @test
+     */
+    public function can_dislike_a_post_if_liked_and_allowed(int $postId, ?int $authenticatedAs, string $message)
+    {
+        $this->sendLikeRequest($postId, $authenticatedAs);
+        $response = $this->sendLikeRequest($postId, $authenticatedAs, false);
+
+        $post = CommentPost::query()->find($postId);
+
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertNull($post->likes->where('id', $authenticatedAs)->first(), $message);
+    }
+
+    public function allowedUsersToLike(): array
+    {
+        return [
+            [1, 1, 'Admin can like any post'],
+            [1, 3, 'User with permission can like other posts'],
+            [6, 3, 'User with permission can like own post']
+        ];
+    }
+
+    public function unallowedUsersToLike(): array
+    {
+        return [
+            [1, null, 'Guest cannot like any post'],
+            [1, 2, 'User without permission cannot like any post']
+        ];
+    }
+
+    protected function sendLikeRequest(int $postId, ?int $authenticatedAs, bool $liked = true): ResponseInterface
+    {
+        if (! isset($authenticatedAs)) {
+            $initial = $this->send(
+                $this->request('GET', '/')
+            );
+
+            $token = $initial->getHeaderLine('X-CSRF-Token');
+        }
+
+        $request = $this->request('PATCH', "/api/posts/$postId", [
+            'authenticatedAs' => $authenticatedAs,
+            'cookiesFrom' => $initial ?? null,
+            'json' => [
+                'data' => [
+                    'attributes' => [
+                        'isLiked' => $liked
+                    ]
+                ]
+            ]
+        ]);
+
+        if (! isset($authenticatedAs)) {
+            $request = $request->withHeader('X-CSRF-Token', $token);
+        }
+
+        return $this->send($request);
+    }
+}

extensions/likes/tests/integration/setup.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of Flarum.
+ *
+ * For detailed copyright and license information, please view the
+ * LICENSE file that was distributed with this source code.
+ */
+
+use Flarum\Testing\integration\Setup\SetupScript;
+
+require __DIR__.'/../../vendor/autoload.php';
+
+$setup = new SetupScript();
+
+$setup->run();

extensions/likes/tests/phpunit.integration.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="true"
+    stopOnFailure="false"
+>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">../src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Flarum Integration Tests">
+            <directory suffix="Test.php">./integration</directory>
+             <exclude>./integration/tmp</exclude>
+        </testsuite>
+    </testsuites>
+</phpunit>

extensions/likes/tests/phpunit.unit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+    backupGlobals="false"
+    backupStaticAttributes="false"
+    colors="true"
+    convertErrorsToExceptions="true"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    processIsolation="false"
+    stopOnFailure="false"
+>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">../src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Flarum Unit Tests">
+            <directory suffix="Test.php">./unit</directory>
+        </testsuite>
+    </testsuites>
+    <listeners>
+        <listener class="\Mockery\Adapter\Phpunit\TestListener" />
+    </listeners>
+</phpunit>