class ValidatorTest
Same name in other branches
- 9 core/modules/file/tests/src/Kernel/ValidatorTest.php \Drupal\Tests\file\Kernel\ValidatorTest
Tests the functions used to validate uploaded files.
@group file
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\AssertHelperTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpunitCompatibilityTrait
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase extends \Drupal\KernelTests\KernelTestBase
- class \Drupal\Tests\file\Kernel\ValidatorTest extends \Drupal\Tests\file\Kernel\FileManagedUnitTestBase
- class \Drupal\Tests\file\Kernel\FileManagedUnitTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of ValidatorTest
File
-
core/
modules/ file/ tests/ src/ Kernel/ ValidatorTest.php, line 12
Namespace
Drupal\Tests\file\KernelView source
class ValidatorTest extends FileManagedUnitTestBase {
/**
* An image file.
*
* @var \Drupal\file\FileInterface
*/
protected $image;
/**
* A file which is not an image.
*
* @var \Drupal\file\Entity\File
*/
protected $nonImage;
protected function setUp() {
parent::setUp();
$this->image = File::create();
$this->image
->setFileUri('core/misc/druplicon.png');
/** @var \Drupal\Core\File\FileSystemInterface $file_system */
$file_system = \Drupal::service('file_system');
$this->image
->setFilename($file_system->basename($this->image
->getFileUri()));
$this->nonImage = File::create();
$this->nonImage
->setFileUri('core/assets/vendor/jquery/jquery.min.js');
$this->nonImage
->setFilename($file_system->basename($this->nonImage
->getFileUri()));
}
/**
* Test the file_validate_extensions() function.
*/
public function testFileValidateExtensions() {
$file = File::create([
'filename' => 'asdf.txt',
]);
$errors = file_validate_extensions($file, 'asdf txt pork');
$this->assertCount(0, $errors, 'Valid extension accepted.');
$file->setFilename('asdf.txt');
$errors = file_validate_extensions($file, 'exe png');
$this->assertCount(1, $errors, 'Invalid extension blocked.');
}
/**
* This ensures a specific file is actually an image.
*/
public function testFileValidateIsImage() {
$this->assertFileExists($this->image
->getFileUri());
$errors = file_validate_is_image($this->image);
$this->assertCount(0, $errors, 'No error reported for our image file.');
$this->assertFileExists($this->nonImage
->getFileUri());
$errors = file_validate_is_image($this->nonImage);
$this->assertCount(1, $errors, 'An error reported for our non-image file.');
}
/**
* This ensures the resolution of a specific file is within bounds.
*
* The image will be resized if it's too large.
*/
public function testFileValidateImageResolution() {
// Non-images.
$errors = file_validate_image_resolution($this->nonImage);
$this->assertCount(0, $errors, 'Should not get any errors for a non-image file.');
$errors = file_validate_image_resolution($this->nonImage, '50x50', '100x100');
$this->assertCount(0, $errors, 'Do not check the resolution on non files.');
// Minimum size.
$errors = file_validate_image_resolution($this->image);
$this->assertCount(0, $errors, 'No errors for an image when there is no minimum or maximum resolution.');
$errors = file_validate_image_resolution($this->image, 0, '200x1');
$this->assertCount(1, $errors, 'Got an error for an image that was not wide enough.');
$errors = file_validate_image_resolution($this->image, 0, '1x200');
$this->assertCount(1, $errors, 'Got an error for an image that was not tall enough.');
$errors = file_validate_image_resolution($this->image, 0, '200x200');
$this->assertCount(1, $errors, 'Small images report an error.');
// Maximum size.
if ($this->container
->get('image.factory')
->getToolkitId()) {
// Copy the image so that the original doesn't get resized.
copy('core/misc/druplicon.png', 'temporary://druplicon.png');
$this->image
->setFileUri('temporary://druplicon.png');
$errors = file_validate_image_resolution($this->image, '10x5');
$this->assertCount(0, $errors, 'No errors should be reported when an oversized image can be scaled down.');
$image = $this->container
->get('image.factory')
->get($this->image
->getFileUri());
$this->assertTrue($image->getWidth() <= 10, 'Image scaled to correct width.', 'File');
$this->assertTrue($image->getHeight() <= 5, 'Image scaled to correct height.', 'File');
// Once again, now with negative width and height to force an error.
copy('core/misc/druplicon.png', 'temporary://druplicon.png');
$this->image
->setFileUri('temporary://druplicon.png');
$errors = file_validate_image_resolution($this->image, '-10x-5');
$this->assertCount(1, $errors, 'An error reported for an oversized image that can not be scaled down.');
\Drupal::service('file_system')->unlink('temporary://druplicon.png');
}
else {
// TODO: should check that the error is returned if no toolkit is available.
$errors = file_validate_image_resolution($this->image, '5x10');
$this->assertCount(1, $errors, 'Oversize images that cannot be scaled get an error.');
}
}
/**
* This will ensure the filename length is valid.
*/
public function testFileValidateNameLength() {
// Create a new file entity.
$file = File::create();
// Add a filename with an allowed length and test it.
$file->setFilename(str_repeat('x', 240));
$this->assertEqual(strlen($file->getFilename()), 240);
$errors = file_validate_name_length($file);
$this->assertCount(0, $errors, 'No errors reported for 240 length filename.');
// Add a filename with a length too long and test it.
$file->setFilename(str_repeat('x', 241));
$errors = file_validate_name_length($file);
$this->assertCount(1, $errors, 'An error reported for 241 length filename.');
// Add a filename with an empty string and test it.
$file->setFilename('');
$errors = file_validate_name_length($file);
$this->assertCount(1, $errors, 'An error reported for 0 length filename.');
}
/**
* Test file_validate_size().
*/
public function testFileValidateSize() {
// Create a file with a size of 1000 bytes, and quotas of only 1 byte.
$file = File::create([
'filesize' => 1000,
]);
$errors = file_validate_size($file, 0, 0);
$this->assertCount(0, $errors, 'No limits means no errors.');
$errors = file_validate_size($file, 1, 0);
$this->assertCount(1, $errors, 'Error for the file being over the limit.');
$errors = file_validate_size($file, 0, 1);
$this->assertCount(1, $errors, 'Error for the user being over their limit.');
$errors = file_validate_size($file, 1, 1);
$this->assertCount(2, $errors, 'Errors for both the file and their limit.');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | 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 | 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 | ||||
AssertLegacyTrait::assertEqual | protected | function | ||||
AssertLegacyTrait::assertIdentical | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | protected | function | ||||
AssertLegacyTrait::assertNotEqual | protected | function | ||||
AssertLegacyTrait::assertNotIdentical | protected | function | ||||
AssertLegacyTrait::pass | protected | function | ||||
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. | |||
FileManagedUnitTestBase::$modules | public static | property | Modules to enable. | Overrides KernelTestBase::$modules | ||
FileManagedUnitTestBase::assertDifferentFile | public | function | Asserts that two files are not the same by comparing the fid and filepath. | |||
FileManagedUnitTestBase::assertFileHookCalled | public | function | Assert that a hook_file_* hook was called a certain number of times. | |||
FileManagedUnitTestBase::assertFileHooksCalled | public | function | Assert that all of the specified hook_file_* hooks were called once, other values result in failure. |
|||
FileManagedUnitTestBase::assertFileUnchanged | public | function | Asserts that two files have the same values (except timestamp). | |||
FileManagedUnitTestBase::assertSameFile | public | function | Asserts that two files are the same by comparing the fid and filepath. | |||
FileManagedUnitTestBase::createFile | public | function | Create a file and save it to the files table and assert that it occurs correctly. |
|||
FileManagedUnitTestBase::createUri | public | function | Creates a file and returns its URI. | |||
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 | 5 | |||
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. | |||
ValidatorTest::$image | protected | property | An image file. | |||
ValidatorTest::$nonImage | protected | property | A file which is not an image. | |||
ValidatorTest::setUp | protected | function | Overrides FileManagedUnitTestBase::setUp | |||
ValidatorTest::testFileValidateExtensions | public | function | Test the file_validate_extensions() function. | |||
ValidatorTest::testFileValidateImageResolution | public | function | This ensures the resolution of a specific file is within bounds. | |||
ValidatorTest::testFileValidateIsImage | public | function | This ensures a specific file is actually an image. | |||
ValidatorTest::testFileValidateNameLength | public | function | This will ensure the filename length is valid. | |||
ValidatorTest::testFileValidateSize | public | function | Test file_validate_size(). |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.