class EntityResourceTest

Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Kernel/Controller/EntityResourceTest.php \Drupal\Tests\jsonapi\Kernel\Controller\EntityResourceTest
  2. 10 core/modules/jsonapi/tests/src/Kernel/Controller/EntityResourceTest.php \Drupal\Tests\jsonapi\Kernel\Controller\EntityResourceTest
  3. 11.x core/modules/jsonapi/tests/src/Kernel/Controller/EntityResourceTest.php \Drupal\Tests\jsonapi\Kernel\Controller\EntityResourceTest

@coversDefaultClass \Drupal\jsonapi\Controller\EntityResource @group jsonapi

@internal

Hierarchy

Expanded class hierarchy of EntityResourceTest

File

core/modules/jsonapi/tests/src/Kernel/Controller/EntityResourceTest.php, line 24

Namespace

Drupal\Tests\jsonapi\Kernel\Controller
View source
class EntityResourceTest extends JsonapiKernelTestBase {
    
    /**
     * Static UUIDs to use in testing.
     *
     * @var array
     */
    protected static $nodeUuid = [
        1 => '83bc47ad-2c58-45e3-9136-abcdef111111',
        2 => '83bc47ad-2c58-45e3-9136-abcdef222222',
        3 => '83bc47ad-2c58-45e3-9136-abcdef333333',
        4 => '83bc47ad-2c58-45e3-9136-abcdef444444',
    ];
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'node',
        'field',
        'jsonapi',
        'serialization',
        'system',
        'user',
    ];
    
    /**
     * The user.
     *
     * @var \Drupal\user\Entity\User
     */
    protected $user;
    
    /**
     * The node.
     *
     * @var \Drupal\node\Entity\Node
     */
    protected $node;
    
    /**
     * The other node.
     *
     * @var \Drupal\node\Entity\Node
     */
    protected $node2;
    
    /**
     * An unpublished node.
     *
     * @var \Drupal\node\Entity\Node
     */
    protected $node3;
    
    /**
     * A fake request.
     *
     * @var \Symfony\Component\HttpFoundation\Request
     */
    protected $request;
    
    /**
     * The EntityResource under test.
     *
     * @var \Drupal\jsonapi\Controller\EntityResource
     */
    protected $entityResource;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        // Add the entity schemas.
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        // Add the additional table schemas.
        $this->installSchema('system', [
            'sequences',
        ]);
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installSchema('user', [
            'users_data',
        ]);
        NodeType::create([
            'type' => 'lorem',
        ])->save();
        $type = NodeType::create([
            'type' => 'article',
        ]);
        $type->save();
        $this->user = User::create([
            'name' => 'user1',
            'mail' => 'user@localhost',
            'status' => 1,
            'roles' => [
                'test_role_one',
                'test_role_two',
            ],
        ]);
        $this->createEntityReferenceField('node', 'article', 'field_relationships', 'Relationship', 'node', 'default', [
            'target_bundles' => [
                'article',
            ],
        ], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->user
            ->save();
        $this->node = Node::create([
            'title' => 'dummy_title',
            'type' => 'article',
            'uid' => $this->user
                ->id(),
            'uuid' => static::$nodeUuid[1],
        ]);
        $this->node
            ->save();
        $this->node2 = Node::create([
            'type' => 'article',
            'title' => 'Another test node',
            'uid' => $this->user
                ->id(),
            'uuid' => static::$nodeUuid[2],
        ]);
        $this->node2
            ->save();
        $this->node3 = Node::create([
            'type' => 'article',
            'title' => 'Unpublished test node',
            'uid' => $this->user
                ->id(),
            'status' => 0,
            'uuid' => static::$nodeUuid[3],
        ]);
        $this->node3
            ->save();
        $this->node4 = Node::create([
            'type' => 'article',
            'title' => 'Test node with related nodes',
            'uid' => $this->user
                ->id(),
            'field_relationships' => [
                [
                    'target_id' => $this->node
                        ->id(),
                ],
                [
                    'target_id' => $this->node2
                        ->id(),
                ],
                [
                    'target_id' => $this->node3
                        ->id(),
                ],
            ],
            'uuid' => static::$nodeUuid[4],
        ]);
        $this->node4
            ->save();
        // Give anonymous users permission to view user profiles, so that we can
        // verify the cache tags of cached versions of user profile pages.
        array_map(function ($role_id) {
            Role::create([
                'id' => $role_id,
                'permissions' => [
                    'access user profiles',
                    'access content',
                ],
            ])->save();
        }, [
            RoleInterface::ANONYMOUS_ID,
            'test_role_one',
            'test_role_two',
        ]);
        $this->entityResource = $this->createEntityResource();
    }
    
    /**
     * Creates an instance of the subject under test.
     *
     * @return \Drupal\jsonapi\Controller\EntityResource
     *   An EntityResource instance.
     */
    protected function createEntityResource() {
        return $this->container
            ->get('jsonapi.entity_resource');
    }
    
    /**
     * @covers ::getCollection
     */
    public function testGetPagedCollection() {
        $request = Request::create('/jsonapi/node/article');
        $request->query = new ParameterBag([
            'sort' => 'nid',
            'page' => [
                'offset' => 1,
                'limit' => 1,
            ],
        ]);
        $entity_resource = $this->createEntityResource();
        // Get the response.
        $resource_type = $this->container
            ->get('jsonapi.resource_type.repository')
            ->get('node', 'article');
        $response = $entity_resource->getCollection($resource_type, $request);
        // Assertions.
        $this->assertInstanceOf(JsonApiDocumentTopLevel::class, $response->getResponseData());
        $this->assertInstanceOf(Data::class, $response->getResponseData()
            ->getData());
        $data = $response->getResponseData()
            ->getData();
        $this->assertCount(1, $data);
        $this->assertEquals($this->node2
            ->uuid(), $data->toArray()[0]
            ->getId());
        $this->assertEquals([
            'node:2',
            'node_list',
        ], $response->getCacheableMetadata()
            ->getCacheTags());
    }
    
    /**
     * @covers ::getCollection
     */
    public function testGetEmptyCollection() {
        $request = Request::create('/jsonapi/node/article');
        $request->query = new ParameterBag([
            'filter' => [
                'id' => 'invalid',
            ],
        ]);
        // Get the response.
        $resource_type = new ResourceType('node', 'article', NULL);
        $response = $this->entityResource
            ->getCollection($resource_type, $request);
        // Assertions.
        $this->assertInstanceOf(JsonApiDocumentTopLevel::class, $response->getResponseData());
        $this->assertInstanceOf(Data::class, $response->getResponseData()
            ->getData());
        $this->assertEquals(0, $response->getResponseData()
            ->getData()
            ->count());
        $this->assertEquals([
            'node_list',
        ], $response->getCacheableMetadata()
            ->getCacheTags());
    }

}

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.
EntityResourceTest::$entityResource protected property The EntityResource under test.
EntityResourceTest::$modules public static property Modules to enable. Overrides JsonapiKernelTestBase::$modules
EntityResourceTest::$node protected property The node.
EntityResourceTest::$node2 protected property The other node.
EntityResourceTest::$node3 protected property An unpublished node.
EntityResourceTest::$nodeUuid protected static property Static UUIDs to use in testing.
EntityResourceTest::$request protected property A fake request.
EntityResourceTest::$user protected property The user.
EntityResourceTest::createEntityResource protected function Creates an instance of the subject under test.
EntityResourceTest::setUp protected function Overrides KernelTestBase::setUp
EntityResourceTest::testGetEmptyCollection public function @covers ::getCollection
EntityResourceTest::testGetPagedCollection public function @covers ::getCollection
JsonapiKernelTestBase::createEntityReferenceField protected function Creates a field of an entity reference field storage on the bundle.
JsonapiKernelTestBase::createTextField protected function Creates a field of an entity reference field storage on the bundle.
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.

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