Skip to content
This repository was archived by the owner on Apr 20, 2023. It is now read-only.

Fix list tool command tests to be localizable. #8807

Merged
peterhuene merged 1 commit into from
Mar 16, 2018
Merged

Fix list tool command tests to be localizable. #8807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/dotnet/PrintableTable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Microsoft.DotNet.Cli
// Represents a table (with rows of type T) that can be printed to a terminal.
internal class PrintableTable<T>
{
private const string ColumnDelimiter = " ";
public const string ColumnDelimiter = " ";
private List<Column> _columns = new List<Column>();

private class Column
Expand Down
8 changes: 4 additions & 4 deletions src/dotnet/commands/dotnet-list/dotnet-list-tool/ListToolCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace Microsoft.DotNet.Tools.List.Tool
{
internal class ListToolCommand : CommandBase
{
private const string CommandDelimiter = ", ";
public const string CommandDelimiter = ", ";
private readonly AppliedOption _options;
private readonly IToolPackageStore _toolPackageStore;
private readonly IReporter _reporter;
Expand Down Expand Up @@ -66,20 +66,20 @@ private IEnumerable<IToolPackage> GetPackages()
.ToArray();
}

private bool PackageHasCommands(IToolPackage p)
private bool PackageHasCommands(IToolPackage package)
{
try
{
// Attempt to read the commands collection
// If it fails, print a warning and treat as no commands
return p.Commands.Count >= 0;
return package.Commands.Count >= 0;
}
catch (Exception ex) when (ex is ToolConfigurationException)
{
_errorReporter.WriteLine(
string.Format(
LocalizableStrings.InvalidPackageWarning,
p.Id,
package.Id,
ex.Message).Yellow());
return false;
}
Expand Down
116 changes: 65 additions & 51 deletions test/dotnet.Tests/CommandTests/ListToolCommandTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,7 @@ public void GivenNoInstalledPackagesItPrintsEmptyTable()

command.Execute().Should().Be(0);

_reporter.Lines.Should().Equal(
string.Format(
"{0} {1} {2}",
LocalizableStrings.PackageIdColumn,
LocalizableStrings.VersionColumn,
LocalizableStrings.CommandsColumn
),
"-------------------------------------");
_reporter.Lines.Should().Equal(EnumerateExpectedTableLines(store.Object));
}

[Fact]
Expand All @@ -92,15 +85,7 @@ public void GivenASingleInstalledPackageItPrintsThePackage()

command.Execute().Should().Be(0);

_reporter.Lines.Should().Equal(
string.Format(
"{0} {1} {2}",
LocalizableStrings.PackageIdColumn,
LocalizableStrings.VersionColumn,
LocalizableStrings.CommandsColumn
),
"-------------------------------------------",
"test.tool 1.3.5-preview foo ");
_reporter.Lines.Should().Equal(EnumerateExpectedTableLines(store.Object));
}

[Fact]
Expand Down Expand Up @@ -137,17 +122,7 @@ public void GivenMultipleInstalledPackagesItPrintsThePackages()

command.Execute().Should().Be(0);

_reporter.Lines.Should().Equal(
string.Format(
"{0} {1} {2} ",
LocalizableStrings.PackageIdColumn,
LocalizableStrings.VersionColumn,
LocalizableStrings.CommandsColumn
),
"----------------------------------------------",
"another.tool 2.7.3 bar ",
"some.tool 1.0.0 fancy-foo",
"test.tool 1.3.5-preview foo ");
_reporter.Lines.Should().Equal(EnumerateExpectedTableLines(store.Object));
}

[Fact]
Expand All @@ -172,15 +147,7 @@ public void GivenAPackageWithMultipleCommandsItListsThem()

command.Execute().Should().Be(0);

_reporter.Lines.Should().Equal(
string.Format(
"{0} {1} {2} ",
LocalizableStrings.PackageIdColumn,
LocalizableStrings.VersionColumn,
LocalizableStrings.CommandsColumn
),
"------------------------------------------------",
"test.tool 1.3.5-preview foo, bar, baz");
_reporter.Lines.Should().Equal(EnumerateExpectedTableLines(store.Object));
}

[Fact]
Expand Down Expand Up @@ -212,20 +179,11 @@ public void GivenABrokenPackageItPrintsWarning()
command.Execute().Should().Be(0);

_reporter.Lines.Should().Equal(
string.Format(
LocalizableStrings.InvalidPackageWarning,
"another.tool",
"broken"
).Yellow(),
string.Format(
"{0} {1} {2} ",
LocalizableStrings.PackageIdColumn,
LocalizableStrings.VersionColumn,
LocalizableStrings.CommandsColumn
),
"--------------------------------------------",
"some.tool 1.0.0 fancy-foo",
"test.tool 1.3.5-preview foo ");
EnumerateExpectedTableLines(store.Object).Prepend(
string.Format(
LocalizableStrings.InvalidPackageWarning,
"another.tool",
"broken").Yellow()));
}

private IToolPackage CreateMockToolPackage(string id, string version, IReadOnlyList<CommandSettings> commands)
Expand Down Expand Up @@ -257,5 +215,61 @@ private ListToolCommand CreateCommand(IToolPackageStore store, string options =
store,
_reporter);
}

private IEnumerable<string> EnumerateExpectedTableLines(IToolPackageStore store)
{
string GetCommandsString(IToolPackage package)
{
return string.Join(ListToolCommand.CommandDelimiter, package.Commands.Select(c => c.Name));
}

var packages = store.EnumeratePackages().Where(PackageHasCommands).OrderBy(package => package.Id);
var columnDelimiter = PrintableTable<IToolPackageStore>.ColumnDelimiter;

int packageIdColumnWidth = LocalizableStrings.PackageIdColumn.Length;
int versionColumnWidth = LocalizableStrings.VersionColumn.Length;
int commandsColumnWidth = LocalizableStrings.CommandsColumn.Length;
foreach (var package in packages)
{
packageIdColumnWidth = Math.Max(packageIdColumnWidth, package.Id.ToString().Length);
versionColumnWidth = Math.Max(versionColumnWidth, package.Version.ToNormalizedString().Length);
commandsColumnWidth = Math.Max(commandsColumnWidth, GetCommandsString(package).Length);
}

yield return string.Format(
"{0}{1}{2}{3}{4}",
LocalizableStrings.PackageIdColumn.PadRight(packageIdColumnWidth),
columnDelimiter,
LocalizableStrings.VersionColumn.PadRight(versionColumnWidth),
columnDelimiter,
LocalizableStrings.CommandsColumn.PadRight(commandsColumnWidth));

yield return new string(
'-',
packageIdColumnWidth + versionColumnWidth + commandsColumnWidth + (columnDelimiter.Length * 2));

foreach (var package in packages)
{
yield return string.Format(
"{0}{1}{2}{3}{4}",
package.Id.ToString().PadRight(packageIdColumnWidth),
columnDelimiter,
package.Version.ToNormalizedString().PadRight(versionColumnWidth),
columnDelimiter,
GetCommandsString(package).PadRight(commandsColumnWidth));
}
}

private static bool PackageHasCommands(IToolPackage package)
{
try
{
return package.Commands.Count >= 0;
}
catch (Exception ex) when (ex is ToolConfigurationException)
{
return false;
}
}
}
}