draw/command-bundle

This bundle track command execution in the database.

0.7.59 2022-04-06 17:47 UTC

Requires

• doctrine/dbal: ^2.13
• psr/log: @stable
• sensiolabs/ansi-to-html: ^1.2
• symfony/config: ^4.4 || ^5.4
• symfony/console: ^4.4 || ^5.4
• symfony/dependency-injection: ^4.4 || ^5.4
• symfony/expression-language: ^4.4 || ^5.4

Requires (Dev)

• doctrine/orm: ^2.10
• draw/tester: ^0.7.59
• phpunit/phpunit: ^8.0 || ^9.0
• sonata-project/admin-bundle: ^3.105
• sonata-project/doctrine-orm-admin-bundle: ^3.35
• symfony/security-core: ^4.4 || ^5.4

Suggests

• symfony/security-core: If you want to user authentication in command line

MIT

• symfony
• sonata
• command

README

This bundle allows triggering command from the sonata admin. It also logs every command execution in the database even if they have been started from the command line.

Configuration

The configuration lists the commands available from Sonata to be selected and executed:

draw_command:
    sonata:
        commands:
            clearCache:
                commandName: "redis:flushdb"
                label: "Clear Cache"
                icon: "fa-ban"
            reIndexSearch:
                commandName: "fos:elastica:populate"
                label: "Re-Index Search"
                icon: "fa-search-plus"

Logging command execution

All command execution are log in the databases. They also log the output, so you can debug them in case an error happen.

If you want to proper log the output from command line interface you must use the BufferedConsoleOutput for you output in bin/console:

$application->run($input, new \Draw\Bundle\CommandBundle\Console\Output\BufferedConsoleOutput());

Some predefined command are ignored by the command logging. This is a predefined list:

• help
• doctrine:database:drop
• doctrine:database:create
• cache:clear

Todo

• Allow to configure the list of command that are ignored form the logger
• Allow to have argument on the command execution, could be predefined from the configuration, an input in the admin, or a more complex input done by reverse engineering the arguments of a command