PHPackages jacobstr/matura - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. jacobstr/matura ActiveLibrary[Testing & Quality](/categories/testing) jacobstr/matura =============== A mocha/rspec inspired testing framework for php. v0.2.2(8y ago)3529.1k5[1 PRs](https://github.com/jacobstr/matura/pulls)2MITPHP Since Jul 25Pushed 8y ago4 watchersCompare [ Source](https://github.com/jacobstr/matura)[ Packagist](https://packagist.org/packages/jacobstr/matura)[ RSS](/packages/jacobstr-matura/feed)WikiDiscussions master Synced 4w ago READMEChangelog (1)Dependencies (4)Versions (11)Used By (2) Matura ====== [](#matura) [!\[Gitter\](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/jacobstr/matura?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://camo.githubusercontent.com/b6d0e5b2af3fff8263760493763779f54df76026c95432352483bc535459ea17/68747470733a2f2f7472617669732d63692e6f72672f6a61636f627374722f6d61747572612e737667)](https://camo.githubusercontent.com/b6d0e5b2af3fff8263760493763779f54df76026c95432352483bc535459ea17/68747470733a2f2f7472617669732d63692e6f72672f6a61636f627374722f6d61747572612e737667) An RSpec / Mocha inspired testing tool for php. Requires 5.3+. --- Installation ------------ [](#installation) 1. `composer require "jacobstr/matura ~0.2"` Features -------- [](#features) - [Esperance](http://github.com/jacobstr/esperance) expectation library: `expect($result)->to->have->length(2)`. - A succinct DSL for defining tests. ``` describe('Matura', function ($ctx){ it('should make writing tests fun', function ($ctx) { expect($are_we_having_fun_yet)->to->eql(true); }); }); ``` - Heirarchical blocks to drill down from basic to complex assertions. ``` describe('User', function ($ctx) { describe('Authorization', function ($ctx){ describe('OAuth', function ($ctx) {}); }); }); ``` - `before`, `before_all`, `after`, `after_all`, hooks with a well-defined ordering. ``` describe('User Database', function ($ctx) { foreach(range(1,5) as $repetition) { it('should insert a user', function ($ctx){ $user = $ctx->db->findOne(array( 'username' => $ctx->username; )); expect($user)->to->have->length(1); }); it('should not accumulate users', function ($ctx){ $users = $ctx->db->find(); expect($users)->to->have->length(1); }); } // Executed once for each describe block. before_all(function ($ctx){ $ctx->test_id = uniqid(); $ctx->test_db = 'DB_'.$ctx->test_id; $ctx->db = new Database('localhost', $ctx->test_db); }); // Executed prior to each test (including descendants). before(function ($ctx){ $ctx->username = 'test_user'.$ctx->test_id.uniqid(); $ctx->db->insert(array('username' => $ctx->username)); }); // Executed after each test (including descendants); after(function ($ctx) { $ctx->db->delete(array('username' => $ctx->username)); }); // Executed once at the very end of this describe block. after_all(function ($ctx) { $ctx->db->drop($ctx->test_db); }); }); ``` Assertions ---------- [](#assertions) As mentioned above, Matura uses Esperance as it's assertion library. Here are the core examples that you can use: ``` // Deep Equal(===) expect($object)->to->be($cloned_object); // Approximately Equal(==) expect($object)->to->eql(NULL); // Not Equal/Be/A expect($object)->to->not->be('Walrus') // Type Checking expect($object)->to->be->a('AwesomeObject'); expect($object)->to->be->an('AwesomeObject'); // Truthy expect($success)->to->be->ok(); // Invokability expect($example_func)->to->be->invokable(); // Range Checking expect($number)->to->be->within($start, $finish); // Above expect($number)->to->be->above($floor); // Below expect($number)->to->be->below($ceiling); // Empty expecy($an_array)->to->be->empty(); // Grep expect($greppable)->to->match($regexp); // Exception/Error Throwing expect($function)->to->throw($klass, $expected_msg); // Length expect('bob')->to->have->length(3); // Complex Assertions expect($complex)->to->not->be('Simple')->and->to->be('Complex'); ``` The CLI ------- [](#the-cli) If you run, `bin/mat test test/examples`: [![Matura Shell Output](docs/matura_in_action.gif)](docs/matura_in_action.gif) And the documentation for the standard test command: ``` Usage: test [-g|--grep="..."] [-i|--include="..."] [-x|--exclude="..."] [-d|--trace_depth="..."] path Arguments: path The path to the file or directory to test. Options: --grep (-g) Filter individual test cases by a description regexp. --include (-i) Include test files by a basename(filename) regexp. --exclude (-x) Exclude test files by a basename(filename) regexp. --trace_depth (-d) Set the depth of printed stack traces. --help (-h) Display this help message. --quiet (-q) Do not output any message. --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug --version (-V) Display this application version. --ansi Force ANSI output. --no-ansi Disable ANSI output. --no-interaction (-n) Do not ask any interactive question. ``` Filtering --------- [](#filtering) If you wish to filter specific tests within a suite/file, use `--grep`. Matura will be clever enough to run the requisite before/after hooks. Test Result Association ----------------------- [](#test-result-association) When running before/after hooks Matura will associate any test failures with the currently running test, rather than treating it as a file-level failure. This is particularly useful with Mockery's `close` method, which triggers additional assertions: was a method called, was it called with the right parameters, and so on. For before\_all / after\_all hooks, the failure is associate with the surrounding describe block. Test Organization ----------------- [](#test-organization) By default, Matura filters on the file's basename for anything beginning with `test_`. I'm using the structure below. I might formalize this some time: ``` ├── test // Actual test cases. │   ├── functional // Functional tests. │   │   ├── test_context.php │   │   ├── test_model.php │   │   └── test_ordering.php │   ├── integration // More end-to-end flavored tests. │   │   └── test_test_runner.php │   └── performance // Tests that serve to benchmark your code. │   └── test_stress.php ``` I keep my fixtures in a top-level `support` folder. I've seen these placed in the `test` folder but I chose to keep them tucked away to avoid iterating over them and making the default filter complex. Authoring Tests --------------- [](#authoring-tests) The one key piece is you want to place your tests in the `Matura\Tests` namespace if you're not using PHP 5.6. If you're using 5.6 you can import the functions in Matura\\Tests into your namespace. Further Documentation --------------------- [](#further-documentation) I swear it's not a cop out! Examine the [tests folder](test/functional). - [In what order is everything run?](test/functional/test_ordering.php) - [What is that $ctx parameter?](test/functional/test_context.php) TODOS ----- [](#todos) - There's currently nothing like PHPUnit's backupGlobals. Maybe there shouldn't be - I feel a better way to find inadvertent coupling / dependencies on global variables may be to add functionality that randomizes test ordering. - Backtraces annoyingly include calls internal to the framework. - I'm a fan of [contract tests](http://c2.com/cgi/wiki?AbstractTestCases). Class-based tests seem better suited to them, however, so I'm in need of inspiration wrt to the callback-driven dsl that matura uses. Maybe an invocable class... Thanks! ------- [](#thanks) - [Ben Zittlau](https://github.com/benzittlau) - PHPUsable which brings similar syntax to PHPUnit. Helped me realize this was a worthwhile diversion. ### Health Score 36 — LowBetter than 81% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity33 Limited adoption so far Community20 Small or concentrated contributor base Maturity59 Maturing project, gaining track record Bus Factor1 Top contributor holds 96.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~137 days Recently: every ~259 days Total 9 Last Release 3210d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/70507?v=4)[Jacob Straszynski](/maintainers/jacobstr)[@jacobstr](https://github.com/jacobstr) ![](https://avatars.githubusercontent.com/u/21269670?v=4)[Epson Developer Relations](/maintainers/moverio)[@moverio](https://github.com/moverio) --- Top Contributors [![jacobstr](https://avatars.githubusercontent.com/u/70507?v=4)](https://github.com/jacobstr "jacobstr (77 commits)")[![derekdowling](https://avatars.githubusercontent.com/u/613964?v=4)](https://github.com/derekdowling "derekdowling (2 commits)")[![gitter-badger](https://avatars.githubusercontent.com/u/8518239?v=4)](https://github.com/gitter-badger "gitter-badger (1 commits)") ### Embed Badge ![Health badge](/badges/jacobstr-matura/health.svg) ``` [![Health](https://phpackages.com/badges/jacobstr-matura/health.svg)](https://phpackages.com/packages/jacobstr-matura) ``` ### Alternatives [vimeo/psalm A static analysis tool for finding errors in PHP applications 5.8k77.5M6.7k](/packages/vimeo-psalm)[phan/phan A static analyzer for PHP 5.6k11.2M1.1k](/packages/phan-phan)[behat/behat Scenario-oriented BDD framework for PHP 4.0k96.8M1.9k](/packages/behat-behat)[brianium/paratest Parallel testing for PHP 2.5k118.8M753](/packages/brianium-paratest)[infection/infection Infection is a Mutation Testing framework for PHP. The mutation adequacy score can be used to measure the effectiveness of a test set in terms of its ability to detect faults. 2.2k26.2M1.8k](/packages/infection-infection)[phpbench/phpbench PHP Benchmarking Framework 2.0k13.0M625](/packages/phpbench-phpbench) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)