f99010fae1
CI / lint (push) Failing after 1s
CI / frontend (push) Failing after 1s
CI / scripts (push) Failing after 1s
CI / Go Test (ubuntu-latest) (push) Failing after 0s
CI / frontend-node-25 (push) Failing after 1s
CI / docs (push) Failing after 0s
CI / coverage (push) Failing after 0s
CI / e2e (push) Failing after 0s
Docker / build-and-push (push) Failing after 1s
CI / integration (push) Failing after 4m43s
CI / Go Test (windows-latest) (push) Has been cancelled
CI / Desktop Unit Tests (Windows) (push) Has been cancelled
Desktop Artifacts / Desktop Build (Linux (arm64)) (push) Has been cancelled
Desktop Artifacts / Desktop Build (Linux) (push) Has been cancelled
Desktop Artifacts / Desktop Build (Windows) (push) Has been cancelled
Desktop Artifacts (macOS) / Desktop Build (macOS (aarch64)) (push) Has been cancelled
Desktop Artifacts (macOS) / Desktop Build (macOS (x86_64)) (push) Has been cancelled
152 lines
4.2 KiB
Go
152 lines
4.2 KiB
Go
package telemetry
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
kittelemetry "go.kenn.io/kit/telemetry"
|
|
)
|
|
|
|
func TestEnabledFromEnvHonorsAgentsViewAndGenericOptOut(t *testing.T) {
|
|
t.Setenv(EnabledEnv, "0")
|
|
assert.False(t, EnabledFromEnv())
|
|
|
|
t.Setenv(EnabledEnv, "1")
|
|
if kittelemetry.PostHogTelemetryDisabled() {
|
|
assert.False(t, EnabledFromEnv())
|
|
return
|
|
}
|
|
assert.True(t, EnabledFromEnv())
|
|
|
|
t.Setenv(GenericEnabledEnv, "0")
|
|
assert.False(t, EnabledFromEnv())
|
|
}
|
|
|
|
func TestNewReporterDisabledByEnvDoesNotCreateInstallID(t *testing.T) {
|
|
t.Setenv(EnabledEnv, "0")
|
|
dir := t.TempDir()
|
|
|
|
reporter, err := NewReporter(Options{DataDir: dir})
|
|
require.NoError(t, err)
|
|
|
|
assert.False(t, reporter.Enabled())
|
|
_, err = os.Stat(filepath.Join(dir, installIDFilename))
|
|
assert.ErrorIs(t, err, os.ErrNotExist)
|
|
}
|
|
|
|
func TestGenericTelemetryEnvDisablesReporter(t *testing.T) {
|
|
t.Setenv(GenericEnabledEnv, "0")
|
|
dir := t.TempDir()
|
|
|
|
reporter, err := NewReporter(Options{DataDir: dir})
|
|
require.NoError(t, err)
|
|
|
|
assert.False(t, reporter.Enabled())
|
|
_, err = os.Stat(filepath.Join(dir, installIDFilename))
|
|
assert.ErrorIs(t, err, os.ErrNotExist)
|
|
}
|
|
|
|
func TestNewReporterDisabledDuringTestsDespiteEnabledEnv(t *testing.T) {
|
|
t.Setenv(EnabledEnv, "1")
|
|
t.Setenv(GenericEnabledEnv, "1")
|
|
dir := t.TempDir()
|
|
|
|
reporter, err := NewReporter(Options{DataDir: dir})
|
|
require.NoError(t, err)
|
|
|
|
assert.False(t, reporter.Enabled())
|
|
_, err = os.Stat(filepath.Join(dir, installIDFilename))
|
|
assert.ErrorIs(t, err, os.ErrNotExist)
|
|
}
|
|
|
|
func TestLoadOrCreateInstallIDIsStableAndAnonymous(t *testing.T) {
|
|
dir := t.TempDir()
|
|
|
|
first, err := loadOrCreateInstallID(dir)
|
|
require.NoError(t, err)
|
|
second, err := loadOrCreateInstallID(dir)
|
|
require.NoError(t, err)
|
|
|
|
assert.Len(t, first, 32)
|
|
assert.Equal(t, first, second)
|
|
|
|
stored, err := os.ReadFile(filepath.Join(dir, installIDFilename))
|
|
require.NoError(t, err)
|
|
assert.Equal(t, first+"\n", string(stored))
|
|
}
|
|
|
|
func TestAllowedEventOptionsConfigureDaemonActiveShape(t *testing.T) {
|
|
t.Setenv(EnabledEnv, "1")
|
|
t.Setenv(GenericEnabledEnv, "1")
|
|
|
|
client, err := newKitReporter(
|
|
"anonymous-install-id", "v1.2.3", "abc123",
|
|
)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { require.NoError(t, client.Close()) })
|
|
|
|
reporter := &Reporter{client: client}
|
|
|
|
assert.True(t, reporter.EventAllowed(EventDaemonActive))
|
|
assert.False(t, reporter.EventAllowed("daemon_started"))
|
|
|
|
props, err := reporter.SanitizeProperties(EventDaemonActive, map[string]any{
|
|
"$process_person_profile": true,
|
|
"$geoip_disable": false,
|
|
"application": "other",
|
|
"version": "caller-version",
|
|
"commit": "caller-commit",
|
|
"goos": "caller-os",
|
|
"goarch": "caller-arch",
|
|
"source": "caller-source",
|
|
"app": "legacy-app",
|
|
"project": "private-project",
|
|
"session": "private-session",
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
assert.False(t, props["$process_person_profile"].(bool))
|
|
assert.True(t, props["$geoip_disable"].(bool))
|
|
assert.Equal(t, "agentsview", props["application"])
|
|
assert.Equal(t, "v1.2.3", props["version"])
|
|
assert.Equal(t, "abc123", props["commit"])
|
|
assert.Equal(t, runtime.GOOS, props["goos"])
|
|
assert.Equal(t, runtime.GOARCH, props["goarch"])
|
|
assert.Equal(t, "daemon", props["source"])
|
|
assert.NotContains(t, props, "app")
|
|
assert.NotContains(t, props, "project")
|
|
assert.NotContains(t, props, "session")
|
|
}
|
|
|
|
func TestReporterCaptureDaemonActiveNoopsDuringTests(t *testing.T) {
|
|
t.Setenv(EnabledEnv, "1")
|
|
t.Setenv(GenericEnabledEnv, "1")
|
|
|
|
client, err := newKitReporter(
|
|
"anonymous-install-id", "v1.2.3", "abc123",
|
|
)
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { require.NoError(t, client.Close()) })
|
|
|
|
reporter := &Reporter{client: client}
|
|
assert.True(t, reporter.Enabled())
|
|
|
|
err = reporter.CaptureDaemonActive(context.Background())
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func TestReporterCaptureDaemonActiveTestBlockerWinsOverCanceledContext(t *testing.T) {
|
|
client := kittelemetry.DisabledPostHogReporter()
|
|
reporter := &Reporter{client: client}
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel()
|
|
|
|
err := reporter.CaptureDaemonActive(ctx)
|
|
require.NoError(t, err)
|
|
}
|