2 * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 package org
.lttng
.ust
.agent
.utils
;
21 import java
.io
.IOException
;
22 import java
.lang
.ProcessBuilder
.Redirect
;
23 import java
.nio
.file
.Files
;
24 import java
.nio
.file
.Path
;
25 import java
.util
.Arrays
;
26 import java
.util
.List
;
27 import java
.util
.StringJoiner
;
29 import org
.lttng
.ust
.agent
.jul
.LttngLogHandler
;
30 import org
.lttng
.ust
.agent
.log4j
.LttngLogAppender
;
31 import org
.lttng
.ust
.agent
.utils
.LttngSession
.Domain
;
34 * Utility methods to help with UST-Java tests
36 public final class MiscTestUtils
{
38 private MiscTestUtils() {}
41 * Check the the JUL native library is available, effectively allowing LTTng
42 * JUL handlers to be used.
44 * @return True if JUL works fine, false if it does not.
46 public static boolean checkForJulLibrary() {
48 LttngLogHandler testHandler
= new LttngLogHandler();
50 } catch (SecurityException
| IOException e
) {
57 * Check the the Log4j native library is available, effectively allowing
58 * LTTng Log4j appenders to be used.
60 * @return True if Log4j works fine, false if it does not.
62 public static boolean checkForLog4jLibrary() {
64 LttngLogAppender testAppender
= new LttngLogAppender();
66 } catch (SecurityException
| IOException e
) {
73 * Check that lttng-tools and babeltrace are installed on the system and
77 * The tracing domain to test for (we will try to setup a session
79 * @return True if the environment should allow tracing fine, false if there
82 public static boolean checkForLttngTools(Domain domain
) {
83 try (LttngSession session
= new LttngSession(null, domain
)) {
84 boolean ret1
= session
.enableAllEvents();
85 boolean ret2
= session
.start();
86 boolean ret3
= session
.stop();
88 * "lttng view" also tests that Babeltrace is installed and working
90 List
<String
> contents
= session
.view();
91 return (ret1
&& ret2
&& ret3
&& contents
.isEmpty());
96 * Check if there is a user session daemon currently running on the system.
97 * It needs to be of the same user as the application running this program.
99 * @return If there is a user session daemon currently running
101 public static boolean checkForUserSessiond() {
102 String userName
= System
.getProperty("user.name");
104 /* The user name is truncated to 7 characters in "ps" */
105 String shortUserName
= userName
.substring(0, Math
.min(userName
.length(), 7));
107 List
<String
> command
= Arrays
.asList("ps", "-e", "u");
108 List
<String
> output
= getOutputFromCommand(false, command
);
109 return output
.stream()
110 .filter(s
-> s
.contains("lttng-sessiond"))
111 .anyMatch(s
-> s
.startsWith(shortUserName
));
115 * Check if there is a root user session daemon daemon currently running on
118 * @return If there is a root session daemon currently running
120 public static boolean checkForRootSessiond() {
121 List
<String
> command
= Arrays
.asList("ps", "-e", "u");
122 List
<String
> output
= getOutputFromCommand(false, command
);
123 return output
.stream()
124 .filter(s
-> s
.contains("lttng-sessiond"))
125 .anyMatch(s
-> s
.startsWith("root"));
129 static List
<String
> getOutputFromCommand(List
<String
> command
) {
130 return MiscTestUtils
.getOutputFromCommand(true, command
);
133 static List
<String
> getOutputFromCommand(boolean print
, List
<String
> command
) {
135 /* "echo" the command to stdout */
136 StringJoiner sj
= new StringJoiner(" ", "$ ", "");
137 command
.stream().forEach(sj
::add
);
138 System
.out
.println(sj
.toString());
140 Path tempFile
= Files
.createTempFile("test-output", null);
142 ProcessBuilder builder
= new ProcessBuilder(command
);
143 builder
.redirectErrorStream(true);
144 builder
.redirectOutput(Redirect
.to(tempFile
.toFile()));
146 Process p
= builder
.start();
149 List
<String
> lines
= Files
.readAllLines(tempFile
);
150 Files
.delete(tempFile
);
153 /* Also print the output to the console */
154 lines
.stream().forEach(System
.out
::println
);
156 System
.out
.println("(output silenced)");
159 System
.out
.println("(returned from command)");
162 } catch (IOException
| InterruptedException e
) {