Github

This page should give you instructions and some ideas on how to use dockware images in Github workflows and pipelines.
Please keep in mind, these might not always be 100% accurate samples, because some things like installing dependencies and so on, might work different in your project. In fact, some of these things are only related to projects, but you should get the idea.
Are we missing something? Just let us know and we'd be happy to add it here!
Cypress Tests
This is a perfect usage for dockware and its pre-installed Shopware version including demo data.
Let's assume we have a plugin where we already have some Cypress tests that need a Shopware instance.
We want to run all these tests of our plugin in mutliple Shopware versions within Github.
We start by creating a job with a matrix strategy, where just provide the Shopware versions that we need. In addition to this, we want to test it with different PHP versions. 
To avoid a combination of all possibilities, we just create a static list in here, but please feel free to use your own strategy configuration of Github actions!
The real pipeline is started by downloading the correct dockware version of our matrix value.
Afterwards we start it with the docker run command and use the HTTPS port 443 as well as our correct PHP version. You can also use any other supported ENV variable in here.
Once started, we just give the container a bit time to launch MySQL and all its services. Usually you use a waitFor approach here, but this does also work really good.
In addition to this, we imagine that we must not use https://localhost for our tests, due to some restrictions. So we even have the option to configure a different domain to be used locally within the Github Runner.
Congratulations, your Docker infrastructure with dockware is done!
All we have to do now is to upload the files into our container, and intall and build our plugin as we would usually do.
Once completed, we can install Cypress and start to run the tests against our domain that we have just created for this pipeline.
If everything is done, we make sure to always download the logs and store those within our pipeline. By including the correct name of our shopware version from the matrix, we end up with a single ZIP file with logs and screenshots for all our Shopware versions.
Pro Tip:

If you want to see all results of all Shopware versions to detect patterns on problems in specific versions, then it might be a good thing to turn off "fail-fast" in the strategy.
The full pipeline will still go on and takes longer even if problems occur, but you'll be rewarded with full results in the end!

strategy:  
        fail-fast: false
1
name: CI Pipeline
2
​
3
on:
4
  push:
5
    branches:
6
      - master
7
​
8
jobs:
9
​
10
  e2e:
11
    name: E2E Tests | Shopware ${{ matrix.shopware }}, PHP ${{ matrix.php }}
12
    runs-on: ubuntu-latest
13
    strategy:
14
      matrix:
15
        include:
16
          - shopware: '6.4.7.0'
17
            php: '8.0'
18
          - shopware: '6.4.6.1'
19
            php: '8.0'
20
          - shopware: '6.4.5.1'
21
            php: '7.4'
22
    steps:
23
​
24
      - name: Clone Code
25
        uses: actions/[email protected]
26
​
27
      - name: Download Docker
28
        run: |
29
          docker pull dockware/dev:${{ matrix.shopware }}
30
    
31
      - name: Start Docker
32
        run: |
33
          docker run --rm -p 80:80 -p 443:443 --name shop --env PHP_VERSION=${{ matrix.php }} -d dockware/dev:${{ matrix.shopware }}
34
          sleep 30
35
          docker logs shop
36
          # now change the domain of our shop if required
37
          sudo echo "127.0.0.1 local.shopware.shop" | sudo tee -a /etc/hosts
38
          docker exec shop bash -c "mysql -u root -proot shopware -e \"UPDATE sales_channel_domain SET url='https://local.shopware.shop' WHERE url NOT LIKE 'default.%';\""
39
    
40
      - name: Upload into Docker
41
        run: |
42
          docker cp $(pwd)/. shop:/var/www/html/custom/plugins/MyPlugin
43
          docker exec shop bash -c 'sudo chown www-data:www-data /var/www/html/custom/plugins -R'
44
     
45
      - name: Install and Build Artifacts
46
        run: |
47
          docker exec shop bash -c 'cd /var/www/html/custom/plugins/MyPlugin && make install -B'
48
          docker exec shop bash -c 'cd /var/www/html/custom/plugins/MyPlugin && make build -B'
49
    
50
      - name: Install/Configure Plugin
51
        run: |
52
          docker exec shop bash -c 'php bin/console plugin:refresh'
53
          docker exec shop bash -c 'php bin/console plugin:install MyPlugin --activate'
54
          docker exec shop bash -c 'php bin/console system:config:set MyPlugin.config.MyKey ${{ secrets.MYKEY_TEST }}'
55
          docker exec shop bash -c 'php bin/console cache:clear'
56
   
57
      - name: Install Cypress
58
        run: cd tests/Cypress && make install -B
59
​
60
      - name: Start Cypress
61
        run: cd tests/Cypress && CYPRESS_BASE_URL=http://local.shopware.shop CYPRESS_SHOPWARE=${{ matrix.shopware }} ./node_modules/.bin/cypress run --headless
62
​
63
      - name: Download Logs
64
        if: ${{ always() }}
65
        run: |
66
          mkdir -p $(pwd)/Tests/Cypress/cypress/logs/shopware
67
          mkdir -p $(pwd)/Tests/Cypress/cypress/logs/apache
68
          docker cp shop:/var/www/html/var/log/. $(pwd)/Tests/Cypress/cypress/logs/shopware
69
          docker cp shop:/var/log/php/. $(pwd)/Tests/Cypress/cypress/logs/apache
70
      
71
      - name: Store Cypress Results
72
        if: ${{ always() }}
73
        uses: actions/upload-[email protected]
74
        with:
75
          name: cypress_results_sw_v${{ matrix.shopware }}
76
          retention-days: 1
77
          path: |
78
            Tests/Cypress/cypress/logs
79
            Tests/Cypress/cypress/videos
80
            Tests/Cypress/cypress/screenshots
81
            
Copied!

Contribute - Previous

Create Pull Requests

Next - CI/CD

Buddy

Last modified 1mo ago

Copy link

Contents

Cypress Tests