Unit Testing

eddiewebb

Anyone have advice where the dev docs are still TBD?

I've tried to reverse engineer the main project, but still composer test:unit says "no tests"

.
| - src
|- tests
 |- unit
  \ ClassNameTest.php

test case:

namespace Webbinaro\Affiliator\Tests\unit;


use Flarum\Testing\unit\TestCase;
use Webbinaro\Affiliator\PostAffiliatorSerializer;

class AffiliatorSerializerTest extends TestCase
{
    
    public function setUp(): void
    {
        parent::setUp();

    }

    /**
     * @test 
     *. Use annotation, prefix and suffix for good measure... :shrug:
     */

    public function test_suffix_added_test()
...

eddies-mbp:flarum-affiliator eddie$ vendor/bin/phpunit -c tests/phpunit.unit.xml  --list-suites
PHPUnit 9.5.13 by Sebastian Bergmann and contributors.

Available test suite(s):
 - Flarum Unit Tests
eddies-mbp:flarum-affiliator eddie$ vendor/bin/phpunit -c tests/phpunit.unit.xml  --list-tests
PHPUnit 9.5.13 by Sebastian Bergmann and contributors.

Available test(s):

eddies-mbp:flarum-affiliator eddie$ composer test:unit
> phpunit -c tests/phpunit.unit.xml
PHPUnit 9.5.13 by Sebastian Bergmann and contributors.

No tests executed!

clarkwinkelmann

The testing documentation for extension should cover everything important already https://docs.flarum.org/extend/testing

How did you generate the test files? Did you use the CLI utility or did you create the files manually?

While I don't think it's required, you could try adding an autoload namespace to the test folder under autoload-dev in composer.json I think the CLI utility does it but the documentation doesn't mention it.

eddiewebb

clarkwinkelmann Almost everything, except the entire section for unit testing says "TODO"

I'm not sure what changed over past 12 hours but it works now.

clarkwinkelmann

eddiewebb oops, sorry, I completely missed that.

The way to run the tests should be identical to integration tests.

And the way to write the tests should be regular PHPUnit code since unit tests are standalone and are by definition not integrated with Flarum.

eddiewebb

clarkwinkelmann 😆 no worries!

Yeah that was my thought, but when they weren't running I thought there might be something special I was missing (it wasn't, the magic was clearly lunar cycles 🤷‍♂️ i did something dumb and fixed it i guess ).

That said, it might be worth some advice and examples on (or if you disagree with):

putting logic in easy to test a method vs the overridden function (which usually requires more "things" to mock)
Key services/common services to mock, ie. Extensions that use settings can mock SettingsRepository to provide values

To your point, that's really maybe just general to php, but it might be nice to encourage good hygiene within this community nonetheless?

if there's value I'm happy to draft something minimal that could encourage folks without being a maintenance issue for y;'all.

askvortsov

eddiewebb To your point, that's really maybe just general to php, but it might be nice to encourage good hygiene within this community nonetheless?

if there's value I'm happy to draft something minimal that could e

That would be fantastic! Developer experience and tooling has been my top priority for a while, but I've been spread a bit thin between all the stuff I want to add, so PHP unit tests haven't gotten the attention they need.

eddiewebb

askvortsov

Rad.

flarum/docs411/files