Externalize KVM Agent storage's timeout configuration (#5239)

* Externalize KVM Agent storage's timeout configuration

* Address @nvazquez review

* Add empty line at the end of the agent.properties file

Co-authored-by: Daniel Augusto Veronezi Salvador <[email protected]>

Author: GutoVeronezi

agent/conf/agent.properties

@@ -266,3 +266,7 @@ iscsi.session.cleanup.enabled=false
 # Automatically clean up iscsi sessions not attached to any VM.
 # Should be enabled for users using managed storage for example solidfire.
 # Should be disabled for users with unmanaged iscsi connections on their hosts
+
+# This parameter specifies the heartbeat update timeout in ms; The default value is 60000ms (1 min).
+# Depending on the use case, this timeout might need increasing/decreasing.
+# heartbeat.update.timeout=60000

agent/src/main/java/com/cloud/agent/properties/AgentProperties.java

@@ -0,0 +1,52 @@
+/*
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.cloud.agent.properties;
+
+/**
+ * Class of constant agent's properties available to configure on
+ * "agent.properties".
+ *<br><br>
+ * Not all available agent properties are defined here, but we should work to
+ * migrate them on demand to this class.
+ *
+ * @param <T> type of the default value.
+ */
+public class AgentProperties{
+
+    /**
+     * Heartbeat update timeout. <br>
+     * Data type: int. <br>
+     * Default value: 60000 (ms).
+    */
+    public static final Property<Integer> HEARTBEAT_UPDATE_TIMEOUT = new Property<Integer>("heartbeat.update.timeout", 60000);
+
+    public static class Property <T>{
+        private final String name;
+        private final T defaultValue;
+
+        private Property(String name, T value) {
+            this.name = name;
+            this.defaultValue = value;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public T getDefaultValue() {
+            return defaultValue;
+        }
+    }
+}

agent/src/main/java/com/cloud/agent/properties/AgentPropertiesFileHandler.java

@@ -0,0 +1,70 @@
+/*
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.cloud.agent.properties;
+
+import com.cloud.utils.PropertiesUtil;
+import java.io.File;
+import java.io.IOException;
+import org.apache.cloudstack.utils.security.KeyStoreUtils;
+import org.apache.commons.beanutils.ConvertUtils;
+import org.apache.commons.beanutils.converters.IntegerConverter;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.log4j.Logger;
+
+/**
+ * This class provides a facility to read the agent's properties file and get
+ * its properties, according to the {@link AgentProperties} properties constants.
+ *
+ */
+public class AgentPropertiesFileHandler {
+
+    private static final Logger logger = Logger.getLogger(AgentPropertiesFileHandler.class);
+
+    /**
+     * This method reads the property in the agent.properties file.
+     *
+     * @param property the property to retrieve.
+     * @return The value of the property. If the property is not available, the
+     * default defined value will be used.
+     */
+    public static <T> T getPropertyValue(AgentProperties.Property<T> property) {
+        T defaultValue = property.getDefaultValue();
+        String name = property.getName();
+
+        File agentPropertiesFile = PropertiesUtil.findConfigFile(KeyStoreUtils.AGENT_PROPSFILE);
+
+        if (agentPropertiesFile != null) {
+            try {
+                String configValue = PropertiesUtil.loadFromFile(agentPropertiesFile).getProperty(name);
+                if (StringUtils.isNotBlank(configValue)) {
+                    if (defaultValue instanceof Integer) {
+                        ConvertUtils.register(new IntegerConverter(defaultValue), Integer.class);
+                    }
+
+                    return (T)ConvertUtils.convert(configValue, defaultValue.getClass());
+                } else {
+                    logger.debug(String.format("Property [%s] has empty or null value. Using default value [%s].", name, defaultValue));
+                }
+            } catch (IOException ex) {
+                logger.debug(String.format("Failed to get property [%s]. Using default value [%s].", name, defaultValue), ex);
+            }
+        } else {
+            logger.debug(String.format("File [%s] was not found, we will use default defined values. Property [%s]: [%s].", KeyStoreUtils.AGENT_PROPSFILE, name, defaultValue));
+        }
+
+        return defaultValue;
+    }
+
+}

agent/src/test/java/com/cloud/agent/properties/AgentPropertiesFileHandlerTest.java

@@ -0,0 +1,143 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.cloud.agent.properties;
+
+import com.cloud.utils.PropertiesUtil;
+import java.io.File;
+import java.io.IOException;
+import java.util.Properties;
+import junit.framework.TestCase;
+import org.apache.commons.beanutils.ConvertUtils;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+
+@RunWith(PowerMockRunner.class)
+@PrepareForTest({PropertiesUtil.class, ConvertUtils.class})
+public class AgentPropertiesFileHandlerTest extends TestCase {
+
+    @Mock
+    AgentProperties.Property<String> agentPropertiesStringMock;
+
+    @Mock
+    AgentProperties.Property<Integer> agentPropertiesIntegerMock;
+
+    @Mock
+    File fileMock;
+
+    @Mock
+    Properties propertiesMock;
+
+    @Test
+    public void validateGetPropertyValueFileNotFoundReturnDefaultValue() throws Exception{
+        String expectedResult = "default value";
+        Mockito.doReturn(expectedResult).when(agentPropertiesStringMock).getDefaultValue();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(null).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+
+        String result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesStringMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+
+    @Test
+    public void validateGetPropertyValueLoadFromFileThrowsIOExceptionReturnDefaultValue() throws Exception{
+        String expectedResult = "default value";
+        Mockito.doReturn(expectedResult).when(agentPropertiesStringMock).getDefaultValue();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(fileMock).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+        PowerMockito.doThrow(new IOException()).when(PropertiesUtil.class, "loadFromFile", Mockito.any());
+
+        String result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesStringMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+
+    @Test
+    public void validateGetPropertyValuePropertyIsEmptyReturnDefaultValue() throws Exception{
+        String expectedResult = "default value";
+        Mockito.doReturn(expectedResult).when(agentPropertiesStringMock).getDefaultValue();
+        Mockito.doReturn("name").when(agentPropertiesStringMock).getName();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(fileMock).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+        PowerMockito.doReturn(propertiesMock).when(PropertiesUtil.class, "loadFromFile", Mockito.any());
+        PowerMockito.doReturn("").when(propertiesMock).getProperty(Mockito.anyString());
+
+        String result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesStringMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+
+    @Test
+    public void validateGetPropertyValuePropertyIsNullReturnDefaultValue() throws Exception{
+        String expectedResult = "default value";
+        Mockito.doReturn(expectedResult).when(agentPropertiesStringMock).getDefaultValue();
+        Mockito.doReturn("name").when(agentPropertiesStringMock).getName();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(fileMock).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+        PowerMockito.doReturn(propertiesMock).when(PropertiesUtil.class, "loadFromFile", Mockito.any());
+        PowerMockito.doReturn(null).when(propertiesMock).getProperty(Mockito.anyString());
+
+        String result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesStringMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+
+    @Test
+    public void validateGetPropertyValueValidPropertyReturnPropertyValue() throws Exception{
+        String expectedResult = "test";
+        Mockito.doReturn("default value").when(agentPropertiesStringMock).getDefaultValue();
+        Mockito.doReturn("name").when(agentPropertiesStringMock).getName();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(fileMock).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+        PowerMockito.doReturn(propertiesMock).when(PropertiesUtil.class, "loadFromFile", Mockito.any());
+        Mockito.doReturn(expectedResult).when(propertiesMock).getProperty(Mockito.anyString());
+
+        String result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesStringMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+
+    @Test
+    public void validateGetPropertyValueValidIntegerPropertyReturnPropertyValue() throws Exception{
+        Integer expectedResult = 2;
+        Mockito.doReturn(1).when(agentPropertiesIntegerMock).getDefaultValue();
+        Mockito.doReturn("name").when(agentPropertiesIntegerMock).getName();
+
+        PowerMockito.mockStatic(PropertiesUtil.class);
+        PowerMockito.doReturn(fileMock).when(PropertiesUtil.class, "findConfigFile", Mockito.anyString());
+        PowerMockito.doReturn(propertiesMock).when(PropertiesUtil.class, "loadFromFile", Mockito.any());
+        Mockito.doReturn(String.valueOf(expectedResult)).when(propertiesMock).getProperty(Mockito.anyString());
+
+        Integer result = AgentPropertiesFileHandler.getPropertyValue(agentPropertiesIntegerMock);
+
+        Assert.assertEquals(expectedResult, result);
+    }
+}