class FeaturesGenerateTest in Features 8.4

Same name and namespace in other branches

8.3 tests/src/Kernel/FeaturesGenerateTest.php \Drupal\Tests\features\Kernel\FeaturesGenerateTest

@group features

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\features\Kernel\FeaturesGenerateTest

Expanded class hierarchy of FeaturesGenerateTest

File

tests/src/Kernel/FeaturesGenerateTest.php, line 14

Namespace

Drupal\Tests\features\Kernel

View source

class FeaturesGenerateTest extends KernelTestBase {
  const PACKAGE_NAME = 'my_test_package';
  const BUNDLE_NAME = 'giraffe';

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'features',
    'node',
    'system',
    'user',
  ];

  /**
   * @var \Drupal\features\FeaturesManagerInterface
   */
  protected $featuresManager;

  /**
   * @var \Drupal\features\FeaturesGeneratorInterface
   */
  protected $generator;

  /**
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;
  protected $strictConfigSchema = FALSE;

  /**
   * @var \Drupal\features\FeaturesAssignerInterface
   */
  protected $assigner;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig('features');
    $this
      ->installConfig('system');
    $this->featuresManager = \Drupal::service('features.manager');
    $this->generator = \Drupal::service('features_generator');
    $this->assigner = \Drupal::service('features_assigner');
    $this->fileSystem = \Drupal::service('file_system');
    $this->featuresManager
      ->initPackage(self::PACKAGE_NAME, 'My test package');
    $package = $this->featuresManager
      ->getPackage(self::PACKAGE_NAME);
    $package
      ->appendConfig('system.site');
    $this->featuresManager
      ->setPackage($package);
  }

  /**
   * @covers \Drupal\features\Plugin\FeaturesGeneration\FeaturesGenerationArchive
   */
  public function testExportArchive() {
    $filename = $this->fileSystem
      ->getTempDirectory() . '/' . self::PACKAGE_NAME . '.tar.gz';
    if (file_exists($filename)) {
      unlink($filename);
    }
    $this
      ->assertFalse(file_exists($filename), 'Archive file already exists.');
    $this->generator
      ->generatePackages('archive', $this->assigner
      ->getBundle(), [
      self::PACKAGE_NAME,
    ]);
    $this
      ->assertTrue(file_exists($filename), 'Archive file was not generated.');
    $archive = new ArchiveTar($filename);
    $files = $archive
      ->listContent();
    $this
      ->assertEquals(3, count($files));
    $this
      ->assertEquals(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.info.yml', $files[0]['filename']);
    $this
      ->assertEquals(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.features.yml', $files[1]['filename']);
    $this
      ->assertEquals(self::PACKAGE_NAME . '/config/install/system.site.yml', $files[2]['filename']);
    $expected_info = [
      "name" => "My test package",
      "type" => "module",
      "core_version_requirement" => "^8.9 || ^9",
    ];
    $info = Yaml::decode($archive
      ->extractInString(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.info.yml'));
    $this
      ->assertEquals($expected_info, $info, 'Incorrect info file generated');
  }

  /**
   *
   */
  public function testGeneratorWithBundle() {
    $filename = $this->fileSystem
      ->getTempDirectory() . '/' . self::BUNDLE_NAME . '_' . self::PACKAGE_NAME . '.tar.gz';
    if (file_exists($filename)) {
      unlink($filename);
    }
    $this
      ->assertFalse(file_exists($filename), 'Archive file already exists.');
    $bundle = FeaturesBundle::create([
      'machine_name' => self::BUNDLE_NAME,
    ]);
    $this->generator
      ->generatePackages('archive', $bundle, [
      self::PACKAGE_NAME,
    ]);
    $package = $this->featuresManager
      ->getPackage(self::PACKAGE_NAME);
    $this
      ->assertNull($package);
    $package = $this->featuresManager
      ->getPackage(self::BUNDLE_NAME . '_' . self::PACKAGE_NAME);
    $this
      ->assertEquals(self::BUNDLE_NAME . '_' . self::PACKAGE_NAME, $package
      ->getMachineName());
    $this
      ->assertEquals(self::BUNDLE_NAME, $package
      ->getBundle());
    $this
      ->assertTrue(file_exists($filename), 'Archive file was not generated.');
  }

  /**
   * @covers \Drupal\features\Plugin\FeaturesGeneration\FeaturesGenerationWrite
   */
  public function testExportWrite() {

    // Set a fake drupal root, so the testbot can also write into it.
    vfsStream::setup('drupal');
    \Drupal::getContainer()
      ->set('app.root', 'vfs://drupal');
    $this->featuresManager
      ->setRoot('vfs://drupal');
    $package = $this->featuresManager
      ->getPackage(self::PACKAGE_NAME);

    // Find out where package will be exported.
    list($full_name, $path) = $this->featuresManager
      ->getExportInfo($package, $this->assigner
      ->getBundle());
    $path = 'vfs://drupal/' . $path . '/' . $full_name;
    if (file_exists($path)) {
      file_unmanaged_delete_recursive($path);
    }
    $this
      ->assertFalse(file_exists($path), 'Package directory already exists.');
    $this->generator
      ->generatePackages('write', $this->assigner
      ->getBundle(), [
      self::PACKAGE_NAME,
    ]);
    $info_file_uri = $path . '/' . self::PACKAGE_NAME . '.info.yml';
    $this
      ->assertTrue(file_exists($path), 'Package directory was not generated.');
    $this
      ->assertTrue(file_exists($info_file_uri), 'Package info.yml not generated.');
    $this
      ->assertTrue(file_exists($path . '/config/install'), 'Package config/install not generated.');
    $this
      ->assertTrue(file_exists($path . '/config/install/system.site.yml'), 'Config.yml not exported.');
    $expected_info = [
      "name" => "My test package",
      "type" => "module",
      "core_version_requirement" => "^8.9 || ^9",
    ];
    $info = Yaml::decode(file_get_contents($info_file_uri));
    $this
      ->assertEquals($expected_info, $info, 'Incorrect info file generated');

    // Now, add stuff to the feature and re-export to ensure it is preserved
    // Add a dependency to the package itself to see that it gets exported.
    $package
      ->setDependencies([
      'user',
    ]);
    $this->featuresManager
      ->setPackage($package);

    // Add dependency and custom key to the info file to simulate manual edit.
    $info['dependencies'] = [
      'node',
    ];
    $info['mykey'] = "test value";
    $info_contents = Yaml::encode($info);
    file_put_contents($info_file_uri, $info_contents);

    // Add an extra file that should be retained.
    $css_file = $path . '/' . self::PACKAGE_NAME . '.css';
    $file_contents = "This is a dummy file";
    file_put_contents($css_file, $file_contents);

    // Add a config file that should be removed since it's not part of the
    // feature.
    $config_file = $path . '/config/install/node.type.mytype.yml';
    file_put_contents($config_file, $file_contents);
    $this->generator
      ->generatePackages('write', $this->assigner
      ->getBundle(), [
      self::PACKAGE_NAME,
    ]);
    $this
      ->assertTrue(file_exists($info_file_uri), 'Package info.yml not generated.');
    $expected_info = [
      "name" => "My test package",
      "type" => "module",
      "core_version_requirement" => "^8.9 || ^9",
      "dependencies" => [
        "drupal:node",
        "drupal:user",
      ],
      "mykey" => "test value",
    ];
    $info = Yaml::decode(file_get_contents($info_file_uri));
    $this
      ->assertEquals($expected_info, $info, 'Incorrect info file generated');
    $this
      ->assertTrue(file_exists($css_file), 'Extra file was not retained.');
    $this
      ->assertFalse(file_exists($config_file), 'Config directory was not cleaned.');
    $this
      ->assertEquals($file_contents, file_get_contents($css_file), 'Extra file contents not retained');

    // Next, test that generating an Archive picks up the extra files.
    $filename = $this->fileSystem
      ->getTempDirectory() . '/' . self::PACKAGE_NAME . '.tar.gz';
    if (file_exists($filename)) {
      unlink($filename);
    }
    $this
      ->assertFalse(file_exists($filename), 'Archive file already exists.');
    $this->generator
      ->generatePackages('archive', $this->assigner
      ->getBundle(), [
      self::PACKAGE_NAME,
    ]);
    $this
      ->assertTrue(file_exists($filename), 'Archive file was not generated.');
    $archive = new ArchiveTar($filename);
    $files = $archive
      ->listContent();
    $this
      ->assertEquals(4, count($files));
    $this
      ->assertEquals(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.info.yml', $files[0]['filename']);
    $this
      ->assertEquals(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.features.yml', $files[1]['filename']);
    $this
      ->assertEquals(self::PACKAGE_NAME . '/config/install/system.site.yml', $files[2]['filename']);
    $this
      ->assertEquals(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.css', $files[3]['filename']);
    $expected_info = [
      "name" => "My test package",
      "type" => "module",
      "core_version_requirement" => "^8.9 || ^9",
      "dependencies" => [
        "drupal:node",
        "drupal:user",
      ],
      "mykey" => "test value",
    ];
    $info = Yaml::decode($archive
      ->extractInString(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.info.yml'));
    $this
      ->assertEquals($expected_info, $info, 'Incorrect info file generated');
    $this
      ->assertEquals($file_contents, $archive
      ->extractInString(self::PACKAGE_NAME . '/' . self::PACKAGE_NAME . '.css'), 'Extra file contents not retained');
  }

}

Members

Name	Modifiers	Type	Description	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	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
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.
FeaturesGenerateTest::$assigner	protected	property
FeaturesGenerateTest::$featuresManager	protected	property
FeaturesGenerateTest::$fileSystem	protected	property
FeaturesGenerateTest::$generator	protected	property
FeaturesGenerateTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
FeaturesGenerateTest::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved. Overrides KernelTestBase::$strictConfigSchema
FeaturesGenerateTest::BUNDLE_NAME		constant
FeaturesGenerateTest::PACKAGE_NAME		constant
FeaturesGenerateTest::setUp	protected	function	Overrides KernelTestBase::setUp
FeaturesGenerateTest::testExportArchive	public	function	@covers \Drupal\features\Plugin\FeaturesGeneration\FeaturesGenerationArchive
FeaturesGenerateTest::testExportWrite	public	function	@covers \Drupal\features\Plugin\FeaturesGeneration\FeaturesGenerationWrite
FeaturesGenerateTest::testGeneratorWithBundle	public	function
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::$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		6
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.

You are here

class FeaturesGenerateTest in Features 8.4

Hierarchy

File

Namespace

Members

API Navigation