Changeset 4380

Timestamp:

Aug 6, 2008, 1:30:07 PM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #1064: Add support for dry-run to the plug-in system

Location:

trunk

Files:

• src/core/common-queries.xml (modified) (1 diff)
• src/core/net/sf/basedb/core/Install.java (modified) (1 diff)
• src/core/net/sf/basedb/core/Job.java (modified) (5 diffs)
• src/core/net/sf/basedb/core/PluginConfigurationRequest.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/PluginExecutionRequest.java (modified) (1 diff)
• src/core/net/sf/basedb/core/PluginResponse.java (modified) (5 diffs)
• src/core/net/sf/basedb/core/Update.java (modified) (3 diffs)
• src/core/net/sf/basedb/core/data/JobData.java (modified) (1 diff)
• src/core/net/sf/basedb/core/plugin/Response.java (modified) (1 diff)
• src/plugins/core/net/sf/basedb/plugins/batchimport/AbstractItemImporter.java (modified) (2 diffs)
• www/views/jobs/index.jsp (modified) (1 diff)
• www/views/jobs/list_jobs.jsp (modified) (2 diffs)
• www/views/jobs/view_job.jsp (modified) (5 diffs)

trunk/src/core/common-queries.xml

@@ -3252 +3252 @@
     </description>
   </query>
+  
+  <query id="SET_DRYRUN_ON_JOBS" type="HQL">
+    <sql>
+      UPDATE JobData job
+      SET job.dryRun = false
+      WHERE job.dryRun IS NULL
+    </sql>
+    <description>
+      A HQL query that set the dryRun property
+      to false on all jobs with a null value.
+    </description>
+  </query>
 
 

trunk/src/core/net/sf/basedb/core/Install.java

@@ -107 +107 @@
     method.
   */
-  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(62).intValue();
+  public static final int NEW_SCHEMA_VERSION = Integer.valueOf(63).intValue();
   
   public static synchronized void createTables(boolean update, final ProgressReporter progress)

trunk/src/core/net/sf/basedb/core/Job.java

@@ -579 +579 @@
   
   /**
+    Check if the job should be/was executed as a dry-run job.
+    A dry-run job is a job that does all the things a normal job would 
+    do except committing the changes to the database. The dry-run job 
+    may output a log file with detailed information about what should 
+    have happened if it hadn't been a dry-run.
+    @since 2.8
+  */
+  public boolean isDryRun()
+  {
+    return getData().isDryRun();
+  }
+    
+  /**
     The maximum allowed length of the status message.
   */
@@ -1058 +1071 @@
       parameters in case these has changed since the job was created
     @throws PermissionDeniedException If the logged in user doesn't have write permission
+    @deprecated Use {@link #retry(boolean, boolean)} instead
   */
   public void retry(boolean useLatestConfiguration)
+    throws PermissionDeniedException
+  {
+    retry(useLatestConfiguration, false);
+  }
+  
+  /**
+    Retry a job which finished with an error or a successful dry-run job.
+    @param useLatestConfiguration If the job should use the latest configuration
+      parameters in case these has changed since the job was created
+    @param clearDryRun If the job was a dry-run job, clear the dry-run flag
+      to indicate that it should be executed for real the next time
+    @throws PermissionDeniedException If the logged in user doesn't have write permission
+  */
+  public void retry(boolean useLatestConfiguration, boolean clearDryRun)
     throws PermissionDeniedException
   {
@@ -1080 +1108 @@
       }
     }
-  }
+    if (clearDryRun) data.setDryRun(false);
+  }
+
   
   /**
@@ -1629 +1659 @@
       data.setServer(null);
       data.setJobAgentId(null);
+      data.setDryRun(response.isDryRun());
       data.setEstimatedExecutionTime(response.getEstimatedExecutionTime().getValue());
     }
@@ -1661 +1692 @@
         dc = sc.newDbControl();
         Job job = Job.getById(dc, jobId);
+        job.getData().setDryRun(response.isDryRun());
 
         if (response.getStatus() == Response.Status.ERROR)

trunk/src/core/net/sf/basedb/core/PluginConfigurationRequest.java

@@ -86 +86 @@
   private Job.ProgressReporterImpl progress;
   private boolean allowImmediateExecution;
+  private boolean dryRun;
   
   PluginConfigurationRequest(SessionControl sc, InteractivePlugin plugin, String command,
@@ -95 +96 @@
     this.context = context;
     this.allowImmediateExecution = allowImmediateExecution;
+    if (job != null) dryRun = job.isDryRun();
   }
   
@@ -107 +109 @@
     boolean allowImmediateDownload = allowImmediateExecution && 
       plugin instanceof ImmediateDownloadExporter;
-    PluginResponse pluginResponse = new PluginResponse(this, allowImmediateExecution, allowImmediateDownload);
+    PluginResponse pluginResponse = new PluginResponse(this, allowImmediateExecution, allowImmediateDownload, dryRun);
     Request request = new RequestImpl(allowImmediateExecution);
     Response response = pluginResponse.getResponseImpl();

trunk/src/core/net/sf/basedb/core/PluginExecutionRequest.java

@@ -86 +86 @@
   public PluginResponse invoke()
   {
-    PluginResponse pluginResponse = new PluginResponse(null, false, false);
+    PluginResponse pluginResponse = new PluginResponse(null, false, false, getJob().isDryRun());
     Request request = new RequestImpl(false);
     Response response = pluginResponse.getResponseImpl();

trunk/src/core/net/sf/basedb/core/PluginResponse.java

@@ -59 +59 @@
   private Job.ExecutionTime estimatedExecutionTime;
   private String message;
+  private boolean dryRun;
   private List<? extends Throwable> errorList;
   private String nextCommand;
 
-  PluginResponse(PluginConfigurationRequest request, boolean allowImmediateExection, boolean allowImmediateDownload)
+  PluginResponse(PluginConfigurationRequest request, 
+    boolean allowImmediateExection, boolean allowImmediateDownload, boolean dryRun)
   {
     this.request = request;
@@ -70 +72 @@
     this.allowImmediateExecution = allowImmediateExection;
     this.message = "A response has not been specified by the plugin";
+    this.dryRun = dryRun;
   }
 
@@ -78 +81 @@
   {
     return status;
+  }
+  
+  /**
+    Check if the job should be executed or was executed in
+    dry-run mode.
+    @since 2.8
+  */
+  public boolean isDryRun()
+  {
+    return dryRun;
   }
   
@@ -136 +149 @@
   
   /**
-    aAve all parameters that has been configured during the configuration sequence to
+    Save all parameters that has been configured during the configuration sequence to
     the database.
     @param dc An open DbControl to use when accessing the database. 
@@ -290 +303 @@
       PluginResponse.this.errorList = errorList;
     }
+    
+    public void setDryRun(boolean dryRun)
+    {
+      PluginResponse.this.dryRun = dryRun;
+    }
     // -------------------------------------------
   }

trunk/src/core/net/sf/basedb/core/Update.java

@@ -712 +712 @@
   </tr>
   
+  <tr>
+    <td>63</td>
+    <td>
+      Added:
+      <ul>
+      <li>{@link net.sf.basedb.core.data.JobData#isDryRun()}. 
+      </ul>
+      The update will set the value for all existing jobs to false.
+    </td>
+  </tr>
+  
   </table>
 
@@ -994 +1005 @@
       }
       
-      if (schemaVersion < 62)
-      {
-        if (progress != null) progress.display((int)(61*progress_factor), "--Updating schema version: " + schemaVersion + " -> 62...");
-        schemaVersion = setSchemaVersionInTransaction(session, 62);
+      if (schemaVersion < 63)
+      {
+        if (progress != null) progress.display((int)(62*progress_factor), "--Updating schema version: " + schemaVersion + " -> 63...");
+        schemaVersion = setSchemaVersionInTransaction(session, 63);
       }
       
@@ -2890 +2901 @@
           HibernateUtil.executeUpdate(query);
         }
+
+        if (schemaVersion < 63)
+        {
+          // Set dryRun = false on all jobs
+          org.hibernate.Query query = HibernateUtil.getPredefinedQuery(session, 
+            "SET_DRYRUN_ON_JOBS");
+          /*
+            UPDATE JobData job
+            SET job.dryRun = false
+            WHERE job.dryRun IS NULL
+          */
+          HibernateUtil.executeUpdate(query);
+        }
         
         //  Commit the changes

trunk/src/core/net/sf/basedb/core/data/JobData.java

@@ -230 +230 @@
   }
 
+  private boolean dryRun;
+  /**
+    If the job should be/was executed as a dry-run job.
+    @hibernate.property column="`dry_run`" type="boolean" not-null="true"
+  */
+  public boolean isDryRun()
+  {
+    return dryRun;
+  }
+  public void setDryRun(boolean dryRun)
+  {
+    this.dryRun = dryRun;
+  }
+  
   /**
     The maximum allowed length of the status message.

trunk/src/core/net/sf/basedb/core/plugin/Response.java

@@ -122 +122 @@
   
   /**
+    A plug-in may call this method in it's configuration phase or
+    after it has been executed to indicate that the job should be
+    or was executed as a dry-run job. A dry-run job is a job that 
+    does all the things a normal job would do except committing the
+    changes to the database. The dry-run job may output a 
+    log file with detailed information about what should have happened
+    if it hadn't been a dry-run.
+    <p>
+    NOTE! Setting this value to true doesn't change the behaviour
+    of the core. It is the responsibility of the plug-in to check
+    this value(eg. {@link Job#isDryRun()} and take appropriate action.
+    
+    @param dryRun TRUE to indicate that the job should be or was
+      executed as a dry-run
+    @since 2.8
+  */
+  public void setDryRun(boolean dryRun);
+  
+  /**
     This will end the job execution or configuration and report it as a 
     failure. If in a configuration sequence the client application may try 

trunk/src/plugins/core/net/sf/basedb/plugins/batchimport/AbstractItemImporter.java

@@ -345 +345 @@
         // Error handling
         storeValue(job, request, ri.getParameter(Parameters.LOGFILE_PARAMETER));
-        storeValue(job, request, ri.getParameter(Parameters.DRY_RUN_PARAMETER));
+        response.setDryRun(Boolean.TRUE.equals(request.getParameterValue(Parameters.DRY_RUN_PARAMETER)));
+//        storeValue(job, request, ri.getParameter(Parameters.DRY_RUN_PARAMETER));
         storeValue(job, request, defaultErrorParameter);
         storeValue(job, request, itemNotFoundErrorParameter);
@@ -453 +454 @@
     
     // Error handling, we don't use the error handling in AbstractFlatFileImporter
-    this.dryRun = Boolean.TRUE.equals(job.getValue(Parameters.DRY_RUN_PARAMETER));
+    this.dryRun = job.getJob().isDryRun();
     this.createNotFoundItems = "create".equals(getErrorOption("itemNotFoundError"));
     this.failIfNotFoundItems = "fail".equals(getErrorOption("itemNotFoundError"));

trunk/www/views/jobs/index.jsp

@@ -234 +234 @@
     ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, pageContext, defaultContext);
     boolean useLatestConfiguration = Values.getBoolean(request.getParameter("useLatestConfiguration"), false);
+    boolean clearDryRun = Values.getBoolean(request.getParameter("clearDryRun"), false);
     dc = sc.newDbControl();
     Job job = Job.getById(dc, cc.getId());
-    job.retry(useLatestConfiguration);
+    job.retry(useLatestConfiguration, clearDryRun);
     dc.commit();
     redirect = viewPage;

trunk/www/views/jobs/list_jobs.jsp

@@ -279 +279 @@
         datatype="string"
         title="Status message"
+        sortable="true" 
+        filterable="true"
+        exportable="true"
+      />
+      <tbl:columndef 
+        id="dryRun"
+        property="dryRun"
+        datatype="boolean"
+        title="Dry run"
         sortable="true" 
         filterable="true"
@@ -594 +603 @@
                 <tbl:cell column="status"><%=item.getStatus()%></tbl:cell>
                 <tbl:cell column="statusMessage"><%=HTML.encodeTags(item.getStatusMessage())%></tbl:cell>
+                <tbl:cell column="dryRun"><%=item.isDryRun()%></tbl:cell>
                 <tbl:cell column="stackTrace"><%=HTML.encodeTags(item.getStackTrace())%></tbl:cell>
                 <tbl:cell column="server"><%=HTML.encodeTags(item.getServer())%></tbl:cell>

trunk/www/views/jobs/view_job.jsp

@@ -153 +153 @@
     }
   }
-  function restartJob()
+  function restartJob(clearDryRun)
   {
     var parameterVersion = <%=parameterVersion%>;
@@ -167 +167 @@
       if (confirm(msg)) useLatestConfiguration = 1;
     }
-    location.href = 'index.jsp?ID=<%=ID%>&cmd=RestartJob&item_id=<%=itemId%>&useLatestConfiguration='+useLatestConfiguration;
+    var url = 'index.jsp?ID=<%=ID%>&cmd=RestartJob&item_id=<%=itemId%>';
+    url += '&useLatestConfiguration='+useLatestConfiguration;
+    if (clearDryRun) url += '&clearDryRun=' + clearDryRun;
+    location.href = url;
   }
   function reconfigureJob()
@@ -229 +232 @@
         <td class="prompt">Status</td>
         <td>
-          <%=job.getStatus()%>: <%=HTML.niceFormat(job.getStatusMessage())%>
+          <%=job.getStatus()%><%=job.isDryRun() ? " (dry-run)" : "" %>: <%=HTML.niceFormat(job.getStatusMessage())%>
         </td>
       </tr>
@@ -531 +534 @@
       {
         %>
-        <base:button onclick="restartJob()" title="Restart job" 
+        <base:button onclick="restartJob(0)" title="Restart job" 
           image="refresh.gif" 
           tooltip="Try to run this job again with the same parameters"
@@ -539 +542 @@
           tooltip="Change the parameters for this job and try again"
           visible="<%=job.hasContext()%>"
+        />
+        <%
+      }
+      if (job.getStatus() == Job.Status.DONE && job.isDryRun())
+      {
+        %>
+        <base:button onclick="restartJob(1)" title="Really run" 
+          image="refresh.gif" 
+          tooltip="Run this dry-run job for real"
         />
         <%