allocation_pools.go

package v1controllers

// allocation_pools.go defines pools of environments, where environments can be
// checked out as being in-use or released back into the pool

import (
	"errors"
	"github.com/broadinstitute/sherlock/internal/models/v1models"

	"gorm.io/gorm"
)

// AllocationPoolController is the management layer for AllocationPools
type AllocationPoolController struct {
	store v1models.AllocationPoolStore
}

// NewAllocationPoolController accepts a gorm DB connection and returns a new instance
// of the allocationPool controller
func NewAllocationPoolController(dbConn *gorm.DB) *AllocationPoolController {
	allocationPoolStore := v1models.NewAllocationPoolStore(dbConn)
	return &AllocationPoolController{
		store: allocationPoolStore,
	}
}

// DoesAllocationPoolExist is a helper method to check if a allocationPool with the given name
// already exists in sherlock's data storage
func (allocationPoolController AllocationPoolController) DoesAllocationPoolExist(name string) (int, bool) {
	allocationPool, err := allocationPoolController.GetByName(name)
	if errors.Is(err, v1models.ErrAllocationPoolNotFound) {
		return 0, false
	}
	return allocationPool.ID, true
}

// CreateNew is the public api on the allocationPoolController for persisting a new service entity to
// the data store
func (allocationPoolController *AllocationPoolController) CreateNew(newAllocationPool v1models.CreateAllocationPoolRequest) (v1models.AllocationPool, error) {
	return allocationPoolController.store.CreateNew(newAllocationPool)

}

// ListAll is the public api for listing out all AllocationPools tracked by sherlock
func (allocationPoolController *AllocationPoolController) ListAll() ([]v1models.AllocationPool, error) {
	return allocationPoolController.store.ListAll()

}

// GetByName is the public API for looking up a allocationPool from the data store by name
func (allocationPoolController *AllocationPoolController) GetByName(name string) (v1models.AllocationPool, error) {
	return allocationPoolController.store.GetByName(name)
}

// GetByID is the public API for looking up a allocationPool from the data store by name
func (allocationPoolController *AllocationPoolController) GetByID(id int) (v1models.AllocationPool, error) {
	return allocationPoolController.store.GetByID(id)
}

// AddEnvironmentByID takes a AllocationPoolObject and associates an existing environment to it.
func (allocationPoolController *AllocationPoolController) AddEnvironmentByID(currentAllocationPool v1models.AllocationPool, environmentID int) (v1models.AllocationPool, error) {
	return allocationPoolController.store.AddEnvironmentByID(currentAllocationPool, environmentID)
}