Rework scenario duplication

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										                               |

configuration/config.go

@@ -20,14 +20,11 @@ package configuration
 import (
 	"flag"
 	"fmt"
-	"io"
 	"log"
 	"os"
 	"sort"
 	"strings"
 
-	"gopkg.in/yaml.v3"
-
 	"github.com/zpatrick/go-config"
 )
 
@@ -192,45 +189,3 @@ func InitConfig() error {
 	}
 	return nil
 }
-
-func remove(arr []GroupedScenario, index int) []GroupedScenario {
-	arr[index] = arr[len(arr)-1]
-	return arr[:len(arr)-1]
-}
-
-func ReadGroupsFile(path string) error {
-	_, err := os.Stat(path)
-	if err != nil {
-		return err
-	}
-
-	yamlFile, err := os.Open(path)
-	if err != nil {
-		return fmt.Errorf("error opening yaml file for groups: %v", err)
-	}
-	log.Println("Successfully opened yaml groups file", path)
-
-	defer yamlFile.Close()
-
-	byteValue, _ := io.ReadAll(yamlFile)
-
-	err = yaml.Unmarshal(byteValue, &ScenarioGroupMap)
-	if err != nil {
-		return fmt.Errorf("error unmarshalling yaml into ScenarioGroupMap: %v", err)
-	}
-
-	for _, group := range ScenarioGroupMap {
-		for i, scenario := range group {
-			// remove invalid values that might have been introduced by typos
-			// (Unmarshal sets default values when it doesn't find a field)
-			if scenario.Scenario == 0 {
-				log.Println("Removing entry from ScenarioGroupMap, check for typos in the yaml!")
-				remove(group, i)
-			}
-		}
-	}
-
-	log.Println("ScenarioGroupMap", ScenarioGroupMap)
-
-	return nil
-}

database/database.go

@@ -105,6 +105,8 @@ func DropTables() {
 	DBpool.DropTableIfExists(&File{})
 	DBpool.DropTableIfExists(&Scenario{})
 	DBpool.DropTableIfExists(&User{})
+	DBpool.DropTableIfExists(&UserGroup{})
+	DBpool.DropTableIfExists(&ScenarioMapping{})
 	DBpool.DropTableIfExists(&Dashboard{})
 	DBpool.DropTableIfExists(&Widget{})
 	DBpool.DropTableIfExists(&Result{})
@@ -120,6 +122,8 @@ func MigrateModels() {
 	DBpool.AutoMigrate(&File{})
 	DBpool.AutoMigrate(&Scenario{})
 	DBpool.AutoMigrate(&User{})
+	DBpool.AutoMigrate(&UserGroup{})
+	DBpool.AutoMigrate(&ScenarioMapping{})
 	DBpool.AutoMigrate(&Dashboard{})
 	DBpool.AutoMigrate(&Widget{})
 	DBpool.AutoMigrate(&Result{})

database/models.go

@@ -48,6 +48,30 @@ type User struct {
 	Active bool `json:"active" gorm:"default:true"`
 	// Scenarios to which user has access
 	Scenarios []*Scenario `json:"-" gorm:"many2many:user_scenarios;"`
+	// Groups of user
+	UserGroups []*UserGroup `json:"-" gorm:"many2many:user_groups_users;"`
+}
+
+// ScenarioMapping data model
+type ScenarioMapping struct {
+	Model
+	ScenarioID  uint      `json:"scenarioID" ` // Foreign key to Scenario
+	Scenario    Scenario  `json:"-" gorm:"foreignkey:ScenarioID"`
+	UserGroupID uint      `json:"-"` // Foreign key to UserGroup
+	UserGroup   UserGroup `json:"-" gorm:"foreignkey:UserGroupID"`
+	// Whether to duplicate Scenario or add users 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"`
+	// Users that belong to the user group
+	Users []*User `json:"users" gorm:"many2many:user_groups_users;"`
 }
 
 // Scenario data model

database/permissions.go

@@ -142,6 +142,35 @@ func CheckSignalPermissions(c *gin.Context, operation CRUD) (bool, Signal) {
 
 }
 
+func CheckUserGroupPermissions(c *gin.Context, operation CRUD, userGroupIDSource string, usergroupIDBody 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
+	}
+
+	if operation == Create {
+		return true, usrgrp
+	}
+
+	groupID, err := helper.GetIDOfElement(c, "userGroupID", userGroupIDSource, usergroupIDBody)
+	if err != nil {
+		return false, usrgrp
+	}
+
+	db := GetDB()
+	err = db.Preload("ScenarioMappings.Scenario").First(&usrgrp, 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,