Fixing review suggestions

components/device-mgt/org.wso2.carbon.device.mgt.core/src/test/java/org/wso2/carbon/device/mgt/core/push/notification/mgt/task/PushNotificationSchedulerTaskTest.java

@@ -43,6 +43,9 @@ import java.sql.SQLException;
 import java.util.List;
 import java.util.Map;
 
+/**
+ * This class contains unit tests to test {@link PushNotificationSchedulerTask} class.
+ */
 public class PushNotificationSchedulerTaskTest extends BaseDeviceManagementTest {
     private static final Log log = LogFactory.getLog(PushNotificationSchedulerTask.class);
     private DeviceManagementProviderService deviceMgtProviderService;
@@ -60,10 +63,12 @@ public class PushNotificationSchedulerTaskTest extends BaseDeviceManagementTest
         this.pushNotificationSchedulerTask = new PushNotificationSchedulerTask();
     }
 
-    @Test
+    @Test(description = "Tests the push notification scheduling for devices")
-    public void testPushNotificationScheduler() {
+    public void testPushNotificationScheduler()
+            throws DeviceManagementException, OperationManagementException, SQLException,
+            OperationManagementDAOException {
         try {
-            log.debug("Attempting to execute push notification task scheduler");
+            log.info("Attempting to execute push notification task scheduler");
             Mockito.doReturn(new TestNotificationStrategy()).when(this.deviceMgtProviderService)
                     .getNotificationStrategyByDeviceType(Mockito.anyString());
             Mockito.doReturn(new org.wso2.carbon.device.mgt.common.operation.mgt.Operation())
@@ -75,13 +80,7 @@ public class PushNotificationSchedulerTaskTest extends BaseDeviceManagementTest
                             DeviceConfigurationManager.getInstance().getDeviceManagementConfig()
                                     .getPushNotificationConfiguration().getSchedulerBatchSize());
             Assert.assertEquals(operationMappingsTenantMap.size(), 0);
-            log.debug("Push notification task execution complete.");
+            log.info("Push notification task execution complete.");
-        } catch (DeviceManagementException e) {
-            Assert.fail("Unexpected exception occurred when getting the push notification strategy.", e);
-        } catch (SQLException | OperationManagementDAOException e) {
-            Assert.fail("Unexpected exception occurred retrieving the operation mapping list.", e);
-        } catch (OperationManagementException e) {
-            Assert.fail("Unexpected exception occurred when retrieving an operation.", e);
         } finally {
             OperationManagementDAOFactory.closeConnection();
         }

components/device-mgt/org.wso2.carbon.device.mgt.core/src/test/java/org/wso2/carbon/device/mgt/core/task/DeviceTaskManagerTest.java

@@ -33,6 +33,7 @@ import org.wso2.carbon.device.mgt.common.push.notification.NotificationStrategy;
 import org.wso2.carbon.device.mgt.core.TestDeviceManagementService;
 import org.wso2.carbon.device.mgt.core.TestUtils;
 import org.wso2.carbon.device.mgt.core.authorization.DeviceAccessAuthorizationServiceImpl;
+import org.wso2.carbon.device.mgt.core.common.BaseDeviceManagementTest;
 import org.wso2.carbon.device.mgt.core.common.TestDataHolder;
 import org.wso2.carbon.device.mgt.core.config.DeviceConfigurationManager;
 import org.wso2.carbon.device.mgt.core.internal.DeviceManagementDataHolder;
@@ -52,7 +53,10 @@ import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
-public class DeviceTaskManagerTest {
+/**
+ * This is a test class to test the functionality in {@link DeviceTaskManager}.
+ */
+public class DeviceTaskManagerTest extends BaseDeviceManagementTest {
 
     private static final Log log = LogFactory.getLog(DeviceTaskManagerTest.class);
     private static final String NEW_DEVICE_TYPE = "NEW-DEVICE-TYPE";
@@ -65,7 +69,6 @@ public class DeviceTaskManagerTest {
 
     @BeforeClass
     public void init() throws DeviceManagementException, RegistryException {
-        DeviceConfigurationManager.getInstance().initConfig();
         log.info("Initializing Device Task Manager Test Suite");
         this.deviceIds = new ArrayList<>();
         for (int i = 0; i < 5; i++) {
@@ -73,14 +76,13 @@ public class DeviceTaskManagerTest {
         }
         List<Device> devices = TestDataHolder.generateDummyDeviceData(this.deviceIds);
         this.deviceMgtProviderService = new DeviceManagementProviderServiceImpl();
+
         DeviceManagementServiceComponent.notifyStartupListeners();
         DeviceManagementDataHolder.getInstance().setDeviceManagementProvider(this.deviceMgtProviderService);
         DeviceManagementDataHolder.getInstance()
                 .setRegistryService(TestUtils.getRegistryService(DeviceTaskManagerTest.class));
         DeviceManagementDataHolder.getInstance()
                 .setDeviceAccessAuthorizationService(new DeviceAccessAuthorizationServiceImpl());
-        DeviceManagementDataHolder.getInstance()
-                .setGroupManagementProviderService(new GroupManagementProviderServiceImpl());
         DeviceManagementDataHolder.getInstance().setDeviceTaskManagerService(null);
         NotificationStrategy notificationStrategy = new TestNotificationStrategy();
         this.operationManager = new OperationManagerImpl(TestDataHolder.TEST_DEVICE_TYPE, notificationStrategy);
@@ -93,113 +95,84 @@ public class DeviceTaskManagerTest {
                 TestDataHolder.generateMonitoringTaskConfig(true, 60000, 3));
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group", description = "Getting the task frequency from the scheduler")
-    public void testGetTaskFrequency() {
+    public void testGetTaskFrequency() throws DeviceMgtTaskException {
-        log.debug("Attempting to retrieve task frequency.");
+        log.info("Attempting to retrieve task frequency.");
-        try {
+        Assert.assertEquals(this.deviceTaskManager.getTaskFrequency(), 60000);
-            Assert.assertEquals(this.deviceTaskManager.getTaskFrequency(), 60000);
+        log.info("Successfully retrieved task frequency.");
-        } catch (DeviceMgtTaskException e) {
-            Assert.fail("Exception occurred when obtaining task frequency.", e);
-        }
-        log.debug("Successfully retrieved task frequency.");
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group", description = "Testing if the task is enabled")
-    public void testIsTaskEnabled() {
+    public void testIsTaskEnabled() throws DeviceMgtTaskException {
-        log.debug("Attempting to retrieve task status.");
+        log.info("Attempting to retrieve task status.");
-        try {
+        Assert.assertTrue(this.deviceTaskManager.isTaskEnabled());
-            Assert.assertTrue(this.deviceTaskManager.isTaskEnabled());
+        log.info("Successfully retrieved task status.");
-        } catch (DeviceMgtTaskException e) {
-            Assert.fail("Exception occurred when checking whether the task is enabled.", e);
-        }
-        log.debug("Successfully retrieved task status.");
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group", description = "Testing adding operations to devices.")
-    public void testAddOperation() {
+    public void testAddOperation() throws DeviceMgtTaskException, OperationManagementException {
-        log.debug("Attempting to add operations for devices.");
+        log.info("Attempting to add operations for devices.");
-        try {
+        this.deviceTaskManager.addOperations();
-            this.deviceTaskManager.addOperations();
+        for (DeviceIdentifier deviceId : deviceIds) {
-            for(DeviceIdentifier deviceId :  deviceIds) {
+            List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
-                List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
+            Assert.assertNotNull(operationList);
-                Assert.assertNotNull(operationList);
+            Assert.assertEquals(operationList.size(), 3);
-                Assert.assertEquals(operationList.size(), 3);
-            }
-        } catch (DeviceMgtTaskException e) {
-            Assert.fail("Exception occurred when adding operations to available devices.", e);
-        } catch (OperationManagementException e) {
-            Assert.fail("Exception occurred when retrieving operations.", e);
         }
-        log.debug("Successfully added operations for devices.");
+        log.info("Successfully added operations for devices.");
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group",
-    public void testAddOperationsWithoutDevices() {
+            description = "Testing adding operations when no devices are available")
-        try {
+    public void testAddOperationsWithoutDevices() throws DeviceManagementException, DeviceMgtTaskException {
-            this.deviceMgtProviderService.registerDeviceType(
+        this.deviceMgtProviderService.registerDeviceType(
-                    new TestDeviceManagementService(NEW_DEVICE_TYPE, TestDataHolder.SUPER_TENANT_DOMAIN));
+                new TestDeviceManagementService(NEW_DEVICE_TYPE, TestDataHolder.SUPER_TENANT_DOMAIN));
-            DeviceTaskManager taskManager = new DeviceTaskManagerImpl(NEW_DEVICE_TYPE,
+        DeviceTaskManager taskManager = new DeviceTaskManagerImpl(NEW_DEVICE_TYPE,
-                    TestDataHolder.generateMonitoringTaskConfig(true, 50000, 3));
+                TestDataHolder.generateMonitoringTaskConfig(true, 50000, 3));
-            taskManager.addOperations();
+        taskManager.addOperations();
-        } catch (DeviceManagementException e) {
-            Assert.fail("Unexpected exception occurred", e);
-        } catch (DeviceMgtTaskException e) {
-            Assert.fail("Exception occurred when adding operations for the devices", e);
-        }
     }
 
-    @Test(groups = "Device Task Manager Test Group", dependsOnMethods = "testAddOperationsWithoutDevices")
+    @Test(groups = "Device Task Manager Test Group", dependsOnMethods = "testAddOperationsWithoutDevices",
-    public void testAddOperationsWithoutOperations() {
+            description = "Testing adding operations when no operations are scheduled")
+    public void testAddOperationsWithoutOperations() throws DeviceMgtTaskException {
         DeviceTaskManager taskManager = new DeviceTaskManagerImpl(NEW_DEVICE_TYPE,
                 TestDataHolder.generateMonitoringTaskConfig(true, 50000, 3));
-        try {
+        taskManager.addOperations();
-            taskManager.addOperations();
-        } catch (DeviceMgtTaskException e) {
-            Assert.fail("Exception occurred when adding operations for the devices", e);
-        }
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group", description = "Testing device detail retriever task execution")
-    public void testDeviceDetailRetrieverTaskExecute() {
+    public void testDeviceDetailRetrieverTaskExecute() throws OperationManagementException {
         DeviceDetailsRetrieverTask deviceDetailsRetrieverTask = new DeviceDetailsRetrieverTask();
         Map<String, String> map = new HashMap<>();
         map.put("DEVICE_TYPE", TestDataHolder.TEST_DEVICE_TYPE);
         map.put("OPPCONFIG", DEVICE_DETAIL_RETRIEVER_OPPCONFIG);
-        try {
+        deviceDetailsRetrieverTask.setProperties(map);
-            deviceDetailsRetrieverTask.setProperties(map);
+        deviceDetailsRetrieverTask.execute();
-            deviceDetailsRetrieverTask.execute();
+        for (DeviceIdentifier deviceId : deviceIds) {
-            for(DeviceIdentifier deviceId :  deviceIds) {
+            List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
-                List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
+            Assert.assertNotNull(operationList);
-                Assert.assertNotNull(operationList);
+            Assert.assertEquals(operationList.size(), 4,
-                Assert.assertEquals(operationList.size(), 4, "Expected number of operations is 4 " +
+                    "Expected number of operations is 4 after adding the device detail retriever operation");
-                        "after adding the device detail retriever operation");
+            Assert.assertEquals(operationList.get(0).getCode(), "DEVICE_INFO",
-                Assert.assertEquals(operationList.get(0).getCode(), "DEVICE_INFO", "Operation code of " +
+                    "Operation code of the device detail retriever task should be DEVICE_LOCATION");
-                        "the device detail retriever task should be DEVICE_LOCATION");
-            }
-        } catch (Exception e) {
-            Assert.fail("Exception occurred when adding operations for the devices", e);
         }
     }
 
-    @Test(groups = "Device Task Manager Test Group")
+    @Test(groups = "Device Task Manager Test Group",
-    public void testDeviceDetailRetrieverTaskExecuteForAllTenants() {
+            description = "Testing device detail retriever task execution for tenants")
+    public void testDeviceDetailRetrieverTaskExecuteForAllTenants() throws OperationManagementException {
         DeviceDetailsRetrieverTask deviceDetailsRetrieverTask = new DeviceDetailsRetrieverTask();
         System.setProperty("is.cloud", "true");
         Map<String, String> map = new HashMap<>();
         map.put("DEVICE_TYPE", TestDataHolder.TEST_DEVICE_TYPE);
         map.put("OPPCONFIG", DEVICE_DETAIL_RETRIEVER_OPPCONFIG);
-        try {
+        deviceDetailsRetrieverTask.setProperties(map);
-            deviceDetailsRetrieverTask.setProperties(map);
+        deviceDetailsRetrieverTask.execute();
-            deviceDetailsRetrieverTask.execute();
+        for (DeviceIdentifier deviceId : deviceIds) {
-            for(DeviceIdentifier deviceId :  deviceIds) {
+            List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
-                List<? extends Operation> operationList = this.operationManager.getOperations(deviceId);
+            Assert.assertNotNull(operationList);
-                Assert.assertNotNull(operationList);
+            Assert.assertEquals(operationList.size(), 4);
-                Assert.assertEquals(operationList.size(), 4);
+            Assert.assertEquals(operationList.get(0).getCode(), "DEVICE_INFO",
-                Assert.assertEquals(operationList.get(0).getCode(), "DEVICE_INFO", "Operation code of " +
+                    "Operation code of the device detail retriever task should be DEVICE_LOCATION");
-                        "the device detail retriever task should be DEVICE_LOCATION");
-            }
-        } catch (Exception e) {
-            Assert.fail("Exception occurred when adding operations for the devices", e);
         }
     }
 
@@ -209,5 +182,4 @@ public class DeviceTaskManagerTest {
             this.deviceMgtProviderService.disenrollDevice(deviceId);
         }
     }
-
 }