PHPUnit 5.7：如何Mock file_get_contents函数？

Hey there! Mocking file_get_contents is a super common task when you want to isolate your code from external files or APIs during testing. Let’s break down the most practical approaches you can use in PHP:

If your application code lives in a custom namespace, you can define a local file_get_contents function that overrides the global one—PHP prioritizes namespace-scoped functions over global ones. This is great for quick mocking without extra dependencies.

Here’s an example:

namespace App;

// Your mock implementation
function file_get_contents($filename, $use_include_path = false, $context = null, $offset = 0, $length = null) {
    // Return tailored mock data based on the input filename/URL
    if ($filename === 'https://api.example.com/user-data') {
        return json_encode(['user_id' => 123, 'username' => 'mocked_user']);
    }
    
    // Optional: Fall back to the real global function for other cases
    return \file_get_contents($filename, $use_include_path, $context, $offset, $length);
}

// In your application code (same namespace)
$userData = file_get_contents('https://api.example.com/user-data');
var_dump($userData); // Outputs the mocked JSON string

When writing unit tests, you have two solid options with PHPUnit:

Option A: Namespace-Based Mock in Test Files #

Define the mock function directly in your test’s namespace, so your test code uses it instead of the global function:

namespace Tests\Unit;

use PHPUnit\Framework\TestCase;
use App\FileReader; // Your class that uses file_get_contents

// Mock function in the test namespace
function file_get_contents($filename) {
    return match($filename) {
        'config.txt' => 'DEBUG=true',
        default => '',
    };
}

class FileReaderTest extends TestCase {
    public function testReadingConfigFile() {
        $reader = new FileReader();
        $configContent = $reader->getConfig('config.txt');
        
        $this->assertEquals('DEBUG=true', $configContent);
    }
}

Option B: Using PHPUnit’s MockFunction (PHP 8+, PHPUnit 9+) #

For more control (like verifying how many times the function was called), use PHPUnit’s MockFunction class:

use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\MockObject\MockFunction;

class ApiClientTest extends TestCase {
    public function testApiRequest() {
        // Create a mock for the global file_get_contents function
        $mockFunction = new MockFunction('file_get_contents', $this);
        
        // Set expectations: should be called once with the API URL, return mock response
        $mockFunction->expects($this->once())
            ->with('https://api.example.com/endpoint')
            ->willReturn('{"status": "success"}');
            
        // Run your code that calls file_get_contents
        $response = file_get_contents('https://api.example.com/endpoint');
        
        // Assert the result matches our mock
        $this->assertEquals('{"status": "success"}', $response);
    }
}

If you absolutely need to redefine the global file_get_contents function (outside of namespaces), you can use the runkit7 extension. Note that this requires installing an extension and isn’t portable, so it’s not ideal for most projects.

Example:

// Install first via PECL: pecl install runkit7
runkit_function_redefine(
    'file_get_contents',
    '$filename',
    'return "Mocked global content regardless of input";'
);

echo file_get_contents('any-file-or-url.txt'); // Outputs the mocked string

Quick Notes #

• If you’re mocking HTTP requests, consider using a dedicated HTTP client like Guzzle with its built-in mocking tools instead of directly mocking file_get_contents—it’s cleaner for API interactions.
• Always make sure your mock function accepts all the same parameters as the real file_get_contents to avoid argument mismatch errors.

内容的提问来源于stack exchange，提问作者fatma_wings