This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new 7173b6149d Batch 12: Result sections for Send SNMP trap, Send Nagios
passive check, Run pipeline unit tests, Delete execution information and Set
password encoder. #8970 (#9197)
7173b6149d is described below
commit 7173b6149d99f699376375ecd48c9655b4bf8fee
Author: Adalennis <[email protected]>
AuthorDate: Mon Nov 2 15:38:12 2026 +0100
Batch 12: Result sections for Send SNMP trap, Send Nagios passive check,
Run pipeline unit tests, Delete execution information and Set password encoder.
#8970 (#9197)
* Batch 12: Result sections for Send SNMP trap, Send Nagios passive check,
Run pipeline unit tests, Delete execution information and Set password encoder.
#8970
* Delete execution information, Send Nagios passive check and Send SNMP
trap: project ids, connection timeout and invalid ports, after review. #8970
---
.../workflow/actions/deleteexecutioninfo.adoc | 18 ++++++++++++++++
.../pages/workflow/actions/runpipelinetests.adoc | 15 +++++++++++--
.../workflow/actions/sendnagiospassivecheck.adoc | 25 +++++++++++++++++-----
.../pages/workflow/actions/setpasswordencoder.adoc | 15 +++++++++++++
.../ROOT/pages/workflow/actions/snmptrap.adoc | 23 ++++++++++++++++----
5 files changed, 85 insertions(+), 11 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteexecutioninfo.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteexecutioninfo.adoc
index 9acf89bed2..a51c1c845c 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteexecutioninfo.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteexecutioninfo.adoc
@@ -49,3 +49,21 @@ Place it in a workflow that you run on a schedule when a
location should not kee
|===
An execution with no start date is deleted together with the ones that are old
enough. Children of a deleted execution are removed with it.
+
+== Result
+
+What this action passes on to the next action. See
xref:workflow/action-results.adoc[Action results] for how results travel
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The executions were deleted, with 0 errors. No execution to delete, or a
root folder that doesn't exist yet, is also true. The result is not used for
hops: see the WARNING.
+|False|The number of errors is 1. *Execution information location* is empty or
doesn't exist, *Older than* is empty, 0, negative or not a number while *Delete
all executions in this location* is unchecked, or an execution can't be deleted
(for example a read-only folder).
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|Lines deleted|The number of executions deleted. A File location counts each
run once, with everything it ran (child pipelines, actions, transforms). A
Caching file location counts the workflow and each pipeline it ran separately.
When the action is false, the value of the previous action is passed on.
+|===
+
+WARNING: A success or failure hop from this action is never followed, whatever
the result: only an unconditional hop is. The result and the metrics are still
passed on to the next action.
+
+NOTE: A Caching file location only deletes the executions of the project the
workflow runs in, when both have a project id: an execution stored without
project id is deleted from any project, and a workflow that runs in a project
without project id deletes the executions of every project. A File location
deletes the executions of every project that writes to it.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
index b027406f1c..4a95d47089 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/runpipelinetests.adoc
@@ -33,10 +33,21 @@ Errors are logged.
[options="header", width="90%", cols="1,3"]
|===
|Option|Description
-|Action Name|The name of the action.
-|Test names|The names of the unit tests to execute
+|Action name|The name of the action.
+|Names of the tests to execute|The names of the unit tests to execute.
|===
Use the `Get test names` to get the list of available unit tests in the
current project.
+== Result
+What this action passes on to the next action. See
xref:workflow/action-results.adoc[Action results] for how results travel
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|Every test in the list ran its pipeline without errors and the golden
data sets matched, with 0 errors. An empty list is also true.
+|False|The number of errors is 1. A test is not found (an unknown or empty
name), its pipeline file is not found, the pipeline fails, or the rows don't
match a golden data set. All the tests of the list are run, also after one that
fails.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged: the rows that a test pipeline copies to its
result are not added.
+|===
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
index 264c980398..b745701054 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/sendnagiospassivecheck.adoc
@@ -39,15 +39,15 @@ More details and setup instructions for the Nagios NSCA
addon can be found at th
|Option|Description
2+|Server
|Action name|The name of the workflow action.
-|Host Name/IP Address|Nagios server name / IP Address
-|Server port|Nagios server port (often 5667).
+|Host name/IP address|Nagios server name / IP Address
+|Server port|Nagios server port (default 5667). A value that is not a number
is replaced by 5667; a number that is not a valid port (for example 70000)
makes the action false.
|Password|The password to connect to the Nagios server NSCA (shared between
the Nagios server and the client).
This field can be set empty when connections without password are allowed.
-|Connection Timeout|Fail after the specified connection timeout in
milliseconds (default 5000).
+|Connection timeout|Fail after the specified connection timeout in
milliseconds (default 5000).
|Response Timeout|Fail after the specified response timeout in milliseconds
(default 10000).
2+|Sender
-|Host Name/IP Address|Define your sender host name / IP Address.
-|Service Name|Define the service name used to log the events.
+|Name/ IP host|Define your sender host name / IP Address. When it is empty,
the name of the machine that runs the workflow is sent.
+|Service name|Define the service name used to log the events. When it is
empty, `UNDEFINED` is sent.
|Encryption mode a|Encryption mode for the connection. The available options
are
* None (default)
@@ -61,3 +61,18 @@ This field can be set empty when connections without
password are allowed.
* Critical
|Message|The message to get logged.
|===
+
+== Result
+
+What this action passes on to the next action. See
xref:workflow/action-results.adoc[Action results] for how results travel
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The passive check was sent to the NSCA server, with 0 errors. The action
sends the check and closes the connection without waiting for an answer.
+|False|The number of errors is 1. *Host name/IP address* or *Message* is
empty, the host name can't be resolved, *Server port* is a number that is not a
valid port, the server refuses the connection or doesn't answer it within
*Connection timeout*, or the server doesn't send its first packet within
*Response timeout*.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+WARNING: Since Hop 2.18 the action can't send a check: the library it uses
(jsendnsca) needs `commons-lang` 2, which Hop no longer ships. The workflow
stops with `NoClassDefFoundError: org/apache/commons/lang/Validate`, and no hop
from the action is followed. Only an empty *Host name/IP address* or *Message*
still makes the action false. The table above describes the action with that
library available (tested with `commons-lang-2.6.jar` added to the lib folder
of the plugin).
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setpasswordencoder.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setpasswordencoder.adoc
index 87da6bc3b6..44069e0b23 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setpasswordencoder.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/setpasswordencoder.adoc
@@ -50,3 +50,18 @@ The encoder is **process-global**. Changing it affects every
concurrent pipeline
* Inject the key via the environment, a secrets manager, or a key file — never
commit keys into HWF or git.
* Set plugin ID to `Hop` to disable AES for subsequent steps (return to
obfuscation).
* Mixing ciphertext prefixes (`Encrypted`, `AES`, `AES2`) is not supported for
a single active encoder.
+
+== Result
+
+What this action passes on to the next action. See
xref:workflow/action-results.adoc[Action results] for how results travel
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The encoder was initialized, with 0 errors. An empty *Encoder plugin ID*
initializes `Hop`. An *Encoder plugin ID* that doesn't exist is also true: see
the NOTE.
+|False|The number of errors is 1. *Encoder plugin ID* resolves to an empty
value (for example an empty variable), or `AES` or `AES2` finds no key: the
variable named in *Key variable name* is empty, `HOP_AES_ENCODER_KEY` is not
set either, and *Key file path* is empty or the file doesn't exist.
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+NOTE: An *Encoder plugin ID* that doesn't exist only logs an error (`Unable to
find two-way password encoder plugin with ID ...`): the `Hop` encoder is used
instead, and the action is true and logs that it initialized the ID it was
given.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
index 80cca7c24b..49bdd33008 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/snmptrap.adoc
@@ -32,17 +32,32 @@ The `Send SNMP trap` action sends alert messages to a
remote SNMP-enabled device
|Action name|The name of the workflow action.
2+|Server
|Server name / IP address|The server host.
-|Server port|The server port.
+|Server port|The server port (default 162). A value that is not a number is
replaced by 162; a number that is not a valid port (for example 70000) makes
the action false.
|OID|The object identifier.
|Test connection|Can be used to test the connection.
2+|Advanced
-|Target type|Type of target: Community or User.
-|Community string|A user id or password that allows access to a router's or
other device's statistics.
+|Target type|Type of target: Community (SNMP V1) or User (SNMP V3). See the
WARNING under <<Result>>.
+|Community string|A user id or password that allows access to a router's or
other device's statistics (default `public`).
|User|The username to connect to the server
|Passphrase|The password to connect to the server
-|Engine ID|
+|Engine ID|The context engine ID of the SNMP V3 trap (optional).
|Retry|Number of retries.
|Timeout|Timeout in milliseconds
2+|Message
|Message|The message to send.
|===
+
+== Result
+
+What this action passes on to the next action. See
xref:workflow/action-results.adoc[Action results] for how results travel
through a workflow.
+
+[options="header", width="90%", cols="1,3"]
+|===
+|Result|Value
+|True|The trap was sent, with 0 errors. The action doesn't wait for an answer,
so it is also true when nothing listens on *Server port*. An empty *Server name
/ IP address* sends the trap to the local machine, and an empty *OID* or
*Message* is sent as it is.
+|False|The number of errors is 1. *Server name / IP address* can't be
resolved, *Server port* is a number that is not a valid port (for example
70000), or *OID* is not a valid object identifier (for example `abc`).
+|Result files|Passed on unchanged.
+|Result rows|Passed on unchanged.
+|===
+
+WARNING: *User (SNMP V3)* is not kept. When the workflow is loaded from its
file, the target type is read back as *Community (SNMP V1)*, so the action
sends an SNMP V1 trap with *Community string*, and *User*, *Passphrase* and
*Engine ID* are not used.