about summary refs log tree commit diff
path: root/main/civisibility/utils/codeowners_test.go
blob: 95852bec4aea08cb40134905e41d0e1a5b4d4fa8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024 Datadog, Inc.

package utils

import (
	"os"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestNewCodeOwners(t *testing.T) {
	// Create a temporary file for testing
	fileContent := `[Section 1]
/path/to/file @owner1 @owner2
/path/to/* @owner3

[Section 2]
/another/path @owner4
`

	tmpFile, err := os.CreateTemp("", "CODEOWNERS")
	assert.NoError(t, err)
	defer os.Remove(tmpFile.Name())

	_, err = tmpFile.WriteString(fileContent)
	assert.NoError(t, err)

	err = tmpFile.Close()
	assert.NoError(t, err)

	// Test NewCodeOwners
	codeOwners, err := NewCodeOwners(tmpFile.Name())
	assert.NoError(t, err)
	assert.NotNil(t, codeOwners)
	assert.Equal(t, 2, len(codeOwners.Sections))
	assert.Equal(t, 2, len(codeOwners.GetSection("Section 1").Entries))
	assert.Equal(t, 1, len(codeOwners.GetSection("Section 2").Entries))

	// Test empty file path
	_, err = NewCodeOwners("")
	assert.Error(t, err)
}

func TestFindSectionIgnoreCase(t *testing.T) {
	sections := []string{"Section1", "section2", "SECTION3"}
	assert.Equal(t, "Section1", findSectionIgnoreCase(sections, "section1"))
	assert.Equal(t, "section2", findSectionIgnoreCase(sections, "SECTION2"))
	assert.Equal(t, "SECTION3", findSectionIgnoreCase(sections, "Section3"))
	assert.Equal(t, "", findSectionIgnoreCase(sections, "Section4"))
}

func TestMatch(t *testing.T) {
	entries := []Entry{
		{Pattern: "/path/to/file", Owners: []string{"@owner1", "@owner2"}, Section: "Section 1"},
		{Pattern: "/path/to/*", Owners: []string{"@owner3"}, Section: "Section 1"},
		{Pattern: "/another/path", Owners: []string{"@owner4"}, Section: "Section 2"},
	}
	sections := []*Section{
		{Name: "Section 1", Entries: []Entry{entries[0], entries[1]}},
		{Name: "Section 2", Entries: []Entry{entries[2]}},
	}

	codeOwners := &CodeOwners{Sections: sections}

	// Test exact match
	entry, ok := codeOwners.Match("/path/to/file")
	assert.True(t, ok)
	assert.Equal(t, entries[0], *entry)

	// Test wildcard match
	entry, ok = codeOwners.Match("/path/to/anything")
	assert.True(t, ok)
	assert.Equal(t, entries[1], *entry)

	// Test no match
	entry, ok = codeOwners.Match("/no/match")
	assert.False(t, ok)
}

func TestGetOwnersString(t *testing.T) {
	entry := Entry{Owners: []string{"@owner1", "@owner2"}}
	assert.Equal(t, "[\"@owner1\",\"@owner2\"]", entry.GetOwnersString())

	entry = Entry{}
	assert.Equal(t, "", entry.GetOwnersString())
}

func TestGithubCodeOwners(t *testing.T) {
	cOwners, err := NewCodeOwners("testdata/fixtures/codeowners/CODEOWNERS_GITHUB")
	if err != nil {
		t.Fatal(err)
	}
	if cOwners == nil {
		t.Fatal("nil codeowners")
	}

	data := []struct {
		value    string
		expected string
	}{
		{value: "unexistent/path/test.cs", expected: "[\"@global-owner1\",\"@global-owner2\"]"},
		{value: "apps/test.cs", expected: "[\"@octocat\"]"},
		{value: "/example/apps/test.cs", expected: "[\"@octocat\"]"},
		{value: "/docs/test.cs", expected: "[\"@doctocat\"]"},
		{value: "/examples/docs/test.cs", expected: "[\"docs@example.com\"]"},
		{value: "/src/vendor/match.go", expected: "[\"docs@example.com\"]"},
		{value: "/examples/docs/inside/test.cs", expected: "[\"@global-owner1\",\"@global-owner2\"]"},
		{value: "/component/path/test.js", expected: "[\"@js-owner\"]"},
		{value: "/mytextbox.txt", expected: "[\"@octo-org/octocats\"]"},
		{value: "/scripts/artifacts/value.js", expected: "[\"@doctocat\",\"@octocat\"]"},
		{value: "/apps/octo/test.cs", expected: "[\"@octocat\"]"},
		{value: "/apps/github", expected: ""},
	}

	for _, item := range data {
		t.Run(strings.ReplaceAll(item.value, "/", "_"), func(t *testing.T) {
			match, ok := cOwners.Match(item.value)
			assert.True(t, ok)
			assert.EqualValues(t, item.expected, match.GetOwnersString())
		})
	}
}

func TestGitlabCodeOwners(t *testing.T) {
	cOwners, err := NewCodeOwners("testdata/fixtures/codeowners/CODEOWNERS_GITLAB")
	if err != nil {
		t.Fatal(err)
	}
	if cOwners == nil {
		t.Fatal("nil codeowners")
	}

	data := []struct {
		value    string
		expected string
	}{
		{value: "apps/README.md", expected: "[\"@docs\",\"@database\",\"@multiple\",\"@code\",\"@owners\"]"},
		{value: "model/db", expected: "[\"@database\",\"@multiple\",\"@code\",\"@owners\"]"},
		{value: "/config/data.conf", expected: "[\"@config-owner\"]"},
		{value: "/docs/root.md", expected: "[\"@root-docs\"]"},
		{value: "/docs/sub/root.md", expected: "[\"@all-docs\"]"},
		{value: "/src/README", expected: "[\"@group\",\"@group/with-nested/subgroup\"]"},
		{value: "/src/lib/internal.h", expected: "[\"@lib-owner\"]"},
		{value: "src/ee/docs", expected: "[\"@docs\",\"@multiple\",\"@code\",\"@owners\"]"},
	}

	for _, item := range data {
		t.Run(strings.ReplaceAll(item.value, "/", "_"), func(t *testing.T) {
			match, ok := cOwners.Match(item.value)
			assert.True(t, ok)
			assert.EqualValues(t, item.expected, match.GetOwnersString())
		})
	}
}