mcs/class/monodoc/Test/Monodoc/HelpSourceTests.cs

   1 using System;
   2 using System.IO;
   3 using System.Linq;
   4 using System.Collections.Generic;
   5
   6 using NUnit.Framework;
   7
   8 using Monodoc;
   9 using Monodoc.Generators;
  10
  11 using HtmlAgilityPack;
  12
  13 namespace MonoTests.Monodoc
  14 {
  15         [TestFixture]
  16         public class HelpSourceTest
  17         {
  18                 const string BaseDir = "../../class/monodoc/Test/monodoc_test/";
  19
  20                 class CheckGenerator : IDocGenerator<bool>
  21                 {
  22                         public string LastCheckMessage { get; set; }
  23
  24                         public bool Generate (HelpSource hs, string id, Dictionary<string, string> context)
  25                         {
  26                                 LastCheckMessage = string.Format ("#1 : {0} {1}", hs, id);
  27                                 if (hs == null || string.IsNullOrEmpty (id))
  28                                         return false;
  29
  30                                 // Stripe the arguments parts since we don't need it
  31                                 var argIdx = id.LastIndexOf ('?');
  32                                 if (argIdx != -1)
  33                                         id = id.Substring (0, argIdx);
  34
  35                                 LastCheckMessage = string.Format ("#2 : {0} {1}", hs, id);
  36                                 if (hs.IsRawContent (id))
  37                                         return hs.GetText (id) != null;
  38
  39                                 IEnumerable<string> parts;
  40                                 if (hs.IsMultiPart (id, out parts)) {
  41                                         LastCheckMessage = string.Format ("#4 : {0} {1} ({2})", hs, id, string.Join (", ", parts));
  42                                         foreach (var partId in parts)
  43                                                 if (!Generate (hs, partId, context))
  44                                                         return false;
  45                                 }
  46
  47                                 LastCheckMessage = string.Format ("#3 : {0} {1}", hs, id);
  48                                 if (hs.IsGeneratedContent (id))
  49                                         return hs.GetCachedText (id) != null;
  50                                 else {
  51                                         var s = hs.GetCachedHelpStream (id);
  52                                         if (s != null) {
  53                                                 s.Close ();
  54                                                 return true;
  55                                         } else {
  56                                                 return false;
  57                                         }
  58                                 }
  59                         }
  60                 }
  61
  62                 /* This test verifies that for every node in our tree that possed a PublicUrl,
  63                  * we can correctly access it back through RenderUrl
  64                  */
  65                 [Test]
  66                 public void ReachabilityTest ()
  67                 {
  68                         var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
  69                         Node result;
  70                         var generator = new CheckGenerator ();
  71                         int errorCount = 0;
  72                         int testCount = 0;
  73
  74                         foreach (var leaf in GetLeaves (rootTree.RootNode)) {
  75                                 if (!rootTree.RenderUrl (leaf.PublicUrl, generator, out result) || leaf != result) {
  76                                         Console.WriteLine ("Error: {0} with HelpSource {1} ", leaf.PublicUrl, leaf.Tree.HelpSource.Name);
  77                                         errorCount++;
  78                                 }
  79                                 testCount++;
  80                         }
  81
  82                         //Assert.AreEqual (0, errorCount, errorCount + " / " + testCount.ToString ());
  83
  84                         // HACK: in reality we have currently 4 known issues which are due to duplicated namespaces across
  85                         // doc sources, something that was never supported and that we need to improve/fix at some stage
  86                         Assert.LessOrEqual (4, errorCount, errorCount + " / " + testCount.ToString ());
  87                 }
  88
  89                 IEnumerable<Node> GetLeaves (Node node)
  90                 {
  91                         if (node == null)
  92                                 yield break;
  93
  94                         if (node.IsLeaf)
  95                                 yield return node;
  96                         else {
  97                                 foreach (var child in node.ChildNodes) {
  98                                         if (!string.IsNullOrEmpty (child.Element) && !child.Element.StartsWith ("root:/"))
  99                                                 yield return child;
 100                                         foreach (var childLeaf in GetLeaves (child))
 101                                                 yield return childLeaf;
 102                                 }
 103                         }
 104                 }
 105
 106                 [Test]
 107                 public void ReachabilityWithShortGenericNotationTest ()
 108                 {
 109                         var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
 110                         Node result;
 111                         var generator = new CheckGenerator ();
 112
 113                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Concurrent.IProducerConsumerCollection`1", generator, out result), "#1");
 114                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary`2", generator, out result), "#2");
 115                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`4", generator, out result), "#3");
 116                         Assert.IsTrue (rootTree.RenderUrl ("T:System.EventHandler`1", generator, out result), "#4");
 117                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`5", generator, out result), "#5a");
 118                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`4", generator, out result), "#5b");
 119                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`6", generator, out result), "#5c");
 120                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`7", generator, out result), "#5d");
 121                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`3", generator, out result), "#5e");
 122                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`2", generator, out result), "#5f");
 123                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`1", generator, out result), "#5g");
 124                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`8", generator, out result), "#5h");
 125                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func`9", generator, out result), "#5i");
 126                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`3", generator, out result), "#6a");
 127                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`2", generator, out result), "#6b");
 128                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Action`4", generator, out result), "#6c");
 129                         Assert.IsTrue (rootTree.RenderUrl ("T:System.IComparable`1", generator, out result), "#7");
 130                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Lazy`1", generator, out result), "#8");
 131                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`1", generator, out result), "#9a");
 132                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`2", generator, out result), "#9b");
 133                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`3", generator, out result), "#9c");
 134                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Tuple`4", generator, out result), "#9d");
 135                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary`2+ValueCollection", generator, out result), "#10");
 136                         Assert.IsFalse (rootTree.RenderUrl ("T:System.EventHandler`2", generator, out result), "#11");
 137                         Assert.IsFalse (rootTree.RenderUrl ("T:System.Lazy`2", generator, out result), "#12");
 138                 }
 139
 140                 [Test]
 141                 public void AspNetStyleUrlReachabilityTest ()
 142                 {
 143                         var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
 144                         Node result;
 145                         var generator = new CheckGenerator ();
 146
 147                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary{TKey,TValue}", generator, out result), "#1");
 148                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Action{T1,T2}", generator, out result), "#2");
 149                         Assert.IsTrue (rootTree.RenderUrl ("T:System.EventHandler{TEventArgs}", generator, out result), "#3");
 150                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Func{T1,T2,T3,TResult}", generator, out result), "#4");
 151                         Assert.IsTrue (rootTree.RenderUrl ("T:System.Collections.Generic.Dictionary{TKey,TValue}+ValueCollection", generator, out result), "#5");
 152                         Assert.IsTrue (rootTree.RenderUrl ("T:System.IComparable{T}", generator, out result), "#6");
 153                 }
 154
 155                 [Test, Ignore ("Mono documentation is full of syntax errors so we can't use it reliably for this test")]
 156                 public void ReachabilityWithCrefsTest ()
 157                 {
 158                         var rootTree = RootTree.LoadTree (Path.GetFullPath (BaseDir), false);
 159                         Node result;
 160                         var htmlGenerator = new HtmlGenerator (null);
 161                         var crefs = new HashSet<string> ();
 162                         var generator = new CheckGenerator ();
 163                         int errorCount = 0;
 164
 165                         foreach (var leaf in GetLeaves (rootTree.RootNode)) {
 166                                 Dictionary<string, string> context;
 167                                 string internalId = leaf.Tree.HelpSource.GetInternalIdForUrl (leaf.PublicUrl, out result, out context);
 168                                 if (leaf.Tree.HelpSource.GetDocumentTypeForId (internalId) != DocumentType.EcmaXml)
 169                                         continue;
 170
 171                                 string content = null;
 172                                 if (string.IsNullOrEmpty (content = rootTree.RenderUrl (leaf.PublicUrl, htmlGenerator, out result)) || leaf != result) {
 173                                         Console.WriteLine ("Error: {0} with HelpSource {1} ", leaf.PublicUrl, leaf.Tree.HelpSource.Name);
 174                                         continue;
 175                                 }
 176
 177                                 HtmlDocument doc = new HtmlDocument();
 178                                 try {
 179                                         doc.LoadHtml (content);
 180                                 } catch {
 181                                         Console.WriteLine ("Couldn't load a HTML document for URL {0}", leaf.PublicUrl);
 182                                         continue;
 183                                 }
 184
 185                                 foreach (HtmlNode link in doc.DocumentNode.SelectNodes("//a[@href]")) {
 186                                         var newUrl = link.Attributes["href"].Value;
 187                                         var hashIndex = newUrl.IndexOf ('#');
 188                                         if (hashIndex != -1)
 189                                                 newUrl = newUrl.Substring (0, hashIndex);
 190                                         if (newUrl.Length > 1 && newUrl[1] == ':' && char.IsLetter (newUrl, 0) && char.ToLowerInvariant (newUrl[0]) != 'c')
 191                                                 crefs.Add (newUrl);
 192                                 }
 193
 194                                 foreach (var cref in crefs) {
 195                                         if (!rootTree.RenderUrl (cref, generator, out result) || result == null) {
 196                                                 Console.WriteLine ("Error with cref: `{0}'", cref);
 197                                                 errorCount++;
 198                                         }
 199                                 }
 200
 201                                 crefs.Clear ();
 202                         }
 203
 204                         Assert.AreEqual (0, errorCount, errorCount + " / " + crefs.Count);
 205                 }
 206         }
 207 }