claim

package
v1.0.4 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2021 License: GPL-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package claim provides a test-network-definition claim schema.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Claim

type Claim struct {

	// Tests within test-network-function often require configuration.  For example, the generic test suite requires listing all CNF containers.  This information is used to derive per-container IP address information, which is then used as input to the connectivity test suite.  Test suites within test-network-function may use multiple configurations, but each with a unique name.
	Configurations map[string]interface{} `json:"configurations"`
	Metadata       *Metadata              `json:"metadata"`

	// An OpenShift cluster is composed of an arbitrary number of Nodes used for platform and application services.  Since a claim must be reproducible, a variety of per-Node information must be collected and stored in the claim.  Node names are unique within a given OpenShift cluster.
	Nodes map[string]interface{} `json:"nodes"`

	// The test-network-function test results.  Results are a JSON representation of the JUnit output.
	RawResults map[string]interface{} `json:"rawResults"`

	// The results for each unique test case.
	Results  map[string]interface{} `json:"results,omitempty"`
	Versions *Versions              `json:"versions"`
}

Claim

func (*Claim) MarshalJSON

func (strct *Claim) MarshalJSON() ([]byte, error)

func (*Claim) UnmarshalJSON

func (strct *Claim) UnmarshalJSON(b []byte) error

type Identifier added in v1.0.3

type Identifier struct {

	// url stores the unique url for a test.
	Url string `json:"url"`

	// version stores the semantic version of the test.
	Version string `json:"version"`
}

Identifier identifier is a per testcase unique identifier.

func (*Identifier) MarshalJSON added in v1.0.3

func (strct *Identifier) MarshalJSON() ([]byte, error)

func (*Identifier) UnmarshalJSON added in v1.0.3

func (strct *Identifier) UnmarshalJSON(b []byte) error

type Metadata

type Metadata struct {

	// The UTC end time of a claim evaluation.  This is recorded when the test-network-function test suite completes.
	EndTime string `json:"endTime"`

	// The UTC start time of a claim evaluation.  This is recorded when the test-network-function test suite is invoked.
	StartTime string `json:"startTime"`
}

Metadata

func (*Metadata) MarshalJSON

func (strct *Metadata) MarshalJSON() ([]byte, error)

func (*Metadata) UnmarshalJSON

func (strct *Metadata) UnmarshalJSON(b []byte) error

type Result added in v1.0.3

type Result struct {

	// The duration of the test in nanoseconds.
	Duration int `json:"duration"`

	// Describes the test failure in detail.
	FailureReason string `json:"failureReason,omitempty"`

	// The file containing the Ginkgo test suite.
	Filename string `json:"filename"`

	// Whether the test is measuring elapsed time.
	IsMeasurement bool `json:"isMeasurement"`

	// The line number containing the Ginkgo.It test specification.
	LineNumber int `json:"lineNumber"`

	// Whether the Ginkgo.IT test specification passed or failed.
	Passed bool `json:"passed"`

	// The JUnit test text.
	TestText string `json:"testText"`
}

Result result is the result of running a testcase.

func (*Result) MarshalJSON added in v1.0.3

func (strct *Result) MarshalJSON() ([]byte, error)

func (*Result) UnmarshalJSON added in v1.0.3

func (strct *Result) UnmarshalJSON(b []byte) error

type Root

type Root struct {
	Claim *Claim `json:"claim"`
}

Root A test-network-function claim is an attestation of the tests performed, the results and the various configurations. Since a claim must be reproducible, it also includes an overview of the systems under test and their physical configurations.

func (*Root) MarshalJSON

func (strct *Root) MarshalJSON() ([]byte, error)

func (*Root) UnmarshalJSON

func (strct *Root) UnmarshalJSON(b []byte) error

type Versions

type Versions struct {

	// The Kubernetes release version.
	K8s string `json:"k8s,omitempty"`

	// The oc client release version.
	OcClient string `json:"ocClient,omitempty"`

	// OCP cluster release version.
	Ocp string `json:"ocp,omitempty"`

	// The test-network-function (tnf) release version.
	Tnf string `json:"tnf"`

	// The test-network-function (tnf) Git Commit.
	TnfGitCommit string `json:"tnfGitCommit,omitempty"`
}

Versions

func (*Versions) MarshalJSON

func (strct *Versions) MarshalJSON() ([]byte, error)

func (*Versions) UnmarshalJSON

func (strct *Versions) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL