Implements the Payolution payment workflow into shopware.
Customer: best it
Product Owner / Project Manager: Johannes Terhürne
Tech Lead: Martin Knoop
Wiki: Confluence
GIT Flow: GitFlow Workflow
System: Shopware 5.2+
Credentials: Confluence / LastPass
In order to run a shopware instance locally to develop or test features, you have to run the following steps:
Before you start you have to install composer in the project root on your host system.
$ composer installAfter that you can startup the vagrant with:
$ vagrant upThis could take some time! Perfect time for a coffee :)
Open Tools > Deployment > Browse Remote Host.
Create a new remote host called Vagrant and open it.
| Configuration Field | Value |
|---|---|
| SFTP Host | 192.168.33.10 |
| Port | 22 |
| Root path | /home/vagrant/www/ |
| User name | vagrant |
| Auth type | Password |
| Password | vagrant |
| Save password | Tick checkbox |
| Local Path | Deployment Path | Web Path |
|---|---|---|
| %PATH_TO_PROJECT% | / | / |
| Add Local Paths |
|---|
| %PATH_TO_PROJECT%/.vagrant/ |
| %PATH_TO_PROJECT%/.idea/ |
| %PATH_TO_PROJECT%/vendor/ |
Upload all project files via Tools > Deployment > Upload to Vagrant or let the rsync handle it.
$ vagrant sshTo connect to vagrant.
$ cd /home/vagrant/wwwChange directory to project path.
$ composer installIf you already haven't done this add following /etc/hosts entry.
192.168.33.10 local.dev.bestit-online.de
$ ./vendor/bin/phing buildThis installs a shopware instance by configured version with listed features:
- Install Cron and SwagDemoDataDE Plugin
- Install some language packages necessary for language shops
- Install PolPaymentPayolution Plugin
- Create different language and subshops in order to configure PolPaymentPayolution to handle them
- Activate and assign payment method to standard shipping
- Clear shopware cache
You should now be able to browse the shop under https://local.dev.bestit-online.de/.
As of a bug with the shopware smarty function "link" to resolve symlinks not correctly there is a service "iwatch"
installed which moves created, changed, deleted files under /home/vagrant/www/src/PolPaymentPayolution/*
automatically to the corresponding path within the shopware instance.
If your changes doesn't get synced check if this service is running.
Add the Shopware codebase to your include path under Languages & Frameworks > PHP:
- Include path: %PATH_TO_SHOPWARE%
Go to the Toolbar->Run->Edit Configurations... Add a new "PHP Remote Debug" and apply the following configuration:
- Name: local.dev.bestit-online.de
- Check "Filter debug connection by IDE key"
- Server: see instructions below
- IDE key(session id): PHPSTORM
You will need to add an appropriate Server which you can do by clicking the button with the three dots which is placed next to the Server select box.
Now enter the following information:
- Name: vagrant
- Host: local.dev.bestit-online.de
- Port: 80
- Debugger: Xdebug
- Use path mappings: true
- Paths
- Path #1
- File/Dir: %PATH_TO_PROJECT%/src/PolPaymentPayolution
- Absolute Path: home/vagrant/www/html/engine/Shopware/Plugins/Community/Frontend/PolPaymentPayolution
- Path #2
- File/Dir: %PATH_TO_SHOPWARE%
- Absolute Path: /home/vagrant/www/html
- Path #1
Once you have done so, create a copy if your just now created server configuration by clicking the stacked paper icon in the upper left corner.
Rename the copied configuration to "vagrant ssh" and edit the Port to 443.
You can now save the new server configurations, select in the previously created "PHP Remote Debug" on of your server configurations (which one doesn't matter) and save it.
You can either go to "Run->Debug" to start debugging or set the option "Run->Start Listening for PHP Debug Connections" and the use some XDebug helper like the Chrome Extension.
Please ensure that the following tools are installed on your host system (minimum version specified)
- Virtualbox 5.2+
- Vagrant 2.0+ (as development machine)
- Docker 18.03+ (currently only for automated frontend testing with behat)
- Shopware 5.2+
- PHP 5.6+
- MySQL 5.6+
The architecture is currently in a major change, so this section would be described later.
Simply run in the vagrant
$ /home/vagrant/www/vendor/bin/phpunitTo execute the behat tests you need to setup a working instance in the container:
Create the docker network for the container stack, only required once:
$ docker network create -d bridge payolution_localStart the container stack with a running bash
$ docker run --name payolution_mysql --network payolution_local -e MYSQL_DATABASE='shopware' -e MYSQL_ROOT_PASSWORD='root' -d mysql:5.7
$ docker run -it -v $(pwd):/app -e PIPELINES_BUILD_CONTAINER_XDEBUG_STATUS=1 -e HTML_WORKING_DIR=/www -e PIPELINES_BUILD_CONTAINER_ENVIRONMENT=php7.1 -w /app --network payolution_local bestitdocker/pipelines-build-containerBuild the working instance in the stack:
$ ./vendor/bin/phing -Denvironment=pipelines -Dmysql.host=payolution_mysql build -debug
$ symfony server:start -d --port=80 --passthru=/www/shopware.php --document-root=/wwwAfter this you can run behat:
$ ./vendor/bin/behatThere is currently no automated deployment on any instance. The build is done via Bitbucket Pipelines. It sets up a complete Shopware instance and runs PHPUnit. Behat is currently disabled because there are some major problems with Shopware which let them fail.
It generates a zip-artifact on every successful build on the master-sw5 branch and stores the artifact in the Download-Section. The naming is "PolPaymentPayolution_mastervX.X.X.zip" The version at the end is determined from the plugin.json file. Be aware that the first change after a release must update the version so that older artifacts don't get polluted.