etcd/tests/common/auth_util.go
Chao Chen 9a2553fe2f migrate auth tests to common #7
Signed-off-by: Chao Chen <chaochn@amazon.com>
2023-03-27 19:30:41 -07:00

125 lines
3.2 KiB
Go

// Copyright 2022 The etcd Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package common
import (
"context"
"fmt"
"testing"
"github.com/stretchr/testify/require"
"go.etcd.io/etcd/api/v3/authpb"
clientv3 "go.etcd.io/etcd/client/v3"
"go.etcd.io/etcd/tests/v3/framework/config"
"go.etcd.io/etcd/tests/v3/framework/interfaces"
)
const (
rootUserName = "root"
rootRoleName = "root"
rootPassword = "rootPassword"
testUserName = "test-user"
testRoleName = "test-role"
testPassword = "pass"
)
var (
rootUser = authUser{user: rootUserName, pass: rootPassword, role: rootRoleName}
testUser = authUser{user: testUserName, pass: testPassword, role: testRoleName}
testRole = authRole{
role: testRoleName,
permission: clientv3.PermissionType(clientv3.PermReadWrite),
key: "foo",
keyEnd: "",
}
)
type authRole struct {
role string
permission clientv3.PermissionType
key string
keyEnd string
}
type authUser struct {
user string
pass string
role string
}
func createRoles(c interfaces.Client, roles []authRole) error {
for _, r := range roles {
// add role
if _, err := c.RoleAdd(context.TODO(), r.role); err != nil {
return fmt.Errorf("RoleAdd failed: %w", err)
}
// grant permission to role
if _, err := c.RoleGrantPermission(context.TODO(), r.role, r.key, r.keyEnd, r.permission); err != nil {
return fmt.Errorf("RoleGrantPermission failed: %w", err)
}
}
return nil
}
func createUsers(c interfaces.Client, users []authUser) error {
for _, u := range users {
// add user
if _, err := c.UserAdd(context.TODO(), u.user, u.pass, config.UserAddOptions{}); err != nil {
return fmt.Errorf("UserAdd failed: %w", err)
}
// grant role to user
if _, err := c.UserGrantRole(context.TODO(), u.user, u.role); err != nil {
return fmt.Errorf("UserGrantRole failed: %w", err)
}
}
return nil
}
func setupAuth(c interfaces.Client, roles []authRole, users []authUser) error {
// create roles
if err := createRoles(c, roles); err != nil {
return err
}
if err := createUsers(c, users); err != nil {
return err
}
// enable auth
if err := c.AuthEnable(context.TODO()); err != nil {
return err
}
return nil
}
func requireRolePermissionEqual(t *testing.T, expectRole authRole, actual []*authpb.Permission) {
require.Equal(t, 1, len(actual))
require.Equal(t, expectRole.permission, clientv3.PermissionType(actual[0].PermType))
require.Equal(t, expectRole.key, string(actual[0].Key))
require.Equal(t, expectRole.keyEnd, string(actual[0].RangeEnd))
}
func requireUserRolesEqual(t *testing.T, expectUser authUser, actual []string) {
require.Equal(t, 1, len(actual))
require.Equal(t, expectUser.role, actual[0])
}