replace assertEquals() in examples with assertSame()

mhujer · sebastianbergmann · commit 4255e9486d28 · 2018-02-10T06:43:46.000+01:00
diff --git a/src/annotations.rst b/src/annotations.rst
@@ -264,7 +264,7 @@ specify which method(s) a test method wants to test:
      */
     public function testBalanceIsInitiallyZero()
     {
-        $this->assertEquals(0, $this->ba->getBalance());
+        $this->assertSame(0, $this->ba->getBalance());
     }
 
 If provided, only the code coverage information for the specified
@@ -728,7 +728,7 @@ annotation in a method's DocBlock to mark it as a test method.
      */
     public function initialBalanceShouldBe0()
     {
-        $this->assertEquals(0, $this->ba->getBalance());
+        $this->assertSame(0, $this->ba->getBalance());
     }
 
 .. _appendixes.annotations.testdox:
@@ -752,7 +752,7 @@ The ``@testdox`` annotation can be applied to both test classes and test methods
          */
         public function balanceIsInitiallyZero()
         {
-            $this->assertEquals(0, $this->ba->getBalance());
+            $this->assertSame(0, $this->ba->getBalance());
         }
     }
 
@@ -783,7 +783,7 @@ you can define a data set using the ``@testWith`` annotation.
      */
     public function testStringLength(string $input, int $expectedLength)
     {
-        $this->assertEquals($expectedLength, strlen($input));
+        $this->assertSame($expectedLength, strlen($input));
     }
 
 .. _appendixes.annotations.ticket:
diff --git a/src/code-coverage-analysis.rst b/src/code-coverage-analysis.rst
@@ -216,7 +216,7 @@ shows an example.
          */
         public function testBalanceIsInitiallyZero()
         {
-            $this->assertEquals(0, $this->ba->getBalance());
+            $this->assertSame(0, $this->ba->getBalance());
         }
 
         /**
@@ -229,7 +229,7 @@ shows an example.
             }
 
             catch (BankAccountException $e) {
-                $this->assertEquals(0, $this->ba->getBalance());
+                $this->assertSame(0, $this->ba->getBalance());
 
                 return;
             }
@@ -247,7 +247,7 @@ shows an example.
             }
 
             catch (BankAccountException $e) {
-                $this->assertEquals(0, $this->ba->getBalance());
+                $this->assertSame(0, $this->ba->getBalance());
 
                 return;
             }
@@ -262,11 +262,11 @@ shows an example.
          */
         public function testDepositWithdrawMoney()
         {
-            $this->assertEquals(0, $this->ba->getBalance());
+            $this->assertSame(0, $this->ba->getBalance());
             $this->ba->depositMoney(1);
-            $this->assertEquals(1, $this->ba->getBalance());
+            $this->assertSame(1, $this->ba->getBalance());
             $this->ba->withdrawMoney(1);
-            $this->assertEquals(0, $this->ba->getBalance());
+            $this->assertSame(0, $this->ba->getBalance());
         }
     }
     ?>
diff --git a/src/database.rst b/src/database.rst
@@ -206,7 +206,7 @@ following way:
     {
         public function testCalculate()
         {
-            $this->assertEquals(2, 1 + 1);
+            $this->assertSame(2, 1 + 1);
         }
     }
     ?>
@@ -1340,7 +1340,7 @@ which has to be returned from the
 
            public function testGetRowCount()
            {
-               $this->assertEquals(2, $this->getConnection()->getRowCount('guestbook'));
+               $this->assertSame(2, $this->getConnection()->getRowCount('guestbook'));
            }
        }
        ?>
@@ -1379,12 +1379,12 @@ examples, but a third one:
 
         public function testAddEntry()
         {
-            $this->assertEquals(2, $this->getConnection()->getRowCount('guestbook'), "Pre-Condition");
+            $this->assertSame(2, $this->getConnection()->getRowCount('guestbook'), "Pre-Condition");
 
             $guestbook = new Guestbook();
             $guestbook->addEntry("suzy", "Hello world!");
 
-            $this->assertEquals(3, $this->getConnection()->getRowCount('guestbook'), "Inserting failed");
+            $this->assertSame(3, $this->getConnection()->getRowCount('guestbook'), "Inserting failed");
         }
     }
     ?>
diff --git a/src/fixtures.rst b/src/fixtures.rst
@@ -40,7 +40,7 @@ creation of the ``array`` fixture into the
 ``setUp()`` method. Finally, we remove the redundant code
 from the test methods and use the newly introduced instance variable,
 ``$this->stack``, instead of the method-local variable
-``$stack`` with the ``assertEquals()``
+``$stack`` with the ``assertSame()``
 assertion method.
 
 .. code-block:: php
@@ -67,14 +67,14 @@ assertion method.
         public function testPush()
         {
             array_push($this->stack, 'foo');
-            $this->assertEquals('foo', $this->stack[count($this->stack)-1]);
+            $this->assertSame('foo', $this->stack[count($this->stack)-1]);
             $this->assertFalse(empty($this->stack));
         }
 
         public function testPop()
         {
             array_push($this->stack, 'foo');
-            $this->assertEquals('foo', array_pop($this->stack));
+            $this->assertSame('foo', array_pop($this->stack));
             $this->assertTrue(empty($this->stack));
         }
     }
diff --git a/src/test-doubles.rst b/src/test-doubles.rst
@@ -113,7 +113,7 @@ the example. This leads to more readable and "fluent" code.
 
             // Calling $stub->doSomething() will now return
             // 'foo'.
-            $this->assertEquals('foo', $stub->doSomething());
+            $this->assertSame('foo', $stub->doSomething());
         }
     }
     ?>
@@ -146,7 +146,7 @@ the same best practice defaults used by ``createMock()``.
         public function testStub()
         {
             // Create a stub for the SomeClass class.
-            $stub = $this->getMockBuilder($originalClassName)
+            $stub = $this->getMockBuilder(SomeClass::class)
                          ->disableOriginalConstructor()
                          ->disableOriginalClone()
                          ->disableArgumentCloning()
@@ -159,7 +159,7 @@ the same best practice defaults used by ``createMock()``.
 
             // Calling $stub->doSomething() will now return
             // 'foo'.
-            $this->assertEquals('foo', $stub->doSomething());
+            $this->assertSame('foo', $stub->doSomething());
         }
     }
     ?>
@@ -194,10 +194,10 @@ can achieve this using ``returnArgument()`` instead of
                  ->will($this->returnArgument(0));
 
             // $stub->doSomething('foo') returns 'foo'
-            $this->assertEquals('foo', $stub->doSomething('foo'));
+            $this->assertSame('foo', $stub->doSomething('foo'));
 
             // $stub->doSomething('bar') returns 'bar'
-            $this->assertEquals('bar', $stub->doSomething('bar'));
+            $this->assertSame('bar', $stub->doSomething('bar'));
         }
     }
     ?>
@@ -264,8 +264,8 @@ an example.
 
             // $stub->doSomething() returns different values depending on
             // the provided arguments.
-            $this->assertEquals('d', $stub->doSomething('a', 'b', 'c'));
-            $this->assertEquals('h', $stub->doSomething('e', 'f', 'g'));
+            $this->assertSame('d', $stub->doSomething('a', 'b', 'c'));
+            $this->assertSame('h', $stub->doSomething('e', 'f', 'g'));
         }
     }
     ?>
@@ -296,7 +296,7 @@ result of a callback function or method. See
                  ->will($this->returnCallback('str_rot13'));
 
             // $stub->doSomething($argument) returns str_rot13($argument)
-            $this->assertEquals('fbzrguvat', $stub->doSomething('something'));
+            $this->assertSame('fbzrguvat', $stub->doSomething('something'));
         }
     }
     ?>
@@ -326,9 +326,9 @@ an example.
                  ->will($this->onConsecutiveCalls(2, 3, 5, 7));
 
             // $stub->doSomething() returns a different value each time
-            $this->assertEquals(2, $stub->doSomething());
-            $this->assertEquals(3, $stub->doSomething());
-            $this->assertEquals(5, $stub->doSomething());
+            $this->assertSame(2, $stub->doSomething());
+            $this->assertSame(3, $stub->doSomething());
+            $this->assertSame(5, $stub->doSomething());
         }
     }
     ?>
diff --git a/src/textui.rst b/src/textui.rst
@@ -58,7 +58,7 @@ indicate progress:
 
 PHPUnit distinguishes between *failures* and
 *errors*. A failure is a violated PHPUnit
-assertion such as a failing ``assertEquals()`` call.
+assertion such as a failing ``assertSame()`` call.
 An error is an unexpected exception or a PHP error. Sometimes
 this distinction proves useful since errors tend to be easier to fix
 than failures. If you have a big list of problems, it is best to
diff --git a/src/writing-tests-for-phpunit.rst b/src/writing-tests-for-phpunit.rst

Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,7 @@ specify which method(s) a test method wants to test:`
`264`	`264`	`*/`
`265`	`265`	`public function testBalanceIsInitiallyZero()`
`266`	`266`	`{`
`267`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`267`	`+ $this->assertSame(0, $this->ba->getBalance());`
`268`	`268`	`}`
`269`	`269`
`270`	`270`	`If provided, only the code coverage information for the specified`
`@@ -728,7 +728,7 @@ annotation in a method's DocBlock to mark it as a test method.`
`728`	`728`	`*/`
`729`	`729`	`public function initialBalanceShouldBe0()`
`730`	`730`	`{`
`731`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`731`	`+ $this->assertSame(0, $this->ba->getBalance());`
`732`	`732`	`}`
`733`	`733`
`734`	`734`	`.. _appendixes.annotations.testdox:`
@@ -752,7 +752,7 @@ The ``@testdox`` annotation can be applied to both test classes and test methods
`752`	`752`	`*/`
`753`	`753`	`public function balanceIsInitiallyZero()`
`754`	`754`	`{`
`755`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`755`	`+ $this->assertSame(0, $this->ba->getBalance());`
`756`	`756`	`}`
`757`	`757`	`}`
`758`	`758`
@@ -783,7 +783,7 @@ you can define a data set using the ``@testWith`` annotation.
`783`	`783`	`*/`
`784`	`784`	`public function testStringLength(string $input, int $expectedLength)`
`785`	`785`	`{`
`786`		`- $this->assertEquals($expectedLength, strlen($input));`
	`786`	`+ $this->assertSame($expectedLength, strlen($input));`
`787`	`787`	`}`
`788`	`788`
`789`	`789`	`.. _appendixes.annotations.ticket:`
Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ shows an example.`
`216`	`216`	`*/`
`217`	`217`	`public function testBalanceIsInitiallyZero()`
`218`	`218`	`{`
`219`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`219`	`+ $this->assertSame(0, $this->ba->getBalance());`
`220`	`220`	`}`
`221`	`221`
`222`	`222`	`/**`
`@@ -229,7 +229,7 @@ shows an example.`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`catch (BankAccountException $e) {`
`232`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`232`	`+ $this->assertSame(0, $this->ba->getBalance());`
`233`	`233`
`234`	`234`	`return;`
`235`	`235`	`}`
`@@ -247,7 +247,7 @@ shows an example.`
`247`	`247`	`}`
`248`	`248`
`249`	`249`	`catch (BankAccountException $e) {`
`250`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`250`	`+ $this->assertSame(0, $this->ba->getBalance());`
`251`	`251`
`252`	`252`	`return;`
`253`	`253`	`}`
`@@ -262,11 +262,11 @@ shows an example.`
`262`	`262`	`*/`
`263`	`263`	`public function testDepositWithdrawMoney()`
`264`	`264`	`{`
`265`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`265`	`+ $this->assertSame(0, $this->ba->getBalance());`
`266`	`266`	`$this->ba->depositMoney(1);`
`267`		`- $this->assertEquals(1, $this->ba->getBalance());`
	`267`	`+ $this->assertSame(1, $this->ba->getBalance());`
`268`	`268`	`$this->ba->withdrawMoney(1);`
`269`		`- $this->assertEquals(0, $this->ba->getBalance());`
	`269`	`+ $this->assertSame(0, $this->ba->getBalance());`
`270`	`270`	`}`
`271`	`271`	`}`
`272`	`272`	`?>`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ following way:`
`206`	`206`	`{`
`207`	`207`	`public function testCalculate()`
`208`	`208`	`{`
`209`		`- $this->assertEquals(2, 1 + 1);`
	`209`	`+ $this->assertSame(2, 1 + 1);`
`210`	`210`	`}`
`211`	`211`	`}`
`212`	`212`	`?>`
`@@ -1340,7 +1340,7 @@ which has to be returned from the`
`1340`	`1340`
`1341`	`1341`	`public function testGetRowCount()`
`1342`	`1342`	`{`
`1343`		`- $this->assertEquals(2, $this->getConnection()->getRowCount('guestbook'));`
	`1343`	`+ $this->assertSame(2, $this->getConnection()->getRowCount('guestbook'));`
`1344`	`1344`	`}`
`1345`	`1345`	`}`
`1346`	`1346`	`?>`
`@@ -1379,12 +1379,12 @@ examples, but a third one:`
`1379`	`1379`
`1380`	`1380`	`public function testAddEntry()`
`1381`	`1381`	`{`
`1382`		`- $this->assertEquals(2, $this->getConnection()->getRowCount('guestbook'), "Pre-Condition");`
	`1382`	`+ $this->assertSame(2, $this->getConnection()->getRowCount('guestbook'), "Pre-Condition");`
`1383`	`1383`
`1384`	`1384`	`$guestbook = new Guestbook();`
`1385`	`1385`	`$guestbook->addEntry("suzy", "Hello world!");`
`1386`	`1386`
`1387`		`- $this->assertEquals(3, $this->getConnection()->getRowCount('guestbook'), "Inserting failed");`
	`1387`	`+ $this->assertSame(3, $this->getConnection()->getRowCount('guestbook'), "Inserting failed");`
`1388`	`1388`	`}`
`1389`	`1389`	`}`
`1390`	`1390`	`?>`
Original file line number	Diff line number	Diff line change
@@ -40,7 +40,7 @@ creation of the ``array`` fixture into the
`40`	`40`	``setUp()`` method. Finally, we remove the redundant code
`41`	`41`	`from the test methods and use the newly introduced instance variable,`
`42`	`42`	``$this->stack``, instead of the method-local variable
`43`		-``$stack`` with the ``assertEquals()``
	`43`	+``$stack`` with the ``assertSame()``
`44`	`44`	`assertion method.`
`45`	`45`
`46`	`46`	`.. code-block:: php`
`@@ -67,14 +67,14 @@ assertion method.`
`67`	`67`	`public function testPush()`
`68`	`68`	`{`
`69`	`69`	`array_push($this->stack, 'foo');`
`70`		`- $this->assertEquals('foo', $this->stack[count($this->stack)-1]);`
	`70`	`+ $this->assertSame('foo', $this->stack[count($this->stack)-1]);`
`71`	`71`	`$this->assertFalse(empty($this->stack));`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`public function testPop()`
`75`	`75`	`{`
`76`	`76`	`array_push($this->stack, 'foo');`
`77`		`- $this->assertEquals('foo', array_pop($this->stack));`
	`77`	`+ $this->assertSame('foo', array_pop($this->stack));`
`78`	`78`	`$this->assertTrue(empty($this->stack));`
`79`	`79`	`}`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ the example. This leads to more readable and "fluent" code.`
`113`	`113`
`114`	`114`	`// Calling $stub->doSomething() will now return`
`115`	`115`	`// 'foo'.`
`116`		`- $this->assertEquals('foo', $stub->doSomething());`
	`116`	`+ $this->assertSame('foo', $stub->doSomething());`
`117`	`117`	`}`
`118`	`118`	`}`
`119`	`119`	`?>`
@@ -146,7 +146,7 @@ the same best practice defaults used by ``createMock()``.
`146`	`146`	`public function testStub()`
`147`	`147`	`{`
`148`	`148`	`// Create a stub for the SomeClass class.`
`149`		`- $stub = $this->getMockBuilder($originalClassName)`
	`149`	`+ $stub = $this->getMockBuilder(SomeClass::class)`
`150`	`150`	`->disableOriginalConstructor()`
`151`	`151`	`->disableOriginalClone()`
`152`	`152`	`->disableArgumentCloning()`
@@ -159,7 +159,7 @@ the same best practice defaults used by ``createMock()``.
`159`	`159`
`160`	`160`	`// Calling $stub->doSomething() will now return`
`161`	`161`	`// 'foo'.`
`162`		`- $this->assertEquals('foo', $stub->doSomething());`
	`162`	`+ $this->assertSame('foo', $stub->doSomething());`
`163`	`163`	`}`
`164`	`164`	`}`
`165`	`165`	`?>`
@@ -194,10 +194,10 @@ can achieve this using ``returnArgument()`` instead of
`194`	`194`	`->will($this->returnArgument(0));`
`195`	`195`
`196`	`196`	`// $stub->doSomething('foo') returns 'foo'`
`197`		`- $this->assertEquals('foo', $stub->doSomething('foo'));`
	`197`	`+ $this->assertSame('foo', $stub->doSomething('foo'));`
`198`	`198`
`199`	`199`	`// $stub->doSomething('bar') returns 'bar'`
`200`		`- $this->assertEquals('bar', $stub->doSomething('bar'));`
	`200`	`+ $this->assertSame('bar', $stub->doSomething('bar'));`
`201`	`201`	`}`
`202`	`202`	`}`
`203`	`203`	`?>`
`@@ -264,8 +264,8 @@ an example.`
`264`	`264`
`265`	`265`	`// $stub->doSomething() returns different values depending on`
`266`	`266`	`// the provided arguments.`
`267`		`- $this->assertEquals('d', $stub->doSomething('a', 'b', 'c'));`
`268`		`- $this->assertEquals('h', $stub->doSomething('e', 'f', 'g'));`
	`267`	`+ $this->assertSame('d', $stub->doSomething('a', 'b', 'c'));`
	`268`	`+ $this->assertSame('h', $stub->doSomething('e', 'f', 'g'));`
`269`	`269`	`}`
`270`	`270`	`}`
`271`	`271`	`?>`
`@@ -296,7 +296,7 @@ result of a callback function or method. See`
`296`	`296`	`->will($this->returnCallback('str_rot13'));`
`297`	`297`
`298`	`298`	`// $stub->doSomething($argument) returns str_rot13($argument)`
`299`		`- $this->assertEquals('fbzrguvat', $stub->doSomething('something'));`
	`299`	`+ $this->assertSame('fbzrguvat', $stub->doSomething('something'));`
`300`	`300`	`}`
`301`	`301`	`}`
`302`	`302`	`?>`
`@@ -326,9 +326,9 @@ an example.`
`326`	`326`	`->will($this->onConsecutiveCalls(2, 3, 5, 7));`
`327`	`327`
`328`	`328`	`// $stub->doSomething() returns a different value each time`
`329`		`- $this->assertEquals(2, $stub->doSomething());`
`330`		`- $this->assertEquals(3, $stub->doSomething());`
`331`		`- $this->assertEquals(5, $stub->doSomething());`
	`329`	`+ $this->assertSame(2, $stub->doSomething());`
	`330`	`+ $this->assertSame(3, $stub->doSomething());`
	`331`	`+ $this->assertSame(5, $stub->doSomething());`
`332`	`332`	`}`
`333`	`333`	`}`
`334`	`334`	`?>`