SkeletonTest.php in Examples for Developers 3.x

Namespace

Drupal\Tests\testing_example\Functional

File

modules/testing_example/tests/src/Functional/SkeletonTest.php

<?php

namespace Drupal\Tests\testing_example\Functional;


/**
 * How the namespace works.
 *
 * The namespace for functional tests follows the pattern
 * Drupal\Tests\[module name]\[test type]. Classes are discovered as PSR-4 under
 * the directory tests/src/.
 */

/**
 * We inherit from BrowserTestBase.
 *
 * Drupal functional tests use the BrowserTestBase base class. This installs a
 * full fixture Drupal which the test can then navigate and test against.
 */
use Drupal\Tests\BrowserTestBase;

/**
 * Skeleton functional test.
 *
 * This test shows you how you can add a failing test in order to make sure the
 * test you've set up is discovered by the test runners. The test is not
 * initially set up to fail. You have to modify the testFail() method to see the
 * fail.
 *
 * Each part of this test is required, and has comments explaining why it's
 * there.
 *
 * You can run this test using either phpunit or run-tests.sh. To use phpunit to
 * make sure the test is discovered, you can call it like this:
 *
 * @code
 * cd drupal/root
 * SIMPLETEST_BASE_URL=http://example.com/ ./vendor/bin/phpunit -c core/ --testsuite functional --filter SkeletonTest
 * @endcode
 *
 * For run-tests.sh:
 *
 * @code
 * cd drupal/root
 * php ./core/scripts/run-tests.sh --browser --url http://example.com --types PHPUnit-Functional testing_example
 * @endcode
 *
 * All tests must have a least one group annotation. run-tests.sh uses the first
 * one only.
 *
 * @group testing_example
 * @group examples
 *
 * @ingroup testing_example
 */
class SkeletonTest extends BrowserTestBase {

  /**
   * The theme to install as the default for testing.
   *
   * When using the default testing install profile we need to specify
   * which theme to use when running functional tests.
   *
   * For tests that do not rely on any specific markup, or at least not Drupal
   * core markup, use 'stark'. For tests that rely on core markup use 'stable'.
   *
   * @link https://www.drupal.org/node/3083055
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * Modules to install.
   *
   * This array of modules will be enabled when the fixture Drupal site is
   * built. We leave it empty here because this is a skeleton test. A typical
   * test will enable basic modules like node and user.
   *
   * @var string[]
   */
  public static $modules = [];

  /**
   * This test method fails, so we can be sure our test is discovered.
   */
  public function testFail() {

    // We comment out the fail assertion so that normal automated tests for
    // Examples don't fail. Uncomment the next line to see a fail.
    // $this->fail('The test runner found our test and failed it. Yay!');
    //
    // PHPUnit will complain if there is no assertion in our test method, so we
    // add this passing assertion. Comment or delete it if you'd like.
    $this
      ->assertTrue(TRUE);
  }

}

Classes

Name	Description
SkeletonTest	Skeleton functional test.