Documentation
¶
Overview ¶
Package testvariantbranch handles test variant branch of change point analysis.
Index ¶
- Constants
- func AddCounts(count1 *cpb.Counts, count2 *cpb.Counts) *cpb.Counts
- func DecodeProtoMessage(bytes []byte, m proto.Message) error
- func DecodeSegment(bytes []byte) (*cpb.Segment, error)
- func DecodeSegments(bytes []byte) (*cpb.Segments, error)
- func DecodeSourceRef(bytes []byte) (*pb.SourceRef, error)
- func DecodeStatistics(bytes []byte) (*cpb.Statistics, error)
- func EncodeProtoMessage(m proto.Message) ([]byte, error)
- func EncodeSegment(seg *cpb.Segment) ([]byte, error)
- func EncodeSegments(segs *cpb.Segments) ([]byte, error)
- func EncodeSourceRef(sourceRef *pb.SourceRef) ([]byte, error)
- func EncodeStatistics(stats *cpb.Statistics) ([]byte, error)
- func ReadF(ctx context.Context, ks []Key, f func(i int, e *Entry) error) error
- func ToPositionVerdict(tv *rdbpb.TestVariant, payload *taskspb.IngestTestVerdicts, ...) (inputbuffer.PositionVerdict, error)
- type Entry
- func (tvb *Entry) ApplyRetentionPolicyForFinalizedSegments(fromTime time.Time)
- func (tvb *Entry) Clear()
- func (tvb *Entry) Copy() *Entry
- func (tvb *Entry) InsertFinalizedSegment(segment *cpb.Segment)
- func (tvb *Entry) InsertToInputBuffer(pv inputbuffer.PositionVerdict)
- func (tvb *Entry) MergedStatistics() *cpb.Statistics
- func (tvb *Entry) PopulateFromSpannerRow(row *spanner.Row, hs *inputbuffer.HistorySerializer) error
- func (tvb *Entry) ToMutation(hs *inputbuffer.HistorySerializer) (*spanner.Mutation, error)
- func (tvb *Entry) UpdateOutputBuffer(evictedSegments []inputbuffer.EvictedSegment)
- type Key
- type RefHash
Constants ¶
const ( // StatisticsRetentionDays is the number of days to keep statistics about // evicted verdicts. See Statistics proto for more. // // This is a minimum period driven by functional and operational requirements, // our deletion logic will tend to keep retain data for longer (but this is // OK as it is not user data). StatisticsRetentionDays = 11 )
Variables ¶
This section is empty.
Functions ¶
func DecodeProtoMessage ¶
DecodeProtoMessage decodes a byte slice into a proto message. It is the inverse of EncodeProtoMessage.
func DecodeSegment ¶
DecodeSegment decodes []byte in to Segment.
func DecodeSegments ¶
DecodeSegments decodes []byte in to Segments.
func DecodeSourceRef ¶
DecodeSourceRef decodes []byte in to SourceRef.
func DecodeStatistics ¶
func DecodeStatistics(bytes []byte) (*cpb.Statistics, error)
DecodeStatistics decodes []byte into a Statistics proto.
func EncodeProtoMessage ¶
EncodeProtoMessage uses zstd to encode a proto message into []byte.
func EncodeStatistics ¶
func EncodeStatistics(stats *cpb.Statistics) ([]byte, error)
func ReadF ¶
ReadF fetches rows from TestVariantBranch spanner table and calls the specified callback function for each row.
Important: The caller must not retain a reference to the provided *Entry after each call, as the object may be re-used for in the next call. If an entry must be retained, it should be copied.
The callback function will be passed the read row and the corresponding index in the key list that was read. If an item does not exist, the provided callback function will be called with the value 'nil'. Absent any errors, the callback function will be called exactly once for each key. The callback function may not be called in order of keys, as Spanner does not return items in order.
This function assumes that it is running inside a transaction.
func ToPositionVerdict ¶
func ToPositionVerdict(tv *rdbpb.TestVariant, payload *taskspb.IngestTestVerdicts, duplicateMap map[string]bool, src *pb.Sources) (inputbuffer.PositionVerdict, error)
Types ¶
type Entry ¶
type Entry struct {
// IsNew is a boolean to denote if the TestVariantBranch is new or already
// existed in Spanner.
// It is used for reducing the number of mutations. For example, the Variant
// field is only inserted once.
IsNew bool
Project string
TestID string
VariantHash string
Variant *pb.Variant
RefHash []byte
SourceRef *pb.SourceRef
InputBuffer *inputbuffer.Buffer
// If this is true, it means we should trigger a write of FinalizingSegment
// to Spanner.
IsFinalizingSegmentDirty bool
// The finalizing segment, if any.
// The count for the finalizing segment should only include the verdicts
// that are not in the input buffer anymore.
FinalizingSegment *cpb.Segment
// If this is true, it means we should trigger a write of FinalizedSegments
// to Spanner.
IsFinalizedSegmentsDirty bool
// The finalized segments for the test variant branch.
FinalizedSegments *cpb.Segments
// If true, it means we should trigger a write of Statistics to Spanner.
IsStatisticsDirty bool
// Statistics about verdicts which have been evicted from the input buffer.
Statistics *cpb.Statistics
}
Entry represents one row in the TestVariantBranch spanner table. See go/luci-test-variant-analysis-design for details.
func New ¶
func New() *Entry
New creates a new empty test variant branch entry, with a preallocated input buffer.
func Read ¶
Read fetches rows from TestVariantBranch spanner table and returns the objects fetched. The returned slice will have the same length and order as the TestVariantBranchKey slices. If a record is not found, the corresponding element will be set to nil. This function assumes that it is running inside a transaction.
func (*Entry) ApplyRetentionPolicyForFinalizedSegments ¶
ApplyRetentionPolicyForFinalizedSegments applies retention policy to finalized segments. The following retention policy applies to finalized segments:
- At most 100 finalized segments can be stored.
- Finalized segments are retained for 5 years from when they closed.
fromTime is the time when the 5 year period is calculated from.
The retention policy to delete test variant branches without test results in 90 days will be enforced separately with a cron job.
func (*Entry) Clear ¶
func (tvb *Entry) Clear()
Clear resets a test variant branch entry to an empty state, similar to after a call to New().
func (*Entry) InsertFinalizedSegment ¶
InsertFinalizedSegment inserts a segment to the end of finalized segments.
func (*Entry) InsertToInputBuffer ¶
func (tvb *Entry) InsertToInputBuffer(pv inputbuffer.PositionVerdict)
InsertToInputBuffer inserts data of a new test variant into the input buffer.
func (*Entry) MergedStatistics ¶
func (tvb *Entry) MergedStatistics() *cpb.Statistics
MergedStatistics returns statistics about the verdicts ingested for given test variant branch. Statistics comprise data from both the input buffer and the output buffer.
func (*Entry) PopulateFromSpannerRow ¶
func (tvb *Entry) PopulateFromSpannerRow(row *spanner.Row, hs *inputbuffer.HistorySerializer) error
func (*Entry) ToMutation ¶
func (tvb *Entry) ToMutation(hs *inputbuffer.HistorySerializer) (*spanner.Mutation, error)
ToMutation returns a spanner Mutation to insert a TestVariantBranch to Spanner table.
func (*Entry) UpdateOutputBuffer ¶
func (tvb *Entry) UpdateOutputBuffer(evictedSegments []inputbuffer.EvictedSegment)
UpdateOutputBuffer updates the output buffer with the evicted segments from the input buffer. evictedSegments should contain only finalized segments, except for the last segment (if any), which must be a finalizing segment. evictedSegments is sorted in ascending order of commit position (oldest segment first).
Source Files