Generate data for performance testing

Using the Magento Performance Toolkit for performance testing requires you to generate a large amount of data, including stores, categories, products, and more. You can adjust the amount of data you create using profiles, such as small, medium, large, and extra large.

The following figure shows a product display on the storefront using the small profile:

Prerequisites

1. Log in to the Magento server as, or switch to, a user with permissions to write to the Magento file system. See switch to the Magento file system owner.

   If you use the bash shell, you can use the following syntax to switch to the Magento file system owner and enter the command at the same time:

   1
   su <Magento file system owner> -s /bin/bash -c <command>
   

   If the Magento file system owner does not allow logins, you can do the following:

   1
   sudo -u <Magento file system owner>  <command>
   

2. To run Magento commands from any directory, add <magento_root>/bin to your system PATH.

   Because shells have differing syntax, consult a reference like unix.stackexchange.com.

   Sample bash shell for CentOS:

   1
   export PATH=$PATH:/var/www/html/magento2/bin
   

   Optionally, you can run the commands in the following ways:

   • cd <magento_root>/bin and run them as ./magento <command name>
   • <magento_root>/bin/magento <command name>
   • <magento_root> is a subdirectory of your web server docroot. Need help locating the docroot?

In addition to the command arguments discussed here, see a list of Common arguments for the command-line configuration.

Profiles

Profiles are stored in the <magento_root>/setup/performance-toolkit/profiles/<ce or ee> directory. The following table provides details about each profile:

To run the data generator:

1. Disable all cron jobs before running the data generator. Disabling cron jobs prevents the data generator from performing actions that conflict with active cron jobs and avoids unnecessary errors.

2. Run the data generator using the absolute file system path and name of a profile.

   1
   bin/magento setup:perf:generate-fixtures <path-to-profile>
   

   For example,

   1
   bin/magento setup:perf:generate-fixtures /var/www/html/magento2/setup/performance-toolkit/profiles/ce/small.xml
   

   Sample output for the small profile:

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   Generating profile with following params:
       |- Websites: 1
       |- Store Groups Count: 1
       |- Store Views Count: 1
       |- Categories: 30
       |- Attribute Sets (Default): 3
       |- Attribute Sets (Extra): 10
       |- Simple products: 800
       |- Configurable products: 0
       |--- 5 products for attribute set "Attribute Set 1"
       |--- 5 products for attribute set "Attribute Set 2"
       |--- 5 products for attribute set "Attribute Set 3"
       |--- 40 products for attribute set "Dynamic Attribute Set 1-24"
       |- Product images: 100, 3 per product
       |- Customers: 200
       |- Cart Price Rules: 20
       |- Catalog Price Rules: 20
       |- Catalog Target Rules: 5
       |- Orders: 80
   Generating websites, stores and store views...  done in <time>
   Generating categories...  done in <time>
   Generating attribute sets...  done in <time>
   Generating simple products...  done in <time>
   ... more ...
   

3. After running the data generator, you must reindex all indexers.

Fixtures

The following lists the supported fixtures and the XML profile node format:

Admin users

Generates admin users.

1
2
<!-- Number of admin users -->
<admin_users>{int}</admin_users>

Attribute sets

Generates attribute sets with specified configuration.

1
2
3
4
5
6
7
8
<!-- Number of product attribute sets -->
<product_attribute_sets>{int}</product_attribute_sets>

<!-- Number of attributes per set -->
<product_attribute_sets_attributes>{int}</product_attribute_sets_attributes>

<!-- Number of values per attribute -->
<product_attribute_sets_attributes_values>{int}</product_attribute_sets_attributes_values>

Bundle products

Generates bundle products. Generated bundle selections are not displayed individually in catalog. Products distribute uniformly per categories and websites. If assign_entities_to_all_websites from the profile is set to 1, products are assigned to all websites.

1
2
3
4
5
6
7
8
<!-- Number of products -->
<bundle_products>{int}</bundle_products>

<!-- Number of options per each product -->
<bundle_products_options>{int}</bundle_products_options>

<!-- Number of simple products per each option -->
<bundle_products_variation>{int}</bundle_products_variation>

Cart price rules

Generates cart price rules.

1
2
3
4
5
<!-- Number of cart price rules -->
<cart_price_rules>{int}</cart_price_rules>

<!-- Number of conditions per rule -->
<cart_price_rules_floor>{int}</cart_price_rules_floor>

Catalog price rules

Generates catalog price rules.

1
2
<!-- Number of catalog price rules -->
<catalog_price_rules>{int}</catalog_price_rules>

Categories

Generates categories. If assign_entities_to_all_websites is set to 0, all categories are uniformly distributed per root categories; otherwise, all categories are assigned to one root category.

1
2
3
4
5
<!-- Number of categories to generate -->
<categories>{int}</categories>

<!-- Nesting level of categories -->
<categories_nesting_level>{int}</categories_nesting_level>

Configs

Sets values for config fields.

1
2
3
4
5
6
7
8
9
10
<!-- Config variables and values for change -->
    <configs>
        <config>
            <path>{string}</path> <!-- e.g. admin/security/use_form_key -->
            <scope>{string}</scope> <!-- e.g. default -->
            <scopeId>{int}</scopeId>
            <value>{int|string}</value>
        </config>
        <!-- ... more entries ... -->
    </configs>

Configurable products

Generates Configurable products. Generated configurable options are not displayed individually in the catalog. Products are uniformly distributed per categories and websites. If assign_entities_to_all_websites is set to 1, products will be assigned to all websites.

We support the following XML node formats:

• Distribution per Default and pre-defined attribute sets:

  1
  2
  <!-- Number of configurable products -->
  <configurable_products>{int}</configurable_products>
  

• Generate products based on an existing attribute set:

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  <configurable_products>
      <!-- Configurable product configuration -->
      <config>
          <!-- Existing attribute set name -->
          <attributeSet>{string}</attributeSet>
  
          <!-- Configurable sku pattern with %s -->
          <sku>{string}</sku>
  
          <!-- Number of configurable products -->
          <products>{int}</products>
  
          <!-- Category Name. Optional. By default category name from Categories fixture will be used -->
          <category>[{string}]</category>
  
          <!-- Type of Swatch attribute e.g. color|image -->
          <swatches>{string}</swatches>
      </config>
  
      <!-- ... more entries ... -->
  </configurable_products>
  

• Generate products based on a dynamically created attribute set with a specified amount of attributes and options:

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  <configurable_products>
      <!-- Configurable product configuration -->
      <config>
          <!-- Number of attributes in configurable product -->
          <attributes>{int}</attributes>
  
          <!-- Number of options per attribute -->
          <options>{int}</options>
  
          <!-- Configurable sku pattern with %s -->
          <sku>{string}</sku>
  
          <!-- Number of configurable products -->
          <products>{int}</products>
  
          <!-- Category Name. Optional. By default category name from Categories fixture will be used -->
          <category>[{string}]</category>
  
          <!-- Type of Swatch attribute e.g. color|image -->
          <swatches>{string}</swatches>
      </config>
  
      <!-- ... more entries ... -->
  </configurable_products>
  

• Generate products based on a dynamically created attribute set with a specified configuration per each attribute:

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
   <configurable_products>
      <!-- Configurable product configuration -->
      <config>
          <attributes>
              <!-- Configuration for a first attribute -->
              <attribute>
                  <!-- Amount of options per attribute -->
                  <options>{int}</options>
  
                  <!-- Type of Swatch attribute -->
                  <swatches>{string}</swatches>
              </attribute>
  
              <!-- Configuration for a second attribute -->
              <attribute>
                  <!-- Amount of options per attribute -->
                  <options>{int}</options>
              </attribute>
          </attributes>
  
          <!-- Configurable sku pattern with %s -->
          <sku>{string}</sku>
  
          <!-- Number of configurable products -->
          <products>{int}</products>
  
          <!-- Category Name. Optional. By default, the category name from Categories fixture will be used -->
          <category>[{string}]</category>
      </config>
  
      <!-- ... more entries ... -->
  </configurable_products>
  

Customers

Generates customers. Customers have a normal distribution on all available websites. Each customer has the same data except customer email, customer group, and customer addresses.

1
2
<!-- Number of customers to generate -->
<customers>{int}</customers>

You can use the following XML to change the customer configuration:

1
2
3
4
<customer-config>
    <!-- Number of addresses per each customer -->
    <addresses-count>{int}</addresses-count>
</customer-config>

Indexers state

Updates the indexer state.

1
2
3
4
5
<indexer>
    <!-- Name of indexer (e.g. catalogrule_product) -->
    <id>{string}</id>
    <set_scheduled>{bool}</set_scheduled>
</indexer>

Product images

Generates product images. Generation does not include resizing.

1
2
3
4
5
6
<product-images>
    <!-- Number of images to generate -->
    <images-count>{int}</images-count>
    <!-- Number of images to be assigned per each product -->
    <images-per-product>{int}</images-per-product>
</product-images>

Orders

Generates orders with configurable number of different types of order items. Optionally generates inactive quotes for generated orders.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<!-- It is necessary to enable quotes for orders -->
<order_quotes_enable>{bool}</order_quotes_enable>

<!-- Min number of simple products per each order -->
<order_simple_product_count_from>{int}</order_simple_product_count_from>

<!-- Max number of simple products per each order -->
<order_simple_product_count_to>{int}</order_simple_product_count_to>

<!-- Min number of configurable products per each order -->
<order_configurable_product_count_from>{int}</order_configurable_product_count_from>

<!-- Max number of configurable products per each order -->
<order_configurable_product_count_to>{int}</order_configurable_product_count_to>

<!-- Min number of big configurable products (with big amount of options) per each order -->
<order_big_configurable_product_count_from>{int}</order_big_configurable_product_count_from>

<!-- Max number of big configurable products (with big amount of options) per each order -->
<order_big_configurable_product_count_to>{int}</order_big_configurable_product_count_to>

<!-- Number of orders to generate -->
<orders>{int}</orders>

Simple products

Generates simple products. Products are distributed per default and pre-defined attribute sets. If extra attribute sets are specified in profile as: <product_attribute_sets>{int}</product_attribute_sets>, products are also distributed per additional attribute sets.

Products are uniformly distributed per categories and websites. If assign_entities_to_all_websites is set to 1, products are assigned to all websites.

1
2
<!-- Number of simple products to generate -->
<simple_products>{int}</simple_products>

Store groups

Generates store groups (referred to in the Magento Admin as stores). Store groups are distributed normally among websites.

1
2
<!-- Number of store groups to be generated -->
<store_groups>{int}</store_groups>

Store views

Generates store views. Store views are distributed normally among store groups.

1
2
3
4
5
<!-- Number of store views to be generated -->
<store_views>{int}</store_views>

<!-- 1 means that all stores will have the same root category, 0 means that all stores will have unique root category -->
<assign_entities_to_all_websites>{0|1}<assign_entities_to_all_websites/>

Tax rates

Generates tax rates.

1
2
<!-- Accepts name of csv file with tax rates (<path to magento folder>/setup/src/Magento/Setup/Fixtures/_files) -->
<tax_rates_file>{csv file name}</tax_rates_file>

Websites

Generates websites.

1
2
<!-- Number of websites to be generated -->
<websites>{int}</websites>

Additional configuration information

You can find the following XML files in the <Magento root dir>/setup/performance-toolkit/config/ directory.