2edbdfc8be
The e2e framework instantiates clients for Nomad/Consul but the provisioning of the actual Nomad cluster is left to Terraform. The Terraform provisioning process uses `remote-exec` to deploy specific versions of Nomad so that we don't have to bake an AMI every time we want to test a new version. But Terraform treats the resulting instances as immutable, so we can't use the same tooling to update the version of Nomad in-place. This is a prerequisite for upgrade testing. This changeset extends the e2e framework to provide the option of deploying Nomad (and, in the future, Consul/Vault) with specific versions to running infrastructure. This initial implementation is focused on deploying to a single cluster via `ssh` (because that's our current need), but provides interfaces to hook the test run at the start of the run, the start of each suite, or the start of a given test case. Terraform work includes: * provides Terraform output that written to JSON used by the framework to configure provisioning via `terraform output provisioning`. * provides Terraform output that can be used by test operators to configure their shell via `$(terraform output environment)` * drops `remote-exec` provisioning steps from Terraform * makes changes to the deployment scripts to ensure they can be run multiple times w/ different versions against the same host.
84 lines
2.4 KiB
Go
84 lines
2.4 KiB
Go
package framework
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
capi "github.com/hashicorp/consul/api"
|
|
"github.com/hashicorp/nomad/api"
|
|
"github.com/hashicorp/nomad/e2e/framework/provisioning"
|
|
)
|
|
|
|
// TestSuite defines a set of test cases and under what conditions to run them
|
|
type TestSuite struct {
|
|
Component string // Name of the component/system/feature tested
|
|
|
|
CanRunLocal bool // Flags if the cases are safe to run on a local nomad cluster
|
|
Cases []TestCase // Cases to run
|
|
Constraints Constraints // Environment constraints to follow
|
|
Parallel bool // If true, will run test cases in parallel
|
|
Slow bool // Slow test suites don't run by default
|
|
|
|
// API Clients
|
|
Consul bool
|
|
Vault bool
|
|
}
|
|
|
|
// Constraints that must be satisfied for a TestSuite to run
|
|
type Constraints struct {
|
|
Provider string // Cloud provider ex. 'aws', 'azure', 'gcp'
|
|
OS string // Operating system ex. 'windows', 'linux'
|
|
Arch string // CPU architecture ex. 'amd64', 'arm64'
|
|
Environment string // Environment name ex. 'simple'
|
|
Tags []string // Generic tags that must all exist in the environment
|
|
}
|
|
|
|
func (c Constraints) matches(env Environment) error {
|
|
if len(c.Provider) != 0 && c.Provider != env.Provider {
|
|
return fmt.Errorf("provider constraint does not match environment")
|
|
}
|
|
|
|
if len(c.OS) != 0 && c.OS != env.OS {
|
|
return fmt.Errorf("os constraint does not match environment")
|
|
}
|
|
|
|
if len(c.Arch) != 0 && c.Arch != env.Arch {
|
|
return fmt.Errorf("arch constraint does not match environment")
|
|
}
|
|
|
|
if len(c.Environment) != 0 && c.Environment != env.Name {
|
|
return fmt.Errorf("environment constraint does not match environment name")
|
|
}
|
|
|
|
for _, t := range c.Tags {
|
|
if _, ok := env.Tags[t]; !ok {
|
|
return fmt.Errorf("tags constraint failed, tag '%s' is not included in environment", t)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// TC is the base test case which should be embedded in TestCase implementations.
|
|
type TC struct {
|
|
cluster *provisioning.ClusterInfo
|
|
}
|
|
|
|
// Nomad returns a configured nomad api client
|
|
func (tc *TC) Nomad() *api.Client {
|
|
return tc.cluster.NomadClient
|
|
}
|
|
|
|
// Consul returns a configured consul api client
|
|
func (tc *TC) Consul() *capi.Client {
|
|
return tc.cluster.ConsulClient
|
|
}
|
|
|
|
// Name returns the name of the test case which is set to the name of the
|
|
// implementing type.
|
|
func (tc *TC) Name() string {
|
|
return tc.cluster.Name
|
|
}
|
|
|
|
func (tc *TC) setClusterInfo(info *provisioning.ClusterInfo) {
|
|
tc.cluster = info
|
|
}
|