view agent/core/src/test/java/com/redhat/thermostat/agent/config/AgentConfigsUtilsTest.java @ 2034:92de1fab95ec

Make published agent address configurable. For hosts sitting behind a router, the config listen address of the agent's command channel might not be resolvable by Thermostat clients in front of the router. In those cases it's useful to be able to configure the address Thermostat shall publish to storage for clients to use for establishing command channel connections to agents. Reviewed-by: neugens Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2016-November/021689.html PR3231
author Severin Gehwolf <sgehwolf@redhat.com>
date Mon, 14 Nov 2016 18:07:21 +0100
parents 5a183ba7be84
children a92d602216ad
line wrap: on
line source

/*
 * Copyright 2012-2016 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.agent.config;

import java.io.File;
import java.io.IOException;
import java.util.Properties;

import org.junit.After;
import org.junit.Assert;
import org.junit.Test;

import com.redhat.thermostat.common.utils.HostPortPair;
import com.redhat.thermostat.shared.config.InvalidConfigurationException;
import com.redhat.thermostat.testutils.TestUtils;

public class AgentConfigsUtilsTest {
    
    private File tmpDir;

    @After
    public void tearDown() throws IOException {
        if (tmpDir != null) {
            TestUtils.deleteRecursively(tmpDir);
        }
        AgentConfigsUtils.setConfigFiles(null, null);
        tmpDir = null;
    }
    
    @Test
    public void testSystemDbUrl() throws InvalidConfigurationException, IOException {
        Properties sysProps = createSystemProperties();
        setConfigs(sysProps, new Properties());
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();

        Assert.assertEquals("http://1.2.3.4:9001/hello", config.getDBConnectionString());
    }
    
    @Test
    public void testSystemPurgeProp() throws InvalidConfigurationException, IOException {
        Properties sysProps = createSystemProperties();
        setConfigs(sysProps, new Properties());
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();

        Assert.assertFalse(config.purge());
    }
    
    @Test
    public void testSystemAddressProp() {
        Properties sysProps = createSystemProperties();
        setConfigs(sysProps, new Properties());
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();

        HostPortPair hostPorts = config.getConfigListenAddress();
        Assert.assertEquals("42.42.42.42", hostPorts.getHost());
        Assert.assertEquals(42, hostPorts.getPort());
        
        // Not explicitly set, should default to config listen address
        HostPortPair publishAddr = config.getConfigPublishAddress();
        Assert.assertEquals("42.42.42.42", publishAddr.getHost());
        Assert.assertEquals(42, publishAddr.getPort());
    }
    
    @Test
    public void testUserDbUrl() throws InvalidConfigurationException, IOException {
        Properties sysProps = createSystemProperties();
        Properties userProps = createUserProperties();
        setConfigs(sysProps, userProps);
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        Assert.assertEquals("http://5.6.7.8:9002/world", config.getDBConnectionString());
    }
    
    @Test
    public void testUserPurgeProp() throws InvalidConfigurationException, IOException {
        Properties sysProps = createSystemProperties();
        Properties userProps = createUserProperties();
        setConfigs(sysProps, userProps);
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        Assert.assertTrue(config.purge());
    }
    
    @Test
    public void testUserAddressProp() {
        Properties sysProps = createSystemProperties();
        Properties userProps = createUserProperties();
        setConfigs(sysProps, userProps);
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        HostPortPair hostPorts = config.getConfigListenAddress();
        Assert.assertEquals("24.24.24.24", hostPorts.getHost());
        Assert.assertEquals(24, hostPorts.getPort());
        
        // Not explicitly set, should default to config listen address
        HostPortPair publishAddr = config.getConfigPublishAddress();
        Assert.assertEquals("24.24.24.24", publishAddr.getHost());
        Assert.assertEquals(24, publishAddr.getPort());
    }
    
    @Test
    public void canParseIpv6ConfigAddress() {
        String ipV6AddressPair = "[::1]:12000";
        Properties sysProps = createSystemProperties(ipV6AddressPair);
        setConfigs(sysProps, new Properties());
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        HostPortPair listenAddr = config.getConfigListenAddress();
        Assert.assertEquals("::1", listenAddr.getHost());
        Assert.assertEquals(12000, listenAddr.getPort());
    }
    
    @Test
    public void canOptionallySetSystemPublishAddress() {
        Properties sysProps = createSystemProperties();
        sysProps.put("CONFIG_PUBLISH_ADDRESS", "foo.example.com:9999");
        setConfigs(sysProps, new Properties());
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        HostPortPair listenAddr = config.getConfigListenAddress();
        Assert.assertEquals("42.42.42.42", listenAddr.getHost());
        Assert.assertEquals(42, listenAddr.getPort());
        
        HostPortPair publishAddr = config.getConfigPublishAddress();
        Assert.assertEquals("foo.example.com", publishAddr.getHost());
        Assert.assertEquals(9999, publishAddr.getPort());
    }
    
    @Test
    public void canOptionallySetUserPublishAddress() {
        Properties sysProps = createSystemProperties();
        sysProps.put("CONFIG_PUBLISH_ADDRESS", "foo.example.com:9999");
        Properties userProps = createUserProperties();
        userProps.put("CONFIG_PUBLISH_ADDRESS", "33.33.33.33:9333");
        setConfigs(sysProps, userProps);
        AgentStartupConfiguration config = AgentConfigsUtils.createAgentConfigs();        

        HostPortPair listenAddr = config.getConfigListenAddress();
        Assert.assertEquals("24.24.24.24", listenAddr.getHost());
        Assert.assertEquals(24, listenAddr.getPort());
        
        HostPortPair publishAddr = config.getConfigPublishAddress();
        Assert.assertEquals("33.33.33.33", publishAddr.getHost());
        Assert.assertEquals(9333, publishAddr.getPort());
    }
    
    private Properties createSystemProperties(String configListenAddress) {
        return doCreateSystemProperties(configListenAddress);
    }
    
    private Properties createSystemProperties() {
        return createSystemProperties("42.42.42.42:42");
    }
    
    private Properties createUserProperties() {
        Properties agentProperties = new Properties();
        agentProperties.setProperty("DB_URL", "http://5.6.7.8:9002/world");
        agentProperties.setProperty("SAVE_ON_EXIT", "false");
        agentProperties.setProperty("CONFIG_LISTEN_ADDRESS", "24.24.24.24:24");
        return agentProperties;
    }
    
    private Properties doCreateSystemProperties(String configListenAddress) {
        Properties agentProperties = new Properties();
        agentProperties.setProperty("DB_URL", "http://1.2.3.4:9001/hello");
        agentProperties.setProperty("SAVE_ON_EXIT", "true");
        agentProperties.setProperty("CONFIG_LISTEN_ADDRESS", configListenAddress);
        return agentProperties;
    }
    
    private void setConfigs(Properties sysProps, Properties userProps) {
        try {
            String tmpDirPath = TestUtils.setupAgentConfigs(sysProps, userProps);
            tmpDir = new File(tmpDirPath);
            File sysAgentConf = TestUtils.getAgentConfFile();
            File userAgentConf = TestUtils.getUserAgentConfFile();
            AgentConfigsUtils.setConfigFiles(sysAgentConf, userAgentConf);
        } catch (IOException e) {
            throw new AssertionError("Unable to create agent configuration", e);
        }
    }
}