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
|
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Xml;
using mdoc.Test.SampleClasses;
using Mono.Cecil;
using Mono.Collections.Generic;
using Mono.Documentation;
using Mono.Documentation.Updater;
using Mono.Documentation.Updater.Formatters;
using Mono.Documentation.Updater.Frameworks;
using NUnit.Framework;
using Cpp = Mono_DocTest_Generic;
namespace mdoc.Test
{
[TestFixture]
public class MDocUpdaterTests : BasicTests
{
readonly MDocUpdater updater = new MDocUpdater();
readonly AttributeFormatter formatter = new AttributeFormatter();
[Test]
public void Test_GetCustomAttributes_IgnoredObsoleteAttribute()
{
TypeDefinition testType = GetType(typeof(MDocUpdaterTests).Module.FullyQualifiedName, "System.Span`1");
Collection<CustomAttribute> attributes = testType.CustomAttributes;
Assert.AreEqual(1, attributes.Count);
Assert.IsFalse(formatter.TryGetAttributeString(attributes.First(), out string rval));
}
[Test]
public void Test_GetCustomAttributes_EmitNativeIntegerAttribute()
{
var method = GetMethod(typeof(SampleClasses.NativeIntClass), "Method1");
static CustomAttribute GetNativeIntegerAttr(ParameterDefinition p) => p?.CustomAttributes.Where(attr => attr.AttributeType.FullName == Consts.NativeIntegerAttribute).FirstOrDefault();
Assert.IsNotNull(GetNativeIntegerAttr(method.Parameters[0]));
Assert.IsTrue(formatter.TryGetAttributeString(GetNativeIntegerAttr(method.Parameters[0]), out string rval));
Assert.IsNull(GetNativeIntegerAttr(method.Parameters[2]));
}
[Test]
public void Test_GetDocParameterType_CppGenericParameterType_ReturnsTypeWithGenericParameters()
{
var method = GetMethod(typeof(Cpp.GenericBase<>), "BaseMethod2");
string parameterType = MDocUpdater.GetDocParameterType(method.Parameters[0].ParameterType);
Assert.AreEqual("Mono_DocTest_Generic.GenericBase<U>", parameterType);
}
[Test]
public void Test_GetNamespace_IgnoredNamespaceGeneric()
{
TypeDefinition testType = GetType(typeof(ReadOnlySpan<>).Module.FullyQualifiedName, "mdoc.Test.SampleClasses.ReadOnlySpan`1");
var ns = DocUtils.GetNamespace(testType.GenericParameters.First());
Assert.AreEqual("", ns);
}
[Test]
public void InternalEIITest()
{
XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(XmlConsts.internalEllXml);
MemberReference oldmember = null;
var type = GetType(typeof(mdoc.Test2.InternalEIICalss));
var docEnum = new DocumentationEnumerator();
bool internalEIIflagged = false;
foreach (DocsNodeInfo info in docEnum.GetDocumentationMembers(doc, type, FrameworkTypeEntry.Empty))
{
var flag = MDocUpdater.IsMemberNotPrivateEII(info.Member);
if (!flag)
{
internalEIIflagged = true;
oldmember = info.Member;
//Note : The following operation will not be carried out, just prompt
//-> DeleteMember();
//-> statisticsCollector.AddMetric();
}
}
Assert.IsTrue(internalEIIflagged, "Internal EII was not flagged");
Assert.AreEqual("System.String mdoc.Test2.InternalEIICalss::mdoc.Test.SampleClasses.InterfaceA.Getstring(System.Int32)", oldmember.FullName);
}
[Test]
public void RemoveInvalidAssembliesInfo()
{
XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(XmlConsts.internalEllXml);
var type = GetType(typeof(mdoc.Test2.InternalEIICalss));
var docEnum = new DocumentationEnumerator();
var delList = DocUtils.RemoveInvalidAssemblyInfo(doc.DocumentElement, false, "Type");
Assert.IsTrue(delList.Count == 1);
foreach (DocsNodeInfo info in docEnum.GetDocumentationMembers(doc, type, FrameworkTypeEntry.Empty))
{
delList.AddRange(DocUtils.RemoveInvalidAssemblyInfo(info.Node, false, "Member"));
}
Assert.IsTrue(delList.Count == 2);
///Note : (The following operation will not be carried out, just prompt)
// foreach (var delitem in delList)
// delitem.ParentNode.RemoveChild(child);
}
[Test]
public void UpdateToRight_MethodInterface_Test()
{
var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Methods.FirstOrDefault(t => t.FullName == "System.String mdoc.Test2.EiiImplementClass::GetNo()");
var nodeinfo = UpdateXml("GetNo", member);
Assert.IsTrue(nodeinfo.Count() == 1);
Assert.AreEqual("M:mdoc.Test2.Interface_B.GetNo", nodeinfo[0].InnerText);
Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
}
[Test]
public void UpdateToRight_PropertyInterface_Test()
{
var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Properties.FirstOrDefault(t => t.FullName == "System.Int32 mdoc.Test2.EiiImplementClass::no()");
var nodeinfo = UpdateXml("no", member);
Assert.IsTrue(nodeinfo.Count() == 1);
Assert.AreEqual("P:mdoc.Test2.Interface_A.no", nodeinfo[0].InnerText);
Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
}
[Test]
public void UpdateToRight_EventInterface_Test()
{
var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Events.FirstOrDefault(t => t.FullName == "System.EventHandler`1<System.EventArgs> mdoc.Test2.EiiImplementClass::ItemChanged");
var nodeinfo = UpdateXml("ItemChanged", member);
Assert.IsTrue(nodeinfo.Count() == 1);
Assert.AreEqual("E:mdoc.Test2.Interface_A.ItemChanged", nodeinfo[0].InnerText);
Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
}
private List<XmlElement> UpdateXml(string XmlNodeName, MemberReference mi)
{
List<XmlElement> returnValue = new List<XmlElement>();
List<FrameworkEntry> entries = new List<FrameworkEntry>();
FrameworkEntry singleEntry = new FrameworkEntry(entries, entries);
singleEntry.Name = "dotnet-plat-ext-2.2";
FrameworkTypeEntry enttyType = new FrameworkTypeEntry(singleEntry);
var type = GetType(typeof(mdoc.Test2.EiiImplementClass));
var ieeImplementList = MDocUpdater.GetTypeEiiMembers(type);
var typeInterfaces = GetClassInterface(type);
var doc = new XmlDocument();
doc.LoadXml(XmlConsts.EiiErrorImplement);
var node = doc.SelectSingleNode($"/Type/Members/Member[@MemberName='{XmlNodeName}']");
if (node != null)
{
MDocUpdater.AddImplementedMembers(enttyType, mi, typeInterfaces, (XmlElement)node, ieeImplementList);
returnValue = node.SelectNodes("Implements/InterfaceMember").Cast<XmlElement>().ToList();
}
return returnValue;
}
[Test]
public void Update_ImportDoc_Test()
{
List<DocumentationImporter> setimporters = new List<DocumentationImporter>();
List<DocumentationImporter> importers = new List<DocumentationImporter>();
var filePath = Path.Combine(Path.GetDirectoryName(this.GetType().Module.Assembly.Location), "SampleClasses\\testImportDoc.xml");
MsxdocDocumentationImporter importer = new MsxdocDocumentationImporter(
filePath);
setimporters.Add(importer);
XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(XmlConsts.internalEllXml);
var type = GetType(typeof(mdoc.Test2.InternalEIICalss));
var docEnum = new DocumentationEnumerator();
var nodeMember = docEnum.GetDocumentationMembers(doc, type, FrameworkTypeEntry.Empty).FirstOrDefault(t => t.Member.FullName == "System.String mdoc.Test2.InternalEIICalss::Getstring(System.Int32)");
var testKeys = new string[] { "returns", "value", "related", "seealso" };
for (int i = 0; i < testKeys.Length; i++)
{
Assert.IsTrue(DocUtils.CheckRemoveByImporter(nodeMember, testKeys[i], importers, setimporters));
}
}
}
}
|
