Merge pull request #85 from jenkinsci/recurring-maintenance

[JENKINS-69843] recurring maintenances

Author: mawinter69

README.md

@@ -45,6 +45,13 @@ Via the "Edit" button one can edit existing maintenance windows (and also add an
 Going to "Manage Jenkins->Agent Maintenance" will present you a list of all currently defined maintenance windows of all agents.
 Using the button "Add" allows to use a label expression to select a list of agents for which to apply the maintenance window.
 
+## Recurring maintenance windows
+It is also possible to define recurring maintenance windows. Using a cron syntax you can specify the start time of the downtime and a duration.
+Recurring maintenance windows are added as planned maintenance window 7 days before they start by default. This way you can easily cancel or modify them before
+they start. The lead time for adding recurring maintenance windows can be changed by setting the system property com.sap.prd.jenkins.plugins.agent_maintenance.RecurringMaintenanceWindow.LEAD_TIME_DAYS
+during start up of Jenkins. Note that changing the lead time can have unwanted side effects like duplicated/missing maintenance windows. 
+
+Changing a recurring maintenance will not change already scheduled maintenance windows for it. Those need to be adjusted manually.
 
 ## Best practices
 

pom.xml

@@ -39,12 +39,13 @@
   </scm>
 
   <properties>
-    <revision>1</revision>
+    <revision>2</revision>
     <changelist>999999-SNAPSHOT</changelist>
     <gitHubRepo>jenkinsci/agent-maintenance-plugin</gitHubRepo>
     <jenkins.version>2.387.2</jenkins.version>
     <powermock.version>1.6.1</powermock.version>
     <checkstyle.version>10.12.1</checkstyle.version>
+    <hpi.compatibleSinceVersion>2.0</hpi.compatibleSinceVersion>
   </properties>
 
   <dependencyManagement>
@@ -59,10 +60,15 @@
     </dependencies>
   </dependencyManagement>
   <dependencies>
-      <dependency>
-          <groupId>io.jenkins.plugins</groupId>
-          <artifactId>ionicons-api</artifactId>
-      </dependency>
+    <dependency>
+        <groupId>io.jenkins.plugins</groupId>
+        <artifactId>ionicons-api</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.cronutils</groupId>
+      <artifactId>cron-utils</artifactId>
+      <version>9.2.0</version>
+    </dependency>
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-core</artifactId>

src/main/java/com/sap/prd/jenkins/plugins/agent_maintenance/AgentMaintenanceRetentionStrategy.java

@@ -62,6 +62,7 @@ public boolean isManualLaunchAllowed(final SlaveComputer c) {
   @GuardedBy("hudson.model.Queue.lock")
   public synchronized long check(final SlaveComputer c) {
     MaintenanceWindow maintenance = MaintenanceHelper.getInstance().getMaintenance(c.getName());
+    MaintenanceHelper.getInstance().checkRecurring(c.getName());
     LOGGER.log(Level.FINER, "Checking for Maintenance Window for agent {0}. online = {1}, idle = {2}",
         new Object[] { c.getName(), c.isOnline(), c.isIdle() });
     if (maintenance != null) {

src/main/java/com/sap/prd/jenkins/plugins/agent_maintenance/MaintenanceAction.java

@@ -16,6 +16,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.SortedSet;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -88,6 +89,10 @@ public Class<MaintenanceWindow> getMaintenanceWindowClass() {
     return MaintenanceWindow.class;
   }
 
+  public Class<RecurringMaintenanceWindow> getRecurringMaintenanceWindowClass() {
+    return RecurringMaintenanceWindow.class;
+  }
+
   public boolean isEnabled() {
     return computer.getRetentionStrategy() instanceof AgentMaintenanceRetentionStrategy;
   }
@@ -155,7 +160,20 @@ public SortedSet<MaintenanceWindow> getMaintenanceWindows() {
   }
 
   /**
-   * UI method to add a smaintenance window.
+   * Returns a list of recurring maintenance windows.
+   *
+   * @return A list of recurring maintenance windows
+   */
+  public Set<RecurringMaintenanceWindow> getRecurringMaintenanceWindows() {
+    try {
+      return Collections.unmodifiableSet(MaintenanceHelper.getInstance().getRecurringMaintenanceWindows(computer.getName()));
+    } catch (IOException e) {
+      return Collections.emptySortedSet();
+    }
+  }
+
+  /**
+   * UI method to add a maintenance window.
    *
    * @param req Stapler Request
    * @return Response containing the result of the add
@@ -172,6 +190,24 @@ public HttpResponse doAdd(StaplerRequest req) throws IOException, ServletExcepti
     return FormApply.success(".");
   }
 
+  /**
+   * UI method to add a recurring maintenance window.
+   *
+   * @param req Stapler Request
+   * @param rsp Stapler Response
+   * @throws IOException      when writing fails
+   * @throws ServletException if an error occurs reading the form
+   */
+  @POST
+  public void doAddRecurring(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException {
+    computer.checkAnyPermission(CONFIGURE_AND_DISCONNECT);
+
+    JSONObject src = req.getSubmittedForm();
+    RecurringMaintenanceWindow rmw = req.bindJSON(RecurringMaintenanceWindow.class, src);
+    MaintenanceHelper.getInstance().addRecurringMaintenanceWindow(computer.getName(), rmw);
+    rsp.sendRedirect(".");
+  }
+
   /**
    * UI method to delete multiple maintenance windows.
    *
@@ -214,6 +250,26 @@ public Map<String, Boolean> getMaintenanceStatus() {
     return statusList;
   }
 
+  /**
+   * UI method to delete multiple recurring maintenance windows.
+   *
+   * @param ids A list of recurring maintenance window ids to delete
+   */
+  @JavaScriptMethod
+  public String[] deleteMultipleRecurring(String[] ids) {
+    computer.checkAnyPermission(CONFIGURE_AND_DISCONNECT);
+    List<String> deletedList = new ArrayList<>();
+    for (String id : ids) {
+      try {
+        MaintenanceHelper.getInstance().deleteRecurringMaintenanceWindow(computer.getName(), id);
+        deletedList.add(id);
+      } catch (Throwable e) {
+        LOGGER.log(Level.WARNING, "Error while deleting maintenance window", e);
+      }
+    }
+    return deletedList.toArray(new String[0]);
+  }
+
   /**
    * UI method to delete a maintenance window.
    *
@@ -236,6 +292,28 @@ public boolean deleteMaintenance(String id) {
     return false;
   }
 
+  /**
+   * UI method to delete a recurring maintenance window.
+   *
+   * @param id The id of the maintenance to delete
+   */
+  @JavaScriptMethod
+  public boolean deleteRecurringMaintenance(String id) {
+    if (computer.hasAnyPermission(CONFIGURE_AND_DISCONNECT)) {
+      if (Util.fixEmptyAndTrim(id) == null) {
+        return false;
+      }
+      try {
+        MaintenanceHelper.getInstance().deleteRecurringMaintenanceWindow(computer.getName(), id);
+        return true;
+      } catch (IOException ioe) {
+        LOGGER.log(Level.WARNING, "Failed to delete recurring maintenance window.", ioe);
+        return false;
+      }
+    }
+    return false;
+  }
+
   /**
    * UI method to submit the configuration.
    *
@@ -251,12 +329,18 @@ public synchronized HttpResponse doConfigSubmit(StaplerRequest req) throws IOExc
     JSONObject src = req.getSubmittedForm();
 
     List<MaintenanceWindow> newTargets = req.bindJSONToList(MaintenanceWindow.class, src.get("maintenanceWindows"));
+    List<RecurringMaintenanceWindow> newRecurringTargets = req.bindJSONToList(RecurringMaintenanceWindow.class,
+        src.get("recurringMaintenanceWindows"));
 
-    SortedSet<MaintenanceWindow> mwlist = MaintenanceHelper.getInstance().getMaintenanceWindows(computer.getName());
-    synchronized (mwlist) {
-      mwlist.clear();
-      mwlist.addAll(newTargets);
-      MaintenanceHelper.getInstance().saveMaintenanceWindows(computer.getName(), mwlist);
+    MaintenanceDefinitions md = MaintenanceHelper.getInstance().getMaintenanceDefinitions(computer.getName());
+    synchronized (md) {
+      SortedSet<MaintenanceWindow> scheduled = md.getScheduled();
+      Set<RecurringMaintenanceWindow> recurring = md.getRecurring();
+      scheduled.clear();
+      scheduled.addAll(newTargets);
+      recurring.clear();
+      recurring.addAll(newRecurringTargets);
+      MaintenanceHelper.getInstance().saveMaintenanceWindows(computer.getName(), md);
     }
     return FormApply.success(".");
   }

src/main/java/com/sap/prd/jenkins/plugins/agent_maintenance/MaintenanceDefinitions.java

@@ -0,0 +1,41 @@
+package com.sap.prd.jenkins.plugins.agent_maintenance;
+
+import java.util.Set;
+import java.util.SortedSet;
+
+/**
+ * Container that holds the scheduled and recurring maintenance windows for an agent.
+ */
+public class MaintenanceDefinitions {
+  private SortedSet<MaintenanceWindow> scheduled;
+  private Set<RecurringMaintenanceWindow> recurring;
+
+  /**
+   * Create definitions container.
+   *
+   * @param scheduled A set of scheduled maintenance windows
+   * @param recurring A set of recurring maintenance windows
+   */
+  public MaintenanceDefinitions(SortedSet<MaintenanceWindow> scheduled, Set<RecurringMaintenanceWindow> recurring) {
+    this.scheduled = scheduled;
+    this.recurring = recurring;
+  }
+
+  /**
+   * Get the scheduled maintenance windows.
+   *
+   * @return Set of scheduled maintenance windows
+   */
+  public SortedSet<MaintenanceWindow> getScheduled() {
+    return scheduled;
+  }
+
+  /**
+   * Get the recurring maintenance windows.
+   *
+   * @return Set of recurring maintenance windows
+   */
+  public Set<RecurringMaintenanceWindow> getRecurring() {
+    return recurring;
+  }
+}