Skip to content

Latest commit

 

History

History
158 lines (130 loc) · 6.07 KB

README.md

File metadata and controls

158 lines (130 loc) · 6.07 KB
Raw

What is this?

A docker image with preinstalled Shopware 6, without a webserver, but including some helper tools. These images are meant to be useful for debugging Shopware plugins or running plugin tasks in CI with different Shopware versions.

Available Docker image tags

We provide a tag for each minor Shopware 6 release, which should always point to the latest patch release. Additionally there exist a tag for each major branch. A list of available tags can be found here.

Available scripts and commands

Inside the Docker container you can use the following commands

plugin-uploader

For more information see the offical documentation of the plugin uploader.

start-mysql

Simple script which will start the mysql server and return 0 if it was successfully started.

pack-plugin <plugin name>

This command will install the plugin with <plugin name> and compile all JavaScript files needed for the storefront and the administration. If the environment variable SHOPWARE_ROOT is set, this will be used as alternative Shopware location, otherwise if this variable is empty, the default Shopware setup from this image /opt/shopware will be used.

Make sure that the plugin folder is present in ${SHOPWARE_ROOT}/custom/plugins/. If you use the default SHOPWARE_ROOT you can place them in /plugins.

pack-app <app name>

This command will install the app with <app name> and compile all JavaScript files needed for the storefront. If the environment variable SHOPWARE_ROOT is set, this will be used as alternative Shopware location, otherwise if this variable is empty, the default Shopware setup from this image /opt/shopware will be used.

Make sure that the app folder is present in ${SHOPWARE_ROOT}/custom/apps/. If you use the default SHOPWARE_ROOT you can place them in /apps.

Build Docker image for specific Shopware version

It is possible to specify the Shopware version or even the template with the Docker option --build-arg, e.g.:

docker build --build-arg SHOPWARE_VERSION=trunk . -t platform-plugin-dev:trunk

In the same way it is also possible to specify the template Git repository URL:

docker build --build-arg SHOPWARE_VERSION=trunk \
    --build-arg TEMPLATE_REPOSITORY='https://github.com/FriendsOfShopware/platform' \
    . -t platform-plugin-dev:trunk

Examples

Pack Plugin in .gitlab-ci.yml

build:pack-plugin:
  image:
    name: ghcr.io/friendsofshopware/platform-plugin-dev:v6.5.0
    entrypoint: [""]
  script:
    - ln -s "$(pwd)" "/plugins/${CI_PROJECT_NAME}"
    - pack-plugin "${CI_PROJECT_NAME}"
    - plugin-uploader ext:validate "$(realpath "${CI_PROJECT_NAME}.zip")"
  artifacts:
    paths:
      - "${CI_PROJECT_NAME}.zip"
    expire_in: 1 week

Pack App in .gitlab-ci.yml

build:pack-app:
  image:
    name: ghcr.io/friendsofshopware/platform-plugin-dev:v6.5.0
    entrypoint: [""]
  script:
    - start-mysql
    - ln -s "$(pwd)" "/apps/${CI_PROJECT_NAME}"
    - rm -rf "/apps/${CI_PROJECT_NAME}/store" # Remove the store folder manually since it is not removed in the pack process for apps
    - pack-app "${CI_PROJECT_NAME}"
    - plugin-uploader ext:validate "$(realpath "${CI_PROJECT_NAME}.zip")" || true
  artifacts:
    paths:
      - "${CI_PROJECT_NAME}.zip"
    expire_in: 1 week

PHPUnit tests

The docker images contains phpunit constrained via the Shopware composer.json. Additionally a TestBootstrapper is included, either the one from the Shopware repository or a fallback one for Shopware versions < 6.4.5.0. This can be utilized inside your plugin (e.g. in tests/TestBootstrap.php)

<?php declare(strict_types=1);

use Shopware\Core\TestBootstrapper;

$testBootstrapper = null;
if (is_readable('/opt/share/shopware/tests/TestBootstrapper.php')) {
    // For Docker image: ghcr.io/friendsofshopware/platform-plugin-dev
    $testBootstrapper = require '/opt/share/shopware/tests/TestBootstrapper.php';
} else {
    // Create your own TestBootstrapper
}

return $testBootstrapper
    ->setLoadEnvFile(true)
    ->setForceInstallPlugins(true)
    ->addActivePlugins('MyTechnicalPluginName')
    ->bootstrap()
    ->getClassLoader()
;

The associate phpunit.xml.dist would than look something like

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
         backupGlobals="false"
         colors="true"
         bootstrap="tests/TestBootstrap.php"
         cacheResult="false">
    <coverage processUncoveredFiles="true">
        <include>
            <directory suffix=".php">src</directory>
        </include>
    </coverage>
    <php>
        <ini name="error_reporting" value="-1"/>
        <server name="APP_ENV" value="test" force="true"/>
        <env name="APP_DEBUG" value="1"/>
        <env name="APP_SECRET" value="s$cretf0rt3st"/>
        <env name="SHELL_VERBOSITY" value="-1"/>
        <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled" />
    </php>
    <testsuites>
        <testsuite name="MyTechnicalPluginName">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
</phpunit>

Locally execute the tests using the provided docker images, assuming you are currently inside the plugin directory

docker run --rm -it -v "${PWD}:/plugins/MyTechnicalPluginName" ghcr.io/friendsofshopware/platform-plugin-dev:v6.4.0 sh -c 'start-mysql && cd /plugins/MyTechnicalPluginName && phpunit'

Run the tests in .gitlab-ci.yml

test:phpunit:
  stage: test
  image:
    name: ghcr.io/friendsofshopware/platform-plugin-dev:${SHOPWARE_VERSION}
    entrypoint: [""]
  script:
    - start-mysql
    - ln -s "$(pwd)" "/plugins/${CI_PROJECT_NAME}"
    - phpunit
  parallel:
    matrix:
      - SHOPWARE_VERSION: ['v6.4.0', 'v6.4.5', 'v6.4.10', 'v6.4.15']