Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2025-12-15 11:17:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix exceptions and incorrect results within the calculator plugin (#7438)

Browse Source 
* remove functions which mages cannot interpret and add in functions which mages can

* set validResult when the result is explicitly created to differentiate it form an empty CalculateResult

* Add condition to check that the input is not ending with a binary operation

* add tests for all the cases

* use valid result while calculating hash as well

* add test for e is valid within regex

* removed i from regex

* remove valid result to use decimal? instead

* remove duplicate rand and exp
This commit is contained in:
Alekhya
2020-10-21 16:19:37 -07:00
committed by GitHub
parent 86d77103e9
commit dd2627dbbc
4 changed files with 83 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
src/modules/launcher/Plugins/Microsoft.Plugin.Calculator.UnitTest/ExtendedCalculatorParserTests.cs
View File

@@ -34,6 +34,7 @@ namespace Microsoft.Plugin.Calculator.UnitTests
[TestCase("42")]
[TestCase("test")]
[TestCase("pi(2)")] // Incorrect input, constant is being treated as a function.
public void Interpret_NoResult_WhenCalled(string input)
{
// Arrange
@@ -60,6 +61,7 @@ namespace Microsoft.Plugin.Calculator.UnitTests
[TestCase("2+2.11", 4.11D)]
[TestCase("8.43 + 4.43 - 12.86", 0D)]
[TestCase("8.43 + 4.43 - 12.8", 0.06D)]
[TestCase("exp(5)", 148.413159102577D)]
public void Interpret_NoErrors_WhenCalledWithRounding(string input, decimal expectedResult)
{
// Arrange
@@ -110,7 +112,15 @@ namespace Microsoft.Plugin.Calculator.UnitTests
[TestCase("((1 * 2)", false)]
[TestCase("(1 * 2)))", false)]
[TestCase("abcde", false)]
[TestCase("plot( 2 * 3)", true)]
[TestCase("1 + 2 +", false)]
[TestCase("1+2*", false)]
[TestCase("1 && 3 &&", false)]
[TestCase("sqrt( 36)", true)]
[TestCase("max 4", false)]
[TestCase("sin(0)", true)]
[TestCase("cos", false)]
[TestCase("abs", false)]
[TestCase("1+1.1e3", true)]
public void InputValid_TestValid_WhenCalled(string input, bool valid)
{
// Arrange
@@ -121,5 +131,38 @@ namespace Microsoft.Plugin.Calculator.UnitTests
// Assert
Assert.AreEqual(valid, result);
}
[TestCase("1-1")]
[TestCase("sin(0)")]
public void Interpret_MustReturnResult_WhenResultIsZero(string input)
{
// Arrange
var engine = new CalculateEngine();
// Act
var result = engine.Interpret(input, CultureInfo.InvariantCulture);
// Assert
Assert.IsNotNull(result);
Assert.AreEqual(0.0, result.Result);
}
[TestCase("factorial(5)", 120)]
[TestCase("sign(-2)", -1)]
[TestCase("sign(2)", +1)]
[TestCase("abs(-2)", 2)]
[TestCase("abs(2)", 2)]
public void Interpret_MustReturnExpectedResult_WhenCalled(string input, decimal expectedResult)
{
// Arrange
var engine = new CalculateEngine();
// Act
var result = engine.Interpret(input, CultureInfo.InvariantCulture);
// Assert
Assert.IsNotNull(result);
Assert.AreEqual(expectedResult, result.Result);
}
}
}

17
src/modules/launcher/Plugins/Microsoft.Plugin.Calculator/CalculateHelper.cs
View File

@@ -11,12 +11,12 @@ namespace Microsoft.Plugin.Calculator
{
private static readonly Regex RegValidExpressChar = new Regex(
@"^(" +
@"ceil|floor|exp|pi|e|max|min|det|abs|log|ln|sqrt|" +
@"sin|cos|tan|arcsin|arccos|arctan|" +
@"eigval|eigvec|eig|sum|polar|plot|round|sort|real|zeta|" +
@"bin2dec|hex2dec|oct2dec|" +
@"ceil\s*\(|floor\s*\(|exp\s*\(|max\s*\(|min\s*\(|abs\s*\(|log\s*\(|ln\s*\(|sqrt\s*\(|pow\s*\(|" +
@"factorial\s*\(|sign\s*\(|round\s*\(|rand\s*\(|" +
@"sin\s*\(|cos\s*\(|tan\s*\(|arcsin\s*\(|arccos\s*\(|arctan\s*\(|" +
@"pi|" +
@"==|~=|&&|\|\||" +
@"[ei]|[0-9]|[\+\-\*\/\^\., ""]|[\(\)\|\!\[\]]" +
@"e|[0-9]|[\+\-\*\/\^\., ""]|[\(\)\|\!\[\]]" +
@")+$", RegexOptions.Compiled);
public static bool InputValid(string input)
@@ -41,6 +41,13 @@ namespace Microsoft.Plugin.Calculator
return false;
}
// If the input ends with a binary operator then it is not a valid input to mages and the Interpret function would throw an exception.
string trimmedInput = input.TrimEnd();
if (trimmedInput.EndsWith('+') || trimmedInput.EndsWith('-') || trimmedInput.EndsWith('*') || trimmedInput.EndsWith('|') || trimmedInput.EndsWith('\\') || trimmedInput.EndsWith('^') || trimmedInput.EndsWith('=') || trimmedInput.EndsWith('&'))
{
return false;
}
return true;
}
}

4
src/modules/launcher/Plugins/Microsoft.Plugin.Calculator/CalculateResult.cs
View File

@@ -9,9 +9,9 @@ namespace Microsoft.Plugin.Calculator
{
public struct CalculateResult : IEquatable<CalculateResult>
{
public decimal Result { get; set; }
public decimal? Result { get; set; }
public decimal RoundedResult { get; set; }
public decimal? RoundedResult { get; set; }
public bool Equals(CalculateResult other)
{

41
src/modules/launcher/Plugins/Microsoft.Plugin.Calculator/ResultHelper.cs
View File

@@ -17,11 +17,17 @@ namespace Microsoft.Plugin.Calculator
return CreateResult(result.RoundedResult, iconPath);
}
public static Result CreateResult(decimal roundedResult, string iconPath)
public static Result CreateResult(decimal? roundedResult, string iconPath)
{
// Return null when the expression is not a valid calculator query.
if (roundedResult == null)
{
return null;
}
return new Result
{
Title = roundedResult.ToString(CultureInfo.CurrentCulture),
Title = roundedResult?.ToString(CultureInfo.CurrentCulture),
IcoPath = iconPath,
Score = 300,
SubTitle = Properties.Resources.wox_plugin_calculator_copy_number_to_clipboard,
@@ -29,26 +35,29 @@ namespace Microsoft.Plugin.Calculator
};
}
public static bool Action(decimal roundedResult)
public static bool Action(decimal? roundedResult)
{
var ret = false;
var thread = new Thread(() =>
if (roundedResult != null)
{
try
var thread = new Thread(() =>
{
Clipboard.SetText(roundedResult.ToString(CultureInfo.CurrentUICulture.NumberFormat));
ret = true;
}
catch (ExternalException)
{
MessageBox.Show(Properties.Resources.wox_plugin_calculator_copy_failed);
}
});
try
{
Clipboard.SetText(roundedResult?.ToString(CultureInfo.CurrentUICulture.NumberFormat));
ret = true;
}
catch (ExternalException)
{
MessageBox.Show(Properties.Resources.wox_plugin_calculator_copy_failed);
}
});
thread.SetApartmentState(ApartmentState.STA);
thread.Start();
thread.Join();
thread.SetApartmentState(ApartmentState.STA);
thread.Start();
thread.Join();
}
return ret;
}