https://github.com/friendsofshopware/platform-plugin-dev-docker
Docker image containing useful stuff for plugin development
https://github.com/friendsofshopware/platform-plugin-dev-docker
Last synced: about 1 month ago
JSON representation
Docker image containing useful stuff for plugin development
- Host: GitHub
- URL: https://github.com/friendsofshopware/platform-plugin-dev-docker
- Owner: FriendsOfShopware
- License: mit
- Created: 2020-09-21T17:53:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-18T23:26:21.000Z (about 2 months ago)
- Last Synced: 2025-03-18T23:29:29.130Z (about 2 months ago)
- Language: Dockerfile
- Homepage:
- Size: 151 KB
- Stars: 24
- Watchers: 2
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://www.shopware.com/en/news/shopware-6-versioning-strategy/), 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](https://github.com/FriendsOfShopware/platform-plugin-dev-docker/pkgs/container/platform-plugin-dev/versions?filters%5Bversion_type%5D=tagged).
# Available scripts and commands
Inside the Docker container you can use the following commands
## `plugin-uploader`
For more information see the [offical documentation](https://github.com/FriendsOfShopware/FroshPluginUploader#using-the-commands) of the plugin uploader.
## `start-mysql`
Simple script which will start the mysql server and return `0` if it was successfully started.
## `pack-plugin `
This command will install the plugin with `` 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 `
This command will install the app with `` 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
```yaml
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
```yaml
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
setLoadEnvFile(true)
->setForceInstallPlugins(true)
->addActivePlugins('MyTechnicalPluginName')
->bootstrap()
->getClassLoader()
;
```
The associate `phpunit.xml.dist` would than look something like
```xml
src
tests
```
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
```yaml
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']
```