lttng: Unit tests for the UST callstack provider

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ust.core.tests / src / org / eclipse / linuxtools / lttng2 / ust / core / tests / trace / callstack / LttngUstCallStackProviderTest.java

/*******************************************************************************
 * Copyright (c) 2013 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Alexandre Montplaisir - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.lttng2.ust.core.tests.trace.callstack;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assume.assumeTrue;

import java.io.File;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.linuxtools.lttng2.ust.core.trace.LttngUstTrace;
import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfEvent;
import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateSystem;
import org.eclipse.linuxtools.tmf.core.tests.shared.CtfTmfTestTrace;
import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
import org.eclipse.linuxtools.tmf.core.trace.TmfTraceManager;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

/**
 * Test suite for the UST callstack state provider, using the trace of a program
 * instrumented with lttng-ust-cyg-profile.so tracepoints.
 *
 * @author Alexandre Montplaisir
 */
public class LttngUstCallStackProviderTest {

    // ------------------------------------------------------------------------
    // Attributes
    // ------------------------------------------------------------------------

    private static final CtfTmfTestTrace testTrace = CtfTmfTestTrace.CYG_PROFILE;
    private static final CtfTmfTestTrace otherUstTrace = CtfTmfTestTrace.HELLO_LOST;

    private static final String PROCNAME = "glxgears-16073";

    private static LttngUstTrace fixture = null;

    // ------------------------------------------------------------------------
    // Class  methods
    // ------------------------------------------------------------------------

    /**
     * Perform pre-class initialization.
     *
     * @throws TmfTraceException
     *             If the test trace is not found
     */
    @BeforeClass
    public static void setUp() throws TmfTraceException {
        assumeTrue(testTrace.exists());

        /* We init the trace ourselves (we need the specific LttngUstTrace type) */
        fixture = new LttngUstTrace();
        IStatus valid = fixture.validate(null, testTrace.getPath());
        assertTrue(valid.isOK());
        fixture.initTrace((IResource) null, testTrace.getPath(), CtfTmfEvent.class);
        TestUtils.openTrace(fixture);
    }

    /**
     * Perform post-class clean-up.
     */
    @AfterClass
    public static void tearDown() {
        if (fixture != null) {
            fixture.dispose();
            File suppDir = new File(TmfTraceManager.getSupplementaryFileDir(fixture));
            TestUtils.deleteDirectory(suppDir);
        }
    }

    // ------------------------------------------------------------------------
    // Test methods
    // ------------------------------------------------------------------------

    /**
     * Test the handling of generic UST traces who do not contain the required
     * information.
     */
    @Test
    public void testOtherUstTrace() {
        /* Initialize the trace */
        final LttngUstTrace ustTrace = new LttngUstTrace();
        IStatus valid = ustTrace.validate(null, otherUstTrace.getPath());
        assertTrue(valid.isOK());
        try {
            ustTrace.initTrace((IResource) null, otherUstTrace.getPath(), CtfTmfEvent.class);
        } catch (TmfTraceException e) {
            fail(e.getMessage());
        }
        TestUtils.openTrace(ustTrace);

        /* Make sure the generated state system exists, but is empty */
        ITmfStateSystem ss = ustTrace.getStateSystems().get(TestUtils.SSID);
        assertNotNull(ss);
        assertTrue(ss.getStartTime() >= ustTrace.getStartTime().normalize(0, ITmfTimestamp.NANOSECOND_SCALE).getValue());
        assertEquals(0, ss.getNbAttributes());

        /* Dispose the trace */
        ustTrace.dispose();
        File suppDir = new File(TmfTraceManager.getSupplementaryFileDir(ustTrace));
        TestUtils.deleteDirectory(suppDir);
        assertFalse(suppDir.exists());
    }

    /**
     * Test that the callstack state system is there and contains data.
     */
    @Test
    public void testConstruction() {
        ITmfStateSystem ss = fixture.getStateSystems().get(TestUtils.SSID);
        assertNotNull(ss);
        assertTrue(ss.getNbAttributes() > 0);
    }

    /**
     * Test the callstack at the beginning of the state system.
     */
    @Test
    public void testCallStackBegin() {
        long start = fixture.getStateSystems().get(TestUtils.SSID).getStartTime();
        String[] cs = TestUtils.getCallStack(fixture, PROCNAME, start);
        assertEquals(1, cs.length);

        assertEquals("0x40472b", cs[0]);
    }

    /**
     * Test the callstack somewhere in the trace.
     */
    @Test
    public void testCallStack1() {
        String[] cs = TestUtils.getCallStack(fixture, PROCNAME, 1378850463600000000L);
        assertEquals(2, cs.length);

        assertEquals("0x40472b", cs[0]);
        assertEquals("0x403d60", cs[1]);
    }

    /**
     * Test the callstack somewhere in the trace.
     */
    @Test
    public void testCallStack2() {
        String[] cs = TestUtils.getCallStack(fixture, PROCNAME, 1378850463770000000L);
        assertEquals(3, cs.length);

        assertEquals("0x40472b", cs[0]);
        assertEquals("0x403b14", cs[1]);
        assertEquals("0x401b23", cs[2]);
    }

    /**
     * Test the callstack somewhere in the trace.
     */
    @Test
    public void testCallStack3() {
        String[] cs = TestUtils.getCallStack(fixture, PROCNAME, 1378850463868753000L);
        assertEquals(4, cs.length);

        assertEquals("0x40472b", cs[0]);
        assertEquals("0x4045c8", cs[1]);
        assertEquals("0x403760", cs[2]);
        assertEquals("0x401aac", cs[3]);
    }

    /**
     * Test the callstack at the end of the trace/state system.
     */
    @Test
    public void testCallStackEnd() {
        long end = fixture.getStateSystems().get(TestUtils.SSID).getCurrentEndTime();
        String[] cs = TestUtils.getCallStack(fixture, PROCNAME, end);
        assertEquals(3, cs.length);

        assertEquals("0x40472b", cs[0]);
        assertEquals("0x4045c8", cs[1]);
        assertEquals("0x403760", cs[2]);
    }
}