🌱 End-to-end tests for APIExportEndpointSlice #2608
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,310 @@ | ||
| /* | ||
| Copyright 2023 The KCP 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 apiexportendpointslice | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/wait" | ||
|
|
||
| apisv1alpha1 "github.com/kcp-dev/kcp/pkg/apis/apis/v1alpha1" | ||
| "github.com/kcp-dev/kcp/pkg/apis/core" | ||
| corev1alpha1 "github.com/kcp-dev/kcp/pkg/apis/core/v1alpha1" | ||
| "github.com/kcp-dev/kcp/pkg/apis/third_party/conditions/util/conditions" | ||
| topologyv1alpha1 "github.com/kcp-dev/kcp/pkg/apis/topology/v1alpha1" | ||
| kcpclientset "github.com/kcp-dev/kcp/pkg/client/clientset/versioned/cluster" | ||
| "github.com/kcp-dev/kcp/test/e2e/framework" | ||
| ) | ||
|
|
||
| func TestAPIExportEndpointSliceWithPartition(t *testing.T) { | ||
| t.Parallel() | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| server := framework.SharedKcpServer(t) | ||
|
|
||
| // Create Organization and Workspaces | ||
| orgPath, _ := framework.NewOrganizationFixture(t, server) | ||
| exportClusterPath, _ := framework.NewWorkspaceFixture(t, server, orgPath) | ||
| partitionClusterPath, _ := framework.NewWorkspaceFixture(t, server, orgPath) | ||
|
|
||
| cfg := server.BaseConfig(t) | ||
|
|
||
| var err error | ||
| kcpClusterClient, err := kcpclientset.NewForConfig(cfg) | ||
| require.NoError(t, err, "failed to construct kcp cluster client for server") | ||
|
|
||
| export := &apisv1alpha1.APIExport{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "my-export", | ||
| }, | ||
| } | ||
|
|
||
| slice := &apisv1alpha1.APIExportEndpointSlice{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| GenerateName: "my-slice", | ||
| }, | ||
| Spec: apisv1alpha1.APIExportEndpointSliceSpec{ | ||
| APIExport: apisv1alpha1.ExportBindingReference{ | ||
| Path: exportClusterPath.String(), | ||
| Name: export.Name, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| partition := &topologyv1alpha1.Partition{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "my-partition", | ||
| }, | ||
| Spec: topologyv1alpha1.PartitionSpec{ | ||
| Selector: &metav1.LabelSelector{ | ||
| MatchLabels: map[string]string{ | ||
| "region": "apiexportendpointslice-test-region", | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| t.Logf("Creating an APIExportEndpointSlice with reference to a nonexistent APIExport") | ||
| sliceClient := kcpClusterClient.ApisV1alpha1().APIExportEndpointSlices() | ||
|
|
||
| _, err = sliceClient.Cluster(partitionClusterPath).Create(ctx, slice, metav1.CreateOptions{}) | ||
| require.True(t, apierrors.IsForbidden(err), "no error creating APIExportEndpointSlice (admission should have declined it)") | ||
| sliceList, err := sliceClient.Cluster(partitionClusterPath).List(ctx, metav1.ListOptions{}) | ||
| require.NoError(t, err, "error listing APIExportEndpointSlice") | ||
| require.True(t, len(sliceList.Items) == 0, "not expecting any APIExportEndpointSlice") | ||
|
|
||
| t.Logf("Creating the missing APIExport") | ||
| exportClient := kcpClusterClient.ApisV1alpha1().APIExports() | ||
| _, err = exportClient.Cluster(exportClusterPath).Create(ctx, export, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating APIExport") | ||
|
|
||
| t.Logf("Retrying to create the APIExportEndpointSlice after the APIExport has been created") | ||
| require.Eventually(t, func() bool { | ||
| slice, err = sliceClient.Cluster(partitionClusterPath).Create(ctx, slice, metav1.CreateOptions{}) | ||
|
There was a problem hiding this comment. why does this call have to be wrapped into There was a problem hiding this comment. in case of delay with the syncing of the cache server. |
||
| return err == nil | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected APIExportEndpointSlice creation to succeed") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| slice, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return conditions.IsTrue(slice, apisv1alpha1.APIExportValid) && conditions.IsTrue(slice, apisv1alpha1.APIExportEndpointSliceURLsReady) | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected valid APIExport") | ||
|
|
||
| t.Logf("Adding a Partition to the APIExportEndpointSlice") | ||
| slice.Spec.Partition = partition.Name | ||
| _, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Update(ctx, slice, metav1.UpdateOptions{}) | ||
| require.NoError(t, err, "error updating APIExportEndpointSlice") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| slice, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return conditions.IsFalse(slice, apisv1alpha1.PartitionValid) && conditions.GetReason(slice, apisv1alpha1.PartitionValid) == apisv1alpha1.PartitionInvalidReferenceReason | ||
|
There was a problem hiding this comment. should we also examine any other conditions (if any) ? There was a problem hiding this comment. added check for URLs ready condition |
||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected missing Partition") | ||
| require.True(t, len(slice.Status.APIExportEndpoints) == 0, "not expecting any endpoint") | ||
| require.True(t, conditions.IsFalse(slice, apisv1alpha1.APIExportEndpointSliceURLsReady), "expecting URLs not ready condition") | ||
|
|
||
| t.Logf("Creating the missing Partition") | ||
| partitionClient := kcpClusterClient.TopologyV1alpha1().Partitions() | ||
| _, err = partitionClient.Cluster(partitionClusterPath).Create(ctx, partition, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating Partition") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| slice, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return conditions.IsTrue(slice, apisv1alpha1.PartitionValid) | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected valid Partition") | ||
|
|
||
| t.Logf("Checking that no endpoint has been populated") | ||
| require.True(t, len(slice.Status.APIExportEndpoints) == 0, "not expecting any endpoint") | ||
| require.True(t, conditions.IsTrue(slice, apisv1alpha1.APIExportEndpointSliceURLsReady), "expecting the URLs ready condition") | ||
| } | ||
|
|
||
| func TestAPIExportEndpointSliceWithPartitionPrivate(t *testing.T) { | ||
| t.Parallel() | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| server := framework.PrivateKcpServer(t) | ||
|
|
||
| // Create Organization and Workspaces | ||
| orgPath, _ := framework.NewOrganizationFixture(t, server) | ||
| exportClusterPath, _ := framework.NewWorkspaceFixture(t, server, orgPath) | ||
| partitionClusterPath, _ := framework.NewWorkspaceFixture(t, server, orgPath) | ||
|
|
||
| cfg := server.BaseConfig(t) | ||
|
|
||
| var err error | ||
| kcpClusterClient, err := kcpclientset.NewForConfig(cfg) | ||
| require.NoError(t, err, "failed to construct kcp cluster client for server") | ||
|
|
||
| export := &apisv1alpha1.APIExport{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "my-export", | ||
| }, | ||
| } | ||
|
|
||
| slice := &apisv1alpha1.APIExportEndpointSlice{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| GenerateName: "my-slice", | ||
| }, | ||
| Spec: apisv1alpha1.APIExportEndpointSliceSpec{ | ||
| APIExport: apisv1alpha1.ExportBindingReference{ | ||
| Path: exportClusterPath.String(), | ||
| Name: export.Name, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| partition := &topologyv1alpha1.Partition{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "my-partition", | ||
| }, | ||
| Spec: topologyv1alpha1.PartitionSpec{ | ||
| Selector: &metav1.LabelSelector{ | ||
| MatchLabels: map[string]string{ | ||
| "region": "apiexportendpointslice-test-region", | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| t.Logf("Creating the APIExport") | ||
| exportClient := kcpClusterClient.ApisV1alpha1().APIExports() | ||
| _, err = exportClient.Cluster(exportClusterPath).Create(ctx, export, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating APIExport") | ||
|
|
||
| t.Logf("Creating the APIExportEndpointSlice") | ||
| sliceClient := kcpClusterClient.ApisV1alpha1().APIExportEndpointSlices() | ||
| slice, err = sliceClient.Cluster(partitionClusterPath).Create(ctx, slice, metav1.CreateOptions{}) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| slice, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return conditions.IsTrue(slice, apisv1alpha1.APIExportValid) | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected valid APIExport") | ||
| require.True(t, conditions.IsTrue(slice, apisv1alpha1.APIExportEndpointSliceURLsReady), "expecting URLs ready condition") | ||
|
|
||
| t.Logf("Creating the Partition") | ||
| partitionClient := kcpClusterClient.TopologyV1alpha1().Partitions() | ||
| _, err = partitionClient.Cluster(partitionClusterPath).Create(ctx, partition, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating Partition") | ||
|
|
||
|
There was a problem hiding this comment. shouldn't we examine There was a problem hiding this comment. For that we would need to make assumptions on the shards in a shared environment, which I think it is better to avoid as long as we have not defined clear conventions.
There was a problem hiding this comment. In general we can assume that an environment created by the test binary is stable (either single or multi-shard) and doesn't change. Tests that are destructive should set-up their own env. Validating if There was a problem hiding this comment. Is it ? The test case appears to be adding a shard that matches a partition assigned to a This is not the same as "Validating if a APIExportEndpointSlice without a Partition has all (default) shards assigned" or is it? There was a problem hiding this comment. Added an end-to-end test for APIExportEndpointSlice without partition in the private environment. |
||
| t.Logf("Adding a Partition to the APIExportEndpointSlice") | ||
| slice.Spec.Partition = partition.Name | ||
| _, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Update(ctx, slice, metav1.UpdateOptions{}) | ||
| require.NoError(t, err, "error updating APIExportEndpointSlice") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| s, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return conditions.IsTrue(s, apisv1alpha1.PartitionValid) | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expected valid Partition") | ||
| require.True(t, conditions.IsTrue(slice, apisv1alpha1.APIExportEndpointSliceURLsReady), "expecting URLs ready condition") | ||
|
|
||
| t.Logf("Checking that no endpoint has been populated") | ||
| require.Eventually(t, func() bool { | ||
| s, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(s.Status.APIExportEndpoints) == 0 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "not expecting any endpoint") | ||
|
|
||
|
There was a problem hiding this comment. would it make sense to add a scenario with a partition that would select some shards ? could be just There was a problem hiding this comment. As per the above this is covered with the private server. |
||
| // Endpoint tests require the edition of shards. | ||
| // These tests are run on a private cluster to avoid side effects on other e2e tests. | ||
| // They require the resources previously created: APIExport, APIExportEndpointSlice, etc. | ||
| shard := &corev1alpha1.Shard{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "my-shard", | ||
| Labels: map[string]string{ | ||
| "region": "apiexportendpointslice-test-region", | ||
| }, | ||
| }, | ||
| Spec: corev1alpha1.ShardSpec{ | ||
| BaseURL: "https://base.kcp.test.dev", | ||
| }, | ||
| } | ||
|
|
||
| t.Logf("Creating a shard in the region") | ||
| shardClient := kcpClusterClient.CoreV1alpha1().Shards() | ||
| shard, err = shardClient.Cluster(core.RootCluster.Path()).Create(ctx, shard, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating Shard") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| slice, err = kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(slice.Status.APIExportEndpoints) == 1 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expecting a single endpoint") | ||
| require.Contains(t, slice.Status.APIExportEndpoints[0].URL, export.Name) | ||
|
|
||
| t.Logf("Updating the previously created shard") | ||
| shard.Labels["region"] = "doesnotexist" | ||
| shard, err = shardClient.Cluster(core.RootCluster.Path()).Update(ctx, shard, metav1.UpdateOptions{}) | ||
| require.NoError(t, err, "error updating Shard") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| s, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(s.Status.APIExportEndpoints) == 0 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expecting no endpoint") | ||
|
|
||
| t.Logf("Setting back the correct label") | ||
| shard.Labels["region"] = "apiexportendpointslice-test-region" | ||
| shard, err = shardClient.Cluster(core.RootCluster.Path()).Update(ctx, shard, metav1.UpdateOptions{}) | ||
| require.NoError(t, err, "error updating Shard") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| s, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(s.Status.APIExportEndpoints) == 1 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expecting a single endpoint") | ||
|
|
||
| t.Logf("Deleting the shard") | ||
| err = shardClient.Cluster(core.RootCluster.Path()).Delete(ctx, shard.Name, metav1.DeleteOptions{}) | ||
| require.NoError(t, err, "error deleting Shard") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| s, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, slice.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(s.Status.APIExportEndpoints) == 0 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expecting no endpoint") | ||
|
|
||
| t.Logf("Creating a slice without partition") | ||
| sliceWithAll := &apisv1alpha1.APIExportEndpointSlice{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| GenerateName: "my-slice-without-partition", | ||
| }, | ||
| Spec: apisv1alpha1.APIExportEndpointSliceSpec{ | ||
| APIExport: apisv1alpha1.ExportBindingReference{ | ||
| Path: exportClusterPath.String(), | ||
| Name: slice.Spec.APIExport.Name, | ||
| }, | ||
| }, | ||
| } | ||
| sliceWithAll, err = sliceClient.Cluster(partitionClusterPath).Create(ctx, sliceWithAll, metav1.CreateOptions{}) | ||
| require.NoError(t, err, "error creating APIExportEndpointSlice") | ||
|
|
||
| require.Eventually(t, func() bool { | ||
| sliceWithAll, err := kcpClusterClient.Cluster(partitionClusterPath).ApisV1alpha1().APIExportEndpointSlices().Get(ctx, sliceWithAll.Name, metav1.GetOptions{}) | ||
| require.NoError(t, err) | ||
| return len(sliceWithAll.Status.APIExportEndpoints) == 1 | ||
| }, wait.ForeverTestTimeout, 100*time.Millisecond, "expecting a single endpoint for the root shard, got %d", len(sliceWithAll.Status.APIExportEndpoints)) | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we trust the server or could we issue a
GETrq and make sure theslicewasn't created?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can add that.