api4

package
v5.34.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 16, 2021 License: AGPL-3.0, Apache-2.0 Imports: 52 Imported by: 9

Documentation

Index

Constants

View Source 
const (
	FileTeamId = "noteam"

	PreviewImageType   = "image/jpeg"
	ThumbnailImageType = "image/jpeg"
)
View Source 
const (
	RedirectLocationCacheSize = 10000
	DefaultServerBusySeconds  = 3600
	MaxServerBusySeconds      = 86400
)
View Source 
const (
	MaxAddMembersBatch    = 256
	MaximumBulkImportSize = 10 * 1024 * 1024
)
View Source 
const (
	EmojiMaxAutocompleteItems = 100
)
View Source 
const (
	MaximumPluginFileSize = 50 * 1024 * 1024
)
View Source 
const OpenGraphMetadataCacheSize = 10000

Variables

View Source 
var MediaContentTypes = [...]string{
	"image/jpeg",
	"image/png",
	"image/bmp",
	"image/gif",
	"image/tiff",
	"video/avi",
	"video/mpeg",
	"video/mp4",
	"audio/mpeg",
	"audio/wav",
}
View Source 
var ReturnStatusOK = web.ReturnStatusOK
View Source 
var UnsafeContentTypes = [...]string{
	"application/javascript",
	"application/ecmascript",
	"text/javascript",
	"text/ecmascript",
	"application/x-javascript",
	"text/html",
}

Functions

func CheckBadRequestStatus 

func CheckBadRequestStatus(t *testing.T, resp *model.Response)

func CheckCreatedStatus 

func CheckCreatedStatus(t *testing.T, resp *model.Response)

func CheckErrorMessage 

func CheckErrorMessage(t *testing.T, resp *model.Response, errorId string)

func CheckEtag 

func CheckEtag(t *testing.T, data interface{}, resp *model.Response)

func CheckForbiddenStatus 

func CheckForbiddenStatus(t *testing.T, resp *model.Response)

func CheckInternalErrorStatus 

func CheckInternalErrorStatus(t *testing.T, resp *model.Response)

func CheckNoError 

func CheckNoError(t *testing.T, resp *model.Response)

func CheckNotFoundStatus 

func CheckNotFoundStatus(t *testing.T, resp *model.Response)

func CheckNotImplementedStatus 

func CheckNotImplementedStatus(t *testing.T, resp *model.Response)

func CheckOKStatus 

func CheckOKStatus(t *testing.T, resp *model.Response)

func CheckRequestEntityTooLargeStatus 

func CheckRequestEntityTooLargeStatus(t *testing.T, resp *model.Response)

func CheckServiceUnavailableStatus added in v5.20.0 

func CheckServiceUnavailableStatus(t *testing.T, resp *model.Response)

func CheckStartsWith 

func CheckStartsWith(t *testing.T, value, prefix, message string)

func CheckUnauthorizedStatus 

func CheckUnauthorizedStatus(t *testing.T, resp *model.Response)

func CheckUserSanitization 

func CheckUserSanitization(t *testing.T, user *model.User)

func GenerateTestAppName 

func GenerateTestAppName() string

func GenerateTestChannelName 

func GenerateTestChannelName() string

func GenerateTestId 

func GenerateTestId() string

func GenerateTestTeamName 

func GenerateTestTeamName() string

func GenerateTestUsername 

func GenerateTestUsername() string

func Logout 

func Logout(c *Context, w http.ResponseWriter, r *http.Request)

func SetMainHelper added in v5.22.0 

func SetMainHelper(mh *testlib.MainHelper)

Types

type API 

type API struct {
	ConfigService       configservice.ConfigService
	GetGlobalAppOptions app.AppOptionCreator
	BaseRoutes          *Routes
}

func Init 

func Init(configservice configservice.ConfigService, globalOptionsFunc app.AppOptionCreator, root *mux.Router) *API

func InitLocal added in v5.24.0 

func InitLocal(configservice configservice.ConfigService, globalOptionsFunc app.AppOptionCreator, root *mux.Router) *API

func (*API) ApiHandler 

func (api *API) ApiHandler(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiHandler provides a handler for API endpoints which do not require the user to be logged in order for access to be granted.

func (*API) ApiHandlerTrustRequester 

func (api *API) ApiHandlerTrustRequester(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiHandlerTrustRequester provides a handler for API endpoints which do not require the user to be logged in and are allowed to be requested directly rather than via javascript/XMLHttpRequest, such as site branding images or the websocket.

func (*API) ApiLocal added in v5.24.0 

func (api *API) ApiLocal(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiLocal provides a handler for API endpoints to be used in local mode, this is, through a UNIX socket and without an authenticated session, but with one that has no user set and no permission restrictions

func (*API) ApiSessionRequired 

func (api *API) ApiSessionRequired(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiSessionRequired provides a handler for API endpoints which require the user to be logged in in order for access to be granted.

func (*API) ApiSessionRequiredDisableWhenBusy added in v5.20.0 

func (api *API) ApiSessionRequiredDisableWhenBusy(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

DisableWhenBusy provides a handler for API endpoints which should be disabled when the server is under load, responding with HTTP 503 (Service Unavailable).

func (*API) ApiSessionRequiredMfa 

func (api *API) ApiSessionRequiredMfa(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiSessionRequiredMfa provides a handler for API endpoints which require a logged-in user session but when accessed, if MFA is enabled, the MFA process is not yet complete, and therefore the requirement to have completed the MFA authentication must be waived.

func (*API) ApiSessionRequiredTrustRequester 

func (api *API) ApiSessionRequiredTrustRequester(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

ApiSessionRequiredTrustRequester provides a handler for API endpoints which do require the user to be logged in and are allowed to be requested directly rather than via javascript/XMLHttpRequest, such as emoji or file uploads.

func (*API) CloudApiKeyRequired added in v5.31.0 

func (api *API) CloudApiKeyRequired(h func(*Context, http.ResponseWriter, *http.Request)) http.Handler

CloudApiKeyRequired provides a handler for webhook endpoints to access Cloud installations from CWS

func (*API) Handle404 

func (api *API) Handle404(w http.ResponseWriter, r *http.Request)

func (*API) InitAction 

func (api *API) InitAction()

func (*API) InitBleve added in v5.24.0 

func (api *API) InitBleve()

func (*API) InitBot 

func (api *API) InitBot()

func (*API) InitBotLocal added in v5.26.0 

func (api *API) InitBotLocal()

func (*API) InitBrand 

func (api *API) InitBrand()

func (*API) InitChannel 

func (api *API) InitChannel()

func (*API) InitChannelLocal added in v5.24.0 

func (api *API) InitChannelLocal()

func (*API) InitCloud added in v5.30.0 

func (api *API) InitCloud()

func (*API) InitCluster 

func (api *API) InitCluster()

func (*API) InitCommand 

func (api *API) InitCommand()

func (*API) InitCommandLocal added in v5.26.0 

func (api *API) InitCommandLocal()

func (*API) InitCompliance 

func (api *API) InitCompliance()

func (*API) InitConfig 

func (api *API) InitConfig()

func (*API) InitConfigLocal added in v5.24.0 

func (api *API) InitConfigLocal()

func (*API) InitDataRetention 

func (api *API) InitDataRetention()

func (*API) InitElasticsearch 

func (api *API) InitElasticsearch()

func (*API) InitEmoji 

func (api *API) InitEmoji()

func (*API) InitExport added in v5.33.0 

func (api *API) InitExport()

func (*API) InitExportLocal added in v5.33.0 

func (api *API) InitExportLocal()

func (*API) InitFile 

func (api *API) InitFile()

func (*API) InitGroup 

func (api *API) InitGroup()

func (*API) InitGroupLocal added in v5.26.0 

func (api *API) InitGroupLocal()

func (*API) InitImage 

func (api *API) InitImage()

func (*API) InitImport added in v5.32.0 

func (api *API) InitImport()

func (*API) InitImportLocal added in v5.32.0 

func (api *API) InitImportLocal()

func (*API) InitJob 

func (api *API) InitJob()

func (*API) InitJobLocal added in v5.32.0 

func (api *API) InitJobLocal()

func (*API) InitLdap 

func (api *API) InitLdap()

func (*API) InitLdapLocal added in v5.26.0 

func (api *API) InitLdapLocal()

func (*API) InitLicense 

func (api *API) InitLicense()

func (*API) InitLicenseLocal added in v5.24.0 

func (api *API) InitLicenseLocal()

func (*API) InitOAuth 

func (api *API) InitOAuth()

func (*API) InitOpenGraph 

func (api *API) InitOpenGraph()

func (*API) InitPlugin 

func (api *API) InitPlugin()

func (*API) InitPluginLocal added in v5.24.0 

func (api *API) InitPluginLocal()

func (*API) InitPost 

func (api *API) InitPost()

func (*API) InitPostLocal added in v5.26.0 

func (api *API) InitPostLocal()

func (*API) InitPreference 

func (api *API) InitPreference()

func (*API) InitReaction 

func (api *API) InitReaction()

func (*API) InitRole 

func (api *API) InitRole()

func (*API) InitRoleLocal added in v5.26.0 

func (api *API) InitRoleLocal()

func (*API) InitSaml 

func (api *API) InitSaml()

func (*API) InitScheme 

func (api *API) InitScheme()

func (*API) InitStatus 

func (api *API) InitStatus()

func (*API) InitSystem 

func (api *API) InitSystem()

func (*API) InitSystemLocal added in v5.26.0 

func (api *API) InitSystemLocal()

func (*API) InitTeam 

func (api *API) InitTeam()

func (*API) InitTeamLocal added in v5.24.0 

func (api *API) InitTeamLocal()

func (*API) InitTermsOfService 

func (api *API) InitTermsOfService()

func (*API) InitUpload added in v5.28.0 

func (api *API) InitUpload()

func (*API) InitUploadLocal added in v5.32.0 

func (api *API) InitUploadLocal()

func (*API) InitUser 

func (api *API) InitUser()

func (*API) InitUserLocal added in v5.26.0 

func (api *API) InitUserLocal()

func (*API) InitWebSocket 

func (api *API) InitWebSocket()

func (*API) InitWebhook 

func (api *API) InitWebhook()

func (*API) InitWebhookLocal added in v5.30.0 

func (api *API) InitWebhookLocal()

type Context 

type Context = web.Context

type Routes 

type Routes struct {
	Root    *mux.Router // ”
	ApiRoot *mux.Router // 'api/v4'

	Users          *mux.Router // 'api/v4/users'
	User           *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}'
	UserByUsername *mux.Router // 'api/v4/users/username/{username:[A-Za-z0-9\\_\\-\\.]+}'
	UserByEmail    *mux.Router // 'api/v4/users/email/{email:.+}'

	Bots *mux.Router // 'api/v4/bots'
	Bot  *mux.Router // 'api/v4/bots/{bot_user_id:[A-Za-z0-9]+}'

	Teams              *mux.Router // 'api/v4/teams'
	TeamsForUser       *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams'
	Team               *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}'
	TeamForUser        *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}'
	UserThreads        *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/threads'
	UserThread         *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/threads/{thread_id:[A-Za-z0-9]+}'
	TeamByName         *mux.Router // 'api/v4/teams/name/{team_name:[A-Za-z0-9_-]+}'
	TeamMembers        *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/members'
	TeamMember         *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/members/{user_id:[A-Za-z0-9]+}'
	TeamMembersForUser *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/members'

	Channels                 *mux.Router // 'api/v4/channels'
	Channel                  *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}'
	ChannelForUser           *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/channels/{channel_id:[A-Za-z0-9]+}'
	ChannelByName            *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/channels/name/{channel_name:[A-Za-z0-9_-]+}'
	ChannelByNameForTeamName *mux.Router // 'api/v4/teams/name/{team_name:[A-Za-z0-9_-]+}/channels/name/{channel_name:[A-Za-z0-9_-]+}'
	ChannelsForTeam          *mux.Router // 'api/v4/teams/{team_id:[A-Za-z0-9]+}/channels'
	ChannelMembers           *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/members'
	ChannelMember            *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/members/{user_id:[A-Za-z0-9]+}'
	ChannelMembersForUser    *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/channels/members'
	ChannelModerations       *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/moderations'
	ChannelCategories        *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/channels/categories'

	Posts           *mux.Router // 'api/v4/posts'
	Post            *mux.Router // 'api/v4/posts/{post_id:[A-Za-z0-9]+}'
	PostsForChannel *mux.Router // 'api/v4/channels/{channel_id:[A-Za-z0-9]+}/posts'
	PostsForUser    *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/posts'
	PostForUser     *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/posts/{post_id:[A-Za-z0-9]+}'

	Files *mux.Router // 'api/v4/files'
	File  *mux.Router // 'api/v4/files/{file_id:[A-Za-z0-9]+}'

	Uploads *mux.Router // 'api/v4/uploads'
	Upload  *mux.Router // 'api/v4/uploads/{upload_id:[A-Za-z0-9]+}'

	Plugins *mux.Router // 'api/v4/plugins'
	Plugin  *mux.Router // 'api/v4/plugins/{plugin_id:[A-Za-z0-9\\_\\-\\.]+}'

	PublicFile *mux.Router // '/files/{file_id:[A-Za-z0-9]+}/public'

	Commands *mux.Router // 'api/v4/commands'
	Command  *mux.Router // 'api/v4/commands/{command_id:[A-Za-z0-9]+}'

	Hooks         *mux.Router // 'api/v4/hooks'
	IncomingHooks *mux.Router // 'api/v4/hooks/incoming'
	IncomingHook  *mux.Router // 'api/v4/hooks/incoming/{hook_id:[A-Za-z0-9]+}'
	OutgoingHooks *mux.Router // 'api/v4/hooks/outgoing'
	OutgoingHook  *mux.Router // 'api/v4/hooks/outgoing/{hook_id:[A-Za-z0-9]+}'

	OAuth     *mux.Router // 'api/v4/oauth'
	OAuthApps *mux.Router // 'api/v4/oauth/apps'
	OAuthApp  *mux.Router // 'api/v4/oauth/apps/{app_id:[A-Za-z0-9]+}'

	OpenGraph *mux.Router // 'api/v4/opengraph'

	SAML       *mux.Router // 'api/v4/saml'
	Compliance *mux.Router // 'api/v4/compliance'
	Cluster    *mux.Router // 'api/v4/cluster'

	Image *mux.Router // 'api/v4/image'

	LDAP *mux.Router // 'api/v4/ldap'

	Elasticsearch *mux.Router // 'api/v4/elasticsearch'

	Bleve *mux.Router // 'api/v4/bleve'

	DataRetention *mux.Router // 'api/v4/data_retention'

	Brand *mux.Router // 'api/v4/brand'

	System *mux.Router // 'api/v4/system'

	Jobs *mux.Router // 'api/v4/jobs'

	Preferences *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/preferences'

	License *mux.Router // 'api/v4/license'

	Public *mux.Router // 'api/v4/public'

	Reactions *mux.Router // 'api/v4/reactions'

	Roles   *mux.Router // 'api/v4/roles'
	Schemes *mux.Router // 'api/v4/schemes'

	Emojis      *mux.Router // 'api/v4/emoji'
	Emoji       *mux.Router // 'api/v4/emoji/{emoji_id:[A-Za-z0-9]+}'
	EmojiByName *mux.Router // 'api/v4/emoji/name/{emoji_name:[A-Za-z0-9\\_\\-\\+]+}'

	ReactionByNameForPostForUser *mux.Router // 'api/v4/users/{user_id:[A-Za-z0-9]+}/posts/{post_id:[A-Za-z0-9]+}/reactions/{emoji_name:[A-Za-z0-9\\_\\-\\+]+}'

	TermsOfService *mux.Router // 'api/v4/terms_of_service'
	Groups         *mux.Router // 'api/v4/groups'

	Cloud *mux.Router // 'api/v4/cloud'

	Imports *mux.Router // 'api/v4/imports'
	Exports *mux.Router // 'api/v4/exports'
	Export  *mux.Router // 'api/v4/exports/{export_name:.+\\.zip}'
}

type TestHelper 

type TestHelper struct {
	App         *app.App
	Server      *app.Server
	ConfigStore *config.Store

	Client               *model.Client4
	BasicUser            *model.User
	BasicUser2           *model.User
	TeamAdminUser        *model.User
	BasicTeam            *model.Team
	BasicChannel         *model.Channel
	BasicPrivateChannel  *model.Channel
	BasicPrivateChannel2 *model.Channel
	BasicDeletedChannel  *model.Channel
	BasicChannel2        *model.Channel
	BasicPost            *model.Post
	Group                *model.Group

	SystemAdminClient *model.Client4
	SystemAdminUser   *model.User

	SystemManagerClient *model.Client4
	SystemManagerUser   *model.User

	LocalClient *model.Client4

	IncludeCacheLayer bool
	// contains filtered or unexported fields
}

func Setup 

func Setup(tb testing.TB) *TestHelper

func SetupConfig 

func SetupConfig(tb testing.TB, updateConfig func(cfg *model.Config)) *TestHelper

func SetupConfigWithStoreMock added in v5.22.0 

func SetupConfigWithStoreMock(tb testing.TB, updateConfig func(cfg *model.Config)) *TestHelper

func SetupEnterprise 

func SetupEnterprise(tb testing.TB) *TestHelper

func SetupEnterpriseWithStoreMock added in v5.22.0 

func SetupEnterpriseWithStoreMock(tb testing.TB) *TestHelper

func SetupWithStoreMock added in v5.22.0 

func SetupWithStoreMock(tb testing.TB) *TestHelper

func (*TestHelper) AddPermissionToRole 

func (th *TestHelper) AddPermissionToRole(permission string, roleName string)

func (*TestHelper) AddUserToChannel 

func (th *TestHelper) AddUserToChannel(user *model.User, channel *model.Channel) *model.ChannelMember

func (*TestHelper) CreateBotWithClient added in v5.21.0 

func (th *TestHelper) CreateBotWithClient(client *model.Client4) *model.Bot

func (*TestHelper) CreateBotWithSystemAdminClient added in v5.21.0 

func (th *TestHelper) CreateBotWithSystemAdminClient() *model.Bot

func (*TestHelper) CreateChannelWithClient 

func (th *TestHelper) CreateChannelWithClient(client *model.Client4, channelType string) *model.Channel

func (*TestHelper) CreateChannelWithClientAndTeam 

func (th *TestHelper) CreateChannelWithClientAndTeam(client *model.Client4, channelType string, teamId string) *model.Channel

func (*TestHelper) CreateClient 

func (th *TestHelper) CreateClient() *model.Client4

func (*TestHelper) CreateDmChannel 

func (th *TestHelper) CreateDmChannel(user *model.User) *model.Channel

func (*TestHelper) CreateGroup 

func (th *TestHelper) CreateGroup() *model.Group

func (*TestHelper) CreateLocalClient added in v5.24.0 

func (th *TestHelper) CreateLocalClient(socketPath string) *model.Client4

ToDo: maybe move this to NewAPIv4SocketClient and reuse it in mmctl

func (*TestHelper) CreateMessagePost 

func (th *TestHelper) CreateMessagePost(message string) *model.Post

func (*TestHelper) CreateMessagePostNoClient 

func (th *TestHelper) CreateMessagePostNoClient(channel *model.Channel, message string, createAtTime int64) *model.Post

func (*TestHelper) CreateMessagePostWithClient 

func (th *TestHelper) CreateMessagePostWithClient(client *model.Client4, channel *model.Channel, message string) *model.Post

func (*TestHelper) CreatePinnedPost 

func (th *TestHelper) CreatePinnedPost() *model.Post

func (*TestHelper) CreatePinnedPostWithClient 

func (th *TestHelper) CreatePinnedPostWithClient(client *model.Client4, channel *model.Channel) *model.Post

func (*TestHelper) CreatePost 

func (th *TestHelper) CreatePost() *model.Post

func (*TestHelper) CreatePostWithClient 

func (th *TestHelper) CreatePostWithClient(client *model.Client4, channel *model.Channel) *model.Post

func (*TestHelper) CreatePrivateChannel 

func (th *TestHelper) CreatePrivateChannel() *model.Channel

func (*TestHelper) CreatePublicChannel 

func (th *TestHelper) CreatePublicChannel() *model.Channel

func (*TestHelper) CreateTeam 

func (th *TestHelper) CreateTeam() *model.Team

func (*TestHelper) CreateTeamWithClient 

func (th *TestHelper) CreateTeamWithClient(client *model.Client4) *model.Team

func (*TestHelper) CreateUser 

func (th *TestHelper) CreateUser() *model.User

func (*TestHelper) CreateUserWithClient 

func (th *TestHelper) CreateUserWithClient(client *model.Client4) *model.User

func (*TestHelper) CreateWebSocketClient 

func (th *TestHelper) CreateWebSocketClient() (*model.WebSocketClient, *model.AppError)

func (*TestHelper) CreateWebSocketClientWithClient 

func (th *TestHelper) CreateWebSocketClientWithClient(client *model.Client4) (*model.WebSocketClient, *model.AppError)

func (*TestHelper) CreateWebSocketSystemAdminClient 

func (th *TestHelper) CreateWebSocketSystemAdminClient() (*model.WebSocketClient, *model.AppError)

func (*TestHelper) CreateWebSocketSystemManagerClient added in v5.32.0 

func (th *TestHelper) CreateWebSocketSystemManagerClient() (*model.WebSocketClient, *model.AppError)

func (*TestHelper) GenerateTestEmail 

func (th *TestHelper) GenerateTestEmail() string

func (*TestHelper) InitBasic 

func (th *TestHelper) InitBasic() *TestHelper

func (*TestHelper) InitLogin added in v5.28.0 

func (th *TestHelper) InitLogin() *TestHelper

func (*TestHelper) LinkUserToTeam 

func (th *TestHelper) LinkUserToTeam(user *model.User, team *model.Team)

func (*TestHelper) LoginBasic 

func (th *TestHelper) LoginBasic()

func (*TestHelper) LoginBasic2 

func (th *TestHelper) LoginBasic2()

func (*TestHelper) LoginBasic2WithClient 

func (th *TestHelper) LoginBasic2WithClient(client *model.Client4)

func (*TestHelper) LoginBasicWithClient 

func (th *TestHelper) LoginBasicWithClient(client *model.Client4)

func (*TestHelper) LoginSystemAdmin 

func (th *TestHelper) LoginSystemAdmin()

func (*TestHelper) LoginSystemAdminWithClient 

func (th *TestHelper) LoginSystemAdminWithClient(client *model.Client4)

func (*TestHelper) LoginSystemManager added in v5.32.0 

func (th *TestHelper) LoginSystemManager()

func (*TestHelper) LoginSystemManagerWithClient added in v5.32.0 

func (th *TestHelper) LoginSystemManagerWithClient(client *model.Client4)

func (*TestHelper) LoginTeamAdmin 

func (th *TestHelper) LoginTeamAdmin()

func (*TestHelper) LoginTeamAdminWithClient 

func (th *TestHelper) LoginTeamAdminWithClient(client *model.Client4)

func (*TestHelper) MakeUserChannelAdmin 

func (th *TestHelper) MakeUserChannelAdmin(user *model.User, channel *model.Channel)

func (*TestHelper) RemovePermissionFromRole 

func (th *TestHelper) RemovePermissionFromRole(permission string, roleName string)

func (*TestHelper) RestoreDefaultRolePermissions 

func (th *TestHelper) RestoreDefaultRolePermissions(data map[string][]string)

func (*TestHelper) SaveDefaultRolePermissions 

func (th *TestHelper) SaveDefaultRolePermissions() map[string][]string

func (*TestHelper) SetupChannelScheme added in v5.22.0 

func (th *TestHelper) SetupChannelScheme() *model.Scheme

func (*TestHelper) SetupScheme added in v5.22.0 

func (th *TestHelper) SetupScheme(scope string) *model.Scheme

func (*TestHelper) SetupTeamScheme added in v5.22.0 

func (th *TestHelper) SetupTeamScheme() *model.Scheme

func (*TestHelper) ShutdownApp 

func (th *TestHelper) ShutdownApp()

func (*TestHelper) TearDown 

func (th *TestHelper) TearDown()

func (*TestHelper) TestForAllClients added in v5.24.0 

func (th *TestHelper) TestForAllClients(t *testing.T, f func(*testing.T, *model.Client4), name ...string)

TestForAllClients runs a test function for all the clients registered in the TestHelper

func (*TestHelper) TestForSystemAdminAndLocal added in v5.24.0 

func (th *TestHelper) TestForSystemAdminAndLocal(t *testing.T, f func(*testing.T, *model.Client4), name ...string)

TestForSystemAdminAndLocal runs a test function for both SystemAdmin and Local clients. Several endpoints work in the same way when used by a fully privileged user and through the local mode, so this helper facilitates checking both

func (*TestHelper) UpdateActiveUser 

func (th *TestHelper) UpdateActiveUser(user *model.User, active bool)

func (*TestHelper) UpdateUserToNonTeamAdmin 

func (th *TestHelper) UpdateUserToNonTeamAdmin(user *model.User, team *model.Team)

func (*TestHelper) UpdateUserToTeamAdmin 

func (th *TestHelper) UpdateUserToTeamAdmin(user *model.User, team *model.Team)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.