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
|
/*******************************************************************************
* Copyright (c) 2015, 2016 Red Hat Inc.
* 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:
* Red Hat - Initial Contribution
*******************************************************************************/
package org.eclipse.linuxtools.internal.docker.ui.wizards;
import java.io.File;
import java.io.IOException;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.linuxtools.docker.core.EnumDockerConnectionState;
import org.eclipse.linuxtools.docker.core.IDockerConnection;
import org.eclipse.linuxtools.internal.docker.core.DockerConnection;
import org.eclipse.linuxtools.internal.docker.core.SystemUtils;
import org.eclipse.linuxtools.internal.docker.ui.testutils.MockDockerClientFactory;
import org.eclipse.linuxtools.internal.docker.ui.testutils.MockDockerConnectionFactory;
import org.eclipse.linuxtools.internal.docker.ui.testutils.MockDockerConnectionSettingsFinder;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.ButtonAssertion;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.CheckBoxAssertion;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.CloseShellRule;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.CloseWelcomePageRule;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.DockerConnectionManagerUtils;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.RadioAssertion;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.SWTBotTreeItemAssertions;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.SWTUtils;
import org.eclipse.linuxtools.internal.docker.ui.testutils.swt.TextAssertion;
import org.eclipse.linuxtools.internal.docker.ui.views.DockerContainersView;
import org.eclipse.linuxtools.internal.docker.ui.views.DockerExplorerView;
import org.eclipse.linuxtools.internal.docker.ui.views.DockerImagesView;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.dnd.DND;
import org.eclipse.swt.dnd.TextTransfer;
import org.eclipse.swt.dnd.Transfer;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView;
import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarButton;
import org.eclipse.ui.PlatformUI;
import org.junit.Assert;
import org.junit.Assume;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import com.spotify.docker.client.DockerClient;
/**
* Testing the {@link NewDockerConnection} {@link Wizard}
*/
@RunWith(SWTBotJunit4ClassRunner.class)
public class NewDockerConnectionSWTBotTest {
private SWTWorkbenchBot bot = new SWTWorkbenchBot();
private SWTBotToolbarButton addConnectionButton;
private SWTBotView dockerExplorerViewBot;
@ClassRule
public static CloseWelcomePageRule closeWelcomePage = new CloseWelcomePageRule(
CloseWelcomePageRule.DOCKER_PERSPECTIVE_ID);
@Rule
public CloseShellRule closeShell = new CloseShellRule(IDialogConstants.CANCEL_LABEL);
@Before
public void lookupDockerExplorerView() throws Exception {
SWTUtils.asyncExec(() -> {
try {
PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage()
.showView(DockerExplorerView.VIEW_ID);
} catch (Exception e) {
e.printStackTrace();
Assert.fail("Failed to open Docker Explorer view: " + e.getMessage());
}
});
dockerExplorerViewBot = bot.viewById(DockerExplorerView.VIEW_ID);
dockerExplorerViewBot.show();
bot.views().stream().filter(v -> v.getReference().getId().equals(DockerContainersView.VIEW_ID)
|| v.getReference().getId().equals(DockerImagesView.VIEW_ID)).forEach(v -> v.close());
dockerExplorerViewBot.setFocus();
this.addConnectionButton = dockerExplorerViewBot.toolbarButton("&Add Connection");
}
@Before
public void clearClipboards() {
// Clear all clipboards
Display.getDefault().syncExec(() -> {
Clipboard clip = new Clipboard(Display.getCurrent());
clip.clearContents(DND.CLIPBOARD);
clip.clearContents(DND.SELECTION_CLIPBOARD);
});
}
private IDockerConnection configureUnixSocketConnection(final String connectionName, final String pathToSocket) {
final DockerClient client = MockDockerClientFactory.build();
final DockerConnection dockerConnection = MockDockerConnectionFactory.from(connectionName, client)
.withUnixSocketConnectionSettings(pathToSocket);
DockerConnectionManagerUtils.configureConnectionManager(dockerConnection);
return dockerConnection;
}
private IDockerConnection configureTCPConnection(final String connectionName, final String host) {
final DockerClient client = MockDockerClientFactory.build();
final DockerConnection dockerConnection = MockDockerConnectionFactory.from(connectionName, client)
.withTCPConnectionSettings(host, null, EnumDockerConnectionState.ESTABLISHED);
DockerConnectionManagerUtils.configureConnectionManager(dockerConnection);
return dockerConnection;
}
@Test
public void shouldShowCustomUnixSocketSettingsWhenNoConnectionAvailable() {
// given
MockDockerConnectionSettingsFinder.noDockerConnectionAvailable();
// when
addConnectionButton.click();
// then
// Empty Connection name
TextAssertion.assertThat(bot.text(0)).isEnabled().isEmpty();
// "Use custom connection settings" should be enabled and checked
CheckBoxAssertion.assertThat(bot.checkBox(0)).isEnabled().isChecked();
// "Unix socket" radio should be enabled and selected
RadioAssertion.assertThat(bot.radio(0)).isEnabled().isSelected();
// "Unix socket path" text should be enabled and empty
TextAssertion.assertThat(bot.text(1)).isEnabled().isEmpty();
// "TCP Connection" radio should be enabled but unselected
RadioAssertion.assertThat(bot.radio(1)).isEnabled().isNotSelected();
// "URI" should be disabled but empty
TextAssertion.assertThat(bot.text(2)).isNotEnabled().isEmpty();
// "Enable Auth" checkbox should be unselected and disabled
CheckBoxAssertion.assertThat(bot.checkBox(1)).isNotEnabled().isNotChecked();
// "Path" for certs should be disabled and empty
TextAssertion.assertThat(bot.text(3)).isNotEnabled().isEmpty();
}
@Test
public void shouldShowDefaultUnixSocketConnectionSettingsWithValidConnectionAvailable() {
// given
MockDockerConnectionSettingsFinder.validUnixSocketConnectionAvailable();
// when
addConnectionButton.click();
// then
// Connection name
TextAssertion.assertThat(bot.text(0)).isEnabled().textEquals("mock");
// "Use custom connection settings" should be enabled but unchecked
CheckBoxAssertion.assertThat(bot.checkBox(0)).isEnabled().isNotChecked();
// "Unix socket" radio should be disabled and selected
RadioAssertion.assertThat(bot.radio(0)).isNotEnabled().isSelected();
// "Unix socket path" text should be disabled and not empty
TextAssertion.assertThat(bot.text(1)).isNotEnabled().textEquals("unix:///var/run/docker.sock");
// "TCP Connection" radio should be unselected and disabled
RadioAssertion.assertThat(bot.radio(1)).isNotEnabled().isNotSelected();
// "URI" should be disabled and empty
TextAssertion.assertThat(bot.text(2)).isNotEnabled().isEmpty();
// "Enable Auth" checkbox should be unselected and disabled
CheckBoxAssertion.assertThat(bot.checkBox(1)).isNotEnabled().isNotChecked();
// "Path" for certs should be disabled but not empty
TextAssertion.assertThat(bot.text(3)).isNotEnabled().isEmpty();
}
@Test
public void shouldShowDefaultTCPSettingsWithValidConnectionAvailable() {
// given
MockDockerConnectionSettingsFinder.validTCPConnectionAvailable();
// when
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// then
// Connection name
TextAssertion.assertThat(bot.text(0)).isEnabled().textEquals("mock");
// "Use custom connection settings" should be enabled but unchecked
CheckBoxAssertion.assertThat(bot.checkBox(0)).isEnabled().isNotChecked();
// "Unix socket" radio should be disabled and unselected
RadioAssertion.assertThat(bot.radio(0)).isNotEnabled().isNotSelected();
// "Unix socket path" text should be disabled and not empty
TextAssertion.assertThat(bot.text(1)).isNotEnabled().isEmpty();
// "TCP Connection" radio should be selected but diabled
RadioAssertion.assertThat(bot.radio(1)).isNotEnabled().isSelected();
// "URI" should be disabled but not empty
TextAssertion.assertThat(bot.text(2)).isNotEnabled().textEquals("https://1.2.3.4:1234");
// "Enable Auth" checkbox should be selected but disabled
CheckBoxAssertion.assertThat(bot.checkBox(1)).isNotEnabled().isChecked();
// "Path" for certs should be disabled but not empty
TextAssertion.assertThat(bot.text(3)).isNotEnabled().textEquals("/path/to/certs");
}
@Test
public void shouldAddConnectionToDockerExplorerView() throws IOException {
// given
final File dockerSocketTmpFile = File.createTempFile("docker", ".sock");
MockDockerConnectionSettingsFinder.validUnixSocketConnectionAvailable("Mock",
"unix://" + dockerSocketTmpFile.getAbsolutePath());
// when open wizard
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// when click on "OK"
bot.button("Finish").click();
// then the Docker Explorer view should have a connection named "Mock"
SWTBotTreeItemAssertions.assertThat(SWTUtils.getTreeItem(dockerExplorerViewBot.bot().tree(), "Mock"))
.isNotNull();
}
@Test
public void shouldNotAllowNewConnectionWithDifferentNameAndSameUnixSocketSettings() throws IOException {
// given
final String dockerSocketTmpPath = File.createTempFile("docker", ".sock").getAbsolutePath();
MockDockerConnectionSettingsFinder.validUnixSocketConnectionAvailable("Mock", "unix://" + dockerSocketTmpPath);
// add an existing connection based on the settings above
configureUnixSocketConnection("Mock", dockerSocketTmpPath);
// when open wizard
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// when changing connection name
bot.text(0).setText("foo");
// then the wizard should not allow for completion because a connection
// with the connection settings already exists.
ButtonAssertion.assertThat(bot.button("Finish")).isNotEnabled();
}
@Test
public void shouldNotAllowNewConnectionWithDifferentNameAndSameTCPSettings() throws IOException {
// given
MockDockerConnectionSettingsFinder.validTCPConnectionAvailable("Mock", "https://foo:1234", null);
// add an existing connection based on the settings above
configureTCPConnection("Mock", "https://foo:1234");
// when open wizard
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// when changing connection name
bot.text(0).setText("foo");
// then the wizard should not allow for completion because a connection
// with the connection settings already exists.
ButtonAssertion.assertThat(bot.button("Finish")).isNotEnabled();
}
@Test
public void shouldAllowNewConnectionWithDifferentNameAndUnixSettings() throws IOException {
// given
final String dockerSocketTmpPath = File.createTempFile("docker", ".sock").getAbsolutePath();
configureUnixSocketConnection("Bar", dockerSocketTmpPath);
MockDockerConnectionSettingsFinder.validUnixSocketConnectionAvailable("Mock", "unix://" + dockerSocketTmpPath);
final String otherDockerSocketTmpPath = File.createTempFile("docker", ".sock").getAbsolutePath();
// when open wizard
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// when changing connection name
bot.text(0).setText("foo");
bot.checkBox(0).select();
bot.text(1).setText(otherDockerSocketTmpPath);
// then the wizard should not allow for completion because a connection
// with the connection settings already exists.
ButtonAssertion.assertThat(bot.button("Finish")).isEnabled();
}
@Test
public void shouldAllowNewConnectionWithDifferentNameAndTCPSettings() throws IOException {
// given
MockDockerConnectionSettingsFinder.validTCPConnectionAvailable("Mock", "https://foo:1234", null);
// add an existing connection based on the settings above
configureTCPConnection("Mock", "https://foo");
// when open wizard
addConnectionButton.click();
bot.waitUntil(Conditions.shellIsActive(WizardMessages.getString("NewDockerConnection.title"))); //$NON-NLS-1$
// when changing connection name
bot.text(0).setText("foo");
bot.checkBox(0).select();
bot.text(2).setText("https://bar:1234");
// then the wizard should not allow for completion because a connection
// with the connection settings already exists.
ButtonAssertion.assertThat(bot.button("Finish")).isEnabled();
}
@Test
public void shouldPopulateConnectionWithClipboard() {
verifyPopulateConnectionWithClipboard(DND.CLIPBOARD);
}
@Test
public void shouldPopulateConnectionWithSelectionClipboard() {
// SELECTION_CLIPBOARD does not seem to be supported on platforms other
// than Linux (GTK/Motif)
Assume.assumeTrue("This test only runs on Linux", SystemUtils.isLinux());
verifyPopulateConnectionWithClipboard(DND.SELECTION_CLIPBOARD);
}
private void verifyPopulateConnectionWithClipboard(final int clipboardType) {
// given
final String[] connectionData = new String[] {
"DOCKER_HOST=https://1.2.3.4:1234 DOCKER_CERT_PATH=/path/to/certs DOCKER_TLS_VERIFY=1" };
Display.getDefault().syncExec(() -> {
Clipboard clip = new Clipboard(Display.getCurrent());
clip.setContents(connectionData, new Transfer[] { TextTransfer.getInstance() }, clipboardType);
});
// when
addConnectionButton.click();
// then
// Connection name
TextAssertion.assertThat(bot.text(0)).isEnabled().isEmpty();
// "Use custom connection settings" should be enabled and checked
CheckBoxAssertion.assertThat(bot.checkBox(0)).isEnabled().isChecked();
// "Unix socket" radio should be enabled and unselected
RadioAssertion.assertThat(bot.radio(0)).isEnabled().isNotSelected();
// "Unix socket path" text should be disabled and empty
TextAssertion.assertThat(bot.text(1)).isNotEnabled().isEmpty();
// "TCP Connection" radio should be enabled and selected
RadioAssertion.assertThat(bot.radio(1)).isEnabled().isSelected();
// "URI" should be enabled and not empty
TextAssertion.assertThat(bot.text(2)).isEnabled().textEquals("https://1.2.3.4:1234");
// "Enable Auth" checkbox should be enabled and selected
CheckBoxAssertion.assertThat(bot.checkBox(1)).isEnabled().isChecked();
// "Path" for certs should be enabled and not empty
TextAssertion.assertThat(bot.text(3)).isEnabled().textEquals("/path/to/certs");
// Close wizard
bot.button("Cancel").click();
}
}
|
