CS, updated controller test for testing_example

Author: paul-m

testing_example/src/Controller/ContrivedController.php

@@ -40,6 +40,7 @@ public function __construct(TranslationInterface $translation) {
    *   A parameter to the controller path.
    * @param int $second
    *   A parameter to the controller path.
+   *
    * @return string[]
    *   A markup array.
    */
@@ -61,11 +62,11 @@ public function displayAddedNumbers($first, $second) {
    *   The translated message.
    */
   protected function handCount($first, $second) {
-    $sum = abs($this->add((int)$first, (int)$second));
+    $sum = abs($this->add((int) $first, (int) $second));
     if ($sum <= 5) {
       $message = $this->t('I can count these on one hand.');
     }
-    else if ($sum <= 10) {
+    elseif ($sum <= 10) {
       $message = $this->t('I need two hands to count these.');
     }
     else {
@@ -89,4 +90,4 @@ protected function add($first, $second) {
     return $first + $second;
   }
 
-}
+}

testing_example/tests/src/Unit/Controller/ContrivedControllerTest.php

@@ -10,10 +10,13 @@
  */
 class ContrivedControllerTest extends UnitTestCase {
 
+  /**
+   * Data provider for testAdd().
+   */
   public function provideTestAdd() {
     return [
       [4, 2, 2],
-      [0, NULL, '']
+      [0, NULL, ''],
     ];
   }
 
@@ -29,4 +32,76 @@ public function testAdd($expected, $first, $second) {
     $this->assertEquals($expected, $ref_add->invokeArgs($controller, [$first, $second]));
   }
 
+  /**
+   * Data provider for testHandCount().
+   */
+  public function provideTestHandCount() {
+    return [
+      ['I can count these on one hand.', 0, 0],
+      ['I can count these on one hand.', 1, 0],
+      ['I can count these on one hand.', 0, 1],
+      ['I need two hands to count these.', 5, 5],
+      ['That\'s just too many numbers to count.', 5, 6],
+      ['That\'s just too many numbers to count.', 6, 5],
+    ];
+  }
+
+  /**
+   * @dataProvider provideTestHandCount
+   */
+  public function testHandCount($expected, $first, $second) {
+    // Get a mock translation service.
+    $mock_translation = $this->getStringTranslationStub();
+    // Create a new controller with our mocked translation service.
+    $controller = new ContrivedController($mock_translation);
+
+    // Set up a reflection for handCount().
+    $ref_hand_count = new \ReflectionMethod($controller, 'handCount');
+    // Set handCount() to be public.
+    $ref_hand_count->setAccessible(TRUE);
+    // Check out whether handCount() meets our expectation.
+    $message = $ref_hand_count->invokeArgs($controller, [$first, $second]);
+    $this->assertEquals($expected, (string) $message);
+  }
+
+  /**
+   * Data provider for testHandCountIsolated().
+   */
+  public function providerTestHandCountIsolated() {
+    return [
+      ['I can count these on one hand.', 0],
+      ['I can count these on one hand.', 5],
+      ['I need two hands to count these.', 10],
+      ['That\'s just too many numbers to count.', 11],
+    ];
+  }
+
+  /**
+   * @dataProvider providerTestHandCountIsolated
+   */
+  public function testHandCountIsolated($expected, $sum) {
+    // Mock a ContrivedController, using a mocked translation service.
+    $controller = $this->getMockBuilder(ContrivedController::class)
+      ->setConstructorArgs([$this->getStringTranslationStub()])
+      // Specify that we'll also mock add().
+      ->setMethods(['add'])
+      ->getMock();
+
+    // Mock add() so that it returns our $sum when it's called with (0,0).
+    $controller->expects($this->once())
+      ->method('add')
+      ->with($this->equalTo(0), $this->equalTo(0))
+      ->willReturn($sum);
+
+    // Use reflection to make handCount() public.
+    $ref_hand_count = new \ReflectionMethod($controller, 'handCount');
+    $ref_hand_count->setAccessible(TRUE);
+
+    // Invoke handCount().
+    $message = (string) $ref_hand_count->invokeArgs($controller, [0, 0]);
+
+    // Assert our expectations.
+    $this->assertEquals($expected, $message);
+  }
+
 }