michiruf/laravel-http-automock

Automatically mock http requests when testing

0.2-rc4 2025-02-28 17:15 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^10.0||^11.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• laravel/pint: ^1.14
• laravel/sail: ^1.31
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^3.0
• pestphp/pest-plugin-laravel: ^3.0
• slim/slim: ^4.14
• spatie/laravel-ray: ^1.35

MIT

• laravel
• michiruf
• laravel-http-automock

README

Laravel package for tests to automatically mock HTTP requests using laravels HTTP client and Pest.

Prerequisites

This package currently only works using Pest and laravels HTTP client.

Installation

composer require michiruf/laravel-http-automock --dev

Publish the config:

php artisan vendor:publish --tag="http-automock-config"

Usage

To enable automock, call Http::automock(); inside your tests before executing the requests you want to send to save responses automatically and use them in the next tests runs.

For further examples, please refer to this test.

it('can do stuff with the api', function () {
    Http::automock();
    $response = Http::get('https://api.sampleapis.com/coffee/hot')->json();
    expect($response)->toHaveCount(20, 'There are not 20 hot coffees in the api service');
});

Features & TODOs

In this list, features and TODOs can get noted that come up during usage, development and feedback. Features are just a rough idea, whereas TODOs should get implemented at some point.

• FEATURE: Skip or retry specific responses, e.g. when a 429 error or rate limits occur. Maybe by using one of these approaches:
  • New retryRequestsUntil method
  • New renewUntil - Repeat renewing until the response contains sth.
• FEATURE: Mocks that should be reused for all test methods should be definable. Maybe by specifying a scope for specific requests?
• FEATURE: Configure all options like prevent, renew, ... on a requests basis
• FEATURE: Allow additional persistence of the request (for transparency reasons, not for functionality)
• FEATURE: Pipeline for name resolvers (so that one resolver may change stuff of previous resolvers)
• TODO: Null return for resolvers
• TODO: Resolving multiple Resolvers of one type in a stack resolver will only instantiate one
• TODO: Think about an opt-in approach rather than an opt-out for auto-renew
• TODO: Think about adding more easy resolvers
  • http method (exists)
  • http domain/host
  • http domain/host without subdomain
  • http path
  • more easy hash resolver (however this is possible)
• TODO: Think about versioning file name resolvers, because it is crucial if they change inside a project
• FEATURE: Use Macroable in automock
• TODO: Possibility to provide a closure to renew, ... and other config functions
• TODO: Unit tests

Troubleshooting

Windows git long paths

It might be recommended / essential to use git long paths when generating long file names. To do so, execute

git config --global core.longpaths true

if you want to enable long paths in general or

git config core.longpaths true

to enable long paths in the project.

Validate the setting via

git config --list --show-origin

For more information see here.