v1

Documentation

Index

• Constants
• Variables
• type Component
• type Config
• type JiraComponent
• type JiraUser
• type TestInfo
• type TestOwnership
• type VariantMapping

Constants

const TestOwnershipAPIVersion = "v1"

const TestOwnershipKind = "TestOwnership"

const VariantMappingAPIVersion = "v1"

const VariantMappingKind = "VariantOwnership"

Variables

var TestMappingTableSchema = bigquery.Schema{
	{
		Name: "kind",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "apiVersion",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "id",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "name",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "suite",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "product",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "component",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "jira_component",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "jira_component_id",
		Type: bigquery.NumericFieldType,
	},
	{
		Name:     "capabilities",
		Type:     bigquery.StringFieldType,
		Repeated: true,
	},
	{
		Name: "staff_approved_obsolete",
		Type: bigquery.BooleanFieldType,
	},
	{
		Name: "priority",
		Type: bigquery.IntegerFieldType,
	},
	{
		Name: "created_at",
		Type: bigquery.DateTimeFieldType,
	},
}

var VariantMappingTableSchema = bigquery.Schema{
	{
		Name: "kind",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "apiVersion",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "product",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "variant_name",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "variant_value",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "jira_project",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "jira_component",
		Type: bigquery.StringFieldType,
	},
	{
		Name: "created_at",
		Type: bigquery.DateTimeFieldType,
	},
}

Types

type Component

type Component interface {
	// IdentifyTest returns ownership information about a test.  An implementation
	// should return `nil, nil` when the test is not theirs. Implementations should
	// only return an error on a fatal error such as inability to read from a file.
	IdentifyTest(*TestInfo) (*TestOwnership, error)

	// IdentifyVariants returns a list of variants that can be mapped to this component
	IdentifyVariants() ([]string, error)

	// StableID returns the stable ID for a test, given a particular TestInfo. This
	// is generally the suite name + . + test name.  If a test gets renamed, this should return
	// the suite `name + . + the oldest test name` to ensure a stable mapping.
	StableID(*TestInfo) string

	JiraComponents() []string

	JiraProject() string

	// Namespaces returns the list of namespaces owned by this component.
	ListNamespaces() []string
}

Component is the interface that component owners should implement to claim ownership and capabilities for their tests.

type Config

type Config struct {
	// IncludeSuites is a specific list of suites to include from the tests table.
	IncludeSuites []string `yaml:"includeSuites"`

	// ExcludeSuites is a specific list of suites to exclude from the tests table.
	ExcludeSuites []string `yaml:"excludeSuites"`

	// ExcludeTests is a specific list of tests to exclude from the tests table.
	ExcludeTests []string `yaml:"excludeTests"`

	// IncludeJobs is a specific list of CI jobs to include from the tests table.
	IncludeJobs []string `yaml:"includeJobs"`

	// ExcludeJobs is a specific list of CI jobs to exclude from the tests table.
	ExcludeJobs []string `yaml:"excludeJobs"`
}

type JiraComponent

type JiraComponent struct {
	Self                string   `json:"self"`
	ID                  string   `json:"id"`
	Name                string   `json:"name"`
	Description         string   `json:"description"`
	Lead                JiraUser `json:"lead"`
	AssigneeType        string   `json:"assigneeType"`
	Assignee            JiraUser `json:"assignee"`
	RealAssigneeType    string   `json:"realAssigneeType"`
	RealAssignee        JiraUser `json:"realAssignee"`
	IsAssigneeTypeValid bool     `json:"isAssigneeTypeValid"`
	Project             string   `json:"project"`
	ProjectID           int      `json:"projectId"`
	Archived            bool     `json:"archived"`
	Deleted             bool     `json:"deleted"`
}

type JiraUser

type JiraUser struct {
	Self        string `json:"self"`
	Name        string `json:"name"`
	Key         string `json:"key"`
	DisplayName string `json:"displayName"`
	Active      bool   `json:"active"`
	TimeZone    string `json:"timeZone"`
}

type TestInfo

type TestInfo struct {
	Name  string
	Suite string
}

TestInfo is the input to the component owners with metadata about a test. It currently includes only the test name and suite, but could in the future contain additional metadata.

type TestOwnership

type TestOwnership struct {
	// APIVersion specifies the schema version, in case we ever need to make
	// changes to the bigquery table that are not simple column additions.
	//
	// Components should not set this value.
	APIVersion string `bigquery:"apiVersion"`

	// Kind is a string value representing the resource this object represents.
	//
	// Components should not set this value.
	Kind string `bigquery:"kind"`

	// ID is a stable name for the test. This should hold the oldest name
	// of the test, which allows us to make comparisons even when the test
	// name has changed.
	//
	// Components should not set this value.
	ID string `bigquery:"id"`

	// Name is the current name for the test.
	Name string `bigquery:"name"`

	// Suite is the name for the junit test suite, if any.  Generally leave this blank, and we'll
	// fill it in from the supplied TestInfo.
	Suite string `bigquery:"suite"`

	// Product is the layer product name, to support the possibility of multiple
	// component readiness dashboards. Generally leave this blank.
	Product string `bigquery:"product"`

	// Priority allows the ability to take priority on a test's ownership. If
	// two components are vying for a test's ownership and one wants to force
	// the matter, you may use a higher priority value (default: 0). The highest
	// value wins.
	Priority int `bigquery:"priority"`

	// StaffApprovedObsolete controls removal of tests.  If tests are removed but was
	// previously assigned to a component without this flag being set, then the component
	// readiness dashboard will show this as a problem. This should always be false, unless
	// a staff engineer approves returning true.
	StaffApprovedObsolete bool `bigquery:"staff_approved_obsolete"`

	// Component is the principal owner of a test. It should map directly to a JIRA bug component.
	// A test should only have one component owner, see above about the priority flag when contention
	// for ownership of a test arises.
	Component string `bigquery:"component"`

	// Capabilities are the particular capability a test is testing.  A test may map to multiple
	// capabilities. For example, a networking test could belong to OVN, IPv6, and EndpointSlices capabilities.
	Capabilities []string `bigquery:"capabilities"`

	// JIRAComponent specifies the JIRA component that this test belongs to.
	JIRAComponent string `bigquery:"jira_component"`

	// JIRAComponentID specifies the ID of the JIRA component above.
	JIRAComponentID *big.Rat `bigquery:"jira_component_id"`

	// CreatedAt is the time this particular record was created.
	//
	// Components do not need to set this value.
	CreatedAt civil.DateTime `bigquery:"created_at" json:"-"`
}

TestOwnership is the information a component owner needs to return about their ownership of a test.

type VariantMapping

type VariantMapping struct {
	// APIVersion specifies the schema version, in case we ever need to make
	// changes to the bigquery table that are not simple column additions.
	APIVersion string `bigquery:"apiVersion"`

	// Kind is a string value representing the resource this object represents.
	Kind string `bigquery:"kind"`

	// Product is the layer product name, to support the possibility of multiple
	// component readiness dashboards. Generally leave this blank.
	Product string `bigquery:"product"`

	// JiraProject specifies the JIRA project that this variant belongs to.
	JiraProject string `bigquery:"jira_project"`

	// JiraComponent specifies the JIRA component that this variant belongs to.
	JiraComponent string `bigquery:"jira_component"`

	// VariantName defines the name of the variant
	VariantName string `bigquery:"variant_name"`

	// VariantValue defines the value of the variant
	VariantValue string `bigquery:"variant_value"`

	// CreatedAt is the time this particular record was created.
	CreatedAt civil.DateTime `bigquery:"created_at" json:"-"`
}