pmvc-plugin/unit

PMVC Test Framework

0.4.6 2023-09-08 07:55 UTC

Requires

• pmvc-plugin/annotation: *
• pmvc-plugin/dev: *
• pmvc/pmvc: *

MIT

• Hill

• unit-test
• plug-in
• pmvc

README

A simple phpunit wrapper let it support phpunt 4.8.35, 6.5.5, 9.5.0

In another word.

You could use is cross php version 5.5 -> 8.x

function mapping table

Code example

tests/include.php example

<?php

$path = __DIR__ . '/../vendor/autoload.php';
include $path;

\PMVC\Load::plug(
    ['unit' => null],
    [__DIR__ . '/../../']
);

Php TestCase code example

<?php

namespace PMVC\PlugIn\hell_world;

use PMVC\TestCase;

class HelloWorldTest extends TestCase
{

}

CI config example

• Simple plugin
  • https://github.com/pmvc/generator-php-pmvc-plugin/blob/master/generators/app/templates/_circleci/config.yml
• More php version
  • https://github.com/pmvc/pmvc/blob/master/.circleci/config.yml
• Real CircleCI example
  • https://app.circleci.com/pipelines/github/pmvc/pmvc?branch=master

PHPUnit Tip

• Show event

phpunit --log-events-text php://stdout

• show deprecations

phpunit --display-deprecations --testdox

• output debug info

  • extends TestCase
  • https://github.com/pmvc-plugin/unit/blob/main/src/TestCase.php#L127-L130

  $this->dump(/*anything*/);  //fwrite(STDERR, print_r(?, true));

• trigger PMVC dev dump

  • https://github.com/pmvc-plugin/dev/blob/master/tests/DevWithPhpUnitTest.php

• Further integration with the [dev] plugin.

  • https://github.com/pmvc-plugin/dev#debug-with-cli

  \PMVC\plug('dev')->debug_with_cli();
  \PMVC\d(/*something*/);

Install with Composer

1. Download composer

• mkdir test_folder
• curl -sS https://getcomposer.org/installer | php

2. Install by composer.json or use command-line directly

2.1 Install by composer.json

• vim composer.json

{
    "require": {
        "pmvc-plugin/unit": "dev-master"
    }
}

• php composer.phar install

2.2 Or use composer command-line

• php composer.phar require pmvc-plugin/unit
• or
  • composer require pmvc-plugin/unit

Other Polyfills

• https://github.com/Yoast/PHPUnit-Polyfills