config.go

// Copyright (c) 2019-2020 Cisco Systems, Inc and/or its affiliates.
//
// SPDX-License-Identifier: Apache-2.0
//
// 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.

// Package config - define a configuration used by CloudTest tool.
package config

type ClusterProviderConfig struct {
	Name       string            `yaml:"name"`       // name of provider, GKE, Azure, etc.
	Kind       string            `yaml:"kind"`       // register provider type, 'shell', 'packet'
	Instances  int               `yaml:"instances"`  // Number of required instances, executions will be split between instances.
	Timeout    int               `yaml:"timeout"`    // Timeout for start, stop
	RetryCount int               `yaml:"retry"`      // A count of start retrying steps.
	NodeCount  int               `yaml:"node-count"` // A count of nodes should be available via API to match cluster is alive.
	StopDelay  int64             `yaml:"stop-delay"` // A timeout after stop and starting of session again.
	Enabled    bool              `yaml:"enabled"`    // Is it enabled by default or not
	Parameters map[string]string `yaml:"parameters"` // A parameters specific for provider
	Scripts    map[string]string `yaml:"scripts"`    // A parameters specific for provider
	Env        []string          `yaml:"env"`        // Extra environment variables
	EnvCheck   []string          `yaml:"env-check"`  // Check if environment has required environment variables present.
	Packet     *PacketConfig     `yaml:"packet"`     // A Packet provider configuration
	TestDelay  int               `yaml:"test-delay"` // Delay between tests of this cluster will be executed in second.
}

type ExecutionSource struct {
	Tags  []string `yaml:"tags"`  // A list of tags for this configured execution.
	Tests []string `yaml:"tests"` // A list of tests for execution.
}

type Execution struct {
	Source          ExecutionSource `yaml:"source"`           // A source for tests execution
	Before          string          `yaml:"before"`           // A script to execute against required cluster, called before run tasks from execution.
	After           string          `yaml:"after"`            // A script to execute against required cluster, called when all tasks from execution are done on cluster instance.
	Kind            string          `yaml:"kind"`             // Execution kind, default is 'gotest', 'shell' could be used for pure shell tests.
	Name            string          `yaml:"name"`             // Execution name
	OnlyRun         []string        `yaml:"only-run"`         // If non-empty, only run the listed tests
	PackageRoot     string          `yaml:"root"`             // A package root for this test execution, default .
	Timeout         int64           `yaml:"timeout"`          // Individual test timeout, "60" passed to gotest, in seconds
	ExtraOptions    []string        `yaml:"extra-options"`    // Extra options to pass to gotest
	ClusterCount    int             `yaml:"cluster-count"`    // A number of clusters required for this execution, default 1
	ClusterEnv      []string        `yaml:"cluster-env"`      // Names of environment variables to put cluster names inside.
	ClusterSelector []string        `yaml:"cluster-selector"` // A cluster name to execute this tests on.
	Env             []string        `yaml:"env"`              // Additional environment variables
	Run             string          `yaml:"run"`              // A script to execute against required cluster
	OnFail          string          `yaml:"on-fail"`          // A script to execute against required cluster, called if task failed

	ConcurrencyRetry int64 `yaml:"test-retry-count"` // A count of times, same test will be executed to find concurrency issues
	TestsFound       int   `yaml:"-"`                // Number of tests found for the config
}

type RetestConfig struct {
	// Executions, every execution execute some tests agains configured set of clusters
	Patterns         []string `yaml:"pattern"`         // Restart test output pattern, to treat as a test restart request, test will be added back for execution.
	RestartCount     int      `yaml:"count"`           // Allow to restart only few times using RestartCode check.
	WarmupTimeout    int      `yaml:"warmup-time"`     // A cluster instance should warmup for some time if this is happening.
	AllowedRetests   int      `yaml:"allowed-retests"` // A number of allowed retests for cluster, if reached, cluster instance will be restarted.
	RetestFailResult string   `yaml:"fail-result"`     // A status if all attempts are failed, usual is skipped. if value != skip, it will be failed.
}

type HealthCheckConfig struct {
	Interval int64  `yaml:"interval"` // Interval between Health checks in seconds
	Run      string `yaml:"run"`      // A script to execute with health check purpose
	Message  string `yaml:"message"`
}

type CloudTestConfig struct {
	Version    string                   `yaml:"version"` // Provider file version, 1.0
	Providers  []*ClusterProviderConfig `yaml:"providers"`
	ConfigRoot string                   `yaml:"root"` // A provider stored configurations root.
	Reporting  struct {
		JUnitReportFile string `yaml:"junit-report"` // A junit report file location, relative to test root folder.
	} `yaml:"reporting"` // A reporting options.
	HealthCheck []*HealthCheckConfig `yaml:"health-check"` // Health checks options.
	Executions  []*Execution         `yaml:"executions"`
	Timeout     int64                `yaml:"timeout"` // Global timeout in seconds
	Imports     []string             `yaml:"import"`  // A set of configurations for import

	RetestConfig RetestConfig `yaml:"retest"`

	Statistics struct {
		Interval int64 `yaml:"interval"` // A statistics printing timeout, default 60 seconds
		Enabled  bool  `yaml:"enabled"`  // A way to disable printing of statistics
	} `yaml:"statistics"` // Statistics options

	ShuffleTests            bool     `yaml:"shuffle-enabled"`    // Shuffle tests before assignment
	OnlyRun                 []string `yaml:"only-run"`           // If non-empty, only run the listed tests
	FailedTestsLimit        int      `yaml:"failed-tests-limit"` // If non-zero, terminates testing after failed tests limit is reached
	MinSuiteSize            int      `yaml:"min-suite-size"`
	TestsPerClusterInstance int      `yaml:"tests-per-cluster-instance"` // Number of tests per cluster instance
}

// NewCloudTestConfig - creates a test config with some default values specified.
func NewCloudTestConfig() (result *CloudTestConfig) {
	result = &CloudTestConfig{}
	result.Statistics.Enabled = true
	result.Statistics.Interval = 60
	return result
}