Custom modules

@cmd_args @custom_plugins @custom_plugins_discovery
Feature: Discover custom plugins
    Scenarios for discovering custom plugins at runtime

    Examples:
    | command_line   |
    | --list-plugins |

    Background:
        Given a controlled environment
        And a valid configuration
        And a random custom plugin directory

    @successful
    Scenario: Discover the system modules
        When we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id             | description                                                |
        | bootstrap             | Lua plugin for module \S*/plugins/bootstrap.lua            |
        | clang-static-analyzer | Lua plugin for module \S*/plugins/clang-static-analyzer.lua|
        | clang-tidy            | Lua plugin for module \S*/plugins/clang-tidy.lua           |
        | cmake                 | Lua plugin for module \S*/plugins/cmake.lua                |
        | command-line-command  | Command-line-command \(internal\)                          |
        | cppcheck              | Lua plugin for module \S*/plugins/cppcheck.lua             |
        | docker                | Lua plugin for module \S*/plugins/docker.lua               |
        | lcov                  | Lua plugin for module \S*/plugins/lcov.lua                 |
        | make                  | Lua plugin for module \S*/plugins/make.lua                 |
        | ninja                 | Lua plugin for module \S*/plugins/ninja.lua                |
        | pmd                   | Lua plugin for module \S*/plugins/pmd.lua                  |
        | scons                 | Lua plugin for module \S*/plugins/scons.lua                |
        | selector              | Lua plugin for module \S*/plugins/selector.lua             |
        | valgrind              | Lua plugin for module \S*/plugins/valgrind.lua             |

    @error
    Scenario: Fail to find a custom module when the search path is not set properly
        Given a custom module with id <plugin_id>
        When we register the command <command> to use the module <plugin_id>
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should not contain <plugin_id>

        Examples:
        | plugin_id                 | command  |
        | exec-helper-custom-module | Command1 |

    @successful
    Scenario: Discover a custom module by setting the search path in the configuration
        Given a custom module with id <plugin_id>
        When we register the command <command> to use the module <plugin_id>
        And add the search path to the configuration
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id                 | description                                                             | command  |
        | exec-helper-custom-module | Lua plugin for module \S*/custom-plugins/exec-helper-custom-module.lua  | Command1 |

    @successful
    Scenario: The search custom plugin configuration takes precedence over the system modules
        Given a custom module with id <plugin_id>
        When we register the command <command> to use the module <plugin_id>
        And add the search path to the configuration
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id             | description                                                       | command    |
        | make                  | Lua plugin for module \S*/custom-plugins/make.lua                 | Command1   |
        | command-line-command  | Lua plugin for module \S*/custom-plugins/command-line-command.lua | Command1   |

    @successful
    Scenario: Discover a custom module by setting the search path on the command line
        Given a custom module with id <plugin_id>
        When we register the command <command> to use the module <plugin_id>
        And add the search path to the command line
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id                 | description                                                             | command  |
        | exec-helper-custom-module | Lua plugin for module \S*/custom-plugins/exec-helper-custom-module.lua  | Command1 |

    @successful
    Scenario: The search custom plugin command line takes precedence over the system modules
        Given a custom module with id <plugin_id>
        When we register the command <command> to use the module <plugin_id>
        And add the search path to the command line
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id             | description                                                       | command    |
        | make                  | Lua plugin for module \S*/custom-plugins/make.lua                 | Command1   |
        | command-line-command  | Lua plugin for module \S*/custom-plugins/command-line-command.lua | Command1   |

    @successful
    Scenario: The search custom plugin command line parameter takes precedence over the one(s) in the configuration
        Given a custom module with id <plugin_id>
        And the same custom module <plugin_id> on a different location and add it to the command line search path
        When we register the command <command> to use the module <plugin_id>
        And add the search path to the configuration
        And we add the <command_line> as command line arguments
        And we call the application
        Then the call should succeed
        And stdout should contain <plugin_id>
        And stdout should contain regex <description>

        Examples:
        | plugin_id                 | description                                                                   | command  |
        | exec-helper-custom-module | Lua plugin for module \S*/custom-plugins/other/exec-helper-custom-module.lua  | Command1 |

@custom_plugins @custom_plugins_usage
Feature: Using custom plugins
    Scenarios for using custom plugins

    Examples:
    | plugin_id                 | command  |
    | exec-helper-custom-module | Command1 |
    | make                      | Command2 |

    Background:
        Given a controlled environment
        And a valid configuration
        And a random custom plugin directory
        And a custom module with id <plugin_id>
        And a registered command <command> that uses the module <plugin_id>
        And the custom plugin search path is registered in the configuration

    @successful
    Scenario: Check that the custom plugin is called
        When run the <command> command <nb_of_times> in the same statement
        Then the call should succeed
        And the <command> command should be called <nb_of_times> times
        And stderr should be empty

        Examples:    
        | nb_of_times   |
        |   1           |
        |   10          |