Merge pull request sarven#1 from carusogabriel/ref/better-assertions

sarven · web-flow · commit a8f422c4c0fb · 2021-03-05T08:44:10.000+01:00
Use stricter assertions
diff --git a/README.md b/README.md
@@ -184,7 +184,7 @@ public function test(): void
 
     $subscription->activate();
 
-    self::assertEquals(Status::activated(), $subscription->status());
+    self::assertSame(Status::activated(), $subscription->status());
 }
 ```
 
@@ -197,7 +197,7 @@ public function sut(): void
 
     $sut->activate();
 
-    self::assertEquals(Status::activated(), $sut->status());
+    self::assertSame(Status::activated(), $sut->status());
 }
 ``` 
 
@@ -281,7 +281,7 @@ public function aaa_pattern_example_test(): void
     $sut->activate();
 
     //Assert|Then
-    self::assertEquals(Status::activated(), $sut->status());
+    self::assertSame(Status::activated(), $sut->status());
 }
 ```
 
@@ -357,7 +357,7 @@ final class ExampleTest extends TestCase
 
         $result = $sut->isValid($email);
 
-        self::assertEquals(false, $result);
+        self::assertFalse($result);
     }
 
     /**
@@ -370,7 +370,7 @@ final class ExampleTest extends TestCase
 
         $result = $sut->isValid($email);
 
-        self::assertEquals(true, $result);
+        self::assertTrue($result);
     }
 
     public function getInvalidEmails(): array
@@ -416,7 +416,7 @@ final class TestExample extends TestCase
         $result = $sut->suspend($canAlwaysSuspendPolicy);
 
         self::assertTrue($result);
-        self::assertEquals(Status::suspend(), $sut->status());
+        self::assertSame(Status::suspend(), $sut->status());
     }
 }
 ```
@@ -441,7 +441,7 @@ final class TestExample extends TestCase
         $result = $sut->suspend($canAlwaysSuspendPolicy);
 
         self::assertTrue($result);
-        self::assertEquals(Status::suspend(), $sut->status());
+        self::assertSame(Status::suspend(), $sut->status());
     }
 }
 ```
@@ -550,7 +550,7 @@ final class ExampleTest extends TestCase
 
         $result = $sut->isValid($email);
 
-        self::assertEquals(false, $result);
+        self::assertFalse($result);
     }
 
     /**
@@ -563,7 +563,7 @@ final class ExampleTest extends TestCase
 
         $result = $sut->isValid($email);
 
-        self::assertEquals(true, $result);
+        self::assertTrue($result);
     }
 
     public function getInvalidEmails(): array
@@ -608,8 +608,8 @@ final class ExampleTest extends TestCase
 
         $sut->addItem($item);
 
-        self::assertEquals(1, $sut->getCount());
-        self::assertEquals($item, $sut->getItems()[0]);
+        self::assertSame(1, $sut->getCount());
+        self::assertSame($item, $sut->getItems()[0]);
     }
 }
 ```
@@ -746,7 +746,7 @@ final class ValidUnitExampleTest extends TestCase
 
         $result = $sut->parse($namesData);
         
-        self::assertEquals(
+        self::assertSame(
             [
                 new Name('John', new Gender('M')),
                 new Name('Lennon', new Gender('U')),
@@ -833,7 +833,7 @@ final class InvalidTestExample extends TestCase
 
         $result = $sut->renewSubscription(1);
 
-        self::assertEquals(Status::active(), $expiredSubscription->getStatus());
+        self::assertSame(Status::active(), $expiredSubscription->getStatus());
         self::assertGreaterThan($modifiedAt, $expiredSubscription->getModifiedAt());
         self::assertTrue($result);
     }
@@ -851,7 +851,7 @@ final class InvalidTestExample extends TestCase
 
         $result = $sut->renewSubscription(1);
 
-        self::assertEquals($modifiedAt, $activeSubscription->getModifiedAt());
+        self::assertSame($modifiedAt, $activeSubscription->getModifiedAt());
         self::assertFalse($result);
     }
 }
@@ -1585,7 +1585,7 @@ final class CustomerTest extends TestCase
 
         $customer->setName('John');
 
-        self::assertEquals('John', $customer->getName());
+        self::assertSame('John', $customer->getName());
     }
 }
 ```
@@ -1612,7 +1612,7 @@ final class EventSubscriberTest extends TestCase
     {
         $result = EventSubscriber::getSubscribedEvents();
 
-        self::assertEquals(['event' => 'onEvent'], $result);
+        self::assertSame(['event' => 'onEvent'], $result);
     }
 }
 ```
@@ -1684,7 +1684,7 @@ final class TestUserRepository extends TestCase
 
         $result = $userRepository->getUserNameByEmail($email);
 
-        self::assertEquals(['email' => $email], $result);
+        self::assertSame(['email' => $email], $result);
     }
 }
 ```
@@ -1841,7 +1841,7 @@ final class InvalidTest extends TestCase
         $sut = new Customer();
         $sut->makeVip();
 
-        self::assertEquals(CustomerType::VIP(), $sut->getCustomerType());
+        self::assertSame(CustomerType::VIP(), $sut->getCustomerType());
     }
 }
 ```
@@ -1885,7 +1885,7 @@ final class ValidTest extends TestCase
         $sut = new Customer();
         $sut->makeVip();
 
-        self::assertEquals(25, $sut->getPercentageDiscount());
+        self::assertSame(25, $sut->getPercentageDiscount());
     }
 }
 ```
@@ -1919,7 +1919,7 @@ final class InvalidTest extends TestCase
     {
         $sut = new DiscountCalculator();
 
-        self::assertEquals($expected, $sut->calculate($vipDaysFrom));
+        self::assertSame($expected, $sut->calculate($vipDaysFrom));
     }
 
     public function discountDataProvider(): array
@@ -1946,7 +1946,7 @@ final class ValidTest extends TestCase
     {
         $sut = new DiscountCalculator();
 
-        self::assertEquals($expected, $sut->calculate($vipDaysFrom));
+        self::assertSame($expected, $sut->calculate($vipDaysFrom));
     }
 
     public function discountDataProvider(): array
@@ -2011,7 +2011,7 @@ final class InvalidTest extends TestCase
         $discountCalculator->method('calculateAdditionalDiscountFromExternalSystem')->willReturn(5);
         $sut = new OrderService($discountCalculator);
 
-        self::assertEquals($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));
+        self::assertSame($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));
     }
 
     public function orderDataProvider(): array
@@ -2075,7 +2075,7 @@ final class ValidTest extends TestCase
         $externalDiscountCalculator->method('calculate')->willReturn(5);
         $sut = new OrderService(new InternalDiscountCalculator(), $externalDiscountCalculator);
 
-        self::assertEquals($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));
+        self::assertSame($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));
     }
 
     public function orderDataProvider(): array
@@ -2141,7 +2141,7 @@ final class InvalidTest extends TestCase
      */
     public function get_total_returns_a_total_cost_of_a_whole_order(Order $order, int $expectedTotal): void
     {
-        self::assertEquals($expectedTotal, $order->getTotal());
+        self::assertSame($expectedTotal, $order->getTotal());
     }
 
     /**
@@ -2150,7 +2150,7 @@ final class InvalidTest extends TestCase
      */
     public function get_items_total_returns_a_total_cost_of_all_items(Order $order, int $expectedTotal): void
     {
-        self::assertEquals($expectedTotal, $this->invokePrivateMethodGetItemsTotal($order));
+        self::assertSame($expectedTotal, $this->invokePrivateMethodGetItemsTotal($order));
     }
 
     public function ordersDataProvider(): array
@@ -2192,7 +2192,7 @@ final class ValidTest extends TestCase
      */
     public function get_total_returns_a_total_cost_of_a_whole_order(Order $order, int $expectedTotal): void
     {
-        self::assertEquals($expectedTotal, $order->getTotal());
+        self::assertSame($expectedTotal, $order->getTotal());
     }
 
     public function ordersDataProvider(): array
@@ -2385,4 +2385,4 @@ Mutation testing gives better feedback about the quality of tests.
 ## Recommended books
 
 - [Test Driven Development: By Example / Kent Beck](https://www.amazon.com/gp/product/0321146530/)  - the classic
-- [Unit Testing Principles, Practices, and Patterns / Vladimir Khorikov](https://www.amazon.com/Unit-Testing-Principles-Practices-Patterns/dp/1617296279) - the best book about tests I've ever read
+- [Unit Testing Principles, Practices, and Patterns / Vladimir Khorikov](https://www.amazon.com/Unit-Testing-Principles-Practices-Patterns/dp/1617296279) - the best book about tests I've ever read

Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ public function test(): void`
`184`	`184`
`185`	`185`	`$subscription->activate();`
`186`	`186`
`187`		`- self::assertEquals(Status::activated(), $subscription->status());`
	`187`	`+ self::assertSame(Status::activated(), $subscription->status());`
`188`	`188`	`}`
`189`	`189`	```
`190`	`190`
`@@ -197,7 +197,7 @@ public function sut(): void`
`197`	`197`
`198`	`198`	`$sut->activate();`
`199`	`199`
`200`		`- self::assertEquals(Status::activated(), $sut->status());`
	`200`	`+ self::assertSame(Status::activated(), $sut->status());`
`201`	`201`	`}`
`202`	`202`	```
`203`	`203`
`@@ -281,7 +281,7 @@ public function aaa_pattern_example_test(): void`
`281`	`281`	`$sut->activate();`
`282`	`282`
`283`	`283`	`//Assert\|Then`
`284`		`- self::assertEquals(Status::activated(), $sut->status());`
	`284`	`+ self::assertSame(Status::activated(), $sut->status());`
`285`	`285`	`}`
`286`	`286`	```
`287`	`287`
`@@ -357,7 +357,7 @@ final class ExampleTest extends TestCase`
`357`	`357`
`358`	`358`	`$result = $sut->isValid($email);`
`359`	`359`
`360`		`- self::assertEquals(false, $result);`
	`360`	`+ self::assertFalse($result);`
`361`	`361`	`}`
`362`	`362`
`363`	`363`	`/**`
`@@ -370,7 +370,7 @@ final class ExampleTest extends TestCase`
`370`	`370`
`371`	`371`	`$result = $sut->isValid($email);`
`372`	`372`
`373`		`- self::assertEquals(true, $result);`
	`373`	`+ self::assertTrue($result);`
`374`	`374`	`}`
`375`	`375`
`376`	`376`	`public function getInvalidEmails(): array`
`@@ -416,7 +416,7 @@ final class TestExample extends TestCase`
`416`	`416`	`$result = $sut->suspend($canAlwaysSuspendPolicy);`
`417`	`417`
`418`	`418`	`self::assertTrue($result);`
`419`		`- self::assertEquals(Status::suspend(), $sut->status());`
	`419`	`+ self::assertSame(Status::suspend(), $sut->status());`
`420`	`420`	`}`
`421`	`421`	`}`
`422`	`422`	```
`@@ -441,7 +441,7 @@ final class TestExample extends TestCase`
`441`	`441`	`$result = $sut->suspend($canAlwaysSuspendPolicy);`
`442`	`442`
`443`	`443`	`self::assertTrue($result);`
`444`		`- self::assertEquals(Status::suspend(), $sut->status());`
	`444`	`+ self::assertSame(Status::suspend(), $sut->status());`
`445`	`445`	`}`
`446`	`446`	`}`
`447`	`447`	```
`@@ -550,7 +550,7 @@ final class ExampleTest extends TestCase`
`550`	`550`
`551`	`551`	`$result = $sut->isValid($email);`
`552`	`552`
`553`		`- self::assertEquals(false, $result);`
	`553`	`+ self::assertFalse($result);`
`554`	`554`	`}`
`555`	`555`
`556`	`556`	`/**`
`@@ -563,7 +563,7 @@ final class ExampleTest extends TestCase`
`563`	`563`
`564`	`564`	`$result = $sut->isValid($email);`
`565`	`565`
`566`		`- self::assertEquals(true, $result);`
	`566`	`+ self::assertTrue($result);`
`567`	`567`	`}`
`568`	`568`
`569`	`569`	`public function getInvalidEmails(): array`
`@@ -608,8 +608,8 @@ final class ExampleTest extends TestCase`
`608`	`608`
`609`	`609`	`$sut->addItem($item);`
`610`	`610`
`611`		`- self::assertEquals(1, $sut->getCount());`
`612`		`- self::assertEquals($item, $sut->getItems()[0]);`
	`611`	`+ self::assertSame(1, $sut->getCount());`
	`612`	`+ self::assertSame($item, $sut->getItems()[0]);`
`613`	`613`	`}`
`614`	`614`	`}`
`615`	`615`	```
`@@ -746,7 +746,7 @@ final class ValidUnitExampleTest extends TestCase`
`746`	`746`
`747`	`747`	`$result = $sut->parse($namesData);`
`748`	`748`
`749`		`- self::assertEquals(`
	`749`	`+ self::assertSame(`
`750`	`750`	`[`
`751`	`751`	`new Name('John', new Gender('M')),`
`752`	`752`	`new Name('Lennon', new Gender('U')),`
`@@ -833,7 +833,7 @@ final class InvalidTestExample extends TestCase`
`833`	`833`
`834`	`834`	`$result = $sut->renewSubscription(1);`
`835`	`835`
`836`		`- self::assertEquals(Status::active(), $expiredSubscription->getStatus());`
	`836`	`+ self::assertSame(Status::active(), $expiredSubscription->getStatus());`
`837`	`837`	`self::assertGreaterThan($modifiedAt, $expiredSubscription->getModifiedAt());`
`838`	`838`	`self::assertTrue($result);`
`839`	`839`	`}`
`@@ -851,7 +851,7 @@ final class InvalidTestExample extends TestCase`
`851`	`851`
`852`	`852`	`$result = $sut->renewSubscription(1);`
`853`	`853`
`854`		`- self::assertEquals($modifiedAt, $activeSubscription->getModifiedAt());`
	`854`	`+ self::assertSame($modifiedAt, $activeSubscription->getModifiedAt());`
`855`	`855`	`self::assertFalse($result);`
`856`	`856`	`}`
`857`	`857`	`}`
`@@ -1585,7 +1585,7 @@ final class CustomerTest extends TestCase`
`1585`	`1585`
`1586`	`1586`	`$customer->setName('John');`
`1587`	`1587`
`1588`		`- self::assertEquals('John', $customer->getName());`
	`1588`	`+ self::assertSame('John', $customer->getName());`
`1589`	`1589`	`}`
`1590`	`1590`	`}`
`1591`	`1591`	```
`@@ -1612,7 +1612,7 @@ final class EventSubscriberTest extends TestCase`
`1612`	`1612`	`{`
`1613`	`1613`	`$result = EventSubscriber::getSubscribedEvents();`
`1614`	`1614`
`1615`		`- self::assertEquals(['event' => 'onEvent'], $result);`
	`1615`	`+ self::assertSame(['event' => 'onEvent'], $result);`
`1616`	`1616`	`}`
`1617`	`1617`	`}`
`1618`	`1618`	```
`@@ -1684,7 +1684,7 @@ final class TestUserRepository extends TestCase`
`1684`	`1684`
`1685`	`1685`	`$result = $userRepository->getUserNameByEmail($email);`
`1686`	`1686`
`1687`		`- self::assertEquals(['email' => $email], $result);`
	`1687`	`+ self::assertSame(['email' => $email], $result);`
`1688`	`1688`	`}`
`1689`	`1689`	`}`
`1690`	`1690`	```
`@@ -1841,7 +1841,7 @@ final class InvalidTest extends TestCase`
`1841`	`1841`	`$sut = new Customer();`
`1842`	`1842`	`$sut->makeVip();`
`1843`	`1843`
`1844`		`- self::assertEquals(CustomerType::VIP(), $sut->getCustomerType());`
	`1844`	`+ self::assertSame(CustomerType::VIP(), $sut->getCustomerType());`
`1845`	`1845`	`}`
`1846`	`1846`	`}`
`1847`	`1847`	```
`@@ -1885,7 +1885,7 @@ final class ValidTest extends TestCase`
`1885`	`1885`	`$sut = new Customer();`
`1886`	`1886`	`$sut->makeVip();`
`1887`	`1887`
`1888`		`- self::assertEquals(25, $sut->getPercentageDiscount());`
	`1888`	`+ self::assertSame(25, $sut->getPercentageDiscount());`
`1889`	`1889`	`}`
`1890`	`1890`	`}`
`1891`	`1891`	```
`@@ -1919,7 +1919,7 @@ final class InvalidTest extends TestCase`
`1919`	`1919`	`{`
`1920`	`1920`	`$sut = new DiscountCalculator();`
`1921`	`1921`
`1922`		`- self::assertEquals($expected, $sut->calculate($vipDaysFrom));`
	`1922`	`+ self::assertSame($expected, $sut->calculate($vipDaysFrom));`
`1923`	`1923`	`}`
`1924`	`1924`
`1925`	`1925`	`public function discountDataProvider(): array`
`@@ -1946,7 +1946,7 @@ final class ValidTest extends TestCase`
`1946`	`1946`	`{`
`1947`	`1947`	`$sut = new DiscountCalculator();`
`1948`	`1948`
`1949`		`- self::assertEquals($expected, $sut->calculate($vipDaysFrom));`
	`1949`	`+ self::assertSame($expected, $sut->calculate($vipDaysFrom));`
`1950`	`1950`	`}`
`1951`	`1951`
`1952`	`1952`	`public function discountDataProvider(): array`
`@@ -2011,7 +2011,7 @@ final class InvalidTest extends TestCase`
`2011`	`2011`	`$discountCalculator->method('calculateAdditionalDiscountFromExternalSystem')->willReturn(5);`
`2012`	`2012`	`$sut = new OrderService($discountCalculator);`
`2013`	`2013`
`2014`		`- self::assertEquals($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));`
	`2014`	`+ self::assertSame($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));`
`2015`	`2015`	`}`
`2016`	`2016`
`2017`	`2017`	`public function orderDataProvider(): array`
`@@ -2075,7 +2075,7 @@ final class ValidTest extends TestCase`
`2075`	`2075`	`$externalDiscountCalculator->method('calculate')->willReturn(5);`
`2076`	`2076`	`$sut = new OrderService(new InternalDiscountCalculator(), $externalDiscountCalculator);`
`2077`	`2077`
`2078`		`- self::assertEquals($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));`
	`2078`	`+ self::assertSame($expected, $sut->getTotalPriceWithDiscount($totalPrice, $vipDaysFrom));`
`2079`	`2079`	`}`
`2080`	`2080`
`2081`	`2081`	`public function orderDataProvider(): array`
`@@ -2141,7 +2141,7 @@ final class InvalidTest extends TestCase`
`2141`	`2141`	`*/`
`2142`	`2142`	`public function get_total_returns_a_total_cost_of_a_whole_order(Order $order, int $expectedTotal): void`
`2143`	`2143`	`{`
`2144`		`- self::assertEquals($expectedTotal, $order->getTotal());`
	`2144`	`+ self::assertSame($expectedTotal, $order->getTotal());`
`2145`	`2145`	`}`
`2146`	`2146`
`2147`	`2147`	`/**`
`@@ -2150,7 +2150,7 @@ final class InvalidTest extends TestCase`
`2150`	`2150`	`*/`
`2151`	`2151`	`public function get_items_total_returns_a_total_cost_of_all_items(Order $order, int $expectedTotal): void`
`2152`	`2152`	`{`
`2153`		`- self::assertEquals($expectedTotal, $this->invokePrivateMethodGetItemsTotal($order));`
	`2153`	`+ self::assertSame($expectedTotal, $this->invokePrivateMethodGetItemsTotal($order));`
`2154`	`2154`	`}`
`2155`	`2155`
`2156`	`2156`	`public function ordersDataProvider(): array`
`@@ -2192,7 +2192,7 @@ final class ValidTest extends TestCase`
`2192`	`2192`	`*/`
`2193`	`2193`	`public function get_total_returns_a_total_cost_of_a_whole_order(Order $order, int $expectedTotal): void`
`2194`	`2194`	`{`
`2195`		`- self::assertEquals($expectedTotal, $order->getTotal());`
	`2195`	`+ self::assertSame($expectedTotal, $order->getTotal());`
`2196`	`2196`	`}`
`2197`	`2197`
`2198`	`2198`	`public function ordersDataProvider(): array`
`@@ -2385,4 +2385,4 @@ Mutation testing gives better feedback about the quality of tests.`
`2385`	`2385`	`## Recommended books`
`2386`	`2386`
`2387`	`2387`	`- [Test Driven Development: By Example / Kent Beck](https://www.amazon.com/gp/product/0321146530/) - the classic`
`2388`		`-- [Unit Testing Principles, Practices, and Patterns / Vladimir Khorikov](https://www.amazon.com/Unit-Testing-Principles-Practices-Patterns/dp/1617296279) - the best book about tests I've ever read`
	`2388`	`+- [Unit Testing Principles, Practices, and Patterns / Vladimir Khorikov](https://www.amazon.com/Unit-Testing-Principles-Practices-Patterns/dp/1617296279) - the best book about tests I've ever read`