diff --git a/.github/workflows/flarum-sticky-backend.yml b/.github/workflows/flarum-sticky-backend.yml index 3ec5a6dca..d86994abc 100644 --- a/.github/workflows/flarum-sticky-backend.yml +++ b/.github/workflows/flarum-sticky-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/sticky diff --git a/extensions/sticky/composer.json b/extensions/sticky/composer.json index 6cadf3947..0bf7ae319 100644 --- a/extensions/sticky/composer.json +++ b/extensions/sticky/composer.json @@ -51,7 +51,7 @@ "prettier": true, "typescript": false, "bundlewatch": false, - "backendTesting": false, + "backendTesting": true, "editorConfig": true, "styleci": true } @@ -64,5 +64,29 @@ } ], "minimum-stability": "dev", - "prefer-stable": true + "prefer-stable": true, + "autoload-dev": { + "psr-4": { + "Flarum\\Sticky\\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/tags": "*@dev", + "flarum/testing": "^1.0.0" + } } diff --git a/extensions/sticky/tests/fixtures/.gitkeep b/extensions/sticky/tests/fixtures/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/extensions/sticky/tests/integration/api/ListDiscussionsTest.php b/extensions/sticky/tests/integration/api/ListDiscussionsTest.php new file mode 100644 index 000000000..3f595acbb --- /dev/null +++ b/extensions/sticky/tests/integration/api/ListDiscussionsTest.php @@ -0,0 +1,120 @@ +extension('flarum-tags', 'flarum-sticky'); + + $this->prepareDatabase([ + 'users' => [ + ['id' => 1, 'username' => 'Muralf', 'email' => 'muralf@machine.local', 'is_email_confirmed' => 1], + $this->normalUser(), + ['id' => 3, 'username' => 'Muralf_', 'email' => 'muralf_@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' => 1, 'is_sticky' => true, 'last_post_number' => 1], + ['id' => 2, 'title' => __CLASS__, 'created_at' => Carbon::now()->addMinutes(2), 'last_posted_at' => Carbon::now()->addMinutes(5), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1, 'is_sticky' => false, 'last_post_number' => 1], + ['id' => 3, 'title' => __CLASS__, 'created_at' => Carbon::now()->addMinutes(3), 'last_posted_at' => Carbon::now()->addMinute(), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1, 'is_sticky' => true, 'last_post_number' => 1], + ['id' => 4, 'title' => __CLASS__, 'created_at' => Carbon::now()->addMinutes(4), 'last_posted_at' => Carbon::now()->addMinutes(2), 'user_id' => 1, 'first_post_id' => 1, 'comment_count' => 1, 'is_sticky' => false, 'last_post_number' => 1], + ], + 'discussion_user' => [ + ['discussion_id' => 1, 'user_id' => 3, 'last_read_post_number' => 1], + ['discussion_id' => 3, 'user_id' => 3, 'last_read_post_number' => 1], + ], + 'tags' => [ + ['id' => 1, 'slug' => 'general', 'position' => 0, 'parent_id' => null] + ], + 'discussion_tag' => [ + ['discussion_id' => 1, 'tag_id' => 1], + ['discussion_id' => 2, 'tag_id' => 1], + ['discussion_id' => 3, 'tag_id' => 1], + ['discussion_id' => 4, 'tag_id' => 1], + ] + ]); + } + + /** @test */ + public function list_discussions_shows_sticky_first_as_guest() + { + $response = $this->send( + $this->request('GET', '/api/discussions') + ); + + $this->assertEquals(200, $response->getStatusCode()); + + $data = json_decode($response->getBody()->getContents(), true); + + $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id')); + } + + /** @test */ + public function list_discussions_shows_sticky_unread_first_as_user() + { + $response = $this->send( + $this->request('GET', '/api/discussions', [ + 'authenticatedAs' => 2 + ]) + ); + + $this->assertEquals(200, $response->getStatusCode()); + + $data = json_decode($response->getBody()->getContents(), true); + + $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id')); + } + + /** @test */ + public function list_discussions_shows_normal_order_when_all_read_as_user() + { + $response = $this->send( + $this->request('GET', '/api/discussions', [ + 'authenticatedAs' => 3 + ]) + ); + + $this->assertEquals(200, $response->getStatusCode()); + + $data = json_decode($response->getBody()->getContents(), true); + + $this->assertEquals([2, 4, 3, 1], Arr::pluck($data['data'], 'id')); + } + + /** @test */ + public function list_discussions_shows_stick_first_on_a_tag() + { + $response = $this->send( + $this->request('GET', '/api/discussions', [ + 'authenticatedAs' => 3 + ])->withQueryParams([ + 'filter' => [ + 'tag' => 'general' + ] + ]) + ); + + $this->assertEquals(200, $response->getStatusCode()); + + $data = json_decode($response->getBody()->getContents(), true); + + $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id')); + } +} diff --git a/extensions/sticky/tests/integration/setup.php b/extensions/sticky/tests/integration/setup.php new file mode 100644 index 000000000..67039c083 --- /dev/null +++ b/extensions/sticky/tests/integration/setup.php @@ -0,0 +1,16 @@ +run(); diff --git a/extensions/sticky/tests/phpunit.integration.xml b/extensions/sticky/tests/phpunit.integration.xml new file mode 100644 index 000000000..90fbbff37 --- /dev/null +++ b/extensions/sticky/tests/phpunit.integration.xml @@ -0,0 +1,25 @@ + + + + + ../src/ + + + + + ./integration + ./integration/tmp + + + diff --git a/extensions/sticky/tests/phpunit.unit.xml b/extensions/sticky/tests/phpunit.unit.xml new file mode 100644 index 000000000..d3a4a3e3d --- /dev/null +++ b/extensions/sticky/tests/phpunit.unit.xml @@ -0,0 +1,27 @@ + + + + + ../src/ + + + + + ./unit + + + + + + diff --git a/extensions/sticky/tests/unit/.gitkeep b/extensions/sticky/tests/unit/.gitkeep new file mode 100644 index 000000000..e69de29bb