generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
provider: added k3d provider and lifecycle handlers
This change includes the following changes and features. 1. Added a new Interface type `E2EClusterProviderWithLifeCycle` which can be used to setup providers that extend the cluster lifecycle function around the nodes. 2. Enabled a `k3d` based provider with support for Node lifecycle management. 3. Existing Image loader related function and interfaces were augmented with `args ...string` to be able to provide additional arguments in case if the image load handlers need some of the additional config.
- Loading branch information
1 parent
baa442d
commit 3d1be3f
Showing
9 changed files
with
785 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 k3d | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "sigs.k8s.io/e2e-framework/pkg/stepfuncs" | ||
| "sigs.k8s.io/e2e-framework/support" | ||
|
|
||
| appsv1 "k8s.io/api/apps/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/e2e-framework/klient/wait" | ||
| "sigs.k8s.io/e2e-framework/klient/wait/conditions" | ||
| "sigs.k8s.io/e2e-framework/pkg/envconf" | ||
| "sigs.k8s.io/e2e-framework/pkg/features" | ||
| ) | ||
|
|
||
| func newDeployment(namespace string, name string, replicaCount int32) *appsv1.Deployment { | ||
| podSpec := corev1.PodSpec{ | ||
| Containers: []corev1.Container{ | ||
| { | ||
| Name: "my-container", | ||
| Image: "nginx", | ||
| }, | ||
| }, | ||
| } | ||
| return &appsv1.Deployment{ | ||
| ObjectMeta: metav1.ObjectMeta{Name: name, Namespace: namespace, Labels: map[string]string{"app": "test-app"}}, | ||
| Spec: appsv1.DeploymentSpec{ | ||
| Replicas: &replicaCount, | ||
| Selector: &metav1.LabelSelector{ | ||
| MatchLabels: map[string]string{"app": "test-app"}, | ||
| }, | ||
| Template: corev1.PodTemplateSpec{ | ||
| ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"app": "test-app"}}, | ||
| Spec: podSpec, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func TestK3DCluster(t *testing.T) { | ||
| deploymentFeature := features.New("Should be able to create a new deployment in the k3d cluster"). | ||
| Assess("Create a new deployment", func(ctx context.Context, t *testing.T, c *envconf.Config) context.Context { | ||
| deployment := newDeployment(c.Namespace(), "test-deployment", 1) | ||
| if err := c.Client().Resources().Create(ctx, deployment); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| var dep appsv1.Deployment | ||
| if err := c.Client().Resources().Get(ctx, "test-deployment", c.Namespace(), &dep); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| err := wait.For(conditions.New(c.Client().Resources()).DeploymentConditionMatch(&dep, appsv1.DeploymentAvailable, corev1.ConditionTrue), wait.WithTimeout(time.Minute*3)) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| return context.WithValue(ctx, "test-deployment", &dep) | ||
| }). | ||
| Feature() | ||
|
|
||
| nodeAddFeature := features.New("Should be able to add a new node to the k3d cluster"). | ||
| Setup(stepfuncs.PerformNodeOperation(support.AddNode, &support.Node{ | ||
| Name: fmt.Sprintf("%s-agent", clusterName), | ||
| Cluster: clusterName, | ||
| Role: "agent", | ||
| })). | ||
| Assess("Check if the node is added to the cluster", func(ctx context.Context, t *testing.T, c *envconf.Config) context.Context { | ||
| var node corev1.Node | ||
| if err := c.Client().Resources().Get(ctx, fmt.Sprintf("k3d-%s-agent-0", clusterName), c.Namespace(), &node); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| return ctx | ||
| }).Feature() | ||
|
|
||
| testEnv.Test(t, deploymentFeature, nodeAddFeature) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 k3d | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| "sigs.k8s.io/e2e-framework/pkg/env" | ||
| "sigs.k8s.io/e2e-framework/pkg/envconf" | ||
| "sigs.k8s.io/e2e-framework/pkg/envfuncs" | ||
| "sigs.k8s.io/e2e-framework/support/k3d" | ||
| ) | ||
|
|
||
| var ( | ||
| testEnv env.Environment | ||
| clusterName string | ||
| ) | ||
|
|
||
| func TestMain(m *testing.M) { | ||
| testEnv = env.New() | ||
| clusterName = envconf.RandomName("test", 16) | ||
| namespace := envconf.RandomName("k3d-ns", 16) | ||
|
|
||
| testEnv.Setup( | ||
| envfuncs.CreateClusterWithOpts(k3d.NewProvider(), clusterName, k3d.WithImage("rancher/k3s:v1.29.6-k3s1")), | ||
| envfuncs.CreateNamespace(namespace), | ||
| envfuncs.LoadImageToCluster(clusterName, "rancher/k3s:v1.29.6-k3s1", "--verbose", "--mode", "direct"), | ||
| ) | ||
|
|
||
| testEnv.Finish( | ||
| envfuncs.DeleteNamespace(namespace), | ||
| envfuncs.DestroyCluster(clusterName), | ||
| ) | ||
|
|
||
| os.Exit(testEnv.Run(m)) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 stepfuncs | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "sigs.k8s.io/e2e-framework/pkg/utils" | ||
|
|
||
| "sigs.k8s.io/e2e-framework/pkg/envconf" | ||
| "sigs.k8s.io/e2e-framework/pkg/types" | ||
| "sigs.k8s.io/e2e-framework/support" | ||
| ) | ||
|
|
||
| // PerformNodeOperation returns a step function that performs a node operation on a cluster. | ||
| // This can be integrated as a setup function for a feature in question before the feature | ||
| // is tested. | ||
| func PerformNodeOperation(action support.NodeOperation, node *support.Node, args ...string) types.StepFunc { | ||
| return func(ctx context.Context, t *testing.T, config *envconf.Config) context.Context { | ||
| t.Helper() | ||
|
|
||
| err := utils.PerformNodeLifecycleOperation(ctx, action, node, args...) | ||
| if err != nil { | ||
| t.Fatalf("failed to perform node operation: %v", err) | ||
| } | ||
| return ctx | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| 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 utils | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "sigs.k8s.io/e2e-framework/support" | ||
| ) | ||
|
|
||
| // PerformNodeLifecycleOperation performs a node operation on a cluster. These operations can range from Add/Remove/Start/Stop. | ||
| // This helper is re-used in both node lifecycle handler used as types.StepFunc or env.Func | ||
| func PerformNodeLifecycleOperation(ctx context.Context, action support.NodeOperation, node *support.Node, args ...string) error { | ||
| clusterVal := ctx.Value(support.ClusterNameContextKey(node.Cluster)) | ||
| if clusterVal == nil { | ||
| return fmt.Errorf("%s node to cluster: context cluster is nil", action) | ||
| } | ||
|
|
||
| clusterProvider, ok := clusterVal.(support.E2EClusterProviderWithLifeCycle) | ||
| if !ok { | ||
| return fmt.Errorf("cluster provider %s doesn't support node lifecycle operations", node.Cluster) | ||
| } | ||
|
|
||
| switch action { | ||
| case support.AddNode: | ||
| return clusterProvider.AddNode(ctx, node, args...) | ||
| case support.RemoveNode: | ||
| return clusterProvider.RemoveNode(ctx, node, args...) | ||
| case support.StartNode: | ||
| return clusterProvider.StartNode(ctx, node, args...) | ||
| case support.StopNode: | ||
| return clusterProvider.StopNode(ctx, node, args...) | ||
| default: | ||
| return fmt.Errorf("unknown node operation: %s", action) | ||
| } | ||
| } |
Oops, something went wrong.