summaryrefslogtreecommitdiffstats
path: root/hugolib/page_paths_test.go
blob: 80dc390ccc1d6e4643223f3eebbe1e430d8b9e73 (plain)
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// Copyright 2017 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package hugolib

import (
	"path/filepath"
	"strings"
	"testing"

	"github.com/gohugoio/hugo/media"

	"fmt"

	"github.com/gohugoio/hugo/output"
)

func TestPageTargetPath(t *testing.T) {

	pathSpec := newTestDefaultPathSpec()

	noExtNoDelimMediaType := media.TextType
	noExtNoDelimMediaType.Suffix = ""
	noExtNoDelimMediaType.Delimiter = ""

	// Netlify style _redirects
	noExtDelimFormat := output.Format{
		Name:      "NER",
		MediaType: noExtNoDelimMediaType,
		BaseName:  "_redirects",
	}

	for _, langPrefix := range []string{"", "no"} {
		for _, uglyURLs := range []bool{false, true} {
			t.Run(fmt.Sprintf("langPrefix=%q,uglyURLs=%t", langPrefix, uglyURLs),
				func(t *testing.T) {

					tests := []struct {
						name     string
						d        targetPathDescriptor
						expected string
					}{
						{"JSON home", targetPathDescriptor{Kind: KindHome, Type: output.JSONFormat}, "/index.json"},
						{"AMP home", targetPathDescriptor{Kind: KindHome, Type: output.AMPFormat}, "/amp/index.html"},
						{"HTML home", targetPathDescriptor{Kind: KindHome, BaseName: "_index", Type: output.HTMLFormat}, "/index.html"},
						{"Netlify redirects", targetPathDescriptor{Kind: KindHome, BaseName: "_index", Type: noExtDelimFormat}, "/_redirects"},
						{"HTML section list", targetPathDescriptor{
							Kind:     KindSection,
							Sections: []string{"sect1"},
							BaseName: "_index",
							Type:     output.HTMLFormat}, "/sect1/index.html"},
						{"HTML taxonomy list", targetPathDescriptor{
							Kind:     KindTaxonomy,
							Sections: []string{"tags", "hugo"},
							BaseName: "_index",
							Type:     output.HTMLFormat}, "/tags/hugo/index.html"},
						{"HTML taxonomy term", targetPathDescriptor{
							Kind:     KindTaxonomy,
							Sections: []string{"tags"},
							BaseName: "_index",
							Type:     output.HTMLFormat}, "/tags/index.html"},
						{
							"HTML page", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/a/b",
								BaseName: "mypage",
								Sections: []string{"a"},
								Type:     output.HTMLFormat}, "/a/b/mypage/index.html"},

						{
							// Issue #3396
							"HTML page with index as base", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/a/b",
								BaseName: "index",
								Sections: []string{"a"},
								Type:     output.HTMLFormat}, "/a/b/index.html"},

						{
							"HTML page with special chars", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/a/b",
								BaseName: "My Page!",
								Type:     output.HTMLFormat}, "/a/b/My-Page/index.html"},
						{"RSS home", targetPathDescriptor{Kind: kindRSS, Type: output.RSSFormat}, "/index.xml"},
						{"RSS section list", targetPathDescriptor{
							Kind:     kindRSS,
							Sections: []string{"sect1"},
							Type:     output.RSSFormat}, "/sect1/index.xml"},
						{
							"AMP page", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/a/b/c",
								BaseName: "myamp",
								Type:     output.AMPFormat}, "/amp/a/b/c/myamp/index.html"},
						{
							"AMP page with URL with suffix", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/sect/",
								BaseName: "mypage",
								URL:      "/some/other/url.xhtml",
								Type:     output.HTMLFormat}, "/some/other/url.xhtml"},
						{
							"JSON page with URL without suffix", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/sect/",
								BaseName: "mypage",
								URL:      "/some/other/path/",
								Type:     output.JSONFormat}, "/some/other/path/index.json"},
						{
							"JSON page with URL without suffix and no trailing slash", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/sect/",
								BaseName: "mypage",
								URL:      "/some/other/path",
								Type:     output.JSONFormat}, "/some/other/path/index.json"},
						{
							"HTML page with expanded permalink", targetPathDescriptor{
								Kind:              KindPage,
								Dir:               "/a/b",
								BaseName:          "mypage",
								ExpandedPermalink: "/2017/10/my-title",
								Type:              output.HTMLFormat}, "/2017/10/my-title/index.html"},
						{
							"Paginated HTML home", targetPathDescriptor{
								Kind:     KindHome,
								BaseName: "_index",
								Type:     output.HTMLFormat,
								Addends:  "page/3"}, "/page/3/index.html"},
						{
							"Paginated Taxonomy list", targetPathDescriptor{
								Kind:     KindTaxonomy,
								BaseName: "_index",
								Sections: []string{"tags", "hugo"},
								Type:     output.HTMLFormat,
								Addends:  "page/3"}, "/tags/hugo/page/3/index.html"},
						{
							"Regular page with addend", targetPathDescriptor{
								Kind:     KindPage,
								Dir:      "/a/b",
								BaseName: "mypage",
								Addends:  "c/d/e",
								Type:     output.HTMLFormat}, "/a/b/mypage/c/d/e/index.html"},
					}

					for i, test := range tests {
						test.d.PathSpec = pathSpec
						test.d.UglyURLs = uglyURLs
						test.d.LangPrefix = langPrefix
						test.d.Dir = filepath.FromSlash(test.d.Dir)
						isUgly := uglyURLs && !test.d.Type.NoUgly

						expected := test.expected

						// TODO(bep) simplify
						if test.d.Kind == KindPage && test.d.BaseName == test.d.Type.BaseName {

						} else if test.d.Kind == KindHome && test.d.Type.Path != "" {
						} else if (!strings.HasPrefix(expected, "/index") || test.d.Addends != "") && test.d.URL == "" && isUgly {
							expected = strings.Replace(expected,
								"/"+test.d.Type.BaseName+"."+test.d.Type.MediaType.Suffix,
								"."+test.d.Type.MediaType.Suffix, -1)
						}

						if test.d.LangPrefix != "" && !(test.d.Kind == KindPage && test.d.URL != "") {
							expected = "/" + test.d.LangPrefix + expected
						}

						expected = filepath.FromSlash(expected)

						pagePath := createTargetPath(test.d)

						if pagePath != expected {
							t.Fatalf("[%d] [%s] targetPath expected %q, got: %q", i, test.name, expected, pagePath)
						}
					}
				})
		}
	}
}