[WIP] add usergroups endpoints

Signed-off-by: iripiri <[email protected]>

Author: iripiri

README.md

@@ -42,6 +42,11 @@ go run start.go --help
 ```
 to get a list of available parameters and default values
 
+### Generating Docs
+```bash
+$(go env GOPATH)/bin/swag init --generalInfo start.go --output ./doc/api --parseDependency
+```
+
 ## Environment variables
 
 | Variable		| Description										                               |

database/models.go

@@ -44,12 +44,32 @@ type User struct {
 	Mail string `json:"mail" gorm:"default:''"`
 	// Role of user
 	Role string `json:"role" gorm:"default:'user'"`
+	// Group of user by which the user is added to scenarios
+	Group string `json:"group" gorm:"default:''"`
 	// Indicating status of user (false means user is inactive and should not be able to login)
 	Active bool `json:"active" gorm:"default:true"`
 	// Scenarios to which user has access
 	Scenarios []*Scenario `json:"-" gorm:"many2many:user_scenarios;"`
 }
 
+// ScenarioMapping data model
+type ScenarioMapping struct {
+	Model
+	// ID of Scenario
+	ScenarioID uint `json:"scenarioID"`
+	// Duplicate Scenario or add to existing Scenario
+	Duplicate bool `json:"duplicate"`
+}
+
+// UserGroup data model
+type UserGroup struct {
+	Model
+	// Name of user group
+	Name string `json:"name" gorm:"unique;not null"`
+	// Scenarios that belong to the user group
+	ScenarioMappings []*ScenarioMapping `json:"scenarioMappings" gorm:"foreignkey:UserGroupID"`
+}
+
 // Scenario data model
 type Scenario struct {
 	Model

database/permissions.go

@@ -142,6 +142,30 @@ func CheckSignalPermissions(c *gin.Context, operation CRUD) (bool, Signal) {
 
 }
 
+func CheckUserGroupPermissions(c *gin.Context, operation CRUD, userGroupSourceID string, dabIDBody int) (bool, UserGroup) {
+
+	var usrgrp UserGroup
+
+	err := ValidateRole(c, ModelUserGroup, operation)
+	if err != nil {
+		helper.UnprocessableEntityError(c, fmt.Sprintf("Access denied (role validation failed): %v", err.Error()))
+		return false, usrgrp
+	}
+
+	groupID, err := helper.GetIDOfElement(c, "usergroupID", userGroupSourceID, dabIDBody)
+	if err != nil {
+		return false, usrgrp
+	}
+
+	db := GetDB()
+	err = db.Find(&usrgrp, uint(groupID)).Error
+	if helper.DBNotFoundError(c, err, strconv.Itoa(groupID), "UserGroup") {
+		return false, usrgrp
+	}
+
+	return true, usrgrp
+}
+
 func CheckDashboardPermissions(c *gin.Context, operation CRUD, dabIDSource string, dabIDBody int) (bool, Dashboard) {
 
 	var dab Dashboard

database/roles.go

@@ -19,6 +19,7 @@ package database
 
 import (
 	"fmt"
+
 	"github.com/gin-gonic/gin"
 )
 
@@ -33,6 +34,7 @@ type ModelName string
 const ModelUser = ModelName("user")
 const ModelUsers = ModelName("users")
 const ModelScenario = ModelName("scenario")
+const ModelUserGroup = ModelName("usergroup")
 const ModelInfrastructureComponent = ModelName("ic")
 const ModelInfrastructureComponentAction = ModelName("icaction")
 const ModelDashboard = ModelName("dashboard")
@@ -73,6 +75,7 @@ var Roles = RoleActions{
 		ModelUser:                          crud,
 		ModelUsers:                         crud,
 		ModelScenario:                      crud,
+		ModelUserGroup:                     crud,
 		ModelComponentConfiguration:        crud,
 		ModelInfrastructureComponent:       crud,
 		ModelInfrastructureComponentAction: crud,
@@ -86,6 +89,7 @@ var Roles = RoleActions{
 		ModelUser:                          _ru_,
 		ModelUsers:                         none,
 		ModelScenario:                      crud,
+		ModelUserGroup:                     _r__,
 		ModelComponentConfiguration:        crud,
 		ModelInfrastructureComponent:       _r__,
 		ModelInfrastructureComponentAction: _ru_,
@@ -117,6 +121,7 @@ var Roles = RoleActions{
 		ModelInfrastructureComponentAction: none,
 		ModelUser:                          none,
 		ModelUsers:                         none,
+		ModelUserGroup:                     none,
 		ModelSignal:                        none,
 		ModelFile:                          _r__,
 		ModelResult:                        none,