K8s: Folders: Add pagination for children (#100978)

2025-02-19 19:06:26 +01:00
parent ff1b22297c
commit 95278d7552
4 changed files with 233 additions and 20 deletions
@@ -1,10 +1,19 @@
 package folderimpl

 import (
+	"context"
 	"testing"

+	claims "github.com/grafana/authlib/types"
+	"github.com/grafana/grafana/pkg/apimachinery/identity"
+	"github.com/grafana/grafana/pkg/services/accesscontrol"
+	"github.com/grafana/grafana/pkg/services/apiserver/client"
 	"github.com/grafana/grafana/pkg/services/folder"
+	"github.com/grafana/grafana/pkg/storage/unified/resource"
+	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/selection"
 )

 func TestComputeFullPath(t *testing.T) {
@@ -75,3 +84,155 @@ func TestComputeFullPath(t *testing.T) {
 		})
 	}
 }
+
+func TestGetChildren(t *testing.T) {
+	mockCli := new(client.MockK8sHandler)
+	store := FolderUnifiedStoreImpl{
+		k8sclient: mockCli,
+	}
+
+	ctx := context.Background()
+	orgID := int64(2)
+
+	t.Run("should be able to find children folders, and set defaults for pages", func(t *testing.T) {
+		mockCli.On("Search", mock.Anything, orgID, &resource.ResourceSearchRequest{
+			Options: &resource.ListOptions{
+				Fields: []*resource.Requirement{
+					{
+						Key:      resource.SEARCH_FIELD_FOLDER,
+						Operator: string(selection.In),
+						Values:   []string{"folder1"},
+					},
+				},
+			},
+			Limit:  folderSearchLimit, // should default to folderSearchLimit
+			Offset: 0,                 // should be set as limit * (page - 1)
+			Page:   1,                 // should be set to 1 by default
+		}).Return(&resource.ResourceSearchResponse{
+			Results: &resource.ResourceTable{
+				Columns: []*resource.ResourceTableColumnDefinition{
+					{Name: "folder", Type: resource.ResourceTableColumnDefinition_STRING},
+				},
+				Rows: []*resource.ResourceTableRow{
+					{
+						Key:   &resource.ResourceKey{Name: "folder2", Resource: "folder"},
+						Cells: [][]byte{[]byte("folder1")},
+					},
+					{
+						Key:   &resource.ResourceKey{Name: "folder3", Resource: "folder"},
+						Cells: [][]byte{[]byte("folder1")},
+					},
+				},
+			},
+			TotalHits: 1,
+		}, nil).Once()
+		mockCli.On("Get", mock.Anything, "folder2", orgID, mock.Anything, mock.Anything).Return(&unstructured.Unstructured{
+			Object: map[string]interface{}{
+				"metadata": map[string]interface{}{"name": "folder2"},
+			},
+		}, nil).Once()
+		mockCli.On("Get", mock.Anything, "folder3", orgID, mock.Anything, mock.Anything).Return(&unstructured.Unstructured{
+			Object: map[string]interface{}{
+				"metadata": map[string]interface{}{"name": "folder3"},
+			},
+		}, nil).Once()
+
+		// don't set page or limit - should be automatically added
+		result, err := store.GetChildren(ctx, folder.GetChildrenQuery{
+			UID:   "folder1",
+			OrgID: orgID,
+		})
+		require.NoError(t, err)
+		require.Len(t, result, 2)
+		require.Equal(t, "folder2", result[0].UID)
+		require.Equal(t, "folder3", result[1].UID)
+	})
+
+	t.Run("pages should be able to be set, general folder should be turned to empty string, and folder uids should be passed in", func(t *testing.T) {
+		mockCli.On("Search", mock.Anything, orgID, &resource.ResourceSearchRequest{
+			Options: &resource.ListOptions{
+				Fields: []*resource.Requirement{
+					{
+						Key:      resource.SEARCH_FIELD_FOLDER,
+						Operator: string(selection.In),
+						Values:   []string{""}, // should be an empty string if general is passed in
+					},
+					{
+						Key:      resource.SEARCH_FIELD_NAME,
+						Operator: string(selection.In),
+						Values:   []string{"folder2"},
+					},
+				},
+			},
+			Limit:  10,
+			Offset: 20, // should be set as limit * (page - 1)
+			Page:   3,
+		}).Return(&resource.ResourceSearchResponse{
+			Results: &resource.ResourceTable{
+				Columns: []*resource.ResourceTableColumnDefinition{
+					{Name: "folder", Type: resource.ResourceTableColumnDefinition_STRING},
+				},
+				Rows: []*resource.ResourceTableRow{
+					{
+						Key:   &resource.ResourceKey{Name: "folder2", Resource: "folder"},
+						Cells: [][]byte{[]byte("folder1")},
+					},
+				},
+			},
+			TotalHits: 1,
+		}, nil).Once()
+		mockCli.On("Get", mock.Anything, "folder2", orgID, mock.Anything, mock.Anything).Return(&unstructured.Unstructured{
+			Object: map[string]interface{}{
+				"metadata": map[string]interface{}{"name": "folder2"},
+			},
+		}, nil).Once()
+
+		result, err := store.GetChildren(ctx, folder.GetChildrenQuery{
+			UID:        "general",
+			OrgID:      orgID,
+			Limit:      10,
+			Page:       3,
+			FolderUIDs: []string{"folder2"},
+		})
+		require.NoError(t, err)
+		require.Len(t, result, 1)
+		require.Equal(t, "folder2", result[0].UID)
+	})
+
+	t.Run("k6 folder should only be returned to service accounts", func(t *testing.T) {
+		mockCli.On("Search", mock.Anything, orgID, mock.Anything).Return(&resource.ResourceSearchResponse{
+			Results: &resource.ResourceTable{
+				Columns: []*resource.ResourceTableColumnDefinition{
+					{Name: "folder", Type: resource.ResourceTableColumnDefinition_STRING},
+				},
+				Rows: []*resource.ResourceTableRow{
+					{
+						Key:   &resource.ResourceKey{Name: accesscontrol.K6FolderUID, Resource: "folder"},
+						Cells: [][]byte{[]byte("folder1")},
+					},
+				},
+			},
+			TotalHits: 1,
+		}, nil)
+		mockCli.On("Get", mock.Anything, accesscontrol.K6FolderUID, orgID, mock.Anything, mock.Anything).Return(&unstructured.Unstructured{
+			Object: map[string]interface{}{
+				"metadata": map[string]interface{}{"name": accesscontrol.K6FolderUID},
+			},
+		}, nil)
+
+		result, err := store.GetChildren(ctx, folder.GetChildrenQuery{
+			UID:   "folder",
+			OrgID: orgID,
+		})
+		require.NoError(t, err)
+		require.Len(t, result, 0)
+
+		result, err = store.GetChildren(ctx, folder.GetChildrenQuery{
+			UID:          "folder",
+			OrgID:        orgID,
+			SignedInUser: &identity.StaticRequester{Type: claims.TypeServiceAccount},
+		})
+		require.NoError(t, err)
+		require.Len(t, result, 1)
+	})
+}