d2b09d854f
Implement a new error handling library based on pkg/errors. It provides stack saving on wrapping and exports some function to add stack saving also to external errors. It also implements custom zerolog error formatting without adding too much verbosity by just printing the chain error file:line without a full stack trace of every error. * Add a --detailed-errors options to print error with they full chain * Wrap all error returns. Use errors.WithStack to wrap without adding a new messsage and error.Wrap[f] to add a message. * Add golangci-lint wrapcheck to check that external packages errors are wrapped. This won't check that internal packages error are wrapped. But we want also to ensure this case so we'll have to find something else to check also these.
372 lines
12 KiB
Go
372 lines
12 KiB
Go
// Copyright 2019 Sorint.lab
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package action
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"path"
|
|
"strings"
|
|
|
|
"agola.io/agola/internal/datamanager"
|
|
"agola.io/agola/internal/db"
|
|
"agola.io/agola/internal/errors"
|
|
|
|
"agola.io/agola/internal/util"
|
|
"agola.io/agola/services/configstore/types"
|
|
|
|
"github.com/gofrs/uuid"
|
|
)
|
|
|
|
func (h *ActionHandler) GetProjectGroup(ctx context.Context, projectGroupRef string) (*types.ProjectGroup, error) {
|
|
var projectGroup *types.ProjectGroup
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
var err error
|
|
projectGroup, err = h.readDB.GetProjectGroup(tx, projectGroupRef)
|
|
return errors.WithStack(err)
|
|
})
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
if projectGroup == nil {
|
|
return nil, util.NewAPIError(util.ErrNotExist, errors.Errorf("project group %q doesn't exist", projectGroupRef))
|
|
}
|
|
|
|
return projectGroup, nil
|
|
}
|
|
|
|
func (h *ActionHandler) GetProjectGroupSubgroups(ctx context.Context, projectGroupRef string) ([]*types.ProjectGroup, error) {
|
|
var projectGroups []*types.ProjectGroup
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
var err error
|
|
projectGroup, err := h.readDB.GetProjectGroup(tx, projectGroupRef)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
if projectGroup == nil {
|
|
return util.NewAPIError(util.ErrNotExist, errors.Errorf("project group %q doesn't exist", projectGroupRef))
|
|
}
|
|
|
|
projectGroups, err = h.readDB.GetProjectGroupSubgroups(tx, projectGroup.ID)
|
|
return errors.WithStack(err)
|
|
})
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
return projectGroups, nil
|
|
}
|
|
|
|
func (h *ActionHandler) GetProjectGroupProjects(ctx context.Context, projectGroupRef string) ([]*types.Project, error) {
|
|
var projects []*types.Project
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
var err error
|
|
projectGroup, err := h.readDB.GetProjectGroup(tx, projectGroupRef)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
if projectGroup == nil {
|
|
return util.NewAPIError(util.ErrNotExist, errors.Errorf("project group %q doesn't exist", projectGroupRef))
|
|
}
|
|
|
|
projects, err = h.readDB.GetProjectGroupProjects(tx, projectGroup.ID)
|
|
return errors.WithStack(err)
|
|
})
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
return projects, nil
|
|
}
|
|
|
|
func (h *ActionHandler) ValidateProjectGroup(ctx context.Context, projectGroup *types.ProjectGroup) error {
|
|
if projectGroup.Parent.Type != types.ConfigTypeProjectGroup &&
|
|
projectGroup.Parent.Type != types.ConfigTypeOrg &&
|
|
projectGroup.Parent.Type != types.ConfigTypeUser {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("invalid project group parent type %q", projectGroup.Parent.Type))
|
|
}
|
|
if projectGroup.Parent.ID == "" {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group parent id required"))
|
|
}
|
|
|
|
// if the project group is a root project group the name must be empty
|
|
if projectGroup.Parent.Type == types.ConfigTypeOrg ||
|
|
projectGroup.Parent.Type == types.ConfigTypeUser {
|
|
if projectGroup.Name != "" {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group name for root project group must be empty"))
|
|
}
|
|
} else {
|
|
if projectGroup.Name == "" {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group name required"))
|
|
}
|
|
if !util.ValidateName(projectGroup.Name) {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("invalid project group name %q", projectGroup.Name))
|
|
}
|
|
}
|
|
if !types.IsValidVisibility(projectGroup.Visibility) {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("invalid project group visibility"))
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (h *ActionHandler) CreateProjectGroup(ctx context.Context, projectGroup *types.ProjectGroup) (*types.ProjectGroup, error) {
|
|
if err := h.ValidateProjectGroup(ctx, projectGroup); err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
if projectGroup.Parent.Type != types.ConfigTypeProjectGroup {
|
|
return nil, util.NewAPIError(util.ErrBadRequest, errors.Errorf("wrong project group parent type %q", projectGroup.Parent.Type))
|
|
}
|
|
|
|
var cgt *datamanager.ChangeGroupsUpdateToken
|
|
|
|
// must do all the checks in a single transaction to avoid concurrent changes
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
parentProjectGroup, err := h.readDB.GetProjectGroup(tx, projectGroup.Parent.ID)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if parentProjectGroup == nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with id %q doesn't exist", projectGroup.Parent.ID))
|
|
}
|
|
// TODO(sgotti) now we are doing a very ugly thing setting the request
|
|
// projectgroup parent ID that can be both an ID or a ref. Then we are fixing
|
|
// it to an ID here. Change the request format to avoid this.
|
|
projectGroup.Parent.ID = parentProjectGroup.ID
|
|
|
|
groupPath, err := h.readDB.GetProjectGroupPath(tx, parentProjectGroup)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
pp := path.Join(groupPath, projectGroup.Name)
|
|
|
|
// changegroup is the projectgroup path. Use "projectpath" prefix as it must
|
|
// cover both projects and projectgroups
|
|
cgNames := []string{util.EncodeSha256Hex("projectpath-" + pp)}
|
|
cgt, err = h.readDB.GetChangeGroupsUpdateTokens(tx, cgNames)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
// check duplicate project group name
|
|
pg, err := h.readDB.GetProjectGroupByName(tx, projectGroup.Parent.ID, projectGroup.Name)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if pg != nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with name %q, path %q already exists", pg.Name, pp))
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
projectGroup.ID = uuid.Must(uuid.NewV4()).String()
|
|
projectGroup.Parent.Type = types.ConfigTypeProjectGroup
|
|
|
|
pgj, err := json.Marshal(projectGroup)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "failed to marshal projectGroup")
|
|
}
|
|
actions := []*datamanager.Action{
|
|
{
|
|
ActionType: datamanager.ActionTypePut,
|
|
DataType: string(types.ConfigTypeProjectGroup),
|
|
ID: projectGroup.ID,
|
|
Data: pgj,
|
|
},
|
|
}
|
|
|
|
_, err = h.dm.WriteWal(ctx, actions, cgt)
|
|
return projectGroup, errors.WithStack(err)
|
|
}
|
|
|
|
type UpdateProjectGroupRequest struct {
|
|
ProjectGroupRef string
|
|
|
|
ProjectGroup *types.ProjectGroup
|
|
}
|
|
|
|
func (h *ActionHandler) UpdateProjectGroup(ctx context.Context, req *UpdateProjectGroupRequest) (*types.ProjectGroup, error) {
|
|
if err := h.ValidateProjectGroup(ctx, req.ProjectGroup); err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
var cgt *datamanager.ChangeGroupsUpdateToken
|
|
|
|
// must do all the checks in a single transaction to avoid concurrent changes
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
var err error
|
|
// check project exists
|
|
pg, err := h.readDB.GetProjectGroup(tx, req.ProjectGroupRef)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if pg == nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with ref %q doesn't exist", req.ProjectGroupRef))
|
|
}
|
|
// check that the project group ID matches
|
|
if pg.ID != req.ProjectGroup.ID {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with ref %q has a different id", req.ProjectGroupRef))
|
|
}
|
|
|
|
if pg.Parent.Type != req.ProjectGroup.Parent.Type {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("changing project group parent type isn't supported"))
|
|
}
|
|
|
|
switch req.ProjectGroup.Parent.Type {
|
|
case types.ConfigTypeOrg:
|
|
fallthrough
|
|
case types.ConfigTypeUser:
|
|
// Cannot update root project group parent
|
|
if pg.Parent.Type != req.ProjectGroup.Parent.Type || pg.Parent.ID != req.ProjectGroup.Parent.ID {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("cannot change root project group parent type or id"))
|
|
}
|
|
// if the project group is a root project group force the name to be empty
|
|
req.ProjectGroup.Name = ""
|
|
|
|
case types.ConfigTypeProjectGroup:
|
|
// check parent exists
|
|
group, err := h.readDB.GetProjectGroup(tx, req.ProjectGroup.Parent.ID)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if group == nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with id %q doesn't exist", req.ProjectGroup.Parent.ID))
|
|
}
|
|
// TODO(sgotti) now we are doing a very ugly thing setting the request
|
|
// projectgroup parent ID that can be both an ID or a ref. Then we are fixing
|
|
// it to an ID here. Change the request format to avoid this.
|
|
req.ProjectGroup.Parent.ID = group.ID
|
|
}
|
|
|
|
curPGParentPath, err := h.readDB.GetPath(tx, pg.Parent.Type, pg.Parent.ID)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
curPGP := path.Join(curPGParentPath, pg.Name)
|
|
|
|
pgParentPath, err := h.readDB.GetPath(tx, req.ProjectGroup.Parent.Type, req.ProjectGroup.Parent.ID)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
pgp := path.Join(pgParentPath, req.ProjectGroup.Name)
|
|
|
|
if pg.Name != req.ProjectGroup.Name || pg.Parent.ID != req.ProjectGroup.Parent.ID {
|
|
// check duplicate project group name
|
|
ap, err := h.readDB.GetProjectGroupByName(tx, req.ProjectGroup.Parent.ID, req.ProjectGroup.Name)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if ap != nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group with name %q, path %q already exists", req.ProjectGroup.Name, pgp))
|
|
}
|
|
// Cannot move inside itself or a child project group
|
|
if strings.HasPrefix(pgp, curPGP+"/") {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("cannot move project group inside itself or child project group"))
|
|
}
|
|
}
|
|
|
|
// changegroup is the project group path. Use "projectpath" prefix as it must
|
|
// cover both projects and projectgroups
|
|
cgNames := []string{util.EncodeSha256Hex("projectpath-" + pgp)}
|
|
|
|
// add new projectpath
|
|
if pg.Parent.ID != req.ProjectGroup.Parent.ID {
|
|
cgNames = append(cgNames, util.EncodeSha256Hex("projectpath-"+pgp))
|
|
}
|
|
|
|
cgt, err = h.readDB.GetChangeGroupsUpdateTokens(tx, cgNames)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return nil, errors.WithStack(err)
|
|
}
|
|
|
|
pgj, err := json.Marshal(req.ProjectGroup)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "failed to marshal project")
|
|
}
|
|
actions := []*datamanager.Action{
|
|
{
|
|
ActionType: datamanager.ActionTypePut,
|
|
DataType: string(types.ConfigTypeProjectGroup),
|
|
ID: req.ProjectGroup.ID,
|
|
Data: pgj,
|
|
},
|
|
}
|
|
|
|
_, err = h.dm.WriteWal(ctx, actions, cgt)
|
|
return req.ProjectGroup, errors.WithStack(err)
|
|
}
|
|
|
|
func (h *ActionHandler) DeleteProjectGroup(ctx context.Context, projectGroupRef string) error {
|
|
var projectGroup *types.ProjectGroup
|
|
|
|
var cgt *datamanager.ChangeGroupsUpdateToken
|
|
|
|
// must do all the checks in a single transaction to avoid concurrent changes
|
|
err := h.readDB.Do(ctx, func(tx *db.Tx) error {
|
|
var err error
|
|
|
|
// check project group existance
|
|
projectGroup, err = h.readDB.GetProjectGroup(tx, projectGroupRef)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
if projectGroup == nil {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("project group %q doesn't exist", projectGroupRef))
|
|
}
|
|
|
|
// cannot delete root project group
|
|
if projectGroup.Parent.Type == types.ConfigTypeOrg ||
|
|
projectGroup.Parent.Type == types.ConfigTypeUser {
|
|
return util.NewAPIError(util.ErrBadRequest, errors.Errorf("cannot delete root project group"))
|
|
}
|
|
|
|
// changegroup is the project group id.
|
|
cgNames := []string{util.EncodeSha256Hex(projectGroup.ID)}
|
|
cgt, err = h.readDB.GetChangeGroupsUpdateTokens(tx, cgNames)
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return errors.WithStack(err)
|
|
}
|
|
|
|
// TODO(sgotti) implement childs garbage collection
|
|
actions := []*datamanager.Action{
|
|
{
|
|
ActionType: datamanager.ActionTypeDelete,
|
|
DataType: string(types.ConfigTypeProjectGroup),
|
|
ID: projectGroup.ID,
|
|
},
|
|
}
|
|
|
|
_, err = h.dm.WriteWal(ctx, actions, cgt)
|
|
return errors.WithStack(err)
|
|
}
|