public void LoadConfiguration_file_reads_configuration_file_if_path_is_specified(MarkdownPreset preset)
{
// ARRANGE
using var temporaryDirectory = new TemporaryDirectory();
var configPath = Path.Combine(temporaryDirectory, "config.json");
File.WriteAllText(configPath, $@"{{
""mddocs"" : {{
""apireference"" : {{
""template"" : {{
""default"" : {{
""markdownPreset"" : ""{preset}""
}}
}}
}}
}}
}}");
var sut = new GenerateApiReferenceDocumentation()
{
Assembly = new TaskItem("myAssembly.dll"),
BuildEngine = new BuildEngineMock(),
OutputDirectory = new TaskItem("my-output-directory"),
ConfigurationFile = new TaskItem(configPath),
};
// ACT
var config = sut.GetConfigurationProvider().GetApiReferenceConfiguration();
// ASSERT
Assert.Equal(preset, config.Template.Default.MarkdownPreset);
}
public void OutputDirectoryPath_returns_empty_string_if_OutputDirectory_is_null()
{
// ARRANGE
var sut = new GenerateApiReferenceDocumentation()
{
Assembly = new TaskItem("my-assembly.dll"),
BuildEngine = new BuildEngineMock(),
OutputDirectory = null
};
// ACT
var outputDirectoryPath = sut.OutputDirectoryPath;
// ASSERT
Assert.NotNull(outputDirectoryPath);
Assert.Equal("", outputDirectoryPath);
}
public void AssemblyPaths_returns_full_paths()
{
// ARRANGE
var sut = new GenerateApiReferenceDocumentation()
{
Assembly = new TaskItem("my-assembly.dll"),
BuildEngine = new BuildEngineMock()
};
var expectedPath = Path.GetFullPath("my-assembly.dll");
// ACT / ASSERT
var actualPath = Assert.Single(sut.AssemblyPaths);
Assert.True(Path.IsPathRooted(actualPath));
Assert.Equal(expectedPath, actualPath);
}
public void OutputDirectoryPath_overrides_output_path_setting()
{
// ARRANGE
var sut = new GenerateApiReferenceDocumentation()
{
Assembly = new TaskItem("my-assembly.dll"),
BuildEngine = new BuildEngineMock(),
OutputDirectory = new TaskItem("some-output-directory")
};
var expectedOutputPath = Path.GetFullPath("some-output-directory");
// ACT
var config = sut.GetConfigurationProvider().GetApiReferenceConfiguration();
// ASSERT
Assert.Equal(expectedOutputPath, config.OutputPath);
}
public void AssemblyPath_overrides_assembly_paths_setting()
{
// ARRANGE
var sut = new GenerateApiReferenceDocumentation()
{
Assembly = new TaskItem("my-assembly.dll"),
BuildEngine = new BuildEngineMock()
};
var expectedPath = Path.GetFullPath("my-assembly.dll");
// ACT
var config = sut.GetConfigurationProvider().GetApiReferenceConfiguration();
// ASSERT
var actualPath = Assert.Single(config.AssemblyPaths);
Assert.Equal(expectedPath, actualPath);
}
