Handle filter strings being passed by the sessiond

[lttng-ust-java-tests.git] / lttng-ust-java-tests / src / test / java / org / lttng / ust / agent / utils / LttngUtils.java

/*
 * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
 *
 * This program 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 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package org.lttng.ust.agent.utils;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;

import org.lttng.tools.ILttngSession;
import org.lttng.tools.ILttngSession.Domain;
import org.lttng.tools.utils.ShellUtils;
import org.lttng.ust.agent.jul.LttngLogHandler;
import org.lttng.ust.agent.log4j.LttngLogAppender;

/**
 * Utility methods to test the presence of certain LTTng tools or libraries in
 * the runtime environment.
 */
public final class LttngUtils {

    private LttngUtils() {}

    /**
     * Check the the JUL native library is available, effectively allowing LTTng
     * JUL handlers to be used.
     *
     * @return True if JUL works fine, false if it does not.
     */
    public static boolean checkForJulLibrary() {
        try {
            LttngLogHandler testHandler = new LttngLogHandler();
            testHandler.close();
        } catch (SecurityException | IOException e) {
            return false;
        }
        return true;
    }

    /**
     * Check the the Log4j native library is available, effectively allowing
     * LTTng Log4j appenders to be used.
     *
     * @return True if Log4j works fine, false if it does not.
     */
    public static boolean checkForLog4jLibrary() {
        try {
            LttngLogAppender testAppender = new LttngLogAppender();
            testAppender.close();
        } catch (SecurityException | IOException e) {
            return false;
        }
        return true;
    }

    /**
     * Check that lttng-tools and babeltrace are installed on the system and
     * working.
     *
     * @param domain
     *            The tracing domain to test for (we will try to setup a session
     *            with this domain)
     * @return True if the environment should allow tracing fine, false if there
     *         was an error
     */
    public static boolean checkForLttngTools(Domain domain) {
        try (ILttngSession session = ILttngSession.createSession(null, domain)) {
            boolean ret1 = session.enableAllEvents();
            boolean ret2 = session.start();
            boolean ret3 = session.stop();
            /*
             * "lttng view" also tests that Babeltrace is installed and working
             */
            List<String> contents = session.view();
            return (ret1 && ret2 && ret3 && contents.isEmpty());
        }
    }

    /**
     * Check if there is a user session daemon currently running on the system.
     * It needs to be of the same user as the application running this program.
     *
     * @return If there is a user session daemon currently running
     */
    public static boolean checkForUserSessiond() {
        String userName = System.getProperty("user.name");

        /* The user name is truncated to 7 characters in "ps" */
        String shortUserName = userName.substring(0, Math.min(userName.length(), 7));

        List<String> command = Arrays.asList("ps", "-e", "u");
        List<String> output = ShellUtils.getOutputFromCommand(false, command);
        return output.stream()
                .filter(s -> s.contains("lttng-sessiond"))
                .anyMatch(s -> s.startsWith(shortUserName));
    }

    /**
     * Check if there is a root user session daemon daemon currently running on
     * the system.
     *
     * @return If there is a root session daemon currently running
     */
    public static boolean checkForRootSessiond() {
        List<String> command = Arrays.asList("ps", "-e", "u");
        List<String> output = ShellUtils.getOutputFromCommand(false, command);
        return output.stream()
                .filter(s -> s.contains("lttng-sessiond"))
                .anyMatch(s -> s.startsWith("root"));
    }

}