1 /*******************************************************************************
2 * Copyright (c) 2013, 2014 École Polytechnique de Montréal
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.ui
.tests
.shared
;
16 import java
.lang
.reflect
.InvocationTargetException
;
17 import java
.util
.concurrent
.TimeoutException
;
19 import org
.eclipse
.core
.resources
.IFolder
;
20 import org
.eclipse
.core
.resources
.IProject
;
21 import org
.eclipse
.core
.resources
.IResource
;
22 import org
.eclipse
.core
.runtime
.CoreException
;
23 import org
.eclipse
.core
.runtime
.IPath
;
24 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
25 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
26 import org
.eclipse
.core
.runtime
.Path
;
27 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.Activator
;
28 import org
.eclipse
.linuxtools
.internal
.tmf
.ui
.project
.model
.TmfImportHelper
;
29 import org
.eclipse
.linuxtools
.tmf
.core
.TmfCommonConstants
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.tests
.shared
.TmfTestTrace
;
31 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.ITmfProjectModelElement
;
32 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfCommonProjectElement
;
33 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfExperimentElement
;
34 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectElement
;
35 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfProjectRegistry
;
36 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTraceElement
;
37 import org
.eclipse
.linuxtools
.tmf
.ui
.project
.model
.TmfTracesFolder
;
38 import org
.eclipse
.swt
.widgets
.Display
;
39 import org
.eclipse
.ui
.PlatformUI
;
40 import org
.eclipse
.ui
.actions
.WorkspaceModifyOperation
;
43 * Creates objects used for this package's testing purposes
45 * @author Geneviève Bastien
47 public class ProjectModelTestData
{
49 /* Maximum number of thread delays the main thread will do before timing out */
50 private static final int DELAY_COUNTER
= 1000;
51 /* Default delay time when having the main thread sleep. */
52 private static final long DEFAULT_DELAY
= 500;
54 /** Default test project name */
55 public static final String PROJECT_NAME
= "Test_Project";
57 private static final TmfTestTrace testTrace
= TmfTestTrace
.A_TEST_10K
;
60 * Gets a project element with traces all initialized
62 * @return A project stub element
63 * @throws CoreException
64 * If something happened with the project creation
66 public static TmfProjectElement
getFilledProject() throws CoreException
{
68 IProject project
= TmfProjectRegistry
.createProject(PROJECT_NAME
, null, null);
69 IFolder traceFolder
= project
.getFolder(TmfTracesFolder
.TRACES_FOLDER_NAME
);
71 /* Create a trace, if it exist, it will be replaced */
72 File file
= new File(testTrace
.getFullPath());
73 String path
= file
.getAbsolutePath();
74 final IPath pathString
= Path
.fromOSString(path
);
75 IResource linkedTrace
= TmfImportHelper
.createLink(traceFolder
, pathString
, pathString
.lastSegment());
76 if (!(linkedTrace
!= null && linkedTrace
.exists())) {
79 linkedTrace
.setPersistentProperty(TmfCommonConstants
.TRACETYPE
,
80 "org.eclipse.linuxtools.tmf.core.tests.tracetype");
82 final TmfProjectElement projectElement
= TmfProjectRegistry
.getProject(project
, true);
83 TmfTraceElement traceElement
= projectElement
.getTracesFolder().getTraces().get(0);
84 traceElement
.refreshTraceType();
86 projectElement
.refresh();
88 return projectElement
;
92 * Adds a new experiment to the project
94 * @param projectElement
95 * The project to add to
96 * @param experimentName
97 * Name of the experiment
98 * @return The newly created experiment
100 public static TmfExperimentElement
addExperiment(TmfProjectElement projectElement
, String experimentName
) {
101 IFolder experimentFolder
= projectElement
.getExperimentsFolder().getResource();
102 final IFolder folder
= experimentFolder
.getFolder(experimentName
);
104 WorkspaceModifyOperation operation
= new WorkspaceModifyOperation() {
106 public void execute(IProgressMonitor monitor
) throws CoreException
{
107 monitor
.beginTask("", 1000);
108 folder
.create(false, true, monitor
);
113 PlatformUI
.getWorkbench().getProgressService().busyCursorWhile(operation
);
114 } catch (InterruptedException
| InvocationTargetException
| RuntimeException exception
) {
118 for (ITmfProjectModelElement el
: projectElement
.getExperimentsFolder().getChildren()) {
119 if (el
.getName().equals(experimentName
) && (el
instanceof TmfExperimentElement
)) {
120 return (TmfExperimentElement
) el
;
127 * Get the name of the test trace element
129 * @return The trace name
131 public static String
getTraceName() {
132 File file
= new File(testTrace
.getPath());
133 String path
= file
.getAbsolutePath();
134 final IPath pathString
= Path
.fromOSString(path
);
135 return pathString
.lastSegment();
144 public static void deleteProject(TmfProjectElement project
) {
145 /* Delete experiments */
146 ITmfProjectModelElement
[] experiments
= project
.getExperimentsFolder().getChildren().toArray(new ITmfProjectModelElement
[0]);
147 for (ITmfProjectModelElement element
: experiments
) {
148 if (element
instanceof TmfExperimentElement
) {
149 TmfExperimentElement experiment
= (TmfExperimentElement
) element
;
150 IResource resource
= experiment
.getResource();
152 /* Close the experiment if open */
153 experiment
.closeEditors();
155 IPath path
= resource
.getLocation();
157 /* Delete supplementary files */
158 experiment
.deleteSupplementaryFolder();
161 /* Finally, delete the experiment */
163 resource
.delete(true, null);
164 } catch (CoreException e
) {
165 Activator
.getDefault().logError("Error deleting experiment element", e
);
171 ITmfProjectModelElement
[] traces
= project
.getTracesFolder().getChildren().toArray(new ITmfProjectModelElement
[0]);
172 for (ITmfProjectModelElement element
: traces
) {
173 if (element
instanceof TmfTraceElement
) {
174 TmfTraceElement trace
= (TmfTraceElement
) element
;
175 IResource resource
= trace
.getResource();
177 /* Close the trace if open */
178 trace
.closeEditors();
180 IPath path
= resource
.getLocation();
182 /* Delete supplementary files */
183 trace
.deleteSupplementaryFolder();
186 /* Finally, delete the trace */
188 resource
.delete(true, new NullProgressMonitor());
189 } catch (CoreException e
) {
190 Activator
.getDefault().logError("Error deleting trace element", e
);
195 /* Delete the project itself */
197 project
.getResource().delete(true, null);
198 } catch (CoreException e
) {
199 Activator
.getDefault().logError("Error deleting project", e
);
204 * Makes the main display thread sleep, so it gives a chance to other
205 * threads needing the main display to execute
207 * @param waitTimeMillis
208 * time to wait in millisecond
210 public static void delayThread(final long waitTimeMillis
) {
211 final Display display
= Display
.getCurrent();
212 if (display
!= null) {
213 final long endTimeMillis
= System
.currentTimeMillis() + waitTimeMillis
;
214 while (System
.currentTimeMillis() < endTimeMillis
) {
215 if (!display
.readAndDispatch()) {
222 Thread
.sleep(waitTimeMillis
);
223 } catch (final InterruptedException e
) {
230 * Makes the main display thread sleep to give a chance to other threads to
231 * execute. It sleeps until the a trace element's corresponding trace is
232 * available (opened) or returns after a timeout. It allows to set short
233 * delays, while still not failing tests when it randomly takes a bit more
234 * time for the trace to open.
236 * If the project model element sent in parameter is not a trace element,
237 * then the thread is delayed only once by the default delay time. For
238 * longer delays in those cases, it is preferable to use the
239 * {@link ProjectModelTestData#delayThread(long)} instead.
241 * Timeout is DELAY_COUNTER * DEFAULT_DELAY ms
243 * @param projectElement
244 * The trace element we are waiting for. If the element if not of
245 * type TmfTraceElement, the thread is delayed only once.
246 * @throws TimeoutException
247 * If after the maximum number of delays the trace is still
248 * null, we throw a timeout exception, the trace has not opened.
250 public static void delayUntilTraceOpened(final ITmfProjectModelElement projectElement
) throws TimeoutException
{
251 if (projectElement
instanceof TmfCommonProjectElement
) {
252 TmfCommonProjectElement traceElement
= (TmfCommonProjectElement
) projectElement
;
253 final long deadline
= System
.nanoTime() + (DELAY_COUNTER
* DEFAULT_DELAY
* 1000000L);
255 delayThread(DEFAULT_DELAY
);
256 if (traceElement
.getTrace() != null) {
259 } while (System
.nanoTime() < deadline
);
260 throw new TimeoutException("Timeout while waiting for " + traceElement
);
262 delayThread(DEFAULT_DELAY
);