mock

Documentation

Index

• type Calls
• type Mock
  • func New() *Mock
  • func (m *Mock) DeclareFixedRoles(registrations ...accesscontrol.RoleRegistration) error
  • func (m *Mock) Evaluate(ctx context.Context, user *models.SignedInUser, ...) (bool, error)
  • func (m *Mock) GetUserBuiltInRoles(user *models.SignedInUser) []string
  • func (m *Mock) GetUserPermissions(ctx context.Context, user *models.SignedInUser) ([]*accesscontrol.Permission, error)
  • func (m *Mock) GetUserRoles(ctx context.Context, user *models.SignedInUser) ([]*accesscontrol.RoleDTO, error)
  • func (m *Mock) IsDisabled() bool
  • func (m *Mock) RegisterFixedRoles() error
  • func (m Mock) WithBuiltInRoles(builtInRoles []string) *Mock
  • func (m Mock) WithDisabled() *Mock
  • func (m Mock) WithPermissions(permissions []*accesscontrol.Permission) *Mock

Types

type Calls

type Calls struct {
	Evaluate            []interface{}
	GetUserPermissions  []interface{}
	GetUserRoles        []interface{}
	IsDisabled          []interface{}
	DeclareFixedRoles   []interface{}
	GetUserBuiltInRoles []interface{}
	RegisterFixedRoles  []interface{}
}

type Mock

type Mock struct {

	// Track the list of calls
	Calls Calls

	// Override functions
	EvaluateFunc            func(context.Context, *models.SignedInUser, accesscontrol.Evaluator) (bool, error)
	GetUserPermissionsFunc  func(context.Context, *models.SignedInUser) ([]*accesscontrol.Permission, error)
	GetUserRolesFunc        func(context.Context, *models.SignedInUser) ([]*accesscontrol.RoleDTO, error)
	IsDisabledFunc          func() bool
	DeclareFixedRolesFunc   func(...accesscontrol.RoleRegistration) error
	GetUserBuiltInRolesFunc func(user *models.SignedInUser) []string
	RegisterFixedRolesFunc  func() error
	// contains filtered or unexported fields
}

func New

func New() *Mock

func (*Mock) DeclareFixedRoles

func (m *Mock) DeclareFixedRoles(registrations ...accesscontrol.RoleRegistration) error

DeclareFixedRoles allow the caller to declare, to the service, fixed roles and their assignments to organization roles ("Viewer", "Editor", "Admin") or "Grafana Admin" This mock returns no error unless an override is provided.

func (*Mock) Evaluate

func (m *Mock) Evaluate(ctx context.Context, user *models.SignedInUser, evaluator accesscontrol.Evaluator) (bool, error)

Evaluate evaluates access to the given resource. This mock uses GetUserPermissions to then call the evaluator Evaluate function.

func (*Mock) GetUserBuiltInRoles

func (m *Mock) GetUserBuiltInRoles(user *models.SignedInUser) []string

GetUserBuiltInRoles returns the list of organizational roles ("Viewer", "Editor", "Admin") or "Grafana Admin" associated to a user This mock returns m.builtInRoles unless an override is provided.

func (*Mock) GetUserPermissions

func (m *Mock) GetUserPermissions(ctx context.Context, user *models.SignedInUser) ([]*accesscontrol.Permission, error)

GetUserPermissions returns user permissions. This mock return m.permissions unless an override is provided.

func (*Mock) GetUserRoles

func (m *Mock) GetUserRoles(ctx context.Context, user *models.SignedInUser) ([]*accesscontrol.RoleDTO, error)

func (*Mock) IsDisabled

func (m *Mock) IsDisabled() bool

Middleware checks if service disabled or not to switch to fallback authorization. This mock return m.disabled unless an override is provided.

func (*Mock) RegisterFixedRoles

func (m *Mock) RegisterFixedRoles() error

RegisterFixedRoles registers all roles declared to AccessControl This mock returns no error unless an override is provided.

func (Mock) WithBuiltInRoles

func (m Mock) WithBuiltInRoles(builtInRoles []string) *Mock

func (Mock) WithDisabled

func (m Mock) WithDisabled() *Mock

func (Mock) WithPermissions

func (m Mock) WithPermissions(permissions []*accesscontrol.Permission) *Mock