Merge pull request #6569 from psiinon/automation/alwaysrun

kingthorin · web-flow · commit b7a1e06652b6 · 2025-07-07T11:45:42.000-04:00
automation: add alwaysRun option for all jobs
diff --git a/addOns/automation/CHANGELOG.md b/addOns/automation/CHANGELOG.md
@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## Unreleased
 ### Added
 - Support for exclude regexes to active scan config job.
+- Always run option for all jobs.
 
 ### Changed
 - Job remains selected when moved in the GUI.
diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationJob.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationJob.java
@@ -64,6 +64,7 @@ public enum Status {
     private long timeStarted;
     private long timeFinished;
     private boolean enabled = true;
+    private boolean alwaysRun = false;
 
     public enum Order {
         RUN_FIRST,
@@ -133,6 +134,14 @@ public void setEnabled(boolean enabled) {
         this.enabled = enabled;
     }
 
+    public boolean isAlwaysRun() {
+        return alwaysRun;
+    }
+
+    public void setAlwaysRun(boolean alwaysRun) {
+        this.alwaysRun = alwaysRun;
+    }
+
     public int addDefaultTests(AutomationProgress progress) {
         return ZERO_TESTS;
     }
diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationPlan.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/AutomationPlan.java
@@ -134,15 +134,26 @@ public AutomationPlan(ExtensionAutomation ext, File file) throws IOException {
 
                         Object jobEnabled = jobData.get("enabled");
                         if (jobEnabled != null) {
-                            if (jobEnabled instanceof Boolean) {
-                                job.setEnabled((Boolean) jobEnabled);
+                            if (jobEnabled instanceof Boolean enableBool) {
+                                job.setEnabled(enableBool);
                             } else {
                                 progress.warn(
                                         Constant.messages.getString(
                                                 "automation.error.job.enabled", jobEnabled));
                             }
                         }
 
+                        Object alwaysRun = jobData.get("alwaysRun");
+                        if (alwaysRun != null) {
+                            if (alwaysRun instanceof Boolean jobBool) {
+                                job.setAlwaysRun(jobBool);
+                            } else {
+                                progress.warn(
+                                        Constant.messages.getString(
+                                                "automation.error.job.alwaysrun", alwaysRun));
+                            }
+                        }
+
                         job.setEnv(env);
                         job.setJobData(jobData);
                         job.verifyParameters(progress);
diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/ExtensionAutomation.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/ExtensionAutomation.java
@@ -384,6 +384,10 @@ public AutomationProgress runPlan(AutomationPlan plan, boolean resetProgress) {
 
         for (AutomationJob job : jobsToRun) {
 
+            if (env.isTimeToQuit() && !job.isAlwaysRun()) {
+                continue;
+            }
+
             if (!job.isEnabled()) {
                 progress.info(
                         Constant.messages.getString("automation.info.jobdisabled", job.getType()));
@@ -425,9 +429,6 @@ public AutomationProgress runPlan(AutomationPlan plan, boolean resetProgress) {
                     Constant.messages.getString(
                             "automation.info.jobend", job.getType(), job.getFormattedTimeTaken()));
             progress.addRunJob(job);
-            if (env.isTimeToQuit()) {
-                break;
-            }
         }
         setPlanFinished(plan);
         return progress;
diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/gui/PlanTreeTableModel.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/gui/PlanTreeTableModel.java
@@ -47,17 +47,19 @@ public PlanTreeTableModel(DefaultMutableTreeNode root) {
 
     protected static final int HIERARCHY_INDEX = 0;
     protected static final int ENABLED_INDEX = 1;
-    protected static final int STATUS_INDEX = 2;
-    protected static final int TIME_INDEX = 3;
-    protected static final int TYPE_INDEX = 4;
-    protected static final int NAME_INDEX = 5;
-    protected static final int INFO_INDEX = 6;
+    protected static final int ALWAYS_RUN_INDEX = 2;
+    protected static final int STATUS_INDEX = 3;
+    protected static final int TIME_INDEX = 4;
+    protected static final int TYPE_INDEX = 5;
+    protected static final int NAME_INDEX = 6;
+    protected static final int INFO_INDEX = 7;
 
     private static final String INDENT = "    ";
 
     private static final String[] COLUMN_NAMES = {
         "", // The tree control
         Constant.messages.getString("automation.panel.table.header.enabled"),
+        Constant.messages.getString("automation.panel.table.header.alwaysrun"),
         Constant.messages.getString("automation.panel.table.header.status"),
         Constant.messages.getString("automation.panel.table.header.time"),
         Constant.messages.getString("automation.panel.table.header.type"),
@@ -117,6 +119,8 @@ public Object getValueAt(Object node, int columnIndex) {
                     return "";
                 case ENABLED_INDEX:
                     return true;
+                case ALWAYS_RUN_INDEX:
+                    return false;
                 case STATUS_INDEX:
                     if (!env.isCreated()) {
                         return Constant.messages.getString(
@@ -156,6 +160,8 @@ public Object getValueAt(Object node, int columnIndex) {
             switch (columnIndex) {
                 case ENABLED_INDEX:
                     return job.isEnabled();
+                case ALWAYS_RUN_INDEX:
+                    return job.isAlwaysRun();
                 case STATUS_INDEX:
                     switch (job.getStatus()) {
                         case COMPLETED:
@@ -215,6 +221,8 @@ public Object getValueAt(Object node, int columnIndex) {
             switch (columnIndex) {
                 case ENABLED_INDEX:
                     return true;
+                case ALWAYS_RUN_INDEX:
+                    return false;
                 case STATUS_INDEX:
                     if (!test.hasRun()) {
                         return "";
@@ -262,6 +270,7 @@ public Object getValueAt(Object node, int columnIndex) {
     public Class<?> getColumnClass(int columnIndex) {
         switch (columnIndex) {
             case ENABLED_INDEX:
+            case ALWAYS_RUN_INDEX:
                 return Boolean.class;
             default:
                 return String.class;
@@ -275,7 +284,7 @@ public int getHierarchicalColumn() {
 
     @Override
     public boolean isCellEditable(Object node, int column) {
-        if (column == ENABLED_INDEX) {
+        if (column == ENABLED_INDEX || column == ALWAYS_RUN_INDEX) {
             DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode) node;
             if (!treeNode.isRoot()) {
                 Object obj = treeNode.getUserObject();
@@ -288,15 +297,18 @@ public boolean isCellEditable(Object node, int column) {
 
     @Override
     public void setValueAt(Object value, Object node, int column) {
-        if (column == ENABLED_INDEX) {
-            DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode) node;
-            if (!treeNode.isRoot()) {
-                Object obj = treeNode.getUserObject();
-                if (obj instanceof AutomationJob) {
-                    AutomationJob job = (AutomationJob) obj;
+        DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode) node;
+        if (!treeNode.isRoot()) {
+            Object obj = treeNode.getUserObject();
+            if (obj instanceof AutomationJob job) {
+                if (column == ENABLED_INDEX) {
                     job.setEnabled(((Boolean) value).booleanValue());
                     job.setChanged();
                     jobChanged(job);
+                } else if (column == ALWAYS_RUN_INDEX) {
+                    job.setAlwaysRun(((Boolean) value).booleanValue());
+                    job.setChanged();
+                    jobChanged(job);
                 }
             }
         }
diff --git a/addOns/automation/src/main/java/org/zaproxy/addon/automation/jobs/JobData.java b/addOns/automation/src/main/java/org/zaproxy/addon/automation/jobs/JobData.java
@@ -67,6 +67,10 @@ public void setEnabled(boolean enabled) {
         this.job.setEnabled(enabled);
     }
 
+    public boolean isAlwaysRun() {
+        return this.job.isAlwaysRun();
+    }
+
     public List<AutomationData> getTests() {
         List<AbstractAutomationTest> tests = this.job.getTests();
         if (tests.isEmpty()) {
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/automation.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/automation.html
@@ -68,7 +68,6 @@ <H2><a name="file-paths">File Paths</a></H2>
 Relative paths are recommended for portability.
 
 <H2><a name="jobs">Jobs</a></H2>
-The jobs can be enabled/disabled through the GUI and the automation plan, with the <code>enabled</code> flag. Jobs are enabled by default.
 <p>
 The following automation jobs are supported by this add-on:
 <ul>
@@ -81,6 +80,15 @@ <H2><a name="jobs">Jobs</a></H2>
 <li><a href="job-exitstatus.html">exitStatus</a> - sets ZAP's exit code based on scan results</li>
 </ul>
 
+<H3><a name="gen-options">General Job Options</a></H3>
+
+The following options can be applied to all jobs, via the automation plan or the <a href="gui.html">GUI</a>:
+
+<ul>
+<li><code>enabled</code> - only jobs that are enabled will run.
+<li><code>alwaysRun</code> - enabled jobs with this option will run even if the plan exits early.
+</ul>
+
 <H3>Importance of Job Order</H3>
 The order of jobs is relevant and important. For example: 
 <ul>
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/gui.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/gui.html
@@ -33,6 +33,13 @@ <H3>Plan sub-tab</H3>
 
 A graphical representation of the plan which also shows the state of the plan when it is run.<br>
 You can edit any of the elements of the plan by double clicking on them.
+<p>
+You can also change the following general job options via the plan table:
+
+<ul>
+<li>Enabled - only jobs that are enabled will run.
+<li>Always Run - enabled jobs with this option will run even if the plan exits early.
+</ul>
 
 <H3>Output sub-tab</H3>
 
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascan.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascan.html
@@ -42,6 +42,8 @@ <H2>YAML</H2>
         name:                          # String: The name of the rule for documentation purposes - this is not required or actually used
         strength:                      # String: The Attack Strength for this rule, one of Low, Medium, High, Insane, default: Medium
         threshold:                     # String: The Alert Threshold for this rule, one of Off, Low, Medium, High, default: Medium
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
 </pre>
 
 <strong>Note</strong>: Unless the <code>defaultThreshold</code> of the <code>policyDefinition</code> is <code>OFF</code> all rules will be enabled to start with.
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascanconfig.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascanconfig.html
@@ -45,6 +45,8 @@ <H2>YAML</H2>
         encodeCookieValues:                # Bool: If cookie values should be encoded. Default: false
       scripts:                             # Bool: If Input Vector scripts should be used. Default: true
     excludePaths:                          # An optional list of regexes to exclude
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
 </pre>
 
 Note that the 'excludePaths' will overwrite any existing session "Exclude from Scanner" paths.
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascanpolicy.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-ascanpolicy.html
@@ -25,6 +25,8 @@ <H2>YAML</H2>
         name:                          # Comment: The name of the rule for documentation purposes - this is not required or actually used
         strength:                      # String: The Attack Strength for this rule, one of Low, Medium, High, Insane, default: Medium
         threshold:                     # String: The Alert Threshold for this rule, one of Off, Low, Medium, High, default: Medium
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
 </pre>
 
 </BODY>
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-delay.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-delay.html
@@ -30,6 +30,8 @@ <H2>YAML</H2>
     parameters:
       time:                            # String: The time to wait, format any of ['hh:mm:ss', 'mm:ss', 'ss'], default: 0
       fileName:                        # String: Name of a file which will cause the job to end early if created, default: empty
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
 </pre>
 
 </BODY>
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-exitstatus.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-exitstatus.html
@@ -31,6 +31,8 @@ <H2>YAML</H2>
       okExitValue:                     # Integer: Exit value if all ok, default 0
       errorExitValue:                  # Integer: Exit value if there are errors, default 1
       warnExitValue:                   # Integer: Exit value if there are warnings, default 2
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
  </pre>
 
 </BODY>
diff --git a/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-requestor.html b/addOns/automation/src/main/javahelp/org/zaproxy/addon/automation/resources/help/contents/job-requestor.html
@@ -28,6 +28,8 @@ <H2>YAML</H2>
             - "header1:value1"
         data:                          # String: Optional data to send in the request body, supports vars
         responseCode:                  # Int: An optional, expected response code against which the actual response code will be matched
+    enabled:                           # Bool: If set to false the job will not be run, default: true
+    alwaysRun:                         # Bool: If set and the job is enabled then it will run even if the plan exits early, default: false
 </pre>
 
 </BODY>
diff --git a/addOns/automation/src/main/resources/org/zaproxy/addon/automation/resources/Messages.properties b/addOns/automation/src/main/resources/org/zaproxy/addon/automation/resources/Messages.properties
@@ -337,6 +337,7 @@ automation.error.env.verification.loginregex.bad = Invalid verification loggedIn
 automation.error.env.verification.logoutregex.bad = Invalid verification loggedOutRegex: {0}
 automation.error.env.verification.pollunits.bad = Invalid verification pollUnits: {0}
 automation.error.env.verification.type.bad = Invalid verification method: {0}
+automation.error.job.alwaysrun = Unsupported job alwaysRun format: {0}
 automation.error.job.baduser = Job {0} unrecognised user: {1}
 automation.error.job.data = Unsupported job data format: {0}
 automation.error.job.enabled = Unsupported job enabled format: {0}
@@ -412,6 +413,7 @@ automation.panel.load.failed = YAML file failed to load: {0}
 automation.panel.load.warning = YAML file loaded with warnings: {0}
 automation.panel.load.yaml = YAML Configuration Files
 automation.panel.table.env.name = Environment
+automation.panel.table.header.alwaysrun = Always Run
 automation.panel.table.header.enabled = Enabled
 automation.panel.table.header.info = Info
 automation.panel.table.header.name = Name
diff --git a/addOns/automation/src/test/java/org/zaproxy/addon/automation/ExtensionAutomationUnitTest.java b/addOns/automation/src/test/java/org/zaproxy/addon/automation/ExtensionAutomationUnitTest.java
@@ -1085,6 +1085,82 @@ public String getType() {
         assertThat(progress.hasErrors(), is(equalTo(false)));
     }
 
+    @Test
+    void shouldAlwaysRunJobOnError() {
+        // Given
+        ExtensionAutomation extAuto = new ExtensionAutomation();
+        String job1Name = "job1";
+        String job2Name = "job2";
+        String job3Name = "job3";
+
+        AutomationJobImpl job1 =
+                new AutomationJobImpl(true) {
+                    @Override
+                    public String getType() {
+                        return job1Name;
+                    }
+
+                    @Override
+                    public Order getOrder() {
+                        return Order.REPORT;
+                    }
+
+                    @Override
+                    public void runJob(AutomationEnvironment env, AutomationProgress progress) {
+                        super.runJob(env, progress);
+                        progress.error("Test Error");
+                    }
+                };
+        AutomationJobImpl job2 =
+                new AutomationJobImpl(true) {
+                    @Override
+                    public String getType() {
+                        return job2Name;
+                    }
+
+                    @Override
+                    public Order getOrder() {
+                        return Order.REPORT;
+                    }
+                };
+        AutomationJobImpl job3 =
+                new AutomationJobImpl(true) {
+                    @Override
+                    public String getType() {
+                        return job3Name;
+                    }
+
+                    @Override
+                    public Order getOrder() {
+                        return Order.REPORT;
+                    }
+                };
+        Path filePath = getResourcePath("resources/testplan-alwaysRunLastJob.yaml");
+        InMemoryStats stats = new InMemoryStats();
+        Stats.addListener(stats);
+
+        // When
+        extAuto.registerAutomationJob(job1);
+        extAuto.registerAutomationJob(job2);
+        extAuto.registerAutomationJob(job3);
+        AutomationProgress progress =
+                extAuto.runAutomationFile(filePath.toAbsolutePath().toString());
+
+        // Then
+        assertThat(progress.hasWarnings(), is(equalTo(false)));
+        assertThat(progress.hasErrors(), is(equalTo(true)));
+        assertThat(progress.getErrors().size(), is(equalTo(1)));
+        assertThat(progress.getErrors().get(0), is(equalTo("Test Error")));
+        assertThat(job1.wasRun(), is(equalTo(true)));
+        assertThat(job2.wasRun(), is(equalTo(false)));
+        assertThat(job3.wasRun(), is(equalTo(true)));
+
+        assertThat(stats.getStat(ExtensionAutomation.WARNING_COUNT_STATS), is(equalTo(0L)));
+        assertThat(stats.getStat(ExtensionAutomation.ERROR_COUNT_STATS), is(equalTo(1L)));
+        assertThat(stats.getStat(ExtensionAutomation.PLANS_RUN_STATS), is(equalTo(1L)));
+        assertThat(stats.getStat(ExtensionAutomation.TOTAL_JOBS_RUN_STATS), is(2L));
+    }
+
     // Methods are accessed via reflection
     @SuppressWarnings("unused")
     private static class TestParamContainer {
diff --git a/addOns/automation/src/test/resources/org/zaproxy/addon/automation/resources/testplan-alwaysRunLastJob.yaml b/addOns/automation/src/test/resources/org/zaproxy/addon/automation/resources/testplan-alwaysRunLastJob.yaml
@@ -0,0 +1,21 @@
+env:
+  contexts:
+    - name: example
+      urls: 
+      - https://www.example.com/
+  parameters:
+    failOnError: true                  
+    failOnWarning: false               
+    progressToStdout: false         
+    continueOnFailure: false   
+
+jobs:
+  - type: job1
+    parameters:
+
+  - type: job2
+    parameters:
+
+  - type: job3
+    parameters:
+    alwaysRun: true
