Shopware 6 Fixture Plugin

Appearance

Upgrade Guide ​

Upgrading from v2 to v3 ​

SEE CHANGELOG

For a comprehensive list of all changes, please refer to the CHANGELOG. This document will only cover the breaking changes.

Dropped support for older versions Impact: High ​

Release v3 has dropped support for PHP 8.1 and Shopware versions 6.3 and 6.4. The supported versions are now PHP 8.2, PHP 8.3, and Shopware versions 6.5 and 6.6.

Refer to the Supported versions page for a complete list of supported Shopware and PHP versions.

Removed FixtureBag Impact: High ​

Support for the FixtureBag parameter in the load method has been removed. Each fixture needs to be updated accordingly:

php
class CustomerFixture extends Fixture
{
    public function load(FixtureBag $bag): void
    public function load(): void
    {
        // ...
    }
}

Moved & Deleted some helper methods Impact: High ​

Many of our helper methods have been updated. Below is a list of the affected methods. All helpers not mentioned still work as in v2:

  • $this->helper->Category()->getFirst() is removed. No replacement is available
  • $this->helper->Category()->getByName() is removed. No replacement is available
  • $this->helper->Customer()->getNotSpecifiedSalutation() has moved to $this->helper->Salutation()->getNotSpecifiedSalutation()
  • $this->helper->SalesChannel()->getCurrencyEuro() has moved to $this->helper->Currency()->getCurrencyEuro()
  • $this->helper->SalesChannel()->getLanguage() has moved to $this->helper->LanguageAndLocale()->getLanguage()
  • $this->helper->SalesChannel()->getLocale() has moved to $this->helper->LanguageAndLocale()->getLocale()
  • $this->helper->SalesChannel()->getCountry() has moved to $this->helper->LanguageAndLocale()->getCountry()
  • $this->helper->SalesChannel()->getSnippetSet() has moved to $this->helper->LanguageAndLocale()->getSnippetSet()
  • $this->helper->SalesChannel()->getTax19() has moved to $this->helper->Tax()->getTax19()
  • $this->helper->SalesChannel()->getTax() has moved to $this->helper->Tax()->getTax()

Changed methods on the FixtureTrait Impact: Medium ​

The FixtureTrait used for testing has been rewritten to use the new FixtureOption structure.

The runFixtures method, which previously took an array of fixture names, now takes a FixtureOption class. To achieve the original behavior, you can either provide a FixtureOption class with the $fixtureNames parameter filled out or use our new alias method runSpecificFixtures, which works like the previous runFixtures. The new method also includes a parameter to load all dependencies of those fixtures.

php
// Before:
$this->runFixtures(['MyFixture', 'AnotherFixture']); 

// After:
$this->runSpecificFixtures(['MyFixture', 'AnotherFixture']); 
$this->runFixtures(new FixtureOption(fixtureNames: ['MyFixture', 'AnotherFixture']));

The runSingleFixtureWithDependencies method has been replaced with runSingleFixture. The first argument is the name of the fixture, and the second argument is a boolean to determine if dependencies should be loaded.

php
// Before:
$this->runSingleFixtureWithDependencies('MyFixture'); 

// After:
$this->runSingleFixture('MyFixture', true);

Vendor Fixtures don't run by default anymore Impact: Low ​

In version 2, fixtures within the vendor folder were executed alongside project-specific fixtures. This behavior has changed in v3. Now, only direct fixtures (those not within the vendor folder) will be executed.

Every fixture command now supports an additional flag --vendor to include vendor fixtures:

shell
bin/console fixture:load --vendor
bin/console fixture:load:single --vendor MyFixture
bin/console fixture:load:group --vendor MyGroup

Rewrote the fixture loader Impact: Low ​

All fixtures are now loaded from a FixtureLoader service. If you have never directly accessed the loader and only used the built-in traits and commands, you can ignore this section.

We have completely rewritten the logic to define which fixtures are executed. The fixture loader now accepts a single argument: $options. Within this options object, you can specify exactly how the FixturePlugin loads fixtures.

php
readonly class FixtureOption
{
    public function __construct(
        public bool $dryMode = false,
        public ?string $groupName = null,
        public array $fixtureNames = [],
        public bool $withDependencies = false,
        public bool $withVendor = false,
    ) {
    }
}

All options are combinable, and the internal commands and traits also utilize this options object.

Fixture Helper is now given to any fixture Recommendation ​

In v3, every fixture has access to the fixture helper by default using $this->helper. While not strictly a breaking change, we advise against manually loading the fixture helper via dependency injection and instead using the provided helper.

php
<?php

class MyFixture extends Fixture {
    public function __construct( 
        private readonly FixtureHelper $helper 
    ) {} 

    public function load(): void {
        $this->helper->doSomething();
    }
}

Upgrading from v1 to v2 ​

SEE CHANGELOG

For a comprehensive list of all changes, please refer to the CHANGELOG. This document will only cover the breaking changes.

Helper methods have been split Impact: High ​

Instead of calling the helper methods like $helper->getInvoicePaymentMethod(), you now need to call the sub util class: $helper->PaymentMethod()->getInvoicePaymentMethod().

The following util classes have been added:

php
$fixtureHelper->Media()
$fixtureHelper->Category()
$fixtureHelper->SalesChannel()
$fixtureHelper->Customer()
$fixtureHelper->Cms()
$fixtureHelper->PaymentMethod()
$fixtureHelper->ShippingMethod()

INFO

We haven't removed any helper methods in this release. We only moved them!

Released under the MIT License.

Copyright © 2021-2024 basecom GmbH & Co. KG