You are here

Home » API reference » System stream wrapper 8 » ExtensionStreamTest.php

class ExtensionStreamTest in System stream wrapper 8

Tests system stream wrapper functions.

@group system_stream_wrapper

Hierarchy

Expanded class hierarchy of ExtensionStreamTest

File

tests/src/Kernel/File/ExtensionStreamTest.php, line 12

Namespace

Drupal\Tests\system_stream_wrapper\Kernel\File
View source 
class ExtensionStreamTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'system',
    'system_stream_wrapper',
    'file_test',
  ];

  /**
   * A list of extension stream wrappers keyed by scheme.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperInterface[]
   */
  protected $streamWrappers = [];

  /**
   * The base url for the current request.
   *
   * @var string
   */
  protected $baseUrl;

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();

    // Find the base url to be used later in tests.
    $this->baseUrl = $this->container
      ->get('request_stack')
      ->getCurrentRequest()
      ->getUriForPath(base_path());

    /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
    $stream_wrapper_manager = $this->container
      ->get('stream_wrapper_manager');

    // Get stream wrapper instances.
    foreach ([
      'module',
      'theme',
      'profile',
    ] as $scheme) {
      $this->streamWrappers[$scheme] = $stream_wrapper_manager
        ->getViaScheme($scheme);
    }

    /** @var \Drupal\Core\Extension\ThemeInstallerInterface $theme_installer */
    $theme_installer = $this->container
      ->get('theme_installer');

    // Install Bartik and Seven themes.
    $theme_installer
      ->install([
      'bartik',
      'seven',
    ]);
  }

  /**
   * Tests invalid stream uris.
   *
   * @param string $uri
   *   The URI being tested.
   *
   * @dataProvider providerInvalidUris
   */
  public function testInvalidStreamUri($uri) {

    // Set 'minimal' as installed profile for the purposes of this test.
    $this
      ->setInstallProfile('minimal');
    $this
      ->enableModules([
      'minimal',
    ]);
    $message = "\\InvalidArgumentException thrown on invalid uri {$uri}.";
    try {
      $this->streamWrappers['module']
        ->dirname($uri);
      $this
        ->fail($message);
    } catch (\InvalidArgumentException $e) {
      $this
        ->assertSame($e
        ->getMessage(), "Malformed uri parameter passed: {$uri}", $message);
    }
  }

  /**
   * Provides test cases for testInvalidStreamUri()
   *
   * @return array[]
   *   A list of urls to test.
   */
  public function providerInvalidUris() {
    return [
      [
        'invalid/uri',
      ],
      [
        'invalid_uri',
      ],
      [
        'module/invalid/uri',
      ],
      [
        'module/invalid_uri',
      ],
      [
        'module:invalid_uri',
      ],
      [
        'module::/invalid/uri',
      ],
      [
        'module::/invalid_uri',
      ],
      [
        'module//:invalid/uri',
      ],
      [
        'module//invalid_uri',
      ],
      [
        'module//invalid/uri',
      ],
    ];
  }

  /**
   * Test the extension stream wrapper methods.
   *
   * @param string $uri
   *   The uri to be tested.
   * @param string $dirname
   *   The expectation for dirname() method.
   * @param string $realpath
   *   The expectation for realpath() method.
   * @param string|\RuntimeException|\InvalidArgumentException $getExternalUrl
   *   The expectation for getExternalUrl() method.
   *
   * @dataProvider providerStreamWrapperMethods
   */
  public function testStreamWrapperMethods($uri, $dirname, $realpath, $getExternalUrl) {

    // Set 'minimal' as installed profile for the purposes of this test.
    $this
      ->setInstallProfile('minimal');
    $this
      ->enableModules([
      'minimal',
    ]);

    // Prefix realpath() expected value with Drupal root directory.
    $realpath = strpos($realpath, 'or is not') === FALSE ? DRUPAL_ROOT . $realpath : $realpath;

    // Prefix getExternalUrl() expected value with base url.
    $getExternalUrl = strpos($getExternalUrl, 'or is not') === FALSE ? "{$this->baseUrl}{$getExternalUrl}" : $getExternalUrl;
    $case = compact('dirname', 'realpath', 'getExternalUrl');
    foreach ($case as $method => $expected) {
      list($scheme, ) = explode('://', $uri);
      $this->streamWrappers[$scheme]
        ->setUri($uri);
      if (strpos($expected, 'or is not') !== FALSE) {

        /** @var \Exception $expected */
        $message = sprintf('Exception thrown: \\InvalidArgumentException("%s").', $expected);
        try {
          $this->streamWrappers[$scheme]
            ->{$method}();
          $this
            ->fail($message);
        } catch (\InvalidArgumentException $e) {
          $this
            ->assertSame($expected, $e
            ->getMessage(), $message);
        } catch (\RuntimeException $e) {
          $this
            ->assertSame($expected, $e
            ->getMessage(), $message);
        }
      }
      elseif (is_string($expected)) {
        $this
          ->assertSame($expected, $this->streamWrappers[$scheme]
          ->{$method}(), sprintf("%s failed", $method));
      }
    }
  }

  /**
   * Tests call of ::dirname() without setting a URI first.
   */
  public function testDirnameAsParameter() {

    // Set 'minimal' as installed profile for the purposes of this test.
    $this
      ->setInstallProfile('minimal');
    $this
      ->enableModules([
      'minimal',
    ]);
    $this
      ->assertEquals('module://system', $this->streamWrappers['module']
      ->dirname('module://system/system.admin.css'));
  }

  /**
   * Provides test cases for testStreamWrapperMethods().
   *
   * @return array[]
   *   A list of test cases. Each case consists of the following items:
   *   - The uri to be tested.
   *   - The result or the exception when running dirname() method.
   *   - The result or the exception when running realpath() method. The value
   *     is prefixed later, in the test method, with the Drupal root directory.
   *   - The result or the exception when running getExternalUrl() method. The
   *     value is prefixed later, in the test method, with the base url.
   */
  public function providerStreamWrapperMethods() {
    return [
      // Cases for module:// stream wrapper.
      [
        'module://system',
        'module://system',
        '/core/modules/system',
        'core/modules/system',
      ],
      [
        'module://system/css/system.admin.css',
        'module://system/css',
        '/core/modules/system/css/system.admin.css',
        'core/modules/system/css/system.admin.css',
      ],
      [
        'module://file_test/file_test.dummy.inc',
        'module://file_test',
        '/core/modules/file/tests/file_test/file_test.dummy.inc',
        'core/modules/file/tests/file_test/file_test.dummy.inc',
      ],
      [
        'module://file_test/src/file_test.dummy.inc',
        'module://file_test/src',
        '/core/modules/file/tests/file_test/src/file_test.dummy.inc',
        'core/modules/file/tests/file_test/src/file_test.dummy.inc',
      ],
      [
        'module://ckeditor/ckeditor.info.yml',
        'Module ckeditor does not exist or is not installed',
        'Module ckeditor does not exist or is not installed',
        'Module ckeditor does not exist or is not installed',
      ],
      [
        'module://foo_bar/foo.bar.js',
        'Module foo_bar does not exist or is not installed',
        'Module foo_bar does not exist or is not installed',
        'Module foo_bar does not exist or is not installed',
      ],
      // Cases for theme:// stream wrapper.
      [
        'theme://seven',
        'theme://seven',
        '/core/themes/seven',
        'core/themes/seven',
      ],
      [
        'theme://seven/style.css',
        'theme://seven',
        '/core/themes/seven/style.css',
        'core/themes/seven/style.css',
      ],
      [
        'theme://bartik/color/preview.js',
        'theme://bartik/color',
        '/core/themes/bartik/color/preview.js',
        'core/themes/bartik/color/preview.js',
      ],
      [
        'theme://fifteen/screenshot.png',
        'Theme fifteen does not exist or is not installed',
        'Theme fifteen does not exist or is not installed',
        'Theme fifteen does not exist or is not installed',
      ],
      [
        'theme://stark/stark.info.yml',
        'Theme stark does not exist or is not installed',
        'Theme stark does not exist or is not installed',
        'Theme stark does not exist or is not installed',
      ],
      // Cases for profile:// stream wrapper.
      [
        'profile://',
        'profile://',
        '/core/profiles/minimal',
        'core/profiles/minimal',
      ],
      [
        'profile://config/install/block.block.stark_login.yml',
        'profile://config/install',
        '/core/profiles/minimal/config/install/block.block.stark_login.yml',
        'core/profiles/minimal/config/install/block.block.stark_login.yml',
      ],
      [
        'profile://config/install/node.type.article.yml',
        'profile://config/install',
        '/core/profiles/minimal/config/install/node.type.article.yml',
        'core/profiles/minimal/config/install/node.type.article.yml',
      ],
      [
        'profile://minimal.info.yml',
        'profile://',
        '/core/profiles/minimal/minimal.info.yml',
        'core/profiles/minimal/minimal.info.yml',
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionStreamTest::$baseUrl protected property The base url for the current request.
ExtensionStreamTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ExtensionStreamTest::$streamWrappers protected property A list of extension stream wrappers keyed by scheme.
ExtensionStreamTest::providerInvalidUris public function Provides test cases for testInvalidStreamUri()
ExtensionStreamTest::providerStreamWrapperMethods public function Provides test cases for testStreamWrapperMethods().
ExtensionStreamTest::setUp public function Overrides KernelTestBase::setUp
ExtensionStreamTest::testDirnameAsParameter public function Tests call of ::dirname() without setting a URI first.
ExtensionStreamTest::testInvalidStreamUri public function Tests invalid stream uris.
ExtensionStreamTest::testStreamWrapperMethods public function Test the extension stream wrapper methods.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.