suite_test.go•13.3 kB
/*
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 garbagecollection_test
import (
"context"
"fmt"
"sync"
"testing"
"time"
"sigs.k8s.io/karpenter/pkg/test/v1alpha1"
"github.com/aws/aws-sdk-go-v2/aws"
ec2types "github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/awslabs/operatorpkg/object"
"github.com/samber/lo"
corev1 "k8s.io/api/core/v1"
"k8s.io/client-go/tools/record"
karpv1 "sigs.k8s.io/karpenter/pkg/apis/v1"
karpcloudprovider "sigs.k8s.io/karpenter/pkg/cloudprovider"
"sigs.k8s.io/karpenter/pkg/events"
coretest "sigs.k8s.io/karpenter/pkg/test"
"github.com/aws/karpenter-provider-aws/pkg/apis"
v1 "github.com/aws/karpenter-provider-aws/pkg/apis/v1"
"github.com/aws/karpenter-provider-aws/pkg/cloudprovider"
"github.com/aws/karpenter-provider-aws/pkg/controllers/nodeclaim/garbagecollection"
"github.com/aws/karpenter-provider-aws/pkg/fake"
"github.com/aws/karpenter-provider-aws/pkg/operator/options"
"github.com/aws/karpenter-provider-aws/pkg/test"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
. "sigs.k8s.io/karpenter/pkg/test/expectations"
. "sigs.k8s.io/karpenter/pkg/utils/testing"
coreoptions "sigs.k8s.io/karpenter/pkg/operator/options"
)
var ctx context.Context
var awsEnv *test.Environment
var env *coretest.Environment
var garbageCollectionController *garbagecollection.Controller
var cloudProvider *cloudprovider.CloudProvider
func TestAPIs(t *testing.T) {
ctx = TestContextWithLogger(t)
RegisterFailHandler(Fail)
RunSpecs(t, "GarbageCollection")
}
var _ = BeforeSuite(func() {
ctx = options.ToContext(ctx, test.Options())
env = coretest.NewEnvironment(coretest.WithCRDs(apis.CRDs...), coretest.WithCRDs(v1alpha1.CRDs...))
ctx = coreoptions.ToContext(ctx, coretest.Options(coretest.OptionsFields{FeatureGates: coretest.FeatureGates{ReservedCapacity: lo.ToPtr(true)}}))
awsEnv = test.NewEnvironment(ctx, env)
cloudProvider = cloudprovider.New(awsEnv.InstanceTypesProvider, awsEnv.InstanceProvider, events.NewRecorder(&record.FakeRecorder{}),
env.Client, awsEnv.AMIProvider, awsEnv.SecurityGroupProvider, awsEnv.CapacityReservationProvider, awsEnv.InstanceTypeStore)
garbageCollectionController = garbagecollection.NewController(env.Client, cloudProvider)
})
var _ = AfterSuite(func() {
Expect(env.Stop()).To(Succeed(), "Failed to stop environment")
})
var _ = BeforeEach(func() {
awsEnv.Reset()
})
var _ = Describe("GarbageCollection", func() {
var instance *ec2types.Instance
var nodeClass *v1.EC2NodeClass
var providerID string
BeforeEach(func() {
instanceID := fake.InstanceID()
providerID = fake.ProviderID(instanceID)
nodeClass = test.EC2NodeClass()
nodePool := coretest.NodePool(karpv1.NodePool{
Spec: karpv1.NodePoolSpec{
Template: karpv1.NodeClaimTemplate{
Spec: karpv1.NodeClaimTemplateSpec{
NodeClassRef: &karpv1.NodeClassReference{
Group: object.GVK(nodeClass).Group,
Kind: object.GVK(nodeClass).Kind,
Name: nodeClass.Name,
},
},
},
},
})
instance = &ec2types.Instance{
State: &ec2types.InstanceState{
Name: ec2types.InstanceStateNameRunning,
},
Tags: []ec2types.Tag{
{
Key: aws.String(fmt.Sprintf("kubernetes.io/cluster/%s", options.FromContext(ctx).ClusterName)),
Value: aws.String("owned"),
},
{
Key: aws.String(karpv1.NodePoolLabelKey),
Value: aws.String(nodePool.Name),
},
{
Key: aws.String(v1.LabelNodeClass),
Value: aws.String(nodeClass.Name),
},
{
Key: aws.String(v1.EKSClusterNameTagKey),
Value: aws.String(options.FromContext(ctx).ClusterName),
},
},
PrivateDnsName: aws.String(fake.PrivateDNSName()),
Placement: &ec2types.Placement{
AvailabilityZone: aws.String(fake.DefaultRegion),
},
InstanceId: aws.String(instanceID),
InstanceType: "m5.large",
}
})
AfterEach(func() {
ExpectCleanedUp(ctx, env.Client)
})
It("should delete an instance if there is no NodeClaim owner", func() {
// Launch time was 1m ago
instance.LaunchTime = aws.Time(time.Now().Add(-time.Minute))
awsEnv.EC2API.Instances.Store(aws.ToString(instance.InstanceId), *instance)
ExpectSingletonReconciled(ctx, garbageCollectionController)
awsEnv.InstanceCache.Flush()
_, err := cloudProvider.Get(ctx, providerID)
Expect(err).To(HaveOccurred())
Expect(karpcloudprovider.IsNodeClaimNotFoundError(err)).To(BeTrue())
})
It("should delete an instance along with the node if there is no NodeClaim owner (to quicken scheduling)", func() {
// Launch time was 1m ago
instance.LaunchTime = aws.Time(time.Now().Add(-time.Minute))
awsEnv.EC2API.Instances.Store(aws.ToString(instance.InstanceId), *instance)
node := coretest.Node(coretest.NodeOptions{
ProviderID: providerID,
})
ExpectApplied(ctx, env.Client, node)
ExpectSingletonReconciled(ctx, garbageCollectionController)
awsEnv.InstanceCache.Flush()
_, err := cloudProvider.Get(ctx, providerID)
Expect(err).To(HaveOccurred())
Expect(karpcloudprovider.IsNodeClaimNotFoundError(err)).To(BeTrue())
ExpectNotFound(ctx, env.Client, node)
})
It("should delete many instances if they all don't have NodeClaim owners", func() {
// Generate 100 instances that have different instanceIDs
var ids []string
for i := 0; i < 100; i++ {
instanceID := fake.InstanceID()
awsEnv.EC2API.Instances.Store(
instanceID,
ec2types.Instance{
State: &ec2types.InstanceState{
Name: ec2types.InstanceStateNameRunning,
},
Tags: []ec2types.Tag{
{
Key: aws.String(fmt.Sprintf("kubernetes.io/cluster/%s", options.FromContext(ctx).ClusterName)),
Value: aws.String("owned"),
},
{
Key: aws.String(karpv1.NodePoolLabelKey),
Value: aws.String("default"),
},
{
Key: aws.String(v1.LabelNodeClass),
Value: aws.String("default"),
},
{
Key: aws.String(v1.EKSClusterNameTagKey),
Value: aws.String(options.FromContext(ctx).ClusterName),
},
},
PrivateDnsName: aws.String(fake.PrivateDNSName()),
Placement: &ec2types.Placement{
AvailabilityZone: aws.String(fake.DefaultRegion),
},
// Launch time was 1m ago
LaunchTime: aws.Time(time.Now().Add(-time.Minute)),
InstanceId: aws.String(instanceID),
InstanceType: "m5.large",
},
)
ids = append(ids, instanceID)
}
ExpectSingletonReconciled(ctx, garbageCollectionController)
wg := sync.WaitGroup{}
for _, id := range ids {
wg.Add(1)
go func(id string) {
defer GinkgoRecover()
defer wg.Done()
awsEnv.InstanceCache.Flush()
_, err := cloudProvider.Get(ctx, fake.ProviderID(id))
Expect(err).To(HaveOccurred())
Expect(karpcloudprovider.IsNodeClaimNotFoundError(err)).To(BeTrue())
}(id)
}
wg.Wait()
})
It("should not delete all instances if they all have NodeClaim owners", func() {
// Generate 100 instances that have different instanceIDs
var ids []string
var nodeClaims []*karpv1.NodeClaim
for i := 0; i < 100; i++ {
instanceID := fake.InstanceID()
awsEnv.EC2API.Instances.Store(
instanceID,
ec2types.Instance{
State: &ec2types.InstanceState{
Name: ec2types.InstanceStateNameRunning,
},
Tags: []ec2types.Tag{
{
Key: aws.String(fmt.Sprintf("kubernetes.io/cluster/%s", options.FromContext(ctx).ClusterName)),
Value: aws.String("owned"),
},
},
PrivateDnsName: aws.String(fake.PrivateDNSName()),
Placement: &ec2types.Placement{
AvailabilityZone: aws.String(fake.DefaultRegion),
},
// Launch time was 1m ago
LaunchTime: aws.Time(time.Now().Add(-time.Minute)),
InstanceId: aws.String(instanceID),
InstanceType: "m5.large",
},
)
nodeClaim := coretest.NodeClaim(karpv1.NodeClaim{
Spec: karpv1.NodeClaimSpec{
NodeClassRef: &karpv1.NodeClassReference{
Group: object.GVK(nodeClass).Group,
Kind: object.GVK(nodeClass).Kind,
Name: nodeClass.Name,
},
},
Status: karpv1.NodeClaimStatus{
ProviderID: fake.ProviderID(instanceID),
},
})
ExpectApplied(ctx, env.Client, nodeClaim)
nodeClaims = append(nodeClaims, nodeClaim)
ids = append(ids, instanceID)
}
ExpectSingletonReconciled(ctx, garbageCollectionController)
wg := sync.WaitGroup{}
for _, id := range ids {
wg.Add(1)
go func(id string) {
defer GinkgoRecover()
defer wg.Done()
_, err := cloudProvider.Get(ctx, fake.ProviderID(id))
Expect(err).ToNot(HaveOccurred())
}(id)
}
wg.Wait()
for _, nodeClaim := range nodeClaims {
ExpectExists(ctx, env.Client, nodeClaim)
}
})
It("should not delete an instance if it is within the NodeClaim resolution window (1m)", func() {
// Launch time just happened
instance.LaunchTime = aws.Time(time.Now())
awsEnv.EC2API.Instances.Store(aws.ToString(instance.InstanceId), *instance)
ExpectSingletonReconciled(ctx, garbageCollectionController)
_, err := cloudProvider.Get(ctx, providerID)
Expect(err).NotTo(HaveOccurred())
})
It("should not delete an instance if it was not launched by a NodeClaim", func() {
// Remove the "karpenter.sh/nodepool" tag (this isn't launched by a machine)
instance.Tags = lo.Reject(instance.Tags, func(t ec2types.Tag, _ int) bool {
return aws.ToString(t.Key) == karpv1.NodePoolLabelKey
})
// Launch time was 1m ago
instance.LaunchTime = aws.Time(time.Now().Add(-time.Minute))
awsEnv.EC2API.Instances.Store(aws.ToString(instance.InstanceId), *instance)
ExpectSingletonReconciled(ctx, garbageCollectionController)
_, err := cloudProvider.Get(ctx, providerID)
Expect(err).NotTo(HaveOccurred())
})
It("should not delete the instance or node if it already has a NodeClaim that matches it", func() {
// Launch time was 1m ago
instance.LaunchTime = aws.Time(time.Now().Add(-time.Minute))
awsEnv.EC2API.Instances.Store(aws.ToString(instance.InstanceId), *instance)
nodeClaim := coretest.NodeClaim(karpv1.NodeClaim{
Spec: karpv1.NodeClaimSpec{
NodeClassRef: &karpv1.NodeClassReference{
Group: object.GVK(nodeClass).Group,
Kind: object.GVK(nodeClass).Kind,
Name: nodeClass.Name,
},
},
Status: karpv1.NodeClaimStatus{
ProviderID: providerID,
},
})
node := coretest.Node(coretest.NodeOptions{
ProviderID: providerID,
})
ExpectApplied(ctx, env.Client, nodeClaim, node)
ExpectSingletonReconciled(ctx, garbageCollectionController)
_, err := cloudProvider.Get(ctx, providerID)
Expect(err).ToNot(HaveOccurred())
ExpectExists(ctx, env.Client, node)
})
It("should not delete many instances or nodes if they already have NodeClaim owners that match it", func() {
// Generate 100 instances that have different instanceIDs that have NodeClaims
var ids []string
var nodes []*corev1.Node
for i := 0; i < 100; i++ {
instanceID := fake.InstanceID()
awsEnv.EC2API.Instances.Store(
instanceID,
ec2types.Instance{
State: &ec2types.InstanceState{
Name: ec2types.InstanceStateNameRunning,
},
Tags: []ec2types.Tag{
{
Key: aws.String(fmt.Sprintf("kubernetes.io/cluster/%s", options.FromContext(ctx).ClusterName)),
Value: aws.String("owned"),
},
{
Key: aws.String(karpv1.NodePoolLabelKey),
Value: aws.String("default"),
},
{
Key: aws.String(v1.EKSClusterNameTagKey),
Value: aws.String(options.FromContext(ctx).ClusterName),
},
},
PrivateDnsName: aws.String(fake.PrivateDNSName()),
Placement: &ec2types.Placement{
AvailabilityZone: aws.String(fake.DefaultRegion),
},
// Launch time was 1m ago
LaunchTime: aws.Time(time.Now().Add(-time.Minute)),
InstanceId: aws.String(instanceID),
InstanceType: "m5.large",
},
)
nodeClaim := coretest.NodeClaim(karpv1.NodeClaim{
Spec: karpv1.NodeClaimSpec{
NodeClassRef: &karpv1.NodeClassReference{
Group: object.GVK(nodeClass).Group,
Kind: object.GVK(nodeClass).Kind,
Name: nodeClass.Name,
},
},
Status: karpv1.NodeClaimStatus{
ProviderID: fake.ProviderID(instanceID),
},
})
node := coretest.Node(coretest.NodeOptions{
ProviderID: fake.ProviderID(instanceID),
})
ExpectApplied(ctx, env.Client, nodeClaim, node)
ids = append(ids, instanceID)
nodes = append(nodes, node)
}
ExpectSingletonReconciled(ctx, garbageCollectionController)
wg := sync.WaitGroup{}
for i := range ids {
wg.Add(1)
go func(id string, node *corev1.Node) {
defer GinkgoRecover()
defer wg.Done()
_, err := cloudProvider.Get(ctx, fake.ProviderID(id))
Expect(err).ToNot(HaveOccurred())
ExpectExists(ctx, env.Client, node)
}(ids[i], nodes[i])
}
wg.Wait()
})
})