Add SigNoz access review driver

Add a SigNoz connector so its organization members can be pulled into access-review campaign snapshots. SigNoz authenticates with a SIGNOZ-API-KEY admin service-account key and a customer-supplied base URL (a SigNoz Cloud region/tenant host or a self-hosted instance). The driver lists users via GET /api/v1/user, which returns the role (ADMIN/EDITOR/VIEWER) inline so admin detection works in a single call, and maps the SigNoz user status (active / pending_invite / deleted) to the account active flag. The name resolver reads the organization display name from GET /api/v2/orgs/me to title the access source. Wire the provider through the coredata enum and settings, the connector-provider registry (driver and name-resolver factories), the console API-key input schema and validation, the access-review source label, and the SigNoz brand logo. Co-authored-by: Bryan FRIMIN <bryan@frimin.fr> Signed-off-by: Aurélien Sibiril <81782+aureliensibiril@users.noreply.github.com>
2026-06-08 23:15:50 +02:00
parent dbf915047d
commit 4df0e52810
17 changed files with 794 additions and 2 deletions
--- a/pkg/accessreview/drivers/signoz_test.go
+++ b/pkg/accessreview/drivers/signoz_test.go
@@ -0,0 +1,188 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package drivers
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.probo.inc/probo/pkg/coredata"
+)
+
+// TestSigNozDriver replays a cassette (recorded against SigNoz Cloud, then
+// anonymized) covering the role/status matrix and exercises both the driver
+// (GET /api/v1/user) and the name resolver (GET /api/v2/orgs/me).
+func TestSigNozDriver(t *testing.T) {
+	t.Parallel()
+
+	rec := newRecorder(t, "testdata/signoz", "SIGNOZ_API_KEY")
+	client := newVCRClientWithHeader(rec, "SIGNOZ-API-KEY", os.Getenv("SIGNOZ_API_KEY"))
+
+	baseURL := os.Getenv("SIGNOZ_BASE_URL")
+	if baseURL == "" {
+		baseURL = "https://signoz.example.com"
+	}
+
+	records, err := NewSigNozDriver(client, baseURL).ListAccounts(context.Background())
+	require.NoError(t, err)
+	require.Len(t, records, 5) // the no-email user is skipped
+
+	// ADMIN role -> admin.
+	assert.Equal(t, "admin@example.com", records[0].Email)
+	assert.Equal(t, "Admin User", records[0].FullName)
+	assert.Equal(t, "Admin", records[0].Role)
+	assert.True(t, records[0].IsAdmin)
+	assert.Equal(t, "00000000-0000-4000-8000-000000000001", records[0].ExternalID)
+	assert.Equal(t, coredata.MFAStatusUnknown, records[0].MFAStatus)
+	require.NotNil(t, records[0].Active)
+	assert.True(t, *records[0].Active)
+	require.NotNil(t, records[0].CreatedAt)
+
+	// isRoot -> admin even with a non-admin role.
+	assert.Equal(t, "owner@example.com", records[1].Email)
+	assert.Equal(t, "Viewer", records[1].Role)
+	assert.True(t, records[1].IsAdmin)
+
+	// Managed-role display name -> Editor; not admin.
+	assert.Equal(t, "editor@example.com", records[2].Email)
+	assert.Equal(t, "Editor", records[2].Role)
+	assert.False(t, records[2].IsAdmin)
+	require.NotNil(t, records[2].Active)
+	assert.True(t, *records[2].Active)
+
+	// pending_invite -> inactive.
+	assert.Equal(t, "invited@example.com", records[3].Email)
+	assert.Equal(t, "Viewer", records[3].Role)
+	require.NotNil(t, records[3].Active)
+	assert.False(t, *records[3].Active)
+
+	// deleted -> inactive.
+	assert.Equal(t, "removed@example.com", records[4].Email)
+	assert.Equal(t, "Editor", records[4].Role)
+	require.NotNil(t, records[4].Active)
+	assert.False(t, *records[4].Active)
+
+	name, err := NewSigNozNameResolver(client, baseURL).ResolveInstanceName(context.Background())
+	require.NoError(t, err)
+	assert.Equal(t, "Example Org", name)
+}
+
+func TestSigNozDriverListAccountsEmptyData(t *testing.T) {
+	t.Parallel()
+
+	for name, payload := range map[string]string{
+		"null data":   `{"status":"success","data":null}`,
+		"empty array": `{"status":"success","data":[]}`,
+	} {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+				w.Header().Set("Content-Type", "application/json")
+				_, _ = w.Write([]byte(payload))
+			}))
+			defer srv.Close()
+
+			records, err := NewSigNozDriver(srv.Client(), srv.URL).ListAccounts(context.Background())
+			require.NoError(t, err)
+			assert.Empty(t, records)
+		})
+	}
+}
+
+func TestSigNozDriverListAccountsErrorStatus(t *testing.T) {
+	t.Parallel()
+
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+		w.WriteHeader(http.StatusForbidden)
+		_, _ = w.Write([]byte(`{"status":"error"}`))
+	}))
+	defer srv.Close()
+
+	_, err := NewSigNozDriver(srv.Client(), srv.URL).ListAccounts(context.Background())
+	require.Error(t, err)
+	assert.Contains(t, err.Error(), "unexpected status 403")
+}
+
+func TestSigNozRole(t *testing.T) {
+	t.Parallel()
+
+	for in, want := range map[string]string{
+		"ADMIN":         "Admin",
+		"signoz-admin":  "Admin",
+		"EDITOR":        "Editor",
+		"signoz-editor": "Editor",
+		"VIEWER":        "Viewer",
+		"signoz-viewer": "Viewer",
+		"":              "User",
+		"  ":            "User",
+		"custom-role":   "custom-role", // unknown role preserved verbatim
+		"superadmin":    "superadmin",  // contains "admin" but must NOT be promoted
+	} {
+		assert.Equalf(t, want, sigNozRole(in), "role %q", in)
+	}
+}
+
+func TestSigNozActiveStatus(t *testing.T) {
+	t.Parallel()
+
+	active := sigNozActiveStatus("active")
+	require.NotNil(t, active)
+	assert.True(t, *active)
+
+	for _, status := range []string{"pending_invite", "deleted"} {
+		v := sigNozActiveStatus(status)
+		require.NotNilf(t, v, "status %q", status)
+		assert.Falsef(t, *v, "status %q", status)
+	}
+
+	assert.Nil(t, sigNozActiveStatus("something_unexpected"))
+}
+
+func TestSigNozNameResolver(t *testing.T) {
+	t.Parallel()
+
+	t.Run("falls back to name when displayName is empty", func(t *testing.T) {
+		t.Parallel()
+
+		srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+			w.Header().Set("Content-Type", "application/json")
+			_, _ = w.Write([]byte(`{"status":"success","data":{"displayName":"","name":"acme"}}`))
+		}))
+		defer srv.Close()
+
+		name, err := NewSigNozNameResolver(srv.Client(), srv.URL).ResolveInstanceName(context.Background())
+		require.NoError(t, err)
+		assert.Equal(t, "acme", name)
+	})
+
+	t.Run("returns empty without error on terminal failure", func(t *testing.T) {
+		t.Parallel()
+
+		srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
+			w.WriteHeader(http.StatusForbidden)
+		}))
+		defer srv.Close()
+
+		name, err := NewSigNozNameResolver(srv.Client(), srv.URL).ResolveInstanceName(context.Background())
+		require.NoError(t, err)
+		assert.Empty(t, name)
+	})
+}