class GitExcluderTest

@covers \Drupal\package_manager\PathExcluder\GitExcluder @group package_manager @internal

Hierarchy

Expanded class hierarchy of GitExcluderTest

File

core/modules/package_manager/tests/src/Kernel/PathExcluder/GitExcluderTest.php, line 21

Namespace

Drupal\Tests\package_manager\Kernel\PathExcluder
View source
class GitExcluderTest extends PackageManagerKernelTestBase {
    use ComposerInstallersTrait;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $project_root = $this->container
            ->get(PathLocator::class)
            ->getProjectRoot();
        $this->installComposerInstallers($project_root);
        $active_manipulator = new ActiveFixtureManipulator();
        $active_manipulator->addPackage([
            'name' => 'foo/package_known_to_composer_removed_later',
            'type' => 'drupal-module',
            'version' => '1.0.0',
        ], FALSE, TRUE)
            ->addPackage([
            'name' => 'foo/custom_package_known_to_composer',
            'type' => 'drupal-custom-module',
            'version' => '1.0.0',
        ], FALSE, TRUE)
            ->addPackage([
            'name' => 'foo/package_with_different_installer_path_known_to_composer',
            'type' => 'drupal-module',
            'version' => '1.0.0',
        ], FALSE, TRUE);
        // Set the installer path config in the project root where we install the
        // package.
        $installer_paths['different_installer_path/package_known_to_composer'] = [
            'foo/package_with_different_installer_path_known_to_composer',
        ];
        $this->setInstallerPaths($installer_paths, $project_root);
        $active_manipulator->addProjectAtPath("modules/module_not_known_to_composer_in_active")
            ->addDotGitFolder($project_root . "/modules/module_not_known_to_composer_in_active")
            ->addDotGitFolder($project_root . "/modules/contrib/package_known_to_composer_removed_later")
            ->addDotGitFolder($project_root . "/modules/custom/custom_package_known_to_composer")
            ->addDotGitFolder($project_root . "/different_installer_path/package_known_to_composer")
            ->commitChanges();
    }
    
    /**
     * Tests that Git directories are excluded from stage during PreCreate.
     */
    public function testGitDirectoriesExcludedActive() : void {
        // Ensure we have an up-to-date container.
        $this->container = $this->container
            ->get('kernel')
            ->rebuildContainer();
        $stage = $this->createStage();
        $stage->create();
        
        /** @var \Drupal\package_manager_bypass\LoggingBeginner $beginner */
        $beginner = $this->container
            ->get(BeginnerInterface::class);
        $beginner_args = $beginner->getInvocationArguments();
        $excluded_paths = [
            '.git',
            'modules/module_not_known_to_composer_in_active/.git',
            'modules/example/.git',
        ];
        foreach ($excluded_paths as $excluded_path) {
            $this->assertContains($excluded_path, $beginner_args[0][2]);
        }
        $not_excluded_paths = [
            'modules/contrib/package_known_to_composer_removed_later/.git',
            'modules/custom/custom_package_known_to_composer/.git',
            'different_installer_path/package_known_to_composer/.git',
        ];
        foreach ($not_excluded_paths as $not_excluded_path) {
            $this->assertNotContains($not_excluded_path, $beginner_args[0][2]);
        }
    }
    
    /**
     * Tests that Git directories are excluded from active during PreApply.
     */
    public function testGitDirectoriesExcludedStage() : void {
        // Ensure we have an up-to-date container.
        $this->container = $this->container
            ->get('kernel')
            ->rebuildContainer();
        $this->getStageFixtureManipulator()
            ->removePackage('foo/package_known_to_composer_removed_later');
        $stage = $this->createStage();
        $stage->create();
        $stage->require([
            'ext-json:*',
        ]);
        $stage_dir = $stage->getStageDirectory();
        // Adding a module with .git in stage which is unknown to composer, we
        // expect it to not be copied to the active directory.
        $path = "{$stage_dir}/modules/unknown_to_composer_in_stage";
        $fs = new Filesystem();
        $fs->mkdir("{$path}/.git");
        file_put_contents("{$path}/unknown_to_composer.info.yml", Yaml::encode([
            'name' => 'Unknown to composer in stage',
            'type' => 'module',
            'core_version_requirement' => '^9.7 || ^10',
        ]));
        file_put_contents("{$path}/.git/excluded.txt", 'Phoenix!');
        $stage->apply();
        
        /** @var \Drupal\package_manager_bypass\LoggingCommitter $committer */
        $committer = $this->container
            ->get(CommitterInterface::class);
        $committer_args = $committer->getInvocationArguments();
        $excluded_paths = [
            '.git',
            'modules/module_not_known_to_composer_in_active/.git',
            'modules/example/.git',
        ];
        // We are missing "modules/unknown_to_composer_in_stage/.git" in excluded
        // paths because there is no validation for it as it is assumed about any
        // new .git folder in stage directory that either composer is aware of it or
        // the developer knows what they are doing.
        foreach ($excluded_paths as $excluded_path) {
            $this->assertContains($excluded_path, $committer_args[0][2]);
        }
        $this->assertNotContains('modules/unknown_to_composer_in_stage/.git', $committer_args[0][2]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern Deprecated protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertPreconditionsTrait::assertNoFailureMarker private static function Asserts that there is no failure marker present.
AssertPreconditionsTrait::failIfUnmetPreConditions protected static function Asserts universal test preconditions before any setup is done.
AssertPreconditionsTrait::getProjectRoot private static function Returns the absolute path of the project root.
AssertPreconditionsTrait::setUpBeforeClass public static function Invokes the test preconditions assertion before the first test is run.
ComposerInstallersTrait::installComposerInstallers private function Installs the composer/installers package.
ComposerInstallersTrait::setInstallerPaths private function Sets the installer paths config.
ComposerStagerTestTrait::createComposeStagerMessage protected function Creates a Composer Stager translatable message.
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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FixtureManipulatorTrait::getStageFixtureManipulator protected function Gets the stage fixture manipulator service.
FixtureUtilityTrait::copyFixtureFilesTo protected static function Mirrors a fixture directory to the given path.
FixtureUtilityTrait::renameGitDirectories private static function Renames _git directories to .git.
FixtureUtilityTrait::renameInfoYmlFiles protected static function Renames all files that end with .info.yml.hide.
GitExcluderTest::setUp protected function Overrides PackageManagerKernelTestBase::setUp
GitExcluderTest::testGitDirectoriesExcludedActive public function Tests that Git directories are excluded from stage during PreCreate.
GitExcluderTest::testGitDirectoriesExcludedStage public function Tests that Git directories are excluded from active during PreApply.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::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::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PackageManagerKernelTestBase::$client private property The mocked HTTP client that returns metadata about available updates.
PackageManagerKernelTestBase::$disableValidators protected property The service IDs of any validators to disable.
PackageManagerKernelTestBase::$failureLogger protected property A logger that will fail the test if Package Manager logs any errors.
PackageManagerKernelTestBase::$fileSystem private property The Symfony filesystem class.
PackageManagerKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 3
PackageManagerKernelTestBase::$testProjectRoot protected property The test root directory, if any, created by ::createTestProject().
PackageManagerKernelTestBase::addEventTestListener protected function Adds an event listener on an event for testing purposes.
PackageManagerKernelTestBase::assertEventPropagationStopped protected function Asserts event propagation is stopped by a certain event subscriber.
PackageManagerKernelTestBase::assertExpectedResultsFromException protected function Asserts that a StageEventException has a particular set of results.
PackageManagerKernelTestBase::assertResults protected function Asserts validation results are returned from a stage life cycle event.
PackageManagerKernelTestBase::assertStatusCheckResults protected function Asserts validation results are returned from the status check event.
PackageManagerKernelTestBase::createStage protected function Creates a stage object for testing purposes.
PackageManagerKernelTestBase::createTestProject protected function Creates a test project. 1
PackageManagerKernelTestBase::enableModules protected function Enables modules for this test. Overrides KernelTestBase::enableModules
PackageManagerKernelTestBase::register public function Registers test-specific services. Overrides KernelTestBase::register 7
PackageManagerKernelTestBase::registerPostUpdateFunctions protected function Marks all pending post-update functions as completed.
PackageManagerKernelTestBase::setCoreVersion protected function Sets the current (running) version of core, as known to the Update module.
PackageManagerKernelTestBase::setReleaseMetadata protected function Sets the release metadata file to use when fetching available updates.
PackageManagerKernelTestBase::tearDown protected function Invokes the test preconditions assertion after each test run. Overrides AssertPreconditionsTrait::tearDown 2
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.
StatusCheckTrait::runStatusCheck protected function Runs a status check for a stage and returns the results, if any.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ValidationTestTrait::assertValidationResultsEqual protected function Asserts two validation result sets are equal.
ValidationTestTrait::getValidationResultsAsArray protected function Gets an array representation of validation results for easy comparison.
ValidationTestTrait::resolvePlaceholdersInArrayValuesWithRealPaths protected function Resolves <PROJECT_ROOT>, <VENDOR_DIR>, <STAGE_ROOT>, <STAGE_ROOT_PARENT>.

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