Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NET-6444] Add tenancy to Reaper Tests #19550

Merged
merged 2 commits into from
Nov 9, 2023
Merged

[NET-6444] Add tenancy to Reaper Tests #19550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ee5a68
[NET-6444] Add tenancy to Reaper Tests
kkavish Nov 7, 2023
be47042
Merge branch 'main' into NET-6444
kkavish Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions agent/grpc-external/services/resource/testing/testing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package testing

import (
"context"
rtest "github.com/hashicorp/consul/internal/resource/resourcetest"
"testing"

"github.com/hashicorp/go-uuid"
Expand Down Expand Up @@ -57,6 +58,23 @@ func RunResourceService(t *testing.T, registerFns ...func(resource.Registry)) pb
return RunResourceServiceWithConfig(t, svc.Config{}, registerFns...)
}

// RunResourceServiceWithTenancies runs a Resource Service with tenancies returned from TestTenancies.
func RunResourceServiceWithTenancies(t *testing.T, registerFns ...func(resource.Registry)) pbresource.ResourceServiceClient {
mockTenancyBridge := &svc.MockTenancyBridge{}

for _, tenant := range rtest.TestTenancies() {
mockTenancyBridge.On("PartitionExists", tenant.Partition).Return(true, nil)
mockTenancyBridge.On("NamespaceExists", tenant.Partition, tenant.Namespace).Return(true, nil)
mockTenancyBridge.On("IsPartitionMarkedForDeletion", tenant.Partition).Return(false, nil)
mockTenancyBridge.On("IsNamespaceMarkedForDeletion", tenant.Partition, tenant.Namespace).Return(false, nil)
}

cfg := &svc.Config{
TenancyBridge: mockTenancyBridge,
}
return RunResourceServiceWithConfig(t, *cfg, registerFns...)
}

// RunResourceServiceWithConfig runs a ResourceService with caller injectable config to ease mocking dependencies.
// Any nil config field is replaced with a reasonable default with the following behavior:
//
Expand Down
333 changes: 179 additions & 154 deletions internal/resource/reaper/controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package reaper

import (
"github.com/hashicorp/consul/internal/resource/resourcetest"
"testing"
"time"

Expand All @@ -20,174 +21,198 @@ import (
)

func TestReconcile_ResourceWithNoChildren(t *testing.T) {
client := svctest.RunResourceService(t, demo.RegisterTypes)

// Seed the database with an artist.
res, err := demo.GenerateV2Artist()
require.NoError(t, err)
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)

// Retrieve tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: writeRsp.Resource.Id.Tenancy,
client := svctest.RunResourceServiceWithTenancies(t, demo.RegisterTypes)

runReaperTestCaseWithTenancies(func(tenancy *pbresource.Tenancy) {
// Seed the database with an artist.
res, err := demo.GenerateV2Artist()

// set resource tenancy from default to test tenancy
res.Id.Tenancy = tenancy

require.NoError(t, err)
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)

// Retrieve tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: tenancy,
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))

// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify reconcile does second pass and tombstone is deleted
// Fake out time so elapsed time > secondPassDelay
rec.timeNow = func() time.Time { return time.Now().Add(secondPassDelay + time.Second) }
require.NoError(t, rec.Reconcile(ctx, runtime, req))
_, err = client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.Error(t, err)
require.Equal(t, codes.NotFound.String(), status.Code(err).String())

// Reconcile again to verify no-op on an already deleted tombstone
require.NoError(t, rec.Reconcile(ctx, runtime, req))
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))

// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify reconcile does second pass and tombstone is deleted
// Fake out time so elapsed time > secondPassDelay
rec.timeNow = func() time.Time { return time.Now().Add(secondPassDelay + time.Second) }
require.NoError(t, rec.Reconcile(ctx, runtime, req))
_, err = client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.Error(t, err)
require.Equal(t, codes.NotFound.String(), status.Code(err).String())

// Reconcile again to verify no-op on an already deleted tombstone
require.NoError(t, rec.Reconcile(ctx, runtime, req))
}

func TestReconcile_ResourceWithChildren(t *testing.T) {
client := svctest.RunResourceService(t, demo.RegisterTypes)
client := svctest.RunResourceServiceWithTenancies(t, demo.RegisterTypes)

runReaperTestCaseWithTenancies(func(tenancy *pbresource.Tenancy) {
// Seed the database with an artist
res, err := demo.GenerateV2Artist()

// Seed the database with an artist
res, err := demo.GenerateV2Artist()
require.NoError(t, err)
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)
artist := writeRsp.Resource
// set resource tenancy from default to test tenancy
res.Id.Tenancy = tenancy

// Create 3 albums owned by the artist
numAlbums := 3
for i := 0; i < numAlbums; i++ {
res, err = demo.GenerateV2Album(artist.Id)
require.NoError(t, err)
_, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)
artist := writeRsp.Resource

// Create 3 albums owned by the artist
numAlbums := 3
for i := 0; i < numAlbums; i++ {
res, err = demo.GenerateV2Album(artist.Id)
require.NoError(t, err)
_, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)
}

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)
}

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)

// Retrieve the tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: writeRsp.Resource.Id.Tenancy,
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass delete and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))
// Retrieve the tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: writeRsp.Resource.Id.Tenancy,
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass delete and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))

// Verify 3 albums deleted
listRsp, err = client.List(ctx, &pbresource.ListRequest{
Type: demo.TypeV2Album,
Tenancy: artist.Id.Tenancy,
})
require.NoError(t, err)
require.Empty(t, listRsp.Resources)

// Verify 3 albums deleted
listRsp, err = client.List(ctx, &pbresource.ListRequest{
Type: demo.TypeV2Album,
Tenancy: artist.Id.Tenancy,
})
require.NoError(t, err)
require.Empty(t, listRsp.Resources)

// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify reconcile does second pass
// Fake out time so elapsed time > secondPassDelay
rec.timeNow = func() time.Time { return time.Now().Add(secondPassDelay + time.Second) }
require.NoError(t, rec.Reconcile(ctx, runtime, req))

// Verify artist tombstone deleted
_, err = client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.Error(t, err)
require.Equal(t, codes.NotFound.String(), status.Code(err).String())

// Verify tombstones for 3 albums created
listRsp, err = client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: artist.Id.Tenancy,
// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify reconcile does second pass
// Fake out time so elapsed time > secondPassDelay
rec.timeNow = func() time.Time { return time.Now().Add(secondPassDelay + time.Second) }
require.NoError(t, rec.Reconcile(ctx, runtime, req))

// Verify artist tombstone deleted
_, err = client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.Error(t, err)
require.Equal(t, codes.NotFound.String(), status.Code(err).String())

// Verify tombstones for 3 albums created
listRsp, err = client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: artist.Id.Tenancy,
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, numAlbums)
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, numAlbums)
}

func TestReconcile_RequeueWithDelayWhenSecondPassDelayNotElapsed(t *testing.T) {
client := svctest.RunResourceService(t, demo.RegisterTypes)

// Seed the database with an artist.
res, err := demo.GenerateV2Artist()
require.NoError(t, err)
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)

// Retrieve tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: writeRsp.Resource.Id.Tenancy,
client := svctest.RunResourceServiceWithTenancies(t, demo.RegisterTypes)

runReaperTestCaseWithTenancies(func(tenancy *pbresource.Tenancy) {
// Seed the database with an artist.
res, err := demo.GenerateV2Artist()

// set resource tenancy from default to test tenancy
res.Id.Tenancy = tenancy

require.NoError(t, err)
ctx := testutil.TestContext(t)
writeRsp, err := client.Write(ctx, &pbresource.WriteRequest{Resource: res})
require.NoError(t, err)

// Delete the artist to create a tombstone
_, err = client.Delete(ctx, &pbresource.DeleteRequest{Id: writeRsp.Resource.Id})
require.NoError(t, err)

// Retrieve tombstone
listRsp, err := client.List(ctx, &pbresource.ListRequest{
Type: resource.TypeV1Tombstone,
Tenancy: writeRsp.Resource.Id.Tenancy,
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))

// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify requeued for second pass since secondPassDelay time has not elapsed
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))
})
require.NoError(t, err)
require.Len(t, listRsp.Resources, 1)
tombstone := listRsp.Resources[0]

// Verify reconcile does first pass and queues up for a second pass
rec := newReconciler()
runtime := controller.Runtime{
Client: client,
Logger: testutil.Logger(t),
}

func runReaperTestCaseWithTenancies(testCase func(tenancy *pbresource.Tenancy)) {
for _, tenancy := range resourcetest.TestTenancies() {
testCase(tenancy)
}
req := controller.Request{ID: tombstone.Id}
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))

// Verify condition FirstPassCompleted is true
readRsp, err := client.Read(ctx, &pbresource.ReadRequest{Id: tombstone.Id})
require.NoError(t, err)
tombstone = readRsp.Resource
condition := tombstone.Status[statusKeyReaperController].Conditions[0]
require.Equal(t, conditionTypeFirstPassCompleted, condition.Type)
require.Equal(t, pbresource.Condition_STATE_TRUE, condition.State)

// Verify requeued for second pass since secondPassDelay time has not elapsed
require.ErrorIs(t, controller.RequeueAfterError(secondPassDelay), rec.Reconcile(ctx, runtime, req))
}