Expanding testing_example for tutorial support

Author: paul-m

testing_example/src/Controller/ContrivedController.php

@@ -0,0 +1,92 @@
+<?php
+
+namespace Drupal\testing_example\Controller;
+
+use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\Core\StringTranslation\TranslationInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * A highly-contrived controller class used to demonstrate unit testing.
+ */
+class ContrivedController implements ContainerInjectionInterface {
+
+  use StringTranslationTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('string_translation')
+    );
+  }
+
+  /**
+   * Construct a new controller.
+   *
+   * @param Drupal\Core\StringTranslation\TranslationInterface $translation
+   *   The translation service.
+   */
+  public function __construct(TranslationInterface $translation) {
+    $this->setStringTranslation($translation);
+  }
+
+  /**
+   * A controller method which displays a sum in terms of hands.
+   *
+   * @param int $first
+   *   A parameter to the controller path.
+   * @param int $second
+   *   A parameter to the controller path.
+   * @return string[]
+   *   A markup array.
+   */
+  public function displayAddedNumbers($first, $second) {
+    return [
+      '#markup' => '<p>' . $this->handCount($first, $second) . '</p>',
+    ];
+  }
+
+  /**
+   * Generate a message based on how many hands are needed to count the sum.
+   *
+   * @param int $first
+   *   First parameter.
+   * @param int $second
+   *   Second parameter.
+   *
+   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
+   *   The translated message.
+   */
+  protected function handCount($first, $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) {
+      $message = $this->t('I need two hands to count these.');
+    }
+    else {
+      $message = $this->t("That's just too many numbers to count.");
+    }
+    return $message;
+  }
+
+  /**
+   * Add two numbers.
+   *
+   * @param int $first
+   *   The first parameter.
+   * @param int $second
+   *   The second parameter.
+   *
+   * @return int
+   *   The sum of the two parameters.
+   */
+  protected function add($first, $second) {
+    return $first + $second;
+  }
+
+}

testing_example/testing_example.links.menu.yml

@@ -1,3 +1,8 @@
 testing_example.description:
   title: Testing Example
   route_name: testing_example.description
+  expanded: TRUE
+testing_example.sum_in_hands:
+  title: Sum In Hands
+  route_name: testing_example.sum_in_hands
+  parent: testing_example.description

testing_example/testing_example.routing.yml

@@ -1,7 +1,19 @@
-# testing_example only has one route. It is to a page explaining the module.
+# This route is to a page explaining the module.
 testing_example.description:
   path: 'examples/testing-example'
   defaults:
     _controller: '\Drupal\testing_example\Controller\TestingExampleController::description'
   requirements:
     _permission: 'access content'
+# This route displays a sum of two numbers in terms of how many hands are
+# required to count it.
+testing_example.sum_in_hands:
+  path: 'examples/testing-example/sum-in-hands/{first}/{second}'
+  defaults:
+    _controller: '\Drupal\testing_example\Controller\ContrivedController::displayAddedNumbers'
+    first: 23
+    second: 77
+  requirements:
+    _permission: 'access content'
+    first: '^[0-9]+'
+    second: '^[0-9]+'

testing_example/tests/src/Functional/FrontPageLinkBonusPointsTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Drupal\Tests\testing_example\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Tests core menu behavior.
+ *
+ * This test uses BrowserTestBase to set up a fixture site so that we can test
+ * for the existence of the 'Add content' link normally provided by the Standard
+ * profile.
+ *
+ * The 'bonus points' are a reward for the effort to explicitly build up the
+ * dependencies, rather than simply using the Standard profile.
+ *
+ * This test is meant to support a Drupalize.me tutorial.
+ *
+ * @group testing_example
+ *
+ * @see Drupal\Tests\testing_example\Functional\FrontPageLinkTest
+ */
+class FrontPageLinkBonusPointsTest extends BrowserTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['node', 'block', 'user'];
+
+  /**
+   * Our node type.
+   *
+   * @var \Drupal\node\Entity\NodeType
+   */
+  protected $contentType;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    // Always call the parent setUp().
+    parent::setUp();
+    // Add the Tools menu block, as provided by the Block module.
+    $this->placeBlock('system_menu_block:tools');
+    // Add a content type.
+    $this->contentType = $this->createContentType();
+  }
+
+  /**
+   * Tests for the existence of a default menu item on the home page.
+   *
+   * We'll open the home page and look for the Tools menu link called 'Add
+   * content.'
+   */
+  public function testAddContentMenuItem() {
+    // Step 1: Log in a user who can add content.
+    $this->drupalLogin(
+      $this->drupalCreateUser([
+        'create ' . $this->contentType->id() . ' content',
+      ])
+    );
+
+    // Step 2: Visit the home path.
+    $this->drupalGet($this->buildUrl(''));
+    // Step 3: Look on the page for the 'Add content' link.
+    $this->assertSession()->linkExists('Add content');
+  }
+
+}

testing_example/tests/src/Functional/FrontPageLinkTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Drupal\Tests\testing_example\Functional;
+
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Tests core menu behavior.
+ *
+ * This test is meant to support a Drupalize.me tutorial.
+ *
+ * @group testing_example
+ *
+ * @see Drupal\Tests\testing_example\Functional\FrontPageLinkBonusPointsTest
+ */
+class FrontPageLinkTest extends BrowserTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected $profile = 'standard';
+
+  /**
+   * Tests for the existence of a default menu item on the home page.
+   *
+   * We'll open the home page and look for the Tools menu link called 'Add
+   * content.'
+   */
+  public function testAddContentMenuItem() {
+    // Step 1: Log in a user who can add content.
+    $this->drupalLogin(
+      $this->drupalCreateUser([
+        'create article content',
+      ])
+    );
+
+    // Step 2: Visit the home path.
+    $this->drupalGet($this->buildUrl(''));
+    // Step 3: Look on the page for the 'Add content' link.
+    $this->assertSession()->linkExists('Add content');
+  }
+
+}

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

@@ -0,0 +1,32 @@
+<?php
+
+namespace Drupal\Tests\testing_example\Unit\Controller;
+
+use Drupal\Tests\UnitTestCase;
+use Drupal\testing_example\Controller\ContrivedController;
+
+/**
+ * @group testing_example
+ */
+class ContrivedControllerTest extends UnitTestCase {
+
+  public function provideTestAdd() {
+    return [
+      [4, 2, 2],
+      [0, NULL, '']
+    ];
+  }
+
+  /**
+   * @dataProvider provideTestAdd
+   */
+  public function testAdd($expected, $first, $second) {
+    $controller = $this->getMockBuilder(ContrivedController::class)
+      ->disableOriginalConstructor()
+      ->getMock();
+    $ref_add = new \ReflectionMethod($controller, 'add');
+    $ref_add->setAccessible(TRUE);
+    $this->assertEquals($expected, $ref_add->invokeArgs($controller, [$first, $second]));
+  }
+
+}