From 45d1768cc5aa27806687d5378b4091dbef125e57 Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Wed, 29 Jul 2015 20:19:28 -0400 Subject: [PATCH] Move the "LTTng control" to separate packages This could move to its own project eventually? Signed-off-by: Alexandre Montplaisir --- .settings/org.eclipse.jdt.ui.prefs | 59 +++++ .../java/org/lttng/tools/ILttngSession.java | 133 ++++++++++ .../lttng/tools/LttngCommandLineSession.java | 125 ++++++++++ .../org/lttng/tools/LttngToolsHelper.java | 90 +++++++ .../utils/LttngUtils.java} | 14 +- .../agent => tools}/utils/ShellUtils.java | 2 +- ...tngJulHandlerTracingDisabledBenchmark.java | 8 +- ...ttngJulHandlerTracingEnabledBenchmark.java | 8 +- ...tngJulHandlerTracingDisabledBenchmark.java | 8 +- ...ttngJulHandlerTracingEnabledBenchmark.java | 8 +- .../integration/EnabledEventsTestBase.java | 8 +- .../integration/MultiSessionTestBase.java | 16 +- .../integration/jul/JulEnabledEventsTest.java | 14 +- .../integration/jul/JulLegacyApiTest.java | 19 +- .../integration/jul/JulMultiSessionTest.java | 14 +- .../log4j/Log4jEnabledEventsTest.java | 14 +- .../integration/log4j/Log4jLegacyApiTest.java | 19 +- .../log4j/Log4jMultiSessionTest.java | 14 +- .../lttng/ust/agent/utils/LttngSession.java | 235 ------------------ 19 files changed, 492 insertions(+), 316 deletions(-) create mode 100644 src/test/java/org/lttng/tools/ILttngSession.java create mode 100644 src/test/java/org/lttng/tools/LttngCommandLineSession.java create mode 100644 src/test/java/org/lttng/tools/LttngToolsHelper.java rename src/test/java/org/lttng/{ust/agent/utils/MiscTestUtils.java => tools/utils/LttngUtils.java} (91%) rename src/test/java/org/lttng/{ust/agent => tools}/utils/ShellUtils.java (99%) delete mode 100644 src/test/java/org/lttng/ust/agent/utils/LttngSession.java diff --git a/.settings/org.eclipse.jdt.ui.prefs b/.settings/org.eclipse.jdt.ui.prefs index 090a296..b883c15 100644 --- a/.settings/org.eclipse.jdt.ui.prefs +++ b/.settings/org.eclipse.jdt.ui.prefs @@ -1,3 +1,62 @@ eclipse.preferences.version=1 +editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true formatter_profile=_Spaces formatter_settings_version=12 +sp_cleanup.add_default_serial_version_id=true +sp_cleanup.add_generated_serial_version_id=false +sp_cleanup.add_missing_annotations=false +sp_cleanup.add_missing_deprecated_annotations=true +sp_cleanup.add_missing_methods=false +sp_cleanup.add_missing_nls_tags=false +sp_cleanup.add_missing_override_annotations=true +sp_cleanup.add_missing_override_annotations_interface_methods=true +sp_cleanup.add_serial_version_id=false +sp_cleanup.always_use_blocks=true +sp_cleanup.always_use_parentheses_in_expressions=false +sp_cleanup.always_use_this_for_non_static_field_access=false +sp_cleanup.always_use_this_for_non_static_method_access=false +sp_cleanup.convert_functional_interfaces=false +sp_cleanup.convert_to_enhanced_for_loop=false +sp_cleanup.correct_indentation=false +sp_cleanup.format_source_code=false +sp_cleanup.format_source_code_changes_only=false +sp_cleanup.insert_inferred_type_arguments=false +sp_cleanup.make_local_variable_final=true +sp_cleanup.make_parameters_final=false +sp_cleanup.make_private_fields_final=true +sp_cleanup.make_type_abstract_if_missing_method=false +sp_cleanup.make_variable_declarations_final=false +sp_cleanup.never_use_blocks=false +sp_cleanup.never_use_parentheses_in_expressions=true +sp_cleanup.on_save_use_additional_actions=true +sp_cleanup.organize_imports=false +sp_cleanup.qualify_static_field_accesses_with_declaring_class=false +sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true +sp_cleanup.qualify_static_member_accesses_with_declaring_class=false +sp_cleanup.qualify_static_method_accesses_with_declaring_class=false +sp_cleanup.remove_private_constructors=true +sp_cleanup.remove_redundant_type_arguments=true +sp_cleanup.remove_trailing_whitespaces=true +sp_cleanup.remove_trailing_whitespaces_all=true +sp_cleanup.remove_trailing_whitespaces_ignore_empty=false +sp_cleanup.remove_unnecessary_casts=false +sp_cleanup.remove_unnecessary_nls_tags=false +sp_cleanup.remove_unused_imports=false +sp_cleanup.remove_unused_local_variables=false +sp_cleanup.remove_unused_private_fields=true +sp_cleanup.remove_unused_private_members=false +sp_cleanup.remove_unused_private_methods=true +sp_cleanup.remove_unused_private_types=true +sp_cleanup.sort_members=false +sp_cleanup.sort_members_all=false +sp_cleanup.use_anonymous_class_creation=false +sp_cleanup.use_blocks=false +sp_cleanup.use_blocks_only_for_return_and_throw=false +sp_cleanup.use_lambda=true +sp_cleanup.use_parentheses_in_expressions=false +sp_cleanup.use_this_for_non_static_field_access=false +sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=true +sp_cleanup.use_this_for_non_static_method_access=false +sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true +sp_cleanup.use_type_arguments=false diff --git a/src/test/java/org/lttng/tools/ILttngSession.java b/src/test/java/org/lttng/tools/ILttngSession.java new file mode 100644 index 0000000..c8b532c --- /dev/null +++ b/src/test/java/org/lttng/tools/ILttngSession.java @@ -0,0 +1,133 @@ +/* + * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir + * + * 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.tools; + +import java.util.List; + +/** + * Java representation of a LTTng tracing session. + * + * @author Alexandre Montplaisir + */ +public interface ILttngSession extends AutoCloseable { + + /** + * Tracing domains as they are defined by lttng-tools + */ + enum Domain { + /** The JUL (java.util.logging) domain */ + JUL("-j"), /** The log4j (org.apache.log4j) domain */ + LOG4J("-l"); + + private final String flag; + + private Domain(String flag) { + this.flag = flag; + } + + /** + * @return The corresponding command-line flag to pass to options like + * "lttng enable-event" + */ + public String flag() { + return flag; + } + } + + // ------------------------------------------------------------------------ + // Factory methods + // ------------------------------------------------------------------------ + + /** + * Constructor to create a new LTTng tracing session, which will use the + * command-line "lttng" utility. + * + * @param sessionName + * The name of the session to use. It can be null, in which case + * we will provide a unique random name. + * @param domain + * The tracing domain of this session + * @return The new session object + */ + static ILttngSession newCommandLineSession(String sessionName, Domain domain) { + return new LttngCommandLineSession(sessionName, domain); + } + + // ------------------------------------------------------------------------ + // AutoCloseable + // ------------------------------------------------------------------------ + + /** + * Should be used to destroy the LTTng session. + */ + @Override + void close(); + + // ------------------------------------------------------------------------ + // Session management + // ------------------------------------------------------------------------ + + /** + * Enable all events in the session (as with "enable-event -a"). + * + * @return If the command executed successfully (return code = 0). + */ + boolean enableAllEvents(); + + /** + * Enable individual event(s). + * + * @param enabledEvents + * The list of events to enable. Should not be null or empty + * @return If the command executed successfully (return code = 0). + */ + boolean enableEvents(String... enabledEvents); + + /** + * Send a disable-event command. Used to disable events that were previously + * enabled. + * + * @param disabledEvents + * The list of disabled events. Should not be null or empty + * @return If the command executed successfully (return code = 0). + */ + boolean disableEvents(String... disabledEvents); + + /** + * Start tracing + * + * @return If the command executed successfully (return code = 0). + */ + boolean start(); + + /** + * Stop the tracing session + * + * @return If the command executed successfully (return code = 0). + */ + boolean stop(); + + /** + * Issue a "lttng view" command on the session, and returns its output. This + * effectively returns the current content of the trace in text form. + * + * @return The output of Babeltrace on the session's current trace + */ + List view(); +} diff --git a/src/test/java/org/lttng/tools/LttngCommandLineSession.java b/src/test/java/org/lttng/tools/LttngCommandLineSession.java new file mode 100644 index 0000000..0cd26cc --- /dev/null +++ b/src/test/java/org/lttng/tools/LttngCommandLineSession.java @@ -0,0 +1,125 @@ +/* + * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir + * + * 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.tools; + +import static org.lttng.tools.utils.ShellUtils.executeCommand; + +import java.util.Arrays; +import java.util.List; +import java.util.UUID; +import java.util.stream.Collectors; + +import org.lttng.tools.utils.ShellUtils; + +/** + * Implementation of {@link ILttngSession} which uses the command-line "lttng" + * tool to manipulate the session. Creating an instance will run "lttng create", + * close()'ing it will run "lttng destroy". + * + * @author Alexandre Montplaisir + */ +class LttngCommandLineSession implements ILttngSession { + + private final String sessionName; + private final Domain domain; + + private volatile boolean channelCreated = false; + + /** + * Constructor to create a new LTTng tracing session. + * + * @param sessionName + * The name of the session to use. It can be null, in which case + * we will provide a unique random name. + * @param domain + * The tracing domain of this session + */ + public LttngCommandLineSession(String sessionName, Domain domain) { + if (sessionName != null) { + this.sessionName = sessionName; + } else { + this.sessionName = UUID.randomUUID().toString(); + } + this.domain = domain; + + /* Create the session in LTTng */ + executeCommand(Arrays.asList("lttng", "create", this.sessionName)); + } + + @Override + public void close() { + /* Destroy the session */ + executeCommand(Arrays.asList("lttng", "destroy", sessionName)); + // FIXME also delete the trace we generated ? + } + + @Override + public boolean enableAllEvents() { + channelCreated = true; + return executeCommand(Arrays.asList( + "lttng", "enable-event", domain.flag(), "-a", "-s", sessionName)); + } + + @Override + public boolean enableEvents(String... enabledEvents) { + if (enabledEvents == null || enabledEvents.length == 0) { + throw new IllegalArgumentException(); + } + channelCreated = true; + return executeCommand(Arrays.asList( + "lttng", "enable-event", domain.flag(), + Arrays.stream(enabledEvents).collect(Collectors.joining(",")), + "-s", sessionName)); + } + + @Override + public boolean disableEvents(String... disabledEvents) { + if (disabledEvents == null || disabledEvents.length == 0) { + throw new IllegalArgumentException(); + } + return executeCommand(Arrays.asList( + "lttng", "disable-event", domain.flag(), + Arrays.stream(disabledEvents).collect(Collectors.joining(",")), + "-s", sessionName)); + } + + @Override + public boolean start() { + /* + * We have to enable a channel for 'lttng start' to work. However, we + * cannot enable a channel directly, see + * https://bugs.lttng.org/issues/894 . Instead we will enable an event + * we know does not exist + */ + if (!channelCreated) { + enableEvents("non-event"); + } + return executeCommand(Arrays.asList("lttng", "start", sessionName)); + } + + @Override + public boolean stop() { + return executeCommand(Arrays.asList("lttng", "stop", sessionName)); + } + + @Override + public List view() { + return ShellUtils.getOutputFromCommand(true, Arrays.asList("lttng", "view", sessionName)); + } +} diff --git a/src/test/java/org/lttng/tools/LttngToolsHelper.java b/src/test/java/org/lttng/tools/LttngToolsHelper.java new file mode 100644 index 0000000..a38661e --- /dev/null +++ b/src/test/java/org/lttng/tools/LttngToolsHelper.java @@ -0,0 +1,90 @@ +/* + * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir + * + * 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.tools; + +import static org.lttng.tools.utils.ShellUtils.executeCommand; + +import java.io.IOException; +import java.nio.file.FileVisitResult; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.Arrays; + +/** + * Helper class to issue LTTng commands that do not affect a single session, and + * as such, do not fit into the scope of one {@link ILttngSession}. + * + * @author Alexandre Montplaisir + */ +public final class LttngToolsHelper { + + private LttngToolsHelper() {} + + /** + * Utility method to destroy all existing sessions. Useful when first + * setting up a test to make sure no existing session interferes. + * + * @return If the command completed successfully + */ + public static boolean destroyAllSessions() { + return executeCommand(Arrays.asList("lttng", "destroy", "-a")); + } + + /** + * Outside of the scope of lttng-tools, but this utility method can be used + * to delete all traces currently under ~/lttng-traces/. This can be used by + * tests to cleanup a trace they have created. + * + * @return True if the command completes successfully, false if there was an + * error. + */ + public static boolean deleteAllTraces() { + String tracesDir = new String(System.getProperty("user.home") + "/lttng-traces/"); + return deleteDirectory(Paths.get(tracesDir)); + } + + // ------------------------------------------------------------------------ + // Private helper methods + // ------------------------------------------------------------------------ + + private static boolean deleteDirectory(Path directory) { + try { + Files.walkFileTree(directory, new SimpleFileVisitor() { + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + Files.delete(file); + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { + Files.delete(dir); + return FileVisitResult.CONTINUE; + } + }); + } catch (IOException e) { + /* At least we tried... */ + return false; + } + return true; + } +} diff --git a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java b/src/test/java/org/lttng/tools/utils/LttngUtils.java similarity index 91% rename from src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java rename to src/test/java/org/lttng/tools/utils/LttngUtils.java index cfd4a8e..3c1a83f 100644 --- a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java +++ b/src/test/java/org/lttng/tools/utils/LttngUtils.java @@ -16,22 +16,24 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -package org.lttng.ust.agent.utils; +package org.lttng.tools.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.ust.agent.jul.LttngLogHandler; import org.lttng.ust.agent.log4j.LttngLogAppender; -import org.lttng.ust.agent.utils.LttngSession.Domain; /** - * Utility methods to help with UST-Java tests + * Utility methods to test the presence of certain LTTng tools or libraries in + * the runtime environment. */ -public final class MiscTestUtils { +public final class LttngUtils { - private MiscTestUtils() {} + private LttngUtils() {} /** * Check the the JUL native library is available, effectively allowing LTTng @@ -76,7 +78,7 @@ public final class MiscTestUtils { * was an error */ public static boolean checkForLttngTools(Domain domain) { - try (LttngSession session = new LttngSession(null, domain)) { + try (ILttngSession session = ILttngSession.newCommandLineSession(null, domain)) { boolean ret1 = session.enableAllEvents(); boolean ret2 = session.start(); boolean ret3 = session.stop(); diff --git a/src/test/java/org/lttng/ust/agent/utils/ShellUtils.java b/src/test/java/org/lttng/tools/utils/ShellUtils.java similarity index 99% rename from src/test/java/org/lttng/ust/agent/utils/ShellUtils.java rename to src/test/java/org/lttng/tools/utils/ShellUtils.java index 48c7fd5..eb94c20 100644 --- a/src/test/java/org/lttng/ust/agent/utils/ShellUtils.java +++ b/src/test/java/org/lttng/tools/utils/ShellUtils.java @@ -16,7 +16,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -package org.lttng.ust.agent.utils; +package org.lttng.tools.utils; import java.io.IOException; import java.lang.ProcessBuilder.Redirect; diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingDisabledBenchmark.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingDisabledBenchmark.java index 3ba6291..23ab1ee 100644 --- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingDisabledBenchmark.java +++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingDisabledBenchmark.java @@ -24,10 +24,10 @@ import java.io.IOException; import org.junit.After; import org.junit.Before; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.benchmarks.jul.handler.JulHandlerBenchmarkBase; import org.lttng.ust.agent.jul.LttngLogHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; /** * Benchmark the LTTng-JUL handler, but with tracing disabled in the tracing @@ -35,7 +35,7 @@ import org.lttng.ust.agent.utils.LttngSession.Domain; */ public class LttngJulHandlerTracingDisabledBenchmark extends JulHandlerBenchmarkBase { - private LttngSession session; + private ILttngSession session; /** * Test setup @@ -46,7 +46,7 @@ public class LttngJulHandlerTracingDisabledBenchmark extends JulHandlerBenchmark public void testSetup() throws IOException { handler = new LttngLogHandler(); - session = new LttngSession(null, Domain.JUL); + session = ILttngSession.newCommandLineSession(null, Domain.JUL); assertTrue(session.enableEvents("non-event")); assertTrue(session.start()); } diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingEnabledBenchmark.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingEnabledBenchmark.java index 4a150b6..8e4c37d 100644 --- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingEnabledBenchmark.java +++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/LttngJulHandlerTracingEnabledBenchmark.java @@ -24,17 +24,17 @@ import java.io.IOException; import org.junit.After; import org.junit.Before; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.benchmarks.jul.handler.JulHandlerBenchmarkBase; import org.lttng.ust.agent.jul.LttngLogHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; /** * Test the LTTng-JUL handler, with it actually sending events to the tracer. */ public class LttngJulHandlerTracingEnabledBenchmark extends JulHandlerBenchmarkBase { - private LttngSession session; + private ILttngSession session; /** * Test setup @@ -45,7 +45,7 @@ public class LttngJulHandlerTracingEnabledBenchmark extends JulHandlerBenchmarkB public void testSetup() throws IOException { handler = new LttngLogHandler(); - session = new LttngSession(null, Domain.JUL); + session = ILttngSession.newCommandLineSession(null, Domain.JUL); assertTrue(session.enableAllEvents()); assertTrue(session.start()); } diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingDisabledBenchmark.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingDisabledBenchmark.java index 15628f0..a3a5c41 100644 --- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingDisabledBenchmark.java +++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingDisabledBenchmark.java @@ -22,10 +22,10 @@ import static org.junit.Assert.assertTrue; import org.junit.After; import org.junit.Before; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.LTTngAgent; import org.lttng.ust.agent.benchmarks.jul.handler.JulHandlerBenchmarkBase; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; /** * Benchmark for the LTTng-UST handler, using the legacy API. Tracing is @@ -34,7 +34,7 @@ import org.lttng.ust.agent.utils.LttngSession.Domain; @SuppressWarnings("deprecation") public class OldLttngJulHandlerTracingDisabledBenchmark extends JulHandlerBenchmarkBase { - private LttngSession session; + private ILttngSession session; /** * Test setup @@ -43,7 +43,7 @@ public class OldLttngJulHandlerTracingDisabledBenchmark extends JulHandlerBenchm public void testSetup() { LTTngAgent.getLTTngAgent(); - session = new LttngSession(null, Domain.JUL); + session = ILttngSession.newCommandLineSession(null, Domain.JUL); assertTrue(session.enableEvents("non-event")); assertTrue(session.start()); } diff --git a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingEnabledBenchmark.java b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingEnabledBenchmark.java index 018190d..23c6c95 100644 --- a/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingEnabledBenchmark.java +++ b/src/test/java/org/lttng/ust/agent/benchmarks/jul/handler/lttng/old/OldLttngJulHandlerTracingEnabledBenchmark.java @@ -25,11 +25,11 @@ import java.lang.reflect.Field; import org.junit.After; import org.junit.Before; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.LTTngAgent; import org.lttng.ust.agent.benchmarks.jul.handler.JulHandlerBenchmarkBase; import org.lttng.ust.agent.jul.LttngLogHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; /** * Benchmark for the LTTng-UST handler, using the legacy API. Tracing is @@ -38,7 +38,7 @@ import org.lttng.ust.agent.utils.LttngSession.Domain; @SuppressWarnings("deprecation") public class OldLttngJulHandlerTracingEnabledBenchmark extends JulHandlerBenchmarkBase { - private LttngSession session; + private ILttngSession session; private LttngLogHandler agentHandler; @@ -69,7 +69,7 @@ public class OldLttngJulHandlerTracingEnabledBenchmark extends JulHandlerBenchma fail(); } - session = new LttngSession(null, Domain.JUL); + session = ILttngSession.newCommandLineSession(null, Domain.JUL); assertTrue(session.enableAllEvents()); assertTrue(session.start()); } diff --git a/src/test/java/org/lttng/ust/agent/integration/EnabledEventsTestBase.java b/src/test/java/org/lttng/ust/agent/integration/EnabledEventsTestBase.java index fcbc589..a04057a 100644 --- a/src/test/java/org/lttng/ust/agent/integration/EnabledEventsTestBase.java +++ b/src/test/java/org/lttng/ust/agent/integration/EnabledEventsTestBase.java @@ -28,9 +28,9 @@ import org.junit.After; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.ILttngHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; import org.lttng.ust.agent.utils.TestPrintRunner; /** @@ -45,7 +45,7 @@ public abstract class EnabledEventsTestBase { protected static final String EVENT_NAME_C = "EventABC"; protected static final String EVENT_NAME_D = "EventABCD"; - private LttngSession session; + private ILttngSession session; /* Fields defined by the sub-class */ protected ILttngHandler handlerA; @@ -61,7 +61,7 @@ public abstract class EnabledEventsTestBase { */ @Before public void testSetup() { - session = new LttngSession(null, getDomain()); + session = ILttngSession.newCommandLineSession(null, getDomain()); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/MultiSessionTestBase.java b/src/test/java/org/lttng/ust/agent/integration/MultiSessionTestBase.java index 2330a31..9976e6a 100644 --- a/src/test/java/org/lttng/ust/agent/integration/MultiSessionTestBase.java +++ b/src/test/java/org/lttng/ust/agent/integration/MultiSessionTestBase.java @@ -28,9 +28,9 @@ import org.junit.After; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; import org.lttng.ust.agent.ILttngHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; import org.lttng.ust.agent.utils.TestPrintRunner; /** @@ -44,9 +44,9 @@ public abstract class MultiSessionTestBase { protected static final String EVENT_NAME_C = "EventABC"; protected static final String EVENT_NAME_D = "EventABCD"; - private LttngSession session1; - private LttngSession session2; - private LttngSession session3; + private ILttngSession session1; + private ILttngSession session2; + private ILttngSession session3; /* Fields defined by the sub-class */ protected ILttngHandler handlerA; @@ -63,9 +63,9 @@ public abstract class MultiSessionTestBase { */ @Before public void testSetup() { - session1 = new LttngSession(null, getDomain()); - session2 = new LttngSession(null, getDomain()); - session3 = new LttngSession(null, getDomain()); + session1 = ILttngSession.newCommandLineSession(null, getDomain()); + session2 = ILttngSession.newCommandLineSession(null, getDomain()); + session3 = ILttngSession.newCommandLineSession(null, getDomain()); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/jul/JulEnabledEventsTest.java b/src/test/java/org/lttng/ust/agent/integration/jul/JulEnabledEventsTest.java index 793e2db..949e914 100644 --- a/src/test/java/org/lttng/ust/agent/integration/jul/JulEnabledEventsTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/jul/JulEnabledEventsTest.java @@ -29,11 +29,11 @@ import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.integration.EnabledEventsTestBase; import org.lttng.ust.agent.jul.LttngLogHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; /** * Enabled events test for the LTTng-UST JUL log handler. @@ -53,10 +53,10 @@ public class JulEnabledEventsTest extends EnabledEventsTestBase { @BeforeClass public static void julClassSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForJulLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.JUL)); + assumeTrue(LttngUtils.checkForJulLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.JUL)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -64,7 +64,7 @@ public class JulEnabledEventsTest extends EnabledEventsTestBase { */ @AfterClass public static void julClassCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/jul/JulLegacyApiTest.java b/src/test/java/org/lttng/ust/agent/integration/jul/JulLegacyApiTest.java index f69aff3..b1a7c48 100644 --- a/src/test/java/org/lttng/ust/agent/integration/jul/JulLegacyApiTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/jul/JulLegacyApiTest.java @@ -35,11 +35,12 @@ import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.junit.runner.RunWith; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.ILttngHandler; import org.lttng.ust.agent.LTTngAgent; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; import org.lttng.ust.agent.utils.TestPrintRunner; /** @@ -54,7 +55,7 @@ public class JulLegacyApiTest { private static final String EVENT_NAME_A = "EventA"; private static final String EVENT_NAME_B = "EventB"; - private LttngSession session; + private ILttngSession session; private Logger loggerA; private Logger loggerB; @@ -65,10 +66,10 @@ public class JulLegacyApiTest { @BeforeClass public static void julClassSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForJulLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.JUL)); + assumeTrue(LttngUtils.checkForJulLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.JUL)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -76,7 +77,7 @@ public class JulLegacyApiTest { */ @AfterClass public static void julClassCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** @@ -91,7 +92,7 @@ public class JulLegacyApiTest { loggerA.setLevel(Level.ALL); loggerB.setLevel(Level.ALL); - session = new LttngSession(null, DOMAIN); + session = ILttngSession.newCommandLineSession(null, DOMAIN); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/jul/JulMultiSessionTest.java b/src/test/java/org/lttng/ust/agent/integration/jul/JulMultiSessionTest.java index 646876f..25a9cab 100644 --- a/src/test/java/org/lttng/ust/agent/integration/jul/JulMultiSessionTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/jul/JulMultiSessionTest.java @@ -29,11 +29,11 @@ import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.integration.MultiSessionTestBase; import org.lttng.ust.agent.jul.LttngLogHandler; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; /** * JUL tests for multiple concurrent tracing sessions @@ -53,10 +53,10 @@ public class JulMultiSessionTest extends MultiSessionTestBase { @BeforeClass public static void julClassSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForJulLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.JUL)); + assumeTrue(LttngUtils.checkForJulLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.JUL)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -64,7 +64,7 @@ public class JulMultiSessionTest extends MultiSessionTestBase { */ @AfterClass public static void julClassCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jEnabledEventsTest.java b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jEnabledEventsTest.java index 35a17ab..a5b3453 100644 --- a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jEnabledEventsTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jEnabledEventsTest.java @@ -29,11 +29,11 @@ import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.integration.EnabledEventsTestBase; import org.lttng.ust.agent.log4j.LttngLogAppender; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; /** * Enabled events test for the LTTng-UST Log4j log handler. @@ -53,10 +53,10 @@ public class Log4jEnabledEventsTest extends EnabledEventsTestBase { @BeforeClass public static void log4jClassSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForLog4jLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.LOG4J)); + assumeTrue(LttngUtils.checkForLog4jLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.LOG4J)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -64,7 +64,7 @@ public class Log4jEnabledEventsTest extends EnabledEventsTestBase { */ @AfterClass public static void log4jClassCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jLegacyApiTest.java b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jLegacyApiTest.java index 8d4a6fa..0f473f9 100644 --- a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jLegacyApiTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jLegacyApiTest.java @@ -35,11 +35,12 @@ import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.junit.runner.RunWith; +import org.lttng.tools.ILttngSession; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.ILttngHandler; import org.lttng.ust.agent.LTTngAgent; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; import org.lttng.ust.agent.utils.TestPrintRunner; /** @@ -55,7 +56,7 @@ public class Log4jLegacyApiTest { private static final String EVENT_NAME_A = "EventA"; private static final String EVENT_NAME_B = "EventB"; - private LttngSession session; + private ILttngSession session; private Logger loggerA; private Logger loggerB; @@ -66,10 +67,10 @@ public class Log4jLegacyApiTest { @BeforeClass public static void classSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForLog4jLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.LOG4J)); + assumeTrue(LttngUtils.checkForLog4jLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.LOG4J)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -77,7 +78,7 @@ public class Log4jLegacyApiTest { */ @AfterClass public static void classCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** @@ -92,7 +93,7 @@ public class Log4jLegacyApiTest { loggerA.setLevel(Level.ALL); loggerB.setLevel(Level.ALL); - session = new LttngSession(null, DOMAIN); + session = ILttngSession.newCommandLineSession(null, DOMAIN); } /** diff --git a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jMultiSessionTest.java b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jMultiSessionTest.java index 31556b6..ef0bae1 100644 --- a/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jMultiSessionTest.java +++ b/src/test/java/org/lttng/ust/agent/integration/log4j/Log4jMultiSessionTest.java @@ -29,11 +29,11 @@ import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; +import org.lttng.tools.ILttngSession.Domain; +import org.lttng.tools.LttngToolsHelper; +import org.lttng.tools.utils.LttngUtils; import org.lttng.ust.agent.integration.MultiSessionTestBase; import org.lttng.ust.agent.log4j.LttngLogAppender; -import org.lttng.ust.agent.utils.LttngSession; -import org.lttng.ust.agent.utils.LttngSession.Domain; -import org.lttng.ust.agent.utils.MiscTestUtils; /** * Log4j tests for multiple concurrent tracing sessions @@ -53,10 +53,10 @@ public class Log4jMultiSessionTest extends MultiSessionTestBase { @BeforeClass public static void log4jClassSetup() { /* Skip tests if we can't find the JNI library or lttng-tools */ - assumeTrue(MiscTestUtils.checkForLog4jLibrary()); - assumeTrue(MiscTestUtils.checkForLttngTools(Domain.LOG4J)); + assumeTrue(LttngUtils.checkForLog4jLibrary()); + assumeTrue(LttngUtils.checkForLttngTools(Domain.LOG4J)); - LttngSession.destroyAllSessions(); + LttngToolsHelper.destroyAllSessions(); } /** @@ -64,7 +64,7 @@ public class Log4jMultiSessionTest extends MultiSessionTestBase { */ @AfterClass public static void log4jClassCleanup() { - LttngSession.deleteAllTracee(); + LttngToolsHelper.deleteAllTraces(); } /** diff --git a/src/test/java/org/lttng/ust/agent/utils/LttngSession.java b/src/test/java/org/lttng/ust/agent/utils/LttngSession.java deleted file mode 100644 index 9d0b4ab..0000000 --- a/src/test/java/org/lttng/ust/agent/utils/LttngSession.java +++ /dev/null @@ -1,235 +0,0 @@ -/* - * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir - * - * 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 static org.lttng.ust.agent.utils.ShellUtils.executeCommand; - -import java.io.IOException; -import java.nio.file.FileVisitResult; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.nio.file.SimpleFileVisitor; -import java.nio.file.attribute.BasicFileAttributes; -import java.util.Arrays; -import java.util.List; -import java.util.UUID; -import java.util.stream.Collectors; - -/** - * Java representation of a LTTng tracing session. It uses the command-line - * "lttng" tool to manipulate the session. Creating an instance will run - * "lttng create", close()'ing it will run "lttng destroy". - * - * @author Alexandre Montplaisir - */ -public class LttngSession implements AutoCloseable { - - /** - * Tracing domains as they are defined by lttng-tools - */ - public enum Domain { - /** The JUL (java.util.logging) domain */ - JUL("-j"), /** The log4j (org.apache.log4j) domain */ - LOG4J("-l"); - - private final String flag; - - private Domain(String flag) { - this.flag = flag; - } - - /** - * @return The corresponding command-line flag to pass to options like - * "lttng enable-event" - */ - public String flag() { - return flag; - } - } - - private final String sessionName; - private final Domain domain; - - private volatile boolean channelCreated = false; - - /** - * Constructor to create a new LTTng tracing session. - * - * @param sessionName - * The name of the session to use. It can be null, in which case - * we will provide a unique random name. - * @param domain - * The tracing domain of this session - */ - public LttngSession(String sessionName, Domain domain) { - if (sessionName != null) { - this.sessionName = sessionName; - } else { - this.sessionName = UUID.randomUUID().toString(); - } - this.domain = domain; - - /* Create the session in LTTng */ - executeCommand(Arrays.asList("lttng", "create", this.sessionName)); - } - - @Override - public void close() { - /* Destroy the session */ - executeCommand(Arrays.asList("lttng", "destroy", sessionName)); - // FIXME also delete the trace we generated ? - } - - // ------------------------------------------------------------------------ - // Public methods - // ------------------------------------------------------------------------ - - /** - * Enable all events in the given session (enable-event -a) - * - * @return If the command executed successfully (return code = 0). - */ - public boolean enableAllEvents() { - channelCreated = true; - return executeCommand(Arrays.asList( - "lttng", "enable-event", domain.flag(), "-a", "-s", sessionName)); - } - - /** - * Enable individual event(s). - * - * @param enabledEvents - * The list of events to enable. Should not be null or empty - * @return If the command executed successfully (return code = 0). - */ - public boolean enableEvents(String... enabledEvents) { - if (enabledEvents == null || enabledEvents.length == 0) { - throw new IllegalArgumentException(); - } - channelCreated = true; - return executeCommand(Arrays.asList( - "lttng", "enable-event", domain.flag(), - Arrays.stream(enabledEvents).collect(Collectors.joining(",")), - "-s", sessionName)); - } - - /** - * Send a disable-event command. Used to disable events that were previously - * enabled. - * - * @param disabledEvents - * The list of disabled events. Should not be null or empty - * @return If the command executed successfully (return code = 0). - */ - public boolean disableEvents(String... disabledEvents) { - if (disabledEvents == null || disabledEvents.length == 0) { - throw new IllegalArgumentException(); - } - return executeCommand(Arrays.asList( - "lttng", "disable-event", domain.flag(), - Arrays.stream(disabledEvents).collect(Collectors.joining(",")), - "-s", sessionName)); - } - - /** - * Start tracing - * - * @return If the command executed successfully (return code = 0). - */ - public boolean start() { - /* - * We have to enable a channel for 'lttng start' to work. However, we - * cannot enable a channel directly, see - * https://bugs.lttng.org/issues/894 . Instead we will enable an event - * we know does not exist - */ - if (!channelCreated) { - enableEvents("non-event"); - } - return executeCommand(Arrays.asList("lttng", "start", sessionName)); - } - - /** - * Stop the tracing session - * - * @return If the command executed successfully (return code = 0). - */ - public boolean stop() { - return executeCommand(Arrays.asList("lttng", "stop", sessionName)); - } - - /** - * Issue a "lttng view" command on the session, and returns its output. This - * effectively returns the current content of the trace in text form. - * - * @return The output of Babeltrace on the session's current trace - */ - public List view() { - return ShellUtils.getOutputFromCommand(true, Arrays.asList("lttng", "view", sessionName)); - } - - /** - * Utility method to destroy all existing sessions. Useful when first - * setting up a test to make sure no existing session interferes. - */ - public static void destroyAllSessions() { - executeCommand(Arrays.asList("lttng", "destroy", "-a")); - } - - /** - * Outside of the scope of lttng-tools, but this utility method can be used - * to delete all traces currently under ~/lttng-traces/. This can be used by - * tests to cleanup a trace they have created. - * - * @return True if the command completes successfully, false if there was an - * error. - */ - public static boolean deleteAllTracee() { - String tracesDir = new String(System.getProperty("user.home") + "/lttng-traces/"); - return deleteDirectory(Paths.get(tracesDir)); - } - - // ------------------------------------------------------------------------ - // Private helper methods - // ------------------------------------------------------------------------ - - private static boolean deleteDirectory(Path directory) { - try { - Files.walkFileTree(directory, new SimpleFileVisitor() { - @Override - public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { - Files.delete(file); - return FileVisitResult.CONTINUE; - } - - @Override - public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException { - Files.delete(dir); - return FileVisitResult.CONTINUE; - } - }); - } catch (IOException e) { - /* At least we tried... */ - return false; - } - return true; - } - -} -- 2.34.1