Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing the links for Testing guidelines #2253

Merged
merged 5 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ related:
- title: Code coverage
link: docs/scos/dev/guidelines/testing-guidelines/code-coverage.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Executing tests
description: Learn how to execute regular tests, how to test console commands and the publish and synchronize process.
last_updated: Aug 28, 2023
template: concept-topic-template
redirect_from:
- /docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
---

This section guides you through yhe execution of tests in your Spryker-based project. Specifically, it focuses on the following topics:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Setting up tests
link: docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html
- title: Test framework
Expand Down Expand Up @@ -52,11 +52,11 @@ For a better testing experience, Spryker provides some helpers that turn this as

The main helpers involved in the P&S testing are:

- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#queuehelper)
- [StorageHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#storagehelper)
- [SearchHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#searchhelper)
- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#queuehelper)
- [StorageHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#storagehelper)
- [SearchHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#searchhelper)

## P&S testing storage

Expand All @@ -74,10 +74,10 @@ To prepare for the test, do the following:

- Create a `Persistence` test suite for your `*Storage` module.
- Besides some other [helpers](/docs/scos/dev/guidelines/testing-guidelines/test-helpers.html), add the necessary P&S helpers:
- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#queuehelper)
- [StorageHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#storagehelper)
- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#queuehelper)
- [StorageHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#storagehelper)
- Add the `PublishAndSynchronizeTest` class

This being done, you can start testing the entire process.
Expand Down Expand Up @@ -123,10 +123,10 @@ To prepare for the test, do the following:

- Create a `Persistence` test suite for your `*Search` module
- Besides some other [helpers](/docs/scos/dev/guidelines/testing-guidelines/test-helpers.html), add the necessary P&S helpers:
- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#queuehelper)
- [SearchHelper](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#searchhelper)
- [PublishAndSynchronizeHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#publishandsynchronizehelper)
- [EventBehaviorHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#eventbehaviorhelper)
- [QueueHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#queuehelper)
- [SearchHelper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#searchhelper)
- Add the `PublishAndSynchronizeTest` class

This being done, you can start testing the entire process.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Test framework
Expand Down
8 changes: 4 additions & 4 deletions docs/scos/dev/guidelines/testing-guidelines/test-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand All @@ -50,7 +50,7 @@ We strongly recommend reading the documentation of both frameworks to get the be

Codeception offers many handy things to write better and cleaner tests. Many solutions this framework has are built on top of PHPUnit. In the next articles, we will only reference Codeception even if these features are available in PHPUnit as well.

On top of Codeception, we have built the [Testify](https://github.com/spryker/testify/) module, which provides many handy helpers. See [Testify](/docs/scos/dev/guidelines/testing-guidelines/testify.html) for more details on Testify itself, and [Testify Helpers](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#testify-helpers) for details on the existing Testify helpers.
On top of Codeception, we have built the [Testify](https://github.com/spryker/testify/) module, which provides many handy helpers. See [Testify](/docs/scos/dev/guidelines/testing-guidelines/testify.html) for more details on Testify itself, and [Testify Helpers](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#testify-helpers) for details on the existing Testify helpers.

## Basic test setup

Expand Down Expand Up @@ -151,7 +151,7 @@ There are many console commands provided from Codeception, but the most used one

For information on other Codeception console commands, run `vendor/bin/codecept list`.

See [Executing Tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests.html) for details on some commands.
See [Executing Tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html) for details on some commands.

## Testing with Spryker

Expand All @@ -163,7 +163,7 @@ On top of Codeception, we have added a basic infrastructure for tests. We have d

The **Communication** suite can contain unit and functional tests. The controller tests can be used to test like a user that interacts with the browser but without the overhead of the GUI rendering. This suite should be used for all tests that do not need JavaScript.

The **Business** suite can contain unit and functional tests. The facade test is one kind of an API test approach. For more information, see [Test API](/docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html#test-api).
The **Business** suite can contain unit and functional tests. The facade test is one kind of an API test approach. For more information, see [Test API](/docs/scos/dev/guidelines/testing-guidelines/testing-best-practices/best-practices-for-effective-testing.html#test-api).

The **Presentation** suite contains functional tests that can be used to interact with a headless browser. These tests should be used when you have JavaScript on the page under test.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down Expand Up @@ -152,7 +152,7 @@ class YourHelper extends Module
## Next steps

* Learn about the [available test helpers](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html).
* [Execute your tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests.html).
* Learn [how to test console commands](/docs/scos/dev/guidelines/testing-guidelines/executing-tests.html).
* [Execute your tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html).
* Learn [how to test console commands](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html).
* [Configure data builders to create transfers for your tests](/docs/scos/dev/guidelines/testing-guidelines/data-builders.html).
* [Generate code coverage report for your tests](/docs/scos/dev/guidelines/testing-guidelines/code-coverage.html).
6 changes: 3 additions & 3 deletions docs/scos/dev/guidelines/testing-guidelines/testify.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand All @@ -44,7 +44,7 @@ related:

On top of [Codeception](https://codeception.com), Spryker offers some classes to make your test life easier. In the Spryker [Testify](https://github.com/spryker/testify) module, you can find many useful helpers.

The helpers provided within the Testify module let you write your tests way faster and with less mocking required. For the list of the most useful helpers from the Testify module, see [Testify Helpers](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html#testify-helpers).
The helpers provided within the Testify module let you write your tests way faster and with less mocking required. For the list of the most useful helpers from the Testify module, see [Testify Helpers](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/available-test-helpers.html#testify-helpers).

Spryker follows an [API test](/docs/scos/dev/guidelines/testing-guidelines/testing-best-practices.html) approach to have more coverage with less test code. Testing through the API ensures that the underlying wireup code is working properly. With the helpers of the Testify module, you can avoid ending-up in the so-called "mocking hell". The "mocking hell" means that your test contains more mocks than real test code, which makes the test unreadable and hard to maintain.

Expand Down Expand Up @@ -94,4 +94,4 @@ As you can see, this test is much smaller, easier to read, and better understand

* [Set up an organization of your tests](/docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html).
* [Create or enable a test helper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers.html).
* Learn about the [console commands you can use to execute your tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests.html).
* Learn about the [console commands you can use to execute your tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html).
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down Expand Up @@ -83,7 +83,7 @@ These inline comments give the reader of your test method a clear understanding

There are several ways to make your test methods small, easy to read and understand. When your `Arrange` part becomes huge, you can use the tester class and helper classes. If you see too many code lines in this section, you can move the `Arrange` code into the generated `Tester` class.

Additionally, when you want to use the same code in different modules, you can use helpers as described in [Using Another Helper in a Helper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers.html#using-another-helper-in-a-helper).
Additionally, when you want to use the same code in different modules, you can use helpers as described in [Using Another Helper in a Helper](/docs/scos/dev/guidelines/testing-guidelines/test-helpers/test-helpers.html#using-another-helper-in-a-helper).

Take a look into [\SprykerTest\Shared\Customer\Helper\CustomerDataHelper](https://github.com/spryker/customer/blob/master/tests/SprykerTest/Shared/Customer/_support/Helper/CustomerDataHelper.php) - this one can be re-used in many modules to give you CustomerTransfer.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ redirect_from:
- /v1/docs/testing-concepts
- /v1/docs/en/testing-concepts
- /docs/scos/dev/guidelines/testing-concepts.html
- /docs/scos/dev/guidelines/testing-guidelines/testing-concepts.html
related:
- title: Available test helpers
link: docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html
Expand All @@ -31,7 +32,7 @@ related:
- title: Data builders
link: docs/scos/dev/guidelines/testing-guidelines/data-builders.html
- title: Executing tests
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests.html
link: docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html
- title: Publish and Synchronization testing
link: docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html
- title: Setting up tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The *Testing guidelines* section includes the following documents:
* [Available test helpers](/docs/scos/dev/guidelines/testing-guidelines/available-test-helpers.html)
* [Code coverage](/docs/scos/dev/guidelines/testing-guidelines/code-coverage.html)
* [Data builders](/docs/scos/dev/guidelines/testing-guidelines/data-builders.html)
* [Executing tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests.html)
* [Executing tests](/docs/scos/dev/guidelines/testing-guidelines/executing-tests/executing-tests.html)
* [Publish and Synchronization testing](/docs/scos/dev/guidelines/testing-guidelines/publish-and-synchronization-testing.html)
* [Setting up tests](/docs/scos/dev/guidelines/testing-guidelines/setting-up-tests.html)
* [Test framework](/docs/scos/dev/guidelines/testing-guidelines/test-framework.html)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
---

The Spryker Commerce OS is an end-to-end solution for digital commerce. This document contains a business-level description of new features and enhancements.
For information about installing the Spryker Commerce OS, see [Getting started guide](https://documentation.spryker.com/docs/dev-getting-started).
For information about installing the Spryker Commerce OS, see [Getting started guide](/docs/scos/dev/developer-getting-started-guide.html).

## Spryker Commerce OS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
---

The Spryker Commerce OS is an end-to-end solution for digital commerce. This document contains a business-level description of new features and enhancements.
For information about installing the Spryker Commerce OS, see [Getting started guide](https://documentation.spryker.com/docs/dev-getting-started).
For information about installing the Spryker Commerce OS, see [Getting started guide](/docs/scos/dev/developer-getting-started-guide.html).

## PHP 8.0 is the minimum version for all Spryker projects
With 202211.0, Spryker released a new version of its Demo Shops requiring PHP 8.0 as their minimum PHP version. PHP 7.4 will no longer be supported. Spryker's new module releases will only be compatible with PHP version 8.0 or later.
Expand Down