added exitDetail on failed executions

Author: alegrm

pom.xml

@@ -213,7 +213,7 @@
 				<artifactId>tomcat7-maven-plugin</artifactId>
 				<version>2.2</version>
 				<configuration>
-					<server>generator</server>
+					<server>localhost</server>
 					<url>${tomcat.deploy.url}</url>
 					<path>/${project.build.finalName}</path>
 					<update>true</update>

src/main/java/eu/geoknow/generator/workflow/BatchAdminClient.java

@@ -3,6 +3,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Map.Entry;
 
@@ -46,6 +47,9 @@
 import eu.geoknow.generator.workflow.beans.JobWraper;
 import eu.geoknow.generator.workflow.beans.JobsRegistered;
 import eu.geoknow.generator.workflow.beans.Registration;
+import eu.geoknow.generator.workflow.beans.Status;
+import eu.geoknow.generator.workflow.beans.StepExecution;
+import eu.geoknow.generator.workflow.beans.StepJobExecution;
 
 /**
  * A client class for spring-batch-admin service. This service doesn't support authentication, thus
@@ -76,34 +80,70 @@ public class BatchAdminClient {
    * @throws ServiceInternalServerError
    * @throws Exception
    */
-  public static JobExecutionWrapper getExecutionDetail(String jobName, String jobInstanceId,
+  public static List<JobExecutionWrapper> getExecutionDetail(String jobName, String jobInstanceId,
       String springBatchServiceUri) throws ResourceNotFoundException, UnknownException,
       IOException, ServiceNotAvailableException, ServiceInternalServerError {
-    // first, we need to get the resource with ID. the URI is:
-    // http://localhost:8080/spring-batch-admin-geoknow/jobs/jobName/jobInstanceId.json
+
+    // get executions of an instance
     log.debug(springBatchServiceUri + "/jobs/" + jobName + "/" + jobInstanceId + ".json");
     HttpGet jobInstance =
         new HttpGet(springBatchServiceUri + "/jobs/" + jobName + "/" + jobInstanceId + ".json");
     String jsonString = apiRequest(jobInstance);
-    log.debug(jsonString);
+
+    List<JobExecutionWrapper> executionsList = new ArrayList<JobExecutionWrapper>();
     // create Java object
     ObjectMapper mapper = new ObjectMapper();
+    Gson gson = new Gson();
+
     JobExecutions jobExecutions = mapper.readValue(jsonString, JobExecutions.class);
+    // a job instance may contain several executions
+    Iterator<JobExecution> executionsIterator = jobExecutions.getJobExecutions().iterator();
+
+    // "http://generator.geoknow.eu:8080/spring-batch-admin-geoknow/jobs/executions/11.json",
+    while (executionsIterator.hasNext()) {
+      JobExecution execution = executionsIterator.next();
+      // wrapper
+      log.debug("get execution:" + execution.getResource());
+      HttpGet JobExecution = new HttpGet(execution.getResource());
+      jsonString = apiRequest(JobExecution);
+      JobExecutionWrapper ewrap = gson.fromJson(jsonString, JobExecutionWrapper.class);
+      List<StepJobExecution> failedSteps = new ArrayList<StepJobExecution>();
+
+      // get the URL with the execution detailed error message
+      for (Entry<String, StepExecution> entries : ewrap.getJobExecution().getStepExecutions()
+          .entrySet()) {
+        log.debug(entries.getKey());
+        // next values may be null if the step was not executed
+        log.debug(entries.getValue().getId() == null);
+
+        if (entries.getValue().getId() != null) {
+          if (entries.getValue().getExitCode() == Status.FAILED) {
+            log.debug(entries.getValue().getResource());
+            HttpGet stepExecution = new HttpGet(entries.getValue().getResource());
+            jsonString = apiRequest(stepExecution);
+            StepJobExecution failedStep = gson.fromJson(jsonString, StepJobExecution.class);
+            failedSteps.add(failedStep);
+            // we add the exit description to the step metadata
+            entries.getValue().setExitDescription(
+                failedStep.getStepExecution().getExitDescription());
+          }
+        }
+      }
 
-    // List<JobExecution> executionList =
-    // jobInst.getJobInstance().getJobExecutions().getJobExecutions();
-    // List<JobExecution> executionList =
-    // jobExecutions.getJobInstance().getJobExecutions().getJobExecutions();
-
-    // now, use first element (it has only one) to get the resource in the
-    // execution, to get the
-    // wrapper
-    HttpGet JobExecution = new HttpGet(jobExecutions.getJobExecutions().get(0).getResource());
-    jsonString = apiRequest(JobExecution);
-    // create the required wrapper
-    Gson gson = new Gson();
-    JobExecutionWrapper execution = gson.fromJson(jsonString, JobExecutionWrapper.class);
-    return execution;
+      // here we add a exit description to the hole execution (i.e.) step 1 failed
+      Iterator<StepJobExecution> iter = failedSteps.iterator();
+      while (iter.hasNext()) {
+        StepJobExecution fs = iter.next();
+        String oldesc = ewrap.getJobExecution().getExitDescription();
+        if (!oldesc.equals(""))
+          oldesc += "<br/>";
+        ewrap.getJobExecution().setExitDescription(
+            oldesc + fs.getStepExecution().getName() + " : "
+                + fs.getStepExecution().getExitCode().toString());
+      }
+      executionsList.add(ewrap);
+    }
+    return executionsList;
   }
 
   /**

src/main/java/eu/geoknow/generator/workflow/JobsManager.java

@@ -326,24 +326,40 @@ public Registration getJob(String jobName, UserProfile user) throws Exception {
     return job;
   }
 
+  /**
+   * Get the executions of a JOB based on instances registered in the store
+   * 
+   * @param job
+   * @return
+   * @throws IOException
+   * @throws Exception
+   */
   public JobExecutions getExcecutions(Registration job) throws IOException, Exception {
 
     // complete with execution information
     JobExecutions executions = new JobExecutions();
 
+    // TODO: check I think is instances are not sync to SBA instances- notice that if SBA is
+    // restarted these doesnt exist anymore
     if (job.getJobInstances().size() > 0) {
       Set<Integer> instances = job.getJobInstances().keySet();
       log.debug(instances.size() + " instances ");
       Iterator<Integer> it = instances.iterator();
 
+      List<JobExecutionWrapper> instanceExecutions = null;
       while (it.hasNext()) {
         // this is just the instance number, no the ID:
         // http://localhost:8080/spring-batch-admin-geoknow/jobs/d2rq_2/4
         int id = it.next();
-        JobExecutionWrapper execution =
+        instanceExecutions =
             BatchAdminClient.getExecutionDetail(job.getName(), "" + id, springBatchServiceUri);
-        executions.getJobExecutions().add(execution.getJobExecution());
-
+      }
+      if (instanceExecutions != null) {
+        Iterator<JobExecutionWrapper> instanceIterator = instanceExecutions.iterator();
+        while (instanceIterator.hasNext()) {
+          JobExecutionWrapper execution = instanceIterator.next();
+          executions.getJobExecutions().add(execution.getJobExecution());
+        }
       }
     }
     return executions;

src/main/java/eu/geoknow/generator/workflow/beans/JobExecutionWrapper.java

@@ -5,12 +5,12 @@
 
 public class JobExecutionWrapper {
   private JobExecution jobExecution;
-  private Map<String, String> errors;
-  
+  private Map<String, StepExecutionDetail> errors;
+
   private String page;
 
   public JobExecutionWrapper() {
-    this.errors = new HashMap<String, String>();
+    this.errors = new HashMap<String, StepExecutionDetail>();
   }
 
   public JobExecution getJobExecution() {
@@ -21,11 +21,11 @@ public void setJobExecution(JobExecution jobExecution) {
     this.jobExecution = jobExecution;
   }
 
-  public Map<String, String> getErrors() {
+  public Map<String, StepExecutionDetail> getErrors() {
     return errors;
   }
 
-  public void setErrors(Map<String, String> errors) {
+  public void setErrors(Map<String, StepExecutionDetail> errors) {
     this.errors = errors;
   }
 
@@ -37,5 +37,5 @@ public void setPage(String page) {
     this.page = page;
   }
 
-  
+
 }

src/main/java/eu/geoknow/generator/workflow/beans/StepExecution.java

@@ -1,5 +1,33 @@
 package eu.geoknow.generator.workflow.beans;
 
+/**
+ * 
+ * 
+ * @author alejandragarciarojas
+ *
+ *
+ *        "multiStep_actorsex1446562308585_2" : {
+            "status" : "NONE",
+            "exitCode" : "NONE",
+            "readCount" : "0",
+            "writeCount" : "0",
+            "commitCount" : "0",
+            "rollbackCount" : "0",
+            "duration" : "-"
+        },
+        
+                "multiStep_actorsex1446562308585_1" : {
+            "status" : "FAILED",
+            "exitCode" : "FAILED",
+            "id" : "29",
+            "resource" : "http://generator.geoknow.eu:8080/spring-batch-admin-geoknow/jobs/executions/12/steps/29.json",
+            "readCount" : "0",
+            "writeCount" : "0",
+            "commitCount" : "0",
+            "rollbackCount" : "1",
+            "duration" : "00:00:00"
+        }
+ */
 public class StepExecution {
 
     private Status status;
@@ -11,7 +39,11 @@ public class StepExecution {
     private String commitCount;
     private String rollbackCount;
     private String duration;
+    // exitDescription data is added after the POJO deserialization
+    private String exitDescription;
 
+    public StepExecution(){}
+    
     public Status getStatus() {
         return status;
     }
@@ -84,4 +116,12 @@ public void setDuration(String duration) {
         this.duration = duration;
     }
 
+    public String getExitDescription() {
+      return exitDescription;
+    }
+
+    public void setExitDescription(String exitDescription) {
+      this.exitDescription = exitDescription;
+    }
+
 }

src/main/resources/log4j.properties

@@ -7,4 +7,4 @@ log4j.appender.stdout.Target=System.out
 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
 log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
 
-log4j.logger.eu.geoknow=INFO
+log4j.logger.eu.geoknow=DEBUG

src/test/java/eu/geoknow/generator/workflow/BatchAdminClientIT.java

@@ -6,6 +6,7 @@
 
 import java.util.Calendar;
 import java.util.GregorianCalendar;
+import java.util.List;
 
 import org.apache.log4j.Logger;
 import org.junit.Test;
@@ -84,7 +85,7 @@ public void getAJob() throws Exception {
 
   @Test(expected = UnknownException.class)
   public void getUnexistingExecution() throws Exception {
-    JobExecutionWrapper execution =
+    List<JobExecutionWrapper> execution =
         BatchAdminClient.getExecutionDetail("mmxy", "91919", springBatchServiceUri);
   }