Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 4.46 KB

optimizing-tests.md

File metadata and controls

75 lines (47 loc) · 4.46 KB
title description
Optimizing Tests
Pest offers several optimization techniques to help developers write efficient and high-performing tests. One of the most important is parallel testing, which allows multiple tests to run simultaneously across multiple processes using the `--parallel` option. This can greatly reduce the time it takes to run tests and improve the overall performance of your test suite.

Optimizing Tests

Pest offers several optimization techniques to help developers write efficient and high-performing tests. One of the most important is parallel testing, which allows multiple tests to run simultaneously across multiple processes using the --parallel option. This can greatly reduce the time it takes to run tests and improve the overall performance of your test suite.

Additionally, Pest provides the --profile flag to quickly identify slow-running tests, allowing you to optimize their execution.

Finally, it's often useful to focus solely on your test suite's failures. To do this, you can utilize the --compact printer when running Pest. This instructs Pest to only display information regarding your test suite's failing tests.

Parallel Testing

Parallel testing in Pest 2 now runs up to 80% faster. This impressive result was only possible thanks to a complete rebuild of the parallel test core system. The new core incorporates advanced techniques for process reuse between test case runs.

By default, Pest executes your tests sequentially within a single process. However, you can significantly decrease the time needed to run your tests by utilizing the --parallel option to run tests concurrently across multiple processes.

./vendor/bin/pest --parallel

When running tests in parallel, Pest will create a process for each available CPU core on your machine. However, you can manually modify the number of processes using the --processes option.

./vendor/bin/pest --parallel --processes=10

Here are some important points to consider when writing tests that will be executed in parallel:

  1. Database resources may not be shared between tests: Each test should be isolated and independent from other tests.
  2. Test order may not be guaranteed: Tests should not rely on any specific order of execution.
  3. Tests may be affected by race conditions: Race conditions can occur when multiple processes or threads are accessing shared resources. Make sure to design your tests to handle potential race conditions and avoid them whenever possible.

Profiling

Imagine you have a large test suite that takes several minutes to run. You've noticed that some tests take significantly longer than others, but you're not sure which tests are the slowest or what's causing the slowdown.

To identify the slowest tests and optimize their execution, you can use Pest's --profile option. When you run your test suite with this flag enabled, Pest will collect the duration of each test and provide a report that highlights the slowest tests.

./vendor/bin/pest --profile

For example, imagine you run your test suite and see the following output:

You can see that the UserTest > create user and OrderTest > create order tests are taking significantly longer than the other tests. By analyzing this test, you may discover that it's executing several inefficient database queries or performing other expensive operations that could be optimized to reduce its execution time.

Compact Printer

If you're working with a large number of tests, it can be beneficial to concentrate solely on the failing tests. You can use the --compact printer to instruct Pest to only display test failures, making it easier to pinpoint and resolve any problems without the noise of all of your successful tests.

Furthermore, since the --compact printer produces simpler output, test speed can be improved by a few milliseconds since there is less input / output required for each test.

You may even configure Pest to always use the compact printer so you don't have to specify the --compact option every time you run your test suite.

// tests/Pest.php
pest()->printer()->compact();

//

Now that you have learned how to speed up your test suite, let's move on to discussing Continuous Integration: Continuous Integration