vikunja/pkg/webtests/huma_admin_actions_test.go

// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

package webtests

import (
	"net/http"
	"testing"
	"time"

	"code.vikunja.io/api/pkg/config"
	"code.vikunja.io/api/pkg/db"
	"code.vikunja.io/api/pkg/events"
	"code.vikunja.io/api/pkg/license"
	"code.vikunja.io/api/pkg/models"
	"code.vikunja.io/api/pkg/notifications"
	"code.vikunja.io/api/pkg/user"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

// Gate behaviour (404 on non-admin/unlicensed, 401 unauthenticated) is shared by
// every /api/v2/admin route; covered once here against the overview endpoint.
func TestHumaAdminOverview(t *testing.T) {
	t.Run("non-admin user gets 404", func(t *testing.T) {
		e, err := setupTestEnv()
		require.NoError(t, err)
		license.SetForTests([]license.Feature{license.FeatureAdminPanel})
		defer license.ResetForTests()

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByID(s, 1)
		require.NoError(t, err)
		require.False(t, u.IsAdmin, "fixture precondition: user1 is not an admin")

		res := adminReq(t, e, http.MethodGet, "/api/v2/admin/overview", u, "")
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("admin without the feature gets 404", func(t *testing.T) {
		e, err := setupTestEnv()
		require.NoError(t, err)
		license.SetForTests([]license.Feature{})
		defer license.ResetForTests()

		admin := promoteToAdmin(t, 1)

		res := adminReq(t, e, http.MethodGet, "/api/v2/admin/overview", admin, "")
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("unauthenticated caller gets 401", func(t *testing.T) {
		e, err := setupTestEnv()
		require.NoError(t, err)
		license.SetForTests([]license.Feature{license.FeatureAdminPanel})
		defer license.ResetForTests()

		res := adminReq(t, e, http.MethodGet, "/api/v2/admin/overview", nil, "")
		assert.Equal(t, http.StatusUnauthorized, res.Code)
	})

	t.Run("admin with the feature sees the overview", func(t *testing.T) {
		e, err := setupTestEnv()
		require.NoError(t, err)
		license.SetForTests([]license.Feature{license.FeatureAdminPanel})
		defer license.ResetForTests()

		admin := promoteToAdmin(t, 1)
		res := adminReq(t, e, http.MethodGet, "/api/v2/admin/overview", admin, "")
		require.Equal(t, http.StatusOK, res.Code, res.Body.String())
		body := res.Body.String()
		assert.Contains(t, body, `"users"`)
		assert.Contains(t, body, `"projects"`)
		assert.Contains(t, body, `"tasks"`)
		assert.Contains(t, body, `"shares"`)
		assert.Contains(t, body, `"license"`)
		assert.Contains(t, body, `"licensed":true`)
		assert.Contains(t, body, `"instance_id"`)
	})
}

func TestHumaAdminCreateUser(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	// Admin endpoint must bypass the public-registration toggle.
	prev := config.ServiceEnableRegistration.GetBool()
	config.ServiceEnableRegistration.Set(false)
	defer config.ServiceEnableRegistration.Set(prev)

	admin := promoteToAdmin(t, 1)

	t.Run("creates a plain user and returns 201", func(t *testing.T) {
		events.ClearDispatchedEvents()
		body := `{"username":"v2adm-create-1","password":"averyl0ngpassword","email":"v2adm-create-1@example.com"}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", admin, body)
		assert.Equal(t, http.StatusCreated, res.Code, res.Body.String())
		assert.Contains(t, res.Body.String(), `"username":"v2adm-create-1"`)
		// Regression: the handler used to drop the pending queue, so admin-created
		// users never fired user.created.
		events.AssertDispatched(t, &user.CreatedEvent{})
	})

	t.Run("creates an is_admin user", func(t *testing.T) {
		body := `{"username":"v2adm-create-2","password":"averyl0ngpassword","email":"v2adm-create-2@example.com","is_admin":true}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", admin, body)
		require.Equal(t, http.StatusCreated, res.Code, res.Body.String())

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByUsername(s, "v2adm-create-2")
		require.NoError(t, err)
		assert.True(t, u.IsAdmin, "new user should have been promoted")
	})

	t.Run("skip_email_confirm forces Status=Active", func(t *testing.T) {
		body := `{"username":"v2adm-create-3","password":"averyl0ngpassword","email":"v2adm-create-3@example.com","skip_email_confirm":true}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", admin, body)
		require.Equal(t, http.StatusCreated, res.Code, res.Body.String())

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByUsername(s, "v2adm-create-3")
		require.NoError(t, err)
		assert.Equal(t, user.StatusActive, u.Status)
	})

	t.Run("persists the name field", func(t *testing.T) {
		body := `{"username":"v2adm-create-4","password":"averyl0ngpassword","email":"v2adm-create-4@example.com","name":"Adm Create"}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", admin, body)
		require.Equal(t, http.StatusCreated, res.Code, res.Body.String())

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByUsername(s, "v2adm-create-4")
		require.NoError(t, err)
		assert.Equal(t, "Adm Create", u.Name)
	})

	t.Run("rejects an invalid body with 422", func(t *testing.T) {
		// Password below the 8-char minimum fails govalidator before the create.
		body := `{"username":"v2adm-invalid","password":"short","email":"v2adm-invalid@example.com"}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", admin, body)
		assert.Equal(t, http.StatusUnprocessableEntity, res.Code, res.Body.String())
	})

	t.Run("non-admin caller gets 404", func(t *testing.T) {
		s := db.NewSession()
		u2, err := user.GetUserByID(s, 2)
		require.NoError(t, err)
		require.False(t, u2.IsAdmin, "fixture precondition: user2 is not an admin")
		s.Close()

		body := `{"username":"v2nonadmin","password":"averyl0ngpassword","email":"v2nonadmin@example.com"}`
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users", u2, body)
		assert.Equal(t, http.StatusNotFound, res.Code)
	})
}

func TestHumaAdminPatchAdmin(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	t.Run("promote a non-admin user", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/admin", admin, `{"is_admin":true}`)
		assert.Equal(t, http.StatusOK, res.Code, res.Body.String())

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByID(s, 2)
		require.NoError(t, err)
		assert.True(t, u.IsAdmin)
	})

	t.Run("demote when another admin exists is allowed", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/admin", admin, `{"is_admin":false}`)
		assert.Equal(t, http.StatusOK, res.Code)

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByID(s, 2)
		require.NoError(t, err)
		assert.False(t, u.IsAdmin)
	})

	t.Run("last-admin guard refuses demotion with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/1/admin", admin, `{"is_admin":false}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByID(s, 1)
		require.NoError(t, err)
		assert.True(t, u.IsAdmin, "last admin must remain admin after refused demotion")
	})

	t.Run("unknown user returns 404", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/9999999/admin", admin, `{"is_admin":true}`)
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("omitted is_admin is rejected rather than demoting", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/admin", admin, `{"is_admin":true}`)
		require.Equal(t, http.StatusOK, res.Code)

		res = adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/admin", admin, `{}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)

		s := db.NewSession()
		defer s.Close()
		u, err := user.GetUserByID(s, 2)
		require.NoError(t, err)
		assert.True(t, u.IsAdmin, "omitted is_admin must not silently demote")
	})
}

func TestHumaAdminPatchStatus(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/status", admin, `{"status":2}`)
	assert.Equal(t, http.StatusOK, res.Code, res.Body.String())

	// GetUserByID refuses disabled accounts, so assert against the raw row.
	s := db.NewSession()
	defer s.Close()
	var row struct {
		Status int `xorm:"status"`
	}
	_, err = s.Table("users").Where("id = ?", 2).Get(&row)
	require.NoError(t, err)
	assert.Equal(t, 2, row.Status)

	t.Run("last-admin guard refuses self-disable with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/1/status", admin, `{"status":2}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)

		var row struct {
			Status int `xorm:"status"`
		}
		_, err := s.Table("users").Where("id = ?", 1).Get(&row)
		require.NoError(t, err)
		assert.Equal(t, int(user.StatusActive), row.Status, "last admin must stay active after refused disable")
	})

	t.Run("rejects invalid status value with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/status", admin, `{"status":99}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)
		assert.Contains(t, res.Body.String(), "invalid status")
	})

	t.Run("omitted status is rejected rather than reactivating", func(t *testing.T) {
		// User 2 was disabled above; an empty body must leave that intact.
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/status", admin, `{}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)

		var row struct {
			Status int `xorm:"status"`
		}
		_, err := s.Table("users").Where("id = ?", 2).Get(&row)
		require.NoError(t, err)
		assert.Equal(t, int(user.StatusDisabled), row.Status, "omitted status must not silently reactivate")
	})
}

func passwordHashOf(t *testing.T, userID int64) string {
	s := db.NewSession()
	defer s.Close()
	var row struct {
		Password string `xorm:"password"`
	}
	has, err := s.Table("users").Where("id = ?", userID).Get(&row)
	require.NoError(t, err)
	require.True(t, has)
	return row.Password
}

func TestHumaAdminSetPassword(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	t.Run("sets a new password and invalidates sessions", func(t *testing.T) {
		oldHash := passwordHashOf(t, 2)

		s := db.NewSession()
		_, err := s.Insert(&models.Session{ID: "adm-pw-session", UserID: 2, TokenHash: "adm-pw-hash", LastActive: time.Now()})
		require.NoError(t, err)
		require.NoError(t, s.Commit())
		s.Close()

		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/2/password", admin, `{"new_password":"averyl0ngpassword"}`)
		require.Equal(t, http.StatusOK, res.Code, res.Body.String())

		newHash := passwordHashOf(t, 2)
		assert.NotEqual(t, oldHash, newHash)
		require.NoError(t, user.CheckUserPassword(&user.User{Password: newHash}, "averyl0ngpassword"))

		s2 := db.NewSession()
		defer s2.Close()
		count, err := s2.Where("user_id = ?", 2).Count(&models.Session{})
		require.NoError(t, err)
		assert.Zero(t, count, "all sessions must be invalidated after an admin password reset")
	})

	t.Run("non-local account gets 412", func(t *testing.T) {
		// Fixture user 14 is an OIDC account.
		oldHash := passwordHashOf(t, 14)

		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/14/password", admin, `{"new_password":"averyl0ngpassword"}`)
		assert.Equal(t, http.StatusPreconditionFailed, res.Code, res.Body.String())
		assert.Equal(t, oldHash, passwordHashOf(t, 14), "refused reset must not change the hash")
	})

	t.Run("rejects a too-short password with 422", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/4/password", admin, `{"new_password":"short"}`)
		assert.Equal(t, http.StatusUnprocessableEntity, res.Code, res.Body.String())
	})

	t.Run("unknown user returns 404", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/9999999/password", admin, `{"new_password":"averyl0ngpassword"}`)
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("notifies the user when the mailer is enabled", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)
		notifications.Fake()
		defer notifications.Unfake()

		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/users/4/password", admin, `{"new_password":"averyl0ngpassword"}`)
		require.Equal(t, http.StatusOK, res.Code, res.Body.String())
		notifications.AssertSent(t, &user.PasswordChangedNotification{})
	})
}

func TestHumaAdminPasswordResetEmail(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	countResetTokens := func(t *testing.T, userID int64) int64 {
		s := db.NewSession()
		defer s.Close()
		count, err := s.Table("user_tokens").Where("user_id = ? AND kind = ?", userID, user.TokenPasswordReset).Count()
		require.NoError(t, err)
		return count
	}

	t.Run("mailer disabled gets 412 and writes no token", func(t *testing.T) {
		config.MailerEnabled.Set(false)

		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/2/password-reset-email", admin, "")
		assert.Equal(t, http.StatusPreconditionFailed, res.Code, res.Body.String())
		assert.Zero(t, countResetTokens(t, 2))
	})

	t.Run("sends the reset email", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)
		notifications.Fake()
		defer notifications.Unfake()

		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/2/password-reset-email", admin, "")
		require.Equal(t, http.StatusOK, res.Code, res.Body.String())
		assert.Equal(t, int64(1), countResetTokens(t, 2))
		notifications.AssertSent(t, &user.ResetPasswordNotification{})
	})

	t.Run("non-local account gets 412 and writes no token", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)

		// Fixture user 14 is an OIDC account.
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/14/password-reset-email", admin, "")
		assert.Equal(t, http.StatusPreconditionFailed, res.Code, res.Body.String())
		assert.Zero(t, countResetTokens(t, 14))
	})

	t.Run("disabled account gets 412 and writes no token", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)

		// Fixture user 17 is disabled; ShouldNotify would silently drop the email.
		// It already carries a fixture reset token, so assert no NEW one appears.
		before := countResetTokens(t, 17)
		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/17/password-reset-email", admin, "")
		assert.Equal(t, http.StatusPreconditionFailed, res.Code, res.Body.String())
		assert.Equal(t, before, countResetTokens(t, 17))
	})

	t.Run("bot account gets 400 and writes no token", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)

		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/23/password-reset-email", admin, "")
		assert.Equal(t, http.StatusBadRequest, res.Code, res.Body.String())
		assert.Zero(t, countResetTokens(t, 23))
	})

	t.Run("unknown user returns 404", func(t *testing.T) {
		config.MailerEnabled.Set(true)
		defer config.MailerEnabled.Set(false)

		res := adminReq(t, e, http.MethodPost, "/api/v2/admin/users/9999999/password-reset-email", admin, "")
		assert.Equal(t, http.StatusNotFound, res.Code)
	})
}

func TestHumaAdminDeleteUser(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	t.Run("mode=now deletes a regular user immediately with 204", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/15?mode=now", admin, "")
		assert.Equal(t, http.StatusNoContent, res.Code)

		s := db.NewSession()
		defer s.Close()
		_, err := user.GetUserByID(s, 15)
		assert.Error(t, err, "deleted user must no longer be fetchable")
	})

	t.Run("mode=scheduled keeps the user row", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/16?mode=scheduled", admin, "")
		assert.Equal(t, http.StatusNoContent, res.Code)

		s := db.NewSession()
		defer s.Close()
		u := &user.User{ID: 16}
		has, err := s.Get(u)
		require.NoError(t, err)
		assert.True(t, has, "scheduled deletion must not remove the user row")
	})

	t.Run("default (no mode) is scheduled", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/2", admin, "")
		assert.Equal(t, http.StatusNoContent, res.Code)

		s := db.NewSession()
		defer s.Close()
		u := &user.User{ID: 2}
		has, err := s.Get(u)
		require.NoError(t, err)
		assert.True(t, has, "default mode must not remove the user row")
	})

	t.Run("rejects invalid mode with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/3?mode=bogus", admin, "")
		assert.Equal(t, http.StatusBadRequest, res.Code)
	})

	t.Run("mode=now last-admin guard refuses self-delete with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/1?mode=now", admin, "")
		assert.Equal(t, http.StatusBadRequest, res.Code)
	})

	t.Run("unknown user returns 404", func(t *testing.T) {
		res := adminReq(t, e, http.MethodDelete, "/api/v2/admin/users/9999999?mode=now", admin, "")
		assert.Equal(t, http.StatusNotFound, res.Code)
	})
}

func TestHumaAdminReassignProjectOwner(t *testing.T) {
	e, err := setupTestEnv()
	require.NoError(t, err)
	license.SetForTests([]license.Feature{license.FeatureAdminPanel})
	defer license.ResetForTests()

	admin := promoteToAdmin(t, 1)

	t.Run("updates owner_id", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/2/owner", admin, `{"owner_id":2}`)
		assert.Equal(t, http.StatusOK, res.Code, res.Body.String())

		s := db.NewSession()
		defer s.Close()
		var row struct {
			OwnerID int64 `xorm:"owner_id"`
		}
		_, err := s.Table("projects").Where("id = ?", 2).Get(&row)
		require.NoError(t, err)
		assert.Equal(t, int64(2), row.OwnerID)
	})

	t.Run("rejects nonexistent owner with 404", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/2/owner", admin, `{"owner_id":99999}`)
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("nonexistent project returns 404", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/99999/owner", admin, `{"owner_id":1}`)
		assert.Equal(t, http.StatusNotFound, res.Code)
	})

	t.Run("rejects disabled user as new owner with 412", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/2/owner", admin, `{"owner_id":17}`)
		assert.Equal(t, http.StatusPreconditionFailed, res.Code)
	})

	t.Run("rejects locked user as new owner with 412", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/2/owner", admin, `{"owner_id":18}`)
		assert.Equal(t, http.StatusPreconditionFailed, res.Code)
	})

	t.Run("rejects deletion-scheduled user as new owner with 400", func(t *testing.T) {
		res := adminReq(t, e, http.MethodPatch, "/api/v2/admin/projects/2/owner", admin, `{"owner_id":20}`)
		assert.Equal(t, http.StatusBadRequest, res.Code)
	})
}