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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
# frozen_string_literal: true
require 'spec_helper'
require 'nanoc'
require 'helpers/generic'
RSpec.describe Nanoc::Helpers::Generic do
let(:mock_class) { Class.new { extend Nanoc::Helpers::Generic } }
let(:path) { "ee/user/project/code_intelligence.html" }
let(:mock_item) do
item = Struct.new(:path)
item.new(path)
end
before do
mock_items = { '/_data/navigation.yaml' => YAML.load_file('spec/lib/fixtures/navigation-mock.yaml', symbolize_names: true) }
mock_sections = mock_items['/_data/navigation.yaml'][:sections]
allow(mock_class).to receive(:get_nav_sections).and_return(mock_sections)
end
describe '#docs_section' do
using RSpec::Parameterized::TableSyntax
subject { mock_class.docs_section(mock_item.path.to_s) }
where(:path, :expected_section_title) do
"/ee/tutorials/" | "Learn GitLab with tutorials"
"/ee/topics/set_up_organization.html" | "Use GitLab"
"/ee/user/project/autocomplete_characters.html" | "Use GitLab"
"/ee/policy/alpha-beta-support.html" | "Manage GitLab subscription"
"/updog.html" | nil
end
with_them do
it "returns the section title for the given path" do
expect(subject).to eq(expected_section_title)
end
end
end
describe '#build_breadcrumb_list' do
# Test all six levels of the menu
let(:test_data) do
[
{
path: '/ee/user/',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab"
}
]
},
{
path: '/ee/topics/set_up_organization.html',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab",
item: "https://docs.gitlab.com/ee/user/"
},
{
'@type': "ListItem",
position: 2,
name: "Set up your organization"
}
]
},
{
path: '/ee/user/namespace/',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab",
item: "https://docs.gitlab.com/ee/user/"
},
{
'@type': "ListItem",
position: 2,
name: "Set up your organization",
item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
},
{
'@type': "ListItem",
position: 3,
name: "Namespaces"
}
]
},
{
path: '/ee/user/group/manage.html',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab",
item: "https://docs.gitlab.com/ee/user/"
},
{
'@type': "ListItem",
position: 2,
name: "Set up your organization",
item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
},
{
'@type': "ListItem",
position: 3,
name: "Groups",
item: "https://docs.gitlab.com/ee/user/group/"
},
{
'@type': "ListItem",
position: 4,
name: "Manage groups"
}
]
},
{
path: '/ee/user/group/saml_sso/scim_setup.html',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab",
item: "https://docs.gitlab.com/ee/user/"
},
{
'@type': "ListItem",
position: 2,
name: "Set up your organization",
item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
},
{
'@type': "ListItem",
position: 3,
name: "Groups",
item: "https://docs.gitlab.com/ee/user/group/"
},
{
'@type': "ListItem",
position: 4,
name: "SAML SSO for GitLab.com groups",
item: "https://docs.gitlab.com/ee/user/group/saml_sso/"
},
{
'@type': "ListItem",
position: 5,
name: "Configure SCIM"
}
]
},
{
path: '/ee/topics/autodevops/cicd_variables.html',
expected_items: [
{
'@type': "ListItem",
position: 1,
name: "Use GitLab",
item: "https://docs.gitlab.com/ee/user/"
},
{
'@type': "ListItem",
position: 2,
name: "Build your application",
item: "https://docs.gitlab.com/ee/topics/build_your_application.html"
},
{
'@type': "ListItem",
position: 3,
name: "CI/CD",
item: "https://docs.gitlab.com/ee/ci/"
},
{
'@type': "ListItem",
position: 4,
name: "Auto DevOps",
item: "https://docs.gitlab.com/ee/topics/autodevops/"
},
{
'@type': "ListItem",
position: 5,
name: "Customize",
item: "https://docs.gitlab.com/ee/topics/autodevops/customize.html"
},
{
'@type': "ListItem",
position: 6,
name: "CI/CD variables"
}
]
}
]
end
it 'returns an array of menu items in schema.org breadcrumblist format' do
test_data.each do |data|
expected_items = data[:expected_items]
expected_json = {
'@context': "https://schema.org",
'@type': "BreadcrumbList",
itemListElement: expected_items
}
param_value = data[:path]
expect(mock_class.build_breadcrumb_list(param_value)).to eq(expected_json)
end
end
end
describe '#docs_breadcrumb_list' do
using RSpec::Parameterized::TableSyntax
subject { mock_class.docs_breadcrumb_list(mock_item.path.to_s) }
where(:path, :expected_breadcrumb_list) do
"/ee/tutorials/" | "Learn GitLab with tutorials"
"/ee/topics/set_up_organization.html" | "Use GitLab › Set up your organization"
"/ee/user/project/autocomplete_characters.html" | "Use GitLab › Plan and track work › Quick actions › Autocomplete characters"
"/ee/user/project/settings/import_export_troubleshooting.html" | "Use GitLab › Organize work with projects › Migrate projects using file exports › Troubleshooting"
"/updog.html" | ""
end
with_them do
it "returns the breadcrumb trail for the given path" do
expect(subject).to eq(expected_breadcrumb_list)
end
end
end
end
|
