[MM-55728] Add user reporting load tests (#675)

* Add user reporting load tests

* Oops

* Update MM server

* Update model

* Update loadtest/control/simulcontroller/actions.go

Co-authored-by: Alejandro García Montoro <[email protected]>

* PR feedback

* Lint

* Add config, specify number of admin users

* Fix test

* Fix docs

* Fix test

* fix detecting admin user

* add comment

---------

Co-authored-by: Alejandro García Montoro <[email protected]>
Co-authored-by: Agniva De Sarker <[email protected]>

Author: 3 people

api/agent.go

@@ -365,17 +365,26 @@ func NewControllerWrapper(config *loadtest.Config, controllerConfig interface{},
 		return nil, err
 	}
 
+	modAdmins := 0
+	if config.UsersConfiguration.PercentOfUsersAreAdmin > 0 {
+		modAdmins = int(1 / config.UsersConfiguration.PercentOfUsersAreAdmin)
+	}
+
 	return func(id int, status chan<- control.UserStatus) (control.UserController, error) {
 		id += userOffset
 
 		username := fmt.Sprintf("%s-%d", namePrefix, id)
 		email := fmt.Sprintf("%s-%[email protected]", namePrefix, id)
 		password := "testPass123$"
 
-		// If UsersFilePath was set, and we haven't yet consumed all of the credentials
-		// provided there, ovewrite this user's credentials with the next available
-		// user in that file
-		if len(creds) > 0 && id < len(creds) {
+		if modAdmins > 0 && id%modAdmins == 0 {
+			username = ""
+			email = config.ConnectionConfiguration.AdminEmail
+			password = config.ConnectionConfiguration.AdminPassword
+		} else if len(creds) > 0 && id < len(creds) {
+			// If UsersFilePath was set, and we haven't yet consumed all of the credentials
+			// provided there, ovewrite this user's credentials with the next available
+			// user in that file
 			username = creds[id].username
 			email = creds[id].email
 			password = creds[id].password

config/config.sample.json

@@ -49,7 +49,8 @@
     "InitialActiveUsers": 0,
     "UsersFilePath": "",
     "MaxActiveUsers": 2000,
-    "AvgSessionsPerUser": 1
+    "AvgSessionsPerUser": 1,
+    "PercentOfUsersAreAdmin": 0.02
   },
   "LogSettings": {
     "EnableConsole": true,

docs/config/config.md

@@ -122,6 +122,12 @@ The path to the file which contains a list of user email and passwords that will
 
 The maximum amount of concurrently active users the load-test agent will run.
 
+### PercentOfUsersAreAdmin
+
+*float*
+
+The percentage of users generated that will be system admins.
+
 ## LogSettings
 
 ### EnableConsole

loadtest/config.go

@@ -135,6 +135,8 @@ type UsersConfiguration struct {
 	MaxActiveUsers int `default:"2000" validate:"range:(0,]"`
 	// The average number of sessions per user.
 	AvgSessionsPerUser int `default:"1" validate:"range:[1,]"`
+	// The percentage of users generated that will be system admins
+	PercentOfUsersAreAdmin float64 `default:"0.02" validate:"range:[0,1]"`
 }
 
 // Config holds information needed to create and initialize a new load-test

loadtest/control/simulcontroller/actions.go

@@ -2073,3 +2073,48 @@ func (c *SimulController) openPermalink(u user.User) control.UserActionResponse
 
 	return control.UserActionResponse{Info: fmt.Sprintf("clicked permalink on post %s", postID)}
 }
+
+func (c *SimulController) generateUserReport(u user.User) control.UserActionResponse {
+	// We are detecting the sysadmin here, and not in the actions slice initialization,
+	// because the roles of a user aren't initialized until the user logs in.
+	// See https://github.com/mattermost/mattermost-load-test-ng/pull/675 for more context.
+	isAdmin, err := u.IsSysAdmin()
+	if err != nil {
+		return control.UserActionResponse{Err: control.NewUserError(err)}
+	}
+	if !isAdmin {
+		return control.UserActionResponse{Info: "User is not an admin. Skipping from generating user report."}
+	}
+
+	// Simulate scrolling through the entire list of users
+	// (should be similar to generating the complete report and exporting it)
+	pageSize := 50
+	lastColumnValue := ""
+	lastId := ""
+	totalUsers := 0
+
+	for {
+		report, err := u.GetUsersForReporting(&model.UserReportOptionsAPI{
+			UserReportOptionsWithoutDateRange: model.UserReportOptionsWithoutDateRange{
+				SortColumn:          "Username",
+				PageSize:            pageSize,
+				LastSortColumnValue: lastColumnValue,
+				LastUserId:          lastId,
+			},
+		})
+
+		if err != nil {
+			return control.UserActionResponse{Err: control.NewUserError(err)}
+		}
+
+		totalUsers += len(report)
+		if len(report) < pageSize {
+			break
+		}
+
+		lastColumnValue = report[len(report)-1].Username
+		lastId = report[len(report)-1].Id
+	}
+
+	return control.UserActionResponse{Info: fmt.Sprintf("generated user report for %d users", totalUsers)}
+}

loadtest/control/simulcontroller/controller.go

@@ -16,7 +16,7 @@ import (
 )
 
 func getActionList(c *SimulController) []userAction {
-	return []userAction{
+	actions := []userAction{
 		{
 			name:      "SwitchChannel",
 			run:       switchChannel,
@@ -202,7 +202,14 @@ func getActionList(c *SimulController) []userAction {
 			run:       c.reconnectWebSocket,
 			frequency: 0.144,
 		},
+		{
+			name:      "GenerateUserReport",
+			run:       c.generateUserReport,
+			frequency: 0.0001,
+		},
 	}
+
+	return actions
 }
 
 func getActionMap(actionList []userAction) map[string]userAction {

loadtest/control/simulcontroller/controller_test.go

@@ -17,7 +17,16 @@ func TestNew(t *testing.T) {
 	require.NoError(t, err)
 	require.NotNil(t, config)
 
-	c, err := New(1, &userentity.UserEntity{}, config, make(chan control.UserStatus))
+	store, err := memstore.New(nil)
+	require.NotNil(t, store)
+	require.NoError(t, err)
+
+	user := userentity.New(userentity.Setup{Store: store}, userentity.Config{
+		ServerURL:    "http://localhost:8065",
+		WebSocketURL: "ws://localhost:8065",
+	})
+
+	c, err := New(1, user, config, make(chan control.UserStatus))
 	require.Nil(t, err)
 
 	require.Equal(t, len(c.actionList), len(c.actionMap))
@@ -28,7 +37,16 @@ func TestSetRate(t *testing.T) {
 	require.NoError(t, err)
 	require.NotNil(t, config)
 
-	c, err := New(1, &userentity.UserEntity{}, config, make(chan control.UserStatus))
+	store, err := memstore.New(nil)
+	require.NotNil(t, store)
+	require.NoError(t, err)
+
+	user := userentity.New(userentity.Setup{Store: store}, userentity.Config{
+		ServerURL:    "http://localhost:8065",
+		WebSocketURL: "ws://localhost:8065",
+	})
+
+	c, err := New(1, user, config, make(chan control.UserStatus))
 	require.Nil(t, err)
 	require.Equal(t, 1.0, c.rate)
 

loadtest/user/user.go

@@ -92,6 +92,8 @@ type User interface {
 	GetUsers(page, perPage int) ([]string, error)
 	// GetUsersNotInChannel returns a list of user ids not in a given channel.
 	GetUsersNotInChannel(teamId, channelId string, page, perPage int) ([]string, error)
+	// GetUsersForReporting returns a list of users in a report format
+	GetUsersForReporting(options *model.UserReportOptionsAPI) ([]*model.UserReport, error)
 
 	// SetProfileImage sets the profile image for the user.
 	SetProfileImage(data []byte) error

loadtest/user/userentity/actions.go

@@ -1521,6 +1521,15 @@ func (ue *UserEntity) GetChannelsAndChannelMembersGQL(teamID string, includeDele
 	return chCursor, cmCursor, nil
 }
 
+func (ue *UserEntity) GetUsersForReporting(options *model.UserReportOptionsAPI) ([]*model.UserReport, error) {
+	report, _, err := ue.client.GetUsersForReporting(context.Background(), options)
+	if err != nil {
+		return nil, err
+	}
+
+	return report, nil
+}
+
 func (ue *UserEntity) prepareRequest(method, url string, data io.Reader, headers map[string]string) (*http.Request, error) {
 	rq, err := http.NewRequest(method, url, data)
 	if err != nil {

loadtest/user/userentity/helper_test.go

@@ -46,10 +46,11 @@ type config struct {
 		PercentGroupChannels        float64 `default:"0.1" validate:"range:[0,1]"`
 	}
 	UsersConfiguration struct {
-		UsersFilePath      string
-		InitialActiveUsers int `default:"0" validate:"range:[0,$MaxActiveUsers]"`
-		MaxActiveUsers     int `default:"2000" validate:"range:(0,]"`
-		AvgSessionsPerUser int `default:"1" validate:"range:[1,]"`
+		UsersFilePath          string
+		InitialActiveUsers     int     `default:"0" validate:"range:[0,$MaxActiveUsers]"`
+		MaxActiveUsers         int     `default:"2000" validate:"range:(0,]"`
+		AvgSessionsPerUser     int     `default:"1" validate:"range:[1,]"`
+		PercentOfUsersAreAdmin float64 `default:"0.02" validate:"range:[0,1]"`
 	}
 	LogSettings logger.Settings
 }