all repos — searchix @ main

Search engine for NixOS, nix-darwin, home-manager and NUR users

internal/nixdocs/envvar/envvar_test.go (view raw)

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
package envvar

import (
	"bytes"
	"testing"

	"github.com/yuin/goldmark"
)

func TestEnvExtension(t *testing.T) {
	markdown := goldmark.New(
		goldmark.WithExtensions(
			New(),
		),
	)

	tests := []struct {
		name     string
		input    string
		expected string
	}{
		{
			name:     "basic env variable reference",
			input:    "{env}`XDG_DATA_DIRS`",
			expected: "<p><span class=\"envvar\">XDG_DATA_DIRS</span></p>\n",
		},
		{
			name:     "env variable reference in sentence",
			input:    "The environment variable {env}`PATH` contains a list of directories.",
			expected: "<p>The environment variable <span class=\"envvar\">PATH</span> contains a list of directories.</p>\n",
		},
		{
			name:  "multiple env variable references",
			input: "Both {env}`HOME` and {env}`XDG_CONFIG_HOME` define user directories.",
			expected: "<p>Both <span class=\"envvar\">HOME</span> and <span class=\"envvar\">" +
				"XDG_CONFIG_HOME</span> define user directories.</p>\n",
		},
		{
			name:     "incomplete env variable reference - no closing backtick",
			input:    "{env}`MISSING_BACKTICK",
			expected: "<p>{env}`MISSING_BACKTICK</p>\n",
		},
		{
			name:     "incomplete env variable reference - empty variable name",
			input:    "{env}``",
			expected: "<p>{env}``</p>\n",
		},
		{
			name:  "env variable reference with code block",
			input: "Set {env}`GOPATH` in your `~/.bashrc` file.",
			expected: "<p>Set <span class=\"envvar\">GOPATH</span> " +
				"in your <code>~/.bashrc</code> file.</p>\n",
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			var buf bytes.Buffer
			if err := markdown.Convert([]byte(test.input), &buf); err != nil {
				t.Fatalf("Failed to convert markdown: %v", err)
			}

			if got := buf.String(); got != test.expected {
				t.Errorf("Expected:\n%q\nGot:\n%q", test.expected, got)
			}
		})
	}
}

func TestEnvNodeKind(t *testing.T) {
	n := &Node{}
	if kind := n.Kind(); kind != KindEnv {
		t.Errorf("Expected node kind %v, got %v", KindEnv, kind)
	}
	if !n.Inline() {
		t.Error("Expected node to be inline")
	}
}