common

package
v0.0.0-...-1643519 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source 
const ServiceConfigID = "service_config"

ServiceConfigID is the key for the service config entity in datastore.

Variables

View Source 
var ErrConsoleNotFound = errors.New("console not found", CodeNotFound)

ErrConsoleNotFound is returned from GetConsole if the requested console isn't known to exist.

Functions

func BucketPermissions 

func BucketPermissions(c context.Context, buckets ...string) (bbAccess.Permissions, error)

BucketPermissions gets permissions for the current identity for all given buckets.

TODO(mknyszek): If a cache entry expires, then there could be QPS issues if all instances query buildbucket for an update simultaneously. Evaluate whether there's an issue in practice, and if so, consider expiring cache entries randomly.

func EnsurePubSubSubscribed 

func EnsurePubSubSubscribed(c context.Context, settings *config.Settings) error

EnsurePubSubSubscribed makes sure the following subscriptions are in place: * buildbucket, via the settings.Buildbucket.Topic setting

func GetSettings 

func GetSettings(c context.Context) *config.Settings

GetSettings returns the service (aka global) config for the current instance of Milo from the datastore. Returns an empty config and warn heavily if none is found. TODO(hinoka): Use process cache to cache configs.

func IsAdmin 

func IsAdmin(c context.Context) (bool, error)

IsAdmin returns true if the current identity is an administrator.

func IsAllowed 

func IsAllowed(c context.Context, project string) (bool, error)

IsAllowed checks to see if the user in the context is allowed to access the given project.

func LuciConfigURL 

func LuciConfigURL(c context.Context, configSet, path, revision string) string

LuciConfigURL returns a user friendly URL that specifies where to view this console definition.

func ReplaceNSEWith 

func ReplaceNSEWith(err errors.MultiError, replacement error) error

ReplaceNSEWith takes an errors.MultiError returned by a datastore.Get() on a slice (which is always a MultiError), filters out all datastore.ErrNoSuchEntitiy or replaces it with replacement instances, and returns an error generated by errors.LazyMultiError.

func UpdateConsoles 

func UpdateConsoles(c context.Context) error

UpdateConsoles updates internal console definitions entities based off luci-config.

func UpdateServiceConfig 

func UpdateServiceConfig(c context.Context) (*config.Settings, error)

UpdateServiceConfig fetches the service config from luci-config and then stores a snapshot of the configuration in datastore.

func WithAccessClient 

func WithAccessClient(c context.Context, a *AccessClient) context.Context

WithAccessClient attaches an AccessClient to the given context.

Types

type AccessClient 

type AccessClient struct {
	accessProto.AccessClient
	Host string
}

AccessClient wraps an accessProto.AccessClient and exports its Host.

func GetAccessClient 

func GetAccessClient(c context.Context) *AccessClient

GetAccessClient retrieves an AccessClient from the given context.

func NewAccessClient 

func NewAccessClient(c context.Context) (*AccessClient, error)

NewAccessClient creates a new AccessClient for talking to this milo instance's buildbucket instance.

type Console 

type Console struct {
	// Parent is a key to the parent Project entity where this console was
	// defined in.
	Parent *datastore.Key `gae:"$parent"`

	// ID is the ID of the console.
	ID string `gae:"$id"`

	// Ordinal specifies the console's ordering in its project's consoles list.
	Ordinal int

	// The URL to the luci-config definition of this console.
	ConfigURL string

	// The luci-config reivision from when this Console was retrieved.
	ConfigRevision string `gae:",noindex"`

	// (indexed) All builder IDs mentioned by this console config.
	Builders []string

	// Def is the actual underlying proto Console definition.
	Def config.Console `gae:",noindex"`
	// contains filtered or unexported fields
}

Console is a datastore entity representing a single console.

func GetAllConsoles 

func GetAllConsoles(c context.Context, builderID string) ([]*Console, error)

GetAllConsoles returns all Consoles (across all projects) which contian the builder ID. If builderID is empty, then this retrieves all Consoles.

TODO-perf(iannucci): Maybe memcache this too.

func GetConsole 

func GetConsole(c context.Context, proj, id string) (*Console, error)

GetConsole returns the requested console.

TODO-perf(iannucci,hinoka): Memcache this.

func GetConsoles 

func GetConsoles(c context.Context, consoles []ConsoleID) ([]*Console, error)

GetConsoles returns the requested consoles.

TODO-perf(iannucci,hinoka): Memcache this.

func GetProjectConsoles 

func GetProjectConsoles(c context.Context, projectID string) ([]*Console, error)

GetProjectConsoles returns all consoles for the given project ordered as in config.

func (*Console) Buckets 

func (c *Console) Buckets() stringset.Set

Buckets returns all buckets referenced by this Console's Builders.

func (*Console) ConsoleID 

func (c *Console) ConsoleID() ConsoleID

func (*Console) FilterBuilders 

func (c *Console) FilterBuilders(perms access.Permissions)

FilterBuilders uses an access.Permissions to filter out builder IDs and builders from the definition, and builders in the definition's header, which are not allowed by the permissions.

func (*Console) ProjectID 

func (c *Console) ProjectID() string

ProjectID retrieves the project ID string of the console out of the Console's parent key.

type ConsoleID 

type ConsoleID struct {
	Project string
	ID      string
}

ConsoleID is a reference to a console.

func ParseConsoleID 

func ParseConsoleID(id string) (cid ConsoleID, err error)

func (*ConsoleID) SetID 

func (id *ConsoleID) SetID(c context.Context, console *Console) *Console

NewEntity returns an empty Console datastore entity keyed with itself.

func (*ConsoleID) String 

func (id *ConsoleID) String() string

type ErrorCode 

type ErrorCode int

ErrorCode represents milo's internal error code system. The subsystems in milo can attach an ErrorCode to an error (using ErrorTag), and then the html and grpc frontends know how to render the error in a way that will help the user. 

const (
	// CodeUnknown means an error happened, but we weren't able to classify it.
	CodeUnknown ErrorCode = iota

	// CodeUnauthorized occurs when a user isn't logged in, but needs to be to
	// proceed further.
	CodeUnauthorized

	// CodeNoAccess occurs when the currently logged-in user is not permitted to
	// see the resource.
	CodeNoAccess

	// CodeNotFound occurs when we weren't able to find the build that the
	// user asked for.
	CodeNotFound

	// CodeParameterError occurs when one or more of the user-provided parameters
	// was malformed.
	CodeParameterError

	// CodeOK indicates absense of any error.
	CodeOK
)

func ErrorCodeIn 

func ErrorCodeIn(err error) ErrorCode

ErrorCodeIn returns the ErrorCode in err. If err is nil, returns CodeOK. If not present, returns CodeUnknown.

func (ErrorCode) GenerateErrorTagValue 

func (c ErrorCode) GenerateErrorTagValue() errors.TagValue

GenerateErrorTagValue implements errors.TagValueGenerator so that ErrorCodes can be used like: 

errors.Annotate(err).Tag(CodeNotFound)
errors.New("terrible thing", CodeNotFound)

func (ErrorCode) HTTPStatus 

func (c ErrorCode) HTTPStatus() int

HTTPStatus returns an HTTP Status code corresponding to this ErrorCode.

func (ErrorCode) Tag 

func (c ErrorCode) Tag() errors.TagValue

Tag returns an errors.TagValue for this code.

type Project 

type Project struct {
	ID      string `gae:"$id"`
	LogoURL string
}

Project is a datastore entity representing a single project. Its children are consoles.

func GetAllProjects 

func GetAllProjects(c context.Context) ([]Project, error)

GetAllProjects returns all projects the current user has access to.

type PubSubMessage 

type PubSubMessage struct {
	Attributes map[string]interface{} `json:"attributes"`
	Data       string                 `json:"data"`
	MessageID  string                 `json:"message_id"`
}

type PubSubSubscription 

type PubSubSubscription struct {
	Message      PubSubMessage `json:"message"`
	Subscription string        `json:"subscription"`
}

func (*PubSubSubscription) GetData 

func (m *PubSubSubscription) GetData() ([]byte, error)

GetData returns the expanded form of Data (decoded from base64).

type ServiceConfig 

type ServiceConfig struct {
	// ID is the datastore key.  This should be static, as there should only be
	// one service config.
	ID string `gae:"$id"`
	// Revision is the revision of the config, taken from luci-config.  This is used
	// to determine if the entry needs to be refreshed.
	Revision string
	// Data is the binary proto of the config.
	Data []byte `gae:",noindex"`
	// Text is the text format of the config.  For human consumption only.
	Text string `gae:",noindex"`
	// LastUpdated is the time this config was last updated.
	LastUpdated time.Time
}

ServiceConfig is a container for the instance's service config.

func GetCurrentServiceConfig 

func GetCurrentServiceConfig(c context.Context) (*ServiceConfig, error)

GetCurrentServiceConfig gets the service config for the instance from either process cache or datastore cache.

type TestBundle 

type TestBundle struct {
	// Description is a short one line description of what the data contains.
	Description string
	// Data is the data fed directly into the template.
	Data templates.Args
}

TestBundle is a template arg associated with a description used for testing.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.