Add position-checking unit test to NRefactory.

ICSharpCode.NRefactory.Tests/CSharp/Parser/ParseSelfTests.cs

@@ -0,0 +1,119 @@
+// Copyright (c) AlphaSierraPapa for the SharpDevelop Team
+// 
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this
+// software and associated documentation files (the "Software"), to deal in the Software
+// without restriction, including without limitation the rights to use, copy, modify, merge,
+// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
+// to whom the Software is furnished to do so, subject to the following conditions:
+// 
+// The above copyright notice and this permission notice shall be included in all copies or
+// substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+
+using System;
+using System.IO;
+using ICSharpCode.Editor;
+using ICSharpCode.NRefactory.TypeSystem.Implementation;
+using NUnit.Framework;
+
+namespace ICSharpCode.NRefactory.CSharp.Parser
+{
+	/// <summary>
+	/// Test fixture that parses NRefactory itself,
+	/// ensures that there are no parser crashes while doing so,
+	/// and that the returned positions are consistent.
+	/// </summary>
+	[TestFixture]
+	public class ParseSelfTests
+	{
+		string[] fileNames;
+		
+		[TestFixtureSetUp]
+		public void SetUp()
+		{
+			string path = Path.GetFullPath(@"..\..\..");
+			if (!File.Exists(Path.Combine(path, "NRefactory.sln")))
+				throw new InvalidOperationException("Test cannot find the NRefactory source code in " + path);
+			fileNames = Directory.GetFiles(path, "*.cs", SearchOption.AllDirectories);
+		}
+		
+		[Test]
+		public void GenerateTypeSystem()
+		{
+			SimpleProjectContent pc = new SimpleProjectContent();
+			CSharpParser parser = new CSharpParser();
+			parser.GenerateTypeSystemMode = true;
+			foreach (string fileName in fileNames) {
+				CompilationUnit cu;
+				using (var fs = new FileStream(fileName, FileMode.Open, FileAccess.Read, FileShare.Read, 4096, FileOptions.SequentialScan)) {
+					cu = parser.Parse(fs);
+				}
+				TypeSystemConvertVisitor cv = new TypeSystemConvertVisitor(pc, fileName);
+				pc.UpdateProjectContent(null, cv.Convert(cu));
+			}
+		}
+		
+		#region ParseAndCheckPositions
+		string currentFileName;
+		ReadOnlyDocument currentDocument;
+		
+		[Test]
+		public void ParseAndCheckPositions()
+		{
+			CSharpParser parser = new CSharpParser();
+			foreach (string fileName in fileNames) {
+				this.currentDocument = new ReadOnlyDocument(File.ReadAllText(fileName));
+				CompilationUnit cu = parser.Parse(currentDocument.CreateReader());
+				this.currentFileName = fileName;
+				CheckPositionConsistency(cu);
+				CheckMissingTokens(cu);
+			}
+		}
+		
+		void CheckPositionConsistency(AstNode node)
+		{
+			string comment = "(" + node.GetType().Name + " at " + node.StartLocation + " in " + currentFileName + ")";
+			Assert.IsTrue(node.StartLocation <= node.EndLocation, "StartLocation must be before EndLocation " + comment);
+			var prevNodeEnd = node.StartLocation;
+			for (AstNode child = node.FirstChild; child != null; child = child.NextSibling) {
+				Assert.IsTrue(child.StartLocation >= prevNodeEnd, "Child must start after previous sibling " + comment);
+				CheckPositionConsistency(child);
+				prevNodeEnd = child.EndLocation;
+			}
+			Assert.IsTrue(prevNodeEnd <= node.EndLocation, "Last child must end before parent node ends " + comment);
+		}
+		
+		void CheckMissingTokens(AstNode node)
+		{
+			if (node is IRelocatable) {
+				Assert.IsNull(node.FirstChild, "Token nodes should not have children");
+			} else {
+				var prevNodeEnd = node.StartLocation;
+				for (AstNode child = node.FirstChild; child != null; child = child.NextSibling) {
+					CheckWhitespace(prevNodeEnd, child.StartLocation);
+					CheckMissingTokens(child);
+					prevNodeEnd = child.EndLocation;
+				}
+				CheckWhitespace(prevNodeEnd, node.EndLocation);
+			}
+		}
+		
+		void CheckWhitespace(AstLocation whitespaceStart, AstLocation whitespaceEnd)
+		{
+			if (whitespaceStart == whitespaceEnd)
+				return;
+			int start = currentDocument.GetOffset(whitespaceStart.Line, whitespaceStart.Column);
+			int end = currentDocument.GetOffset(whitespaceEnd.Line, whitespaceEnd.Column);
+			string text = currentDocument.GetText(start, end - start);
+			Assert.IsTrue(string.IsNullOrWhiteSpace(text), "Expected whitespace between " + whitespaceStart + " and " + whitespaceEnd
+			              + ", but got '" + text + "' (in " + currentFileName + ")");
+		}
+		#endregion
+	}
+}

ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

@@ -64,6 +64,7 @@
     <Compile Include="CSharp\Parser\GeneralScope\NamespaceDeclarationTests.cs" />
     <Compile Include="CSharp\Parser\GeneralScope\TypeDeclarationTests.cs" />
     <Compile Include="CSharp\Parser\GeneralScope\UsingDeclarationTests.cs" />
+    <Compile Include="CSharp\Parser\ParseSelfTests.cs" />
     <Compile Include="CSharp\Parser\Statements\BlockStatementTests.cs" />
     <Compile Include="CSharp\Parser\Statements\CheckedStatementTests.cs" />
     <Compile Include="CSharp\Parser\Statements\EmptyStatementTests.cs" />
@@ -161,6 +162,10 @@
     <Compile Include="FormattingTests\TestBlankLineFormatting.cs" />
   </ItemGroup>
   <ItemGroup>
+    <ProjectReference Include="..\ICSharpCode.Editor\ICSharpCode.Editor.csproj">
+      <Project>{F054A788-B591-4561-A8BA-AE745BBEB817}</Project>
+      <Name>ICSharpCode.Editor</Name>
+    </ProjectReference>
     <ProjectReference Include="..\ICSharpCode.NRefactory\ICSharpCode.NRefactory.csproj">
       <Project>{3B2A5653-EC97-4001-BB9B-D90F1AF2C371}</Project>
       <Name>ICSharpCode.NRefactory</Name>