Merge pull request #6 from TAMULib/sprint1-b03253-monitor

jcreel · web-flow · commit a5e20ada5b8d · 2017-07-05T10:23:44.000-05:00
Sprint1 b03253 monitor
diff --git a/src/main/java/edu/tamu/app/controller/ServiceController.java b/src/main/java/edu/tamu/app/controller/ServiceController.java
@@ -53,7 +53,7 @@ public ApiResponse getService(@ApiVariable Long id) {
     @Auth(role = "ROLE_SERVICE_MANAGER")
     @ApiValidation(business = { @ApiValidation.Business(value = CREATE), @ApiValidation.Business(value = EXISTS) })
     public ApiResponse createService(@ApiValidatedModel Service service) {
-        service = serviceRepo.create(service.getName(), service.getStatus(), service.getIsPublic(), service.getOnShortList());
+        service = serviceRepo.create(service.getName(), service.getStatus(), service.getIsAuto(), service.getIsPublic(), service.getOnShortList(),service.getServiceUrl());
         simpMessagingTemplate.convertAndSend("/channel/service", new ApiResponse(SUCCESS, serviceRepo.findOne(service.getId())));
         return new ApiResponse(SUCCESS, service);
     }
diff --git a/src/main/java/edu/tamu/app/controller/StatusController.java b/src/main/java/edu/tamu/app/controller/StatusController.java
@@ -2,7 +2,7 @@
 
 import edu.tamu.app.model.OverallStatus;
 import edu.tamu.app.service.AppRoleService;
-import edu.tamu.app.service.OverallStatusService;
+import edu.tamu.app.service.MonitorService;
 import edu.tamu.framework.aspect.annotation.ApiCredentials;
 import edu.tamu.framework.aspect.annotation.ApiMapping;
 import edu.tamu.framework.aspect.annotation.Auth;
@@ -19,22 +19,22 @@
 public class StatusController {
 	
 	@Autowired
-	OverallStatusService overallStatusService;
+	MonitorService monitorService;
 	
 	@Autowired
 	AppRoleService appRoleService;
 	
 	@ApiMapping("/overall-full")
 	@Auth(role = "ROLE_STAFF")
 	public ApiResponse overallFull(@ApiCredentials Credentials credentials) {
-		OverallStatus overallStatus = overallStatusService.getOverallStatusFull();		
+		OverallStatus overallStatus = monitorService.getOverallStatus();		
         return new ApiResponse(SUCCESS, overallStatus);
 	}
 	
 	@ApiMapping("/overall-public")
 	@Auth(role = "ROLE_ANONYMOUS")
 	public ApiResponse overallPublic(@ApiCredentials Credentials credentials) {		
-		OverallStatus overallStatus = overallStatusService.getOverallStatusPublic();
+		OverallStatus overallStatus = monitorService.getOverallStatusPublic();
         return new ApiResponse(SUCCESS, overallStatus);
 	}
 	
diff --git a/src/main/java/edu/tamu/app/enums/Status.java b/src/main/java/edu/tamu/app/enums/Status.java
@@ -2,5 +2,5 @@
 
 public enum Status {
 
-    UP, DOWN, AUTO;
+    UP, DOWN;
 }
diff --git a/src/main/java/edu/tamu/app/job/UpdateServiceStatuses.java b/src/main/java/edu/tamu/app/job/UpdateServiceStatuses.java
@@ -1,30 +1,30 @@
 package edu.tamu.app.job;
 
+import static edu.tamu.framework.enums.ApiResponseType.SUCCESS;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.messaging.simp.SimpMessagingTemplate;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Service;
 
-import edu.tamu.app.service.OverallStatusService;
+import edu.tamu.app.service.MonitorService;
 import edu.tamu.framework.model.ApiResponse;
 
-import static edu.tamu.framework.enums.ApiResponseType.SUCCESS;
-
 @Service
-public class UpdateOveralStatuses {
+public class UpdateServiceStatuses {
 
 	@Autowired
-	OverallStatusService overallStatusService;
+	MonitorService monitorService;
 	
 	@Autowired
 	SimpMessagingTemplate simpMessagingTemplate;
 	
-	@Scheduled(fixedRate=(1 * 30 * 1000))
+	@Scheduled(fixedRate=(10*60*1000))
 	public void updateOveralStatuses() {
-		overallStatusService.updateStatuses();
+		monitorService.updateAll();
 		
-		simpMessagingTemplate.convertAndSend("/channel/status/overall-full", new ApiResponse(SUCCESS, overallStatusService.getOverallStatusFull()));
-		simpMessagingTemplate.convertAndSend("/channel/status/overall-public", new ApiResponse(SUCCESS, overallStatusService.getOverallStatusPublic()));
+		simpMessagingTemplate.convertAndSend("/channel/status/overall-full", new ApiResponse(SUCCESS, monitorService.getOverallStatus()));
+		simpMessagingTemplate.convertAndSend("/channel/status/overall-public", new ApiResponse(SUCCESS, monitorService.getOverallStatusPublic()));
 		
 	}
 
diff --git a/src/main/java/edu/tamu/app/model/Service.java b/src/main/java/edu/tamu/app/model/Service.java
@@ -38,6 +38,9 @@ public class Service extends BaseEntity {
     @Column(nullable = false, unique = false)
     private Status status;
     
+    @Column(nullable = false)
+    private boolean isAuto;
+    
     @Column(nullable = true, unique = true)
     private String serviceUrl;
     
@@ -57,12 +60,14 @@ public Service() {
         setAliases(new ArrayList<String>());
     }
     
-    public Service(String name, Status status, Boolean isPublic, Boolean onShortList) {
+    public Service(String name, Status status, Boolean isAuto, Boolean isPublic, Boolean onShortList, String serviceUrl) {
         this();
         setName(name);
         setStatus(status);
+        setIsAuto(isAuto);
         setIsPublic(isPublic);
         setOnShortList(onShortList);
+        setServiceUrl(serviceUrl);
     }
 
     public String getName() {
@@ -81,11 +86,14 @@ public void setStatus(Status status) {
         this.status = status;
     }
     
-    public boolean isCurrentlyUp() {
-    	//TODO: Implement this method to return true, false or the resolution of 'auto' 
-    	return true;
+    public Boolean getIsAuto() {
+        return isAuto;
     }
-
+    
+    public void setIsAuto(Boolean isAuto) {
+        this.isAuto = isAuto;
+    }
+    
     public String getServiceUrl() {
         return serviceUrl;
     }
diff --git a/src/main/java/edu/tamu/app/model/repo/ServiceRepo.java b/src/main/java/edu/tamu/app/model/repo/ServiceRepo.java
@@ -4,10 +4,14 @@
 
 import org.springframework.data.jpa.repository.JpaRepository;
 
+import edu.tamu.app.enums.Status;
 import edu.tamu.app.model.Service;
 import edu.tamu.app.model.repo.custom.ServiceRepoCustom;
 
 public interface ServiceRepo extends JpaRepository<Service, Long>, ServiceRepoCustom {
 
     public List<Service> findByIsPublic(Boolean isPublic);
+    public List<Service> findByIsAuto(Boolean isAuto);
+    public Long countByStatus(Status status);
+    public Long countByStatusAndIsPublic(Status status, Boolean isPublic);
 }
diff --git a/src/main/java/edu/tamu/app/model/repo/custom/ServiceRepoCustom.java b/src/main/java/edu/tamu/app/model/repo/custom/ServiceRepoCustom.java
@@ -5,6 +5,6 @@
 
 public interface ServiceRepoCustom {
     
-    public Service create(String name, Status status, Boolean isPublic, Boolean onShortList);
+    public Service create(String name, Status status, Boolean isAuto, Boolean isPublic, Boolean onShortList, String serviceUrl);
 
 }
diff --git a/src/main/java/edu/tamu/app/model/repo/impl/ServiceRepoImpl.java b/src/main/java/edu/tamu/app/model/repo/impl/ServiceRepoImpl.java
@@ -13,7 +13,7 @@ public class ServiceRepoImpl implements ServiceRepoCustom {
     ServiceRepo serviceRepo;
     
     @Override
-    public Service create(String name, Status status, Boolean isPublic, Boolean onShortList) {
-        return serviceRepo.save(new Service(name, status, isPublic, onShortList));
+    public Service create(String name, Status status, Boolean isAuto, Boolean isPublic, Boolean onShortList, String serviceUrl) {
+        return serviceRepo.save(new Service(name, status, isAuto, isPublic, onShortList, serviceUrl));
     }
 }
diff --git a/src/main/java/edu/tamu/app/model/validation/ServiceValidator.java b/src/main/java/edu/tamu/app/model/validation/ServiceValidator.java
@@ -15,10 +15,13 @@ public ServiceValidator() {
         String statusProperty = "status";
         this.addInputValidator(new InputValidator(InputValidationType.required, "Service requires an enum status", statusProperty, true));
         
+        String isAutoProperty = "isAuto";
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is automatically managed", isAutoProperty, true));
+
         String isPublicProperty = "isPublic";
-        this.addInputValidator(new InputValidator(InputValidationType.required, "Service required an Boolean indicating whether it is public", isPublicProperty, true));
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is public", isPublicProperty, true));
         
         String onShortListProperty = "onShortList";
-        this.addInputValidator(new InputValidator(InputValidationType.required, "Service required an Boolean indicating whether it is on the short list", onShortListProperty, true));
+        this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is on the short list", onShortListProperty, true));
     }
 }
diff --git a/src/main/java/edu/tamu/app/service/MonitorService.java b/src/main/java/edu/tamu/app/service/MonitorService.java
@@ -0,0 +1,9 @@
+package edu.tamu.app.service;
+
+import edu.tamu.app.model.OverallStatus;
+
+public interface MonitorService {
+	public void updateAll();
+	public OverallStatus getOverallStatus();
+	public OverallStatus getOverallStatusPublic();
+}
diff --git a/src/main/java/edu/tamu/app/service/OverallStatusService.java b/src/main/java/edu/tamu/app/service/OverallStatusService.java
diff --git a/src/main/java/edu/tamu/app/service/SystemMonitorService.java b/src/main/java/edu/tamu/app/service/SystemMonitorService.java
@@ -0,0 +1,83 @@
+package edu.tamu.app.service;
+
+import static edu.tamu.app.enums.OverallMessageType.ERROR;
+import static edu.tamu.app.enums.OverallMessageType.SUCCESS;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.util.List;
+import java.util.Map;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import edu.tamu.app.enums.Status;
+import edu.tamu.app.model.OverallStatus;
+import edu.tamu.app.model.repo.ServiceRepo;
+import edu.tamu.framework.util.HttpUtility;
+
+@Service
+public class SystemMonitorService implements MonitorService {
+	@Autowired
+	ServiceRepo serviceRepo;
+	
+	@Autowired
+	HttpUtility httpUtility;
+	
+	@Autowired
+	ObjectMapper objectMapper;
+	
+	private static final String SUCCESS_MESSAGE = "All services are working.";
+	private static final String ERROR_MESSAGE = "Some services are experiencing problems.";
+
+	private Logger logger = LoggerFactory.getLogger(this.getClass());
+
+	@Override
+	public void updateAll() {
+		logger.debug("Monitor Service is checking the status of the managed services");
+		//get all monitor-able services from ServiceRepo
+		serviceRepo.findByIsAuto(true).forEach(service -> {
+			try {
+				Status serviceStatus = getServiceStatus(service.getServiceUrl());
+				//update the service status if it's changed
+				logger.debug("The status reported by ["+service.getServiceUrl()+"] of ["+service.getName()+"] is: "+serviceStatus);
+				if (serviceStatus != service.getStatus()) {
+					logger.debug("Updating the status of ["+service.getName()+"] to: "+serviceStatus);
+					service.setStatus(serviceStatus);
+					serviceRepo.save(service);
+				}
+			} catch(MalformedURLException e) {
+				logger.error("Did not check the status of ["+service.getName()+"] due to a malformed URL: "+service.getServiceUrl());
+			} catch(IOException e) {
+				logger.error("Attempt to check the status of ["+service.getName()+"] failed due to an IOException");
+			}
+		});
+	}
+	
+	public OverallStatus getOverallStatus() {
+		Long downCount = serviceRepo.countByStatus(Status.DOWN);
+		if (downCount == 0) {
+			return new OverallStatus(SUCCESS, SUCCESS_MESSAGE);
+		}
+		return new OverallStatus(ERROR, ERROR_MESSAGE);
+	}
+	
+	public OverallStatus getOverallStatusPublic() {		
+		Long downCount = serviceRepo.countByStatusAndIsPublic(Status.DOWN,true);
+		if (downCount == 0) {
+			return new OverallStatus(SUCCESS, SUCCESS_MESSAGE);
+		}
+		return new OverallStatus(ERROR, ERROR_MESSAGE);
+	}	
+	protected Status getServiceStatus(String serviceUrl) throws MalformedURLException,IOException {
+		String rawStatusResponse = httpUtility.makeHttpRequest(serviceUrl, "GET");
+		List<Map<String,String>> mappedStatusResponse  = objectMapper.readValue(rawStatusResponse, new TypeReference<List<Map<String, String>>>(){});
+		return Status.valueOf(mappedStatusResponse.get(0).get("service").toUpperCase());
+	}
+
+}
diff --git a/src/main/java/edu/tamu/app/util/AppHttpUtility.java b/src/main/java/edu/tamu/app/util/AppHttpUtility.java
@@ -0,0 +1,23 @@
+package edu.tamu.app.util;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.Optional;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+import edu.tamu.framework.util.HttpUtility;
+
+@Service
+public class AppHttpUtility extends HttpUtility {
+	@Value("${app.http.timeout}")
+	private int DEFAULT_TIMEOUT;
+	
+	@Override
+	public String makeHttpRequest(String urlString, String method) throws IOException, MalformedURLException {
+		URL url = new URL(urlString);
+		return makeHttpRequest(urlString, method, Optional.empty(), Optional.empty(), DEFAULT_TIMEOUT);
+	}
+}
diff --git a/src/test/java/controller/ServiceControllerTest.java b/src/test/java/controller/ServiceControllerTest.java
diff --git a/src/test/java/edu/tamu/app/model/NoteTest.java b/src/test/java/edu/tamu/app/model/NoteTest.java
diff --git a/src/test/java/edu/tamu/app/model/ServiceTest.java b/src/test/java/edu/tamu/app/model/ServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public ApiResponse getService(@ApiVariable Long id) {`
`53`	`53`	`@Auth(role = "ROLE_SERVICE_MANAGER")`
`54`	`54`	`@ApiValidation(business = { @ApiValidation.Business(value = CREATE), @ApiValidation.Business(value = EXISTS) })`
`55`	`55`	`public ApiResponse createService(@ApiValidatedModel Service service) {`
`56`		`- service = serviceRepo.create(service.getName(), service.getStatus(), service.getIsPublic(), service.getOnShortList());`
	`56`	`+ service = serviceRepo.create(service.getName(), service.getStatus(), service.getIsAuto(), service.getIsPublic(), service.getOnShortList(),service.getServiceUrl());`
`57`	`57`	`simpMessagingTemplate.convertAndSend("/channel/service", new ApiResponse(SUCCESS, serviceRepo.findOne(service.getId())));`
`58`	`58`	`return new ApiResponse(SUCCESS, service);`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`
`3`	`3`	`public enum Status {`
`4`	`4`
`5`		`- UP, DOWN, AUTO;`
	`5`	`+ UP, DOWN;`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@`
`5`	`5`
`6`	`6`	`public interface ServiceRepoCustom {`
`7`	`7`
`8`		`- public Service create(String name, Status status, Boolean isPublic, Boolean onShortList);`
	`8`	`+ public Service create(String name, Status status, Boolean isAuto, Boolean isPublic, Boolean onShortList, String serviceUrl);`
`9`	`9`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class ServiceRepoImpl implements ServiceRepoCustom {`
`13`	`13`	`ServiceRepo serviceRepo;`
`14`	`14`
`15`	`15`	`@Override`
`16`		`- public Service create(String name, Status status, Boolean isPublic, Boolean onShortList) {`
`17`		`- return serviceRepo.save(new Service(name, status, isPublic, onShortList));`
	`16`	`+ public Service create(String name, Status status, Boolean isAuto, Boolean isPublic, Boolean onShortList, String serviceUrl) {`
	`17`	`+ return serviceRepo.save(new Service(name, status, isAuto, isPublic, onShortList, serviceUrl));`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,13 @@ public ServiceValidator() {`
`15`	`15`	`String statusProperty = "status";`
`16`	`16`	`this.addInputValidator(new InputValidator(InputValidationType.required, "Service requires an enum status", statusProperty, true));`
`17`	`17`
	`18`	`+ String isAutoProperty = "isAuto";`
	`19`	`+ this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is automatically managed", isAutoProperty, true));`
	`20`	`+`
`18`	`21`	`String isPublicProperty = "isPublic";`
`19`		`- this.addInputValidator(new InputValidator(InputValidationType.required, "Service required an Boolean indicating whether it is public", isPublicProperty, true));`
	`22`	`+ this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is public", isPublicProperty, true));`
`20`	`23`
`21`	`24`	`String onShortListProperty = "onShortList";`
`22`		`- this.addInputValidator(new InputValidator(InputValidationType.required, "Service required an Boolean indicating whether it is on the short list", onShortListProperty, true));`
	`25`	`+ this.addInputValidator(new InputValidator(InputValidationType.required, "Service required a Boolean indicating whether it is on the short list", onShortListProperty, true));`
`23`	`26`	`}`
`24`	`27`	`}`