4 using System.Collections.Generic;
9 using Monodoc.Generators;
11 // Used by ReachabilityWithCrefsTest
12 // using HtmlAgilityPack;
14 namespace MonoTests.Monodoc
17 public class HelpSourceTest
19 const string BaseDir = "../../class/monodoc/Test/monodoc_test/";
21 class CheckGenerator : IDocGenerator<bool>
23 public string LastCheckMessage { get; set; }
25 public bool Generate (HelpSource hs, string id, Dictionary<string, string> context)
27 LastCheckMessage = string.Format ("#1 : {0} {1}", hs, id);
28 if (hs == null || string.IsNullOrEmpty (id))
31 // Stripe the arguments parts since we don't need it
32 var argIdx = id.LastIndexOf ('?');
34 id = id.Substring (0, argIdx);
36 LastCheckMessage = string.Format ("#2 : {0} {1}", hs, id);
37 if (hs.IsRawContent (id))
38 return hs.GetText (id) != null;
40 IEnumerable<string> parts;
41 if (hs.IsMultiPart (id, out parts)) {
42 LastCheckMessage = string.Format ("#4 : {0} {1} ({2})", hs, id, string.Join (", ", parts));
43 foreach (var partId in parts)
44 if (!Generate (hs, partId, context))
48 LastCheckMessage = string.Format ("#3 : {0} {1}", hs, id);
49 if (hs.IsGeneratedContent (id))
50 return hs.GetCachedText (id) != null;
52 var s = hs.GetCachedHelpStream (id);
63 /* This test verifies that for every node in our tree that possed a PublicUrl,
64 * we can correctly access it back through RenderUrl
67 public void ReachabilityTest ()
69 var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
71 var generator = new CheckGenerator ();
75 foreach (var leaf in GetLeaves (rootTree.RootNode)) {
76 if (!rootTree.RenderUrl (leaf.PublicUrl, generator, out result) || leaf != result) {
77 Console.WriteLine ("Error: {0} with HelpSource {1} ", leaf.PublicUrl, leaf.Tree.HelpSource.Name);
83 //Assert.AreEqual (0, errorCount, errorCount + " / " + testCount.ToString ());
85 // HACK: in reality we have currently 4 known issues which are due to duplicated namespaces across
86 // doc sources, something that was never supported and that we need to improve/fix at some stage
87 Assert.LessOrEqual (4, errorCount, errorCount + " / " + testCount.ToString ());
90 IEnumerable<Node> GetLeaves (Node node)
98 foreach (var child in node.ChildNodes) {
99 if (!string.IsNullOrEmpty (child.Element) && !child.Element.StartsWith ("root:/"))
101 foreach (var childLeaf in GetLeaves (child))
102 yield return childLeaf;
108 public void ReachabilityWithShortGenericNotationTest ()
110 var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
112 var generator = new CheckGenerator ();
114 Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Concurrent.IProducerConsumerCollection`1", generator, out result), "#1");
115 Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary`2", generator, out result), "#2");
116 Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`4", generator, out result), "#3");
117 Assert.IsTrue (rootTree.RenderUrl ("T:System.EventHandler`1", generator, out result), "#4");
118 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`5", generator, out result), "#5a");
119 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`4", generator, out result), "#5b");
120 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`6", generator, out result), "#5c");
121 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`7", generator, out result), "#5d");
122 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`3", generator, out result), "#5e");
123 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`2", generator, out result), "#5f");
124 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`1", generator, out result), "#5g");
125 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`8", generator, out result), "#5h");
126 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`9", generator, out result), "#5i");
127 Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`3", generator, out result), "#6a");
128 Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`2", generator, out result), "#6b");
129 Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`4", generator, out result), "#6c");
130 Assert.IsTrue (rootTree.RenderUrl ("T:System.IComparable`1", generator, out result), "#7");
131 Assert.IsTrue (rootTree.RenderUrl ("T:System.Lazy`1", generator, out result), "#8");
132 Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`1", generator, out result), "#9a");
133 Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`2", generator, out result), "#9b");
134 Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`3", generator, out result), "#9c");
135 Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`4", generator, out result), "#9d");
136 Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary`2+ValueCollection", generator, out result), "#10");
137 Assert.IsFalse (rootTree.RenderUrl ("T:System.EventHandler`2", generator, out result), "#11");
138 Assert.IsFalse (rootTree.RenderUrl ("T:System.Lazy`2", generator, out result), "#12");
142 public void AspNetStyleUrlReachabilityTest ()
144 var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
146 var generator = new CheckGenerator ();
148 Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary{TKey,TValue}", generator, out result), "#1");
149 Assert.IsTrue (rootTree.RenderUrl ("T:System.Action{T1,T2}", generator, out result), "#2");
150 Assert.IsTrue (rootTree.RenderUrl ("T:System.EventHandler{TEventArgs}", generator, out result), "#3");
151 Assert.IsTrue (rootTree.RenderUrl ("T:System.Func{T1,T2,T3,TResult}", generator, out result), "#4");
152 Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary{TKey,TValue}+ValueCollection", generator, out result), "#5");
153 Assert.IsTrue (rootTree.RenderUrl ("T:System.IComparable{T}", generator, out result), "#6");
157 [Test, Ignore ("Mono documentation is full of syntax errors so we can't use it reliably for this test")]
158 public void ReachabilityWithCrefsTest ()
160 var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
162 var htmlGenerator = new HtmlGenerator (null);
163 var crefs = new HashSet<string> ();
164 var generator = new CheckGenerator ();
167 foreach (var leaf in GetLeaves (rootTree.RootNode)) {
168 Dictionary<string, string> context;
169 string internalId = leaf.Tree.HelpSource.GetInternalIdForUrl (leaf.PublicUrl, out result, out context);
170 if (leaf.Tree.HelpSource.GetDocumentTypeForId (internalId) != DocumentType.EcmaXml)
173 string content = null;
174 if (string.IsNullOrEmpty (content = rootTree.RenderUrl (leaf.PublicUrl, htmlGenerator, out result)) || leaf != result) {
175 Console.WriteLine ("Error: {0} with HelpSource {1} ", leaf.PublicUrl, leaf.Tree.HelpSource.Name);
179 HtmlDocument doc = new HtmlDocument();
181 doc.LoadHtml (content);
183 Console.WriteLine ("Couldn't load a HTML document for URL {0}", leaf.PublicUrl);
187 foreach (HtmlNode link in doc.DocumentNode.SelectNodes("//a[@href]")) {
188 var newUrl = link.Attributes["href"].Value;
189 var hashIndex = newUrl.IndexOf ('#');
191 newUrl = newUrl.Substring (0, hashIndex);
192 if (newUrl.Length > 1 && newUrl[1] == ':' && char.IsLetter (newUrl, 0) && char.ToLowerInvariant (newUrl[0]) != 'c')
196 foreach (var cref in crefs) {
197 if (!rootTree.RenderUrl (cref, generator, out result) || result == null) {
198 Console.WriteLine ("Error with cref: `{0}'", cref);
206 Assert.AreEqual (0, errorCount, errorCount + " / " + crefs.Count);