Always issues lttng stop before destroy

[deliverable/lttng-ivc.git] / lttng_ivc / tests / ust_python_agent_vs_tools / test_ust_python_agent_vs_tools.py

import pytest
import os
import shutil
import signal
import subprocess

import lttng_ivc.utils.ProjectFactory as ProjectFactory
import lttng_ivc.utils.utils as utils
import lttng_ivc.utils.runtime as Run
import lttng_ivc.settings as Settings

"""

FC: Fully Compatible
BC: Feature of the smallest version number will works.
TU: Tracing unavailable

Note: actual testing is limited by lttng-ust and lttng-tools abi/api.

+----------------------------------------------------------------------------------+
|             LTTng UST Python agent protocol vs LTTng session daemon              |
+--------------------------+------------+------------+------------+----------------+
| LTTng UST Java/ LTTng Tools  | 2.7 (1.0)  | 2.8 (2.0)  | 2.9 (2.0)  | 2.10 (2.0) |
+--------------------------+------------+------------+------------+----------------+
| 2.7                          | NA         | NA         | NA         | NA         |
| 2.8 (2.0)                    | TU         | FC         | BC         | BC         |
| 2.9 (2.0)                    | TU         | BC         | FC         | BC         |
| 2.10 (2.0)                   | TU         | BC         | BC         | FC         |
+--------------------------+------------+------------+------------+----------------+

"""

"""
First tuple member: lttng-ust label
Second tuple member: lttng-tool label
Thirdd tuple member: expected scenario
"""

test_matrix_tracing_available = [
    ("lttng-ust-2.7", "lttng-tools-2.7",   True),
    ("lttng-ust-2.7", "lttng-tools-2.8",   False),
    ("lttng-ust-2.7", "lttng-tools-2.9",   False),
    ("lttng-ust-2.7", "lttng-tools-2.10",  False),
    ("lttng-ust-2.8", "lttng-tools-2.7",   False),
    ("lttng-ust-2.8", "lttng-tools-2.8",   True),
    ("lttng-ust-2.8", "lttng-tools-2.9",   False),
    ("lttng-ust-2.8", "lttng-tools-2.10",  False),
    ("lttng-ust-2.9", "lttng-tools-2.7",   False),
    ("lttng-ust-2.9", "lttng-tools-2.8",   False),
    ("lttng-ust-2.9", "lttng-tools-2.9",   True),
    ("lttng-ust-2.9", "lttng-tools-2.10",  True),
    ("lttng-ust-2.10", "lttng-tools-2.7",  False),
    ("lttng-ust-2.10", "lttng-tools-2.8",  False),
    ("lttng-ust-2.10", "lttng-tools-2.9",  True),
    ("lttng-ust-2.10", "lttng-tools-2.10", True),
]

test_matrix_agent_interface = [
    ("lttng-ust-2.7", "lttng-tools-2.7",    "Success"),
    ("lttng-ust-2.7", "lttng-tools-2.8",    "Unsupported protocol"),
    ("lttng-ust-2.7", "lttng-tools-2.9",    "Unsupported protocol"),
    ("lttng-ust-2.7", "lttng-tools-2.10",   "Unsupported protocol"),
    ("lttng-ust-2.8", "lttng-tools-2.7",    "Unsupported protocol"),
    ("lttng-ust-2.8", "lttng-tools-2.8",    "Success"),
    ("lttng-ust-2.8", "lttng-tools-2.9",    "Success"),
    ("lttng-ust-2.8", "lttng-tools-2.10",   "Success"),
    ("lttng-ust-2.9", "lttng-tools-2.7",    "Unsupported protocol"),
    ("lttng-ust-2.9", "lttng-tools-2.8",    "Success"),
    ("lttng-ust-2.9", "lttng-tools-2.9",    "Success"),
    ("lttng-ust-2.9", "lttng-tools-2.10",   "Success"),
    ("lttng-ust-2.10", "lttng-tools-2.7",   "Unsupported protocol"),
    ("lttng-ust-2.10", "lttng-tools-2.8",   "Success"),
    ("lttng-ust-2.10", "lttng-tools-2.9",   "Success"),
    ("lttng-ust-2.10", "lttng-tools-2.10",  "Success"),
]

runtime_matrix_tracing_available = []
runtime_matrix_agent_interface = []

if not Settings.test_only:
    runtime_matrix_tracing_available = test_matrix_tracing_available
    runtime_matrix_agent_interface = test_matrix_agent_interface
else:
    for tup in test_matrix_tracing_available:
        if (tup[0] in Settings.test_only or tup[1] in
                Settings.test_only):
            runtime_matrix_tracing_available.append(tup)
    for tup in test_matrix_agent_interface:
        if (tup[0] in Settings.test_only or tup[1] in
                Settings.test_only):
            runtime_matrix_agent_interface.append(tup)


@pytest.mark.parametrize("ust_label,tools_label,should_trace", runtime_matrix_tracing_available)
def test_ust_python_agent_tracing_available(tmpdir, ust_label, tools_label, should_trace):

    nb_iter = 100
    nb_events = 5 * nb_iter

    # Prepare environment
    ust = ProjectFactory.get_precook(ust_label)
    tools = ProjectFactory.get_precook(tools_label)
    babeltrace = ProjectFactory.get_precook(Settings.default_babeltrace)

    tools_runtime_path = os.path.join(str(tmpdir), "tools")
    ust_runtime_path = os.path.join(str(tmpdir), "ust")
    app_path = os.path.join(str(tmpdir), "app")

    with Run.get_runtime(ust_runtime_path) as runtime_app, Run.get_runtime(tools_runtime_path) as runtime_tools:
        runtime_tools.add_project(tools)
        runtime_tools.add_project(babeltrace)

        runtime_app.add_project(ust)
        runtime_app.lttng_home = runtime_tools.lttng_home

        trace_path = os.path.join(runtime_tools.lttng_home, 'trace')

        # Copy the python app
        shutil.copytree(Settings.apps_python, app_path)

        # Start lttng-sessiond
        sessiond = utils.sessiond_spawn(runtime_tools)

        # Create session using mi to get path and session name
        runtime_tools.run('lttng create trace --output={}'.format(trace_path))

        runtime_tools.run('lttng enable-event -p pello')
        runtime_tools.run('lttng start')

        # Run application
        cmd = 'python app.py -i {}'.format(nb_iter)
        runtime_app.run(cmd, cwd=app_path)

        # Stop tracing
        runtime_tools.run('lttng stop')
        runtime_tools.run('lttng destroy -a')
        cp = runtime_tools.subprocess_terminate(sessiond)
        if cp.returncode != 0:
            pytest.fail("Sessiond return code")

        # Read trace with babeltrace and check for event count via number of line
        cmd = 'babeltrace {}'.format(trace_path)
        if should_trace:
            cp_process, cp_out, cp_err = runtime_tools.run(cmd)
            assert(utils.line_count(cp_out) == nb_events)
        else:
            with pytest.raises(subprocess.CalledProcessError):
                cp_process, cp_out, cp_err = runtime_tools.run(cmd)

@pytest.mark.parametrize("ust_label,tools_label,outcome", runtime_matrix_agent_interface)
def test_ust_python_agent_interface(tmpdir, ust_label, tools_label, outcome):
    """
    Use the agent coming from ust_label, but run app under tools_version runtime using ust agent.
    """

    nb_iter = 100
    nb_events = 5 * nb_iter

    # Prepare environment
    ust = ProjectFactory.get_precook(ust_label)
    tools = ProjectFactory.get_precook(tools_label)
    babeltrace = ProjectFactory.get_precook(Settings.default_babeltrace)

    tools_runtime_path = os.path.join(str(tmpdir), "tools")
    ust_runtime_path = os.path.join(str(tmpdir), "ust")
    app_path = os.path.join(str(tmpdir), "app")

    with Run.get_runtime(ust_runtime_path) as runtime_app, Run.get_runtime(tools_runtime_path) as runtime_tools:
        runtime_tools.add_project(tools)
        runtime_tools.add_project(babeltrace)

        runtime_app.add_project(ust)
        runtime_app.lttng_home = runtime_tools.lttng_home

        trace_path = os.path.join(runtime_tools.lttng_home, 'trace')

        # Make application using the ust runtime
        shutil.copytree(Settings.apps_python, app_path)

        # Start lttng-sessiond
        sessiond = utils.sessiond_spawn(runtime_tools)

        # Create session using mi to get path and session name
        runtime_tools.run('lttng create trace --output={}'.format(trace_path))

        runtime_tools.run('lttng enable-event -p pello')
        runtime_tools.run('lttng start')

        # Steal the PYTHONPATH from ust project and force it on the tools
        # project
        python_path = ust.special_env_variables['PYTHONPATH']
        tools.special_env_variables['PYTHONPATH'] = python_path

        # Run application with tools runtime
        cmd = 'python app.py -i {}'.format(nb_iter)
        runtime_tools.run(cmd, cwd=app_path)

        # Stop tracing
        runtime_tools.run('lttng stop')
        runtime_tools.run('lttng destroy -a')
        cp = runtime_tools.subprocess_terminate(sessiond)
        if cp.returncode != 0:
            pytest.fail("Sessiond return code")

        # Read trace with babeltrace and check for event count via number of line
        cmd = 'babeltrace {}'.format(trace_path)
        if outcome == "Success":
            assert(utils.file_contains(runtime_tools.get_subprocess_stderr_path(sessiond),["New registration for pid"]))
            cp_process, cp_out, cp_err = runtime_tools.run(cmd)
            assert(utils.line_count(cp_out) == nb_events)
        else:
            if outcome == "Unsupported protocol":
                assert(not(utils.file_contains(runtime_tools.get_subprocess_stderr_path(sessiond),["New registration for pid"])))
                cp_process, cp_out, cp_err = runtime_tools.run(cmd)
                assert(utils.line_count(cp_out) == 0)