class UrlBagTest in Mini site 8

Class UrlBagTest.

Tests URL bag.

@group minisite

@package Drupal\testmode\Tests

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\minisite\Kernel\UrlBagTest uses MockHelperTrait

Expanded class hierarchy of UrlBagTest

File

tests/src/Kernel/UrlBagTest.php, line 19

Namespace

Drupal\Tests\minisite\Kernel

View source

class UrlBagTest extends KernelTestBase {
  use MockHelperTrait;

  /**
   * Tests toLocal() method.
   *
   * @dataProvider dataProviderToLocal
   * @covers \Drupal\minisite\UrlBag::toLocal
   */
  public function testToLocal($base_url, $url, $expected, $expect_exception = FALSE) {
    if ($expect_exception) {
      $this
        ->expectException(UrlBagException::class);
    }
    $actual = $this
      ->callProtectedMethod(UrlBag::class, 'toLocal', [
      $url,
      $base_url,
    ]);
    $this
      ->assertEquals($expected, $actual);
  }

  /**
   * Data provider for testToLocal.
   */
  public function dataProviderToLocal() {
    return [
      [
        'http://example.com',
        'http://example.com/page1',
        '/page1',
      ],
      [
        'http://example.com',
        'http://example.com/sub/path/page1',
        '/sub/path/page1',
      ],
      [
        'http://example.com',
        '/page1',
        '/page1',
      ],
      [
        'http://example.com',
        '/sub/path/page1',
        '/sub/path/page1',
      ],
      [
        'http://example.com',
        'page1',
        '/page1',
      ],
      [
        'http://example.com',
        'subpath/page1',
        '/subpath/page1',
      ],
      [
        'http://example.com',
        'http://otherexample.com/page1',
        '',
        TRUE,
      ],
      [
        'http://example.com',
        'http://otherexample.com',
        '',
        TRUE,
      ],
      [
        'http://example.com',
        'http://example.com',
        '',
        TRUE,
      ],
      // File.
      [
        'http://example.com',
        'public://page1',
        'public://page1',
      ],
      [
        'http://example.com/hostpath',
        'public://page1',
        'public://page1',
      ],
      // Base URL is a subdir.
      [
        'http://example.com/subdir',
        '/page1',
        '/page1',
      ],
      [
        'http://example.com/subdir',
        'page1',
        '/page1',
      ],
      [
        'http://example.com/subdir',
        '/pagesub/page1',
        '/pagesub/page1',
      ],
      [
        'http://example.com/subdir',
        'http://example.com/subdir/pagesub/page1',
        '/pagesub/page1',
      ],
    ];
  }

  /**
   * Tests toAbsolute() method.
   *
   * @dataProvider dataProviderToAbsolute
   * @covers \Drupal\minisite\UrlBag::toAbsolute
   */
  public function testToAbsolute($base_url, $url, $expected, $expect_exception = FALSE) {
    if ($expect_exception) {
      $this
        ->expectException(UrlBagException::class);
    }
    $actual = $this
      ->callProtectedMethod(UrlBag::class, 'toAbsolute', [
      $url,
      $base_url,
    ]);
    $this
      ->assertEquals($expected, $actual);
  }

  /**
   * Data provider for testToAbsolute.
   */
  public function dataProviderToAbsolute() {
    return [
      [
        'http://example.com',
        'http://example.com',
        'http://example.com',
      ],
      [
        'http://example.com',
        'http://example.com/page1.html',
        'http://example.com/page1.html',
      ],
      [
        'http://example.com',
        'http://otherdomain.com/page1.html',
        'http://otherdomain.com/page1.html',
      ],
      [
        'http://example.com',
        'page1.html',
        'http://example.com/page1.html',
      ],
      [
        'http://example.com',
        'subpath/page1.html',
        'http://example.com/subpath/page1.html',
      ],
      [
        'http://example.com',
        '/page1.html',
        'http://example.com/page1.html',
      ],
      [
        'http://example.com',
        '/subpath/page1.html',
        'http://example.com/subpath/page1.html',
      ],
    ];
  }

  /**
   * Tests getUriPart() method.
   *
   * @dataProvider dataProviderGetUriPart
   * @covers \Drupal\minisite\UrlBag::getUriPart
   */
  public function testGetUriPart($uri, $part_name, $expected, $expect_exception = FALSE) {
    if ($expect_exception) {
      $this
        ->expectException(UrlBagException::class);
    }
    $actual = $this
      ->callProtectedMethod(UrlBag::class, 'getUriPart', [
      $uri,
      $part_name,
    ]);
    $this
      ->assertEquals($expected, $actual);
  }

  /**
   * Data provider for getUriPart.
   */
  public function dataProviderGetUriPart() {
    return [
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file',
        UrlBag::URI_PART_ASSET_DIR,
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5',
        UrlBag::URI_PART_ASSET_DIR,
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a',
        UrlBag::URI_PART_ASSET_DIR,
        NULL,
        TRUE,
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file',
        UrlBag::URI_PART_ROOT_ARCHIVE_DIR,
        'subpath',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file/',
        UrlBag::URI_PART_ROOT_ARCHIVE_DIR,
        'subpath',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a/subpath/file/',
        UrlBag::URI_PART_ROOT_ARCHIVE_DIR,
        NULL,
        TRUE,
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file',
        UrlBag::URI_PART_PATH_IN_ARCHIVE,
        'file',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/second/file',
        UrlBag::URI_PART_PATH_IN_ARCHIVE,
        'second/file',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/second/third/file',
        UrlBag::URI_PART_PATH_IN_ARCHIVE,
        'second/third/file',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file/',
        UrlBag::URI_PART_PATH_IN_ARCHIVE,
        'file',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a/subpath/file/',
        UrlBag::URI_PART_PATH_IN_ARCHIVE,
        NULL,
        TRUE,
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file.txt',
        UrlBag::URI_PART_BASENAME,
        'file.txt',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/subpath/file/',
        UrlBag::URI_PART_BASENAME,
        'file',
      ],
      [
        'public://minisite/static/24c22dd1-2cf1-47ae-ac8a/subpath/file/',
        UrlBag::URI_PART_BASENAME,
        NULL,
        TRUE,
      ],
    ];
  }

  /**
   * Test getter functions.
   */
  public function testGetters() {
    $bag = new UrlBag('public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/rootpath/subpath/file.txt', 'http://example.com');
    $this
      ->assertEquals('http://example.com', $bag
      ->getBaseUrl());
    $this
      ->assertEquals('public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/rootpath/subpath/file.txt', $bag
      ->getUri());
    $this
      ->assertEquals('rootpath', $bag
      ->getRootDir());
    $this
      ->assertEquals('subpath/file.txt', $bag
      ->getPathInArchive());

    // Relative URL will be within VFS.
    $this
      ->assertContains('files/minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/rootpath/subpath/file.txt', $bag
      ->getUrl());

    // Can only test absolute URLs with partial matching.
    $this
      ->assertContains('files/minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/rootpath/subpath/file.txt', $bag
      ->getUrlAbsolute());
    $this
      ->assertNull($bag
      ->getAlias());
    $this
      ->assertNull($bag
      ->getAliasAbsolute());
    $this
      ->assertNull($bag
      ->getParentAlias());
    $this
      ->assertNull($bag
      ->getParentAliasAbsolute());

    // With parent alias.
    $bag
      ->setParentAlias('/parent/alias');
    $this
      ->assertEquals('/parent/alias/rootpath/subpath/file.txt', $bag
      ->getAlias());
    $this
      ->assertContains('/parent/alias/rootpath/subpath/file.txt', $bag
      ->getAliasAbsolute());
    $this
      ->assertEquals('/parent/alias', $bag
      ->getParentAlias());
    $this
      ->assertContains('/parent/alias', $bag
      ->getParentAliasAbsolute());
    $this
      ->assertNotContains('rootpath/subpath/file.txt', $bag
      ->getParentAlias());
    $this
      ->assertNotContains('rootpath/subpath/file.txt', $bag
      ->getParentAliasAbsolute());

    // Same as above, but with alias set. Need a new bag to test cleanly.
    $bag = new UrlBag('public://minisite/static/24c22dd1-2cf1-47ae-ac8a-23a7ff8b86c5/rootpath/subpath/file.txt', 'http://example.com');

    // With alias autodiscovery.
    $bag
      ->setAlias('/parent/alias/rootpath/subpath/file.txt');
    $this
      ->assertEquals('/parent/alias/rootpath/subpath/file.txt', $bag
      ->getAlias());
    $this
      ->assertContains('/parent/alias/rootpath/subpath/file.txt', $bag
      ->getAliasAbsolute());
    $this
      ->assertEquals('/parent/alias', $bag
      ->getParentAlias());
    $this
      ->assertContains('/parent/alias', $bag
      ->getParentAliasAbsolute());
    $this
      ->assertNotContains('rootpath/subpath/file.txt', $bag
      ->getParentAlias());
    $this
      ->assertNotContains('rootpath/subpath/file.txt', $bag
      ->getParentAliasAbsolute());
  }

}

Members

Name	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.
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::$modules	protected static	property	Modules to enable.	464
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::setUp	protected	function		347
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.
MockHelperTrait::callProtectedMethod	protected static	function	Call protected methods on the class.
MockHelperTrait::getProtectedValue	protected static	function	Get protected value from the object.
MockHelperTrait::isDebug	protected	function	Check if testing framework was ran with --debug option.
MockHelperTrait::prepareMock	protected	function	Helper to prepare class mock.
MockHelperTrait::setProtectedValue	protected static	function	Set protected property value.
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.
UrlBagTest::dataProviderGetUriPart	public	function	Data provider for getUriPart.
UrlBagTest::dataProviderToAbsolute	public	function	Data provider for testToAbsolute.
UrlBagTest::dataProviderToLocal	public	function	Data provider for testToLocal.
UrlBagTest::testGetters	public	function	Test getter functions.
UrlBagTest::testGetUriPart	public	function	Tests getUriPart() method.
UrlBagTest::testToAbsolute	public	function	Tests toAbsolute() method.
UrlBagTest::testToLocal	public	function	Tests toLocal() method.

You are here

class UrlBagTest in Mini site 8

Hierarchy

File

Namespace

Members

API Navigation