results

const (
	// StatusFailed is the key we base junit pass/failure off of and save into
	// our canonical results format.
	StatusFailed = "failed"

	// StatusPassed is the key we base junit pass/failure off of and save into
	// our canonical results format.
	StatusPassed = "passed"

	// StatusSkipped is the key we base junit pass/failure off of and save into
	// our canonical results format.
	StatusSkipped = "skipped"

	// StatusUnknown is the key we fallback to in our canonical results format
	// if another can not be determined.
	StatusUnknown = "unknown"

	// StatusEmpty is just the empty string; we equate this to StatusUnknown.
	StatusEmpty = ""

	// StatusTimeout is the key used when the plugin does not report results within the
	// timeout period. It will be treated as a failure (e.g. its parent will be marked
	// as a failure).
	StatusTimeout = "timeout"

	// PostProcessedResultsFile is the name of the file we create when doing
	// postprocessing on the plugin results.
	PostProcessedResultsFile = "sonobuoy_results.yaml"

	// MetadataFileKey is the key used in an Item's metadata field when the Item is
	// representing the a file summary (and its leaf nodes are individual tests or Suites).
	MetadataFileKey = "file"

	// MetadataTypeKey is the key used in an Item's metadata field when describing what type
	// of entry in the tree it is. Currently we just tag summaries, files, and nodes.
	MetadataTypeKey = "type"

	MetadataTypeNode    = "node"
	MetadataTypeFile    = "file"
	MetadataTypeSummary = "summary"

	MetadataDetailsFailure = "failure"
	MetadataDetailsOutput  = "output"
)

const (
	// JUnitStdoutKey is the key in the Items.Details map for the system-out output.
	JUnitStdoutKey = "system-out"

	// JUnitStderrKey is the key in the Items.Details map for the system-out output.
	JUnitStderrKey = "system-err"

	// JUnitFailureKey is the key in the Items.Details map for the failure output.
	JUnitFailureKey = "failure"

	// JUnitErrorKey is the key in the Items.Details map for the error output.
	JUnitErrorKey = "error"
)

const (
	ResultFormatJUnit  = "junit"
	ResultFormatE2E    = "e2e"
	ResultFormatGoJSON = "gojson"
	ResultFormatRaw    = "raw"
	ResultFormatManual = "manual"
)

const (
	// PluginsDir defines where in the archive directories for plugin results are.
	PluginsDir = "plugins/"

	// ResultsDir defines where in the archive the plugin results are.
	// Example: plugins/<name>/results
	ResultsDir = "results/"

	// ErrorsDir defines where in the archive the errors running the plugin get reported.
	// These are the Sonobuoy reported errors, e.g. failure to start a plugin, timeout, etc.
	// This is not the appropriate directory for things like test failures.
	// Example: plugins/<name>/errors
	ErrorsDir = "errors/"

	// DefaultErrFile is the file name used when Sonobuoy is reporting an error running a plugin.
	// Is written into the ErrorsDir directory.
	DefaultErrFile = "error.json"

	// CoreNodesFile is the filename of the core nodes json output, relative to nonNamespacedResourcesDir
	CoreNodesFile = "core_v1_nodes.json"

	// CorePodsFile is the filename of the core pod json output, relative to namespacedResourcesDir
	CorePodsFile = "core_v1_pods.json"

	// InfoFile contains data not that isn't strictly in another location
	// but still relevent to post-processing or understanding the run in some way.
	InfoFile = "info.json"

	// ClusterHealthFile is the filename of the cluster health, relative to metadataDir
	ClusterHealthFile = "clusterhealth.json"
)

const (
	// UnknownVersion lets the consumer know if this client can detect the archive version or not.
	UnknownVersion = "v?.?"
	VersionEight   = "v0.8"
	VersionNine    = "v0.9"
	VersionTen     = "v0.10"
	VersionFifteen = "v0.15"
)