File size: 6,599 Bytes
5dd7e60 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | // _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2025 Weaviate B.V. All rights reserved.
//
// CONTACT: hello@weaviate.io
//
package backup
import (
"context"
"encoding/json"
"fmt"
"reflect"
"testing"
"time"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"github.com/weaviate/weaviate/entities/backup"
"github.com/weaviate/weaviate/entities/models"
"github.com/weaviate/weaviate/entities/modulecapabilities"
"github.com/weaviate/weaviate/usecases/auth/authorization"
)
// A component-test like test suite that makes sure that every available UC is
// potentially protected with the Authorization plugin
func Test_Authorization(t *testing.T) {
req := &BackupRequest{ID: "123", Backend: "filesystem"}
type testCase struct {
methodName string
additionalArgs []interface{}
classes []string
expectedVerb string
expectedResource string
ignoreAuthZ bool
}
tests := []testCase{
{
methodName: "Backup",
additionalArgs: []interface{}{req},
expectedVerb: authorization.CREATE,
expectedResource: authorization.Backups("ABC")[0],
classes: []string{"ABC"},
},
{
methodName: "BackupStatus",
additionalArgs: []interface{}{"filesystem", "123", "", ""},
classes: []string{"ABC"},
ignoreAuthZ: true,
},
{
methodName: "Restore",
additionalArgs: []interface{}{req, false},
expectedVerb: authorization.CREATE,
expectedResource: authorization.Backups("ABC")[0],
classes: []string{"ABC"},
},
{
methodName: "RestorationStatus",
additionalArgs: []interface{}{"filesystem", "123", "", ""},
classes: []string{"ABC"},
ignoreAuthZ: true,
},
{
methodName: "Cancel",
additionalArgs: []interface{}{"filesystem", "123", "", ""},
expectedVerb: authorization.DELETE,
expectedResource: authorization.Backups("ABC")[0],
classes: []string{"ABC"},
},
{
methodName: "List",
additionalArgs: []interface{}{"filesystem"},
classes: []string{"ABC"},
ignoreAuthZ: true,
},
}
t.Run("verify that a test for every public method exists", func(t *testing.T) {
testedMethods := make([]string, len(tests))
for i, test := range tests {
testedMethods[i] = test.methodName
}
for _, method := range allExportedMethods(&Scheduler{}) {
switch method {
case "OnCommit", "OnAbort", "OnCanCommit",
"OnStatus", "CleanupUnfinishedBackups":
continue
}
assert.Contains(t, testedMethods, method)
}
})
t.Run("verify the tested methods require correct permissions from the authorizer", func(t *testing.T) {
logger, _ := test.NewNullLogger()
for _, test := range tests {
t.Run(test.methodName, func(t *testing.T) {
authorizer := authorization.NewMockAuthorizer(t)
selector := NewMockSelector(t)
backupProvider := NewMockBackupBackendProvider(t)
nodeResolver := NewMockNodeResolver(t)
modcapabilities := modulecapabilities.NewMockBackupBackend(t)
backupProvider.On("BackupBackend", mock.Anything).Return(modcapabilities, nil).Maybe()
modcapabilities.On("IsExternal").Return(false).Maybe()
modcapabilities.On("HomeDir", mock.Anything, mock.Anything, mock.Anything).Return("/").Maybe()
d, err := json.Marshal(backup.DistributedBackupDescriptor{
StartedAt: time.Now(),
Nodes: map[string]*backup.NodeDescriptor{
"node-0": {
Classes: test.classes,
Status: backup.Success,
},
},
Status: backup.Success,
ID: "123",
Version: "2.1",
ServerVersion: "x.x.x",
Error: "",
})
require.Nil(t, err)
var dd backup.DistributedBackupDescriptor
err = json.Unmarshal(d, &dd)
require.Nil(t, err)
var notFound interface{}
if test.methodName == "Backup" {
notFound = backup.ErrNotFound{}
} else {
notFound = nil
}
modcapabilities.On("GetObject", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(d, notFound).Maybe()
modcapabilities.On("PutObject", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil).Maybe()
modcapabilities.On("Initialize", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil).Maybe()
// AllBackups mock expectation for List method
if test.methodName == "List" {
modcapabilities.On("AllBackups", mock.Anything).Return([]*backup.DistributedBackupDescriptor{&dd}, nil)
}
nodeResolver.On("NodeCount").Return(1).Maybe()
nodeResolver.On("LeaderID").Return("node-0").Maybe()
nodeResolver.On("AllNames").Return([]string{"node-0"}).Maybe()
nodeResolver.On("NodeHostname", mock.Anything).Return("localhost", false).Maybe()
selector.On("Shards", mock.Anything, test.classes[0]).Return([]string{"node-0"}, nil).Maybe()
selector.On("ListClasses", mock.Anything).Return(test.classes).Maybe()
selector.On("Backupable", mock.Anything, mock.Anything).Return(nil).Maybe()
s := NewScheduler(authorizer, nil, selector, backupProvider, nodeResolver, &fakeSchemaManger{}, logger)
require.NotNil(t, s)
if !test.ignoreAuthZ {
authorizer.On("Authorize", mock.Anything, mock.Anything, test.expectedVerb, test.expectedResource).Return(nil)
}
args := append([]interface{}{context.Background(), &models.Principal{}}, test.additionalArgs...)
callFuncByName(s, test.methodName, args...)
})
}
})
}
// inspired by https://stackoverflow.com/a/33008200
func callFuncByName(manager interface{}, funcName string, params ...interface{}) (out []reflect.Value, err error) {
managerValue := reflect.ValueOf(manager)
m := managerValue.MethodByName(funcName)
if !m.IsValid() {
return make([]reflect.Value, 0), fmt.Errorf("Method not found \"%s\"", funcName)
}
in := make([]reflect.Value, len(params))
for i, param := range params {
in[i] = reflect.ValueOf(param)
}
out = m.Call(in)
return
}
func allExportedMethods(subject interface{}) []string {
var methods []string
subjectType := reflect.TypeOf(subject)
for i := 0; i < subjectType.NumMethod(); i++ {
name := subjectType.Method(i).Name
if name[0] >= 'A' && name[0] <= 'Z' {
methods = append(methods, name)
}
}
return methods
}
|