aboutsummaryrefslogtreecommitdiffstats
path: root/pkg/index/filters_test.go
blob: bedf5e904674e5a3494159548e82aec4bd5a1129 (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
160
161
162
163
164
165
166
package index_test

import (
	"bytes"
	"io"
	"os"
	"testing"

	"github.com/jpappel/atlas/pkg/index"
)

func noYamlHeader() io.ReadSeeker {
	buf := []byte("just some text")
	return bytes.NewReader(buf)
}

func incompleteYamlHeader() io.ReadSeeker {
	buf := []byte("---\nfoo:bar\ntitle:bizbaz\nauthor:\n-JP Appel\n---")
	return bytes.NewReader(buf)
}

func completeYamlHeader() io.ReadSeeker {
	buf := []byte("---\nfoo:bar\ntitle:bizbaz\nauthor:\n-JP Appel\n---\n")
	return bytes.NewReader(buf)
}

func trailingYamlHeader() io.ReadSeeker {
	buf := []byte("---\nfoo:bar\ntitle:bizbaz\nauthor:\n-JP Appel\n---\nhere are some content\nanother line of text")
	return bytes.NewReader(buf)
}

func extensionless(t *testing.T) index.InfoPath {
	root := t.TempDir()
	path := root + "/" + "afile"
	f, err := os.Create(path)
	if err != nil {
		t.Fatal(err)
	}
	defer f.Close()

	if _, err := f.WriteString("this is a file"); err != nil {
		t.Fatal(err)
	}

	info, err := f.Stat()
	if err != nil {
		t.Fatal(err)
	}

	return index.InfoPath{path, info}
}

func markdownExtension(t *testing.T) index.InfoPath {
	root := t.TempDir()
	path := root + "/" + "a.md"
	f, err := os.Create(path)
	if err != nil {
		t.Fatal(err)
	}
	defer f.Close()

	info, err := f.Stat()
	if err != nil {
		t.Fatal(err)
	}

	return index.InfoPath{path, info}
}

func parentDirectory(t *testing.T) index.InfoPath {
	root := t.TempDir()
	dir := root + "/parent"
	path := dir + "/a"

	return index.InfoPath{Path: path}
}

func grandparentDirectory(t *testing.T) index.InfoPath {
	root := t.TempDir()
	dir := root + "/grandparent/parent"
	path := dir + "/a"

	return index.InfoPath{Path: path}
}

func TestYamlHeaderFilter(t *testing.T) {
	tests := []struct {
		name string
		r    io.ReadSeeker
		want bool
	}{
		{"completeYamlHeader", completeYamlHeader(), true},
		{"trailingYamlHeader", trailingYamlHeader(), true},
		{"noYamlHeader", noYamlHeader(), false},
		{"incompleteYamlHeader", incompleteYamlHeader(), false},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got := index.YamlHeaderPos(tt.r) > 0
			if got != tt.want {
				t.Errorf("YamlHeaderFilter() = %v, want %v", got, tt.want)
			}
		})
	}
}

func TestExtensionFilter(t *testing.T) {
	tests := []struct {
		name    string
		infoGen func(*testing.T) index.InfoPath
		ext     string
		want    bool
	}{
		{"no extension, accept .md", extensionless, ".md", false},
		{"no extension, accept all", extensionless, "", true},
		{"markdown, accept .md", markdownExtension, ".md", true},
		{"makdown, accept .png", markdownExtension, ".png", false},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			docFilter := index.NewExtensionFilter(tt.ext)
			ip := tt.infoGen(t)
			got := docFilter.Filter(ip, nil)

			if got != tt.want {
				t.Errorf("ExtensionFilter() = %v, want %v", got, tt.want)
			}
		})
	}
}

func TestExcludeParentFilter(t *testing.T) {
	tests := []struct {
		name    string
		infoGen func(*testing.T) index.InfoPath
		parent  string
		want    bool
	}{
		{
			"no matching parent",
			parentDirectory,
			"foobar", true,
		},
		{
			"direct parent",
			parentDirectory,
			"parent", false,
		},
		{
			"nested parent",
			grandparentDirectory,
			"grandparent", false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			docFilter := index.NewExcludeParentFilter(tt.parent)
			ip := tt.infoGen(t)
			got := docFilter.Filter(ip, nil)

			if got != tt.want {
				t.Errorf("ExcludeParentFilter() = %v, want %v", got, tt.want)
			}
		})
	}
}