A simple PHP tool to benchmark PHP scripts.
You can install Benchmarker in different ways:
- Using the
pharfile. Go to the Releases page and download the latestbenchmarker.phararchive. - In an existing project:
And then run it via
$ composer require orbitale/benchmarkervendor/bin/benchmarker. - In a separate directory with Composer:
$ composer create-project orbitale/benchmarker benchmarker $ cd benchmarker/ $ php bin/benchmarker - In a separate directory, using Git:
$ git clone [email protected]:Orbitale/Benchmarker.git $ cd benchmarker/ $ php bin/benchmarker - By building the
.pharfile manually with Box:# Install the project in any directory via "composer create" or "git clone" $ box build # Find the file in build/benchmarker.phar
You can use this command to create test files:
$ benchmarker create test_file.php
No test names provided
Provide a name for one test (or leave empty if you have finished)::
> first test
Provide a name for one test (or leave empty if you have finished)::
> second test
Provide a name for one test (or leave empty if you have finished)::
>
[OK] Created benchmark at test_file.php
See File Format to know what the file will look like and how to create tests in them.
There are two ways to use the benchmarker: sequential or parallel execution.
$ benchmarker run my_test.php --count=1000
(Check the run command help to know other usages)
$ benchmarker parallel test_one.php test_two --count=1000
(Check the parallel command help to know other usages)
ℹ️ Note: Parallelization is only usable with multiple files, else it won't change anything.
A test file must return an iterable with callables, each callable being a test for the benchmark.
You can do anything you want in it: autoload, create global vars, etc.
If you use parallelization, you are guaranteed that a file execution will be isolated from other tests.
Here is an example of a test file:
<?php
declare(strict_types=1);
return (function(){
yield 'simple' => function(){
$a = 'quote';
};
yield 'double' => function(){
$a = "quote";
};
})();You can see more examples in the examples directory.
More coming soon! Stay tuned 😉
This project is highly inspired by http://www.php-benchmark-script.com/ from which the source code is based.