Test setup for accounts handler and ListAccounts permission checks

2026-05-24 22:19:09 -05:00 · 2020-09-04 11:36:27 +02:00
parent 9a4a08e35f
commit d6db5c9f64
1 changed files with 164 additions and 0 deletions
@@ -0,0 +1,164 @@
+package service
+
+import (
+	"context"
+	"encoding/json"
+	"log"
+	"net/http"
+	"os"
+	"testing"
+	"time"
+
+	"github.com/micro/go-micro/v2/client"
+	merrors "github.com/micro/go-micro/v2/errors"
+	"github.com/micro/go-micro/v2/metadata"
+	"github.com/owncloud/ocis-accounts/pkg/config"
+	"github.com/owncloud/ocis-accounts/pkg/proto/v0"
+	olog "github.com/owncloud/ocis-pkg/v2/log"
+	"github.com/owncloud/ocis-pkg/v2/middleware"
+	"github.com/owncloud/ocis-pkg/v2/roles"
+	settings "github.com/owncloud/ocis-settings/pkg/proto/v0"
+	ssvc "github.com/owncloud/ocis-settings/pkg/service/v0"
+	"github.com/stretchr/testify/assert"
+)
+
+const dataPath = "/var/tmp/ocis-accounts-tests"
+
+var (
+	roleServiceMock settings.RoleService
+	s               *Service
+)
+
+func init() {
+	cfg := config.New()
+	cfg.Server.Name = "accounts"
+	cfg.Server.AccountsDataPath = dataPath
+	logger := olog.NewLogger(olog.Color(true), olog.Pretty(true))
+	roleServiceMock = buildRoleServiceMock()
+	roleManager := roles.NewManager(
+		roles.Logger(logger),
+		roles.RoleService(roleServiceMock),
+		roles.CacheTTL(time.Hour),
+		roles.CacheSize(1024),
+	)
+	s, _ = New(
+		Logger(logger),
+		Config(cfg),
+		RoleService(roleServiceMock),
+		RoleManager(&roleManager),
+	)
+}
+
+func setup() (teardown func()) {
+	return func() {
+		if err := os.RemoveAll(dataPath); err != nil {
+			log.Printf("could not delete data root: %s", dataPath)
+		} else {
+			log.Println("data root deleted")
+		}
+	}
+}
+
+// TestPermissionsListAccounts checks permission handling on ListAccounts
+func TestPermissionsListAccounts(t *testing.T) {
+	var scenarios = []struct {
+		name            string
+		roleIDs         []string
+		query           string
+		permissionError error
+	}{
+		// TODO: remove this test when https://github.com/owncloud/ocis-accounts/pull/111 is merged
+		// replace with two tests:
+		// 1: "ListAccounts fails with 403 when no roleIDs in context"
+		// 2: "ListAccounts fails with 403 when no admin role in context and query empty"
+		{
+			"ListAccounts succeeds when no roleIDs in context",
+			nil,
+			"",
+			nil,
+		},
+		{
+			"ListAccounts fails when no admin roleID in context",
+			[]string{ssvc.BundleUUIDRoleUser, ssvc.BundleUUIDRoleGuest},
+			"",
+			merrors.Forbidden(s.id, "no permission for ListAccounts"),
+		},
+		{
+			"ListAccounts succeeds when admin roleID in context",
+			[]string{ssvc.BundleUUIDRoleAdmin},
+			"",
+			nil,
+		},
+	}
+
+	for _, scenario := range scenarios {
+		t.Run(scenario.name, func(t *testing.T) {
+			teardown := setup()
+			defer teardown()
+
+			ctx := context.Background()
+			if scenario.roleIDs != nil {
+				roleIDs, err := json.Marshal(scenario.roleIDs)
+				assert.NoError(t, err)
+				ctx = metadata.Set(ctx, middleware.RoleIDs, string(roleIDs))
+			}
+
+			request := &proto.ListAccountsRequest{
+				Query: scenario.query,
+			}
+			response := &proto.ListAccountsResponse{}
+			err := s.ListAccounts(ctx, request, response)
+			if scenario.permissionError != nil {
+				assert.Equal(t, scenario.permissionError, err)
+			} else if err != nil {
+				// we are only checking permissions here, so just check that the error code is not 403
+				merr := merrors.FromError(err)
+				assert.NotEqual(t, http.StatusForbidden, merr.GetCode())
+			}
+		})
+	}
+}
+
+func buildRoleServiceMock() settings.RoleService {
+	defaultRoles := map[string]*settings.Bundle{
+		ssvc.BundleUUIDRoleAdmin: {
+			Id:   ssvc.BundleUUIDRoleAdmin,
+			Type: settings.Bundle_TYPE_ROLE,
+			Resource: &settings.Resource{
+				Type: settings.Resource_TYPE_SYSTEM,
+			},
+			Settings: []*settings.Setting{
+				{
+					Id: AccountManagementPermissionID,
+				},
+			},
+		},
+		ssvc.BundleUUIDRoleUser: {
+			Id:   ssvc.BundleUUIDRoleUser,
+			Type: settings.Bundle_TYPE_ROLE,
+			Resource: &settings.Resource{
+				Type: settings.Resource_TYPE_SYSTEM,
+			},
+			Settings: []*settings.Setting{},
+		},
+	}
+	return settings.MockRoleService{
+		ListRolesFunc: func(ctx context.Context, req *settings.ListBundlesRequest, opts ...client.CallOption) (res *settings.ListBundlesResponse, err error) {
+			payload := make([]*settings.Bundle, 0)
+			for _, roleID := range req.BundleIds {
+				if defaultRoles[roleID] != nil {
+					payload = append(payload, defaultRoles[roleID])
+				}
+			}
+			return &settings.ListBundlesResponse{
+				Bundles: payload,
+			}, nil
+		},
+		AssignRoleToUserFunc: func(ctx context.Context, req *settings.AssignRoleToUserRequest, opts ...client.CallOption) (res *settings.AssignRoleToUserResponse, err error) {
+			// mock can be empty. function is called during service start. actual role assignments not needed for the tests.
+			return &settings.AssignRoleToUserResponse{
+				Assignment: &settings.UserRoleAssignment{},
+			}, nil
+		},
+	}
+}