integrations_test.go

package sentry

import (
	"encoding/json"
	"os"
	"path/filepath"
	"regexp"
	"runtime/debug"
	"testing"

	"github.com/google/go-cmp/cmp"
)

func TestTransformStringsIntoRegexps(t *testing.T) {
	got := transformStringsIntoRegexps([]string{
		"+",
		"foo",
		"*",
		"(?i)bar",
		"[]",
	})

	want := []*regexp.Regexp{
		regexp.MustCompile("foo"),
		regexp.MustCompile("(?i)bar"),
	}

	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsEmptyEvent(t *testing.T) {
	event := &Event{}
	got := getIgnoreErrorsSuspects(event)
	want := []string{}
	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsMessage(t *testing.T) {
	event := &Event{
		Message: "foo",
	}
	got := getIgnoreErrorsSuspects(event)
	want := []string{"foo"}
	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsException(t *testing.T) {
	event := &Event{
		Exception: []Exception{{
			Type:  "exType",
			Value: "exVal",
		}},
	}
	got := getIgnoreErrorsSuspects(event)
	want := []string{
		"exType",
		"exVal",
	}
	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsMultipleExceptions(t *testing.T) {
	event := &Event{
		Exception: []Exception{{
			Type:  "exType",
			Value: "exVal",
		}, {
			Type:  "exTypeTwo",
			Value: "exValTwo",
		}},
	}
	got := getIgnoreErrorsSuspects(event)
	want := []string{
		"exType",
		"exVal",
		"exTypeTwo",
		"exValTwo",
	}
	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsMessageAndException(t *testing.T) {
	event := &Event{
		Message: "foo",
		Exception: []Exception{{
			Type:  "exType",
			Value: "exVal",
		}},
	}
	got := getIgnoreErrorsSuspects(event)
	want := []string{
		"foo",
		"exType",
		"exVal",
	}
	assertEqual(t, got, want)
}

func TestGetIgnoreErrorsSuspectsMessageAndMultipleExceptions(t *testing.T) {
	event := &Event{
		Message: "foo",
		Exception: []Exception{{
			Type:  "exType",
			Value: "exVal",
		}, {
			Type:  "exTypeTwo",
			Value: "exValTwo",
		}},
	}
	got := getIgnoreErrorsSuspects(event)
	want := []string{
		"foo",
		"exType",
		"exVal",
		"exTypeTwo",
		"exValTwo",
	}
	assertEqual(t, got, want)
}

func TestIgnoreErrorsIntegration(t *testing.T) {
	iei := ignoreErrorsIntegration{
		ignoreErrors: []*regexp.Regexp{
			regexp.MustCompile("foo"),
			regexp.MustCompile("(?i)bar"),
			regexp.MustCompile("(hello)"),
		},
	}

	dropped := &Event{
		Message: "foo",
	}

	alsoDropped := &Event{
		Exception: []Exception{{
			Type: "foo",
		}},
	}

	thisDroppedAsWell := &Event{
		Exception: []Exception{{
			Value: "Bar",
		}},
	}

	notDropped := &Event{
		Message: "dont",
	}

	alsoNotDropped := &Event{
		Exception: []Exception{{
			Type:  "really",
			Value: "dont",
		}},
	}

	toDrop := &Event{
		Exception: []Exception{{
			Value: "(hello)",
		}},
	}

	if iei.processor(dropped, &EventHint{}) != nil {
		t.Error("Event should be dropped")
	}

	if iei.processor(alsoDropped, &EventHint{}) != nil {
		t.Error("Event should be dropped")
	}

	if iei.processor(thisDroppedAsWell, &EventHint{}) != nil {
		t.Error("Event should be dropped")
	}

	if iei.processor(notDropped, &EventHint{}) == nil {
		t.Error("Event should not be dropped")
	}

	if iei.processor(alsoNotDropped, &EventHint{}) == nil {
		t.Error("Event should not be dropped")
	}

	if iei.processor(toDrop, &EventHint{}) != nil {
		t.Error("Event should be dropped")
	}
}

func TestIgnoreTransactionsIntegration(t *testing.T) {
	iei := ignoreTransactionsIntegration{
		ignoreTransactions: []*regexp.Regexp{
			regexp.MustCompile("foo"),
			regexp.MustCompile("(?i)bar"),
			regexp.MustCompile("(hello)"),
		},
	}

	dropped := &Event{
		Transaction: "foo",
	}

	alsoDropped := &Event{
		Transaction: "Bar",
	}

	notDropped := &Event{
		Transaction: "dont",
	}

	thisDroppedAsWell := &Event{
		Transaction: "(hello)",
	}

	if iei.processor(dropped, &EventHint{}) != nil {
		t.Error("Transaction should be dropped")
	}

	if iei.processor(alsoDropped, &EventHint{}) != nil {
		t.Error("Transaction should be dropped")
	}

	if iei.processor(notDropped, &EventHint{}) == nil {
		t.Error("Transaction should not be dropped")
	}

	if iei.processor(thisDroppedAsWell, &EventHint{}) != nil {
		t.Error("Transaction should be dropped")
	}
}

func TestContextifyFrames(t *testing.T) {
	cfi := contextifyFramesIntegration{
		sr:           newSourceReader(),
		contextLines: 5,
	}

	filename := "errors_test.go"
	abspath, err := filepath.Abs("errors_test.go")
	if err != nil {
		t.Fatal(err)
	}

	frames := cfi.contextify([]Frame{{
		Function: "Trace",
		Module:   "github.com/getsentry/sentry-go",
		Filename: filename,
		AbsPath:  abspath,
		Lineno:   12,
		InApp:    true,
	}})
	if len(frames) != 1 {
		t.Fatalf("got %d frames, want 1", len(frames))
	}
	frame := frames[0]

	assertEqual(t, frame.PreContext, []string{
		")",
		"",
		"// NOTE: if you modify this file, you are also responsible for updating LoC position in Stacktrace tests",
		"",
		"func Trace() *Stacktrace {",
	})
	assertEqual(t, frame.ContextLine, "\treturn NewStacktrace()")
	assertEqual(t, frame.PostContext, []string{
		"}",
		"",
		"func RedPkgErrorsRanger() error {",
		"\treturn BluePkgErrorsRanger()",
		"}",
	})
}

func TestContextifyFramesNonexistingFilesShouldNotDropFrames(t *testing.T) {
	cfi := contextifyFramesIntegration{
		sr:           newSourceReader(),
		contextLines: 5,
	}

	frames := []Frame{{
		InApp:    true,
		Function: "fnName",
		Module:   "same",
		Filename: "wat.go",
		AbsPath:  "this/doesnt/exist/wat.go",
		Lineno:   1,
		Colno:    2,
	}, {
		InApp:    false,
		Function: "fnNameFoo",
		Module:   "sameFoo",
		Filename: "foo.go",
		AbsPath:  "this/doesnt/exist/foo.go",
		Lineno:   3,
		Colno:    5,
	}}

	contextifiedFrames := cfi.contextify(frames)
	assertEqual(t, len(contextifiedFrames), len(frames))
}

func TestExtractModules(t *testing.T) {
	tests := []struct {
		name string
		info *debug.BuildInfo
		want map[string]string
	}{
		{
			name: "no require modules",
			info: &debug.BuildInfo{
				Main: debug.Module{
					Path:    "my/module",
					Version: "(devel)",
				},
				Deps: []*debug.Module{},
			},
			want: map[string]string{
				"my/module": "(devel)",
			},
		},
		{
			name: "have require modules",
			info: &debug.BuildInfo{
				Main: debug.Module{
					Path:    "my/module",
					Version: "(devel)",
				},
				Deps: []*debug.Module{
					{
						Path:    "github.com/getsentry/sentry-go",
						Version: "v0.5.1",
					},
					{
						Path:    "github.com/gin-gonic/gin",
						Version: "v1.4.0",
					},
				},
			},
			want: map[string]string{
				"my/module":                      "(devel)",
				"github.com/getsentry/sentry-go": "v0.5.1",
				"github.com/gin-gonic/gin":       "v1.4.0",
			},
		},
		{
			name: "replace module with local module",
			info: &debug.BuildInfo{
				Main: debug.Module{
					Path:    "my/module",
					Version: "(devel)",
				},
				Deps: []*debug.Module{
					{
						Path:    "github.com/getsentry/sentry-go",
						Version: "v0.5.1",
						Replace: &debug.Module{
							Path: "pkg/sentry",
						},
					},
				},
			},
			want: map[string]string{
				"my/module":                      "(devel)",
				"github.com/getsentry/sentry-go": "v0.5.1 => pkg/sentry",
			},
		},
		{
			name: "replace module with another remote module",
			info: &debug.BuildInfo{
				Main: debug.Module{
					Path:    "my/module",
					Version: "(devel)",
				},
				Deps: []*debug.Module{
					{
						Path:    "github.com/ugorji/go",
						Version: "v1.1.4",
						Replace: &debug.Module{
							Path:    "github.com/ugorji/go/codec",
							Version: "v0.0.0-20190204201341-e444a5086c43",
						},
					},
				},
			},
			want: map[string]string{
				"my/module":            "(devel)",
				"github.com/ugorji/go": "v1.1.4 => github.com/ugorji/go/codec v0.0.0-20190204201341-e444a5086c43",
			},
		},
	}

	for _, tt := range tests {
		tt := tt
		t.Run(tt.name, func(t *testing.T) {
			got := extractModules(tt.info)
			if diff := cmp.Diff(tt.want, got); diff != "" {
				t.Errorf("modules info mismatch (-want +got):\n%s", diff)
			}
		})
	}
}

func TestEnvironmentIntegrationDoesNotOverrideExistingContexts(t *testing.T) {
	transport := &TransportMock{}
	client, err := NewClient(ClientOptions{
		Transport: transport,
		Integrations: func([]Integration) []Integration {
			return []Integration{new(environmentIntegration)}
		},
	})
	if err != nil {
		t.Fatal(err)
	}
	scope := NewScope()

	scope.contexts["device"] = Context{
		"foo": "bar",
	}
	scope.contexts["os"] = Context{
		"name": "test",
	}
	scope.contexts["custom"] = Context{"key": "value"}
	hub := NewHub(client, scope)
	hub.CaptureMessage("test event")

	events := transport.Events()
	if len(events) != 1 {
		b, err := json.MarshalIndent(events, "", "  ")
		if err != nil {
			t.Fatal(err)
		}
		t.Fatalf("events = %s\ngot %d events, want 1", b, len(events))
	}

	contexts := events[0].Contexts

	if contexts["device"]["foo"] != "bar" {
		t.Errorf(`contexts["device"] = %#v, want contexts["device"]["foo"] == "bar"`, contexts["device"])
	}
	if contexts["os"]["name"] != "test" {
		t.Errorf(`contexts["os"] = %#v, want contexts["os"]["name"] == "test"`, contexts["os"])
	}
	if contexts["custom"]["key"] != "value" {
		t.Errorf(`contexts["custom"]["key"] = %#v, want "value"`, contexts["custom"]["key"])
	}
}

func TestGlobalTagsIntegration(t *testing.T) {
	os.Setenv("SENTRY_TAGS_foo", "foo_value_env")
	os.Setenv("SENTRY_TAGS_bar", "bar_value_env")
	os.Setenv("SENTRY_TAGS_baz", "baz_value_env")
	defer os.Unsetenv("SENTRY_TAGS_foo")
	defer os.Unsetenv("SENTRY_TAGS_bar")
	defer os.Unsetenv("SENTRY_TAGS_baz")

	transport := &TransportMock{}
	client, err := NewClient(ClientOptions{
		Transport: transport,
		Tags: map[string]string{
			"foo": "foo_value_client_options",
			"baz": "baz_value_client_options",
		},
		Integrations: func([]Integration) []Integration {
			return []Integration{new(globalTagsIntegration)}
		},
	})
	if err != nil {
		t.Fatal(err)
	}

	scope := NewScope()
	scope.SetTags(map[string]string{"foo": "foo_value_scope"})

	event := NewEvent()
	event.Message = "event message"
	client.CaptureEvent(event, nil, scope)

	assertEqual(t,
		transport.lastEvent.Tags["foo"],
		"foo_value_scope",
		"scope tag should override any global tag",
	)
	assertEqual(t,
		transport.lastEvent.Tags["bar"],
		"bar_value_env",
		"env tag present if not overridden by scope or client options tags",
	)
	assertEqual(t,
		transport.lastEvent.Tags["baz"],
		"baz_value_client_options",
		"client options tag present if not overridden by scope and overrides env tag",
	)
}