portainer/portainer

View on GitHub
api/http/handler/edgegroups/edgegroup_create.go

Summary

Maintainability
A
1 hr
Test Coverage
package edgegroups

import (
    "errors"
    "net/http"

    portainer "github.com/portainer/portainer/api"
    "github.com/portainer/portainer/api/dataservices"
    "github.com/portainer/portainer/api/internal/endpointutils"
    httperror "github.com/portainer/portainer/pkg/libhttp/error"
    "github.com/portainer/portainer/pkg/libhttp/request"

    "github.com/asaskevich/govalidator"
)

type edgeGroupCreatePayload struct {
    Name         string
    Dynamic      bool
    TagIDs       []portainer.TagID
    Endpoints    []portainer.EndpointID
    PartialMatch bool
}

func (payload *edgeGroupCreatePayload) Validate(r *http.Request) error {
    if govalidator.IsNull(payload.Name) {
        return errors.New("invalid Edge group name")
    }

    if payload.Dynamic && len(payload.TagIDs) == 0 {
        return errors.New("tagIDs is mandatory for a dynamic Edge group")
    }

    return nil
}

func calculateEndpointsOrTags(tx dataservices.DataStoreTx, edgeGroup *portainer.EdgeGroup, endpoints []portainer.EndpointID, tagIDs []portainer.TagID) error {
    if edgeGroup.Dynamic {
        edgeGroup.TagIDs = tagIDs
    } else {
        endpointIDs := []portainer.EndpointID{}

        for _, endpointID := range endpoints {
            endpoint, err := tx.Endpoint().Endpoint(endpointID)
            if err != nil {
                return httperror.InternalServerError("Unable to retrieve environment from the database", err)
            }

            if endpointutils.IsEdgeEndpoint(endpoint) {
                endpointIDs = append(endpointIDs, endpoint.ID)
            }
        }

        edgeGroup.Endpoints = endpointIDs
    }

    return nil
}

// @id EdgeGroupCreate
// @summary Create an EdgeGroup
// @description **Access policy**: administrator
// @tags edge_groups
// @security ApiKeyAuth
// @security jwt
// @accept json
// @produce json
// @param body body edgeGroupCreatePayload true "EdgeGroup data"
// @success 200 {object} portainer.EdgeGroup
// @failure 503 "Edge compute features are disabled"
// @failure 500
// @router /edge_groups [post]
func (handler *Handler) edgeGroupCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
    var payload edgeGroupCreatePayload
    err := request.DecodeAndValidateJSONPayload(r, &payload)
    if err != nil {
        return httperror.BadRequest("Invalid request payload", err)
    }

    var edgeGroup *portainer.EdgeGroup
    err = handler.DataStore.UpdateTx(func(tx dataservices.DataStoreTx) error {
        edgeGroups, err := tx.EdgeGroup().ReadAll()
        if err != nil {
            return httperror.InternalServerError("Unable to retrieve Edge groups from the database", err)
        }

        for _, edgeGroup := range edgeGroups {
            if edgeGroup.Name == payload.Name {
                return httperror.BadRequest("Edge group name must be unique", errors.New("edge group name must be unique"))
            }
        }

        edgeGroup = &portainer.EdgeGroup{
            Name:         payload.Name,
            Dynamic:      payload.Dynamic,
            TagIDs:       []portainer.TagID{},
            Endpoints:    []portainer.EndpointID{},
            PartialMatch: payload.PartialMatch,
        }

        if err := calculateEndpointsOrTags(tx, edgeGroup, payload.Endpoints, payload.TagIDs); err != nil {
            return err
        }

        err = tx.EdgeGroup().Create(edgeGroup)
        if err != nil {
            return httperror.InternalServerError("Unable to persist the Edge group inside the database", err)
        }

        return nil
    })

    return txResponse(w, edgeGroup, err)
}