mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
e89b26e8f3
* format using `goimports -local github.com/mattermost/mattermost-server/v5 -w` * added goimports lint check to .golangci.yml * format using `goimports -local github.com/mattermost/mattermost-server/v5 -w` for a corner case * make app-layers, *-mocks and store-layers for ci check Co-authored-by: Mahmudul Haque <mahmudulhaque@protonmail.com> Co-authored-by: Mattermod <mattermod@users.noreply.github.com>
459 lines
18 KiB
Go
459 lines
18 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package api4
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/mattermost/mattermost-server/v5/model"
|
|
)
|
|
|
|
func TestCreateCategoryForTeamForUser(t *testing.T) {
|
|
th := Setup(t).InitBasic()
|
|
defer th.TearDown()
|
|
|
|
t.Run("should silently prevent the user from creating a category with an invalid channel ID", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
// Attempt to create the category
|
|
category := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: model.SidebarCategory{
|
|
UserId: user.Id,
|
|
TeamId: th.BasicTeam.Id,
|
|
DisplayName: "test",
|
|
},
|
|
Channels: []string{th.BasicChannel.Id, "notachannel", th.BasicChannel2.Id},
|
|
}
|
|
|
|
received, resp := client.CreateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, category)
|
|
require.Nil(t, resp.Error)
|
|
assert.NotContains(t, received.Channels, "notachannel")
|
|
assert.Equal(t, []string{th.BasicChannel.Id, th.BasicChannel2.Id}, received.Channels)
|
|
})
|
|
|
|
t.Run("should silently prevent the user from creating a category with a channel that they're not a member of", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
// Have another user create a channel that user isn't a part of
|
|
channel, resp := th.SystemAdminClient.CreateChannel(&model.Channel{
|
|
TeamId: th.BasicTeam.Id,
|
|
Type: model.CHANNEL_OPEN,
|
|
Name: "testchannel",
|
|
})
|
|
require.Nil(t, resp.Error)
|
|
|
|
// Attempt to create the category
|
|
category := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: model.SidebarCategory{
|
|
UserId: user.Id,
|
|
TeamId: th.BasicTeam.Id,
|
|
DisplayName: "test",
|
|
},
|
|
Channels: []string{th.BasicChannel.Id, channel.Id},
|
|
}
|
|
|
|
received, resp := client.CreateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, category)
|
|
require.Nil(t, resp.Error)
|
|
assert.NotContains(t, received.Channels, channel.Id)
|
|
assert.Equal(t, []string{th.BasicChannel.Id}, received.Channels)
|
|
})
|
|
}
|
|
|
|
func TestUpdateCategoryForTeamForUser(t *testing.T) {
|
|
th := Setup(t).InitBasic()
|
|
defer th.TearDown()
|
|
|
|
t.Run("should update the channel order of the Channels category", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
require.Len(t, channelsCategory.Channels, 5) // Town Square, Off Topic, and the 3 channels created by InitBasic
|
|
|
|
// Should return the correct values from the API
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: []string{channelsCategory.Channels[1], channelsCategory.Channels[0], channelsCategory.Channels[4], channelsCategory.Channels[3], channelsCategory.Channels[2]},
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, updatedCategory)
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.Equal(t, updatedCategory.Channels, received.Channels)
|
|
|
|
// And when requesting the category later
|
|
received, resp = client.GetSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, "")
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.Equal(t, updatedCategory.Channels, received.Channels)
|
|
})
|
|
|
|
t.Run("should update the sort order of the DM category", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
dmsCategory := categories.Categories[2]
|
|
require.Equal(t, model.SidebarCategoryDirectMessages, dmsCategory.Type)
|
|
require.Equal(t, model.SidebarCategorySortRecent, dmsCategory.Sorting)
|
|
|
|
// Should return the correct values from the API
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: dmsCategory.SidebarCategory,
|
|
Channels: dmsCategory.Channels,
|
|
}
|
|
updatedCategory.Sorting = model.SidebarCategorySortAlphabetical
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, dmsCategory.Id, updatedCategory)
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, dmsCategory.Id, received.Id)
|
|
assert.Equal(t, model.SidebarCategorySortAlphabetical, received.Sorting)
|
|
|
|
// And when requesting the category later
|
|
received, resp = client.GetSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, dmsCategory.Id, "")
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, dmsCategory.Id, received.Id)
|
|
assert.Equal(t, model.SidebarCategorySortAlphabetical, received.Sorting)
|
|
})
|
|
|
|
t.Run("should update the display name of a custom category", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
customCategory, resp := client.CreateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: model.SidebarCategory{
|
|
UserId: user.Id,
|
|
TeamId: th.BasicTeam.Id,
|
|
DisplayName: "custom123",
|
|
},
|
|
})
|
|
require.Nil(t, resp.Error)
|
|
require.Equal(t, "custom123", customCategory.DisplayName)
|
|
|
|
// Should return the correct values from the API
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: customCategory.SidebarCategory,
|
|
Channels: customCategory.Channels,
|
|
}
|
|
updatedCategory.DisplayName = "abcCustom"
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, customCategory.Id, updatedCategory)
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, customCategory.Id, received.Id)
|
|
assert.Equal(t, updatedCategory.DisplayName, received.DisplayName)
|
|
|
|
// And when requesting the category later
|
|
received, resp = client.GetSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, customCategory.Id, "")
|
|
assert.Nil(t, resp.Error)
|
|
assert.Equal(t, customCategory.Id, received.Id)
|
|
assert.Equal(t, updatedCategory.DisplayName, received.DisplayName)
|
|
})
|
|
|
|
t.Run("should update the channel order of the category even if it contains archived channels", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
require.Len(t, channelsCategory.Channels, 5) // Town Square, Off Topic, and the 3 channels created by InitBasic
|
|
|
|
// Delete one of the channels
|
|
_, resp = client.DeleteChannel(th.BasicChannel.Id)
|
|
require.Nil(t, resp.Error)
|
|
|
|
// Should still be able to reorder the channels
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: []string{channelsCategory.Channels[1], channelsCategory.Channels[0], channelsCategory.Channels[4], channelsCategory.Channels[3], channelsCategory.Channels[2]},
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, updatedCategory)
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.Equal(t, updatedCategory.Channels, received.Channels)
|
|
})
|
|
|
|
t.Run("should silently prevent the user from adding an invalid channel ID", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: append(channelsCategory.Channels, "notachannel"),
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, updatedCategory)
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.NotContains(t, received.Channels, "notachannel")
|
|
assert.Equal(t, channelsCategory.Channels, received.Channels)
|
|
})
|
|
|
|
t.Run("should silently prevent the user from adding a channel that they're not a member of", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
// Have another user create a channel that user isn't a part of
|
|
channel, resp := th.SystemAdminClient.CreateChannel(&model.Channel{
|
|
TeamId: th.BasicTeam.Id,
|
|
Type: model.CHANNEL_OPEN,
|
|
Name: "testchannel",
|
|
})
|
|
require.Nil(t, resp.Error)
|
|
|
|
// Attempt to update the category
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: append(channelsCategory.Channels, channel.Id),
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, updatedCategory)
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.NotContains(t, received.Channels, channel.Id)
|
|
assert.Equal(t, channelsCategory.Channels, received.Channels)
|
|
})
|
|
|
|
t.Run("muting a category should mute all of its channels", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
require.True(t, len(channelsCategory.Channels) > 0)
|
|
|
|
// Mute the category
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: model.SidebarCategory{
|
|
Id: channelsCategory.Id,
|
|
UserId: user.Id,
|
|
TeamId: th.BasicTeam.Id,
|
|
Sorting: channelsCategory.Sorting,
|
|
Muted: true,
|
|
},
|
|
Channels: channelsCategory.Channels,
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, updatedCategory)
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.True(t, received.Muted)
|
|
|
|
// Check that the muted category was saved in the database
|
|
received, resp = client.GetSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, channelsCategory.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received.Id)
|
|
assert.True(t, received.Muted)
|
|
|
|
// Confirm that the channels in the category were muted
|
|
member, resp := client.GetChannelMember(channelsCategory.Channels[0], user.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
assert.True(t, member.IsChannelMuted())
|
|
})
|
|
|
|
t.Run("should not be able to mute DM category", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
dmsCategory := categories.Categories[2]
|
|
require.Equal(t, model.SidebarCategoryDirectMessages, dmsCategory.Type)
|
|
require.Len(t, dmsCategory.Channels, 0)
|
|
|
|
// Ensure a DM channel exists
|
|
dmChannel, resp := client.CreateDirectChannel(user.Id, th.BasicUser.Id)
|
|
require.Nil(t, resp.Error)
|
|
|
|
// Attempt to mute the category
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: model.SidebarCategory{
|
|
Id: dmsCategory.Id,
|
|
UserId: user.Id,
|
|
TeamId: th.BasicTeam.Id,
|
|
Sorting: dmsCategory.Sorting,
|
|
Muted: true,
|
|
},
|
|
Channels: []string{dmChannel.Id},
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, dmsCategory.Id, updatedCategory)
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, dmsCategory.Id, received.Id)
|
|
assert.False(t, received.Muted)
|
|
|
|
// Check that the muted category was not saved in the database
|
|
received, resp = client.GetSidebarCategoryForTeamForUser(user.Id, th.BasicTeam.Id, dmsCategory.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, dmsCategory.Id, received.Id)
|
|
assert.False(t, received.Muted)
|
|
|
|
// Confirm that the channels in the category were not muted
|
|
member, resp := client.GetChannelMember(dmChannel.Id, user.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
assert.False(t, member.IsChannelMuted())
|
|
})
|
|
}
|
|
|
|
func TestUpdateCategoriesForTeamForUser(t *testing.T) {
|
|
th := Setup(t).InitBasic()
|
|
defer th.TearDown()
|
|
|
|
t.Run("should silently prevent the user from adding an invalid channel ID", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: append(channelsCategory.Channels, "notachannel"),
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, []*model.SidebarCategoryWithChannels{updatedCategory})
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received[0].Id)
|
|
assert.NotContains(t, received[0].Channels, "notachannel")
|
|
assert.Equal(t, channelsCategory.Channels, received[0].Channels)
|
|
})
|
|
|
|
t.Run("should silently prevent the user from adding a channel that they're not a member of", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
// Have another user create a channel that user isn't a part of
|
|
channel, resp := th.SystemAdminClient.CreateChannel(&model.Channel{
|
|
TeamId: th.BasicTeam.Id,
|
|
Type: model.CHANNEL_OPEN,
|
|
Name: "testchannel",
|
|
})
|
|
require.Nil(t, resp.Error)
|
|
|
|
// Attempt to update the category
|
|
updatedCategory := &model.SidebarCategoryWithChannels{
|
|
SidebarCategory: channelsCategory.SidebarCategory,
|
|
Channels: append(channelsCategory.Channels, channel.Id),
|
|
}
|
|
|
|
received, resp := client.UpdateSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, []*model.SidebarCategoryWithChannels{updatedCategory})
|
|
require.Nil(t, resp.Error)
|
|
assert.Equal(t, channelsCategory.Id, received[0].Id)
|
|
assert.NotContains(t, received[0].Channels, channel.Id)
|
|
assert.Equal(t, channelsCategory.Channels, received[0].Channels)
|
|
})
|
|
|
|
t.Run("should update order", func(t *testing.T) {
|
|
user, client := setupUserForSubtest(t, th)
|
|
|
|
categories, resp := client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory := categories.Categories[1]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
_, resp = client.UpdateSidebarCategoryOrderForTeamForUser(user.Id, th.BasicTeam.Id, []string{categories.Order[1], categories.Order[0], categories.Order[2]})
|
|
require.Nil(t, resp.Error)
|
|
|
|
categories, resp = client.GetSidebarCategoriesForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.Len(t, categories.Categories, 3)
|
|
require.Len(t, categories.Order, 3)
|
|
|
|
channelsCategory = categories.Categories[0]
|
|
require.Equal(t, model.SidebarCategoryChannels, channelsCategory.Type)
|
|
|
|
// validate order
|
|
newOrder, resp := client.GetSidebarCategoryOrderForTeamForUser(user.Id, th.BasicTeam.Id, "")
|
|
require.Nil(t, resp.Error)
|
|
require.EqualValues(t, newOrder, categories.Order)
|
|
|
|
// try to update with missing category
|
|
_, resp = client.UpdateSidebarCategoryOrderForTeamForUser(user.Id, th.BasicTeam.Id, []string{categories.Order[1], categories.Order[0]})
|
|
require.NotNil(t, resp.Error)
|
|
|
|
// try to update with invalid category
|
|
_, resp = client.UpdateSidebarCategoryOrderForTeamForUser(user.Id, th.BasicTeam.Id, []string{categories.Order[1], categories.Order[0], "asd"})
|
|
require.NotNil(t, resp.Error)
|
|
})
|
|
}
|
|
|
|
func setupUserForSubtest(t *testing.T, th *TestHelper) (*model.User, *model.Client4) {
|
|
password := "password"
|
|
user, err := th.App.CreateUser(&model.User{
|
|
Email: th.GenerateTestEmail(),
|
|
Username: "user_" + model.NewId(),
|
|
Password: password,
|
|
})
|
|
require.Nil(t, err)
|
|
|
|
th.LinkUserToTeam(user, th.BasicTeam)
|
|
th.AddUserToChannel(user, th.BasicChannel)
|
|
th.AddUserToChannel(user, th.BasicChannel2)
|
|
th.AddUserToChannel(user, th.BasicPrivateChannel)
|
|
|
|
client := th.CreateClient()
|
|
user, resp := client.Login(user.Email, password)
|
|
require.Nil(t, resp.Error)
|
|
|
|
return user, client
|
|
}
|