class ContentImportTest

Same name in other branches
  1. 11.x core/tests/Drupal/FunctionalTests/DefaultContent/ContentImportTest.php \Drupal\FunctionalTests\DefaultContent\ContentImportTest

@covers \Drupal\Core\DefaultContent\Importer @group DefaultContent @group Recipe

Hierarchy

Expanded class hierarchy of ContentImportTest

File

core/tests/Drupal/FunctionalTests/DefaultContent/ContentImportTest.php, line 40

Namespace

Drupal\FunctionalTests\DefaultContent
View source
class ContentImportTest extends BrowserTestBase {
    use EntityReferenceFieldCreationTrait;
    use MediaTypeCreationTrait;
    use RecipeTestTrait;
    use TaxonomyTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block_content',
        'content_translation',
        'entity_test',
        'media',
        'menu_link_content',
        'node',
        'path',
        'path_alias',
        'system',
        'taxonomy',
        'user',
    ];
    private readonly string $contentDir;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->setUpCurrentUser(admin: TRUE);
        BlockContentType::create([
            'id' => 'basic',
            'label' => 'Basic',
        ])->save();
        block_content_add_body_field('basic');
        $this->createVocabulary([
            'vid' => 'tags',
        ]);
        $this->createMediaType('image', [
            'id' => 'image',
        ]);
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->drupalCreateContentType([
            'type' => 'article',
        ]);
        $this->createEntityReferenceField('node', 'article', 'field_tags', 'Tags', 'taxonomy_term');
        // Create a field with custom serialization, so we can ensure that the
        // importer handles that properly.
        $field_storage = FieldStorageConfig::create([
            'entity_type' => 'taxonomy_term',
            'field_name' => 'field_serialized_stuff',
            'type' => 'serialized_property_item_test',
        ]);
        $field_storage->save();
        FieldConfig::create([
            'field_storage' => $field_storage,
            'bundle' => 'tags',
        ])->save();
        ConfigurableLanguage::createFromLangcode('fr')->save();
        ContentLanguageSettings::create([
            'target_entity_type_id' => 'node',
            'target_bundle' => 'article',
        ])->setThirdPartySetting('content_translation', 'enabled', TRUE)
            ->save();
        $this->contentDir = $this->getDrupalRoot() . '/core/tests/fixtures/default_content';
        \Drupal::service('file_system')->copy($this->contentDir . '/file/druplicon_copy.png', $this->publicFilesDirectory . '/druplicon_copy.png', FileExists::Error);
    }
    
    /**
     * @return array<array<mixed>>
     */
    public static function providerImportEntityThatAlreadyExists() : array {
        return [
            [
                Existing::Error,
            ],
            [
                Existing::Skip,
            ],
        ];
    }
    
    /**
     * @dataProvider providerImportEntityThatAlreadyExists
     */
    public function testImportEntityThatAlreadyExists(Existing $existing) : void {
        $this->drupalCreateUser(values: [
            'uuid' => '94503467-be7f-406c-9795-fc25baa22203',
        ]);
        if ($existing === Existing::Error) {
            $this->expectException(ImportException::class);
            $this->expectExceptionMessage('user 94503467-be7f-406c-9795-fc25baa22203 already exists.');
        }
        $this->container
            ->get(Importer::class)
            ->importContent(new Finder($this->contentDir), $existing);
    }
    
    /**
     * Tests importing content directly, via the API.
     */
    public function testDirectContentImport() : void {
        $logger = new TestLogger();
        
        /** @var \Drupal\Core\DefaultContent\Importer $importer */
        $importer = $this->container
            ->get(Importer::class);
        $importer->setLogger($logger);
        $importer->importContent(new Finder($this->contentDir));
        $this->assertContentWasImported();
        // We should see a warning about importing a file entity associated with a
        // file that doesn't exist.
        $predicate = function (array $record) : bool {
            return $record['message'] === 'File entity %name was imported, but the associated file (@path) was not found.' && $record['context']['%name'] === 'dce9cdc3-d9fc-4d37-849d-105e913bb5ad.png' && $record['context']['@path'] === $this->contentDir . '/file/dce9cdc3-d9fc-4d37-849d-105e913bb5ad.png';
        };
        $this->assertTrue($logger->hasRecordThatPasses($predicate, LogLevel::WARNING));
    }
    
    /**
     * Tests that the importer validates entities before saving them.
     */
    public function testEntityValidationIsTriggered() : void {
        $dir = uniqid('public://');
        mkdir($dir);
        
        /** @var string $data */
        $data = file_get_contents($this->contentDir . '/node/2d3581c3-92c7-4600-8991-a0d4b3741198.yml');
        $data = Yaml::decode($data);
        
        /** @var array{default: array{sticky: array<int, array{value: mixed}>}} $data */
        $data['default']['sticky'][0]['value'] = 'not a boolean!';
        file_put_contents($dir . '/invalid.yml', Yaml::encode($data));
        $this->expectException(InvalidEntityException::class);
        $this->expectExceptionMessage("{$dir}/invalid.yml: sticky.0.value=This value should be of the correct primitive type.");
        $this->container
            ->get(Importer::class)
            ->importContent(new Finder($dir));
    }
    
    /**
     * Asserts that the default content was imported as expected.
     */
    private function assertContentWasImported() : void {
        
        /** @var \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository */
        $entity_repository = $this->container
            ->get(EntityRepositoryInterface::class);
        $node = $entity_repository->loadEntityByUuid('node', 'e1714f23-70c0-4493-8e92-af1901771921');
        $this->assertInstanceOf(NodeInterface::class, $node);
        $this->assertSame('Crikey it works!', $node->body->value);
        $this->assertSame('article', $node->bundle());
        $this->assertSame('Test Article', $node->label());
        $tag = $node->field_tags->entity;
        $this->assertInstanceOf(TermInterface::class, $tag);
        $this->assertSame('Default Content', $tag->label());
        $this->assertSame('tags', $tag->bundle());
        $this->assertSame('550f86ad-aa11-4047-953f-636d42889f85', $tag->uuid());
        // The tag carries a field with serialized data, so ensure it came through
        // properly.
        $this->assertSame('a:2:{i:0;s:2:"Hi";i:1;s:6:"there!";}', $tag->field_serialized_stuff->value);
        $this->assertSame('94503467-be7f-406c-9795-fc25baa22203', $node->getOwner()
            ->uuid());
        // The node's URL should use the path alias shipped with the recipe.
        $node_url = $node->toUrl()
            ->toString();
        $this->assertSame(Url::fromUserInput('/test-article')->toString(), $node_url);
        $media = $entity_repository->loadEntityByUuid('media', '344b943c-b231-4d73-9669-0b0a2be12aa5');
        $this->assertInstanceOf(MediaInterface::class, $media);
        $this->assertSame('image', $media->bundle());
        $this->assertSame('druplicon.png', $media->label());
        $file = $media->field_media_image->entity;
        $this->assertInstanceOf(FileInterface::class, $file);
        $this->assertSame('druplicon.png', $file->getFilename());
        $this->assertSame('d8404562-efcc-40e3-869e-40132d53fe0b', $file->uuid());
        // Another file entity referencing an existing file but already in use by
        // another entity, should be imported.
        $same_file_different_entity = $entity_repository->loadEntityByUuid('file', '23a7f61f-1db3-407d-a6dd-eb4731995c9f');
        $this->assertInstanceOf(FileInterface::class, $same_file_different_entity);
        $this->assertSame('druplicon-duplicate.png', $same_file_different_entity->getFilename());
        $this->assertStringEndsWith('/druplicon_0.png', (string) $same_file_different_entity->getFileUri());
        // Another file entity that references a file with the same name as, but
        // different contents than, an existing file, should be imported and the
        // file should be renamed.
        $different_file = $entity_repository->loadEntityByUuid('file', 'a6b79928-838f-44bd-a8f0-44c2fff9e4cc');
        $this->assertInstanceOf(FileInterface::class, $different_file);
        $this->assertSame('druplicon-different.png', $different_file->getFilename());
        $this->assertStringEndsWith('/druplicon_1.png', (string) $different_file->getFileUri());
        // Another file entity referencing an existing file but one that is not in
        // use by another entity, should be imported but use the existing file.
        $different_file = $entity_repository->loadEntityByUuid('file', '7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d');
        $this->assertInstanceOf(FileInterface::class, $different_file);
        $this->assertSame('druplicon_copy.png', $different_file->getFilename());
        $this->assertStringEndsWith('/druplicon_copy.png', (string) $different_file->getFileUri());
        // Our node should have a menu link, and it should use the path alias we
        // included with the recipe.
        $menu_link = $entity_repository->loadEntityByUuid('menu_link_content', '3434bd5a-d2cd-4f26-bf79-a7f6b951a21b');
        $this->assertInstanceOf(MenuLinkContentInterface::class, $menu_link);
        $this->assertSame($menu_link->getUrlObject()
            ->toString(), $node_url);
        $this->assertSame('main', $menu_link->getMenuName());
        $block_content = $entity_repository->loadEntityByUuid('block_content', 'd9b72b2f-a5ea-4a3f-b10c-28deb7b3b7bf');
        $this->assertInstanceOf(BlockContentInterface::class, $block_content);
        $this->assertSame('basic', $block_content->bundle());
        $this->assertSame('Useful Info', $block_content->label());
        $this->assertSame("I'd love to put some useful info here.", $block_content->body->value);
        // A node with a non-existent owner should be reassigned to the current
        // user.
        $node = $entity_repository->loadEntityByUuid('node', '7f1dd75a-0be2-4d3b-be5d-9d1a868b9267');
        $this->assertInstanceOf(NodeInterface::class, $node);
        $this->assertSame(\Drupal::currentUser()->id(), $node->getOwner()
            ->id());
        // Ensure a node with a translation is imported properly.
        $node = $entity_repository->loadEntityByUuid('node', '2d3581c3-92c7-4600-8991-a0d4b3741198');
        $this->assertInstanceOf(NodeInterface::class, $node);
        $translation = $node->getTranslation('fr');
        $this->assertSame('Perdu en traduction', $translation->label());
        $this->assertSame("Içi c'est la version français.", $translation->body->value);
    }

}

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.
ContentImportTest::$contentDir private property
ContentImportTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ContentImportTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ContentImportTest::assertContentWasImported private function Asserts that the default content was imported as expected.
ContentImportTest::providerImportEntityThatAlreadyExists public static function
ContentImportTest::setUp protected function Overrides BrowserTestBase::setUp
ContentImportTest::testDirectContentImport public function Tests importing content directly, via the API.
ContentImportTest::testEntityValidationIsTriggered public function Tests that the importer validates entities before saving them.
ContentImportTest::testImportEntityThatAlreadyExists public function @dataProvider providerImportEntityThatAlreadyExists
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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.
RecipeTestTrait::applyRecipe protected function Applies a recipe to the site.
RecipeTestTrait::createRecipe protected function Creates a recipe in a temporary directory.
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.
TaxonomyTestTrait::createTaxonomyTermRevision protected function Creates a new revision for a given taxonomy term.
TaxonomyTestTrait::createTerm protected function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary protected function Returns a new vocabulary with random properties.
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.

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