Annotation Type WithPlugins


  • @Retention(RUNTIME)
    @Target({METHOD,TYPE})
    @Inherited
    @Documented
    @RuleAnnotation(value=RuleImpl.class,
                    priority=10)
    public @interface WithPlugins
    Indicates that a test requires the presence of the specified plugins.

    Example: @WithPlugin("subversion")

    One can specify a specific minimum version after the plugin name with a suffixed '@'.

    Example: @WithPlugin("subversion@1.54")

    The latter example declares that running the test with older version is pointless, typically because of missing feature.

    In normal mode the annotation guarantees that the plugin is installed in required or later version.

    There is also a pre configured plugins mode, running in this mode means that the ATH is using a war file that (somehow) has already preconfigured all the plugins that are to be tested, in that case the ATH only validates that the pre configured plugin universe is enough to run the tests and don't try to modify the existing plugins in any way.

    If the existing plugin configuration is not enough to run the test the end result depends on the configured value for the configuration property pluginEvaluationOutcome

    • failOnInvalid means the test is to fail if the plugin configuration is not valid for the test
    • skipOnInvalid means the test is to be skipped if the plugin configuration is not valid for the test
    Pre configured plugins mode is activated if and only if pluginEvaluationOutcome has a not null value, by default is not active
    Author:
    Kohsuke Kawaguchi
    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static int PRIORITY  
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String[] value
      See PluginSpec for the syntax.
    • Field Detail

      • PRIORITY

        static final int PRIORITY