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.

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

Add admin/superuser error handling and cleanup #8559

Merged
merged 2 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
6 changes: 6 additions & 0 deletions pkg/auth/setup/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,12 @@ func AddAdminUser(ctx context.Context, authService auth.Service, user *model.Sup
if err != nil {
return nil, fmt.Errorf("create user - %w", err)
}
defer func() {
// delete admin on any error to avoid partial setup
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please replace the comment with an informative log message (info/warn imo)

if err != nil {
_ = authService.DeleteUser(ctx, user.Username)
}
}()

if addToAdmins {
// verify the admin group exists
Expand Down
80 changes: 80 additions & 0 deletions pkg/auth/setup/setup_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package setup_test

import (
"context"
"errors"
"testing"
"time"

"github.com/treeverse/lakefs/pkg/auth"
"github.com/treeverse/lakefs/pkg/auth/crypt"
"github.com/treeverse/lakefs/pkg/auth/model"
authparams "github.com/treeverse/lakefs/pkg/auth/params"
"github.com/treeverse/lakefs/pkg/auth/setup"
"github.com/treeverse/lakefs/pkg/kv"
"github.com/treeverse/lakefs/pkg/kv/kvtest"
"github.com/treeverse/lakefs/pkg/logging"
)

func SetupService(t *testing.T, secret string) (*auth.BasicAuthService, kv.Store) {
t.Helper()
kvStore := kvtest.GetStore(context.Background(), t)
return auth.NewBasicAuthService(kvStore, crypt.NewSecretStore([]byte(secret)), authparams.ServiceCache{
Enabled: false,
}, logging.ContextUnavailable()), kvStore
}

func TestAddAdminUser(t *testing.T) {
authService, _ := SetupService(t, "secret")
ctx := context.Background()

// setup admin user
superuser := &model.SuperuserConfiguration{
User: model.User{
CreatedAt: time.Now(),
Username: "testuser",
},
AccessKeyID: "key",
SecretAccessKey: "secret",
}
_, err := setup.AddAdminUser(ctx, authService, superuser, false)
if err != nil {
t.Fatal("failed to add admin user:", err)
}

// try to add another admin user - should fail
superuser2 := &model.SuperuserConfiguration{
User: model.User{
CreatedAt: time.Now(),
Username: "testuser2",
},
AccessKeyID: "key2",
SecretAccessKey: "secret2",
}
_, err = setup.AddAdminUser(ctx, authService, superuser2, false)
expectedErr := auth.ErrAlreadyExists
if !errors.Is(err, expectedErr) {
t.Fatalf("adding another admin. err:%v, expected:%v", err, expectedErr)
}

// delete admin user should work
err = authService.DeleteUser(ctx, superuser.User.Username)
if err != nil {
t.Fatal("failed to delete admin user:", err)
}

// setup admin user again without secret access key should fail
superuser.SecretAccessKey = ""
_, err = setup.AddAdminUser(ctx, authService, superuser, false)
expectedErr = auth.ErrNotFound
if !errors.Is(err, expectedErr) {
t.Fatalf("adding admin without secret access. key err:%v, expected:%v", err, expectedErr)
}

// we should be able to re-add the admin user
superuser.SecretAccessKey = "new-secret"
_, err = setup.AddAdminUser(ctx, authService, superuser, false)
if err != nil {
t.Fatal("failed to re-add admin user:", err)
}
}
Loading