1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.AdminAPI.UserControllerTest do
6 use Pleroma.Web.ConnCase
7 use Oban.Testing, repo: Pleroma.Repo
10 import Pleroma.Factory
13 alias Pleroma.ModerationLog
15 alias Pleroma.Tests.ObanHelpers
18 alias Pleroma.Web.ActivityPub.Relay
19 alias Pleroma.Web.CommonAPI
20 alias Pleroma.Web.MediaProxy
23 Tesla.Mock.mock_global(fn env -> apply(HttpRequestMock, :request, [env]) end)
29 admin = insert(:user, is_admin: true)
30 token = insert(:oauth_admin_token, user: admin)
34 |> assign(:user, admin)
35 |> assign(:token, token)
37 {:ok, %{admin: admin, token: token, conn: conn}}
40 test "with valid `admin_token` query parameter, skips OAuth scopes check" do
41 clear_config([:admin_token], "password123")
45 conn = get(build_conn(), "/api/pleroma/admin/users/#{user.nickname}?admin_token=password123")
47 assert json_response(conn, 200)
50 test "GET /api/pleroma/admin/users/:nickname requires admin:read:accounts or broader scope",
53 url = "/api/pleroma/admin/users/#{user.nickname}"
55 good_token1 = insert(:oauth_token, user: admin, scopes: ["admin"])
56 good_token2 = insert(:oauth_token, user: admin, scopes: ["admin:read"])
57 good_token3 = insert(:oauth_token, user: admin, scopes: ["admin:read:accounts"])
59 bad_token1 = insert(:oauth_token, user: admin, scopes: ["read:accounts"])
60 bad_token2 = insert(:oauth_token, user: admin, scopes: ["admin:read:accounts:partial"])
63 for good_token <- [good_token1, good_token2, good_token3] do
66 |> assign(:user, admin)
67 |> assign(:token, good_token)
70 assert json_response(conn, 200)
73 for good_token <- [good_token1, good_token2, good_token3] do
77 |> assign(:token, good_token)
80 assert json_response(conn, :forbidden)
83 for bad_token <- [bad_token1, bad_token2, bad_token3] do
86 |> assign(:user, admin)
87 |> assign(:token, bad_token)
90 assert json_response(conn, :forbidden)
94 describe "DELETE /api/pleroma/admin/users" do
95 test "single user", %{admin: admin, conn: conn} do
96 clear_config([:instance, :federating], true)
100 avatar: %{"url" => [%{"href" => "https://someurl"}]},
101 banner: %{"url" => [%{"href" => "https://somebanner"}]},
106 # Create some activities to check they got deleted later
107 follower = insert(:user)
108 {:ok, _} = CommonAPI.post(user, %{status: "test"})
109 {:ok, _, _, _} = CommonAPI.follow(user, follower)
110 {:ok, _, _, _} = CommonAPI.follow(follower, user)
111 user = Repo.get(User, user.id)
112 assert user.note_count == 1
113 assert user.follower_count == 1
114 assert user.following_count == 1
115 assert user.is_active
117 with_mock Pleroma.Web.Federator,
118 publish: fn _ -> nil end,
119 perform: fn _, _ -> nil end do
122 |> put_req_header("accept", "application/json")
123 |> delete("/api/pleroma/admin/users?nickname=#{user.nickname}")
125 ObanHelpers.perform_all()
127 refute User.get_by_nickname(user.nickname).is_active
129 log_entry = Repo.one(ModerationLog)
131 assert ModerationLog.get_log_entry_message(log_entry) ==
132 "@#{admin.nickname} deleted users: @#{user.nickname}"
134 assert json_response(conn, 200) == [user.nickname]
136 user = Repo.get(User, user.id)
137 refute user.is_active
139 assert user.avatar == %{}
140 assert user.banner == %{}
141 assert user.note_count == 0
142 assert user.follower_count == 0
143 assert user.following_count == 0
144 assert user.bio == ""
145 assert user.name == nil
147 assert called(Pleroma.Web.Federator.publish(:_))
151 test "multiple users", %{admin: admin, conn: conn} do
152 user_one = insert(:user)
153 user_two = insert(:user)
157 |> put_req_header("accept", "application/json")
158 |> delete("/api/pleroma/admin/users", %{
159 nicknames: [user_one.nickname, user_two.nickname]
162 log_entry = Repo.one(ModerationLog)
164 assert ModerationLog.get_log_entry_message(log_entry) ==
165 "@#{admin.nickname} deleted users: @#{user_one.nickname}, @#{user_two.nickname}"
167 response = json_response(conn, 200)
168 assert response -- [user_one.nickname, user_two.nickname] == []
172 describe "/api/pleroma/admin/users" do
173 test "Create", %{conn: conn} do
176 |> put_req_header("accept", "application/json")
177 |> post("/api/pleroma/admin/users", %{
180 "nickname" => "lain",
181 "email" => "lain@example.org",
185 "nickname" => "lain2",
186 "email" => "lain2@example.org",
192 response = json_response(conn, 200) |> Enum.map(&Map.get(&1, "type"))
193 assert response == ["success", "success"]
195 log_entry = Repo.one(ModerationLog)
197 assert ["lain", "lain2"] -- Enum.map(log_entry.data["subjects"], & &1["nickname"]) == []
200 test "Cannot create user with existing email", %{conn: conn} do
205 |> put_req_header("accept", "application/json")
206 |> post("/api/pleroma/admin/users", %{
209 "nickname" => "lain",
210 "email" => user.email,
216 assert json_response(conn, 409) == [
220 "email" => user.email,
223 "error" => "email has already been taken",
229 test "Cannot create user with existing nickname", %{conn: conn} do
234 |> put_req_header("accept", "application/json")
235 |> post("/api/pleroma/admin/users", %{
238 "nickname" => user.nickname,
239 "email" => "someuser@plerama.social",
245 assert json_response(conn, 409) == [
249 "email" => "someuser@plerama.social",
250 "nickname" => user.nickname
252 "error" => "nickname has already been taken",
258 test "Multiple user creation works in transaction", %{conn: conn} do
263 |> put_req_header("accept", "application/json")
264 |> post("/api/pleroma/admin/users", %{
267 "nickname" => "newuser",
268 "email" => "newuser@pleroma.social",
272 "nickname" => "lain",
273 "email" => user.email,
279 assert json_response(conn, 409) == [
283 "email" => user.email,
286 "error" => "email has already been taken",
292 "email" => "newuser@pleroma.social",
293 "nickname" => "newuser"
300 assert User.get_by_nickname("newuser") === nil
304 describe "/api/pleroma/admin/users/:nickname" do
305 test "Show", %{conn: conn} do
308 conn = get(conn, "/api/pleroma/admin/users/#{user.nickname}")
310 assert user_response(user) == json_response(conn, 200)
313 test "when the user doesn't exist", %{conn: conn} do
316 conn = get(conn, "/api/pleroma/admin/users/#{user.nickname}")
318 assert %{"error" => "Not found"} == json_response(conn, 404)
322 describe "/api/pleroma/admin/users/follow" do
323 test "allows to force-follow another user", %{admin: admin, conn: conn} do
325 follower = insert(:user)
328 |> put_req_header("accept", "application/json")
329 |> post("/api/pleroma/admin/users/follow", %{
330 "follower" => follower.nickname,
331 "followed" => user.nickname
334 user = User.get_cached_by_id(user.id)
335 follower = User.get_cached_by_id(follower.id)
337 assert User.following?(follower, user)
339 log_entry = Repo.one(ModerationLog)
341 assert ModerationLog.get_log_entry_message(log_entry) ==
342 "@#{admin.nickname} made @#{follower.nickname} follow @#{user.nickname}"
346 describe "/api/pleroma/admin/users/unfollow" do
347 test "allows to force-unfollow another user", %{admin: admin, conn: conn} do
349 follower = insert(:user)
351 User.follow(follower, user)
354 |> put_req_header("accept", "application/json")
355 |> post("/api/pleroma/admin/users/unfollow", %{
356 "follower" => follower.nickname,
357 "followed" => user.nickname
360 user = User.get_cached_by_id(user.id)
361 follower = User.get_cached_by_id(follower.id)
363 refute User.following?(follower, user)
365 log_entry = Repo.one(ModerationLog)
367 assert ModerationLog.get_log_entry_message(log_entry) ==
368 "@#{admin.nickname} made @#{follower.nickname} unfollow @#{user.nickname}"
372 describe "GET /api/pleroma/admin/users" do
373 test "renders users array for the first page", %{conn: conn, admin: admin} do
374 user = insert(:user, local: false, tags: ["foo", "bar"])
375 user2 = insert(:user, is_approved: false, registration_reason: "I'm a chill dude")
377 conn = get(conn, "/api/pleroma/admin/users?page=1")
384 "is_approved" => false,
385 "registration_reason" => "I'm a chill dude",
386 "actor_type" => "Person"
389 user_response(user, %{"local" => false, "tags" => ["foo", "bar"]}),
392 %{"roles" => %{"admin" => true, "moderator" => false}}
396 assert json_response(conn, 200) == %{
403 test "pagination works correctly with service users", %{conn: conn} do
404 service1 = User.get_or_create_service_actor_by_ap_id(Web.base_url() <> "/meido", "meido")
406 insert_list(25, :user)
408 assert %{"count" => 26, "page_size" => 10, "users" => users1} =
410 |> get("/api/pleroma/admin/users?page=1&filters=", %{page_size: "10"})
411 |> json_response(200)
413 assert Enum.count(users1) == 10
414 assert service1 not in users1
416 assert %{"count" => 26, "page_size" => 10, "users" => users2} =
418 |> get("/api/pleroma/admin/users?page=2&filters=", %{page_size: "10"})
419 |> json_response(200)
421 assert Enum.count(users2) == 10
422 assert service1 not in users2
424 assert %{"count" => 26, "page_size" => 10, "users" => users3} =
426 |> get("/api/pleroma/admin/users?page=3&filters=", %{page_size: "10"})
427 |> json_response(200)
429 assert Enum.count(users3) == 6
430 assert service1 not in users3
433 test "renders empty array for the second page", %{conn: conn} do
436 conn = get(conn, "/api/pleroma/admin/users?page=2")
438 assert json_response(conn, 200) == %{
445 test "regular search", %{conn: conn} do
446 user = insert(:user, nickname: "bob")
448 conn = get(conn, "/api/pleroma/admin/users?query=bo")
450 assert json_response(conn, 200) == %{
453 "users" => [user_response(user, %{"local" => true})]
457 test "search by domain", %{conn: conn} do
458 user = insert(:user, nickname: "nickname@domain.com")
461 conn = get(conn, "/api/pleroma/admin/users?query=domain.com")
463 assert json_response(conn, 200) == %{
466 "users" => [user_response(user)]
470 test "search by full nickname", %{conn: conn} do
471 user = insert(:user, nickname: "nickname@domain.com")
474 conn = get(conn, "/api/pleroma/admin/users?query=nickname@domain.com")
476 assert json_response(conn, 200) == %{
479 "users" => [user_response(user)]
483 test "search by display name", %{conn: conn} do
484 user = insert(:user, name: "Display name")
487 conn = get(conn, "/api/pleroma/admin/users?name=display")
489 assert json_response(conn, 200) == %{
492 "users" => [user_response(user)]
496 test "search by email", %{conn: conn} do
497 user = insert(:user, email: "email@example.com")
500 conn = get(conn, "/api/pleroma/admin/users?email=email@example.com")
502 assert json_response(conn, 200) == %{
505 "users" => [user_response(user)]
509 test "regular search with page size", %{conn: conn} do
510 user = insert(:user, nickname: "aalice")
511 user2 = insert(:user, nickname: "alice")
513 conn1 = get(conn, "/api/pleroma/admin/users?query=a&page_size=1&page=1")
515 assert json_response(conn1, 200) == %{
518 "users" => [user_response(user2)]
521 conn2 = get(conn, "/api/pleroma/admin/users?query=a&page_size=1&page=2")
523 assert json_response(conn2, 200) == %{
526 "users" => [user_response(user)]
530 test "only local users" do
531 admin = insert(:user, is_admin: true, nickname: "john")
532 token = insert(:oauth_admin_token, user: admin)
533 user = insert(:user, nickname: "bob")
535 insert(:user, nickname: "bobb", local: false)
539 |> assign(:user, admin)
540 |> assign(:token, token)
541 |> get("/api/pleroma/admin/users?query=bo&filters=local")
543 assert json_response(conn, 200) == %{
546 "users" => [user_response(user)]
550 test "only local users with no query", %{conn: conn, admin: old_admin} do
551 admin = insert(:user, is_admin: true, nickname: "john")
552 user = insert(:user, nickname: "bob")
554 insert(:user, nickname: "bobb", local: false)
556 conn = get(conn, "/api/pleroma/admin/users?filters=local")
560 user_response(admin, %{
561 "roles" => %{"admin" => true, "moderator" => false}
563 user_response(old_admin, %{
565 "roles" => %{"admin" => true, "moderator" => false}
569 assert json_response(conn, 200) == %{
576 test "only unconfirmed users", %{conn: conn} do
577 sad_user = insert(:user, nickname: "sadboy", is_confirmed: false)
578 old_user = insert(:user, nickname: "oldboy", is_confirmed: false)
580 insert(:user, nickname: "happyboy", is_approved: true)
581 insert(:user, is_confirmed: true)
585 |> get("/api/pleroma/admin/users?filters=unconfirmed")
586 |> json_response(200)
589 Enum.map([old_user, sad_user], fn user ->
590 user_response(user, %{
591 "is_confirmed" => false,
592 "is_approved" => true
596 assert result == %{"count" => 2, "page_size" => 50, "users" => users}
599 test "only unapproved users", %{conn: conn} do
604 registration_reason: "Plz let me in!"
607 insert(:user, nickname: "happyboy", is_approved: true)
609 conn = get(conn, "/api/pleroma/admin/users?filters=need_approval")
614 %{"is_approved" => false, "registration_reason" => "Plz let me in!"}
618 assert json_response(conn, 200) == %{
625 test "load only admins", %{conn: conn, admin: admin} do
626 second_admin = insert(:user, is_admin: true)
630 conn = get(conn, "/api/pleroma/admin/users?filters=is_admin")
633 user_response(second_admin, %{
635 "roles" => %{"admin" => true, "moderator" => false}
637 user_response(admin, %{
639 "roles" => %{"admin" => true, "moderator" => false}
643 assert json_response(conn, 200) == %{
650 test "load only moderators", %{conn: conn} do
651 moderator = insert(:user, is_moderator: true)
655 conn = get(conn, "/api/pleroma/admin/users?filters=is_moderator")
657 assert json_response(conn, 200) == %{
661 user_response(moderator, %{
663 "roles" => %{"admin" => false, "moderator" => true}
669 test "load users with actor_type is Person", %{admin: admin, conn: conn} do
670 insert(:user, actor_type: "Service")
671 insert(:user, actor_type: "Application")
673 user1 = insert(:user)
674 user2 = insert(:user)
678 |> get(user_path(conn, :list), %{actor_types: ["Person"]})
679 |> json_response(200)
682 user_response(user2),
683 user_response(user1),
684 user_response(admin, %{"roles" => %{"admin" => true, "moderator" => false}})
687 assert response == %{"count" => 3, "page_size" => 50, "users" => users}
690 test "load users with actor_type is Person and Service", %{admin: admin, conn: conn} do
691 user_service = insert(:user, actor_type: "Service")
692 insert(:user, actor_type: "Application")
694 user1 = insert(:user)
695 user2 = insert(:user)
699 |> get(user_path(conn, :list), %{actor_types: ["Person", "Service"]})
700 |> json_response(200)
703 user_response(user2),
704 user_response(user1),
705 user_response(user_service, %{"actor_type" => "Service"}),
706 user_response(admin, %{"roles" => %{"admin" => true, "moderator" => false}})
709 assert response == %{"count" => 4, "page_size" => 50, "users" => users}
712 test "load users with actor_type is Service", %{conn: conn} do
713 user_service = insert(:user, actor_type: "Service")
714 insert(:user, actor_type: "Application")
720 |> get(user_path(conn, :list), %{actor_types: ["Service"]})
721 |> json_response(200)
723 users = [user_response(user_service, %{"actor_type" => "Service"})]
725 assert response == %{"count" => 1, "page_size" => 50, "users" => users}
728 test "load users with tags list", %{conn: conn} do
729 user1 = insert(:user, tags: ["first"])
730 user2 = insert(:user, tags: ["second"])
734 conn = get(conn, "/api/pleroma/admin/users?tags[]=first&tags[]=second")
737 user_response(user2, %{"tags" => ["second"]}),
738 user_response(user1, %{"tags" => ["first"]})
741 assert json_response(conn, 200) == %{
748 test "`active` filters out users pending approval", %{token: token} do
749 insert(:user, is_approved: false)
750 %{id: user_id} = insert(:user, is_approved: true)
751 %{id: admin_id} = token.user
755 |> assign(:user, token.user)
756 |> assign(:token, token)
757 |> get("/api/pleroma/admin/users?filters=active")
766 } = json_response(conn, 200)
769 test "it works with multiple filters" do
770 admin = insert(:user, nickname: "john", is_admin: true)
771 token = insert(:oauth_admin_token, user: admin)
772 user = insert(:user, nickname: "bob", local: false, is_active: false)
774 insert(:user, nickname: "ken", local: true, is_active: false)
775 insert(:user, nickname: "bobb", local: false, is_active: true)
779 |> assign(:user, admin)
780 |> assign(:token, token)
781 |> get("/api/pleroma/admin/users?filters=deactivated,external")
783 assert json_response(conn, 200) == %{
786 "users" => [user_response(user)]
790 test "it omits relay user", %{admin: admin, conn: conn} do
791 assert %User{} = Relay.get_actor()
793 conn = get(conn, "/api/pleroma/admin/users")
795 assert json_response(conn, 200) == %{
799 user_response(admin, %{"roles" => %{"admin" => true, "moderator" => false}})
805 test "PATCH /api/pleroma/admin/users/activate", %{admin: admin, conn: conn} do
806 user_one = insert(:user, is_active: false)
807 user_two = insert(:user, is_active: false)
812 "/api/pleroma/admin/users/activate",
813 %{nicknames: [user_one.nickname, user_two.nickname]}
816 response = json_response(conn, 200)
817 assert Enum.map(response["users"], & &1["is_active"]) == [true, true]
819 log_entry = Repo.one(ModerationLog)
821 assert ModerationLog.get_log_entry_message(log_entry) ==
822 "@#{admin.nickname} activated users: @#{user_one.nickname}, @#{user_two.nickname}"
825 test "PATCH /api/pleroma/admin/users/deactivate", %{admin: admin, conn: conn} do
826 user_one = insert(:user, is_active: true)
827 user_two = insert(:user, is_active: true)
832 "/api/pleroma/admin/users/deactivate",
833 %{nicknames: [user_one.nickname, user_two.nickname]}
836 response = json_response(conn, 200)
837 assert Enum.map(response["users"], & &1["is_active"]) == [false, false]
839 log_entry = Repo.one(ModerationLog)
841 assert ModerationLog.get_log_entry_message(log_entry) ==
842 "@#{admin.nickname} deactivated users: @#{user_one.nickname}, @#{user_two.nickname}"
845 test "PATCH /api/pleroma/admin/users/approve", %{admin: admin, conn: conn} do
846 user_one = insert(:user, is_approved: false)
847 user_two = insert(:user, is_approved: false)
852 "/api/pleroma/admin/users/approve",
853 %{nicknames: [user_one.nickname, user_two.nickname]}
856 response = json_response(conn, 200)
857 assert Enum.map(response["users"], & &1["is_approved"]) == [true, true]
859 log_entry = Repo.one(ModerationLog)
861 assert ModerationLog.get_log_entry_message(log_entry) ==
862 "@#{admin.nickname} approved users: @#{user_one.nickname}, @#{user_two.nickname}"
865 test "PATCH /api/pleroma/admin/users/:nickname/toggle_activation", %{admin: admin, conn: conn} do
868 conn = patch(conn, "/api/pleroma/admin/users/#{user.nickname}/toggle_activation")
870 assert json_response(conn, 200) ==
873 %{"is_active" => !user.is_active}
876 log_entry = Repo.one(ModerationLog)
878 assert ModerationLog.get_log_entry_message(log_entry) ==
879 "@#{admin.nickname} deactivated users: @#{user.nickname}"
882 defp user_response(user, attrs \\ %{}) do
884 "is_active" => user.is_active,
886 "email" => user.email,
887 "nickname" => user.nickname,
888 "roles" => %{"admin" => false, "moderator" => false},
889 "local" => user.local,
891 "avatar" => User.avatar_url(user) |> MediaProxy.url(),
892 "display_name" => HTML.strip_tags(user.name || user.nickname),
893 "is_confirmed" => true,
894 "is_approved" => true,
896 "registration_reason" => nil,
897 "actor_type" => "Person"