Add deletion helper to reduce complexity

CHANGELOG.md

@@ -10,10 +10,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support for Shopware 6.6
 - Added `--dry` option to all fixture load commands
     - This option will prevent the fixtures from being executed but still prints all fixtures it would execute
+- Added new DatabaseUtils with a few helpful methods:
+  - `deleteEntities` takes an entity name and criteria and deletes all entities which match the criteria
 
 ### Changed
 - Changed argument type on `SalesChannelUtils::getTax()` from `int` to `float`
 - **Breaking** By default no fixtures in the vendor directory are loaded. Added option `--vendor` to load them
+- Refactored `FixtureTrait` to not use command anymore but direct Fixture Loader
+  - `FixtureTrait::loadFixtures` now takes in a FixtureOption parameter
+  - `FixtureTrait::runSpecificFixtures` is an alias to run specific fixtures with optionally dependencies
+  - `FixtureTrait::runSingleFixture` (before `FixtureTrait::runSingleFixtureWithDependencies`) with dependencies can now be configured as the second parameter
+  - `FixtureTrait::runFixtureGroup` is a new function to execute whole fixture groups with optionally dependencies
+- Each fixture now has direct access to the FixtureHelper using `$this->helper`
+  - **Breaking** If you have the helper (or any other helper) previously assigned to `$this->helper` it will either fail or override the FixturePlugin helper
 
 ### Removed
 - Dropped support for PHP 8.1

phpstan.neon

@@ -5,5 +5,7 @@ parameters:
     # The level 9 is the highest level
     level: 9
 
-    checkMissingIterableValueType: false
-    checkGenericClassInNonGenericObjectType: false
+    ignoreErrors:
+        # This is ignored until we drop support for Shopware 6.5
+        - message: '#Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepository is not generic\.#'
+          reportUnmatched: false

psalm.xml

@@ -14,10 +14,12 @@
     </projectFiles>
 
     <issueHandlers>
-        <LessSpecificReturnType errorLevel="info" />
+        <!-- This is ignored until we drop support for Shopware 6.5 -->
+        <TooManyTemplateParams errorLevel="suppress" />
 
         <LessSpecificImplementedReturnType errorLevel="suppress" />
 
+        <LessSpecificReturnType errorLevel="info" />
         <DeprecatedMethod errorLevel="info" />
         <DeprecatedProperty errorLevel="info" />
         <DeprecatedClass errorLevel="info" />

src/Fixture.php

@@ -6,6 +6,8 @@
 
 abstract class Fixture
 {
+    protected readonly FixtureHelper $helper;
+
     abstract public function load(): void;
 
     /** @return string[] */
@@ -24,4 +26,12 @@
     {
         return [];
     }
+
+    /**
+     * @internal This method should only be called from the FixtureLoader.
+     */
+    public final function setHelper(FixtureHelper $helper): void
+    {
+        $this->helper = $helper;
+    }
 }

src/FixtureHelper.php

@@ -7,6 +7,7 @@
 use Basecom\FixturePlugin\Utils\CategoryUtils;
 use Basecom\FixturePlugin\Utils\CmsUtils;
 use Basecom\FixturePlugin\Utils\CustomerUtils;
+use Basecom\FixturePlugin\Utils\DatabaseUtils;
 use Basecom\FixturePlugin\Utils\MediaUtils;
 use Basecom\FixturePlugin\Utils\PaymentMethodUtils;
 use Basecom\FixturePlugin\Utils\SalesChannelUtils;
@@ -22,6 +23,7 @@ public function __construct(
         private PaymentMethodUtils $paymentMethodUtils,
         private ShippingMethodUtils $shippingMethodUtils,
         private CustomerUtils $customerUtils,
+        private DatabaseUtils $databaseUtils,
     ) {
     }
 
@@ -87,4 +89,13 @@ public function ShippingMethod(): ShippingMethodUtils
     {
         return $this->shippingMethodUtils;
     }
+
+    /**
+     * Use this to access the general database helper functions
+     * of the fixture helper class.
+     */
+    public function Database(): DatabaseUtils
+    {
+        return $this->databaseUtils;
+    }
 }

src/FixtureLoader.php

@@ -8,9 +8,16 @@
 
 class FixtureLoader
 {
+    /** @var array<Fixture> */
     private readonly array $fixtures;
 
-    public function __construct(\Traversable $fixtures)
+    /**
+     * @param \Traversable<Fixture> $fixtures
+     */
+    public function __construct(
+        \Traversable $fixtures,
+        private FixtureHelper $helper,
+    )
     {
         $this->fixtures = iterator_to_array($fixtures);
     }
@@ -127,6 +134,8 @@ private function checkThatAllDependenciesAreInGroup(
 
     /**
      * Check if dependencies of fixture are also in the same group. If not, show error and stop process.
+     *
+     * @param array<string, Fixture> $references
      */
     private function checkDependenciesAreInSameGroup(
         Fixture $fixture,
@@ -171,6 +180,7 @@ private function runFixtures(FixtureOption $option, array $fixtures, ?SymfonySty
                 continue;
             }
 
+            $fixture->setHelper($this->helper);
             $fixture->load();
         }
     }

src/FixtureOption.php

@@ -6,6 +6,9 @@
 
 readonly class FixtureOption
 {
+    /**
+     * @param array<string> $fixtureNames
+     */
     public function __construct(
         public bool $dryMode = false,
         public ?string $groupName = null,

src/FixtureTrait.php

@@ -4,69 +4,54 @@
 
 namespace Basecom\FixturePlugin;
 
-use Shopware\Core\Framework\Test\TestCaseBase\KernelLifecycleManager;
-use Symfony\Bundle\FrameworkBundle\Console\Application;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Output\BufferedOutput;
-use Symfony\Component\Console\Output\ConsoleOutput;
+use Shopware\Core\Framework\DependencyInjection\DependencyInjectionException;
+use Shopware\Core\Framework\Test\TestCaseBase\IntegrationTestBehaviour;
 
 trait FixtureTrait
 {
-    private function runFixtures(?array $fixtures = []): void
-    {
-        if (empty($fixtures)) {
-            $application    = new Application(KernelLifecycleManager::getKernel());
-            $fixtureCommand = $application->find('fixture:load');
-
-            $returnCode = $fixtureCommand->run(
-                new ArrayInput(
-                    $fixtures,
-                    $fixtureCommand->getDefinition(),
-                ),
-                new BufferedOutput(), // use new ConsoleOutput() if you don't want to hide output, new BufferedOutput()
-            );
+    use IntegrationTestBehaviour;
 
-            if ($returnCode !== 0) {
-                throw new \RuntimeException('fixture:load');
-            }
+    private function runFixtures(FixtureOption $options): void
+    {
+        $fixtureLoader = $this->getContainer()->get(FixtureLoader::class);
 
-            return;
+        if (!$fixtureLoader instanceof FixtureLoader) {
+            throw new DependencyInjectionException(404, 'FIXTURE_LOADER_NOT_FOUND', 'Fixture Loader not found in container');
         }
 
-        foreach ($fixtures as $fixture) {
-            $application = new Application(KernelLifecycleManager::getKernel());
+        $fixtureLoader->run($options);
+    }
 
-            $fixtureCommand = $application->find('fixture:load:single');
+    /**
+     * @param array<string> $fixtures
+     */
+    private function runSpecificFixtures(array $fixtures = [], bool $withDependencies = false): void
+    {
+        $options = new FixtureOption(
+            fixtureNames: $fixtures,
+            withDependencies: $withDependencies,
+        );
 
-            $returnCode = $fixtureCommand->run(
-                new ArrayInput(
-                    ['fixtureName' => $fixture],
-                    $fixtureCommand->getDefinition(),
-                ),
-                new BufferedOutput(), // use new ConsoleOutput() if you don't want to hide output, new BufferedOutput()
-            );
-            if ($returnCode !== 0) {
-                throw new \RuntimeException('fixture:single');
-            }
-        }
+        $this->runFixtures($options);
     }
 
-    private function runSingleFixtureWithDependencies(string $fixture): void
+    private function runSingleFixture(string $fixture, bool $withDependencies = false): void
     {
-        $application = new Application(KernelLifecycleManager::getKernel());
+        $options = new FixtureOption(
+            fixtureNames: [$fixture],
+            withDependencies: $withDependencies,
+        );
 
-        $fixtureCommand = $application->find('fixture:load:single');
+        $this->runFixtures($options);
+    }
 
-        $returnCode = $fixtureCommand->run(
-            new ArrayInput(
-                ['fixtureName' => $fixture, '--with-dependencies' => true],
-                $fixtureCommand->getDefinition(),
-            ),
-            new BufferedOutput(),
+    private function runFixtureGroup(string $group, bool $withDependencies = false): void
+    {
+        $options = new FixtureOption(
+            groupName: $group,
+            withDependencies: $withDependencies,
         );
 
-        if ($returnCode !== 0) {
-            throw new \RuntimeException('fixture:single');
-        }
+        $this->runFixtures($options);
     }
 }

src/Utils/CategoryUtils.php

@@ -6,6 +6,7 @@
 
 namespace Basecom\FixturePlugin\Utils;
 
+use Shopware\Core\Content\Category\CategoryCollection;
 use Shopware\Core\Content\Category\CategoryEntity;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
@@ -14,6 +15,9 @@
 
 readonly class CategoryUtils
 {
+    /**
+     * @param EntityRepository<CategoryCollection> $categoryRepository
+     */
     public function __construct(
         private EntityRepository $categoryRepository,
     ) {

src/Utils/CmsUtils.php

@@ -4,6 +4,7 @@
 
 namespace Basecom\FixturePlugin\Utils;
 
+use Shopware\Core\Content\Cms\CmsPageCollection;
 use Shopware\Core\Content\Cms\CmsPageEntity;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
@@ -13,6 +14,9 @@
 
 readonly class CmsUtils
 {
+    /**
+     * @param EntityRepository<CmsPageCollection> $cmsPageRepository
+     */
     public function __construct(
         private EntityRepository $cmsPageRepository,
     ) {

src/Utils/CustomerUtils.php

@@ -8,10 +8,14 @@
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
+use Shopware\Core\System\Salutation\SalutationCollection;
 use Shopware\Core\System\Salutation\SalutationEntity;
 
 readonly class CustomerUtils
 {
+    /**
+     * @param EntityRepository<SalutationCollection> $salutationRepository
+     */
     public function __construct(
         private EntityRepository $salutationRepository,
     ) {

src/Utils/DatabaseUtils.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Basecom\FixturePlugin\Utils;
+
+use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
+
+readonly class DatabaseUtils
+{
+    public function __construct(
+        private DefinitionInstanceRegistry $definitionInstanceRegistry,
+    ) {
+    }
+
+    public function deleteEntities(string $entity, Criteria $criteria): void
+    {
+        $repository = $this->definitionInstanceRegistry->getRepository($entity);
+
+        // First load all the ids of the entities
+        $ids = $repository->searchIds($criteria, Context::createDefaultContext())->getData();
+
+        // Delete all entities with the IDs
+        $repository->delete(
+            array_values($ids),
+            Context::createDefaultContext(),
+        );
+    }
+}

src/Utils/MediaUtils.php

@@ -4,16 +4,22 @@
 
 namespace Basecom\FixturePlugin\Utils;
 
+use Shopware\Core\Content\Media\Aggregate\MediaFolder\MediaFolderCollection;
 use Shopware\Core\Content\Media\Aggregate\MediaFolder\MediaFolderEntity;
 use Shopware\Core\Content\Media\File\FileFetcher;
 use Shopware\Core\Content\Media\File\FileSaver;
+use Shopware\Core\Content\Media\MediaCollection;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
 
 readonly class MediaUtils
 {
+    /**
+     * @param EntityRepository<MediaCollection>       $mediaRepository
+     * @param EntityRepository<MediaFolderCollection> $mediaFolderRepository
+     */
     public function __construct(
         private EntityRepository $mediaRepository,
         private EntityRepository $mediaFolderRepository,

src/Utils/PaymentMethodUtils.php

@@ -5,6 +5,7 @@
 namespace Basecom\FixturePlugin\Utils;
 
 use Shopware\Core\Checkout\Payment\Cart\PaymentHandler\InvoicePayment;
+use Shopware\Core\Checkout\Payment\PaymentMethodCollection;
 use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
 use Shopware\Core\Framework\Context;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
@@ -13,6 +14,9 @@
 
 readonly class PaymentMethodUtils
 {
+    /**
+     * @param EntityRepository<PaymentMethodCollection> $paymentMethodRepository
+     */
     public function __construct(
         private EntityRepository $paymentMethodRepository,
     ) {