snapshot of https://github.com/mattermost/mattermost.git (master, 2026-09-16; blobs > 131072B omitted)

server/channels/jobs/migrations/migrations_test.go

@@ -0,0 +1,105 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package migrations
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/mattermost/mattermost/server/public/model"
+	"github.com/mattermost/mattermost/server/public/shared/request"
+)
+
+func TestGetMigrationState(t *testing.T) {
+	if testing.Short() {
+		t.SkipNow()
+	}
+	store := Setup(t)
+	ctx := request.TestContext(t)
+
+	migrationKey := model.NewId()
+
+	deleteAllJobsByTypeAndMigrationKey(t, store, model.JobTypeMigrations, migrationKey)
+
+	// Test with no job yet.
+	state, job, err := GetMigrationState(ctx, migrationKey, store)
+	assert.Nil(t, err)
+	assert.Nil(t, job)
+	assert.Equal(t, "unscheduled", state)
+
+	// Test with the system table showing the migration as done.
+	system := model.System{
+		Name:  migrationKey,
+		Value: "true",
+	}
+	nErr := store.System().Save(&system)
+	assert.NoError(t, nErr)
+
+	state, job, err = GetMigrationState(ctx, migrationKey, store)
+	assert.Nil(t, err)
+	assert.Nil(t, job)
+	assert.Equal(t, "completed", state)
+
+	_, nErr = store.System().PermanentDeleteByName(migrationKey)
+	assert.NoError(t, nErr)
+
+	// Test with a job scheduled in "pending" state.
+	j1 := &model.Job{
+		Id:       model.NewId(),
+		CreateAt: model.GetMillis(),
+		Data: map[string]string{
+			JobDataKeyMigration: migrationKey,
+		},
+		Status: model.JobStatusPending,
+		Type:   model.JobTypeMigrations,
+	}
+
+	j1, nErr = store.Job().Save(j1)
+	require.NoError(t, nErr)
+
+	state, job, err = GetMigrationState(ctx, migrationKey, store)
+	assert.Nil(t, err)
+	assert.Equal(t, j1.Id, job.Id)
+	assert.Equal(t, "in_progress", state)
+
+	// Test with a job scheduled in "in progress" state.
+	j2 := &model.Job{
+		Id:       model.NewId(),
+		CreateAt: j1.CreateAt + 1,
+		Data: map[string]string{
+			JobDataKeyMigration: migrationKey,
+		},
+		Status: model.JobStatusInProgress,
+		Type:   model.JobTypeMigrations,
+	}
+
+	j2, nErr = store.Job().Save(j2)
+	require.NoError(t, nErr)
+
+	state, job, err = GetMigrationState(ctx, migrationKey, store)
+	assert.Nil(t, err)
+	assert.Equal(t, j2.Id, job.Id)
+	assert.Equal(t, "in_progress", state)
+
+	// Test with a job scheduled in "error" state.
+	j3 := &model.Job{
+		Id:       model.NewId(),
+		CreateAt: j2.CreateAt + 1,
+		Data: map[string]string{
+			JobDataKeyMigration: migrationKey,
+		},
+		Status: model.JobStatusError,
+		Type:   model.JobTypeMigrations,
+	}
+
+	j3, nErr = store.Job().Save(j3)
+	require.NoError(t, nErr)
+
+	state, job, err = GetMigrationState(ctx, migrationKey, store)
+	assert.Nil(t, err)
+	assert.Equal(t, j3.Id, job.Id)
+	assert.Equal(t, "unscheduled", state)
+}