Download the PHP package ciareis/bypass without Composer

About | Installation | Writing Tests | Examples | Credits | Inspired

About

Installation

📌 Bypass requires PHP 8.0+.

To install via composer, run the following command:

Video demo

Pest and Bypass

Writing Tests

Content

• Open Bypass Server
• Bypass URL and Port
• Routes
  • Standard Route
  • File Route
  • Bypass Serve and Route Helpers
• Assert Route
• Stop or shut down

🔥 Check out full code examples here section.

1. Open a Bypass Server

To write a test, first open a Bypass server:

Bypass will always run at http://localhost listening to a random port number.

To specify a custom port, just pass it in the argument (int) $port.

2. Bypass URL and Port

You can retrieve the Bypass server URL using getBaseUrl().

If you need to retrieve only the port number, use the getPort() method:

3. Routes

Bypass provides two types of routes: The Standard Route to return a text body content and the File Route, which returns a binary file.

When running your test suit, you should pass the URL created with Bypass to your service. In this way, you will make the service you are testing reach Bypass instead of reaching the real-world API end point.

3.1 Standard Route

The method addRoute() accepts the following parameters:

3.2 File Route

The method addFileRoute() accepts the following parameters:

3.3 Bypass Serve and Route Helpers

Bypass provides you with convenient shortcuts to the most-common-used HTTP requests.

These shortcuts are called "Route Helpers" and are served automatically at a random port using Bypass::serve() without the need to call Bypass::open().

In the next example, Bypasss serves two routes: A URL accessible by method GET returning a JSON body with status 200, and a second route URL accessible by method GET and returning status 404.

Route Helpers

You may find below the list of Route Helpers.

You may also adjust the helpers to your needs by passing arguments:

In the example below, you can see the Helper Route::badRequest using method GET instead of its default method POST.

📝 Note: Custom routes can be created using a Standard Route in case something you need is not covered by the Helpers.

4. Asserting Route Calling

Sometimes you may need to assert that a route was called at least one or multiple times.

The method assertRoutes() will return a RouteNotCalledException if a route was NOT called as many times as defined in the $times parameter.

If you need to assert that a route is NOT being called by your service, set the parameter $times = 0

5. Stop or shut down

Bypass will automatically stop its server once your test is done running.

The Bypass server can be stopped or shut down at any point with the following methods:

To stop: $bypass->stop();

To shut down: $bypass->down();

Examples

Use case

To better illustrate Bypass usage, imagine you have to write a test for a service that calculates the total game score of a given username.

The score is obtained by making an external request to a fictitious API at emtudo-games.com/v1/score/::USERNAME::. The API returns HTTP Status 200 and a JSON body with a list of games:

Quick Test Examples

Click below to see code snippets for Pest PHP and PHPUnit.

Test Examples

📚 See Bypass being used in complete tests with Pest PHP and PHPUnit for the GithubRepoService demo service.

Credits

• Leandro Henrique
• All Contributors

And a special thanks to @DanSysAnalyst

Inspired

Code inspired by Bypass