Skip to content

Custom action

Implement🔗

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
package my.custom.package

import com.chutneytesting.action.spi.Action;
import com.chutneytesting.action.spi.injectable.Input;
import com.chutneytesting.action.spi.injectable.Logger;

public class CustomAction implements Action {

    private final Logger logger;
    private final String parameter;

    public CustomAction(Logger logger,
                        @Input("parameter") String parameter) {
        this.logger = logger;
        this.parameter = parameter;
    }

    @Override
    public ActionExecutionResult execute() {
        logger.info("My custom action");
        return ActionExecutionResult.ok();
    }

    @Override
    public List<String> validateInputs() {
        return Action.super.validateInputs();
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package my.custom.package

import com.chutneytesting.action.spi.Action;
import com.chutneytesting.action.spi.injectable.Input;
import com.chutneytesting.action.spi.injectable.Logger;
import com.chutneytesting.action.spi.injectable.Target

public class CustomAction2 implements Action {

    private final Target target;
    private final Logger logger;
    private final String parameter;

    public CustomAction(Target target,
                        Logger logger,
                        @Input("parameter") String parameter) {
        this.target = target;
        this.logger = logger;
        this.parameter = parameter;
    }

    @Override
    public ActionExecutionResult execute() {
        logger.info("My custom action");
        if (parameter.equals("parameter_value")) {
            String outputObject = "output value";
            return ActionExecutionResult.ok(Map.of("outputKey", outputObject));
        } else {
            logger.error("parameter is not valid !");
            return ActionExecutionResult.ko();
        }
    }

    @Override
    public List<String> validateInputs() {
        return Action.super.validateInputs();
    }
}

Package🔗

  1. Declare your custom actions full class names inside the file META-INF/extension/chutney.actions. 

    1
2
    my.custom.package.CustomAction1
my.custom.package.CustomAction2

  2. Add your custom actions' code and meta file in the classpath of a Chutney engine.

    Custom action starting server debug log

    Checking your log, you will see something like

    1
2
    [main] DEBUG c.c.a.d.DefaultActionTemplateRegistry - Action registered: custom-action-1 (my.custom.package.CustomAction1)
[main] DEBUG c.c.a.d.DefaultActionTemplateRegistry - Action registered: custom-action-2 (my.custom.package.CustomAction2)

Add custom actions to an already packaged Chutney server

  1. Package a JAR archive with your custom actions and associated meta file.
  2. Use the loader.path Java system properties to add your archive to classpath.

Use🔗

1
2
3
CustomAction(
    parameter = "parameter_value"
)

1
2
3
4
CustomAction2(
    target = "CUSTOM_TARGET",
    parameter = "some value",
)