Documentation
¶
Overview ¶
Package utils contains a collection of utilities for the controller test suites
Index ¶
- Variables
- func DeleteAll(cfg *rest.Config, timeout time.Duration, objLists ...client.ObjectList)
- func GetOwnerRefDaemonSet(sts *appsv1.DaemonSet) metav1.OwnerReferencedeprecated
- func GetOwnerRefDeployment(deployment *appsv1.Deployment) metav1.OwnerReferencedeprecated
- func GetOwnerRefStatefulSet(sts *appsv1.StatefulSet) metav1.OwnerReferencedeprecated
- func WithAnnotations(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- func WithDeletionTimestamp(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- func WithFinalizers(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- func WithItems(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- func WithOwnerReferences(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- func WithPodTemplateAnnotations(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
- type Matcher
- func (m *Matcher) Consistently(obj client.Object, intervals ...interface{}) gomega.GomegaAsyncAssertion
- func (m *Matcher) Create(obj client.Object, extras ...interface{}) gomega.GomegaAssertion
- func (m *Matcher) Delete(obj client.Object, extras ...interface{}) gomega.GomegaAssertion
- func (m *Matcher) Get(obj client.Object, intervals ...interface{}) gomega.GomegaAsyncAssertion
- func (m *Matcher) Update(obj client.Object, fn UpdateFunc, intervals ...interface{}) gomega.GomegaAsyncAssertion
- type UpdateFunc
Constants ¶
This section is empty.
Variables ¶
var ExampleConfigMap1 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example1",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example1:key1",
"key2": "example1:key2",
"key3": "example1:key3",
},
BinaryData: map[string][]byte{
"binary_key1": []byte("example1:binary_key1"),
"binary_key2": []byte("example1:binary_key2"),
"binary_key3": []byte("example1:binary_key3"),
},
}
ExampleConfigMap1 is an example ConfigMap object for use within test suites
var ExampleConfigMap2 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example2",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example2:key1",
"key2": "example2:key2",
"key3": "example2:key3",
},
}
ExampleConfigMap2 is an example ConfigMap object for use within test suites
var ExampleConfigMap3 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example3",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example3:key1",
"key2": "example3:key2",
"key3": "example3:key3",
},
}
ExampleConfigMap3 is an example ConfigMap object for use within test suites
var ExampleConfigMap4 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example4",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example4:key1",
"key2": "example4:key2",
"key3": "example4:key3",
},
}
ExampleConfigMap4 is an example ConfigMap object for use within test suites
var ExampleConfigMap5 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example5",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example5:key1",
"key2": "example5:key2",
"key3": "example5:key3",
},
}
ExampleConfigMap5 is an example ConfigMap object for use within test suites
var ExampleConfigMap6 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example6",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example6:key1",
"key2": "example6:key2",
"key3": "example6:key3",
},
}
ExampleConfigMap6 is an example ConfigMap object for use within test suites
var ExampleConfigMap6WithoutKey3 = &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "example6",
Namespace: "default",
Labels: labels,
},
Data: map[string]string{
"key1": "example6:key1",
"key2": "example6:key2",
},
}
ExampleConfigMap6 is an example ConfigMap object for use within test suites
var ExampleDaemonSet = &appsv1.DaemonSet{
ObjectMeta: metav1.ObjectMeta{
Name: "example",
Namespace: "default",
Labels: labels,
Annotations: annotations,
},
Spec: appsv1.DaemonSetSpec{
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: *podTemplate,
},
}
ExampleDaemonSet is an example DaemonSet object for use within test suites
var ExampleDeployment = &appsv1.Deployment{
ObjectMeta: metav1.ObjectMeta{
Name: "example",
Namespace: "default",
Labels: labels,
Annotations: annotations,
},
Spec: appsv1.DeploymentSpec{
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: *podTemplate,
},
}
ExampleDeployment is an example Deployment object for use within test suites
var ExampleSecret1 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example1",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example1:key1",
"key2": "example1:key2",
"key3": "example1:key3",
},
}
ExampleSecret1 is an example Secret object for use within test suites
var ExampleSecret2 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example2",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example2:key1",
"key2": "example2:key2",
"key3": "example2:key3",
},
}
ExampleSecret2 is an example Secret object for use within test suites
var ExampleSecret3 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example3",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example3:key1",
"key2": "example3:key2",
"key3": "example3:key3",
},
}
ExampleSecret3 is an example Secret object for use within test suites
var ExampleSecret4 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example4",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example4:key1",
"key2": "example4:key2",
"key3": "example4:key3",
},
}
ExampleSecret4 is an example Secret object for use within test suites
var ExampleSecret5 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example5",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example5:key1",
"key2": "example5:key2",
"key3": "example5:key3",
},
}
ExampleSecret5 is an example Secret object for use within test suites
var ExampleSecret6 = &corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "example6",
Namespace: "default",
Labels: labels,
},
StringData: map[string]string{
"key1": "example6:key1",
"key2": "example6:key2",
"key3": "example6:key3",
},
}
ExampleSecret6 is an example Secret object for use within test suites
var ExampleStatefulSet = &appsv1.StatefulSet{
ObjectMeta: metav1.ObjectMeta{
Name: "example",
Namespace: "default",
Labels: labels,
Annotations: annotations,
},
Spec: appsv1.StatefulSetSpec{
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: *podTemplate,
},
}
ExampleStatefulSet is an example StatefulSet object for use within test suites
Functions ¶
func DeleteAll ¶
func DeleteAll(cfg *rest.Config, timeout time.Duration, objLists ...client.ObjectList)
DeleteAll lists and deletes all resources
func GetOwnerRefDaemonSet
deprecated
added in
v0.3.0
func GetOwnerRefDaemonSet(sts *appsv1.DaemonSet) metav1.OwnerReference
GetOwnerRefDaemonSet constructs an owner reference for the DaemonSet given
Deprecated: Wave no longer uses OwnerReferences. Only used for migration.
func GetOwnerRefDeployment
deprecated
added in
v0.3.0
func GetOwnerRefDeployment(deployment *appsv1.Deployment) metav1.OwnerReference
GetOwnerRefDeployment constructs an owner reference for the Deployment given
Deprecated: Wave no longer uses OwnerReferences. Only used for migration.
func GetOwnerRefStatefulSet
deprecated
added in
v0.3.0
func GetOwnerRefStatefulSet(sts *appsv1.StatefulSet) metav1.OwnerReference
GetOwnerRefStatefulSet constructs an owner reference for the StatefulSet given
Deprecated: Wave no longer uses OwnerReferences. Only used for migration.
func WithAnnotations ¶
func WithAnnotations(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithAnnotations returns the object's Annotations
func WithDeletionTimestamp ¶ added in v0.2.0
func WithDeletionTimestamp(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithDeletionTimestamp returns the objects Deletion Timestamp
func WithFinalizers ¶
func WithFinalizers(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithFinalizers returns the object's Finalizers
func WithItems ¶
func WithItems(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithItems returns the lists Finalizers
func WithOwnerReferences ¶
func WithOwnerReferences(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithOwnerReferences returns the object's OwnerReferences
func WithPodTemplateAnnotations ¶
func WithPodTemplateAnnotations(matcher gtypes.GomegaMatcher) gtypes.GomegaMatcher
WithPodTemplateAnnotations returns the PodTemplate's annotations
Types ¶
type Matcher ¶
type Matcher struct {
Client client.Client
}
Matcher has Gomega Matchers that use the controller-runtime client
func (*Matcher) Consistently ¶
func (m *Matcher) Consistently(obj client.Object, intervals ...interface{}) gomega.GomegaAsyncAssertion
Consistently continually gets the object from the API for comparison
func (*Matcher) Create ¶
func (m *Matcher) Create(obj client.Object, extras ...interface{}) gomega.GomegaAssertion
Create creates the object on the API server
func (*Matcher) Delete ¶
func (m *Matcher) Delete(obj client.Object, extras ...interface{}) gomega.GomegaAssertion
Delete deletes the object from the API server
type UpdateFunc ¶ added in v0.3.0
type UpdateFunc func(client.Object) client.Object
UpdateFunc modifies the object fetched from the API server before sending the update