Bypass for PHP provides a quick way to create a custom instead of an actual HTTP server to return prebaked responses to client requests.

Bypass for PHP

Bypass for PHP provides a quick way to create a custom instead of an actual HTTP server to return prebaked responses to client requests. This is most useful in tests, when you want to create a mock HTTP server and test how your HTTP client handles different types of responses from the server.

Requirements

• PHP 8.0

Install

To install via composer, run:

composer require --dev ciareis/bypass

Usage

For this demo, lets assume you need to test the service TotalScoreService which calculates the total score of multiple games played by an user.

This service consumes the ficticious API emtudo-games.com/v1/score/USERNAME which returns a list of games in JSON format.

Example:

{
  "games": [
    {
      "name": "game 1",
      "points": 25
    },
    {
      "name": "game 2",
      "points": 10
    }
  ],
  "is_active": true
}

1. Start by opening by pass server

    $bypass = Bypass::open();

The open() method accept the following parameter:

2. Bypass URL & Port

If you have not specified a port, Bypass will be running at http://localhost with a random port number.

To retrive the port, use the method:

$bypass_port = $bypass->getPort(); //for example: 16819

3. Tell Bypass what it should expect

Bypass needs to be informed that a request will be made using the HTTP method get, at the URI /v1/score/USERNAME and it should return a status 200 with a specific JSON body.

    $body = '{"games":[{"name":"game 1","points":25},{"name":"game 2","points":10}],"is_active":true}';
    
    $bypass->expect(method: 'get', uri: '/v1/score', status: 200, body: $body);

The method expect() accepts the following parameters:

4. Use your service with the Bypass URL

    $bypass_port = $bypass->getPort();
    $bypass_url = "http://localhost:{$bypass_port}";
    
    $service = new TotalScoreService();
    $response = $service
        ->setBaseUrl($bypass_url)
        ->getTotalScoreByUsername("johndoe"); //returns 35

5. Stop or shutdown

Bypass can be stopped or shutdown with the following methods:

To stop: $bypass->stop();

To shutdown: $bypass->down();

Full test Method

We recommned you to check Bypass' folder tests to see a working implementation in a TestCase.

Also, you can see below a test example with PEST PHP.

it('properly returns the score by username', function () {
  
    // prepare
    $bypass = Bypass::open();

    $body = '{"games":[{"name":"game 1","points":25},{"name":"game 2","points":10}],"is_active":true}';
    
    $bypass->expect(method: 'get', uri: '/v1/score', status: 200, body: $body);

    $bypass_port = $bypass->getPort();
    $bypass_url = "http://localhost:{$bypass_port}";
    
    $service = new TotalScoreService();
    $response = $service
        ->setBaseUrl($bypass_url)
        ->getTotalScoreByUsername("johndoe");

    expect(35)->toEqual($response);
});

Examples

• if you prefer to use phpunit, you can see an example here
• If you need more example access here

Credits

• Leandro Henrique
• All Contributors

And a special thanks to Daniel

Inspired

Code inspired by Bypass