mathiasverraes / TestFrameworkInATweet.php
Last active

Embed URL

HTTPS clone URL

SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

A unit testing framework in a tweet.

View TestFrameworkInATweet.php
Raw
File suppressed. Click to show.
1 2 
<?php

function it($m,$p){echo ($p?'✔︎':'✘')." It $m\n"; if(!$p){$GLOBALS['f']=1;}}function done(){if(@$GLOBALS['f'])die(1);}
View TestFrameworkInATweet.php
Raw
File suppressed. Click to show.
1 2 3 4 5 
<?php

require_once 'TestFrameworkInATweet.php';

it("should sum two numbers", 1+1==2);

it("should display an X for a failing test", 1+1==3);

done();
Owner
mathiasverraes commented

Output:

✔︎ It should sum two numbers
✘ It should display an X for a failing test

The script will end with exit code 1 for failures.

Owner
mathiasverraes commented

Should you use this in production?

Let's throw statistics at the problem, so we don't have to do any actual thinking. According to Code Complete, the industry average is

"about 15 - 50 errors per 1000 lines of delivered code."

Let's be pessimistic and say that #TestFrameworkInATweet contains 50/1000 = 0.05 bugs. This is of course UNACCEPTABLE.

However, as a testing framework, it should help you to dramatically decrease the defect rate of your code. So let's say you write one line of code, with an expected avg(0.015, 0.05) = 0.0325 bugs. Using #TestFrameworkInATweet's awesome bug reduction capacity, you've now reduced the expectancy to 0.0001 bugs. Add that to #TestFrameworkInATweet's own 0.05 bugs, you have increased your system from 0.0325 bugs to 0.0501 bugs total, simply by introducing unit testing!

But now say you have a system with two lines of code, your expected bug count drops from 0.0325*2 = 0.065 total to 0.0502 total bugs. With a massive system of 5 LoC, you'll go from 0.1625 to 0.0505 bugs, which is a31% improvement. Awesome!

Conclusion: The logic is infallible. #TestFrameworkInATweet only benefits large systems of >= 2 lines of code.

marcaube commented

If you don't echo anything after your assertions you can even add some colours, 137 chars total.

<?php
function it($m,$p){echo "\033[".($p?"32m✔":"31m✘")." It $m\n"; if(!$p){$GLOBALS['f']=1;}}function done(){if(@$GLOBALS['f'])die(1);}
Xeoncross commented

Remove the brackets around the the global assignment and use short open tags. The code is still is only 139 characters even while adding the closing color code (\033[0m).

<? function it($m,$p){echo "\033[".($p?"32m✔":"31m✘")." It $m\033[0m\n"; if(!$p)$GLOBALS['f']=1;}function done({if(@$GLOBALS['f'])die(1);}
Xeoncross commented

If you want to get really sloppy you can register a chain of N shutdown functions for a slim 120 characters.

<?php function it($m,$p){echo "\033[".($p?"32m✔":"31m✘")." It $m\033[0m\n"; if(!$p)register_shutdown_function('die',1);}

Update: Actually, that doesn't work. It doesn't like 'die' as a callback function for some reason. Here is the 132 character version:

<?php function it($m,$p){echo "\033[".($p?"32m✔":"31m✘")." It $m\033[0m\n"; if(!$p)register_shutdown_function(function(){die(1);});}
Xeoncross commented

For those that would rather not write a description for each test you can try this 199 character beast that reports the tests verbatim:

function test($p){
    $t=debug_backtrace(0)[0];$m=substr(trim(file($t['file'])[$t['line']-1]),5,-2);
    echo "\033[".($p?"32m✔":"31m✘")." $m\033[0m\n";
    if(!$p)register_shutdown_function(function(){die(1);});
}

test(1+1==2);
test(1+1==3);

Produces: 

✔ 1+1==2
✘ 1+1==3

Requires PHP 5.4 to use the array dereferencing.

ciaranmcnulty commented

I know you were going for the constraint rather than 'smallest possible' but I trimmed it to 108 chars:

function it($m,$p){echo $p?'✔︎':'✘'," It $m\n"; @$GLOBALS[f]&=!!!$p;}function done(){@$GLOBALS[f]?:die(1);}
Owner
mathiasverraes commented

I wrote an exception matching plugin in a tweet:

<?php
function throws($exp,Closure $cb){try{$cb();}catch(Exception $e){return $e instanceof $exp;}return false;}

Usage:

<?php
it("should pass when the expected exception is thrown", 
    throws("InvalidArgumentException", function () {
        // The SUT throws an exception
        throw new InvalidArgumentException; 
}));

it("should fail when the wrong kind of exception is thrown", 
    throws("InvalidArgumentException", function () {
        throw new RuntimeException;
}));

it("should fail when no exception thrown", 
    throws("InvalidArgumentException", function () {
        // no op
}));

Produces:

✔︎ It should pass when the expected exception is thrown
✘ It should fail when the wrong kind of exception is thrown
✘ It should fail when no exception thrown
Owner
mathiasverraes commented

Also, you guys rock!

turanct commented

Interface matching, but couldn't get it to fit in a tweet when stripping it down... :-( maybe one of you can?

<?php

/**
 * Matcher for interfaces
 *
 * @param string $interface The interface name
 * @param mixed  $object    A valid classname or an object
 *
 * @return bool
 */
function hasInterface($interface, $object)
{
    try {
        $reflection = new ReflectionClass($object);
    } catch (Exception $e) {
        return false;
    }

    return in_array((string) $interface, $reflection->getInterfaceNames());
}

Usage:

<?php

it("should pass when the expected interface is implemented",
    hasInterface('Countable', new RecursiveArrayIterator(array()))
);

it("should pass when the expected interface is implemented",
    hasInterface('Countable', 'RecursiveArrayIterator')
);

it("should fail when the expected interface is not implemented",
    hasInterface('Countable', new RecursiveDirectoryIterator(__DIR__))
);

it("should fail when the given object doesn't exist.",
    hasInterface('Countable', '')
);

Produces:

✔︎ It should pass when the expected interface is implemented
✔︎ It should pass when the expected interface is implemented
✘ It should fail when the expected interface is not implemented
✘ It should fail when the given object doesn't exist.
turanct commented

@SpacefulSpecies, too bad that class_implements doesn't throw exceptions, it shouts warnings at you when you give it an erronious class name... You can then indeed use the ugly @-way to create a function doing the same thing as what i posted before, while getting it to fit in a tweet, like this:

<?php
function hasInterface($i, $o){$is=@class_implements($o, false);return in_array((string) $i, (array) $is);}

but i'd really rather not use the @ sign to suppress errors.

Owner
mathiasverraes commented

but i'd really rather not use the @ sign to suppress errors.

Wait a minute. You're trying to write to write good code. In a tweet. In a plugin for a piece of code that uses globals. :-O

Also, why do you want to test on interfaces?

turanct commented

Those are all valid points :-) maybe that was too eager of me.

Isn't it practical or useful in some cases to test on interfaces? For instance to describe the identity of your class before you start writing it? I could be wrong but i thought phpspec had something like it, and it looked like a fun challenge to make it work here too.

Owner
mathiasverraes commented

PHPSpec has it as a default, but if you watch presentations by Marcello, it's the first thing he removes :). There are rare case where you'd want to test if an object implements a certain interface. TestFrameworkAsATweet has a built-in feature to deal with that, but it is undocumented and untested at this time. Use at your own peril!

<?php
it("should implement the Awesome interface", $object instanceof Awesome);

Bam! TestFrameworkInATweet has everything! Please test thoroughly and submit bug reports for any issues you might find. Who needs bloated frameworks like phpspec? That has like, I don't know, probably MORE THAN 100 LINES OF CODE!!!11!!

adambrett commented

134 character plugin to add Mockery support to TestFrameworkInATweet:

<?php
function withMock(Closure $cb){$cb();try{Mockery::close();}catch(Exception $e){echo $e->getMessage()."\n";return false;}return true;}

Usage:

<?php
use Mockery as m;

it('should use SomeInterface to do Something', withMock(function () {
    $mock = m::mock('SomeInterface');
    $mock->shouldReceive('someMethod')
        ->with('someValue')
        ->once()
        ->andReturn(true);

    $sut = new SystemToTest($mock);
    $sut->test();
});

Output:

Method someMethod("someValue") from Mockery_0_SomeInterface should be called
 exactly 1 times but called 0 times.
✘ It should use SomeInterface to do Something
adambrett commented

Code-coverage support in 144 characters!

<?php
function cc($c){foreach($c as $f=>$z){
$s=file($f);$r=0;foreach($s as $l=>$x){if(isset($z[++$l])){($z[$l]==1)&&$r++;}}yield [$f,$r,count($z)];}}

Usage:

<?php

xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);


it('should do stuff here', true);

foreach (cc(xdebug_get_code_coverage()) as list($file, $run, $total)) {
    echo "$file: $run/$total lines\n";
}

Some cavats: PHP 5.5+ only, not much use on its own needs as it needs an output function too, and it includes code coverage in test and vendor files.

Here's an example text report function in 116 chars:

<?php
function cc_text($c) {echo "Code Coverage: \n\n";foreach($c as list($f,$r,$t)){echo "$f: $r/$t lines\n";}echo "\n";}

Usage:

<?php

xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);

it('should do stuff here', true);

cc_text(cc(xdebug_get_code_coverage());

Output:

Code Coverage:

/path/to/file.php: 1/2 lines

I reality, you need to filter out test and vendor files, and would like to output in a single function, but I couldn't fit that in a tweet, here's a slightly longer version (185 chars) that does that:

<?php
function cc($c,$p){foreach($c as $f=>$z){if(preg_match($p,$f))continue;
$s=file($f);$r=0;foreach($s as $l=>$x){if(isset($z[++$l])){($z[$l]==1)&&$r++;}}$z=count($z);echo "$f: $r/$z\n";}}

Usage:

<?php
xdebug_start_code_coverage(XDEBUG_CC_UNUSED | XDEBUG_CC_DEAD_CODE);

it('should do stuff here', true);

cc(xdebug_get_code_coverage(), '/test|vendor/i');
Owner
mathiasverraes commented

Multiple assertions in one go:

<?php
function all(array $ps){return array_reduce($ps,function($a,$p){return $a&&$p;},true);}

// usage
it("should do a bunch of calculations", all([
    1+1 == 2,
    1+2 == 1249,
]);
done();

Output:

✘ It should do a bunch of calculations
Process finished with exit code 1
anthonysterling commented

Slightly shorter.

<?php
function all($ps){return $ps===array_filter($ps);}

it('should be shorter than Mathias\' proposal and still work', all([
    strlen('function all($ps){return $ps===array_filter($ps);}') < strlen('function all(array $ps){return array_reduce($ps,function($a,$p){return $a&&$p;},true);}'),
    1+1 === 2,
]));

done();
sambeckham commented

Schoolboy error there Sterling.

<?php
function all($a){return $a===array_filter($a);}

it('should be shorter than Sterling\'s proposal by three characters and still work', all([
    (strlen('function all($ps){return $ps===array_filter($ps);}') - strlen('function all($a){return $a===array_filter($a);}')) === 3,
    1+2 === 3,
]));

done();
marcaube commented

In a way, this whole exercise is reminiscent of those C/Perl code obfuscation contests. It's pretty crafty what one can do in 140 chars.

Pretty awesome!

Owner
mathiasverraes commented

Installation guide with composer

  1. Remove composer.
  2. Go to https://gist.github.com/mathiasverraes/9046427
  3. Copy/paste the entire #TestFrameworkInATweet sourcecode into your own code somewhere.
  4. Write a test.
  5. Get a PHP Fatal error: Call to undefined function it()
  6. Curse. (Or find a more senior developer to teach you some appropriate curses).
  7. Mess around with require_once and relative paths and directory separators and autoloaders for a bit.
  8. Oh look it's beer o'clock, maybe try again on Monday.
everzet commented

Implementation

<?php

function it($m,$p){echo"\033[3",$p?'2m✔︎':'1m✘'.register_shutdown_function(function(){die(1);})," It $m\033[0m\n";}
  • Colours
  • Auto-exit
  • 121 char

Installation guide:

<?php

eval(file_get_contents('https://gist.githubusercontent.com/everzet/8a14043d6a63329cee62/raw/twest.php'));

it('sums up two numbers', 1+1==2);
it('displays an X for a failing test', 1+1==3);
  • Framework auto-update built in.
Owner
mathiasverraes commented

Another article

It also covers some minor frameworks like phpspec and phpunit, but of course the focus is mostly about #TestFrameworkInATweet!

Owner
mathiasverraes commented

Soon we will have full stack frameworks in a tweet! Here is a prioritized event dispatcher in a tweet: https://gist.github.com/xsist10/824b559c4effaf43ddb3

turanct commented

And a REPL in a tweet: gist / tweet

liuggio commented

framework components in tweets https://github.com/liuggio/sized140

lastguest commented

78 chars

function it($m,$p){echo"\033[3",$p?"2m✔":"1m✘"," It $m\033[0m\n";$p||die(1);}
jm42 commented

Dependency injection container in a tweet ... https://gist.github.com/jm42/3c32dd50bb9d09f57c4a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.