class FileUploadTest

Same name in this branch
  1. 11.x core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest
Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest
  2. 8.9.x core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest
  3. 10 core/modules/jsonapi/tests/src/Functional/FileUploadTest.php \Drupal\Tests\jsonapi\Functional\FileUploadTest
  4. 10 core/modules/jsonapi/tests/src/Kernel/Controller/FileUploadTest.php \Drupal\Tests\jsonapi\Kernel\Controller\FileUploadTest

@coversDefaultClass \Drupal\jsonapi\Controller\FileUpload @group jsonapi

Hierarchy

Expanded class hierarchy of FileUploadTest

File

core/modules/jsonapi/tests/src/Kernel/Controller/FileUploadTest.php, line 19

Namespace

Drupal\Tests\jsonapi\Kernel\Controller
View source
class FileUploadTest extends JsonapiKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'field',
        'jsonapi',
        'serialization',
        'system',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Add the entity schemas.
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        // Add the additional table schemas.
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installSchema('user', [
            'users_data',
        ]);
        NodeType::create([
            'type' => 'lorem',
            'name' => 'Lorem',
        ])->save();
        $type = NodeType::create([
            'type' => 'article',
            'name' => 'Article',
        ]);
        $type->save();
        $type = NodeType::create([
            'type' => 'page',
            'name' => 'Page',
        ]);
        $type->save();
        $this->createEntityReferenceField('node', 'article', 'field_relationships', 'Relationship', 'node', 'default', [
            'target_bundles' => [
                'article',
            ],
        ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        Role::create([
            'id' => 'article_editor',
            'label' => 'article editor',
            'permissions' => [
                'access content',
                'create article content',
                'edit any article content',
            ],
        ])->save();
        Role::create([
            'id' => 'page_editor',
            'label' => 'page editor',
            'permissions' => [
                'access content',
                'create page content',
                'edit any page content',
            ],
        ])->save();
        Role::create([
            'id' => 'editor',
            'label' => 'editor',
            'permissions' => [
                'bypass node access',
            ],
        ])->save();
    }
    
    /**
     * @covers ::checkFileUploadAccess
     */
    public function testCheckFileUploadAccessWithBaseField() : void {
        // Create a set of users for access testing.
        $article_editor = User::create([
            'name' => 'article editor',
            'mail' => 'article@localhost',
            'status' => 1,
            // Do not use UID 1 as that has access to everything.
'uid' => 2,
            'roles' => [
                'article_editor',
            ],
        ]);
        $page_editor = User::create([
            'name' => 'page editor',
            'mail' => 'page@localhost',
            'status' => 1,
            'uid' => 3,
            'roles' => [
                'page_editor',
            ],
        ]);
        $editor = User::create([
            'name' => 'editor',
            'mail' => 'editor@localhost',
            'status' => 1,
            'uid' => 3,
            'roles' => [
                'editor',
            ],
        ]);
        $no_access_user = User::create([
            'name' => 'no access',
            'mail' => 'user@localhost',
            'status' => 1,
            'uid' => 4,
        ]);
        // Create an entity to test access against.
        $node = Node::create([
            'title' => 'dummy_title',
            'type' => 'article',
            'uid' => 1,
        ]);
        // While the method is only used to check file fields it should work without
        // error for any field whether it is a base field or a bundle field.
        $base_field_definition = $this->container
            ->get('entity_field.manager')
            ->getBaseFieldDefinitions('node')['title'];
        $bundle_field_definition = $this->container
            ->get('entity_field.manager')
            ->getFieldDefinitions('node', 'article')['field_relationships'];
        // Tests the expected access result for each user.
        // The $article_editor account can edit any article.
        $result = FileUpload::checkFileUploadAccess($article_editor, $base_field_definition, $node);
        $this->assertTrue($result->isAllowed());
        // The article editor cannot create a node of undetermined type.
        $result = FileUpload::checkFileUploadAccess($article_editor, $base_field_definition);
        $this->assertFalse($result->isAllowed());
        // The article editor can edit any article.
        $result = FileUpload::checkFileUploadAccess($article_editor, $bundle_field_definition, $node);
        $this->assertTrue($result->isAllowed());
        // The article editor can create an article. The type can be determined
        // because the field is a bundle field.
        $result = FileUpload::checkFileUploadAccess($article_editor, $bundle_field_definition);
        $this->assertTrue($result->isAllowed());
        // The $editor account has the bypass node access permissions and can edit
        // and create all node types.
        $result = FileUpload::checkFileUploadAccess($editor, $base_field_definition, $node);
        $this->assertTrue($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($editor, $base_field_definition);
        $this->assertTrue($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($editor, $bundle_field_definition, $node);
        $this->assertTrue($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($editor, $bundle_field_definition);
        $this->assertTrue($result->isAllowed());
        // The $page_editor account can only edit and create pages therefore has no
        // access.
        $result = FileUpload::checkFileUploadAccess($page_editor, $base_field_definition, $node);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($page_editor, $base_field_definition);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($page_editor, $bundle_field_definition, $node);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($page_editor, $bundle_field_definition);
        $this->assertFalse($result->isAllowed());
        // The $no_access_user account has no access at all.
        $result = FileUpload::checkFileUploadAccess($no_access_user, $base_field_definition, $node);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($no_access_user, $base_field_definition);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($no_access_user, $bundle_field_definition, $node);
        $this->assertFalse($result->isAllowed());
        $result = FileUpload::checkFileUploadAccess($no_access_user, $bundle_field_definition);
        $this->assertFalse($result->isAllowed());
    }

}

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 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.
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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.
FileUploadTest::$modules protected static property Modules to install. Overrides JsonapiKernelTestBase::$modules
FileUploadTest::setUp protected function Overrides KernelTestBase::setUp
FileUploadTest::testCheckFileUploadAccessWithBaseField public function @covers ::checkFileUploadAccess
JsonapiKernelTestBase::createTextField protected function Creates a field of an entity reference field storage on the bundle.
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.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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