PluginCompatTesterHook.java

package org.jenkins.tools.test.model.hook;

/**
 * The hook interface for creating custom hooks at different points in 
 * the plugin compat tester.
 *
 * Hooks can be called at various points within the process, enabling
 * per-plugin, or all-plugin customization. This includes pom 
 * transformations, adding maven arguments, and other actions that 
 * enable the PluginCompatTester to actually go about testing the plugin
 * rather than throwing up its hands in defeat.
 *
 */

import java.util.Arrays;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

 public interface PluginCompatTesterHook {

     /**
      * Check if the plugin should be affected by this hook.
      * There are several different ways this could be implemented, 
      * and the details are left up to the user.
      *
      * Always run this hook unless otherwise specified.
      */
     default boolean check(Map<String, Object> info) throws Exception {
         return true;
     }

     /**
      * The core action of what actually needs to be done by the hook.
      * This can do a number of things such as transform the pom,
      * return custom maven args, etc.
      *
      * Certain implementations could throw exceptions.
      */
     public Map<String, Object> action(Map<String, Object> moreInfo) throws Exception;

     /**
      * List the plugins this hook affects.  This can be a single, list, or simply all.
      *
      * Apply this hook to all plugins unless otherwise specified.
      */
     default List<String> transformedPlugins() {
         return new ArrayList<String>(Arrays.asList("all"));
     }

     /**
      * Check that the object used for this hook. 
      */
     public abstract void validate(Map<String, Object> toCheck) throws Exception; 
 }