public void GetHelpInfo_WhenHelpAdjacencyIsNull_Throws()
{
var reader = new NamingConventionXmlDocumentationFileHelpReader("Data\\Executables-Empty.xml");
Assert.Throws <ArgumentNullException>(() =>
reader.GetHelpInfo(null));
}
public void GetHelpInfo_WhenFileContainsNoData_ReturnsEmptyList()
{
var reader = new NamingConventionXmlDocumentationFileHelpReader("Data\\Executables-Empty.xml");
var results = reader.GetHelpInfo(HelpAdjacencyCriteria.Empty());
results.Should().HaveCount(0);
}
public void GetHelpInfo_WhenFileMissing_Throws()
{
var reader = new NamingConventionXmlDocumentationFileHelpReader("DoesNotExist.xml");
Assert.Throws <ExecutableHelpFileNotFoundExeption>(() =>
reader.GetHelpInfo(HelpAdjacencyCriteria.Empty()));
}
public void GetHelpInfo_WhenFileContainsDataForCommand_ReturnsHelpInfo()
{
var reader = new NamingConventionXmlDocumentationFileHelpReader("Data\\Executables.xml");
var results = reader.GetHelpInfo(new HelpAdjacencyCriteria("foo", "create"))
.ToArray();
results.Should().HaveCount(1);
var result1 = results.First(h => h.Name == "create");
result1.Name.Should().Be("create");
result1.Subject.Should().Be("foo");
result1.Description.Should().Be("Create new Foo");
result1.Type.Should().Be(HelpInfoType.Executable);
result1.Children.Should().HaveCount(2);
var result1Param1 = result1.Children.First(p => p.Name == "id");
result1Param1.Name.Should().Be("id");
result1Param1.Subject.Should().Be("foo create");
result1Param1.Description.Should().Be("Id parameter");
result1Param1.Type.Should().Be(HelpInfoType.Parameter);
result1Param1.Children.Should().HaveCount(0);
var result1Param2 = result1.Children.First(p => p.Name == "bar");
result1Param2.Name.Should().Be("bar");
result1Param2.Subject.Should().Be("foo create");
result1Param2.Description.Should().Be("Bar parameter");
result1Param2.Type.Should().Be(HelpInfoType.Parameter);
result1Param2.Children.Should().HaveCount(0);
}
public void GetHelpInfo_WhenFileIsNotCorrectlyFormatted_Throws()
{
var reader = new NamingConventionXmlDocumentationFileHelpReader("Data\\Executables-IncorrectlyFormatted.txt");
Assert.Throws <ExecutableHelpFileInvalidExeption>(() =>
reader.GetHelpInfo(HelpAdjacencyCriteria.Empty()));
}