class ContentEntityExampleTest

Same name in other branches
  1. 3.x modules/content_entity_example/tests/src/Functional/ContentEntityExampleTest.php \Drupal\Tests\content_entity_example\Functional\ContentEntityExampleTest

Tests the basic functions of the Content Entity Example module.

@group content_entity_example @group examples

Hierarchy

Expanded class hierarchy of ContentEntityExampleTest

Related topics

File

modules/content_entity_example/tests/src/Functional/ContentEntityExampleTest.php, line 18

Namespace

Drupal\Tests\content_entity_example\Functional
View source
class ContentEntityExampleTest extends ExamplesBrowserTestBase {
    use StringTranslationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'content_entity_example',
        'block',
        'field_ui',
    ];
    
    /**
     * Basic tests for Content Entity Example.
     */
    public function testContentEntityExample() {
        $assert = $this->assertSession();
        $web_user = $this->drupalCreateUser([
            'add contact entity',
            'edit contact entity',
            'view contact entity',
            'delete contact entity',
            'administer contact entity',
            'administer content_entity_example_contact display',
            'administer content_entity_example_contact fields',
            'administer content_entity_example_contact form display',
        ]);
        // Anonymous User should not see the link to the listing.
        $assert->pageTextNotContains('Content Entity Example');
        $this->drupalLogin($web_user);
        // Web_user user has the right to view listing.
        $assert->linkExists('Content Entity Example');
        $this->clickLink('Content Entity Example');
        // WebUser can add entity content.
        $assert->linkExists('Add contact');
        $this->clickLink($this->t('Add contact'));
        $assert->fieldValueEquals('name[0][value]', '');
        $assert->fieldValueEquals('name[0][value]', '');
        $assert->fieldValueEquals('name[0][value]', '');
        $assert->fieldValueEquals('name[0][value]', '');
        $user_ref = $web_user->name->value . ' (' . $web_user->id() . ')';
        $assert->fieldValueEquals('user_id[0][target_id]', $user_ref);
        // Post content, save an instance. Go back to list after saving.
        $edit = [
            'name[0][value]' => 'test name',
            'first_name[0][value]' => 'test first name',
            'role' => 'administrator',
        ];
        $this->submitForm($edit, 'Save');
        // Entity listed.
        $assert->linkExists('Edit');
        $assert->linkExists('Delete');
        $this->clickLink('test name');
        // Entity shown.
        $assert->pageTextContains('test name');
        $assert->pageTextContains('test first name');
        $assert->pageTextContains('administrator');
        $assert->linkExists('Add contact');
        $assert->linkExists('Edit');
        $assert->linkExists('Delete');
        // Delete the entity.
        $this->clickLink('Delete');
        // Confirm deletion.
        $assert->linkExists('Cancel');
        $this->submitForm([], 'Delete');
        // Back to list, must be empty.
        $assert->pageTextNotContains('test name');
        // Settings page.
        $this->drupalGet('admin/structure/content_entity_example_contact_settings');
        $assert->pageTextContains('Contact Settings');
        // Make sure the field manipulation links are available.
        $assert->linkExists('Settings');
        $assert->linkExists('Manage fields');
        $assert->linkExists('Manage form display');
        $assert->linkExists('Manage display');
    }
    
    /**
     * Test all paths exposed by the module, by permission.
     */
    public function testPaths() {
        $assert = $this->assertSession();
        // Generate a contact so that we can test the paths against it.
        $contact = Contact::create([
            'name' => 'somename',
            'first_name' => 'Joe',
            'role' => 'administrator',
        ]);
        $contact->save();
        // Gather the test data.
        $data = $this->providerTestPaths($contact->id());
        // Run the tests.
        foreach ($data as $datum) {
            // drupalCreateUser() doesn't know what to do with an empty permission
            // array, so we help it out.
            if ($datum[2]) {
                $user = $this->drupalCreateUser([
                    $datum[2],
                ]);
                $this->drupalLogin($user);
            }
            else {
                $user = $this->drupalCreateUser();
                $this->drupalLogin($user);
            }
            $this->drupalGet($datum[1]);
            $assert->statusCodeEquals($datum[0]);
        }
    }
    
    /**
     * Data provider for testPaths.
     *
     * @param int $contact_id
     *   The id of an existing Contact entity.
     *
     * @return array
     *   Nested array of testing data. Arranged like this:
     *   - Expected response code.
     *   - Path to request.
     *   - Permission for the user.
     */
    protected function providerTestPaths($contact_id) {
        return [
            [
                200,
                '/content_entity_example_contact/' . $contact_id,
                'view contact entity',
            ],
            [
                403,
                '/content_entity_example_contact/' . $contact_id,
                '',
            ],
            [
                200,
                '/content_entity_example_contact/list',
                'view contact entity',
            ],
            [
                403,
                '/content_entity_example_contact/list',
                '',
            ],
            [
                200,
                '/content_entity_example_contact/add',
                'add contact entity',
            ],
            [
                403,
                '/content_entity_example_contact/add',
                '',
            ],
            [
                200,
                '/content_entity_example_contact/' . $contact_id . '/edit',
                'edit contact entity',
            ],
            [
                403,
                '/content_entity_example_contact/' . $contact_id . '/edit',
                '',
            ],
            [
                200,
                '/contact/' . $contact_id . '/delete',
                'delete contact entity',
            ],
            [
                403,
                '/contact/' . $contact_id . '/delete',
                '',
            ],
            [
                200,
                'admin/structure/content_entity_example_contact_settings',
                'administer contact entity',
            ],
            [
                403,
                'admin/structure/content_entity_example_contact_settings',
                '',
            ],
        ];
    }
    
    /**
     * Test add new fields to the contact entity.
     */
    public function testAddFields() {
        $web_user = $this->drupalCreateUser([
            'administer contact entity',
            'administer content_entity_example_contact display',
            'administer content_entity_example_contact fields',
            'administer content_entity_example_contact form display',
        ]);
        $this->drupalLogin($web_user);
        $entity_name = 'content_entity_example_contact';
        $add_field_url = 'admin/structure/' . $entity_name . '_settings/fields/add-field';
        $this->drupalGet($add_field_url);
        $field_name = 'test_name';
        $edit = [
            'new_storage_type' => 'list_string',
            'label' => 'test name',
            'field_name' => $field_name,
        ];
        $this->submitForm($edit, 'Save and continue');
        $expected_path = $this->buildUrl('admin/structure/' . $entity_name . '_settings/fields/' . $entity_name . '.' . $entity_name . '.field_' . $field_name . '/storage');
        // Fetch url without query parameters.
        $current_path = strtok($this->getUrl(), '?');
        $this->assertEquals($expected_path, $current_path);
    }
    
    /**
     * Ensure admin and permissioned users can create contacts.
     */
    public function testCreateAdminPermission() {
        $assert = $this->assertSession();
        $add_url = Url::fromRoute('content_entity_example.contact_add');
        // Create a Contact entity object so that we can query it for it's annotated
        // properties. We don't need to save it.
        
        /** @var \Drupal\content_entity_example\Entity\Contact $contact */
        $contact = Contact::create();
        // Create an admin user and log them in. We use the entity annotation for
        // admin_permission in order to validate it. We also have to add the view
        // list permission because the add form redirects to the list on success.
        $this->drupalLogin($this->drupalCreateUser([
            $contact->getEntityType()
                ->getAdminPermission(),
            'view contact entity',
        ]));
        // Post a contact.
        $edit = [
            'name[0][value]' => 'Test Admin Name',
            'first_name[0][value]' => 'Admin First Name',
            'role' => 'administrator',
        ];
        $this->drupalGet($add_url);
        $this->submitForm($edit, 'Save');
        $assert->statusCodeEquals(200);
        $assert->pageTextContains('Test Admin Name');
        // Create a user with 'add contact entity' permission. We also have to add
        // the view list permission because the add form redirects to the list on
        // success.
        $this->drupalLogin($this->drupalCreateUser([
            'add contact entity',
            'view contact entity',
        ]));
        // Post a contact.
        $edit = [
            'name[0][value]' => 'Mere Mortal Name',
            'first_name[0][value]' => 'Mortal First Name',
            'role' => 'user',
        ];
        $this->drupalGet($add_url);
        $this->submitForm($edit, 'Save');
        $assert->statusCodeEquals(200);
        $assert->pageTextContains('Mere Mortal Name');
        // Finally, a user who can only view should not be able to get to the add
        // form.
        $this->drupalLogin($this->drupalCreateUser([
            'view contact entity',
        ]));
        $this->drupalGet($add_url);
        $assert->statusCodeEquals(403);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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.
ContentEntityExampleTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ContentEntityExampleTest::$modules protected static property Modules to install. Overrides ExamplesBrowserTestBase::$modules
ContentEntityExampleTest::providerTestPaths protected function Data provider for testPaths.
ContentEntityExampleTest::testAddFields public function Test add new fields to the contact entity.
ContentEntityExampleTest::testContentEntityExample public function Basic tests for Content Entity Example.
ContentEntityExampleTest::testCreateAdminPermission public function Ensure admin and permissioned users can create contacts.
ContentEntityExampleTest::testPaths public function Test all paths exposed by the module, by permission.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExamplesBrowserTestBase::setUp protected function Overrides BrowserTestBase::setUp 4
ExamplesBrowserTestBase::setupExamplesMenus protected function Set up menus and tasks in their regions.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.