view system-backend/src/test/java/com/redhat/thermostat/backend/system/JvmStatHostListenerTest.java @ 910:421d8a954893

Generic agent-side API for VM start/stop Introduce an API that all backends can use to find out when a VM starts up or shuts down. Currently, all backends re-implement this functionality using jvmstat explicitly. With an explicit API for this, we will have less duplicated code for each plugin and we can change/improve the implementation that detects when VMs start or stop without having to change each plugin. All classes implementing VmStatusChangeListener registered as OSGi services now get notified about the VM's pid when a vm starts or stops. The GC backend now obtains the pid from this new API but still uses the MonitoredVm class form jvmstat connect to the VM and gather data. Reviewed-by: ebaron, vanaltj Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-January/005122.html PR1258
author Omair Majid <omajid@redhat.com>
date Tue, 15 Jan 2013 11:38:58 -0500
parents 3cc2f2ea31b3
children ccac9bcabaa0
line wrap: on
line source

/*
 * Copyright 2012 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.backend.system;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.eq;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import java.net.URISyntaxException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;

import sun.jvmstat.monitor.HostIdentifier;
import sun.jvmstat.monitor.MonitorException;
import sun.jvmstat.monitor.MonitoredHost;
import sun.jvmstat.monitor.MonitoredVm;
import sun.jvmstat.monitor.StringMonitor;
import sun.jvmstat.monitor.VmIdentifier;
import sun.jvmstat.monitor.event.VmStatusChangeEvent;

import com.redhat.thermostat.agent.VmStatusListener.Status;
import com.redhat.thermostat.common.dao.VmInfoDAO;
import com.redhat.thermostat.storage.model.VmInfo;

public class JvmStatHostListenerTest {
    
    private static String INFO_CMDLINE = "/path/to/executable command line args";
    private static String INFO_JAVAHOME = "/path/to/java";
    private static String INFO_JAVAVER = "1.9001";
    private static String INFO_MAINCLASS = "MyMainClass";
    private static String INFO_VMARGS = "-Xarg1 -Xarg2";
    private static String INFO_VMINFO = "Info";
    private static String INFO_VMNAME = "MyJVM";
    private static String INFO_VMVER = "90.01";

    private JvmStatHostListener hostListener;
    private MonitoredHost host;
    private MonitoredVm monitoredVm1;
    private MonitoredVm monitoredVm2;
    private JvmStatDataExtractor extractor;
    private VmInfoDAO vmInfoDAO;
    private VmStatusChangeNotifier notifier;

    @Before
    public void setup() throws MonitorException, URISyntaxException {
        vmInfoDAO = mock(VmInfoDAO.class);
        notifier = mock(VmStatusChangeNotifier.class);

        hostListener = new JvmStatHostListener(vmInfoDAO, notifier);
        
        host = mock(MonitoredHost.class);
        HostIdentifier hostId = mock(HostIdentifier.class);
        monitoredVm1 = mock(MonitoredVm.class);
        monitoredVm2 = mock(MonitoredVm.class);
        StringMonitor monitor = mock(StringMonitor.class);
        VmIdentifier vmId1 = new VmIdentifier("1");
        VmIdentifier vmId2 = new VmIdentifier("2");
        
        when(host.getHostIdentifier()).thenReturn(hostId);
        when(host.getMonitoredVm(eq(vmId1))).thenReturn(monitoredVm1);
        when(host.getMonitoredVm(eq(vmId2))).thenReturn(monitoredVm2);
        when(hostId.resolve(eq(vmId1))).thenReturn(vmId1);
        when(hostId.resolve(eq(vmId2))).thenReturn(vmId2);
        when(monitoredVm1.findByName(any(String.class))).thenReturn(monitor);
        when(monitoredVm2.findByName(any(String.class))).thenReturn(monitor);
        when(monitor.stringValue()).thenReturn("test");
        when(monitor.getValue()).thenReturn("test");
        
        extractor = mock(JvmStatDataExtractor.class);
        
        when(extractor.getCommandLine()).thenReturn(INFO_CMDLINE);
        when(extractor.getJavaHome()).thenReturn(INFO_JAVAHOME);
        when(extractor.getJavaVersion()).thenReturn(INFO_JAVAVER);
        when(extractor.getMainClass()).thenReturn(INFO_MAINCLASS);
        when(extractor.getVmArguments()).thenReturn(INFO_VMARGS);
        when(extractor.getVmInfo()).thenReturn(INFO_VMINFO);
        when(extractor.getVmName()).thenReturn(INFO_VMNAME);
        when(extractor.getVmVersion()).thenReturn(INFO_VMVER);
    }
    
    @Test
    public void testNewVM() throws InterruptedException, MonitorException {
        startVMs();
        
        assertTrue(hostListener.getMonitoredVms().containsKey(1));
        assertTrue(hostListener.getMonitoredVms().containsKey(2));
        assertEquals(monitoredVm1, hostListener.getMonitoredVms().get(1));
        assertEquals(monitoredVm2, hostListener.getMonitoredVms().get(2));

        verify(notifier, times(2)).notifyVmStatusChange(eq(Status.VM_STARTED), (isA(Integer.class)));
    }
    
    @Test
    public void testStoppedVM() throws InterruptedException, MonitorException {
        final Set<Integer> stopped = new HashSet<>();
        stopped.add(1);
        
        startVMs();
        
        // Trigger a change event
        VmStatusChangeEvent event = mock(VmStatusChangeEvent.class);
        when(event.getMonitoredHost()).thenReturn(host);
        when(event.getStarted()).thenReturn(Collections.emptySet());
        when(event.getTerminated()).thenReturn(stopped);
        hostListener.vmStatusChanged(event);
        
        // Ensure only 1 removed
        assertFalse(hostListener.getMonitoredVms().containsKey(1));
        assertTrue(hostListener.getMonitoredVms().containsKey(2));
        assertEquals(monitoredVm2, hostListener.getMonitoredVms().get(2));

        verify(notifier).notifyVmStatusChange(eq(Status.VM_STOPPED), (isA(Integer.class)));

    }

    private void startVMs() throws InterruptedException, MonitorException {
        final Set<Integer> started = new HashSet<>();
        started.add(1);
        started.add(2);

        // Trigger a change event
        VmStatusChangeEvent event = mock(VmStatusChangeEvent.class);
        when(event.getMonitoredHost()).thenReturn(host);
        when(event.getStarted()).thenReturn(started);
        when(event.getTerminated()).thenReturn(Collections.emptySet());
        hostListener.vmStatusChanged(event);

        verify(notifier, times(2)).notifyVmStatusChange(eq(Status.VM_STARTED), isA(Integer.class));
    }

    @Test
    public void testRecordVmInfo() throws MonitorException {
        final int INFO_ID = 1;
        final long INFO_STARTTIME = Long.MIN_VALUE;
        final long INFO_STOPTIME = Long.MAX_VALUE;
        hostListener.recordVmInfo(INFO_ID, INFO_STARTTIME, INFO_STOPTIME, extractor);
        ArgumentCaptor<VmInfo> captor = ArgumentCaptor.forClass(VmInfo.class);
        verify(vmInfoDAO).putVmInfo(captor.capture());
        VmInfo info = captor.getValue();
        
        assertEquals(INFO_ID, info.getVmId());
        assertEquals(INFO_STARTTIME, info.getStartTimeStamp());
        assertEquals(INFO_STOPTIME, info.getStopTimeStamp());
        assertEquals(INFO_CMDLINE, info.getJavaCommandLine());
        assertEquals(INFO_JAVAHOME, info.getJavaHome());
        assertEquals(INFO_JAVAVER, info.getJavaVersion());
        assertEquals(INFO_MAINCLASS, info.getMainClass());
        assertEquals(INFO_VMARGS, info.getVmArguments());
        assertEquals(INFO_VMINFO, info.getVmInfo());
        assertEquals(INFO_VMNAME, info.getVmName());
        assertEquals(INFO_VMVER, info.getVmVersion());
    }
}