class ToolkitTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Image/ToolkitTest.php \Drupal\KernelTests\Core\Image\ToolkitTest
  2. 8.9.x core/tests/Drupal/FunctionalTests/Image/ToolkitTest.php \Drupal\FunctionalTests\Image\ToolkitTest
  3. 10 core/tests/Drupal/KernelTests/Core/Image/ToolkitTest.php \Drupal\KernelTests\Core\Image\ToolkitTest

Tests the image toolkit.

@group Image

Hierarchy

  • class \Drupal\KernelTests\Core\Image\ToolkitTest extends \Drupal\KernelTests\KernelTestBase uses \Drupal\Tests\Traits\Core\Image\ToolkitTestTrait

Expanded class hierarchy of ToolkitTest

File

core/tests/Drupal/KernelTests/Core/Image/ToolkitTest.php, line 18

Namespace

Drupal\KernelTests\Core\Image
View source
class ToolkitTest extends KernelTestBase {
    use ToolkitTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'image_test',
        'system',
    ];
    
    /**
     * Testing image.
     *
     * @var \Drupal\Core\Image\ImageInterface
     */
    protected $image;
    
    /**
     * The image effect plugin manager service.
     *
     * @var \Drupal\image\ImageEffectManager
     */
    protected ImageEffectManager $imageEffectPluginManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->image = $this->getImage();
        $this->imageTestReset();
    }
    
    /**
     * Tests that the toolkit manager only returns available toolkits.
     */
    public function testGetAvailableToolkits() : void {
        $manager = $this->container
            ->get('image.toolkit.manager');
        $toolkits = $manager->getAvailableToolkits();
        $this->assertArrayHasKey('test', $toolkits);
        $this->assertArrayHasKey('test:derived_toolkit', $toolkits);
        $this->assertArrayNotHasKey('broken', $toolkits);
        $this->assertToolkitOperationsCalled([]);
    }
    
    /**
     * Tests Image's methods.
     */
    public function testLoad() : void {
        $image = $this->getImage();
        $this->assertInstanceOf(ImageInterface::class, $image);
        $this->assertEquals('test', $image->getToolkitId());
        $this->assertToolkitOperationsCalled([
            'parseFile',
        ]);
    }
    
    /**
     * Tests the Image::save() function.
     */
    public function testSave() : void {
        $this->assertFalse($this->image
            ->save());
        $this->assertToolkitOperationsCalled([
            'save',
        ]);
    }
    
    /**
     * Tests the 'apply' method.
     */
    public function testApply() : void {
        $data = [
            'p1' => 1,
            'p2' => TRUE,
            'p3' => 'text',
        ];
        // The operation plugin itself does not exist, so apply will return false.
        $this->assertFalse($this->image
            ->apply('my_operation', $data));
        // Check that apply was called and with the correct parameters.
        $this->assertToolkitOperationsCalled([
            'apply',
        ]);
        $calls = $this->imageTestGetAllCalls();
        $this->assertEquals('my_operation', $calls['apply'][0][0]);
        $this->assertEquals(1, $calls['apply'][0][1]['p1']);
        $this->assertTrue($calls['apply'][0][1]['p2']);
        $this->assertEquals('text', $calls['apply'][0][1]['p3']);
    }
    
    /**
     * Tests the 'apply' method without parameters.
     */
    public function testApplyNoParameters() : void {
        // The operation plugin itself does not exist, so apply will return false.
        $this->assertFalse($this->image
            ->apply('my_operation'));
        // Check that apply was called and with the correct parameters.
        $this->assertToolkitOperationsCalled([
            'apply',
        ]);
        $calls = $this->imageTestGetAllCalls();
        $this->assertEquals('my_operation', $calls['apply'][0][0]);
        $this->assertSame([], $calls['apply'][0][1]);
    }
    
    /**
     * Tests image toolkit operations inheritance by derivative toolkits.
     */
    public function testDerivative() : void {
        $toolkit_manager = $this->container
            ->get('image.toolkit.manager');
        $operation_manager = $this->container
            ->get('image.toolkit.operation.manager');
        $toolkit = $toolkit_manager->createInstance('test:derived_toolkit');
        $this->assertInstanceOf(ImageToolkitInterface::class, $toolkit);
        // Load an overwritten and an inherited operation.
        $blur = $operation_manager->getToolkitOperation($toolkit, 'blur');
        $invert = $operation_manager->getToolkitOperation($toolkit, 'invert');
        // 'Blur' operation overwritten by derivative.
        $this->assertEquals('foo_derived', $blur->getPluginId());
        // "Invert" operation inherited from base plugin.
        $this->assertEquals('bar', $invert->getPluginId());
    }
    
    /**
     * Tests calling a failing image operation plugin.
     */
    public function testFailingOperation() : void {
        $this->assertFalse($this->image
            ->apply('failing'));
        // Check that apply was called and with the correct parameters.
        $this->assertToolkitOperationsCalled([
            'apply',
        ]);
        $calls = $this->imageTestGetAllCalls();
        $this->assertEquals('failing', $calls['apply'][0][0]);
        $this->assertSame([], $calls['apply'][0][1]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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::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.
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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
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 protected function Bootstraps a kernel for a test. 1
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. 2
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
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. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile protected static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ToolkitTest::$image protected property Testing image.
ToolkitTest::$imageEffectPluginManager protected property The image effect plugin manager service.
ToolkitTest::$modules protected static property Overrides KernelTestBase::$modules
ToolkitTest::setUp protected function Overrides KernelTestBase::setUp
ToolkitTest::testApply public function Tests the 'apply' method.
ToolkitTest::testApplyNoParameters public function Tests the 'apply' method without parameters.
ToolkitTest::testDerivative public function Tests image toolkit operations inheritance by derivative toolkits.
ToolkitTest::testFailingOperation public function Tests calling a failing image operation plugin.
ToolkitTest::testGetAvailableToolkits public function Tests that the toolkit manager only returns available toolkits.
ToolkitTest::testLoad public function Tests Image's methods.
ToolkitTest::testSave public function Tests the Image::save() function.
ToolkitTestTrait::assertImageEffect protected function Asserts the effect processing of an image effect plugin.
ToolkitTestTrait::assertToolkitOperationsCalled public function Assert that all of the specified image toolkit operations were called once.
ToolkitTestTrait::getImage protected function Sets up an image with the custom toolkit.
ToolkitTestTrait::imageTestGetAllCalls protected function Gets an array of calls to the 'test' toolkit.
ToolkitTestTrait::imageTestReset protected function Resets/initializes the history of calls to the test toolkit functions.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.