Cannot use the `SimplePlugin` for debugging purpose

[llaville]

Always in context of issue #290, here is another use case I wanted to share !

As CaptainHook seems not to have, by default, a plugin to debug actions, I've found

https://github.com/captainhook-git/captainhook/blob/e2a8cf4221af59a7c48986ed3f147bc087e29fb4/tests/integration/Plugin/SimplePlugin.php

(that did not changed since origins: 5 years ago) and tried it with such kind of captainhook.json config file

{
    "config": {
        "verbosity": "normal",
        "allow-failure": false,
        "ansi-colors": true,
        "git-directory": ".git",
        "fail-on-first-error": true,
        "plugins": [
            {
                "plugin": "\\CaptainHook\\App\\Integration\\Plugin\\SimplePlugin"
            }
        ],
        "includes": [
            "examples/pre-push.phpunit.json"
        ]
    }
}

And when I run with CaptainHook 5.28.0

vendor/bin/captainhook hook:pre-push --bootstrap vendor-bin/phpunit/vendor/autoload.php --bootstrap vendor/autoload.php -v

I got this exception (with stack limited but enough to understand)

In Plugin.php line 50:

  [CaptainHook\App\Exception\InvalidPlugin]
  \CaptainHook\App\Integration\Plugin\SimplePlugin is not a valid CaptainHook plugin.


Exception trace:
  at /shared/backups/bartlett/captainhook-bin-plugin/vendor/captainhook/captainhook/src/Config/Plugin.php:50

[llaville]

That is interesting because it seems not used ...

composer run-script test:integration

Gave us

> tools/phpunit --testsuite IntegrationTests --no-coverage
PHPUnit 10.5.61 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.2.30
Configuration: /shared/backups/forks/captainhook/phpunit.xml

....                                                                4 / 4 (100%)

Time: 00:05.967, Memory: 26.96 MB

OK (4 tests, 36 assertions)

[llaville]

Plugin syntax as described by documentation https://php.captainhook.info/extend.html#plugins works well except when we use the CaptainHook PHAR distrib.

[llaville]

When I use my own plugin (instead of SimplePlugin) for debugging purpose

<?php

declare(strict_types=1);

namespace Bartlett\CaptainHookBinPlugin;

use CaptainHook\App\Config;
use CaptainHook\App\Plugin;
use CaptainHook\App\Runner\Hook as RunnerHook;

class BinPlugin extends Plugin\Hook\Base implements Plugin\Hook
{
    public function beforeHook(RunnerHook $hook): void
    {
        $this->io->write("Do stuff before hook {$hook->getName()} runs");
    }

    public function beforeAction(RunnerHook $hook, Config\Action $action): void
    {
        $this->io->write("Do stuff before action {$action->getLabel()} runs");
    }

    public function afterAction(RunnerHook $hook, Config\Action $action): void
    {
    }

    public function afterHook(RunnerHook $hook): void
    {
    }
}

It works as expected (when using Composer intallation)

But not with the PHAR version

[sebastianfeldmann]

You can't provide multiple --bootstrap options. Only one will be used.
You would need to create a custom bootstrap.php and require both autoloaders there if you need them both.

[llaville]

@sebastianfeldmann I know now why the SimplePlugin cannot be used with the PHAR distribution. It's not able to load it !

Extract contents of CaptainHook 5.28.2 PHAR copy with BOX 4.6.10 into a local folder created on fly if needed, and following command :

./box-4.6.10.phar extract captainhook.phar local

Then read contents (no tests/ directory where SimplePlugin is located)

.
├── bin
│   └── captainhook
├── .box
│   ├── bin
│   ├── .requirements.php
│   ├── src
│   └── vendor
├── LICENSE
├── .phar
│   ├── meta.json
│   └── stub.php
├── src
│   ├── CH.php
│   ├── Config
│   ├── Config.php
│   ├── Console
│   ├── Event
│   ├── Event.php
│   ├── Exception
│   ├── Git
│   ├── Hook
│   ├── Hooks.php
│   ├── Plugin
│   ├── Runner
│   ├── Runner.php
│   └── Storage
└── vendor
    ├── autoload.php
    ├── captainhook
    ├── composer
    ├── psr
    ├── sebastianfeldmann
    └── symfony

23 directories, 11 files

It could be useful to think to include by default a similar plugin for debugging purpose in next Capt'n Versions ! (but located in the src/ folder.

[sebastianfeldmann]

Ah you are right the SimplePlugin was made only for testing purposes.
But you are also right that it could make sense to include it in the source directory

Will fix this right away

[sebastianfeldmann]

Done! Will be out with the next release :)