Mercurial > hg > release > thermostat-0.13
view storage/core/src/test/java/com/redhat/thermostat/storage/internal/dao/VmInfoDAOTest.java @ 1176:f7961cf1e440
Convert VM IDs to UUIDs
This commit changes VM IDs used in VmRef and VmInfo to a randomly
generated UUID string. The VM PIDs are still stored, but are not used to
identify a specific VM. The motivation behind this change is that PIDs
can be reused by the OS, thus there is a chance we could have a PID that
refers to two different VMs (one alive, one dead). There are then
security implications if we return the wrong VM, which the client user
may not have access to. The VM's PID is still required when dealing with
external interfaces like /proc and JMX, but the data collected is placed
in storage using the VM's UUID.
Additionally, I have cleaned up the API in VmRef. I have removed
getIdString from VmRef since we already have a getStringID that does the
same thing. I've also changed VmRef.getAgent to getHostRef to more
accurately reflect what is returned.
Reviewed-by: jerboaa
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-July/007242.html
author | Elliott Baron <ebaron@redhat.com> |
---|---|
date | Thu, 18 Jul 2013 18:33:49 -0400 |
parents | d04860739261 |
children | b43db0f054d2 |
line wrap: on
line source
/* * Copyright 2012, 2013 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.storage.internal.dao; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; import static org.mockito.Matchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoMoreInteractions; import static org.mockito.Mockito.when; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import org.junit.Before; import org.junit.Test; import com.redhat.thermostat.storage.core.Category; import com.redhat.thermostat.storage.core.Cursor; import com.redhat.thermostat.storage.core.DescriptorParsingException; import com.redhat.thermostat.storage.core.HostRef; import com.redhat.thermostat.storage.core.Key; import com.redhat.thermostat.storage.core.PreparedStatement; import com.redhat.thermostat.storage.core.Replace; import com.redhat.thermostat.storage.core.StatementDescriptor; import com.redhat.thermostat.storage.core.StatementExecutionException; import com.redhat.thermostat.storage.core.Storage; import com.redhat.thermostat.storage.core.Update; import com.redhat.thermostat.storage.core.VmRef; import com.redhat.thermostat.storage.dao.DAOException; import com.redhat.thermostat.storage.dao.VmInfoDAO; import com.redhat.thermostat.storage.model.VmInfo; import com.redhat.thermostat.storage.query.ExpressionFactory; public class VmInfoDAOTest { private String vmId; private int vmPid; private long startTime; private long stopTime; private String jVersion; private String jHome; private String mainClass; private String commandLine; private String vmName; private String vmInfo; private String vmVersion; private String vmArgs; private Map<String, String> props; private Map<String, String> env; private String[] libs; private long uid; private String username; @Before public void setUp() { vmId = "vmId"; vmPid = 1; startTime = 2; stopTime = 3; jVersion = "java 1.0"; jHome = "/path/to/jdk/home"; mainClass = "Hello.class"; commandLine = "World"; vmArgs = "-XX=+FastestJITPossible"; vmName = "Hotspot"; vmInfo = "Some info"; vmVersion = "1.0"; props = new HashMap<>(); env = new HashMap<>(); libs = new String[0]; uid = 2000; username = "myUser"; } @Test public void preparedQueryDescriptorsAreSane() { String expectedVmInfo = "QUERY vm-info WHERE 'agentId' = ?s AND 'vmId' = ?s LIMIT 1"; assertEquals(expectedVmInfo, VmInfoDAOImpl.QUERY_VM_INFO); String expectedVmInfoAll = "QUERY vm-info WHERE 'agentId' = ?s"; assertEquals(expectedVmInfoAll, VmInfoDAOImpl.QUERY_ALL_VMS); } @Test public void testCategory() { assertEquals("vm-info", VmInfoDAO.vmInfoCategory.getName()); Collection<Key<?>> keys = VmInfoDAO.vmInfoCategory.getKeys(); assertTrue(keys.contains(new Key<>("agentId", true))); assertTrue(keys.contains(new Key<Integer>("vmId", true))); assertTrue(keys.contains(new Key<Integer>("vmPid", false))); assertTrue(keys.contains(new Key<String>("javaVersion", false))); assertTrue(keys.contains(new Key<String>("javaHome", false))); assertTrue(keys.contains(new Key<String>("mainClass", false))); assertTrue(keys.contains(new Key<String>("javaCommandLine", false))); assertTrue(keys.contains(new Key<String>("vmArguments", false))); assertTrue(keys.contains(new Key<String>("vmName", false))); assertTrue(keys.contains(new Key<String>("vmInfo", false))); assertTrue(keys.contains(new Key<String>("vmVersion", false))); assertTrue(keys.contains(new Key<Map<String, String>>("properties", false))); assertTrue(keys.contains(new Key<Map<String, String>>("environment", false))); assertTrue(keys.contains(new Key<List<String>>("loadedNativeLibraries", false))); assertTrue(keys.contains(new Key<Long>("startTimeStamp", false))); assertTrue(keys.contains(new Key<Long>("stopTimeStamp", false))); assertTrue(keys.contains(new Key<Long>("uid", false))); assertTrue(keys.contains(new Key<Long>("username", false))); assertEquals(18, keys.size()); } @Test public void testGetVmInfo() throws DescriptorParsingException, StatementExecutionException { Storage storage = mock(Storage.class); @SuppressWarnings("unchecked") PreparedStatement<VmInfo> stmt = (PreparedStatement<VmInfo>) mock(PreparedStatement.class); when(storage.prepareStatement(anyDescriptor())).thenReturn(stmt); VmInfo expected = new VmInfo(vmId, vmPid, startTime, stopTime, jVersion, jHome, mainClass, commandLine, vmName, vmInfo, vmVersion, vmArgs, props, env, libs, uid, username); @SuppressWarnings("unchecked") Cursor<VmInfo> cursor = (Cursor<VmInfo>) mock(Cursor.class); when(cursor.hasNext()).thenReturn(true).thenReturn(false); when(cursor.next()).thenReturn(expected).thenReturn(null); when(stmt.executeQuery()).thenReturn(cursor); HostRef hostRef = mock(HostRef.class); when(hostRef.getAgentId()).thenReturn("system"); VmRef vmRef = mock(VmRef.class); when(vmRef.getHostRef()).thenReturn(hostRef); when(vmRef.getVmId()).thenReturn("vmId"); VmInfoDAO dao = new VmInfoDAOImpl(storage); VmInfo info = dao.getVmInfo(vmRef); assertEquals(expected, info); verify(storage).prepareStatement(anyDescriptor()); verify(stmt).setString(0, "system"); verify(stmt).setString(1, "vmId"); verify(stmt).executeQuery(); } @SuppressWarnings("unchecked") private StatementDescriptor<VmInfo> anyDescriptor() { return (StatementDescriptor<VmInfo>) any(StatementDescriptor.class); } @Test public void testGetVmInfoUnknownVM() throws DescriptorParsingException, StatementExecutionException { Storage storage = mock(Storage.class); @SuppressWarnings("unchecked") PreparedStatement<VmInfo> stmt = (PreparedStatement<VmInfo>) mock(PreparedStatement.class); when(storage.prepareStatement(anyDescriptor())).thenReturn(stmt); @SuppressWarnings("unchecked") Cursor<VmInfo> cursor = (Cursor<VmInfo>) mock(Cursor.class); when(stmt.executeQuery()).thenReturn(cursor); HostRef hostRef = mock(HostRef.class); when(hostRef.getAgentId()).thenReturn("system"); VmRef vmRef = mock(VmRef.class); when(vmRef.getVmId()).thenReturn("noVm"); when(vmRef.getHostRef()).thenReturn(hostRef); VmInfoDAO dao = new VmInfoDAOImpl(storage); try { dao.getVmInfo(vmRef); fail(); } catch (DAOException ex) { assertEquals("Unknown VM: host:system;vm:noVm", ex.getMessage()); } verify(storage).prepareStatement(anyDescriptor()); verify(stmt).setString(0, "system"); verify(stmt).setString(1, "noVm"); verify(stmt).executeQuery(); } @Test public void testSingleVM() throws DescriptorParsingException, StatementExecutionException { Storage storage = setupStorageForSingleVM(); VmInfoDAO dao = new VmInfoDAOImpl(storage); HostRef host = new HostRef("123", "fluffhost"); Collection<VmRef> vms = dao.getVMs(host); assertCollection(vms, new VmRef(host, "vmId", 123, "mainClass1")); } private Storage setupStorageForSingleVM() throws DescriptorParsingException, StatementExecutionException { VmInfo vm1 = new VmInfo(); vm1.setVmId("vmId"); vm1.setVmPid(123); vm1.setMainClass("mainClass1"); @SuppressWarnings("unchecked") Cursor<VmInfo> singleVMCursor = (Cursor<VmInfo>) mock(Cursor.class); when(singleVMCursor.hasNext()).thenReturn(true).thenReturn(false); when(singleVMCursor.next()).thenReturn(vm1); Storage storage = mock(Storage.class); @SuppressWarnings("unchecked") PreparedStatement<VmInfo> stmt = (PreparedStatement<VmInfo>) mock(PreparedStatement.class); when(storage.prepareStatement(anyDescriptor())).thenReturn(stmt); when(stmt.executeQuery()).thenReturn(singleVMCursor); return storage; } @Test public void testMultiVMs() throws DescriptorParsingException, StatementExecutionException { Storage storage = setupStorageForMultiVM(); VmInfoDAO dao = new VmInfoDAOImpl(storage); HostRef host = new HostRef("456", "fluffhost"); Collection<VmRef> vms = dao.getVMs(host); assertCollection(vms, new VmRef(host, "vmId1", 123, "mainClass1"), new VmRef(host, "vmId2", 456, "mainClass2")); } private Storage setupStorageForMultiVM() throws DescriptorParsingException, StatementExecutionException { VmInfo vm1 = new VmInfo(); vm1.setVmId("vmId1"); vm1.setVmPid(123); vm1.setMainClass("mainClass1"); VmInfo vm2 = new VmInfo(); vm2.setVmId("vmId2"); vm2.setVmPid(456); vm2.setMainClass("mainClass2"); @SuppressWarnings("unchecked") Cursor<VmInfo> multiVMsCursor = mock(Cursor.class); when(multiVMsCursor.hasNext()).thenReturn(true).thenReturn(true).thenReturn(false); when(multiVMsCursor.next()).thenReturn(vm1).thenReturn(vm2); Storage storage = mock(Storage.class); @SuppressWarnings("unchecked") PreparedStatement<VmInfo> stmt = (PreparedStatement<VmInfo>) mock(PreparedStatement.class); when(storage.prepareStatement(anyDescriptor())).thenReturn(stmt); when(stmt.executeQuery()).thenReturn(multiVMsCursor); return storage; } private void assertCollection(Collection<VmRef> vms, VmRef... expectedVMs) { assertEquals(expectedVMs.length, vms.size()); for (VmRef expectedVM : expectedVMs) { assertTrue(vms.contains(expectedVM)); } } @Test public void testGetCount() { Storage storage = mock(Storage.class); when(storage.getCount(any(Category.class))).thenReturn(5L); VmInfoDAO dao = new VmInfoDAOImpl(storage); Long count = dao.getCount(); assertEquals((Long) 5L, count); } @Test public void testPutVmInfo() { Storage storage = mock(Storage.class); Replace replace = mock(Replace.class); when(storage.createReplace(any(Category.class))).thenReturn(replace); VmInfo info = new VmInfo(vmId, vmPid, startTime, stopTime, jVersion, jHome, mainClass, commandLine, vmName, vmInfo, vmVersion, vmArgs, props, env, libs, uid, username); VmInfoDAO dao = new VmInfoDAOImpl(storage); dao.putVmInfo(info); verify(storage).createReplace(VmInfoDAO.vmInfoCategory); verify(replace).setPojo(info); verify(replace).apply(); } @Test public void testPutVmStoppedTime() { Update mockUpdate = mock(Update.class); Storage storage = mock(Storage.class); when(storage.createUpdate(any(Category.class))).thenReturn(mockUpdate); VmInfoDAO dao = new VmInfoDAOImpl(storage); dao.putVmStoppedTime(vmId, stopTime); verify(storage).createUpdate(VmInfoDAO.vmInfoCategory); ExpressionFactory factory = new ExpressionFactory(); verify(mockUpdate).where(factory.equalTo(Key.VM_ID, "vmId")); verify(mockUpdate).set(VmInfoDAO.stopTimeKey, 3L); verify(mockUpdate).apply(); verifyNoMoreInteractions(mockUpdate); } }