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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
using System;
using System.Collections.Generic;
using System.Xml.Linq;
using Mono.Documentation;
using Mono.Documentation.Framework;
using Mono.Documentation.Util;
using NUnit.Framework;
namespace mdoc.Test
{
[TestFixture]
public class MDocFileSourceTests : BasicTests
{
#region DropExcludedFrameworks
[Test]
public void DropExcludedFrameworks_NoNodesWithFrameworkAlternate_NoChangesInXml()
{
XDocument document = ReadXDocument(XmlConsts.NormalSingleXml2);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
mdocFileSource.DropExcludedFrameworks(document);
Assert.AreEqual(NormalizeXml(XmlConsts.NormalSingleXml2), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworks_FrameworkAlternateWithManyFrameworks_FrameworkOneLeft()
{
XDocument document = ReadXDocument(XmlConsts.MultiFrameworkXml2);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
mdocFileSource.DropExcludedFrameworks(document);
Assert.AreEqual(NormalizeXml(MultiFrameworkXml2FrameworkOne), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworks_FrameworkAlternateWithOneFramework_FrameworkOneLeft()
{
XDocument document = ReadXDocument(XmlConsts.MultiFrameworkXml2Second);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
mdocFileSource.DropExcludedFrameworks(document);
Assert.AreEqual(NormalizeXml(MultiFrameworkXml2SecondFrameworkTwo), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworks_NoFrameworkModeFrameworkAlternateWithManyFrameworks_NoChangesInXml()
{
XDocument document = ReadXDocument(XmlConsts.MultiFrameworkXml2);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, null);
mdocFileSource.DropExcludedFrameworks(document);
Assert.AreEqual(NormalizeXml(XmlConsts.MultiFrameworkXml2), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworks_NoFrameworkModeFrameworkAlternateWithOneFramework_NoChangesInXml()
{
XDocument document = ReadXDocument(XmlConsts.MultiFrameworkXml2Second);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, null);
mdocFileSource.DropExcludedFrameworks(document);
Assert.AreEqual(NormalizeXml(XmlConsts.MultiFrameworkXml2Second), NormalizeXml(document.ToString()));
}
#endregion
#region DropExcludedFrameworksFromIndex
[Test]
public void DropExcludedFrameworksFromIndex_Type1InFrameworkType2IsNot_Type2IsExcluded()
{
XDocument document = ReadXDocument(IndexFileXml);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml);
mdocFileSource.DropExcludedFrameworksFromIndex(document, frameworkIndex, (ns, type) =>
{
switch (type)
{
case "Type1":
return ReadXDocument(Type1Xml);
case "Type2":
return ReadXDocument(Type2Xml);
}
throw new Exception("Error in test data.");
});
Assert.AreEqual(NormalizeXml(IndexFileFilteredByFrameworkXml), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworksFromIndex_Type1AndType2InFramework_NoExcludedTypes()
{
XDocument document = ReadXDocument(IndexFileXml);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml2);
mdocFileSource.DropExcludedFrameworksFromIndex(document, frameworkIndex, (ns, type) =>
{
switch (type)
{
case "Type1":
return ReadXDocument(Type1Xml);
case "Type2":
return ReadXDocument(Type2Xml);
}
throw new Exception("Error in test data.");
});
Assert.AreEqual(NormalizeXml(IndexFileXml), NormalizeXml(document.ToString()));
}
[Test]
public void DropExcludedFrameworksFromIndex_NoFrameworkModeType1InFrameworkType2IsNot_NoChangesInXml()
{
XDocument document = ReadXDocument(IndexFileXml);
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, null);
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml);
mdocFileSource.DropExcludedFrameworksFromIndex(document, frameworkIndex, (ns, type) =>
{
switch (type)
{
case "Type1":
return ReadXDocument(Type1Xml);
case "Type2":
return ReadXDocument(Type2Xml);
}
throw new Exception("Error in test data.");
});
Assert.AreEqual(NormalizeXml(IndexFileXml), NormalizeXml(document.ToString()));
}
#endregion
#region IsTypeInFramework
[Test]
public void IsTypeInFramework_TypeIsInFramework_ReturnsTrue()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml);
XDocument typeDoc = ReadXDocument(Type1Xml);
string nsName = "Namespace1";
bool isTypeInFramework = mdocFileSource.IsTypeInFramework(typeDoc, nsName, frameworkIndex);
Assert.IsTrue(isTypeInFramework);
}
[Test]
public void IsTypeInFramework_NoNamespaceInFramework_ReturnsFalse()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml);
XDocument typeDoc = ReadXDocument(Type1Xml);
string nsName = "Namespace3";
bool isTypeInFramework = mdocFileSource.IsTypeInFramework(typeDoc, nsName, frameworkIndex);
Assert.IsFalse(isTypeInFramework);
}
[Test]
public void IsTypeInFramework_TypeIsNotInFramework_ReturnsFalse()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
Dictionary<string, FrameworkNamespaceModel> frameworkIndex = GetFrameworkIndex(XmlConsts.FrameworkIndexXml);
XDocument typeDoc = ReadXDocument(Type3Xml);
string nsName = "Namespace1";
bool isTypeInFramework = mdocFileSource.IsTypeInFramework(typeDoc, nsName, frameworkIndex);
Assert.IsFalse(isTypeInFramework);
}
#endregion
#region IsExcludedFramework
[Test]
public void IsExcludedFramework_NoFrameworkAlternate_ReturnsFalse()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
var member = XElement.Parse(@"<Member></Member>");
var isExcludedFramework = mdocFileSource.IsExcludedFramework(member);
Assert.IsFalse(isExcludedFramework);
}
[Test]
public void IsExcludedFramework_FrameworkAlternateIncludesFrameworkName_ReturnsFalse()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
var member = XElement.Parse(@"<Member FrameworkAlternate=""One""></Member>");
var isExcludedFramework = mdocFileSource.IsExcludedFramework(member);
Assert.IsFalse(isExcludedFramework);
}
[Test]
public void IsExcludedFramework_FrameworkAlternateIncludesFrameworkNameInManyValues_ReturnsFalse()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
var member = XElement.Parse(@"<Member FrameworkAlternate=""One;Two""></Member>");
var isExcludedFramework = mdocFileSource.IsExcludedFramework(member);
Assert.IsFalse(isExcludedFramework);
}
[Test]
public void IsExcludedFramework_FrameworkAlternateDoesntIncludeFrameworkName_ReturnsTrue()
{
var mdocFileSource = new MDocFileSource(null, ApiStyle.Classic, "One");
var member = XElement.Parse(@"<Member FrameworkAlternate=""Two""></Member>");
var isExcludedFramework = mdocFileSource.IsExcludedFramework(member);
Assert.IsTrue(isExcludedFramework);
}
#endregion
#region Helper
private Dictionary<string, FrameworkNamespaceModel> GetFrameworkIndex(string frameworkIndexXml)
{
return FrameworkIndexHelper.ReadFrameworkIndex(ReadXDocument(frameworkIndexXml).CreateReader());
}
#endregion
#region Consts
private const string MultiFrameworkXml2FrameworkOne = @"<Member MemberName=""Meth"">
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name = ""a"" Type=""System.Int32"" Index=""0"" FrameworkAlternate=""One;Two"" />
<Parameter Name = ""b"" Type=""System.String"" Index=""1"" FrameworkAlternate=""One;Two"" />
<Parameter Name = ""c"" Type=""System.Int32"" Index=""2"" FrameworkAlternate=""One;Two"" />
</Parameters>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>";
private const string MultiFrameworkXml2SecondFrameworkTwo = @"<Member MemberName=""Meth"">
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name = ""a"" Type=""System.Int32"" Index=""0"" FrameworkAlternate=""One"" />
<Parameter Name = ""b"" Type=""System.String"" Index=""1"" FrameworkAlternate=""One"" />
<Parameter Name = ""c"" Type=""System.Int32"" Index=""2"" FrameworkAlternate=""One"" />
</Parameters>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>";
private const string IndexFileXml = @"<Overview>
<Assemblies>
<Assembly Name=""Assembly.14.0"" Version=""14.0.0.0""></Assembly>
</Assemblies>
<Remarks>To be added.</Remarks>
<Copyright>To be added.</Copyright>
<Types>
<Namespace Name=""Namespace1"">
<Type Name=""Type1"" Kind=""Class"" />
</Namespace>
<Namespace Name=""Namespace2"">
<Type Name=""Type2"" Kind=""Interface"" />
</Namespace>
</Types>
<Title>Untitled</Title>
</Overview>";
private const string IndexFileFilteredByFrameworkXml = @"<Overview>
<Assemblies>
<Assembly Name=""Assembly.14.0"" Version=""14.0.0.0""></Assembly>
</Assemblies>
<Remarks>To be added.</Remarks>
<Copyright>To be added.</Copyright>
<Types>
<Namespace Name=""Namespace1"">
<Type Name=""Type1"" Kind=""Class"" />
</Namespace>
</Types>
<Title>Untitled</Title>
</Overview>";
private const string Type1Xml = @"<Type Name="""" FullName="""">
<TypeSignature Language=""DocId"" Value=""T:Type1"" />
</Type>
";
private const string Type2Xml = @"<Type Name="""" FullName="""">
<TypeSignature Language=""DocId"" Value=""T:Type2"" />
</Type>
";
private const string Type3Xml = @"<Type Name="""" FullName="""">
<TypeSignature Language=""DocId"" Value=""T:Type3"" />
</Type>
";
#endregion
}
}
|
