//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System;
using System.Linq;
using Microsoft.SqlTools.Utility;
using Microsoft.SqlTools.ServiceLayer.Workspace.Contracts;
using NUnit.Framework;
namespace Microsoft.SqlTools.ServiceLayer.UnitTests.ServiceHost
{
///
/// ScriptFile test case
///
public class ScriptFileTests
{
internal static object fileLock = new object();
private static readonly string query =
"SELECT * FROM sys.objects as o1" + Environment.NewLine +
"SELECT * FROM sys.objects as o2" + Environment.NewLine +
"SELECT * FROM sys.objects as o3" + Environment.NewLine;
public static ScriptFile GetTestScriptFile(string initialText = null)
{
if (initialText == null)
{
initialText = ScriptFileTests.query;
}
string ownerUri = System.IO.Path.GetTempFileName();
// Write the query text to a backing file
lock (fileLock)
{
System.IO.File.WriteAllText(ownerUri, initialText);
}
return new ScriptFile(ownerUri, ownerUri, initialText);
}
///
/// Validate GetLinesInRange with invalid range
///
[Test]
public void GetLinesInRangeWithInvalidRangeTest()
{
ScriptFile scriptFile = GetTestScriptFile();
bool exceptionRaised = false;
try
{
scriptFile.GetLinesInRange(
new BufferRange(
new BufferPosition(1, 0),
new BufferPosition(2, 0)));
}
catch (ArgumentOutOfRangeException)
{
exceptionRaised = true;
}
Assert.True(exceptionRaised, "ArgumentOutOfRangeException raised for invalid index");
}
///
/// Validate GetLinesInRange
///
[Test]
public void GetLinesInRangeTest()
{
ScriptFile scriptFile = GetTestScriptFile();
string id = scriptFile.Id;
Assert.True(!string.IsNullOrWhiteSpace(id));
BufferRange range =scriptFile.FileRange;
Assert.Null(range);
string[] lines = scriptFile.GetLinesInRange(
new BufferRange(
new BufferPosition(2, 1),
new BufferPosition(2, 7)));
Assert.True(lines.Length == 1, "One line in range");
Assert.True(lines[0].Equals("SELECT"), "Range text is correct");
string[] queryLines = query.Split('\n');
string line = scriptFile.GetLine(2);
Assert.True(queryLines[1].StartsWith(line), "GetLine text is correct");
}
[Test]
public void GetOffsetAtPositionTest()
{
ScriptFile scriptFile = GetTestScriptFile();
int offset = scriptFile.GetOffsetAtPosition(2, 5);
int expected = 35 + Environment.NewLine.Length;
Assert.True(offset == expected, "Offset is at expected location");
BufferPosition position = scriptFile.GetPositionAtOffset(offset);
Assert.True(position.Line == 2 && position.Column == 5, "Position is at expected location");
}
[Test]
public void GetRangeBetweenOffsetsTest()
{
ScriptFile scriptFile = GetTestScriptFile();
BufferRange range = scriptFile.GetRangeBetweenOffsets(
scriptFile.GetOffsetAtPosition(2, 1),
scriptFile.GetOffsetAtPosition(2, 7));
Assert.NotNull(range);
}
[Test]
public void CanApplySingleLineInsert()
{
AssertFileChange(
"This is a test.",
"This is a working test.",
new FileChange
{
Line = 1,
EndLine = 1,
Offset = 10,
EndOffset = 10,
InsertString = " working"
});
}
[Test]
public void CanApplySingleLineReplace()
{
AssertFileChange(
"This is a potentially broken test.",
"This is a working test.",
new FileChange
{
Line = 1,
EndLine = 1,
Offset = 11,
EndOffset = 29,
InsertString = "working"
});
}
[Test]
public void CanApplySingleLineDelete()
{
AssertFileChange(
"This is a test of the emergency broadcasting system.",
"This is a test.",
new FileChange
{
Line = 1,
EndLine = 1,
Offset = 15,
EndOffset = 52,
InsertString = ""
});
}
[Test]
public void CanApplyMultiLineInsert()
{
AssertFileChange(
"first\r\nsecond\r\nfifth",
"first\r\nsecond\r\nthird\r\nfourth\r\nfifth",
new FileChange
{
Line = 3,
EndLine = 3,
Offset = 1,
EndOffset = 1,
InsertString = "third\r\nfourth\r\n"
});
}
[Test]
public void CanApplyMultiLineReplace()
{
AssertFileChange(
"first\r\nsecoXX\r\nXXfth",
"first\r\nsecond\r\nthird\r\nfourth\r\nfifth",
new FileChange
{
Line = 2,
EndLine = 3,
Offset = 5,
EndOffset = 3,
InsertString = "nd\r\nthird\r\nfourth\r\nfi"
});
}
[Test]
public void CanApplyMultiLineReplaceWithRemovedLines()
{
AssertFileChange(
"first\r\nsecoXX\r\nREMOVE\r\nTHESE\r\nLINES\r\nXXfth",
"first\r\nsecond\r\nthird\r\nfourth\r\nfifth",
new FileChange
{
Line = 2,
EndLine = 6,
Offset = 5,
EndOffset = 3,
InsertString = "nd\r\nthird\r\nfourth\r\nfi"
});
}
[Test]
public void CanApplyMultiLineDelete()
{
AssertFileChange(
"first\r\nsecond\r\nREMOVE\r\nTHESE\r\nLINES\r\nthird",
"first\r\nsecond\r\nthird",
new FileChange
{
Line = 3,
EndLine = 6,
Offset = 1,
EndOffset = 1,
InsertString = ""
});
}
[Test]
public void ThrowsExceptionWithEditOutsideOfRange()
{
Assert.Throws(
typeof(ArgumentOutOfRangeException),
() =>
{
AssertFileChange(
"first\r\nsecond\r\nREMOVE\r\nTHESE\r\nLINES\r\nthird",
"first\r\nsecond\r\nthird",
new FileChange
{
Line = 3,
EndLine = 7,
Offset = 1,
EndOffset = 1,
InsertString = ""
});
});
}
private void AssertFileChange(
string initialString,
string expectedString,
FileChange fileChange)
{
// Create an in-memory file from the StringReader
ScriptFile fileToChange = GetTestScriptFile(initialString);
// Apply the FileChange and assert the resulting contents
fileToChange.ApplyChange(fileChange);
Assert.AreEqual(expectedString, fileToChange.Contents);
}
}
public class ScriptFileGetLinesTests
{
private ScriptFile scriptFile;
private const string TestString = "Line One\r\nLine Two\r\nLine Three\r\nLine Four\r\nLine Five";
private readonly string[] TestStringLines =
TestString.Split(
new string[] { "\r\n" },
StringSplitOptions.None);
public ScriptFileGetLinesTests()
{
scriptFile =
ScriptFileTests.GetTestScriptFile(
"Line One\r\nLine Two\r\nLine Three\r\nLine Four\r\nLine Five\r\n");
}
[Test]
public void CanGetWholeLine()
{
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(5, 1, 5, 10));
Assert.AreEqual(1, lines.Length);
Assert.AreEqual("Line Five", lines[0]);
}
[Test]
public void CanGetMultipleWholeLines()
{
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(2, 1, 4, 10));
Assert.AreEqual(TestStringLines.Skip(1).Take(3), lines);
}
[Test]
public void CanGetSubstringInSingleLine()
{
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(4, 3, 4, 8));
Assert.AreEqual(1, lines.Length);
Assert.AreEqual("ne Fo", lines[0]);
}
[Test]
public void CanGetEmptySubstringRange()
{
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(4, 3, 4, 3));
Assert.AreEqual(1, lines.Length);
Assert.AreEqual("", lines[0]);
}
[Test]
public void CanGetSubstringInMultipleLines()
{
string[] expectedLines = new string[]
{
"Two",
"Line Three",
"Line Fou"
};
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(2, 6, 4, 9));
Assert.AreEqual(expectedLines, lines);
}
[Test]
public void CanGetRangeAtLineBoundaries()
{
string[] expectedLines = new string[]
{
"",
"Line Three",
""
};
string[] lines =
scriptFile.GetLinesInRange(
new BufferRange(2, 9, 4, 1));
Assert.AreEqual(expectedLines, lines);
}
}
public class ScriptFilePositionTests
{
private ScriptFile scriptFile;
public ScriptFilePositionTests()
{
scriptFile =
ScriptFileTests.GetTestScriptFile(@"
First line
Second line is longer
Third line
");
}
[Test]
public void CanOffsetByLine()
{
AssertNewPosition(
1, 1,
2, 0,
3, 1);
AssertNewPosition(
3, 1,
-2, 0,
1, 1);
}
[Test]
public void CanOffsetByColumn()
{
AssertNewPosition(
2, 1,
0, 2,
2, 3);
AssertNewPosition(
2, 5,
0, -3,
2, 2);
}
[Test]
public void ThrowsWhenPositionOutOfRange()
{
// Less than line range
Assert.Throws(
typeof(ArgumentOutOfRangeException),
() =>
{
scriptFile.CalculatePosition(
new BufferPosition(1, 1),
-10, 0);
});
// Greater than line range
Assert.Throws(
typeof(ArgumentOutOfRangeException),
() =>
{
scriptFile.CalculatePosition(
new BufferPosition(1, 1),
10, 0);
});
// Less than column range
Assert.Throws(
typeof(ArgumentOutOfRangeException),
() =>
{
scriptFile.CalculatePosition(
new BufferPosition(1, 1),
0, -10);
});
// Greater than column range
Assert.Throws(
typeof(ArgumentOutOfRangeException),
() =>
{
scriptFile.CalculatePosition(
new BufferPosition(1, 1),
0, 10);
});
}
[Test]
public void CanFindBeginningOfLine()
{
AssertNewPosition(
4, 12,
pos => pos.GetLineStart(),
4, 5);
}
[Test]
public void CanFindEndOfLine()
{
AssertNewPosition(
4, 12,
pos => pos.GetLineEnd(),
4, 15);
}
[Test]
public void CanComposePositionOperations()
{
AssertNewPosition(
4, 12,
pos => pos.AddOffset(-1, 1).GetLineStart(),
3, 3);
}
private void AssertNewPosition(
int originalLine, int originalColumn,
int lineOffset, int columnOffset,
int expectedLine, int expectedColumn)
{
AssertNewPosition(
originalLine, originalColumn,
pos => pos.AddOffset(lineOffset, columnOffset),
expectedLine, expectedColumn);
}
private void AssertNewPosition(
int originalLine, int originalColumn,
Func positionOperation,
int expectedLine, int expectedColumn)
{
var newPosition =
positionOperation(
new FilePosition(
scriptFile,
originalLine,
originalColumn));
Assert.AreEqual(expectedLine, newPosition.Line);
Assert.AreEqual(expectedColumn, newPosition.Column);
}
}
}