-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathSitemapControllerTest.cs
232 lines (187 loc) · 11.8 KB
/
SitemapControllerTest.cs
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
232
/*==============================================================================================================================
| Author Ignia, LLC
| Client Ignia, LLC
| Project Topics Library
\=============================================================================================================================*/
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Controllers;
using Microsoft.AspNetCore.Routing;
using OnTopic.AspNetCore.Mvc.Controllers;
using OnTopic.AspNetCore.Mvc.Tests.TestDoubles;
using OnTopic.Data.Caching;
using OnTopic.Repositories;
namespace OnTopic.Tests {
/*============================================================================================================================
| CLASS: SITEMAP CONTROLLER TEST
\---------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Provides unit tests for the <see cref="SitemapController"/>.
/// </summary>
[ExcludeFromCodeCoverage]
public class SitemapControllerTest: IClassFixture<TestTopicRepository> {
/*==========================================================================================================================
| PRIVATE VARIABLES
\-------------------------------------------------------------------------------------------------------------------------*/
readonly ITopicRepository _topicRepository;
readonly ControllerContext _context;
/*==========================================================================================================================
| CONSTRUCTOR
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Initializes a new instance of the <see cref="SitemapControllerTest"/> with shared resources.
/// </summary>
/// <remarks>
/// This uses the <see cref="StubTopicRepository"/> to provide data, and then <see cref="CachedTopicRepository"/> to
/// manage the in-memory representation of the data. While this introduces some overhead to the tests, the latter is a
/// relatively lightweight façade to any <see cref="ITopicRepository"/>, and prevents the need to duplicate logic for
/// crawling the object graph. In addition, it initializes a shared <see cref="Topic"/> reference to use for the various
/// tests.
/// </remarks>
public SitemapControllerTest(TestTopicRepository topicRepository) {
/*------------------------------------------------------------------------------------------------------------------------
| Establish dependencies
\-----------------------------------------------------------------------------------------------------------------------*/
_topicRepository = new CachedTopicRepository(topicRepository);
/*------------------------------------------------------------------------------------------------------------------------
| Establish view model context
\-----------------------------------------------------------------------------------------------------------------------*/
var routes = new RouteData();
routes.Values.Add("rootTopic", "Web");
routes.Values.Add("path", "Web/Valid/Child/");
var actionContext = new ActionContext {
HttpContext = new DefaultHttpContext(),
RouteData = routes,
ActionDescriptor = new ControllerActionDescriptor()
};
_context = new(actionContext);
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: INDEX: RETURNS SITEMAP XML
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action.
/// </summary>
[Fact]
public void SitemapController_Index_ReturnsSitemapXml() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Index() as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.StartsWith("<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>", model, StringComparison.Ordinal);
Assert.Contains("/Web/Valid/Child/</loc>", model!, StringComparison.Ordinal);
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES CONTENT TYPES
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
/// properly excludes <c>List</c> content types, and skips over <c>Container</c> and <c>PageGroup</c>.
/// </summary>
[Fact]
public void SitemapController_Index_ExcludesContentTypes() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Extended(true) as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.False(model!.Contains("NestedTopics/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("NestedTopic/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("Redirect/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("NoIndex/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("Disabled/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("PageGroup/</loc>", StringComparison.Ordinal));
Assert.True(model!.Contains("PageGroupChild/</loc>", StringComparison.Ordinal));
Assert.True(model!.Contains("NoIndexChild/</loc>", StringComparison.Ordinal));
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES CONTAINER DESCENDANTS
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
/// properly excludes the children of <c>Container</c> topics that are marked as <c>NoIndex</c>.
/// </summary>
[Fact]
public void SitemapController_Index_ExcludesContainerDescendants() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Extended(true) as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.False(model!.Contains("NoIndexContainer/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("NoIndexContainerChild/</loc>", StringComparison.Ordinal));
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: INDEX: EXCLUDES PRIVATE BRANCHES
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the index action of the <see cref="SitemapController.Index(Boolean, Boolean)" /> action and verifies that it
/// properly excludes the topics that are marked as <c>IsPrivateBranch</c>, including their descendants.
/// </summary>
[Fact]
public void SitemapController_Index_ExcludesPrivateBranches() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Extended(true) as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.False(model!.Contains("PrivateBranch/</loc>", StringComparison.Ordinal));
Assert.False(model!.Contains("PrivateBranchChild/</loc>", StringComparison.Ordinal));
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: EXTENDED: INCLUDES ATTRIBUTES
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the extended action of the <see cref="SitemapController.Extended(Boolean)" /> action and ensures that the
/// results include the expected attributes.
/// </summary>
[Fact]
public void SitemapController_Extended_IncludesAttributes() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Extended(true) as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.Contains("<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>", model, StringComparison.Ordinal);
Assert.Contains("/Web/Valid/Child/</loc>", model, StringComparison.Ordinal);
Assert.Contains("<Attribute name=\"Attribute\">Value</Attribute>", model, StringComparison.Ordinal);
Assert.Contains("<Attribute name=\"Title\">Title</Attribute>", model, StringComparison.Ordinal);
Assert.Contains("<DataObject type=\"Relationships\">", model, StringComparison.Ordinal);
Assert.Contains("<Attribute name=\"TopicKey\">Web:Redirect</Attribute>", model, StringComparison.Ordinal);
Assert.Contains("<DataObject type=\"References\">", model, StringComparison.Ordinal);
Assert.Contains("<Attribute name=\"Reference\">Web:Redirect</Attribute>", model, StringComparison.Ordinal);
}
/*==========================================================================================================================
| TEST: SITEMAP CONTROLLER: EXTENDED: EXCLUDES ATTRIBUTES
\-------------------------------------------------------------------------------------------------------------------------*/
/// <summary>
/// Triggers the index action of the <see cref="SitemapController.Extended(Boolean)" /> action and verifies that it
/// properly excludes e.g. the <c>Body</c> and <c>IsHidden</c> attributes.
/// </summary>
[Fact]
public void SitemapController_Index_ExcludesAttributes() {
var controller = new SitemapController(_topicRepository) {
ControllerContext = new(_context)
};
var result = controller.Extended(true) as ContentResult;
var model = result?.Content as string;
controller.Dispose();
Assert.NotNull(model);
Assert.False(model!.Contains("<Attribute name=\"Body\">", StringComparison.Ordinal));
Assert.False(model!.Contains("<Attribute name=\"IsHidden\">", StringComparison.Ordinal));
Assert.False(model!.Contains("<Attribute name=\"SortOrder\">", StringComparison.Ordinal));
Assert.False(model!.Contains("<Attribute name=\"ContentType\">List</Attribute>", StringComparison.Ordinal));
}
} //Class
} //Namespace