Add roles to users' batch creation (#102)

* Support role in batch creation params

* Create handler for user batch creation with roles

Adapter from the standard user batch creation handler.

* Update router endpoint to new handler

* Add FIXME

* Update tests

Author: RichDom2185

controller/usergroups/create.go

@@ -0,0 +1,106 @@
+package usergroups
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/sirupsen/logrus"
+	"github.com/source-academy/stories-backend/controller"
+	"github.com/source-academy/stories-backend/internal/auth"
+	"github.com/source-academy/stories-backend/internal/database"
+	apierrors "github.com/source-academy/stories-backend/internal/errors"
+	userpermissiongroups "github.com/source-academy/stories-backend/internal/permissiongroups/users"
+	"github.com/source-academy/stories-backend/internal/usergroups"
+	"github.com/source-academy/stories-backend/model"
+	userparams "github.com/source-academy/stories-backend/params/users"
+	userviews "github.com/source-academy/stories-backend/view/users"
+)
+
+func HandleBatchCreate(w http.ResponseWriter, r *http.Request) error {
+	err := auth.CheckPermissions(r, userpermissiongroups.Create())
+	if err != nil {
+		logrus.Error(err)
+		return apierrors.ClientForbiddenError{
+			Message: fmt.Sprintf("Error batch creating users: %v", err),
+		}
+	}
+
+	var usersparams userparams.BatchCreate
+	if err := json.NewDecoder(r.Body).Decode(&usersparams); err != nil {
+		e, ok := err.(*json.UnmarshalTypeError)
+		if !ok {
+			logrus.Error(err)
+			return apierrors.ClientBadRequestError{
+				Message: fmt.Sprintf("Bad JSON parsing: %v", err),
+			}
+		}
+
+		// TODO: Investigate if we should use errors.Wrap instead
+		return apierrors.ClientUnprocessableEntityError{
+			Message: fmt.Sprintf("Invalid JSON format: %s should be a %s.", e.Field, e.Type),
+		}
+	}
+
+	for _, userparams := range usersparams.Users {
+		err := userparams.Validate()
+		if err != nil {
+			logrus.Error(err)
+			return apierrors.ClientUnprocessableEntityError{
+				Message: fmt.Sprintf("JSON validation failed: %v", err),
+			}
+		}
+	}
+
+	// Get group id from context
+	groupID, err := usergroups.GetGroupIDFrom(r)
+	if err != nil {
+		logrus.Error(err)
+		return err
+	}
+
+	// FIXME: MAKE THIS ATOMIC
+
+	userModels := make([]*model.User, len(usersparams.Users))
+	for i, userparams := range usersparams.Users {
+		userModels[i] = userparams.ToModel()
+	}
+
+	// Get DB instance
+	db, err := database.GetDBFrom(r)
+	if err != nil {
+		logrus.Error(err)
+		return err
+	}
+
+	numCreated, err := model.CreateUsers(db, &userModels)
+	if err != nil {
+		logrus.Error(err)
+		return err
+	}
+
+	// FIXME: REFACTOR
+
+	userGroupModels := make([]*model.UserGroup, len(usersparams.Users))
+	for i, userModel := range userModels {
+		userGroupModels[i] = &model.UserGroup{
+			GroupID: *groupID,
+			UserID:  userModel.ID,
+			User:    *userModel,
+			Role:    usersparams.Users[i].Role,
+		}
+	}
+
+	// FIXME: Use batch create
+	for _, toCreate := range userGroupModels {
+		err := model.CreateUserGroup(db, toCreate)
+		if err != nil {
+			logrus.Error(err)
+			return err
+		}
+	}
+
+	controller.EncodeJSONResponse(w, userviews.BatchCreateFrom(userModels, numCreated))
+	w.WriteHeader(http.StatusCreated)
+	return nil
+}

internal/router/router.go

@@ -9,6 +9,9 @@ import (
 	"github.com/source-academy/stories-backend/controller"
 	"github.com/source-academy/stories-backend/controller/stories"
 	"github.com/source-academy/stories-backend/controller/users"
+
+	// FIXME: Name clash
+	usergroupscontroller "github.com/source-academy/stories-backend/controller/usergroups"
 	"github.com/source-academy/stories-backend/internal/auth"
 	"github.com/source-academy/stories-backend/internal/config"
 	usergroups "github.com/source-academy/stories-backend/internal/usergroups"
@@ -63,7 +66,7 @@ func Setup(config *config.Config, injectMiddleWares []func(http.Handler) http.Ha
 				r.Get("/{userID}", handleAPIError(users.HandleRead))
 				r.Delete("/{userID}", handleAPIError(users.HandleDelete))
 				r.Post("/", handleAPIError(users.HandleCreate))
-				r.Post("/batch", handleAPIError(users.HandleBatchCreate))
+				r.Post("/batch", handleAPIError(usergroupscontroller.HandleBatchCreate))
 			})
 		})
 

params/users/create.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 
+	groupenums "github.com/source-academy/stories-backend/internal/enums/groups"
 	userenums "github.com/source-academy/stories-backend/internal/enums/users"
 	"github.com/source-academy/stories-backend/model"
 )
@@ -12,6 +13,8 @@ type Create struct {
 	Name          string `json:"name"`
 	Username      string `json:"username"`
 	LoginProvider string `json:"provider"`
+	// FIXME: Role should be under usergroups create params
+	Role groupenums.Role `json:"role"`
 }
 
 type BatchCreate struct {
@@ -31,6 +34,10 @@ func (params *Create) Validate() error {
 		return fmt.Errorf("Invalid login provider %s.", params.LoginProvider)
 	}
 
+	if !params.Role.IsValid() {
+		return fmt.Errorf("Invalid role %s.", params.Role)
+	}
+
 	return nil
 }
 

params/users/create_test.go

@@ -3,6 +3,7 @@ package userparams
 import (
 	"testing"
 
+	groupenums "github.com/source-academy/stories-backend/internal/enums/groups"
 	userenums "github.com/source-academy/stories-backend/internal/enums/users"
 	"github.com/stretchr/testify/assert"
 )
@@ -20,6 +21,7 @@ func TestValidate(t *testing.T) {
 		params := Create{
 			Username:      "testUsername",
 			LoginProvider: userenums.LoginProviderNUSNET.ToString(),
+			Role:          groupenums.RoleStandard,
 		}
 		err := params.Validate()
 		assert.Nil(t, err)
@@ -28,6 +30,7 @@ func TestValidate(t *testing.T) {
 		params := Create{
 			Username:      "testUsername",
 			LoginProvider: "invalidProvider",
+			Role:          groupenums.RoleStandard,
 		}
 		err := params.Validate()
 		assert.NotNil(t, err)
@@ -36,6 +39,15 @@ func TestValidate(t *testing.T) {
 		params := Create{
 			Username:      "testUsername",
 			LoginProvider: userenums.LoginProviderGitHub.ToString(),
+			Role:          groupenums.RoleStandard,
+		}
+		err := params.Validate()
+		assert.NotNil(t, err)
+	})
+	t.Run("should ensure role is not empty", func(t *testing.T) {
+		params := Create{
+			Username:      "testUsername",
+			LoginProvider: userenums.LoginProviderNUSNET.ToString(),
 		}
 		err := params.Validate()
 		assert.NotNil(t, err)
@@ -47,6 +59,7 @@ func TestToModel(t *testing.T) {
 		params := Create{
 			Username:      "testUsername",
 			LoginProvider: userenums.LoginProviderNUSNET.ToString(),
+			Role:          groupenums.RoleStandard,
 		}
 		model := params.ToModel()
 		assert.Equal(t, params.Username, model.Username)