Files
vikunja/pkg/models/kanban_task_bucket_test.go
kolaente a7086e5e49 fix: prevent session leaks and visibility issues in model tests
Two categories of fixes:

1. Use defer s.Close() instead of explicit s.Close() to prevent session
   leaks when require.FailNow() triggers runtime.Goexit(), which skips
   explicit close calls but runs deferred functions. Leaked sessions
   hold SQLite write locks that block all subsequent fixture loading.

2. Add s.Commit() before db.AssertExists/db.AssertMissing calls. These
   assertion helpers query via the global engine (not the test session),
   so they cannot see uncommitted data from the session's transaction.

For block-scoped sessions (kanban_task_bucket_test.go), wrap each block
in an anonymous function so defer runs at block boundary rather than
deferring to the enclosing test function.
2026-02-25 11:03:02 +01:00

240 lines
6.7 KiB
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 models
import (
"testing"
"time"
"code.vikunja.io/api/pkg/db"
"code.vikunja.io/api/pkg/user"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestTaskBucket_Update(t *testing.T) {
u := &user.User{ID: 1}
t.Run("full bucket", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 1,
BucketID: 2, // Bucket 2 already has 3 tasks and a limit of 3
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
err := tb.Update(s, u)
require.Error(t, err)
assert.True(t, IsErrBucketLimitExceeded(err))
})
t.Run("full bucket but not changing the bucket", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 4,
BucketID: 2, // Bucket 2 already has 3 tasks and a limit of 3
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
err := tb.Update(s, u)
require.NoError(t, err)
})
t.Run("bucket on other project view", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 1,
BucketID: 4, // Bucket 4 belongs to project 2
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
err := tb.Update(s, u)
require.Error(t, err)
assert.True(t, IsErrBucketDoesNotBelongToProject(err))
})
t.Run("moving a task to the done bucket", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 1,
BucketID: 3, // Bucket 3 is the done bucket
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
err := tb.Update(s, u)
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
assert.True(t, tb.Task.Done)
db.AssertExists(t, "tasks", map[string]interface{}{
"id": 1,
"done": true,
}, false)
db.AssertExists(t, "task_buckets", map[string]interface{}{
"task_id": 1,
"bucket_id": 3,
}, false)
})
t.Run("move done task out of done bucket", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 2,
BucketID: 1, // Bucket 1 is the default bucket
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
err := tb.Update(s, u)
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
assert.False(t, tb.Task.Done)
db.AssertExists(t, "tasks", map[string]interface{}{
"id": tb.TaskID,
"done": false,
}, false)
db.AssertExists(t, "task_buckets", map[string]interface{}{
"task_id": tb.TaskID,
"bucket_id": 1,
}, false)
db.AssertMissing(t, "task_buckets", map[string]interface{}{
"task_id": tb.TaskID,
"bucket_id": 3,
})
})
t.Run("moving a repeating task to the done bucket", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
s := db.NewSession()
defer s.Close()
tb := &TaskBucket{
TaskID: 28,
BucketID: 3, // Bucket 3 is the done bucket
ProjectViewID: 4,
ProjectID: 1, // In actual web requests set via the url
}
// Before running the TaskBucket Update we retrieve the task and execute
// an updateDone to obtain the task with updated start/end/due dates
// This way we can later match them with what happens after running TaskBucket Update
u := &user.User{ID: 1}
oldTask := &Task{ID: tb.TaskID}
err := oldTask.ReadOne(s, u)
require.NoError(t, err)
updatedTask := &Task{ID: tb.TaskID}
err = updatedTask.ReadOne(s, u)
require.NoError(t, err)
updatedTask.Done = true
updateDone(oldTask, updatedTask) // updatedTask now contains the updated dates
err = tb.Update(s, u)
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
assert.False(t, tb.Task.Done)
assert.Equal(t, int64(1), tb.BucketID) // This should be the actual bucket
db.AssertExists(t, "tasks", map[string]interface{}{
"id": 1,
"done": false,
}, false)
db.AssertExists(t, "task_buckets", map[string]interface{}{
"task_id": 1,
"bucket_id": 1,
}, false)
assert.Equal(t, updatedTask.DueDate.Unix(), tb.Task.DueDate.Unix())
assert.Equal(t, updatedTask.StartDate.Unix(), tb.Task.StartDate.Unix())
assert.Equal(t, updatedTask.EndDate.Unix(), tb.Task.EndDate.Unix())
})
t.Run("keep done timestamp when moving task between projects", func(t *testing.T) {
db.LoadAndAssertFixtures(t)
u := &user.User{ID: 1}
doneAt := time.Now().Round(time.Second)
// Set a done timestamp on the task
func() {
s := db.NewSession()
defer s.Close()
_, err := s.ID(2).Cols("done_at").Update(&Task{DoneAt: doneAt})
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
}()
// Move the task to another project without a done bucket using Task.Update
func() {
s := db.NewSession()
defer s.Close()
task := &Task{ID: 2, Done: true, ProjectID: 9}
err := task.Update(s, u)
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
}()
// Verify the task still has the same done timestamp
func() {
s := db.NewSession()
defer s.Close()
var task Task
_, err := s.ID(2).Get(&task)
require.NoError(t, err)
assert.True(t, task.Done)
assert.WithinDuration(t, doneAt, task.DoneAt, time.Second)
}()
// Move the task back to the original project with a done bucket using Task.Update
func() {
s := db.NewSession()
defer s.Close()
task := &Task{ID: 2, Done: true, ProjectID: 1}
err := task.Update(s, u)
require.NoError(t, err)
err = s.Commit()
require.NoError(t, err)
}()
// Verify the done timestamp is still preserved
func() {
s := db.NewSession()
defer s.Close()
var task Task
_, err := s.ID(2).Get(&task)
require.NoError(t, err)
assert.True(t, task.Done)
assert.WithinDuration(t, doneAt, task.DoneAt, time.Second)
}()
})
}