Skip to content

ProgressTask.GetPercentage() returns 100 when max value is 0 #1694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2024
Merged

ProgressTask.GetPercentage() returns 100 when max value is 0 #1694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b22b18
Return 100% when MaxValue = 0
FrankRay78 Nov 18, 2024
a19efae
Added unit test coverage
FrankRay78 Nov 22, 2024
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
5 changes: 5 additions & 0 deletions src/Spectre.Console/Live/Progress/ProgressTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,11 @@ private void Update(

private double GetPercentage()
{
if (MaxValue == 0)
{
return 100;
}

var percentage = (Value / MaxValue) * 100;
percentage = Math.Min(100, Math.Max(0, percentage));
return percentage;
Expand Down
25 changes: 25 additions & 0 deletions src/Tests/Spectre.Console.Tests/Unit/Live/Progress/ProgressTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,31 @@ public void Setting_Max_Value_Should_Set_The_MaxValue_And_Cap_Value()
task.Value.ShouldBe(20);
}

[Fact]
public void Setting_Max_Value_To_Zero_Should_Make_Percentage_OneHundred()
{
// Given
var console = new TestConsole()
.Interactive();

var task = default(ProgressTask);
var progress = new Progress(console)
.Columns(new[] { new ProgressBarColumn() })
.AutoRefresh(false)
.AutoClear(false);

// When
progress.Start(ctx =>
{
task = ctx.AddTask("foo");
task.MaxValue = 0;
});

// Then
task.Value.ShouldBe(0);
task.Percentage.ShouldBe(100);
}

[Fact]
public void Setting_Value_Should_Override_Incremented_Value()
{
Expand Down