description.html.twig

{#

Description text for the PHPUnit Example.

#}

{% set sum_in_hands = path('testing_example.sum_in_hands') %}

{% trans %}
<h2>Testing Frameworks in Drupal</h2>

<p>This module <a href={{ sum_in_hands }}>provides a path</a> so we can test it.
    The path takes two numeric arguments, and tells you how many hands are
    required to count the sum of both numbers.</p>

<h3>How to use this example module</h3>
<p>You really should be reading the various docblocks in the files under
  <code>tests/src/</code>.</p>

<h3>How To:</h3>
<ul>
  <li>PHPUnit-based Drupal tests go in the <code>tests/src</code> directory, so
    they will not be loaded by the autoloader during normal bootstrap.
  </li>

  <li>Unit tests go in <code>[your_module]/tests/src/Unit</code>.</li>
  <li>Kernel tests go in <code>[your_module]/tests/src/Kernel</code>.</li>
  <li>Functional tests go in <code>[your_module]/tests/src/Functional</code>.</li>
</ul>

<table>
  <thead>
  <tr>
    <td><b>Type</b></td>
    <td><b>Location</b></td>
    <td><b>Namespace</b></td>
    <td><b>Subclass of</b></td>
  </tr>
  </thead>
  <tbody>
  <tr>
    <td>Unit test</td>
    <td>[your_module]/tests/src/Unit</td>
    <td>Drupal\Tests\[your_module]\Unit\</td>
    <td>Drupal\Tests\UnitTestCase</td>
  </tr>
  <tr>
    <td>Kernel test</td>
    <td>[your_module]/tests/src/Kernel</td>
    <td>Drupal\Tests\[your_module]\Kernel\</td>
    <td>Drupal\KernelTests\KernelTestBase</td>
  </tr>
  <tr>
    <td>Functional test</td>
    <td>[your_module]/tests/src/Functional</td>
    <td>Drupal\Tests\[your_module]\Functional\</td>
    <td>Drupal\Tests\BrowserTestBase</td>
  </tr>
  <tr>
    <td>FunctionalJavascript test</td>
    <td>[your_module]/tests/src/FunctionalJavascript</td>
    <td>Drupal\Tests\[your_module]\FunctionalJavascript\</td>
    <td>Drupal\FunctionalJavascriptTests\WebDriverTestBase</td>
  </tr>
  <tr>
    <td>Shared test traits</td>
    <td>[your_module]/tests/src/Traits</td>
    <td>Drupal\Tests\[your_module]\Traits\</td>
    <td>n/a</td>
  </tr>

  </tbody>
</table>

<h3>Standard PHPUnit Practices</h3>
<p>You can run PHPUnit from the command line or via the run-tests.sh command.</p>
<p>You can specify which type of test you're running via
  <pre><code>phpunit --testsuite</code></pre> and
  <pre><code>run-tests.sh --types</code><pre>.
<p>There are many options to phpunit, but, for instance, to run all of the
  testing_example phpunit tests, you could
<pre><code>./vendor/phpunit/phpunit/phpunit -c core/ ./modules/examples/testing_example</code></pre>
</p>

{% endtrans %}

File

modules/testing_example/templates/description.html.twig

View source 
  1. {#

  2. 

  3. Description text for the PHPUnit Example.

  4. 

  5. #}

  6. 

  7. {% set sum_in_hands = path('testing_example.sum_in_hands') %}

  8. 

  9. {% trans %}

  10. <h2>Testing Frameworks in Drupal</h2>

  11. 

  12. <p>This module <a href={{ sum_in_hands }}>provides a path</a> so we can test it.

  13.     The path takes two numeric arguments, and tells you how many hands are

  14.     required to count the sum of both numbers.</p>

  15. 

  16. <h3>How to use this example module</h3>

  17. <p>You really should be reading the various docblocks in the files under

  18.   <code>tests/src/</code>.</p>

  19. 

  20. <h3>How To:</h3>

  21. <ul>

  22.   <li>PHPUnit-based Drupal tests go in the <code>tests/src</code> directory, so

  23.     they will not be loaded by the autoloader during normal bootstrap.

  24.   </li>

  25. 

  26.   <li>Unit tests go in <code>[your_module]/tests/src/Unit</code>.</li>

  27.   <li>Kernel tests go in <code>[your_module]/tests/src/Kernel</code>.</li>

  28.   <li>Functional tests go in <code>[your_module]/tests/src/Functional</code>.</li>

  29. </ul>

  30. 

  31. <table>

  32.   <thead>

  33.   <tr>

  34.     <td><b>Type</b></td>

  35.     <td><b>Location</b></td>

  36.     <td><b>Namespace</b></td>

  37.     <td><b>Subclass of</b></td>

  38.   </tr>

  39.   </thead>

  40.   <tbody>

  41.   <tr>

  42.     <td>Unit test</td>

  43.     <td>[your_module]/tests/src/Unit</td>

  44.     <td>Drupal\Tests\[your_module]\Unit\</td>

  45.     <td>Drupal\Tests\UnitTestCase</td>

  46.   </tr>

  47.   <tr>

  48.     <td>Kernel test</td>

  49.     <td>[your_module]/tests/src/Kernel</td>

  50.     <td>Drupal\Tests\[your_module]\Kernel\</td>

  51.     <td>Drupal\KernelTests\KernelTestBase</td>

  52.   </tr>

  53.   <tr>

  54.     <td>Functional test</td>

  55.     <td>[your_module]/tests/src/Functional</td>

  56.     <td>Drupal\Tests\[your_module]\Functional\</td>

  57.     <td>Drupal\Tests\BrowserTestBase</td>

  58.   </tr>

  59.   <tr>

  60.     <td>FunctionalJavascript test</td>

  61.     <td>[your_module]/tests/src/FunctionalJavascript</td>

  62.     <td>Drupal\Tests\[your_module]\FunctionalJavascript\</td>

  63.     <td>Drupal\FunctionalJavascriptTests\WebDriverTestBase</td>

  64.   </tr>

  65.   <tr>

  66.     <td>Shared test traits</td>

  67.     <td>[your_module]/tests/src/Traits</td>

  68.     <td>Drupal\Tests\[your_module]\Traits\</td>

  69.     <td>n/a</td>

  70.   </tr>

  71. 

  72.   </tbody>

  73. </table>

  74. 

  75. <h3>Standard PHPUnit Practices</h3>

  76. <p>You can run PHPUnit from the command line or via the run-tests.sh command.</p>

  77. <p>You can specify which type of test you're running via

  78.   <pre><code>phpunit --testsuite</code></pre> and

  79.   <pre><code>run-tests.sh --types</code><pre>.

  80. <p>There are many options to phpunit, but, for instance, to run all of the

  81.   testing_example phpunit tests, you could

  82. <pre><code>./vendor/phpunit/phpunit/phpunit -c core/ ./modules/examples/testing_example</code></pre>

  83. </p>

  84. 

  85. {% endtrans %}