mattermost/server/enterprise/message_export/shared/shared_test.go

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.enterprise for license information.

package shared

import (
	"testing"
	"time"

	"github.com/stretchr/testify/assert"

	"github.com/mattermost/mattermost/server/public/model"
)

func TestGetJoinsAndLeavesForChannel(t *testing.T) {
	channel := MetadataChannel{
		StartTime:          100,
		EndTime:            200,
		ChannelId:          "good-request-1",
		TeamId:             model.NewPointer("test"),
		TeamName:           model.NewPointer("test"),
		TeamDisplayName:    model.NewPointer("test"),
		ChannelName:        "test",
		ChannelDisplayName: "test",
		ChannelType:        "O",
	}

	tt := []struct {
		name           string
		channel        MetadataChannel
		membersHistory []*model.ChannelMemberHistoryResult
		usersInPosts   map[string]ChannelMember
		expectedJoins  int
		expectedLeaves int
	}{
		{
			name:           "no-joins-no-leaves",
			channel:        channel,
			membersHistory: nil,
			usersInPosts:   nil,
			expectedJoins:  0,
			expectedLeaves: 0,
		},
		{
			name:    "joins-and-leaves-outside-the-range",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 1, LeaveTime: model.NewPointer(int64(10)), UserId: "test", UserEmail: "test", Username: "test"},
				{JoinTime: 250, LeaveTime: model.NewPointer(int64(260)), UserId: "test", UserEmail: "test", Username: "test"},
				{JoinTime: 300, UserId: "test", UserEmail: "test", Username: "test"},
			},
			usersInPosts:   nil,
			expectedJoins:  0,
			expectedLeaves: 0,
		},
		{
			name:    "join-and-leave-during-the-range",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 100, LeaveTime: model.NewPointer(int64(150)), UserId: "test", UserEmail: "test", Username: "test"},
			},
			usersInPosts:   nil,
			expectedJoins:  1,
			expectedLeaves: 1,
		},
		{
			name:    "join-during-and-leave-after-the-range",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 150, LeaveTime: model.NewPointer(int64(300)), UserId: "test", UserEmail: "test", Username: "test"},
			},
			usersInPosts:   nil,
			expectedJoins:  1,
			expectedLeaves: 0,
		},
		{
			name:    "join-before-and-leave-during-the-range",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 99, LeaveTime: model.NewPointer(int64(150)), UserId: "test", UserEmail: "test", Username: "test"},
			},
			usersInPosts:   nil,
			expectedJoins:  1,
			expectedLeaves: 1,
		},
		{
			name:    "join-before-and-leave-after-the-range",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 99, LeaveTime: model.NewPointer(int64(350)), UserId: "test", UserEmail: "test", Username: "test"},
			},
			usersInPosts:   nil,
			expectedJoins:  1,
			expectedLeaves: 0,
		},
		{
			name:           "implicit-joins",
			channel:        channel,
			membersHistory: nil,
			usersInPosts: map[string]ChannelMember{
				"test1": {UserId: "test1", Email: "test1", Username: "test1"},
				"test2": {UserId: "test2", Email: "test2", Username: "test2"},
			},
			expectedJoins:  2,
			expectedLeaves: 0,
		},
		{
			name:    "implicit-joins-with-explicit-joins",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test1", UserEmail: "test1", Username: "test1"},
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test3", UserEmail: "test3", Username: "test3"},
			},
			usersInPosts: map[string]ChannelMember{
				"test1": {UserId: "test1", Email: "test1", Username: "test1"},
				"test2": {UserId: "test2", Email: "test2", Username: "test2"},
			},
			expectedJoins:  3,
			expectedLeaves: 2,
		},
		{
			name:    "join-leave-and-join-again",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test1", UserEmail: "test1", Username: "test1"},
				{JoinTime: 160, LeaveTime: model.NewPointer(int64(180)), UserId: "test1", UserEmail: "test1", Username: "test1"},
			},
			usersInPosts:   nil,
			expectedJoins:  2,
			expectedLeaves: 2,
		},
		{
			name:    "deactivated-members-dont-show",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 50},
				{JoinTime: 160, LeaveTime: model.NewPointer(int64(180)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 50},
			},
			usersInPosts:   nil,
			expectedJoins:  0,
			expectedLeaves: 0,
		},
		{
			name:    "deactivated-members-show-if-deleted-after-latest-export",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 150},
				{JoinTime: 160, LeaveTime: model.NewPointer(int64(180)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 150},
			},
			usersInPosts:   nil,
			expectedJoins:  2,
			expectedLeaves: 2,
		},
		{
			name:    "deactivated-members-show-and-dont-show",
			channel: channel,
			membersHistory: []*model.ChannelMemberHistoryResult{
				{JoinTime: 130, LeaveTime: model.NewPointer(int64(150)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 50},
				{JoinTime: 160, LeaveTime: model.NewPointer(int64(180)), UserId: "test1", UserEmail: "test1", Username: "test1", UserDeleteAt: 150},
			},
			usersInPosts:   nil,
			expectedJoins:  1,
			expectedLeaves: 1,
		},
	}

	for _, tc := range tt {
		t.Run(tc.name, func(t *testing.T) {
			joins, leaves := GetJoinsAndLeavesForChannel(tc.channel.StartTime, tc.channel.EndTime, tc.membersHistory, tc.usersInPosts)
			assert.Len(t, joins, tc.expectedJoins)
			assert.Len(t, leaves, tc.expectedLeaves)
		})
	}
}

func Test_GetBatchPath(t *testing.T) {
	tests := []struct {
		name             string
		exportDir        string
		prevPostUpdateAt int64
		lastPostUpdateAt int64
		batchNumber      int
		want             string
	}{
		{
			name:             "all args given",
			exportDir:        "/export/test_dir",
			prevPostUpdateAt: 123,
			lastPostUpdateAt: 456,
			batchNumber:      21,
			want:             "/export/test_dir/batch021-123-456.zip",
		},
		{
			name:             "exportDir blank",
			exportDir:        "",
			prevPostUpdateAt: 12345,
			lastPostUpdateAt: 456789,
			batchNumber:      921,
			want:             model.ComplianceExportPath + "/" + time.Now().Format(model.ComplianceExportDirectoryFormat) + "/batch921-12345-456789.zip",
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			assert.Equalf(t, tt.want, GetBatchPath(tt.exportDir, tt.prevPostUpdateAt, tt.lastPostUpdateAt, tt.batchNumber), "GetBatchPath(%v, %v, %v, %v)", tt.exportDir, tt.prevPostUpdateAt, tt.lastPostUpdateAt, tt.batchNumber)
		})
	}
}

func TestJobDataToStringMap_and_StringMapToJobData(t *testing.T) {
	jd := JobData{
		JobDataExported: JobDataExported{
			ExportType:              "cli_message_export",
			ExportDir:               "/here/there/34234-123",
			BatchStartTime:          45,
			BatchStartId:            "34arsitenaorsten",
			JobStartTime:            99,
			JobEndTime:              1234,
			JobStartId:              "99abcdef34",
			BatchSize:               2000,
			ChannelBatchSize:        30000,
			ChannelHistoryBatchSize: 30,
			BatchNumber:             4,
			TotalPostsExpected:      999999,
			MessagesExported:        343499,
			WarningCount:            39,
		},
		ExportPeriodStartTime: 123456,                  // not exported
		BatchEndTime:          999999999,               // not exported
		BatchPath:             "/another/path/123-123", // not exported
	}

	strMap := JobDataToStringMap(jd)

	expected := make(map[string]string)
	expected[JobDataExportType] = "cli_message_export"
	expected[JobDataExportDir] = "/here/there/34234-123"
	expected[JobDataBatchStartTime] = "45"
	expected[JobDataBatchStartId] = "34arsitenaorsten"
	expected[JobDataJobStartTime] = "99"
	expected[JobDataJobEndTime] = "1234"
	expected[JobDataJobStartId] = "99abcdef34"
	expected[JobDataBatchSize] = "2000"
	expected[JobDataChannelBatchSize] = "30000"
	expected[JobDataChannelHistoryBatchSize] = "30"
	expected[JobDataBatchNumber] = "4"
	expected[JobDataTotalPostsExpected] = "999999"
	expected[JobDataMessagesExported] = "343499"
	expected[JobDataWarningCount] = "39"
	expected[JobDataIsDownloadable] = "false"

	for k, v := range expected {
		val, ok := strMap[k]
		assert.True(t, ok)
		assert.Equal(t, v, val)
	}

	// not exported:
	for _, k := range []string{"export_period_start_time", "batch_end_time", "batch_path"} {
		_, ok := strMap[k]
		assert.False(t, ok)
	}

	// zero the fields that weren't exported:
	jd.ExportPeriodStartTime = 0
	jd.BatchEndTime = 0
	jd.BatchPath = ""

	// now convert back
	jd2, err := StringMapToJobDataWithZeroValues(strMap)
	assert.NoError(t, err)
	assert.Equal(t, jd, jd2)

	// and test bad conversion (just a couple):
	badStrMap := map[string]string{JobDataJobStartTime: "56aaa"}
	_, err = StringMapToJobDataWithZeroValues(badStrMap)
	assert.Error(t, err)
	badStrMap = map[string]string{JobDataJobEndTime: "blah blah"}
	_, err = StringMapToJobDataWithZeroValues(badStrMap)
	assert.Error(t, err)

	// test that zero values are used when not present
	emptyStrMap := make(map[string]string)
	emptyJd, err := StringMapToJobDataWithZeroValues(emptyStrMap)
	assert.NoError(t, err)
	assert.Equal(t, JobData{}, emptyJd)
}