Skip to content

Main Navigation

Concepts

Resources

API

Guides

Hosting and deployment

Upgrades and migrations

Environment

Tools

Development

Community edition

Migration assistant

Available in Plans

Advanced search

B2B Suite Migration

Frontends

Digital Sales Rooms

Services

Meteor

shopware.design

Meteor icon kit

Meteor Admin SDK

Meteor component library

Releases

Community

Learning

Appearance

Sidebar Navigation

Installation

System Requirements

Project Structure Overview

Advanced Docker Config

Legacy Setups

Install with Docker

Install with Devenv

Install with Symfony CLI

Additional Devenv Config

Migrate Zip Installation to Composer Project

Development

Accessibility

Storefront Accessibility

Accessibility Checklist

Extensions

Extension Architecture

Extendability

Final and Internal Annotation

Public API and Internal Annotation

Code Structure

APIs

API Flows

Create a Product and Complete Checkout

Authentication and API Requests

Search Criteria

Request Headers

Partial Data Loading

Generated Reference

Monetization

In-App Purchases (IAP)

Tooling

Fixture Bundle

Hot Module Replacement

Shopware 6 Toolbox

Troubleshooting

DAL Reference

Fields Reference

EnumField Reference

Flags Reference

Filters Reference

Aggregations Reference

Flow Reference

PHPStan

Rules Reference

Testing

Extensions for Store

Quality Guidelines for Store Extensions

Not allowed store behaviors

Store Review Errors

Functionality and integration

Storefront, performance, and errors

SEO and structured data

Cookies and privacy

Content and translations

Uninstallation and data cleanup

Code quality

FAQ

Playwright E2E testing

Install & Configure

Deployment

Fixtures

Page Objects

Actor Pattern

Test Suite Types

Test Suite

Local development

Language Agnostic Testing

Test Data Service

Best Practices

Legacy

Cypress

Best practices on writing end-to-end tests

Unit Testing

Jest Unit Tests in Shopware's Administration

Jest Unit Tests in Shopware's Storefront

PHP Unit Testing

Continuous Integration

Start Developing

Development Environment

Plugins

Apps

App SDKs

JavaScript App Server SDK

Getting Started

Lifecycle

Context

Signing Responses

HTTP-client

Integrations

External Frontend

Official Symfony Bundle

Official PHP SDK

Getting started

Lifecycle

Context

Signing

HTTP-client

Events

App Scripts

Cart Manipulation

Add an API endpoint

Data Loading

Custom Endpoints

Storefront

Apps as Themes

Customize Templates

Add Cookies to the Consent Manager

Administration

Meteor Admin SDK

Add custom action button

Add Custom Module

Add CMS element

Adding Translations

Create Admin Extensions

Flow Builder

Add Custom Flow Action from App System

Add custom flow trigger from app system

Custom Data

Custom Data Fields

Custom Entities

Content

CMS

Add Custom CMS Blocks

Rule Builder

Add Custom Rule Conditions

Gateways

Checkout

Checkout Gateway

Command Reference

Context

Context Gateway Command Reference

Context Gateway

In app purchase

In-App Purchase Gateway

App Base Guide

Build an Admin UI App Locally

MCP Server Extension

Checkout

Payment

Shipping Methods

Tax Provider

Document (v2)

Lifecycle

Read and write data

App Registration & Backend Setup

Signing & Verification in the App System

Webhook

Client-Side App Backend Communication

Configuration

Plugins

Administration

Administration Reference

Directives

Mixins

Utils

Advanced Configuration

Modify Dynamic Product Groups Blacklist

Extending Webpack

Add Shortcuts

Add Rule Assignment Configuration

Data Handling and Processing

Handling Media

Using Vuex Stores

Using Data Handling

Using the Data Grid Component

The Shopware Object

Using Custom Fields

Add Custom Data to the Search

Mixins and Directives

Adding Mixins

Using Mixins

Using Directives

Modules and Components

Add Custom Module

Add Custom Components

Customize Modules

Customizing Components

Add Custom Input Field to Existing Component

Using Base Components

Permissions and Error Handling

Adding Permissions

Adding Error Handling

Routing and Navigation

Add Custom Route

Add Menu Entry

Override Existing Routes

Add Tab to Existing Module

Services and Utilities

Making API Requests

Adding Services

Extending Services

Injecting Services

Displaying User Feedback

Sanitizer Helper

Using Utility Functions

Add Filter

Using Filter

Templates and Styling

Writing templates

Adding Snippets

Using Assets

Add Custom Styles

Adding Responsive Behavior

Plugin Architecture

Cart Extension Architecture

Rule System Extension Architecture

Dependency Injection & Dependency Handling

Event Extension Architecture

Page Loader Extension Architecture

Plugin Fundamentals

Logging

Add Plugin Configuration

Use Plugin Configuration

Plugin Lifecycle Methods

Add Custom CLI Commands

Add Scheduled Task

Checkout

Cart

Add Cart Collector/Processor

Add Cart Items

Add Cart Discounts

Add Cart Validator

Change Price of Items in Cart

Customize Price Calculation

Tax Provider

Documents

v2

Add a Document Type

Add a Format Renderer

Customize Document Data and Templates

Legacy

Add Custom Document

Add Custom Document Type

Order

Using the State Machine

Listen to Order Changes

Payment

Add Payment Plugin

Customize Payment Provider

Content

CMS

Add CMS block

Add CMS Elements

Add Data to CMS Element

Mail

Add Data to Mails

Add Mail Templates

Media

Prevent Deletion of Media Files Referenced in Plugins

Add Custom Media File Extensions

Remote Thumbnail Generation

SEO

Add Custom SEO URLs

Extend robots.txt Configuration

Sitemap

Add Custom Sitemap Entries

Modifying Sitemap Entries

Remove Sitemap Entries

Stock

Implementing Your Own Stock Storage

Loading Stock Information from a Different Source

Reading and Writing Stock

Integrations

Commercial Plugins

Custom Pricing

Multi-Inventory

Elasticsearch

Add Product Entity Extension to Elasticsearch

Redis

Database

Database Migrations

Using Custom Fields of Type Media

Framework

Data Handling / Data Abstraction Layer

Adding Complex Data to Existing Entities

Adding Custom Complex Data

Adding Data Associations

Adding Data Indexer

Adding Data Translations

Removing Associated Data

Entities via Attributes

Field Inheritance

Reading Data

Replacing Associated Data

Using Database Events

Using Flags

Versioning Entities

Writing Data

Caching

Custom Fields

Add Custom Field

Fetching data from "entity selection" custom field

Event

Add Custom Event

Finding Events

Listening to Events

Extension Points

Finding Extension Points

Creating Custom Extension Points

Extension Points vs Events

Message Queue

Add Message to Queue

Add Message Handler

Add Middleware

Rule

Add Custom Rules

Store API

Add Store API Route

Override Existing Route

Filesystem

Filesystem - Flysystem

Flow

Add Flow Builder Action

Add Flow Builder Trigger

Running Actions Inside Transactions

Rate Limiter

Add Rate Limiter to API Route

System Checks

Add Custom Check

Services

Dependency Injection

Add Custom Service

Adjusting a Service

Dependencies

Add Plugin Dependencies

Adding NPM Dependencies

Adding Composer Dependencies

Storefront

Templates

Customize Templates

Twig Functions Reference

Agentic Files

Customize Header/Footer

Add Custom Twig Functions

Styling

Add Custom Assets

Add Custom Styling

Add Custom Icons

Add Translations

Add SCSS Variables

Add SCSS Variables via Subscriber

JavaScript

Storefront Plugins and Helper Reference

Add Custom JavaScript

Override Existing JavaScript

Add JavaScript as Script Tag

Fetching Data with JavaScript

Reacting to JavaScript Events

Advanced Storefront Customization

Add Caching to Custom Controller

Add Cookie to Manager

Reacting to Cookie Consent Changes

Remove JavaScript Plugin

Storefront Controllers

Add Custom Controller

Add Dynamic Content via AJAX Calls

Add Custom Page

Add Custom Pagelet

Add Data to Storefront Page

How-To Guides

Add Custom Captcha

Add Custom Listing Filters

Working with Media and Thumbnails

Add Custom Field in the Storefront

Add Custom Sorting for Product Listing

Using a Modal Window

Using the Datepicker Plugin

Use Nested Line Items

Plugin Base Guide

Symfony Bundles

Creating Plugins

Install and Activate Plugins

In-App Purchases (IAP)

MCP Server Extension

Storefront Themes

Assets

Add Assets to a Theme

Add Custom Icons

Configuration

Theme Configuration

Theme Inheritance Configuration

Styling

Add SCSS Styling and JavaScript to a Theme

Override Bootstrap variables in a Theme

Override responsive breakpoints in a Theme

Inheritance

Theme Inheritance

Theme with Bootstrap styling

Theme Base Guide

Create a Theme

Hosting

Infrastructure

Elasticsearch

Set up Elasticsearch

Debugging and Troubleshooting Elasticsearch

Elasticsearch

Database

Filesystem

Message Queue

Optional Packages

Rate Limiter

Redis

Reverse HTTP Cache

Scheduled Task

Installation & Updates

Deployments

Deployment Helper

Environment and Database

Store and License

Extensions and Apps

Configuration

One-Time Tasks

Staging Mode Integration

Hosting and Integrations

Commands and Reference

Troubleshooting

Deployment with Deployer

Building Without Database

Cluster Setup

Docker Image

Extension Management

Performing Shopware Updates

Security Plugin

Creating Staging Instance

Configurations

Shopware

HTML sanitizer

Stock

Static System Configuration

Environment Variables

Framework

Custom routes

SameSite protection

Observability

Logging

Profiling / Tracing

OpenTelemetry

Performance

Cache

Performance Test with K6

Session

Increment Storage

Lock Storage

Number Ranges

Cart Storage

Performance Tweaks

Troubleshooting

Upgrades migrations

Administration

Vue 3 upgrade

Upgrading to Meteor Components

Upgrading to Pinia

Changing from Webpack to Vite

Removing Vue Migration Build

Native Vue

Language Pack Migration

Upgrade Shopware

Migrating Extensions

Unit Testing

Development
Testing

On this page

docsmainGuides

Unit Testing

This section explains how to write and execute unit tests in Shopware.

JavaScript testing (Jest)

Jest unit tests in Shopware's Administration
Jest unit tests in Shopware's Storefront

PHP testing (PHPUnit)

PHP unit testing

Jest Unit Tests in Shopware's Administration

Jest Unit Tests in Shopware's Storefront

PHP Unit Testing

Ask a question on StackOverflow

Edit this page on GitHub

Pager

Previous pageBest practices on writing end-to-end tests

Next pageJest Unit Tests in Shopware's Administration

Was this page helpful?

UnsatisfiedSatisfied

Be the first to vote!

0.0 / 5 (0 votes)

info@shopware.com
00 800 746 7626 0

Product

APIs
SDKs
B2B Suite
Extensions
Headless Storefront

Resources

User Documentation
Design Documentation
E-commerce knowledge
Jump into development
Training & Certification

Community

Community Hub
Forum
Community Day
Stack Overflow
Feedback & Issues

GitHub Channels

Shopware 6
Development Template
Contribute to the docs
Contribute to platform

News & Updates

Blog
Announcements
Product Changelog

Newsletter

Copyright © shopware AG - All rights reserved

Terms & Conditions
Privacy policy
Legal notice
Cookie settings