TestMode

This section describes the available actions in the test mode area. Using these actions, you can activate and deactivate test mode. When activating it and while test mode is active, you can also enable extended debugging, simulate failed payments, and signal to the storefront that it should use the test API of the WEBSALE search. You can also have the views compiled from the template sources on every request.

Actions overview

Action	Description
`TestModeOn`	Activates test mode, optionally with debugging, simulated failed payments, the signal for the test API of the WEBSALE search, and compiling the views on every request.
`TestModeOff`	Deactivates test mode.
`TestModeChange`	Changes the switches of the active test mode without leaving it.

Actions

TestModeOn

This action activates test mode. The user must provide the configured test mode password. With the makePaymentFail parameter, payments in test mode are additionally simulated as failed. This causes orders to run into the error case on purpose, so that the templates and workflows designed for it can be checked. The current configuration can be queried in the template via $wsTestMode. With the searchTestApi parameter, you signal to the storefront that it should use the test API of the WEBSALE search instead of the production API. The switch does not change anything in the shop itself. The shop does not call the WEBSALE search itself but passes the value on via $wsTestMode.searchTestApi. With the compileTemplates parameter, the shop compiles the views from the template sources on every request instead of loading them from the precompiled theme. This makes changes to the templates visible immediately. Due to the associated time cost, this setting is only suitable for testing. The current configuration can be queried via $wsTestMode.compileTemplates. Switches that are not checked in the form are off after activation. Usage example
Can be used on the test mode page (testMode.htm), through which shop operators or testers can activate test mode with a password to see test-specific content. Parameters

Name	Description
`password`	The password for activating test mode.
`debug`	Activates extended debugging (value: “`on`”).
`makePaymentFail`	Simulates payments in test mode as failed (value: “`on`”).
`searchTestApi`	Signals to the storefront that it should use the test API of the WEBSALE search (value: “`on`”).
`compileTemplates`	Compiles the views from the template sources on every request instead of from the precompiled theme (value: “`on`”).

Error codes

Error code	Description
`noPassword`	Parameter `password` is missing or empty.
`invalidPassword`	The specified password is incorrect.
`tooManyAttempts`	Access to test mode is temporarily blocked for the caller’s IP address due to too many failed password attempts (provided the lock is enabled via `ipBlockEnabled`). You define the limits and lockout duration under general.testMode.

Related modules, variables & methods

Example showing how test mode is activated via a password form. Debugging, simulated failed payments, and the signal for the test API of the WEBSALE search are optional.

{{ var $cActionTestModeOn = $wsActions.create("TestModeOn") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $cActionTestModeOn.csrf }}">
    <input type="hidden" name="wsact" value="{{= $cActionTestModeOn.id }}">
    <input type="hidden" name="wstarget" value="/">
    <input type="password" name="password">
    <input type="checkbox" name="debug" value="on"{{ if $wsTestMode.debug }} checked{{ /if }}>
    <input type="checkbox" name="makePaymentFail" value="on"{{ if $wsTestMode.makePaymentFail }} checked{{ /if }}>
    <input type="checkbox" name="searchTestApi" value="on"{{ if $wsTestMode.searchTestApi }} checked{{ /if }}>
    <input type="checkbox" name="compileTemplates" value="on"{{ if $wsTestMode.compileTemplates }} checked{{ /if }}>
    <button type="submit">Activate test mode.</button>
</form>

TestModeOff

This action deactivates test mode and the shop returns to normal live operation. Usage example
Can be used on the test mode page or in the shop header to deactivate test mode directly in the shop. Related modules, variables & methods

Example showing how test mode is deactivated via a button.

{{ var $myActionTestModeOff = $wsActions.create("TestModeOff") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionTestModeOff.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionTestModeOff.id }}">
    <input type="hidden" name="wstarget" value="/">
    <button type="submit">Deactivate test mode.</button>
</form>

TestModeChange

This action lets you change the switches of the active test mode without leaving test mode. The prerequisite is that test mode was previously activated with the password.

When saving via the form, the action always sets all switches. The browser does not send an unchecked checkbox at all. A switch that is missing from the form or not checked is therefore off after saving. For this reason, include all switches in the form. This does not apply via the Storefront API. There, testMode/update only changes the switches that are sent.

Usage example
Can be used on the test mode page, for example to switch off debugging while test mode is active without ending test mode. Parameters

Name	Description
`debug`	Activates extended debugging (value: “`on`”). If the parameter is missing, debugging is switched off.
`makePaymentFail`	Simulates payments in test mode as failed (value: “`on`”). If the parameter is missing, the simulation is switched off.
`searchTestApi`	Signals to the storefront that it should use the test API of the WEBSALE search (value: “`on`”). If the parameter is missing, the switch is switched off.
`compileTemplates`	Compiles the views from the template sources on every request instead of from the precompiled theme (value: “`on`”). If the parameter is missing, the switch is switched off.

Error codes

Error code	Description
`notAllowed`	Test mode is not active for the session. Activate it first via TestModeOn.

Related modules, variables & methods

Example showing how the switches of the active test mode are changed.

{{ var $myActionTestModeChange = $wsActions.create("TestModeChange") }}
<form method="post" action="{{= $wsViews.current.url() }}">
    <input type="hidden" name="wscsrf" value="{{= $myActionTestModeChange.csrf }}">
    <input type="hidden" name="wsact" value="{{= $myActionTestModeChange.id }}">
    <input type="hidden" name="wstarget" value="/">
    <input type="checkbox" name="debug" value="on"{{ if $wsTestMode.debug }} checked{{ /if }}>
    <input type="checkbox" name="makePaymentFail" value="on"{{ if $wsTestMode.makePaymentFail }} checked{{ /if }}>
    <input type="checkbox" name="searchTestApi" value="on"{{ if $wsTestMode.searchTestApi }} checked{{ /if }}>
    <input type="checkbox" name="compileTemplates" value="on"{{ if $wsTestMode.compileTemplates }} checked{{ /if }}>
    <button type="submit">Save settings</button>
</form>

Frontend

The basics

Getting started

Feature overview

Examples

Reference – Actions

Reference – Language

Reference – Modules

Actions overview

Actions

TestModeOn

TestModeOff

TestModeChange

​Actions overview

​Actions

​TestModeOn

​TestModeOff

​TestModeChange

Actions overview

Actions

TestModeOn

TestModeOff

TestModeChange