Download the PHP package giberti/phpunit-local-server without Composer
On this page you can find all versions of the php package giberti/phpunit-local-server. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download giberti/phpunit-local-server
More information about giberti/phpunit-local-server
Files in giberti/phpunit-local-server
Package phpunit-local-server
Short Description A local HTTP server for PHPUnit tests
License MIT
Informations about the package phpunit-local-server
PHPUnit Local Server
Provides an HTTP server test case for PHPUnit. The server is powered by PHP's built-in server for testing of network related calls.
Installing
This library requires PHP 7.3 or newer, including PHP 8.0, 8,1, and 8.2. It will run with PHPUnit versions 8 and 9.
Usage
- Create a directory that will contain the code you want to execute
- Extend the
\Giberti\PHPUnitLocalServer\LocalServerTestCase
as if you were extending\PHPUnit\Framework\TestCase
- Start a server in the test method or for the entire class
- Make requests against the server
Usage Tips
- Whenever possible, re-use the existing server. Frequent restarts will slow down your tests.
- You can provide a different
php
binary by overriding the static$phpBinary
property on the class.
A single test
Call either the createServerWithDocroot()
or createServerWithRouter()
helper method and then execute your test.
Several tests using the same configuration
To optimize performance of your tests, it's best to re-use the server whenever possible. To make this easier, simply start the server at the beginning of the class by defining a setupBeforeClass()
method with your desired configuration.
Modifying the server runtime version
It's possible to run the server under a different PHP runtime than the version running your test suite. This can help with testing your code under multiple versions of PHP. In the example below, the server will start with the PHP 7.3 and 8.1 executable in /usr/local/bin/
on the host test system. Your path may be different.
Methods
The following methods are provided to interact with the local server.
public bool LocalServerTestCase::createServerWithDocroot(string $docroot)
Creates a local server using a document root.
public bool LocalServerTestCase::createServerWithRouter(string $router)
Creates a local server using a router file. If you are using a framework, this is most likely the index.php
file in your document route.
public void LocalServerTestCase::destroyServer(void)
Removes the local server. Useful to reset the session state. This is automatically called in the tearDownAfterClass()
lifecycle method.
public string LocalServerTestCase::getServerUrl(void)
The port for the server will usually be 8000
, however, it is dynamically assigned in the event of a conflict. The safest way to access the host is to call the getServerUrl()
method and use that as the root for any Url construction.