swtbot: Add Copy to Clipboard tests
authorPatrick Tasse <patrick.tasse@gmail.com>
Mon, 22 Jun 2015 15:29:08 +0000 (11:29 -0400)
committerPatrick Tasse <patrick.tasse@gmail.com>
Thu, 25 Jun 2015 21:20:25 +0000 (17:20 -0400)
Change-Id: I18e7f8a633918856dc934483c4c1aac41955912d
Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-on: https://git.eclipse.org/r/50653
Reviewed-by: Hudson CI
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
tmf/org.eclipse.tracecompass.tmf.ui.swtbot.tests/src/org/eclipse/tracecompass/tmf/ui/swtbot/tests/viewers/events/AllTests.java
tmf/org.eclipse.tracecompass.tmf.ui.swtbot.tests/src/org/eclipse/tracecompass/tmf/ui/swtbot/tests/viewers/events/CopyToClipboardTest.java [new file with mode: 0644]

index 0f62c8a69c0c5611fa903b1f3ee4ba047cb5c501..5d3f2ecf773ae6f089ad6f2159f12ed0e82233ee 100644 (file)
@@ -24,6 +24,7 @@ import org.junit.runners.Suite;
         CollapseEventsInTableTest.class,
         ColorsViewTest.class,
         ColumnHeaderMenuTest.class,
+        CopyToClipboardTest.class,
         FilterColorEditorTest.class,
         FilterViewerTest.class,
         FontEventEditorTest.class,
diff --git a/tmf/org.eclipse.tracecompass.tmf.ui.swtbot.tests/src/org/eclipse/tracecompass/tmf/ui/swtbot/tests/viewers/events/CopyToClipboardTest.java b/tmf/org.eclipse.tracecompass.tmf.ui.swtbot.tests/src/org/eclipse/tracecompass/tmf/ui/swtbot/tests/viewers/events/CopyToClipboardTest.java
new file mode 100644 (file)
index 0000000..6939a4b
--- /dev/null
@@ -0,0 +1,212 @@
+/*******************************************************************************
+ * Copyright (c) 2015 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:
+ *   Patrick Tasse - Initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.tracecompass.tmf.ui.swtbot.tests.viewers.events;
+
+import static org.junit.Assert.fail;
+import static org.junit.Assume.assumeTrue;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+
+import org.apache.log4j.ConsoleAppender;
+import org.apache.log4j.Logger;
+import org.apache.log4j.SimpleLayout;
+import org.eclipse.core.runtime.FileLocator;
+import org.eclipse.core.runtime.Path;
+import org.eclipse.osgi.util.NLS;
+import org.eclipse.swt.dnd.Clipboard;
+import org.eclipse.swt.dnd.TextTransfer;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
+import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotEditor;
+import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
+import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
+import org.eclipse.swtbot.swt.finder.keyboard.Keyboard;
+import org.eclipse.swtbot.swt.finder.keyboard.KeyboardFactory;
+import org.eclipse.swtbot.swt.finder.keyboard.Keystrokes;
+import org.eclipse.swtbot.swt.finder.results.StringResult;
+import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
+import org.eclipse.swtbot.swt.finder.waits.DefaultCondition;
+import org.eclipse.swtbot.swt.finder.widgets.SWTBotTable;
+import org.eclipse.swtbot.swt.finder.widgets.TimeoutException;
+import org.eclipse.tracecompass.tmf.core.tests.TmfCoreTestPlugin;
+import org.eclipse.tracecompass.tmf.ui.swtbot.tests.shared.SWTBotUtils;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/**
+ * SWTBot test for testing copy to clipboard.
+ */
+@RunWith(SWTBotJunit4ClassRunner.class)
+public class CopyToClipboardTest {
+
+    private static final String LINE_SEPARATOR = System.getProperty("line.separator"); //$NON-NLS-1$
+    private static final String HEADER_TEXT = "Timestamp\tHost\tLogger\tFile\tLine\tMessage" + LINE_SEPARATOR;
+    private static final String EVENT1_TEXT = "01:01:01.000 000 000\tHostA\tLoggerA\tSourceFile\t4\tMessage A" + LINE_SEPARATOR;
+    private static final String EVENT2_TEXT = "02:02:02.000 000 000\tHostB\tLoggerB\tSourceFile\t5\tMessage B" + LINE_SEPARATOR;
+    private static final String EVENT3_TEXT = "03:03:03.000 000 000\tHostC\tLoggerC\tSourceFile\t6\tMessage C" + LINE_SEPARATOR;
+    private static final Keyboard KEYBOARD = KeyboardFactory.getSWTKeyboard();
+    private static final String TRACE_PROJECT_NAME = "test";
+    private static final String TRACE_NAME = "syslog_collapse";
+    private static final String TRACE_PATH = "testfiles/" + TRACE_NAME;
+    private static final String TRACE_TYPE = "org.eclipse.linuxtools.tmf.tests.stubs.trace.text.testsyslog";
+
+    private static File fTestFile = null;
+
+    private static SWTWorkbenchBot fBot;
+    private SWTBotEditor fEditorBot;
+
+    /** The Log4j logger instance. */
+    private static final Logger fLogger = Logger.getRootLogger();
+
+    /**
+     * Test Class setup
+     */
+    @BeforeClass
+    public static void beforeClass() {
+        SWTBotUtils.failIfUIThread();
+
+        /* set up test trace */
+        URL location = FileLocator.find(TmfCoreTestPlugin.getDefault().getBundle(), new Path(TRACE_PATH), null);
+        URI uri;
+        try {
+            uri = FileLocator.toFileURL(location).toURI();
+            fTestFile = new File(uri);
+        } catch (URISyntaxException | IOException e) {
+            fail(e.getMessage());
+        }
+
+        assumeTrue(fTestFile.exists());
+
+        /* Set up for swtbot */
+        SWTBotPreferences.TIMEOUT = 20000; /* 20 second timeout */
+        SWTBotPreferences.KEYBOARD_LAYOUT = "EN_US";
+        fLogger.removeAllAppenders();
+        fLogger.addAppender(new ConsoleAppender(new SimpleLayout(), ConsoleAppender.SYSTEM_OUT));
+        fBot = new SWTWorkbenchBot();
+
+        /* Close welcome view */
+        SWTBotUtils.closeView("Welcome", fBot);
+
+        /* Switch perspectives */
+        SWTBotUtils.switchToTracingPerspective();
+
+        /* Finish waiting for eclipse to load */
+        SWTBotUtils.waitForJobs();
+
+        SWTBotUtils.createProject(TRACE_PROJECT_NAME);
+    }
+
+    /**
+     * Test class tear down method.
+     */
+    @AfterClass
+    public static void afterClass() {
+        SWTBotUtils.deleteProject(TRACE_PROJECT_NAME, fBot);
+        fLogger.removeAllAppenders();
+    }
+
+    /**
+     * Before Test
+     */
+    @Before
+    public void before() {
+        SWTBotUtils.openTrace(TRACE_PROJECT_NAME, fTestFile.getAbsolutePath(), TRACE_TYPE);
+        fEditorBot = SWTBotUtils.activateEditor(fBot, fTestFile.getName());
+    }
+
+    /**
+     * After Test
+     */
+    @After
+    public void after() {
+        fBot.closeAllEditors();
+    }
+
+    /**
+     * Test copy to clipboard with single selection
+     */
+    @Test
+    public void testCopySingleSelection() {
+        final SWTBotTable tableBot = fEditorBot.bot().table();
+        tableBot.getTableItem(1).click();
+
+        tableBot.contextMenu("Copy to Clipboard").click();
+        assertClipboardContentsEquals(HEADER_TEXT + EVENT1_TEXT);
+    }
+
+    /**
+     * Test copy to clipboard with multiple selection
+     */
+    @Test
+    public void testCopyMultipleSelection() {
+        final SWTBotTable tableBot = fEditorBot.bot().table();
+        tableBot.getTableItem(1).click();
+        KEYBOARD.pressShortcut(Keystrokes.SHIFT, Keystrokes.DOWN);
+        KEYBOARD.pressShortcut(Keystrokes.SHIFT, Keystrokes.DOWN);
+
+        tableBot.contextMenu("Copy to Clipboard").click();
+        assertClipboardContentsEquals(HEADER_TEXT + EVENT1_TEXT + EVENT2_TEXT + EVENT3_TEXT);
+    }
+
+    /**
+     * Test copy to clipboard not enabled when selection includes search row
+     */
+    @Test(expected = TimeoutException.class)
+    public void testNoCopySearchRow() {
+        final SWTBotTable tableBot = fEditorBot.bot().table();
+        tableBot.getTableItem(1).click();
+        KEYBOARD.pressShortcut(Keystrokes.SHIFT, Keystrokes.UP);
+
+        try {
+            SWTBotPreferences.TIMEOUT = 1000; /* 1 second timeout */
+            tableBot.contextMenu("Copy to Clipboard");
+        } finally {
+            SWTBotPreferences.TIMEOUT = 20000; /* 20 second timeout */
+        }
+    }
+
+    private static void assertClipboardContentsEquals(final String expected) {
+        fBot.waitUntil(new DefaultCondition() {
+            String actual;
+            @Override
+            public boolean test() throws Exception {
+                actual = UIThreadRunnable.syncExec(new StringResult() {
+                    @Override
+                    public String run() {
+                        Clipboard clipboard = new Clipboard(Display.getDefault());
+                        TextTransfer textTransfer = TextTransfer.getInstance();
+                        try {
+                            return (String) clipboard.getContents(textTransfer);
+                        } finally {
+                            clipboard.dispose();
+                        }
+                    }
+                });
+                return expected.equals(actual);
+            }
+            @Override
+            public String getFailureMessage() {
+                return NLS.bind("Clipboard contents:\n{0}\nExpected:\n{1}",
+                        actual, expected);
+            }
+        });
+    }
+}
This page took 0.029647 seconds and 5 git commands to generate.