Skip to content

Commit

Permalink
Merge pull request #8710 from jrdodds/IntrinsicFunctionsOverload
Browse files Browse the repository at this point in the history 
Intrinsic arithmetic function overloads
  • Loading branch information
@JanKrivanek
JanKrivanek authored Jun 28, 2023
2 parents d11f53a + 19b5039 commit 0cad196
Show file tree
Hide file tree
Showing 6 changed files with 1,029 additions and 63 deletions.
279 changes: 279 additions & 0 deletions src/Build.UnitTests/Evaluation/ExpanderFunction_Tests.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Globalization;
using System.Runtime.InteropServices;
using System.Threading;

using Microsoft.Build.Evaluation;

using Shouldly;

using Xunit;
using Xunit.Abstractions;

namespace Microsoft.Build.Engine.UnitTests.Evaluation
{
public class ExpanderFunction_Tests
{
private readonly ITestOutputHelper _output;

public ExpanderFunction_Tests(ITestOutputHelper output) => _output = output;

/* Tests for TryConvertToInt */

[Fact]
public void TryConvertToIntGivenNull()
{
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(null, out int actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToIntGivenDouble()
{
const double value = 10.0;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToIntGivenLong()
{
const long value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToIntGivenInt()
{
const int value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToIntGivenString()
{
const string value = "10";
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToIntGivenDoubleWithIntMinValue()
{
const int expected = int.MinValue;
const double value = expected;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(expected);
}

[Fact]
public void TryConvertToIntGivenDoubleWithIntMaxValue()
{
const int expected = int.MaxValue;
const double value = expected;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeTrue();
actual.ShouldBe(expected);
}

[Fact]
public void TryConvertToIntGivenDoubleWithLessThanIntMinValue()
{
const double value = int.MinValue - 1.0;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToIntGivenDoubleWithGreaterThanIntMaxValue()
{
const double value = int.MaxValue + 1.0;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToIntGivenLongWithGreaterThanIntMaxValue()
{
const long value = int.MaxValue + 1L;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToInt(value, out int actual).ShouldBeFalse();
actual.ShouldBe(0);
}

/* Tests for TryConvertToLong */

[Fact]
public void TryConvertToLongGivenNull()
{
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(null, out long actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToLongGivenDouble()
{
const double value = 10.0;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToLongGivenLong()
{
const long value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToLongGivenInt()
{
const int value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToLongGivenString()
{
const string value = "10";
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(10);
}

[Fact]
public void TryConvertToLongGivenDoubleWithLongMinValue()
{
const long expected = long.MinValue;
const double value = expected;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(expected);
}

[Fact]
public void TryConvertToLongGivenDoubleWithLongMaxValueShouldNotThrow()
{
// An OverflowException should not be thrown from TryConvertToLong().
// Convert.ToInt64(double) has a defect and will throw an OverflowException
// for values >= (long.MaxValue - 511) and <= long.MaxValue.
_ = Should.NotThrow(() => Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong((double)long.MaxValue, out _));
}

[Fact]
public void TryConvertToLongGivenDoubleWithLongMaxValue()
{
const long longMaxValue = long.MaxValue;
bool result = Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong((double)longMaxValue, out long actual);
if (RuntimeInformation.OSArchitecture != Architecture.Arm64)
{
// Because of loss of precision, long.MaxValue will not 'round trip' from long to double to long.
result.ShouldBeFalse();
actual.ShouldBe(0);
}
else
{
// Testing on macOS 12 on Apple Silicon M1 Pro produces different result.
result.ShouldBeTrue();
actual.ShouldBe(longMaxValue);
}
}

[Fact]
public void TryConvertToLongGivenDoubleWithVeryLargeLongValue()
{
// Because of loss of precision, veryLargeLong will not 'round trip' but within TryConvertToLong
// the double to long conversion will pass the tolerance test. Return will be true and veryLargeLong != expected.
const long veryLargeLong = long.MaxValue - 512;
const double value = veryLargeLong;
const long expected = 9223372036854774784L;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeTrue();
actual.ShouldBe(expected);
}

[Fact]
public void TryConvertToLongGivenDoubleWithLessThanLongMinValue()
{
const double value = -92233720368547758081D;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToLongGivenDoubleWithGreaterThanLongMaxValue()
{
const double value = (double)long.MaxValue + long.MaxValue;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToLong(value, out long actual).ShouldBeFalse();
actual.ShouldBe(0);
}

/* Tests for TryConvertToDouble */

[Fact]
public void TryConvertToDoubleGivenNull()
{
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(null, out double actual).ShouldBeFalse();
actual.ShouldBe(0);
}

[Fact]
public void TryConvertToDoubleGivenDouble()
{
const double value = 10.0;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(value, out double actual).ShouldBeTrue();
actual.ShouldBe(10.0);
}

[Fact]
public void TryConvertToDoubleGivenLong()
{
const long value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(value, out double actual).ShouldBeTrue();
actual.ShouldBe(10.0);
}

[Fact]
public void TryConvertToDoubleGivenInt()
{
const int value = 10;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(value, out double actual).ShouldBeTrue();
actual.ShouldBe(10.0);
}

[Fact]
public void TryConvertToDoubleGivenString()
{
const string value = "10";
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(value, out double actual).ShouldBeTrue();
actual.ShouldBe(10.0);
}

[Fact]
public void TryConvertToDoubleGivenStringAndLocale()
{
const string value = "1,2";

Thread currentThread = Thread.CurrentThread;
CultureInfo originalCulture = currentThread.CurrentCulture;

try
{
// English South Africa locale uses ',' as decimal separator.
// The invariant culture should be used and "1,2" should be 12.0 not 1.2.
var cultureEnglishSouthAfrica = CultureInfo.CreateSpecificCulture("en-ZA");
currentThread.CurrentCulture = cultureEnglishSouthAfrica;
Expander<IProperty, IItem>.Function<IProperty>.TryConvertToDouble(value, out double actual).ShouldBeTrue();
actual.ShouldBe(12.0);
}
finally
{
// Restore CultureInfo.
currentThread.CurrentCulture = originalCulture;
CultureInfo.CurrentCulture = originalCulture;
CultureInfo.DefaultThreadCurrentCulture = originalCulture;
}
}
}
}
Loading

0 comments on commit 0cad196

Please sign in to comment.