public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(folders): allow correct max depth on app platform (#110907)

Browse Source
This commit is contained in:
Jean-Philippe Quéméner
2025-09-11 10:00:23 +02:00
committed by GitHub
parent 4463df8224
commit ecf08ad7d5
3 changed files with 191 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/registry/apis/folders/register.go
+1
View File
@@ -18,6 +18,7 @@ import (
"k8s.io/kube-openapi/pkg/spec3" "k8s.io/kube-openapi/pkg/spec3"
authlib "github.com/grafana/authlib/types" authlib "github.com/grafana/authlib/types"
folders "github.com/grafana/grafana/apps/folder/pkg/apis/folder/v1beta1" folders "github.com/grafana/grafana/apps/folder/pkg/apis/folder/v1beta1"
"github.com/grafana/grafana/apps/iam/pkg/reconcilers" "github.com/grafana/grafana/apps/iam/pkg/reconcilers"
"github.com/grafana/grafana/pkg/apimachinery/identity" "github.com/grafana/grafana/pkg/apimachinery/identity"
pkg/registry/apis/folders/validate.go
+3 -2
View File
@@ -58,8 +58,9 @@ func validateOnCreate(ctx context.Context, f *folders.Folder, getter parentsGett
return fmt.Errorf("unable to create folder inside parent: %w", err) return fmt.Errorf("unable to create folder inside parent: %w", err)
} }
// Can not create a folder that will be too deep // Can not create a folder that will be too deep.
if len(parents.Items)+1 > maxDepth { // We need to add +1 as we also have the root folder as part of the parents.
if len(parents.Items) > maxDepth+1 {
return fmt.Errorf("folder max depth exceeded, max depth is %d", maxDepth) return fmt.Errorf("folder max depth exceeded, max depth is %d", maxDepth)
} }
pkg/registry/apis/folders/validate_test.go
+187 -117
View File
@@ -12,6 +12,7 @@ import (
folders "github.com/grafana/grafana/apps/folder/pkg/apis/folder/v1beta1" folders "github.com/grafana/grafana/apps/folder/pkg/apis/folder/v1beta1"
"github.com/grafana/grafana/pkg/apimachinery/utils" "github.com/grafana/grafana/pkg/apimachinery/utils"
grafanarest "github.com/grafana/grafana/pkg/apiserver/rest" grafanarest "github.com/grafana/grafana/pkg/apiserver/rest"
"github.com/grafana/grafana/pkg/services/folder"
"github.com/grafana/grafana/pkg/storage/unified/resourcepb" "github.com/grafana/grafana/pkg/storage/unified/resourcepb"
) )
@@ -23,79 +24,110 @@ func TestValidateCreate(t *testing.T) {
getterError error getterError error
expectedErr string expectedErr string
maxDepth int // defaults to 5 unless set maxDepth int // defaults to 5 unless set
}{{ }{
name: "ok", {
folder: &folders.Folder{ name: "ok",
ObjectMeta: metav1.ObjectMeta{ folder: &folders.Folder{
Name: "p1", ObjectMeta: metav1.ObjectMeta{
Annotations: map[string]string{"grafana.app/folder": "p2"}, Name: "p1",
Annotations: map[string]string{"grafana.app/folder": "p2"},
},
Spec: folders.FolderSpec{
Title: "some title",
},
}, },
Spec: folders.FolderSpec{ getter: &folders.FolderInfoList{
Title: "some title", Items: []folders.FolderInfo{
{Name: "p2", Parent: "p3"},
{Name: "p3"},
},
}, },
}, },
getter: &folders.FolderInfoList{ {
Items: []folders.FolderInfo{ name: "reserved name",
{Name: "p2", Parent: "p3"}, folder: &folders.Folder{
{Name: "p3"}, ObjectMeta: metav1.ObjectMeta{
Name: "general", // can not name something with general
},
}, },
expectedErr: "invalid uid for folder provided",
}, },
}, { {
name: "reserved name", name: "too long",
folder: &folders.Folder{ folder: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{ ObjectMeta: metav1.ObjectMeta{
Name: "general", // can not name something with general Name: "a0123456789012345678901234567890123456789", // longer than 40
},
}, },
expectedErr: "uid too long, max 40 characters",
}, },
expectedErr: "invalid uid for folder provided", {
}, { name: "bad name",
name: "too long", folder: &folders.Folder{
folder: &folders.Folder{ ObjectMeta: metav1.ObjectMeta{
ObjectMeta: metav1.ObjectMeta{ Name: "hello world", // not a-z|0-9,
Name: "a0123456789012345678901234567890123456789", // longer than 40 },
}, },
expectedErr: "uid contains illegal characters",
}, },
expectedErr: "uid too long, max 40 characters", {
}, { name: "can not be a parent of yourself",
name: "bad name", folder: &folders.Folder{
folder: &folders.Folder{ ObjectMeta: metav1.ObjectMeta{
ObjectMeta: metav1.ObjectMeta{ Name: "p1",
Name: "hello world", // not a-z|0-9, Annotations: map[string]string{"grafana.app/folder": "p1"},
},
Spec: folders.FolderSpec{
Title: "some title",
},
}, },
expectedErr: "folder cannot be parent of itself",
}, },
expectedErr: "uid contains illegal characters", {
}, { name: "can not create a tree that is too deep",
name: "can not be a parent of yourself", folder: &folders.Folder{
folder: &folders.Folder{ ObjectMeta: metav1.ObjectMeta{
ObjectMeta: metav1.ObjectMeta{ Name: "p1",
Name: "p1", Annotations: map[string]string{"grafana.app/folder": "p2"},
Annotations: map[string]string{"grafana.app/folder": "p1"}, },
Spec: folders.FolderSpec{
Title: "some title",
},
}, },
Spec: folders.FolderSpec{ getter: &folders.FolderInfoList{
Title: "some title", Items: []folders.FolderInfo{
{Name: "p2", Parent: "p3"},
{Name: "p3", Parent: "p4"},
{Name: "p4", Parent: folder.GeneralFolderUID},
{Name: folder.GeneralFolderUID},
},
}, },
maxDepth: 2,
expectedErr: "folder max depth exceeded",
}, },
expectedErr: "folder cannot be parent of itself", {
}, { name: "can create a folder in max depth",
name: "can not create a tree that is too deep", folder: &folders.Folder{
folder: &folders.Folder{ ObjectMeta: metav1.ObjectMeta{
ObjectMeta: metav1.ObjectMeta{ Name: "5",
Name: "p1", Annotations: map[string]string{"grafana.app/folder": "4"},
Annotations: map[string]string{"grafana.app/folder": "p2"}, },
Spec: folders.FolderSpec{
Title: "some title",
},
}, },
Spec: folders.FolderSpec{ getter: &folders.FolderInfoList{
Title: "some title", Items: []folders.FolderInfo{
{Name: "4", Parent: "3"},
{Name: "3", Parent: "2"},
{Name: "2", Parent: "1"},
{Name: "1", Parent: folder.GeneralFolderUID},
{Name: folder.GeneralFolderUID},
},
}, },
maxDepth: folder.MaxNestedFolderDepth,
}, },
getter: &folders.FolderInfoList{ }
Items: []folders.FolderInfo{
{Name: "p2", Parent: "p3"},
{Name: "p3"},
},
},
maxDepth: 2, // will become 3
expectedErr: "folder max depth exceeded",
}}
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
@@ -127,75 +159,113 @@ func TestValidateUpdate(t *testing.T) {
parentsError error parentsError error
expectedErr string expectedErr string
maxDepth int // defaults to 5 unless set maxDepth int // defaults to 5 unless set
}{{ }{
name: "change title", {
folder: &folders.Folder{ name: "change title",
ObjectMeta: metav1.ObjectMeta{ folder: &folders.Folder{
Name: "nnn", ObjectMeta: metav1.ObjectMeta{
}, Name: "nnn",
Spec: folders.FolderSpec{ },
Title: "changed", Spec: folders.FolderSpec{
}, Title: "changed",
},
old: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{
Name: "nnn",
},
Spec: folders.FolderSpec{
Title: "old title",
},
},
}, {
name: "error to move into k6 folder",
folder: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{
Name: "nnn",
Annotations: map[string]string{
utils.AnnoKeyFolder: "k6-app",
}, },
}, },
Spec: folders.FolderSpec{ old: &folders.Folder{
Title: "changed", ObjectMeta: metav1.ObjectMeta{
}, Name: "nnn",
}, },
old: &folders.Folder{ Spec: folders.FolderSpec{
ObjectMeta: metav1.ObjectMeta{ Title: "old title",
Name: "nnn",
},
Spec: folders.FolderSpec{
Title: "old title",
},
},
expectedErr: "k6 project may not be moved",
}, {
name: "error when moving too deep",
folder: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Annotations: map[string]string{
utils.AnnoKeyFolder: "p1",
}, },
}, },
Spec: folders.FolderSpec{
Title: "changed",
},
}, },
old: &folders.Folder{ {
ObjectMeta: metav1.ObjectMeta{}, name: "error to move into k6 folder",
Spec: folders.FolderSpec{ folder: &folders.Folder{
Title: "old title", ObjectMeta: metav1.ObjectMeta{
Name: "nnn",
Annotations: map[string]string{
utils.AnnoKeyFolder: "k6-app",
},
},
Spec: folders.FolderSpec{
Title: "changed",
},
}, },
}, old: &folders.Folder{
parents: &folders.FolderInfoList{ ObjectMeta: metav1.ObjectMeta{
Items: []folders.FolderInfo{ Name: "nnn",
{Name: "p1", Parent: "p2"}, },
{Name: "p2", Parent: "p3"}, Spec: folders.FolderSpec{
{Name: "p3"}, Title: "old title",
},
}, },
expectedErr: "k6 project may not be moved",
}, },
maxDepth: 2, // will become 3 {
expectedErr: "[folder.maximum-depth-reached]", name: "no error when moving to max depth",
}} folder: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Annotations: map[string]string{
utils.AnnoKeyFolder: "4",
},
},
Spec: folders.FolderSpec{
Title: "changed",
},
},
old: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{},
Spec: folders.FolderSpec{
Title: "old title",
},
},
parents: &folders.FolderInfoList{
Items: []folders.FolderInfo{
{Name: "4", Parent: "3"},
{Name: "3", Parent: "2"},
{Name: "2", Parent: "1"},
{Name: "1", Parent: folder.GeneralFolderUID},
{Name: folder.GeneralFolderUID},
},
},
maxDepth: folder.MaxNestedFolderDepth,
expectedErr: "[folder.maximum-depth-reached]",
},
{
name: "error when moving too deep",
folder: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Annotations: map[string]string{
utils.AnnoKeyFolder: "5",
},
},
Spec: folders.FolderSpec{
Title: "changed",
},
},
old: &folders.Folder{
ObjectMeta: metav1.ObjectMeta{},
Spec: folders.FolderSpec{
Title: "old title",
},
},
parents: &folders.FolderInfoList{
Items: []folders.FolderInfo{
{Name: "5", Parent: "4"},
{Name: "4", Parent: "3"},
{Name: "3", Parent: "2"},
{Name: "2", Parent: "1"},
{Name: "1", Parent: folder.GeneralFolderUID},
{Name: folder.GeneralFolderUID},
},
},
maxDepth: folder.MaxNestedFolderDepth,
expectedErr: "[folder.maximum-depth-reached]",
},
}
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {