view common/core/src/test/java/com/redhat/thermostat/common/dao/VmLatestPojoListGetterTest.java @ 613:4238b97fc746

Make DAOs stateless Maintaining state in DAOs feels unnatural. It also means DAOs can not be shared or published as OSGi instances. Every user of DAOs must get a unquie instance. Fix that by moving all relevant state (timestamps) out from the DAO into the code that uses the DAOs. DAOs still maintain some Pojo getters (as an optimization) but they are stateless too. Reviewed-by: neugens Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2012-September/003221.html
author Omair Majid <omajid@redhat.com>
date Fri, 14 Sep 2012 19:24:10 -0400
parents 430be1123985
children 9eed9fa986ad
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.common.dao;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.same;
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.util.List;

import org.junit.Before;
import org.junit.Test;

import com.redhat.thermostat.common.model.VmClassStat;
import com.redhat.thermostat.common.storage.Category;
import com.redhat.thermostat.common.storage.Cursor;
import com.redhat.thermostat.common.storage.Cursor.SortDirection;
import com.redhat.thermostat.common.storage.Key;
import com.redhat.thermostat.common.storage.Query;
import com.redhat.thermostat.common.storage.Query.Criteria;
import com.redhat.thermostat.common.storage.Storage;
import com.redhat.thermostat.test.MockQuery;

public class VmLatestPojoListGetterTest {
    private static final String AGENT_ID = "agentid";
    private static final String HOSTNAME = "host.example.com";
    private static final int VM_PID = 123;
    private static final String MAIN_CLASS = "Foo.class";
    private static final String CATEGORY_NAME = "vmcategory";
    // Make this one static so we don't get IllegalStateException from trying
    // to make category of same name while running tests in same classloader.
    private static final Category cat =  new Category(CATEGORY_NAME);

    private static long t1 = 1;
    private static long t2 = 5;
    private static long t3 = 10;

    private static long lc1 = 10;
    private static long lc2 = 20;
    private static long lc3 = 30;

    private HostRef hostRef;
    private VmRef vmRef;
    private VmClassStat result1, result2, result3;

    @Before
    public void setUp() {
        hostRef = new HostRef(AGENT_ID, HOSTNAME);
        vmRef = new VmRef(hostRef, VM_PID, MAIN_CLASS);
        result1 = new VmClassStat(VM_PID, t1, lc1);
        result2 = new VmClassStat(VM_PID, t2, lc2);
        result3 = new VmClassStat(VM_PID, t3, lc3);
    }

    @Test
    public void testBuildQuery() {
        Storage storage = mock(Storage.class);
        MockQuery query = new MockQuery();
        when(storage.createQuery()).thenReturn(query);

        VmLatestPojoListGetter<VmClassStat> getter = new VmLatestPojoListGetter<>(storage, cat, vmRef, VmClassStat.class);
        query = (MockQuery) getter.buildQuery(123l);

        assertNotNull(query);
        assertEquals(cat, query.getCategory());
        assertEquals(3, query.getWhereClausesCount());
        assertTrue(query.hasWhereClause(Key.AGENT_ID, Criteria.EQUALS, AGENT_ID));
        assertTrue(query.hasWhereClause(Key.VM_ID, Criteria.EQUALS, VM_PID));
        assertTrue(query.hasWhereClause(Key.TIMESTAMP, Criteria.GREATER_THAN, 123l));
    }

    @Test
    public void testBuildQueryPopulatesUpdateTimes() {
        Storage storage = mock(Storage.class);
        MockQuery ignored = new MockQuery();
        MockQuery query = new MockQuery();
        when(storage.createQuery()).thenReturn(ignored).thenReturn(query);

        VmLatestPojoListGetter<VmClassStat> getter = new VmLatestPojoListGetter<>(storage, cat, vmRef, VmClassStat.class);
        getter.buildQuery(Long.MIN_VALUE); // Ignore first return value.
        query = (MockQuery) getter.buildQuery(Long.MIN_VALUE);

        assertNotNull(query);
        assertEquals(cat, query.getCategory());
        assertEquals(3, query.getWhereClausesCount());
        assertTrue(query.hasWhereClauseFor(Key.AGENT_ID));
        assertTrue(query.hasWhereClauseFor(Key.VM_ID));
        assertTrue(query.hasWhereClause(Key.TIMESTAMP, Criteria.GREATER_THAN, Long.MIN_VALUE));
    }

    @Test
    public void testGetLatest() {
        @SuppressWarnings("unchecked")
        Cursor<VmClassStat> cursor = mock(Cursor.class);
        when(cursor.hasNext()).thenReturn(true).thenReturn(true).thenReturn(false);
        when(cursor.next()).thenReturn(result1).thenReturn(result2).thenReturn(null);
        when(cursor.sort(any(Key.class), any(SortDirection.class))).thenReturn(cursor);

        Storage storage = mock(Storage.class);
        MockQuery query = new MockQuery();
        when(storage.createQuery()).thenReturn(query);
        when(storage.findAllPojos(any(Query.class), same(VmClassStat.class))).thenReturn(cursor);

        VmLatestPojoListGetter<VmClassStat> getter = new VmLatestPojoListGetter<>(storage, cat, vmRef, VmClassStat.class);

        List<VmClassStat> stats = getter.getLatest(t2);

        verify(storage).findAllPojos(any(Query.class), same(VmClassStat.class));

        assertTrue(query.hasWhereClause(Key.AGENT_ID, Criteria.EQUALS, AGENT_ID));
        assertTrue(query.hasWhereClause(Key.VM_ID, Criteria.EQUALS, VM_PID));
        assertTrue(query.hasWhereClause(Key.TIMESTAMP, Criteria.GREATER_THAN, t2));

        assertNotNull(stats);
        assertEquals(2, stats.size());
        VmClassStat stat1 = stats.get(0);
        assertEquals(t1, stat1.getTimeStamp());
        assertEquals(lc1, stat1.getLoadedClasses());
        VmClassStat stat2 = stats.get(1);
        assertEquals(t2, stat2.getTimeStamp());
        assertEquals(lc2, stat2.getLoadedClasses());
    }

}