Skip to main content
summaryrefslogtreecommitdiffstats
blob: 6a36767d9c795d94803b81118ad9509d19baef5c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/*****************************************************************************
 * Copyright (c) 2015 CEA LIST and others.
 * 
 * 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:
 *   CEA LIST - Initial API and implementation
 *   
 *****************************************************************************/

package org.eclipse.papyrus.uml.nattable.clazz.config.tests.sort;

import java.util.List;

import org.eclipse.emf.common.util.URI;
import org.eclipse.nebula.widgets.nattable.NatTable;
import org.eclipse.nebula.widgets.nattable.sort.command.SortColumnCommand;
import org.eclipse.osgi.util.NLS;
import org.eclipse.papyrus.infra.nattable.common.editor.NatTableEditor;
import org.eclipse.papyrus.infra.nattable.manager.table.NattableModelManager;
import org.eclipse.papyrus.infra.nattable.manager.table.TreeNattableModelManager;
import org.eclipse.papyrus.infra.nattable.model.nattable.Table;
import org.eclipse.papyrus.infra.nattable.model.nattable.nattableaxisconfiguration.TreeFillingConfiguration;
import org.eclipse.papyrus.infra.nattable.tree.CollapseAndExpandActionsEnum;
import org.eclipse.papyrus.infra.nattable.utils.FillingConfigurationUtils;
import org.eclipse.papyrus.infra.nattable.utils.StyleUtils;
import org.eclipse.papyrus.infra.nattable.utils.TableClipboardUtils;
import org.eclipse.papyrus.infra.tools.util.FileUtils;
import org.eclipse.papyrus.junit.framework.classification.tests.AbstractPapyrusTest;
import org.eclipse.papyrus.junit.utils.rules.ActiveTable;
import org.eclipse.papyrus.junit.utils.rules.PapyrusEditorFixture;
import org.eclipse.papyrus.uml.nattable.clazz.config.tests.Activator;
import org.eclipse.papyrus.uml.nattable.clazz.config.tests.tests.AbstractTableTest;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

/**
 * 
 * Abstract test class to reopen filtered table
 */
public abstract class AbstractSortTable extends AbstractTableTest {

	/**
	 * the resource path
	 */
	private static final String RESOURCES_PATH = "resources/sort/";//$NON-NLS-1$

	public static final String NAME_ASC = "NAME_ASC";//$NON-NLS-1$

	public static final String NAME_DESC = "NAME_DESC";//$NON-NLS-1$

	public static final String TYPE_ASC = "TYPE_ASC"; //$NON-NLS-1$

	public static final String TYPE_DESC = "TYPE_DESC";//$NON-NLS-1$

	public static final String NAME_ASC_TYPE_ASC = "NAME_ASC_TYPE_ASC";//$NON-NLS-1$
	public static final String NAME_ASC_TYPE_DESC = "NAME_ASC_TYPE_DESC";//$NON-NLS-1$
	public static final String NAME_DESC_TYPE_ASC = "NAME_DESC_TYPE_ASC";//$NON-NLS-1$
	public static final String NAME_DESC_TYPE_DESC = "NAME_DESC_TYPE_DESC";//$NON-NLS-1$

	public static final String TYPE_ASC_NAME_ASC = "TYPE_ASC_NAME_ASC";//$NON-NLS-1$
	public static final String TYPE_DESC_NAME_ASC = "TYPE_DESC_NAME_ASC";//$NON-NLS-1$
	public static final String TYPE_ASC_NAME_DESC = "TYPE_ASC_NAME_DESC";//$NON-NLS-1$
	public static final String TYPE_DESC_NAME_DESC = "TYPE_DESC_NAME_DESC";//$NON-NLS-1$


	/**
	 * load the table editor
	 */
	@Before
	public void init() {
		// these tests works only when the sorted columns are visible (without scrollbar)!
		if (Display.getDefault() != null) {
			Shell shell = Display.getDefault().getActiveShell();
			if (shell != null) {
				shell.setMaximized(true);
			}
		}
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_ASC() {
		startTest();
	
		fixture.flushDisplayEvents();
		manager.selectAll();
		((NattableModelManager) manager).copyToClipboard();
		fixture.flushDisplayEvents();
		String before = getClipboardContent();

		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));

		fixture.flushDisplayEvents();
		manager.selectAll();
		((NattableModelManager) manager).copyToClipboard();
		fixture.flushDisplayEvents();
		String after = getClipboardContent();

		endTest(getResultFile_Name_ASC_SORT());
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_ASC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));

		endTest(getResultFile_Type_ASC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Type_ASC_SORT() {
		return createSortFileNameResult(TYPE_ASC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));

		endTest(getResultFile_Type_DESC_SORT());
	}

	// ---sorting the 2 columns, name first
	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_ASC_TYPE_ASC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));

		endTest(getResultFile_Name_ASC_Type_ASC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Name_ASC_Type_ASC_SORT() {
		return createSortFileNameResult(NAME_ASC_TYPE_ASC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_ASC_TYPE_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		endTest(getResultFile_Name_ASC_Type_DESC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Name_ASC_Type_DESC_SORT() {
		return createSortFileNameResult(NAME_ASC_TYPE_DESC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_DESC_TYPE_ASC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		endTest(getResultFile_Name_DESC_Type_ASC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Name_DESC_Type_ASC_SORT() {
		return createSortFileNameResult(NAME_DESC_TYPE_ASC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_DESC_TYPE_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		endTest(getResultFile_Name_DESC_Type_DESC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Name_DESC_Type_DESC_SORT() {
		return createSortFileNameResult(NAME_DESC_TYPE_DESC);
	}

	// ---sorting the 2 columns, type first
	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_ASC_NAME_ASC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		endTest(getResultFile_Type_ASC_Name_ASC_SORT());
	}
	
	/**
	 * @return
	 */
	private String getResultFile_Type_ASC_Name_ASC_SORT() {
		return createSortFileNameResult(TYPE_ASC_NAME_ASC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_ASC_NAME_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		endTest(getResultFile_Type_ASC_Name_DESC_SORT());
	}
	
	/**
	 * @return
	 */
	private String getResultFile_Type_ASC_Name_DESC_SORT() {
		return createSortFileNameResult(TYPE_ASC_NAME_DESC);
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_DESC_NAME_ASC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		endTest(getResultFile_Type_DESC_Name_ASC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Type_DESC_Name_ASC_SORT() {
		return createSortFileNameResult(TYPE_DESC_NAME_ASC);
	}

	
	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_TYPE_DESC_NAME_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getTypeColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), true)));
		endTest(getResultFile_Type_DESC_Name_DESC_SORT());
	}

	/**
	 * @return
	 */
	private String getResultFile_Type_DESC_Name_DESC_SORT() {
		return createSortFileNameResult(TYPE_DESC_NAME_DESC);
	}

	/**
	 * @return
	 */
	private String getResultFile_Type_DESC_SORT() {
		return createSortFileNameResult(TYPE_DESC);
	}

	/**
	 * this method initialize some field for the test + expand all the table + check the initial state of the table
	 */
	protected void startTest() {
		super.startTest();
		manager.selectAll();
		manager.copyToClipboard();
		String clipboard = getClipboardContent();
		// we check than the contents of the clipboard (so the displayed table) is the same than the wanted result
		Assert.assertNotNull(clipboard);
		String str = getWantedString(getInitialStateFileName());
		// we check than the contents of the clipboard (so the displayed table) is the same than the wanted result
		Assert.assertEquals(str, clipboard);
	}

	/**
	 * 
	 * @param resultFileName
	 *            the name of the result file to use to compare the displayed state and the wanted state
	 */
	protected void endTest(String resultFileName) {
		compareCurrentDisplayToWantedDisplay(resultFileName);
	}

	/**
	 * 
	 * @return
	 * 		the name column index
	 */
	protected int getNameColumnIndex() {
		return 2;
	}

	/**
	 * 
	 * @return
	 * 		the type column index
	 */
	protected int getTypeColumnIndex() {
		return 3;
	}

	@Test
	@ActiveTable("ClassTreeTable")
	public void test_sort_NAME_DESC() {
		startTest();
		// we do the sort
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));
		Assert.assertTrue(natTable.doCommand(new SortColumnCommand(natTable, getNameColumnIndex(), false)));

		endTest(getResultFile_Name_DESC_SORT());
	}

	/**
	 * 
	 * @return
	 * 		the name of the file which contains the wanted contents of the clipboard after the copy to clipboard
	 */
	private String getInitialStateFileName() {
		URI uri = manager.getTable().eResource().getURI();
		uri = uri.trimFileExtension();
		StringBuffer buffer = new StringBuffer(uri.lastSegment());
		buffer.append(FileUtils.DOT_STRING);
		buffer.append(FileUtils.TEXT_EXTENSION);
		return buffer.toString();
	}

	/**
	 * @return
	 */
	protected String getSourcePath() {
		return RESOURCES_PATH;
	}


	/**
	 * @see org.eclipse.papyrus.uml.nattable.clazz.config.tests.sort.AbstractSortTable#getResultFile_Name_ASC_SORT()
	 *
	 * @return
	 */

	protected String getResultFile_Name_ASC_SORT() {
		return createSortFileNameResult(NAME_ASC);
	}

	protected String getResultFile_Name_DESC_SORT() {
		return createSortFileNameResult(NAME_DESC);
	};

	protected String createSortFileNameResult(String fileNameSuffix) {
		URI uri = fixture.getActiveTableManager().getTable().eResource().getURI().trimFileExtension();
		String lastSegment = uri.lastSegment();
		StringBuffer buffer = new StringBuffer(lastSegment);
		buffer.append(FileUtils.UNDERSCORE);
		buffer.append(fileNameSuffix);
		buffer.append(FileUtils.DOT_STRING);
		buffer.append(FileUtils.TEXT_EXTENSION);
		return buffer.toString();
	}


}

Back to the top