...

• Device Manager has a support for health check feature.
• It empowers the testers and other users to do health check on the devices before executing any test cases.
• User can easily get the list of devices which are in good state and bring up the devices which are in bad state.
• It reduces the tester time for verifying and getting the devices which are in good state.
• As a basic health check validation in the SSH connection to the device is validated and on successful connection device is assigned to good state.
• On each schedule the list device can be added is standardized to 20 considering the JVM memory size  and the jenkins can hold logs upto some extent for single job.

Automatic Components

• Device Manager UI - Provides UI interface to config device details and schedule health check
• Device Manager - Manages scheduled details request and trigger executions.
• Automatic Properties - Provides UI Interface to configure device related configurations.

Partner Components

• Health Check Partner Implementation - Manages Health check validation for the selected devices based on the defined health check steps and update the results to the Device manager.

Following diagram shows interaction of Automatics components and Partner components in a deployed environment

Design for Device Health Check Feature in Device manager

...

• In Device Manager UI new UI pages are added i.e healthcheck and configuartion pages 
• Navigate to the healthcheck → add schedule → Provide the input fields , select devices → click on submit
• User provided details will saved to the DB with the help of API defined in the Device manager 
• Scheduling thread will be initiated based on the provided execution date and time and occurrence.
• Jenkins job will be scheduled for the execution .(Refer to get more details how to define health check jenkins job)
• health check partner implementation code will be executed and below list of APIs will be called in the partner implementation to update results to the device manager.
  • /healthCheck/updateExecutionDetailsStatus – API is called to update the execution details to device manager once the health check is done for the device from the partner side
  • /healthCheck/updateExecutionStatusCount – API is called to updated the pass , failed and aborted devices count to the device manager from the partner implementation when the health check is completed on all the added devices.
  • /healthCheck/updateInProgressExecutionDeviceDetails – API is called to update the Execution device details to Inprogress when health check is initiated for the device on the partner implementation side.

Update Device Manager with health check feature

Follow below steps to update Device manager with health check feature.

Health Check Partner Implementation

Partner can provide there own defined health check implementation project which supports health check executions and update the executions results to device manager . List of need to be implemented as a part of health check executions. Please refer the Device manager API documentation for more details 

Upgrade Device Manager to support Health Check execution

For a partner to upgrade Device Manager to support heath executions need to be done as mentioned below.

Device Manager

For a partner to upgrade the health check support in Device Manager Please follow below steps.

1. Upgrade Device Manager to v1.0.2 or above since it contains the latest code changes for Health Check execution. Pull the latest code of Device Manager.
2. Run the SQL scripts from

...

1. Device_Manager_DB.sql file

...

1. present in the Automatics Orchestration starting from line number 335. These scripts will help in creating all the new tables that are required for health check execution.
2. Once after the above changes generate a WAR file of Device Manager  and deploy it in the tomcat server. Deployment can also be done using Device Manager Deployment. 
3. Verify whether the deployment is done and updated to 1.0.2 version.

Device Manager UI

For a partner to upgrade the health check support in Device Manager UI Please follow below steps.

1. Upgrade Device Manager UI to v1.13 or above since it contains the latest code changes for Health Check execution. Pull the latest code of Device Manager UI.
2. Once after the above changes generate a WAR file of Device Manager  and deploy it in the tomcat server. Deployment can also be done using Device Manager UI Deployment. 
3. Verify whether the deployment is done and updated to 1.13 version.

Setup Jenkins Job For Health Check

For a partner to setup health check job in jenkins Please refer Health Check Job Configuration for details steps.

Steps to schedule health check

• Navigate to Configuration Tab in Device Manager UI provide the valid jenkins url , username and password details where health check job is configured.
• Schedule the health check for the list of devices Please refer Schedule Health Check for more details on how to schedule executions for health check.
• On successful scheduling success pop will be seen and dashboard will be updated.

Image Removed

• Get the latest source code for Device manager and Device manager UI generate the war file and deploy in the local environments.
• On updated device manager ui able to see health check and configuration new UI pages .
• In Device manager UI navigate to the Configuration tab and update the jenkins url username and password configs required for the health check feature.
• Completed the health check feature updation.