moved events to its own pkg

Author: ilijamt

events.go internal/event/event.goevents.go renamed to internal/event/event.go

@@ -1,4 +1,4 @@
-package gitlab
+package event
 
 import (
 	"context"
@@ -10,14 +10,15 @@ import (
 	"google.golang.org/protobuf/types/known/structpb"
 )
 
-func Event(ctx context.Context, b *framework.Backend, eventType string, metadata map[string]string) {
+func Event(ctx context.Context, b *framework.Backend, prefix, eventType string, metadata map[string]string) error {
 	var err error
 	var ev *logical.EventData
 	if ev, err = logical.NewEvent(); err == nil {
 		var metadataBytes []byte
 		metadataBytes, _ = json.Marshal(metadata)
 		ev.Metadata = &structpb.Struct{}
 		_ = ev.Metadata.UnmarshalJSON(metadataBytes)
-		_ = b.SendEvent(ctx, logical.EventType(fmt.Sprintf("%s/%s", operationPrefixGitlabAccessTokens, eventType)), ev)
+		err = b.SendEvent(ctx, logical.EventType(fmt.Sprintf("%s/%s", prefix, eventType)), ev)
 	}
+	return err
 }

internal/event/event_test.go

@@ -0,0 +1,63 @@
+package event_test
+
+import (
+	"context"
+	"sync"
+	"testing"
+
+	"github.com/hashicorp/vault/sdk/framework"
+	"github.com/hashicorp/vault/sdk/logical"
+	"github.com/stretchr/testify/require"
+
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
+)
+
+type mockEventsSender struct {
+	events []*logical.EventReceived
+	mu     sync.Mutex
+}
+
+var _ logical.EventSender = (*mockEventsSender)(nil)
+
+func (m *mockEventsSender) SendEvent(ctx context.Context, eventType logical.EventType, event *logical.EventData) error {
+	if m == nil {
+		return nil
+	}
+	m.mu.Lock()
+	defer m.mu.Unlock()
+	m.events = append(m.events, &logical.EventReceived{
+		EventType: string(eventType),
+		Event:     event,
+	})
+	return nil
+}
+
+func TestEvent(t *testing.T) {
+	t.Run("no sender specified", func(t *testing.T) {
+		b := &framework.Backend{}
+		require.NoError(t, b.Setup(t.Context(), &logical.BackendConfig{}))
+		require.ErrorIs(t,
+			event.Event(
+				t.Context(),
+				&framework.Backend{},
+				"test", "test",
+				map[string]string{"test": "test"},
+			),
+			framework.ErrNoEvents,
+		)
+	})
+
+	t.Run("with event sender", func(t *testing.T) {
+		b := &framework.Backend{}
+		evt := &mockEventsSender{}
+		require.NoError(t, b.Setup(t.Context(), &logical.BackendConfig{EventsSender: evt}))
+		require.NoError(t,
+			event.Event(
+				t.Context(), b,
+				"test", "test",
+				map[string]string{"test": "test"},
+			),
+		)
+		require.Len(t, evt.events, 1)
+	})
+}

path_config.go

@@ -13,6 +13,7 @@ import (
 	g "gitlab.com/gitlab-org/api/client-go"
 
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/errs"
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/gitlab"
 )
 
@@ -91,7 +92,7 @@ func (b *Backend) pathConfigDelete(ctx context.Context, req *logical.Request, da
 		}
 
 		if err = req.Storage.Delete(ctx, fmt.Sprintf("%s/%s", PathConfigStorage, name)); err == nil {
-			Event(ctx, b.Backend, "config-delete", map[string]string{
+			event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "config-delete", map[string]string{
 				"path": fmt.Sprintf("%s/%s", PathConfigStorage, name),
 			})
 			b.SetClient(nil, name)
@@ -146,7 +147,7 @@ func (b *Backend) pathConfigPatch(ctx context.Context, req *logical.Request, dat
 	defer b.lockClientMutex.Unlock()
 	if err = saveConfig(ctx, *config, req.Storage); err == nil {
 		lrd := config.LogicalResponseData(b.flags.ShowConfigToken)
-		Event(ctx, b.Backend, "config-patch", changes)
+		event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "config-patch", changes)
 		b.SetClient(nil, name)
 		b.Logger().Debug("Patched config", "lrd", lrd, "warnings", warnings)
 		lResp = &logical.Response{Data: lrd, Warnings: warnings}
@@ -205,7 +206,7 @@ func (b *Backend) pathConfigWrite(ctx context.Context, req *logical.Request, dat
 	var lResp *logical.Response
 
 	if err = saveConfig(ctx, *config, req.Storage); err == nil {
-		Event(ctx, b.Backend, "config-write", map[string]string{
+		event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "config-write", map[string]string{
 			"path":               fmt.Sprintf("%s/%s", PathConfigStorage, name),
 			"auto_rotate_token":  strconv.FormatBool(config.AutoRotateToken),
 			"auto_rotate_before": config.AutoRotateBefore.String(),

path_config_rotate.go

@@ -12,6 +12,7 @@ import (
 	"github.com/hashicorp/vault/sdk/logical"
 
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/errs"
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 )
 
 const pathConfigRotateHelpSynopsis = `Rotate the gitlab token for this configuration.`
@@ -105,7 +106,7 @@ func (b *Backend) pathConfigTokenRotate(ctx context.Context, request *logical.Re
 
 	lResp = &logical.Response{Data: config.LogicalResponseData(b.flags.ShowConfigToken)}
 	lResp.Data["token"] = config.Token
-	Event(ctx, b.Backend, "config-token-rotate", map[string]string{
+	event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "config-token-rotate", map[string]string{
 		"path":        fmt.Sprintf("%s/%s", PathConfigStorage, name),
 		"expires_at":  entryToken.ExpiresAt.Format(time.RFC3339),
 		"created_at":  entryToken.CreatedAt.Format(time.RFC3339),

path_flags.go

@@ -9,6 +9,8 @@ import (
 	"github.com/hashicorp/vault/sdk/framework"
 	"github.com/hashicorp/vault/sdk/logical"
 	"github.com/mitchellh/mapstructure"
+
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 )
 
 const (
@@ -43,7 +45,7 @@ func (b *Backend) pathFlagsUpdate(ctx context.Context, req *logical.Request, dat
 		eventData["show_config_token"] = strconv.FormatBool(b.flags.ShowConfigToken)
 	}
 
-	Event(ctx, b.Backend, "flags-write", eventData)
+	event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "flags-write", eventData)
 
 	var flagData map[string]any
 	err = mapstructure.Decode(b.flags, &flagData)

path_role.go

@@ -16,6 +16,7 @@ import (
 	"github.com/hashicorp/vault/sdk/logical"
 
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/errs"
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/gitlab"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/token"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/utils"
@@ -166,7 +167,7 @@ func (b *Backend) pathRolesDelete(ctx context.Context, req *logical.Request, dat
 		return nil, fmt.Errorf("error deleting role: %w", err)
 	}
 
-	Event(ctx, b.Backend, "role-delete", map[string]string{
+	event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "role-delete", map[string]string{
 		"path":      "roles",
 		"role_name": roleName,
 	})
@@ -370,7 +371,7 @@ func (b *Backend) pathRolesWrite(ctx context.Context, req *logical.Request, data
 		return nil, err
 	}
 
-	Event(ctx, b.Backend, "role-write", map[string]string{
+	event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "role-write", map[string]string{
 		"path":        "roles",
 		"role_name":   roleName,
 		"config_name": role.ConfigName,

path_token_role.go

@@ -13,6 +13,7 @@ import (
 	"github.com/hashicorp/vault/sdk/logical"
 
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/errs"
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 	token2 "github.com/ilijamt/vault-plugin-secrets-gitlab/internal/token"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/utils"
 )
@@ -155,8 +156,8 @@ func (b *Backend) pathTokenRoleCreate(ctx context.Context, req *logical.Request,
 		resp.Secret.TTL = token.TTL()
 	}
 
-	Event(
-		ctx, b.Backend, "token-write",
+	event.Event(
+		ctx, b.Backend, operationPrefixGitlabAccessTokens, "token-write",
 		token.Event(map[string]string{"path": fmt.Sprintf("%s/%s", PathRoleStorage, roleName)}),
 	)
 	return resp, nil

secret_access_tokens.go

@@ -10,6 +10,7 @@ import (
 	"github.com/hashicorp/vault/sdk/logical"
 
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/errs"
+	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/event"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/token"
 	"github.com/ilijamt/vault-plugin-secrets-gitlab/internal/utils"
 )
@@ -127,7 +128,7 @@ func (b *Backend) secretAccessTokenRevoke(ctx context.Context, req *logical.Requ
 		}
 	}
 
-	Event(ctx, b.Backend, "token-revoke", map[string]string{
+	event.Event(ctx, b.Backend, operationPrefixGitlabAccessTokens, "token-revoke", map[string]string{
 		"lease_id":             secret.LeaseID,
 		"path":                 req.Secret.InternalData["path"].(string),
 		"name":                 req.Secret.InternalData["name"].(string),