Documentation ¶
Index ¶
- func ACLBindingRule() *structs.ACLBindingRule
- func ACLJWTAuthMethod() *structs.ACLAuthMethod
- func ACLManagementToken() *structs.ACLToken
- func ACLOIDCAuthMethod() *structs.ACLAuthMethod
- func ACLPolicy() *structs.ACLPolicy
- func ACLRole() *structs.ACLRole
- func ACLToken() *structs.ACLToken
- func AgentPolicy(policy string) string
- func Alloc() *structs.Allocation
- func AllocForNode(n *structs.Node) *structs.Allocation
- func AllocForNodeWithoutReservedPort(n *structs.Node) *structs.Allocation
- func AllocNetworkStatus() *structs.AllocNetworkStatus
- func AllocWithoutReservedPort() *structs.Allocation
- func BatchAlloc() *structs.Allocation
- func BatchConnectAlloc() *structs.Allocation
- func BatchConnectJob() *structs.Job
- func BatchJob() *structs.Job
- func BigBenchmarkJob() *structs.Job
- func BlockedEval() *structs.Evaluation
- func CSIPlugin() *structs.CSIPlugin
- func CSIPluginJob(pluginType structs.CSIPluginType, pluginID string) *structs.Job
- func CSIVolume(plugin *structs.CSIPlugin) *structs.CSIVolume
- func ConnectAlloc() *structs.Allocation
- func ConnectIngressGatewayAlloc(mode string) *structs.Allocation
- func ConnectIngressGatewayJob(mode string, inject bool) *structs.Job
- func ConnectJob() *structs.Job
- func ConnectMeshGatewayJob(mode string, inject bool) *structs.Job
- func ConnectNativeAlloc(mode string) *structs.Allocation
- func ConnectNativeJob(mode string) *structs.Job
- func ConnectSidecarTask() *structs.Task
- func ConnectTerminatingGatewayJob(mode string, inject bool) *structs.Job
- func CreatePolicy(t testing.T, state StateStore, index uint64, name, rule string)
- func CreatePolicyAndToken(t testing.T, state StateStore, index uint64, name, rule string) *structs.ACLToken
- func CreateToken(t testing.T, state StateStore, index uint64, policies []string) *structs.ACLToken
- func Deployment() *structs.Deployment
- func DrainNode() *structs.Node
- func Eval() *structs.Evaluation
- func Events(index uint64) *structs.Events
- func HCL() string
- func HostVolumePolicy(vol string, policy string, capabilities []string) string
- func Job() *structs.Job
- func JobSummary(jobID string) *structs.JobSummary
- func JobSysBatchSummary(jobID string) *structs.JobSummary
- func JobWithScalingPolicy() (*structs.Job, *structs.ScalingPolicy)
- func LifecycleAlloc() *structs.Allocation
- func LifecycleAllocFromTasks(tasks []LifecycleTaskDef) *structs.Allocation
- func LifecycleAllocWithPoststartDeploy() *structs.Allocation
- func LifecycleAllocWithPoststopDeploy() *structs.Allocation
- func LifecycleInitTask(resources structs.Resources, i int) *structs.Task
- func LifecycleJob() *structs.Job
- func LifecycleJobWithPoststartDeploy() *structs.Job
- func LifecycleJobWithPoststopDeploy() *structs.Job
- func LifecycleMainTask(resources structs.Resources, i int) *structs.Task
- func LifecycleSideTask(resources structs.Resources, i int) *structs.Task
- func MaxParallelJob() *structs.Job
- func MinAlloc() *structs.Allocation
- func MinJob() *structs.Job
- func MultiTaskGroupJob() *structs.Job
- func MultiregionJob() *structs.Job
- func MultiregionMinJob() *structs.Job
- func Namespace() *structs.Namespace
- func NamespacePolicy(namespace string, policy string, capabilities []string) string
- func NamespacePolicyWithVariables(namespace string, policy string, capabilities []string, ...) string
- func NewNetworkStatus(address string) structs.NetworkStatus
- func Node() *structs.Node
- func NodePolicy(policy string) string
- func NvidiaNode() *structs.Node
- func PeriodicJob() *structs.Job
- func Plan() *structs.Plan
- func PlanResult() *structs.PlanResult
- func PluginPolicy(policy string) string
- func QuotaPolicy(policy string) string
- func SITokenAccessor() *structs.SITokenAccessor
- func SampleJWTokenWithKeys(claims jwt.Claims, rsaKey *rsa.PrivateKey) (string, string, error)
- func ScalingPolicy() *structs.ScalingPolicy
- func ServiceRegistrations() []*structs.ServiceRegistration
- func SysBatchAlloc() *structs.Allocation
- func SystemAlloc() *structs.Allocation
- func SystemBatchJob() *structs.Job
- func SystemJob() *structs.Job
- func Variable() *structs.VariableDecrypted
- func VariableEncrypted() *structs.VariableEncrypted
- func VariableLifecycleJob(resources structs.Resources, main int, init int, side int) *structs.Job
- func VariablePolicy(svars map[string][]string) string
- func VaultAccessor() *structs.VaultAccessor
- type CheckShim
- func (s *CheckShim) Difference(allocID string, ids []structs.CheckID) []structs.CheckID
- func (s *CheckShim) List(allocID string) map[structs.CheckID]*structs.CheckQueryResult
- func (s *CheckShim) Purge(allocID string) error
- func (s *CheckShim) Remove(allocID string, ids []structs.CheckID) error
- func (s *CheckShim) Set(allocID string, result *structs.CheckQueryResult) error
- func (s *CheckShim) Snapshot() map[string]string
- type LifecycleTaskDef
- type MockVariables
- type MockVariablesEncrypted
- type NetworkStatus
- type StateStore
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ACLBindingRule ¶ added in v1.5.0
func ACLBindingRule() *structs.ACLBindingRule
func ACLJWTAuthMethod ¶ added in v1.5.4
func ACLJWTAuthMethod() *structs.ACLAuthMethod
func ACLManagementToken ¶ added in v0.7.0
func ACLOIDCAuthMethod ¶ added in v1.5.4
func ACLOIDCAuthMethod() *structs.ACLAuthMethod
func AgentPolicy ¶ added in v0.7.0
AgentPolicy is a helper for generating the hcl for a given agent policy.
func Alloc ¶
func Alloc() *structs.Allocation
func AllocForNode ¶ added in v1.0.16
func AllocForNode(n *structs.Node) *structs.Allocation
func AllocForNodeWithoutReservedPort ¶ added in v1.0.16
func AllocForNodeWithoutReservedPort(n *structs.Node) *structs.Allocation
func AllocNetworkStatus ¶ added in v1.0.0
func AllocNetworkStatus() *structs.AllocNetworkStatus
func AllocWithoutReservedPort ¶ added in v1.0.16
func AllocWithoutReservedPort() *structs.Allocation
func BatchAlloc ¶ added in v0.8.0
func BatchAlloc() *structs.Allocation
func BatchConnectAlloc ¶ added in v0.10.4
func BatchConnectAlloc() *structs.Allocation
BatchConnectAlloc is useful for testing task runner things.
func BatchConnectJob ¶ added in v0.10.4
func BigBenchmarkJob ¶ added in v1.5.2
BigBenchmarkJob creates a job with many fields set, ideal for benchmarking stuff involving jobs.
Should not be used outside of benchmarking - folks should feel free to add more fields without risk of breaking test cases down the line.
func BlockedEval ¶ added in v1.1.0
func BlockedEval() *structs.Evaluation
func CSIPluginJob ¶ added in v1.1.13
func CSIPluginJob(pluginType structs.CSIPluginType, pluginID string) *structs.Job
func ConnectAlloc ¶ added in v0.10.0
func ConnectAlloc() *structs.Allocation
ConnectAlloc adds a Connect proxy sidecar group service to mock.Alloc.
func ConnectIngressGatewayAlloc ¶ added in v0.12.4
func ConnectIngressGatewayAlloc(mode string) *structs.Allocation
func ConnectIngressGatewayJob ¶ added in v0.12.4
ConnectIngressGatewayJob creates a structs.Job that contains the definition of a Consul Ingress Gateway service. The mode is the name of the network mode assumed by the task group. If inject is true, a corresponding Task is set on the group's Tasks (i.e. what the job would look like after job mutation).
func ConnectJob ¶ added in v0.10.0
ConnectJob adds a Connect proxy sidecar group service to mock.Job.
Note this does *not* include the Job.Register mutation that inserts the associated Sidecar Task (nor the hook that configures envoy as the default).
func ConnectMeshGatewayJob ¶ added in v1.1.1
ConnectMeshGatewayJob creates a structs.Job that contains the definition of a Consul Mesh Gateway service. The mode is the name of the network mode assumed by the task group. If inject is true, a corresponding task is set on the group's Tasks (i.e. what the job would look like after job mutation).
func ConnectNativeAlloc ¶ added in v0.12.2
func ConnectNativeAlloc(mode string) *structs.Allocation
ConnectNativeAlloc creates an alloc with a connect native task.
func ConnectNativeJob ¶ added in v0.12.2
func ConnectSidecarTask ¶ added in v1.0.0
func ConnectTerminatingGatewayJob ¶ added in v1.1.1
ConnectTerminatingGatewayJob creates a structs.Job that contains the definition of a Consul Terminating Gateway service. The mode is the name of the network mode assumed by the task group. If inject is true, a corresponding task is set on the group's Tasks (i.e. what the job would look like after mutation).
func CreatePolicy ¶ added in v0.7.0
func CreatePolicy(t testing.T, state StateStore, index uint64, name, rule string)
CreatePolicy creates a policy with the given name and rule.
func CreatePolicyAndToken ¶ added in v0.7.0
func CreatePolicyAndToken(t testing.T, state StateStore, index uint64, name, rule string) *structs.ACLToken
CreatePolicyAndToken creates a policy and then returns a token configured for just that policy. CreatePolicyAndToken uses the given index and index+1.
func CreateToken ¶ added in v0.7.0
CreateToken creates a local, client token for the given policies
func Deployment ¶ added in v0.6.0
func Deployment() *structs.Deployment
func Eval ¶
func Eval() *structs.Evaluation
func HostVolumePolicy ¶ added in v0.10.0
HostVolumePolicy is a helper for generating the policy hcl for a given host-volume. Either policy or capabilities may be nil but not both.
func JobSummary ¶ added in v0.4.1
func JobSummary(jobID string) *structs.JobSummary
func JobSysBatchSummary ¶ added in v1.2.0
func JobSysBatchSummary(jobID string) *structs.JobSummary
func JobWithScalingPolicy ¶ added in v0.11.0
func JobWithScalingPolicy() (*structs.Job, *structs.ScalingPolicy)
func LifecycleAlloc ¶ added in v0.11.0
func LifecycleAlloc() *structs.Allocation
func LifecycleAllocFromTasks ¶ added in v1.3.4
func LifecycleAllocFromTasks(tasks []LifecycleTaskDef) *structs.Allocation
LifecycleAllocFromTasks generates an Allocation with mock tasks that have the provided lifecycles.
func LifecycleAllocWithPoststartDeploy ¶ added in v1.1.13
func LifecycleAllocWithPoststartDeploy() *structs.Allocation
func LifecycleAllocWithPoststopDeploy ¶ added in v1.0.2
func LifecycleAllocWithPoststopDeploy() *structs.Allocation
func LifecycleInitTask ¶ added in v0.11.0
func LifecycleJob ¶ added in v0.11.0
func LifecycleJobWithPoststartDeploy ¶ added in v1.1.13
func LifecycleJobWithPoststopDeploy ¶ added in v1.0.2
func LifecycleMainTask ¶ added in v0.11.0
func LifecycleSideTask ¶ added in v0.11.0
func MaxParallelJob ¶ added in v0.10.0
func MinAlloc ¶ added in v1.3.15
func MinAlloc() *structs.Allocation
func MultiTaskGroupJob ¶ added in v1.1.13
func MultiregionJob ¶ added in v0.12.0
func MultiregionMinJob ¶ added in v1.4.11
func NamespacePolicy ¶ added in v0.7.0
NamespacePolicy is a helper for generating the policy hcl for a given namespace. Either policy or capabilities may be nil but not both.
func NamespacePolicyWithVariables ¶ added in v1.4.0
func NamespacePolicyWithVariables(namespace string, policy string, capabilities []string, svars map[string][]string) string
NamespacePolicyWithVariables is a helper for generating the policy hcl for a given namespace. Either policy or capabilities may be nil but not both.
func NewNetworkStatus ¶ added in v1.4.0
func NewNetworkStatus(address string) structs.NetworkStatus
NewNetworkStatus creates a mock NetworkStatus based on address.
func NodePolicy ¶ added in v0.7.0
NodePolicy is a helper for generating the hcl for a given node policy.
func NvidiaNode ¶ added in v0.9.0
NvidiaNode returns a node with two instances of an Nvidia GPU
func PeriodicJob ¶ added in v0.3.0
func PlanResult ¶
func PlanResult() *structs.PlanResult
func PluginPolicy ¶ added in v0.11.0
PluginPolicy is a helper for generating the hcl for a given plugin policy.
func QuotaPolicy ¶ added in v0.7.0
QuotaPolicy is a helper for generating the hcl for a given quota policy.
func SITokenAccessor ¶ added in v0.10.4
func SITokenAccessor() *structs.SITokenAccessor
func SampleJWTokenWithKeys ¶ added in v1.5.4
func SampleJWTokenWithKeys(claims jwt.Claims, rsaKey *rsa.PrivateKey) (string, string, error)
SampleJWTokenWithKeys takes a set of claims (can be nil) and optionally a private RSA key that should be used for signing the JWT, and returns: - a JWT signed with a randomly generated RSA key - PEM string of the public part of that key that can be used for validation.
func ScalingPolicy ¶ added in v0.11.0
func ScalingPolicy() *structs.ScalingPolicy
func ServiceRegistrations ¶ added in v1.3.0
func ServiceRegistrations() []*structs.ServiceRegistration
ServiceRegistrations generates an array containing two unique service registrations.
func SysBatchAlloc ¶ added in v1.2.0
func SysBatchAlloc() *structs.Allocation
func SystemAlloc ¶ added in v0.8.0
func SystemAlloc() *structs.Allocation
func SystemBatchJob ¶ added in v1.2.0
func Variable ¶ added in v1.4.0
func Variable() *structs.VariableDecrypted
func VariableEncrypted ¶ added in v1.4.0
func VariableEncrypted() *structs.VariableEncrypted
func VariableLifecycleJob ¶ added in v0.11.0
func VariablePolicy ¶ added in v1.4.0
VariablePolicy is a helper for generating the policy hcl for a given variable block inside of a namespace.
func VaultAccessor ¶ added in v0.5.0
func VaultAccessor() *structs.VaultAccessor
Types ¶
type CheckShim ¶ added in v1.4.0
type CheckShim struct{}
CheckShim is a mock implementation of checkstore.Shim
So far the implementation does nothing.
func (*CheckShim) Difference ¶ added in v1.4.0
type LifecycleTaskDef ¶ added in v1.3.4
type MockVariables ¶ added in v1.4.0
type MockVariables map[string]*structs.VariableDecrypted
func Variables ¶ added in v1.4.0
func Variables(minU, maxU uint8) MockVariables
Variables returns a random number of variables between min and max inclusive.
func (MockVariables) List ¶ added in v1.4.0
func (svs MockVariables) List() []*structs.VariableDecrypted
func (MockVariables) ListPaths ¶ added in v1.4.0
func (svs MockVariables) ListPaths() []string
type MockVariablesEncrypted ¶ added in v1.4.0
type MockVariablesEncrypted map[string]*structs.VariableEncrypted
func VariablesEncrypted ¶ added in v1.4.0
func VariablesEncrypted(minU, maxU uint8) MockVariablesEncrypted
VariablesEncrypted returns a random number of variables between min and max inclusive.
func (MockVariablesEncrypted) List ¶ added in v1.4.0
func (svs MockVariablesEncrypted) List() []*structs.VariableEncrypted
func (MockVariablesEncrypted) ListPaths ¶ added in v1.4.0
func (svs MockVariablesEncrypted) ListPaths() []string
type NetworkStatus ¶ added in v1.4.0
type NetworkStatus struct {
// contains filtered or unexported fields
}
NetworkStatus is a mock implementation of structs.NetworkStatus
func (*NetworkStatus) NetworkStatus ¶ added in v1.4.0
func (ns *NetworkStatus) NetworkStatus() *structs.AllocNetworkStatus
type StateStore ¶ added in v0.7.0
type StateStore interface { UpsertACLPolicies(msgType structs.MessageType, index uint64, policies []*structs.ACLPolicy) error UpsertACLTokens(msgType structs.MessageType, index uint64, tokens []*structs.ACLToken) error }
StateStore defines the methods required from state.StateStore but avoids a circular dependency.