Skip to content

Latest commit

 

History

History
99 lines (80 loc) · 3.21 KB

README.md

File metadata and controls

99 lines (80 loc) · 3.21 KB
Raw

Quick start

Installation

Install locust on the machine which executes the benchmark. https://docs.locust.io/en/stable/installation.html

Additionally, you have to install the following dependencies:

  • Beautiful Soup
  • Faker
  • Requests
> pip3 install -r requirements.txt

Setup

To keep the test simple and flexible, the script reads all data from the database directly. The corresponding data can also be determined automatically from the setup.php file and written into the corresponding *.json files. This allows benchmarks on external machines, without having direct access to the shop. To execute Admin API benchmarks, you have to insert the OAuth credentials into the env.json file in the OAuth section.

{
    "url": "http://sw6.dev.localhost",
    "oauth": {
        "client_id": "administration",
        "grant_type": "password",
        "username": "admin",
        "password": "shopware"
    }
}

After inserting the credentials, you can run the setup with the following command:

composer run locust:init

Environment

The env.json file allows the following configurations:

  • url: The base URL of the Shopware API.
  • oauth: The OAuth credentials.
  • wait: The time in seconds to wait between requests. To disable wait time define "wait": false. The default value is [3, 5] which defines a minimal wait time of 3 seconds to a maximum of 5.
  • aggregate: If enabled, groups the requests by a logical key. Default true.
  • indexing_behavior: Allows to configure the indexing behavior. The default value is false. Allowed behavior values are: disable-indexing, use-queue-indexing
  • category_page_limit:
  • product_page_limit:
  • track_ajax_requests: Defines, if Ajax requests should be tracked. Default true.

Enabled cache

Since locust is a benchmark script, the caches should be enabled. Simply add the following section to one of your local configuration files in {root}/config/packages/*.yaml. (Choose Redis, if you have a multi app server setup)

framework:
    cache:
        app: cache.adapter.filesystem

#framework:
#    cache:
#        app: cache.adapter.redis
#    session:
#      handler_id: 'redis://redis:6379'

You may also want to configure a delayed cache, which invalidates all tags after a given time.

shopware:
    cache:
        invalidation:
            delay: 30
            count: 150

Only tags which are not invalidated again within the last 30 seconds will be invalidated. This prevents duplicate invalidation calls. The count property defines how many tags are invalidated at the same time.

Disabled CSRF protection

To allow registrations and tracing the order process, the CSRF protection has to be disabled. Simply add the following section to one of your local configuration files in {root}/config/packages/*.yaml

storefront:
    csrf:
        enabled: false

Run locust

You can run the benchmark with the following command:

composer run locust:run

If you use shopware docker (swdc) you can simply run the benchmark with the following command:

swdc locust sw6