import "github.com/luci/luci-go/milo/common"
acl.go config.go pubsub.go time.go utils.go
const ServiceConfigID = "service_config"
ServiceConfigID is the key for the service config entity in datastore.
ErrConsoleNotFound is returned from GetConsole if the requested console isn't known to exist.
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.
CheckACL returns true if the caller is in the ACL.
Returns an internal error if the check itself fails.
Duration returns duration between start and the earliest of ends. Ignores nil ends. Fallbacks to "N/A" on insufficient data.
EnsurePubSubSubscribed makes sure the following subscriptions are in place: * buildbucket, via the settings.Buildbucket.Topic setting
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.
HumanDuration translates d into a human readable string of x units y units, where x and y could be in days, hours, minutes, or seconds, whichever is the largest.
IsAllowed checks to see if the user in the context is allowed to access the given project.
Returns false for unknown projects. Returns an internal error if the check itself fails.
func LegacyBuilderIDString(bid *buildbucketpb.BuilderID) string
LegacyBuilderIDString returns a legacy string identifying the builder. It is used in the Milo datastore.
MergeStrings merges multiple string slices together into a single slice, removing duplicates.
ObfuscateEmail converts a string containing email address email@address.com into email<junk>@address.com.
ParseIntFromForm parses an integer from a form.
ReadExactOneFromForm read a string from a form. There must be exactly one and non-empty entry of the given key in the form.
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.ErrNoSuchEntity or replaces it with replacement instances, and returns an error generated by errors.LazyMultiError.
ShortenEmail shortens Google emails.
TagGRPC annotates some gRPC with Milo specific semantics, specifically: * Marks the error as Unauthorized if the user is not logged in, and the underlying error was a 403 or 404. * Otherwise, tag the error with the original error code.
UpdateProjects reads project configs from LUCI Config and updates entities.
Visits all LUCI projects (not only ones that have Milo config) to grab their visibility ACL from project.cfg file.
UpdateServiceConfig fetches the service config from luci-config and then stores a snapshot of the configuration in datastore.
WithAccessClient attaches an AccessClient to the given context.
ACL lists groups and identities that are allowed to see consoles in a project.
Fetched from project.cfg config file in fetchProjectACL.
type AccessClient struct { accessProto.AccessClient Host string }
AccessClient wraps an accessProto.AccessClient and exports its Host.
func GetAccessClient(c context.Context) *AccessClient
GetAccessClient retrieves an AccessClient from the given context.
func NewAccessClient(c context.Context) (*AccessClient, error)
NewAccessClient creates a new AccessClient for talking to this milo instance's buildbucket instance.
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. // This ID is local to the console, i.e. it should equal .Def.Id and not // Def.ExternalId. 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 revision 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. // If this console is external (i.e. a reference to a console from // another project), this will contain the resolved Console definition, // but with ExternalId and ExternalProject also set. Def config.Console `gae:",noindex"` // Realm that the console exists under. Realm string // contains filtered or unexported fields }
Console is a datastore entity representing a single console.
GetAllConsoles returns all Consoles (across all projects) which contain the builder ID. If builderID is empty, then this retrieves all Consoles.
TODO-perf(iannucci): Maybe memcache this too.
GetConsole returns the requested console.
TODO-perf(iannucci,hinoka): Memcache this.
GetConsoles returns the requested consoles. Excludes references to external consoles that the user does not have access to.
TODO-perf(iannucci,hinoka): Memcache this.
GetProjectConsoles returns all consoles for the given project ordered as in config. Excludes references to external consoles that the user does not have access to.
Buckets returns all buckets referenced by this Console's Builders.
ConsoleID returns a struct containing ID strings for the console and its parent project.
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.
IsExternal returns whether the console is a reference to a console from another project. If this is the case, the console will have Def.ExternalProject and Def.ExternalId set.
ProjectID retrieves the project ID string of the console out of the Console's parent key.
ConsoleID is a reference to a console.
ParseConsoleID reformats the string into a ConsoleID.
SetID returns an empty Console datastore entity keyed with itself.
type Interval struct { Start time.Time `json:"start,omitempty"` End time.Time `json:"end,omitempty"` Now time.Time `json:"now,omitempty"` }
type Project struct { ID string `gae:"$id"` HasConfig bool ACL ACL `gae:",noindex"` LogoURL string BuildBugTemplate config.BugTemplate IgnoredBuilderIDs []string // contains filtered or unexported fields }
Project is a datastore entity representing a single project.
Its children are consoles. This entity exists even if the project doesn't define milo.cfg config file. It has HasConfig == false in this case. We still need the entity to be able to check project's ACLs when accessing individual build pages.
GetProject loads the project from the datastore.
GetVisibleProjects returns all projects with consoles the current user has access to.
Skips projects that do not have Milo config file.
func (p *Project) BuilderIsIgnored(builderID *buildbucketpb.BuilderID) bool
BuilderIsIgnored checks if the builder is marked as ignored in this project.
type PubSubMessage struct { Attributes map[string]interface{} `json:"attributes"` Data string `json:"data"` MessageID string `json:"message_id"` }
type PubSubSubscription struct { Message PubSubMessage `json:"message"` Subscription string `json:"subscription"` }
func (m *PubSubSubscription) GetData() ([]byte, error)
GetData returns the expanded form of Data (decoded from base64).
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(c context.Context) (*ServiceConfig, error)
GetCurrentServiceConfig gets the service config for the instance from either process cache or datastore cache.
Path | Synopsis |
---|---|
model |
Package common imports 39 packages (graph) and is imported by 7 packages. Updated 2020-12-29. Refresh now. Tools for package owners.