milo/api/resp/build.go - external/github.com/luci/luci-go - Git at Google

 // Copyright 2015 The LUCI Authors.
 //
 // 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.

 //go:generate stringer -type=Verbosity
 //go:generate stringer -type=ComponentType

 package resp

 import (
 	"encoding/hex"
 	"encoding/json"
 	"strings"
 	"time"

 	"golang.org/x/net/context"

 	"github.com/luci/luci-go/common/logging"
 	"github.com/luci/luci-go/milo/common"
 	"github.com/luci/luci-go/milo/common/model"
 )

 // MiloBuild denotes a full renderable Milo build page.
 type MiloBuild struct {
 	// Summary is a top level summary of the page.
 	Summary BuildComponent

 	// SourceStamp gives information about how the build came about.
 	SourceStamp *SourceStamp

 	// Components is a detailed list of components and subcomponents of the page.
 	// This is most often used for steps (buildbot/luci) or deps (luci).
 	Components []*BuildComponent

 	// PropertyGroup is a list of input and output property of this page.
 	// This is used for build and emitted properties (buildbot) and quest
 	// information (luci).  This is also grouped by the "type" of property
 	// so different categories of properties can be separated and sorted.
 	//
 	// This is not a map so code that constructs MiloBuild can control the
 	// order of property groups, for example show important properties
 	// first.
 	PropertyGroup []*PropertyGroup

 	// Blame is a list of people and commits that is likely to be in relation to
 	// the thing displayed on this page.
 	Blame []*Commit
 }

 // SourceStamp is the combination of pointing to a single commit, with information
 // about where that commit came from (eg. the repository).
 type SourceStamp struct {
 	Commit
 	// Source is the trigger source.  In buildbot, this would be the "Reason".
 	// This has no meaning in SwarmBucket and DM yet.
 	Source string
 }

 // Property specifies k/v pair representing some
 // sort of property, such as buildbot property, quest property, etc.
 type Property struct {
 	Key   string
 	Value string
 }

 // PropertyGroup is a cluster of similar properties.  In buildbot land this would be the "source".
 // This is a way to segregate different types of properties such as Quest properties,
 // swarming properties, emitted properties, revision properties, etc.
 type PropertyGroup struct {
 	GroupName string
 	Property  []*Property
 }

 func (p PropertyGroup) Len() int { return len(p.Property) }
 func (p PropertyGroup) Swap(i, j int) {
 	p.Property[i], p.Property[j] = p.Property[j], p.Property[i]
 }
 func (p PropertyGroup) Less(i, j int) bool { return p.Property[i].Key < p.Property[j].Key }

 // Commit represents a single commit to a repository, rendered as part of a blamelist.
 type Commit struct {
 	// Who made the commit?
 	AuthorName string
 	// Email of the committer.
 	AuthorEmail string
 	// Time of the commit.
 	CommitTime time.Time
 	// Full URL of the main source repository.
 	Repo string
 	// Branch of the repo.
 	Branch string
 	// Requested revision of the commit or base commit.
 	RequestRevision *Link
 	// Revision of the commit or base commit.
 	Revision *Link
 	// The commit message.
 	Description string
 	// Rietveld or Gerrit URL if the commit is a patch.
 	Changelist *Link
 	// Browsable URL of the commit.
 	CommitURL string
 	// List of changed filenames.
 	File []string
 }

 // Title is the first line of the commit message (Description).
 func (c *Commit) Title() string {
 	switch lines := strings.SplitN(c.Description, "\n", 2); len(lines) {
 	case 0:
 		return ""
 	case 1:
 		return c.Description
 	default:
 		return lines[0]
 	}
 }

 // BuildProgress is a way to show progress.  Percent should always be specified.
 type BuildProgress struct {
 	// The total number of entries. Shows up as a tooltip.  Leave at 0 to
 	// disable the tooltip.
 	total uint64

 	// The number of entries completed.  Shows up as <progress> / <total>.
 	progress uint64

 	// A number between 0 to 100 denoting the percentage completed.
 	percent uint32
 }

 // ComponentType is the type of build component.
 type ComponentType int

 const (
 	// Recipe corresponds to a full recipe run.  Dependencies are recipes.
 	Recipe ComponentType = iota

 	// Step is a single step of a recipe.
 	Step

 	// Summary denotes that this does not pretain to any particular step.
 	Summary
 )

 // MarshalJSON renders enums into String rather than an int when marshalling.
 func (c ComponentType) MarshalJSON() ([]byte, error) {
 	return json.Marshal(c.String())
 }

 // LogoBanner is a banner of logos that define the OS and devices that a
 // component is associated with.
 type LogoBanner struct {
 	OS     []Logo
 	Device []Logo
 }

 // Verbosity can be tagged onto a BuildComponent to indicate whether it should
 // be hidden or annuciated.
 type Verbosity int

 const (
 	// Normal items are displayed as usual.  This is the default.
 	Normal Verbosity = iota

 	// Hidden items are by default not displayed.
 	Hidden

 	// Interesting items are a signal that they should be annuciated, or
 	// pre-fetched.
 	Interesting
 )

 // BuildComponent represents a single Step, subsetup, attempt, or recipe.
 type BuildComponent struct {
 	// The parent of this component.  For buildbot and swarmbucket builds, this
 	// refers to the builder.  For DM, this refers to whatever triggered the Quest.
 	ParentLabel *Link `json:",omitempty"`

 	// The main label for the component.
 	Label string

 	// Status of the build.
 	Status model.Status

 	// Banner is a banner of logos that define the OS and devices this
 	// component is associated with.
 	Banner *LogoBanner `json:",omitempty"`

 	// Bot is the machine or execution instance that this component ran on.
 	Bot *Link `json:",omitempty"`

 	// Recipe is a link to the recipe this component is based on.
 	Recipe *Link `json:",omitempty"`

 	// Source is a link to the external (buildbot, swarming, dm, etc) data
 	// source that this component relates to.
 	Source *Link `json:",omitempty"`

 	// Links to show adjacent to the main label.
 	MainLink LinkSet `json:",omitempty"`

 	// Links to show right below the main label. Top-level slice are rows of
 	// links, second level shows up as
 	SubLink []LinkSet `json:",omitempty"`

 	// Designates the progress of the current component. Set null for no progress.
 	Progress *BuildProgress `json:",omitempty"`

 	// When did this step start.
 	Started time.Time

 	// When did this step finish.
 	Finished time.Time

 	// The time it took for this step to finish. If unfinished, this is the
 	// current elapsed duration.
 	Duration time.Duration

 	// The type of component.  This manifests itself as a little label on the
 	// top left corner of the component.
 	// This is either "RECIPE" or "STEP".  An attempt is considered a recipe.
 	Type ComponentType

 	// Specifies if this is a top level or a dependency.  Manifests itself as an
 	// indentation level.  Valid options are 0 and 1.  Anything more than 1 is
 	// automatically truncated to 1.
 	LevelsDeep uint32

 	// Verbosity indicates how important this step is.
 	Verbosity Verbosity

 	// Arbitrary text to display below links.  One line per entry,
 	// newlines are stripped.
 	Text []string
 }

 // Navigation is the top bar of the page, used for navigating out of the page.
 type Navigation struct {
 	// Title of the site, is generally consistent throughout the whole site.
 	SiteTitle *Link

 	// Title of the page, usually talks about what's currently here
 	PageTitle *Link

 	// List of clickable thing to navigate down the hierarchy.
 	Breadcrumbs []*Link

 	// List of (smaller) clickable things to display on the right side.
 	Right []*Link
 }

 // LinkSet is an ordered collection of Link objects that will be rendered on the
 // same line.
 type LinkSet []*Link

 // Link denotes a single labeled link.
 //
 // JSON tags here are for test expectations.
 type Link struct {
 	model.Link

 	// An icon for the link.  Not compatible with label.  Rendered as <img>
 	Img string `json:",omitempty"`

 	// Alt text for the image, only supported with img.
 	Alt string `json:",omitempty"`

 	// Alias, if true, means that this link is an [alias link].
 	Alias bool `json:",omitempty"`
 }

 // NewLink does just about what you'd expect.
 func NewLink(label, url string) *Link {
 	return &Link{Link: model.Link{Label: label, URL: url}}
 }

 func (comp *BuildComponent) toModelSummary() model.Summary {
 	return model.Summary{
 		Status: comp.Status,
 		Start:  comp.Started,
 		End:    comp.Finished,
 		Text:   comp.Text,
 	}
 }

 // SummarizeTo summarizes the data into a given model.BuildSummary.
 func (rb *MiloBuild) SummarizeTo(c context.Context, bs *model.BuildSummary) error {
 	bs.Summary = rb.Summary.toModelSummary()
 	if rb.Summary.Status == model.Running {
 		// Assume the last step is the current step.
 		if len(rb.Components) > 0 {
 			cs := rb.Components[len(rb.Components)-1]
 			bs.CurrentStep = cs.toModelSummary()
 		}
 	}
 	if rb.SourceStamp != nil {
 		// TODO(hinoka, iannucci): This should be full manifests, but lets just use
 		// single revisions for now. HACKS!
 		if rb.SourceStamp.Revision != nil {
 			revisionBytes, err := hex.DecodeString(rb.SourceStamp.Revision.Label)
 			if err != nil {
 				logging.WithError(err).Warningf(c, "bad revision (not hex-decodable)")
 			} else {
 				bs.Manifests = append(bs.Manifests, model.ManifestLink{
 					Name: "REVISION",
 					ID:   []byte(rb.SourceStamp.Revision.Label),
 				})
 				consoles, err := common.GetAllConsoles(c, bs.BuilderID)
 				if err != nil {
 					return err
 				}
 				for _, con := range consoles {
 					// HACK(iannucci): Until we have real manifest support, console
 					// definitions will specify their manifest as "REVISION", and we'll do
 					// lookups with null URL fields.
 					bs.AddManifestKey(
 						con.GetProjectName(), con.ID, "REVISION", "", revisionBytes)
 				}
 			}
 		}
 		if rb.SourceStamp.Changelist != nil {
 			bs.Patches = append(bs.Patches, model.PatchInfo{
 				Link:        rb.SourceStamp.Changelist.Link,
 				AuthorEmail: rb.SourceStamp.AuthorEmail,
 			})
 		}
 	}
 	return nil
 }
	// Copyright 2015 The LUCI Authors.
	//
	// 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.

	//go:generate stringer -type=Verbosity
	//go:generate stringer -type=ComponentType

	package resp

	import (
	"encoding/hex"
	"encoding/json"
	"strings"
	"time"

	"golang.org/x/net/context"

	"github.com/luci/luci-go/common/logging"
	"github.com/luci/luci-go/milo/common"
	"github.com/luci/luci-go/milo/common/model"
	)

	// MiloBuild denotes a full renderable Milo build page.
	type MiloBuild struct {
	// Summary is a top level summary of the page.
	Summary BuildComponent

	// SourceStamp gives information about how the build came about.
	SourceStamp *SourceStamp

	// Components is a detailed list of components and subcomponents of the page.
	// This is most often used for steps (buildbot/luci) or deps (luci).
	Components []*BuildComponent

	// PropertyGroup is a list of input and output property of this page.
	// This is used for build and emitted properties (buildbot) and quest
	// information (luci). This is also grouped by the "type" of property
	// so different categories of properties can be separated and sorted.
	//
	// This is not a map so code that constructs MiloBuild can control the
	// order of property groups, for example show important properties
	// first.
	PropertyGroup []*PropertyGroup

	// Blame is a list of people and commits that is likely to be in relation to
	// the thing displayed on this page.
	Blame []*Commit
	}

	// SourceStamp is the combination of pointing to a single commit, with information
	// about where that commit came from (eg. the repository).
	type SourceStamp struct {
	Commit
	// Source is the trigger source. In buildbot, this would be the "Reason".
	// This has no meaning in SwarmBucket and DM yet.
	Source string
	}

	// Property specifies k/v pair representing some
	// sort of property, such as buildbot property, quest property, etc.
	type Property struct {
	Key string
	Value string
	}

	// PropertyGroup is a cluster of similar properties. In buildbot land this would be the "source".
	// This is a way to segregate different types of properties such as Quest properties,
	// swarming properties, emitted properties, revision properties, etc.
	type PropertyGroup struct {
	GroupName string
	Property []*Property
	}

	func (p PropertyGroup) Len() int { return len(p.Property) }
	func (p PropertyGroup) Swap(i, j int) {
	p.Property[i], p.Property[j] = p.Property[j], p.Property[i]
	}
	func (p PropertyGroup) Less(i, j int) bool { return p.Property[i].Key < p.Property[j].Key }

	// Commit represents a single commit to a repository, rendered as part of a blamelist.
	type Commit struct {
	// Who made the commit?
	AuthorName string
	// Email of the committer.
	AuthorEmail string
	// Time of the commit.
	CommitTime time.Time
	// Full URL of the main source repository.
	Repo string
	// Branch of the repo.
	Branch string
	// Requested revision of the commit or base commit.
	RequestRevision *Link
	// Revision of the commit or base commit.
	Revision *Link
	// The commit message.
	Description string
	// Rietveld or Gerrit URL if the commit is a patch.
	Changelist *Link
	// Browsable URL of the commit.
	CommitURL string
	// List of changed filenames.
	File []string
	}

	// Title is the first line of the commit message (Description).
	func (c *Commit) Title() string {
	switch lines := strings.SplitN(c.Description, "\n", 2); len(lines) {
	case 0:
	return ""
	case 1:
	return c.Description
	default:
	return lines[0]
	}
	}

	// BuildProgress is a way to show progress. Percent should always be specified.
	type BuildProgress struct {
	// The total number of entries. Shows up as a tooltip. Leave at 0 to
	// disable the tooltip.
	total uint64

	// The number of entries completed. Shows up as <progress> / <total>.
	progress uint64

	// A number between 0 to 100 denoting the percentage completed.
	percent uint32
	}

	// ComponentType is the type of build component.
	type ComponentType int

	const (
	// Recipe corresponds to a full recipe run. Dependencies are recipes.
	Recipe ComponentType = iota

	// Step is a single step of a recipe.
	Step

	// Summary denotes that this does not pretain to any particular step.
	Summary
	)

	// MarshalJSON renders enums into String rather than an int when marshalling.
	func (c ComponentType) MarshalJSON() ([]byte, error) {
	return json.Marshal(c.String())
	}

	// LogoBanner is a banner of logos that define the OS and devices that a
	// component is associated with.
	type LogoBanner struct {
	OS []Logo
	Device []Logo
	}

	// Verbosity can be tagged onto a BuildComponent to indicate whether it should
	// be hidden or annuciated.
	type Verbosity int

	const (
	// Normal items are displayed as usual. This is the default.
	Normal Verbosity = iota

	// Hidden items are by default not displayed.
	Hidden

	// Interesting items are a signal that they should be annuciated, or
	// pre-fetched.
	Interesting
	)

	// BuildComponent represents a single Step, subsetup, attempt, or recipe.
	type BuildComponent struct {
	// The parent of this component. For buildbot and swarmbucket builds, this
	// refers to the builder. For DM, this refers to whatever triggered the Quest.
	ParentLabel *Link `json:",omitempty"`

	// The main label for the component.
	Label string

	// Status of the build.
	Status model.Status

	// Banner is a banner of logos that define the OS and devices this
	// component is associated with.
	Banner *LogoBanner `json:",omitempty"`

	// Bot is the machine or execution instance that this component ran on.
	Bot *Link `json:",omitempty"`

	// Recipe is a link to the recipe this component is based on.
	Recipe *Link `json:",omitempty"`

	// Source is a link to the external (buildbot, swarming, dm, etc) data
	// source that this component relates to.
	Source *Link `json:",omitempty"`

	// Links to show adjacent to the main label.
	MainLink LinkSet `json:",omitempty"`

	// Links to show right below the main label. Top-level slice are rows of
	// links, second level shows up as
	SubLink []LinkSet `json:",omitempty"`

	// Designates the progress of the current component. Set null for no progress.
	Progress *BuildProgress `json:",omitempty"`

	// When did this step start.
	Started time.Time

	// When did this step finish.
	Finished time.Time

	// The time it took for this step to finish. If unfinished, this is the
	// current elapsed duration.
	Duration time.Duration

	// The type of component. This manifests itself as a little label on the
	// top left corner of the component.
	// This is either "RECIPE" or "STEP". An attempt is considered a recipe.
	Type ComponentType

	// Specifies if this is a top level or a dependency. Manifests itself as an
	// indentation level. Valid options are 0 and 1. Anything more than 1 is
	// automatically truncated to 1.
	LevelsDeep uint32

	// Verbosity indicates how important this step is.
	Verbosity Verbosity

	// Arbitrary text to display below links. One line per entry,
	// newlines are stripped.
	Text []string
	}

	// Navigation is the top bar of the page, used for navigating out of the page.
	type Navigation struct {
	// Title of the site, is generally consistent throughout the whole site.
	SiteTitle *Link

	// Title of the page, usually talks about what's currently here
	PageTitle *Link

	// List of clickable thing to navigate down the hierarchy.
	Breadcrumbs []*Link

	// List of (smaller) clickable things to display on the right side.
	Right []*Link
	}

	// LinkSet is an ordered collection of Link objects that will be rendered on the
	// same line.
	type LinkSet []*Link

	// Link denotes a single labeled link.
	//
	// JSON tags here are for test expectations.
	type Link struct {
	model.Link

	// An icon for the link. Not compatible with label. Rendered as <img>
	Img string `json:",omitempty"`

	// Alt text for the image, only supported with img.
	Alt string `json:",omitempty"`

	// Alias, if true, means that this link is an [alias link].
	Alias bool `json:",omitempty"`
	}

	// NewLink does just about what you'd expect.
	func NewLink(label, url string) *Link {
	return &Link{Link: model.Link{Label: label, URL: url}}
	}

	func (comp *BuildComponent) toModelSummary() model.Summary {
	return model.Summary{
	Status: comp.Status,
	Start: comp.Started,
	End: comp.Finished,
	Text: comp.Text,
	}
	}

	// SummarizeTo summarizes the data into a given model.BuildSummary.
	func (rb MiloBuild) SummarizeTo(c context.Context, bs model.BuildSummary) error {
	bs.Summary = rb.Summary.toModelSummary()
	if rb.Summary.Status == model.Running {
	// Assume the last step is the current step.
	if len(rb.Components) > 0 {
	cs := rb.Components[len(rb.Components)-1]
	bs.CurrentStep = cs.toModelSummary()
	}
	}
	if rb.SourceStamp != nil {
	// TODO(hinoka, iannucci): This should be full manifests, but lets just use
	// single revisions for now. HACKS!
	if rb.SourceStamp.Revision != nil {
	revisionBytes, err := hex.DecodeString(rb.SourceStamp.Revision.Label)
	if err != nil {
	logging.WithError(err).Warningf(c, "bad revision (not hex-decodable)")
	} else {
	bs.Manifests = append(bs.Manifests, model.ManifestLink{
	Name: "REVISION",
	ID: []byte(rb.SourceStamp.Revision.Label),
	})
	consoles, err := common.GetAllConsoles(c, bs.BuilderID)
	if err != nil {
	return err
	}
	for _, con := range consoles {
	// HACK(iannucci): Until we have real manifest support, console
	// definitions will specify their manifest as "REVISION", and we'll do
	// lookups with null URL fields.
	bs.AddManifestKey(
	con.GetProjectName(), con.ID, "REVISION", "", revisionBytes)
	}
	}
	}
	if rb.SourceStamp.Changelist != nil {
	bs.Patches = append(bs.Patches, model.PatchInfo{
	Link: rb.SourceStamp.Changelist.Link,
	AuthorEmail: rb.SourceStamp.AuthorEmail,
	})
	}
	}
	return nil
	}