Skip to main content
summaryrefslogtreecommitdiffstats
blob: 73a3981060ba5d6fb235078abeed623ef774edc0 (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
/*******************************************************************************
 * Copyright (c) 2012 Tasktop Technologies 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:
 *     Tasktop Technologies - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.tasks.tests.ui;

import java.util.concurrent.atomic.AtomicBoolean;

import junit.framework.TestCase;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.mylyn.commons.workbench.WorkbenchUtil;
import org.eclipse.mylyn.internal.tasks.core.data.TaskDataState;
import org.eclipse.mylyn.internal.tasks.ui.TasksUiPlugin;
import org.eclipse.mylyn.internal.tasks.ui.editors.BooleanAttributeEditor;
import org.eclipse.mylyn.tasks.core.TaskRepository;
import org.eclipse.mylyn.tasks.core.data.TaskAttribute;
import org.eclipse.mylyn.tasks.core.data.TaskAttributeMapper;
import org.eclipse.mylyn.tasks.core.data.TaskData;
import org.eclipse.mylyn.tasks.core.data.TaskDataModel;
import org.eclipse.mylyn.tasks.core.data.TaskDataModelEvent;
import org.eclipse.mylyn.tasks.core.data.TaskDataModelListener;
import org.eclipse.mylyn.tasks.tests.connector.MockRepositoryConnector;
import org.eclipse.mylyn.tasks.tests.connector.MockTask;
import org.eclipse.mylyn.tasks.ui.editors.AbstractAttributeEditor;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.forms.widgets.FormToolkit;

/**
 * @author Benjamin Muskalla
 */
public class AttributeEditorTest extends TestCase {

	private class MockAttributeEditor extends AbstractAttributeEditor {

		private MockAttributeEditor(TaskDataModel manager, TaskAttribute taskAttribute) throws CoreException {
			super(manager, taskAttribute);
			setControl(new Shell());
		}

		@Override
		public void createControl(Composite parent, FormToolkit toolkit) {
			// ignore
		}

		@Override
		public boolean needsValue() {
			return super.needsValue();
		}

		@Override
		public void refresh() {
			// ignore
		}

		@Override
		public Label getLabelControl() {
			return new Label(new Shell(), SWT.NONE);
		}

		@Override
		protected boolean shouldAutoRefresh() {
			return true;
		}
	}

	private class MockBooleanAttributeEditor extends BooleanAttributeEditor {

		public MockBooleanAttributeEditor(TaskDataModel manager, TaskAttribute taskAttribute) {
			super(manager, taskAttribute);
		}

		@Override
		public boolean needsValue() {
			return super.needsValue();
		}

	}

	private TaskRepository repository;

	private TaskData taskData;

	private TaskDataModel manager;

	@Override
	protected void setUp() throws Exception {
		repository = new TaskRepository(MockRepositoryConnector.CONNECTOR_KIND, MockRepositoryConnector.REPOSITORY_URL);
		TasksUiPlugin.getRepositoryManager().addRepository(repository);

		taskData = new TaskData(new TaskAttributeMapper(repository), MockRepositoryConnector.CONNECTOR_KIND,
				MockRepositoryConnector.REPOSITORY_URL, "1");

		manager = createManager();
	}

	public void testDetermineNotRequired() throws Exception {
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "not.required.field");
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute);
		assertFalse(editor.needsValue());
		attribute.setValue("");
		assertFalse(editor.needsValue());
		attribute.setValue("abc");
		assertFalse(editor.needsValue());
	}

	public void testDetermineRequired() throws Exception {
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.field");
		attribute.getMetaData().setRequired(true);
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute);
		assertTrue(editor.needsValue());
		attribute.setValue("");
		assertTrue(editor.needsValue());
		attribute.setValue("abc");
		assertFalse(editor.needsValue());
	}

	public void testDecorateRequired() throws Exception {
		final StringBuilder eventLog = new StringBuilder();
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.field");
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute) {
			@Override
			protected void decorateRequired() {
				eventLog.append("decorateRequired");
			}

		};

		assertEquals("", eventLog.toString());
		Color someColor = WorkbenchUtil.getShell().getDisplay().getSystemColor(SWT.COLOR_CYAN);
		editor.decorate(someColor);
		assertEquals("", eventLog.toString());

		attribute.getMetaData().setRequired(true);
		editor.decorate(someColor);
		assertEquals("decorateRequired", eventLog.toString());
		eventLog.setLength(0);

		attribute.getMetaData().setRequired(false);
		editor.decorate(someColor);
		assertEquals("", eventLog.toString());
	}

	public void testDecorateRequiredOnChange() throws Exception {
		final StringBuilder eventLog = new StringBuilder();
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.field");
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute) {

			@Override
			protected void decorateRequired() {
				eventLog.append("decorateRequired");
			}

			@Override
			public boolean needsValue() {
				eventLog.append("asked");
				return super.needsValue();
			}

		};

		assertEquals("", eventLog.toString());
		Color someColor = WorkbenchUtil.getShell().getDisplay().getSystemColor(SWT.COLOR_CYAN);

		attribute.getMetaData().setRequired(true);
		editor.decorate(someColor);
		assertEquals("askeddecorateRequired", eventLog.toString());
		eventLog.setLength(0);

		attribute.setValue("someValue");
		manager.attributeChanged(attribute);

		assertEquals("asked", eventLog.toString());
	}

	public void testDecorateRequiredReal() throws Exception {
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.field");
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute);

		Color someColor = WorkbenchUtil.getShell().getDisplay().getSystemColor(SWT.COLOR_CYAN);

		attribute.getMetaData().setRequired(true);
		editor.decorate(someColor);

		attribute.getMetaData().setRequired(false);
		manager.attributeChanged(attribute);
	}

	public void testNoDecorateWithoutLabel() throws Exception {
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.field");
		MockAttributeEditor editor = new MockAttributeEditor(manager, attribute) {
			@Override
			public Label getLabelControl() {
				return null;
			}
		};

		Color someColor = WorkbenchUtil.getShell().getDisplay().getSystemColor(SWT.COLOR_CYAN);

		attribute.getMetaData().setRequired(true);
		editor.decorate(someColor);

		attribute.getMetaData().setRequired(false);
		manager.attributeChanged(attribute);
	}

	public void testBooleanAttribute() throws Exception {
		FormToolkit toolkit = new FormToolkit(Display.getDefault());
		TaskAttribute attribute = new TaskAttribute(taskData.getRoot(), "a.required.boolean");
		attribute.getMetaData().setType(TaskAttribute.TYPE_BOOLEAN);
		attribute.getMetaData().setRequired(true);
		final AtomicBoolean firedAttributeChanged = new AtomicBoolean();
		manager.addModelListener(new TaskDataModelListener() {
			@Override
			public void attributeChanged(TaskDataModelEvent event) {
				firedAttributeChanged.set(true);
			}
		});

		MockBooleanAttributeEditor editor = new MockBooleanAttributeEditor(manager, attribute);
		assertFalse(editor.needsValue());
		assertFalse(editor.getValue());
		assertFalse(attribute.hasValue());
		editor.createControl(WorkbenchUtil.getShell(), toolkit);
		assertFalse(attribute.hasValue());
		processAllEvents();
		assertTrue(attribute.hasValue());
		assertEquals(Boolean.toString(false), attribute.getValue());
		assertFalse(firedAttributeChanged.get());

		attribute.setValue(Boolean.toString(true));
		editor = new MockBooleanAttributeEditor(manager, attribute);
		editor.createControl(WorkbenchUtil.getShell(), toolkit);
		processAllEvents();
		assertEquals(Boolean.toString(true), attribute.getValue());
		assertFalse(firedAttributeChanged.get());
	}

	/**
	 * wait for the async call in BooleanAttributeEditor to run
	 */
	private void processAllEvents() {
		while (Display.getDefault().readAndDispatch()) {
		}
	}

	private TaskDataModel createManager() throws Exception {
		MockTask task = new MockTask("taskId");
		TaskDataState state = new TaskDataState("kind", "url", "taskId");
		state.setEditsData(taskData);
		state.setLocalTaskData(taskData);
		TaskDataModel manager = new TaskDataModel(repository, task, state);
		return manager;
	}

}

Back to the top