resource

Documentation

Index

• Constants
• Variables
• type ActivityService
• type ConfigRepository
• type Filter
• type GroupService
• type OrganizationService
• type PagedResources
• type ProjectService
• type RelationService
• type Repository
• type Resource
  • func (res Resource) CreateURN() string
  • func (resource Resource) ToResourceLogData() ResourceLogData
• type ResourceLogData
• type Service
  • func NewService(logger log.Logger, repository Repository, configRepository ConfigRepository, ...) *Service
  • func (s Service) AddOrgToResource(ctx context.Context, org organization.Organization, res Resource) error
  • func (s Service) AddProjectToResource(ctx context.Context, project project.Project, res Resource) error
  • func (s Service) CheckAuthz(ctx context.Context, res Resource, act action.Action) (bool, error)
  • func (s Service) Create(ctx context.Context, res Resource) (Resource, error)
  • func (s Service) Get(ctx context.Context, id string) (Resource, error)
  • func (s Service) GetAllConfigs(ctx context.Context) ([]YAML, error)
  • func (s Service) List(ctx context.Context, flt Filter) (PagedResources, error)
  • func (s Service) Update(ctx context.Context, id string, resource Resource) (Resource, error)
• type UserService
• type YAML

Constants

const (
	NON_RESOURCE_ID = "*"
)

Variables

var (
	ErrNotExist      = errors.New("resource doesn't exist")
	ErrInvalidUUID   = errors.New("invalid syntax of uuid")
	ErrInvalidID     = errors.New("resource id is invalid")
	ErrInvalidURN    = errors.New("resource urn is invalid")
	ErrConflict      = errors.New("resource already exist")
	ErrInvalidDetail = errors.New("invalid resource detail")
	ErrLogActivity   = errors.New("error while logging activity")
)

Types

type ActivityService

type ActivityService interface {
	Log(ctx context.Context, action string, actor activity.Actor, data any) error
}

type ConfigRepository

type ConfigRepository interface {
	GetAll(ctx context.Context) ([]YAML, error)
}

type Filter

type Filter struct {
	ProjectID      string
	GroupID        string
	OrganizationID string
	NamespaceID    string
	Limit          int32
	Page           int32
}

type GroupService

type GroupService interface {
	Get(ctx context.Context, id string) (group.Group, error)
}

type OrganizationService

type OrganizationService interface {
	Get(ctx context.Context, id string) (organization.Organization, error)
}

type PagedResources

type PagedResources struct {
	Count     int32
	Resources []Resource
}

type ProjectService

type ProjectService interface {
	Get(ctx context.Context, id string) (project.Project, error)
}

type RelationService

type RelationService interface {
	Create(ctx context.Context, rel relation.RelationV2) (relation.RelationV2, error)
	Delete(ctx context.Context, rel relation.Relation) error
	CheckPermission(ctx context.Context, usr user.User, resourceNS namespace.Namespace, resourceIdxa string, action action.Action) (bool, error)
	DeleteSubjectRelations(ctx context.Context, resourceType, optionalResourceID string) error
}

type Repository

type Repository interface {
	GetByID(ctx context.Context, id string) (Resource, error)
	GetByURN(ctx context.Context, urn string) (Resource, error)
	Create(ctx context.Context, resource Resource) (Resource, error)
	List(ctx context.Context, flt Filter) ([]Resource, error)
	Update(ctx context.Context, id string, resource Resource) (Resource, error)
	GetByNamespace(ctx context.Context, name string, ns string) (Resource, error)
}

type Resource

type Resource struct {
	Idxa           string
	URN            string
	Name           string
	ProjectID      string
	OrganizationID string
	NamespaceID    string
	UserID         string
	CreatedAt      time.Time
	UpdatedAt      time.Time
}

func (Resource) CreateURN

func (res Resource) CreateURN() string

func (Resource) ToResourceLogData

func (resource Resource) ToResourceLogData() ResourceLogData

type ResourceLogData

type ResourceLogData struct {
	Entity         string `mapstructure:"entity"`
	URN            string `mapstructure:"urn"`
	Name           string `mapstructure:"name"`
	OrganizationID string `mapstructure:"organization_id"`
	ProjectID      string `mapstructure:"project_id"`
	NamespaceID    string `mapstructure:"namespace_id"`
	UserID         string `mapstructure:"user_id"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(logger log.Logger, repository Repository, configRepository ConfigRepository, relationService RelationService, userService UserService, projectService ProjectService, organizationService OrganizationService, groupService GroupService, activityService ActivityService) *Service

func (Service) AddOrgToResource

func (s Service) AddOrgToResource(ctx context.Context, org organization.Organization, res Resource) error

func (Service) AddProjectToResource

func (s Service) AddProjectToResource(ctx context.Context, project project.Project, res Resource) error

func (Service) CheckAuthz

func (s Service) CheckAuthz(ctx context.Context, res Resource, act action.Action) (bool, error)

TODO(krkvrm): Separate Authz for Resources & System Namespaces

func (Service) Create

func (s Service) Create(ctx context.Context, res Resource) (Resource, error)

func (Service) Get

func (s Service) Get(ctx context.Context, id string) (Resource, error)

func (Service) GetAllConfigs

func (s Service) GetAllConfigs(ctx context.Context) ([]YAML, error)

func (Service) List

func (s Service) List(ctx context.Context, flt Filter) (PagedResources, error)

func (Service) Update

func (s Service) Update(ctx context.Context, id string, resource Resource) (Resource, error)

type UserService

type UserService interface {
	FetchCurrentUser(ctx context.Context) (user.User, error)
}

type YAML

type YAML struct {
	Name         string              `json:"name" yaml:"name"`
	Backend      string              `json:"backend" yaml:"backend"`
	ResourceType string              `json:"resource_type" yaml:"resource_type"`
	Actions      map[string][]string `json:"actions" yaml:"actions"`
}