Assert::greaterThanEq and Assert::lessThanEq don't work for NAN

[johanvio]

Hi,

I think I just found a bug in your assertion library

$a = NAN; // not-a-number
Assert::greaterThanEq($a, 0);  // does not throw, while it should
Assert::lessThanEq($a, 0); // does not throw, while it should

eq seems to work fine with NAN:

$a = NAN;
Assert::eq($a, $a); // throws, which is fine

Thank you for your nice assertion library; I've been using it for years, and I like it very much!

[kkevindev]

I think an assertion for isNan and isNotNan would be good additions to Assert & then we can add them to validate the given $value for the greaterThanEq / lessThanEq functions. Idea?

[shadowhand]

@kkevindev yes, agreed. Do you want to make a PR for it?

[kkevindev]

@kkevindev yes, agreed. Do you want to make a PR for it?

Yeah was working on something @shadowhand but I got stopped by a limitation where NAN !== NAN in the wounderful PHP world. So tests fail right now since the given $value (NAN) does not equal the returned $value (NAN).. :)

https://www.php.net/manual/en/function.is-nan.php

Will check later maybe to exclude the return testing for NAN values or something.

[shadowhand]

@kkevindev looks like is_nan($a) && is_nan($b) would work: https://3v4l.org/p5pOX#vnull

But... not sure that helps, because it doesn't seem that Psalm has a specific subtype for NAN.

[shadowhand]

Looks like psalm doesn't want to deal with NAN and TBH, I feel like we should follow the same route.

[kkevindev]

@shadowhand I still think we should so something about greaterThan because Assert::greaterThan(NAN, 0); should fail, right?

[shadowhand]

@kkevindev yes? https://3v4l.org/2Sspk#vnull

[kkevindev]

@kkevindev yes? https://3v4l.org/2Sspk#vnull

yeah, but it should throw an Exception in the Assert class, which it doens't.

[shadowhand]

@kkevindev I am not disagreeing with that.

[shadowhand]

Dealing with NAN gets incredibly messy. The correct way to handle this would be in your own code:

Assert::false(is_float($value) && is_nan($value));

Reason being, this is what happens if we try to implement NAN handling:

There were 33 failures:

1) Webmozart\Assert\Tests\AssertTest::testAssert with data set #193 ('nan', [NAN, 0.0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

2) Webmozart\Assert\Tests\AssertTest::testAssert with data set #198 ('greaterThan', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

3) Webmozart\Assert\Tests\AssertTest::testAssert with data set #202 ('greaterThanEq', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

4) Webmozart\Assert\Tests\AssertTest::testAssert with data set #205 ('lessThan', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

5) Webmozart\Assert\Tests\AssertTest::testAssert with data set #209 ('lessThanEq', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

6) Webmozart\Assert\Tests\AssertTest::testAssert with data set #214 ('range', [NAN, -1, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

7) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #192 ('nan', [NAN, NAN], true)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

8) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #193 ('nan', [NAN, 0.0], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

9) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #198 ('greaterThan', [NAN, 0], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

10) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #202 ('greaterThanEq', [NAN, 0], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

11) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #205 ('lessThan', [NAN, 1], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

12) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #209 ('lessThanEq', [NAN, 1], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

13) Webmozart\Assert\Tests\AssertTest::testNullOr with data set #214 ('range', [NAN, -1, 1], false)
Failed asserting that NAN is identical to NAN.

/Users/woodygilk/Code/@misc/webmozart-assert/tests/AssertTest.php:697

14) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #193 ('nan', [NAN, 0.0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

15) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #198 ('greaterThan', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

16) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #202 ('greaterThanEq', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

17) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #205 ('lessThan', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

18) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #209 ('lessThanEq', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

19) Webmozart\Assert\Tests\AssertTest::testAllArray with data set #214 ('range', [NAN, -1, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

20) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #193 ('nan', [NAN, 0.0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

21) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #198 ('greaterThan', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

22) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #202 ('greaterThanEq', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

23) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #205 ('lessThan', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

24) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #209 ('lessThanEq', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

25) Webmozart\Assert\Tests\AssertTest::testAllNullOrArray with data set #214 ('range', [NAN, -1, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

26) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #193 ('nan', [NAN, 0.0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

27) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #198 ('greaterThan', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

28) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #202 ('greaterThanEq', [NAN, 0], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

29) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #205 ('lessThan', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

30) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #209 ('lessThanEq', [NAN, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.

31) Webmozart\Assert\Tests\AssertTest::testAllTraversable with data set #214 ('range', [NAN, -1, 1], false)
Failed asserting that exception of type "\InvalidArgumentException" is thrown.