vikunja-api/pkg/models/task_readall_test.go

/*
 * Copyright (c) 2018 the Vikunja Authors. All rights reserved.
 * Use of this source code is governed by a LPGLv3-style
 * license that can be found in the LICENSE file.
 */

package models

import (
	"code.vikunja.io/api/pkg/db"
	"code.vikunja.io/api/pkg/files"
	"github.com/stretchr/testify/assert"
	"gopkg.in/d4l3k/messagediff.v1"
	"sort"
	"testing"

	"code.vikunja.io/web"
)

func sortTasksForTesting(by SortBy) (tasks []*Task) {
	user1 := &User{
		ID:        1,
		Username:  "user1",
		Password:  "$2a$14$dcadBoMBL9jQoOcZK8Fju.cy0Ptx2oZECkKLnaa8ekRoTFe1w7To.",
		IsActive:  true,
		AvatarURL: "111d68d06e2d317b5a59c2c6c5bad808", // hash for ""
	}
	user2 := &User{
		ID:        2,
		Username:  "user2",
		Password:  "$2a$14$dcadBoMBL9jQoOcZK8Fju.cy0Ptx2oZECkKLnaa8ekRoTFe1w7To.",
		AvatarURL: "ab53a2911ddf9b4817ac01ddcd3d975f", // hash for ""
	}
	user6 := &User{
		ID:        6,
		Username:  "user6",
		Password:  "$2a$14$dcadBoMBL9jQoOcZK8Fju.cy0Ptx2oZECkKLnaa8ekRoTFe1w7To.",
		IsActive:  true,
		AvatarURL: "3efbe51f864c6666bc27caf4c6ff90ed", // hash for ""
	}

	tasks = []*Task{
		{
			ID:          1,
			Text:        "task #1",
			Description: "Lorem Ipsum",
			CreatedByID: 1,
			CreatedBy:   user1,
			ListID:      1,
			Labels: []*Label{
				{
					ID:          4,
					Title:       "Label #4 - visible via other task",
					CreatedByID: 2,
					CreatedBy:   user2,
					Updated:     0,
					Created:     0,
				},
			},
			RelatedTasks: map[RelationKind][]*Task{
				RelationKindSubtask: {
					{
						ID:          29,
						Text:        "task #29 with parent task (1)",
						CreatedByID: 1,
						ListID:      1,
						Created:     1543626724,
						Updated:     1543626724,
					},
				},
			},
			Attachments: []*TaskAttachment{
				{
					ID:          1,
					TaskID:      1,
					FileID:      1,
					CreatedByID: 1,
					CreatedBy:   user1,
					File: &files.File{
						ID:          1,
						Name:        "test",
						Size:        100,
						CreatedUnix: 1570998791,
						CreatedByID: 1,
					},
				},
				{
					ID:          2,
					TaskID:      1,
					FileID:      9999,
					CreatedByID: 1,
					CreatedBy:   user1,
				},
			},
			Created: 1543626724,
			Updated: 1543626724,
		},
		{
			ID:          2,
			Text:        "task #2 done",
			Done:        true,
			CreatedByID: 1,
			CreatedBy:   user1,
			ListID:      1,
			Labels: []*Label{
				{
					ID:          4,
					Title:       "Label #4 - visible via other task",
					CreatedByID: 2,
					CreatedBy:   user2,
					Updated:     0,
					Created:     0,
				},
			},
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           3,
			Text:         "task #3 high prio",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
			Priority:     100,
		},
		{
			ID:           4,
			Text:         "task #4 low prio",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
			Priority:     1,
		},
		{
			ID:           5,
			Text:         "task #5 higher due date",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
			DueDateUnix:  1543636724,
		},
		{
			ID:           6,
			Text:         "task #6 lower due date",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
			DueDateUnix:  1543616724,
		},
		{
			ID:            7,
			Text:          "task #7 with start date",
			CreatedByID:   1,
			CreatedBy:     user1,
			ListID:        1,
			RelatedTasks:  map[RelationKind][]*Task{},
			Created:       1543626724,
			Updated:       1543626724,
			StartDateUnix: 1544600000,
		},
		{
			ID:           8,
			Text:         "task #8 with end date",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
			EndDateUnix:  1544700000,
		},
		{
			ID:            9,
			Text:          "task #9 with start and end date",
			CreatedByID:   1,
			CreatedBy:     user1,
			ListID:        1,
			RelatedTasks:  map[RelationKind][]*Task{},
			Created:       1543626724,
			Updated:       1543626724,
			StartDateUnix: 1544600000,
			EndDateUnix:   1544700000,
		},
		{
			ID:           10,
			Text:         "task #10 basic",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           11,
			Text:         "task #11 basic",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           12,
			Text:         "task #12 basic",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           15,
			Text:         "task #15",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       6,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           16,
			Text:         "task #16",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       7,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           17,
			Text:         "task #17",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       8,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           18,
			Text:         "task #18",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       9,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           19,
			Text:         "task #19",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       10,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           20,
			Text:         "task #20",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       11,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           21,
			Text:         "task #21",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       12,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           22,
			Text:         "task #22",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       13,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           23,
			Text:         "task #23",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       14,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           24,
			Text:         "task #24",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       15,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           25,
			Text:         "task #25",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       16,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           26,
			Text:         "task #26",
			CreatedByID:  6,
			CreatedBy:    user6,
			ListID:       17,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:            27,
			Text:          "task #27 with reminders",
			CreatedByID:   1,
			CreatedBy:     user1,
			RemindersUnix: []int64{1543626724, 1543626824},
			ListID:        1,
			RelatedTasks:  map[RelationKind][]*Task{},
			Created:       1543626724,
			Updated:       1543626724,
		},
		{
			ID:           28,
			Text:         "task #28 with repeat after",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			RepeatAfter:  3600,
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:          29,
			Text:        "task #29 with parent task (1)",
			CreatedByID: 1,
			CreatedBy:   user1,
			ListID:      1,
			RelatedTasks: map[RelationKind][]*Task{
				RelationKindParenttask: {
					{
						ID:          1,
						Text:        "task #1",
						Description: "Lorem Ipsum",
						CreatedByID: 1,
						ListID:      1,
						Created:     1543626724,
						Updated:     1543626724,
					},
				},
			},
			Created: 1543626724,
			Updated: 1543626724,
		},
		{
			ID:          30,
			Text:        "task #30 with assignees",
			CreatedByID: 1,
			CreatedBy:   user1,
			ListID:      1,
			Assignees: []*User{
				user1,
				user2,
			},
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           31,
			Text:         "task #31 with color",
			HexColor:     "f0f0f0",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           32,
			Text:         "task #32",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       3,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
		{
			ID:           33,
			Text:         "task #33 with percent done",
			CreatedByID:  1,
			CreatedBy:    user1,
			ListID:       1,
			PercentDone:  0.5,
			RelatedTasks: map[RelationKind][]*Task{},
			Created:      1543626724,
			Updated:      1543626724,
		},
	}

	switch by {
	case SortTasksByPriorityDesc:
		sort.Slice(tasks, func(i, j int) bool {
			return tasks[i].Priority > tasks[j].Priority
		})
	case SortTasksByPriorityAsc:
		sort.Slice(tasks, func(i, j int) bool {
			return tasks[i].Priority < tasks[j].Priority
		})
	case SortTasksByDueDateDesc:
		sort.Slice(tasks, func(i, j int) bool {
			return tasks[i].DueDateUnix > tasks[j].DueDateUnix
		})
	case SortTasksByDueDateAsc:
		sort.Slice(tasks, func(i, j int) bool {
			return tasks[i].DueDateUnix < tasks[j].DueDateUnix
		})
	}

	return
}

func TestTask_ReadAll(t *testing.T) {
	assert.NoError(t, db.LoadFixtures())

	// Dummy users
	user1 := &User{
		ID:        1,
		Username:  "user1",
		Password:  "$2a$14$dcadBoMBL9jQoOcZK8Fju.cy0Ptx2oZECkKLnaa8ekRoTFe1w7To.",
		IsActive:  true,
		AvatarURL: "111d68d06e2d317b5a59c2c6c5bad808", // hash for ""
	}

	type fields struct {
		ListID            int64
		Sorting           string
		StartDateSortUnix int64
		EndDateSortUnix   int64
		Lists             []*List
		CRUDable          web.CRUDable
		Rights            web.Rights
	}
	type args struct {
		search string
		a      web.Auth
		page   int
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		want    interface{}
		wantErr bool
	}{
		{
			name:   "ReadAll Tasks normally",
			fields: fields{},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByUnsorted),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by priority (desc)",
			fields: fields{
				Sorting: "priority",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByPriorityDesc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by priority asc",
			fields: fields{
				Sorting: "priorityasc",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByPriorityAsc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by priority desc",
			fields: fields{
				Sorting: "prioritydesc",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByPriorityDesc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by due date default desc",
			fields: fields{
				Sorting: "duedate",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByDueDateDesc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by due date asc",
			fields: fields{
				Sorting: "duedateasc",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want:    sortTasksForTesting(SortTasksByDueDateAsc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks sorted by due date desc",
			fields: fields{
				Sorting: "duedatedesc",
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},

			want:    sortTasksForTesting(SortTasksByDueDateDesc),
			wantErr: false,
		},
		{
			name: "ReadAll Tasks with range",
			fields: fields{
				StartDateSortUnix: 1544500000,
				EndDateSortUnix:   1544600000,
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want: []*Task{
				{
					ID:            7,
					Text:          "task #7 with start date",
					CreatedByID:   1,
					CreatedBy:     user1,
					ListID:        1,
					RelatedTasks:  map[RelationKind][]*Task{},
					Created:       1543626724,
					Updated:       1543626724,
					StartDateUnix: 1544600000,
				},
				{
					ID:            9,
					Text:          "task #9 with start and end date",
					CreatedByID:   1,
					CreatedBy:     user1,
					ListID:        1,
					RelatedTasks:  map[RelationKind][]*Task{},
					Created:       1543626724,
					Updated:       1543626724,
					StartDateUnix: 1544600000,
					EndDateUnix:   1544700000,
				},
			},
			wantErr: false,
		},
		{
			name: "ReadAll Tasks with range",
			fields: fields{
				StartDateSortUnix: 1544700000,
				EndDateSortUnix:   1545000000,
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want: []*Task{
				{
					ID:           8,
					Text:         "task #8 with end date",
					CreatedByID:  1,
					CreatedBy:    user1,
					ListID:       1,
					RelatedTasks: map[RelationKind][]*Task{},
					Created:      1543626724,
					Updated:      1543626724,
					EndDateUnix:  1544700000,
				},
				{
					ID:            9,
					Text:          "task #9 with start and end date",
					CreatedByID:   1,
					CreatedBy:     user1,
					ListID:        1,
					RelatedTasks:  map[RelationKind][]*Task{},
					Created:       1543626724,
					Updated:       1543626724,
					StartDateUnix: 1544600000,
					EndDateUnix:   1544700000,
				},
			},
			wantErr: false,
		},
		{
			name: "ReadAll Tasks with range without end date",
			fields: fields{
				StartDateSortUnix: 1544700000,
			},
			args: args{
				search: "",
				a:      &User{ID: 1},
				page:   0,
			},
			want: []*Task{
				{
					ID:           8,
					Text:         "task #8 with end date",
					CreatedByID:  1,
					CreatedBy:    user1,
					ListID:       1,
					RelatedTasks: map[RelationKind][]*Task{},
					Created:      1543626724,
					Updated:      1543626724,
					EndDateUnix:  1544700000,
				},
				{
					ID:            9,
					Text:          "task #9 with start and end date",
					CreatedByID:   1,
					CreatedBy:     user1,
					ListID:        1,
					RelatedTasks:  map[RelationKind][]*Task{},
					Created:       1543626724,
					Updated:       1543626724,
					StartDateUnix: 1544600000,
					EndDateUnix:   1544700000,
				},
			},
			wantErr: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			lt := &TaskCollection{
				ListID:            tt.fields.ListID,
				Sorting:           tt.fields.Sorting,
				StartDateSortUnix: tt.fields.StartDateSortUnix,
				EndDateSortUnix:   tt.fields.EndDateSortUnix,
				CRUDable:          tt.fields.CRUDable,
				Rights:            tt.fields.Rights,
			}
			got, _, _, err := lt.ReadAll(tt.args.a, tt.args.search, tt.args.page, 50)
			if (err != nil) != tt.wantErr {
				t.Errorf("Test %s, Task.ReadAll() error = %v, wantErr %v", tt.name, err, tt.wantErr)
				return
			}
			if diff, equal := messagediff.PrettyDiff(got, tt.want); !equal {
				t.Errorf("Test %s, LabelTask.ReadAll() = %v, want %v, \ndiff: %v", tt.name, got, tt.want, diff)
			}
		})
	}
}