/
ServerDockerExecutor.java
772 lines (641 loc) · 28.8 KB
/
ServerDockerExecutor.java
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
package io.onedev.server.plugin.executor.serverdocker;
import com.google.common.base.Preconditions;
import io.onedev.agent.BuiltInRegistryLogin;
import io.onedev.agent.DockerExecutorUtils;
import io.onedev.agent.ExecutorUtils;
import io.onedev.agent.job.ImageMappingFacade;
import io.onedev.agent.job.RegistryLoginFacade;
import io.onedev.commons.bootstrap.Bootstrap;
import io.onedev.commons.loader.AppLoader;
import io.onedev.commons.utils.ExplicitException;
import io.onedev.commons.utils.FileUtils;
import io.onedev.commons.utils.StringUtils;
import io.onedev.commons.utils.TaskLogger;
import io.onedev.commons.utils.command.Commandline;
import io.onedev.commons.utils.command.LineConsumer;
import io.onedev.k8shelper.*;
import io.onedev.server.OneDev;
import io.onedev.server.annotation.*;
import io.onedev.server.cluster.ClusterManager;
import io.onedev.server.cluster.ClusterTask;
import io.onedev.server.entitymanager.SettingManager;
import io.onedev.server.git.location.GitLocation;
import io.onedev.server.job.*;
import io.onedev.server.model.support.ImageMapping;
import io.onedev.server.model.support.administration.jobexecutor.JobExecutor;
import io.onedev.server.model.support.administration.jobexecutor.RegistryLogin;
import io.onedev.server.model.support.administration.jobexecutor.RegistryLoginAware;
import io.onedev.server.plugin.executor.serverdocker.ServerDockerExecutor.TestData;
import io.onedev.server.terminal.CommandlineShell;
import io.onedev.server.terminal.Shell;
import io.onedev.server.terminal.Terminal;
import io.onedev.server.validation.Validatable;
import io.onedev.server.web.util.Testable;
import org.apache.commons.lang3.SystemUtils;
import javax.annotation.Nullable;
import javax.validation.ConstraintValidatorContext;
import javax.validation.constraints.NotEmpty;
import java.io.File;
import java.io.Serializable;
import java.util.*;
import java.util.concurrent.atomic.AtomicBoolean;
import static io.onedev.agent.DockerExecutorUtils.changeOwner;
import static io.onedev.agent.DockerExecutorUtils.*;
import static io.onedev.k8shelper.KubernetesHelper.*;
import static java.util.stream.Collectors.toList;
@Editable(order=ServerDockerExecutor.ORDER, name="Server Docker Executor",
description="This executor runs build jobs as docker containers on OneDev server")
@ClassValidating
@Horizontal
public class ServerDockerExecutor extends JobExecutor implements RegistryLoginAware, Testable<TestData>, Validatable {
private static final long serialVersionUID = 1L;
static final int ORDER = 50;
private List<RegistryLogin> registryLogins = new ArrayList<>();
private String runOptions;
private String dockerExecutable;
private boolean mountDockerSock;
private String dockerSockPath;
private String dockerBuilder = "onedev";
private String networkOptions;
private String cpuLimit;
private String memoryLimit;
private String concurrency;
private List<ImageMapping> imageMappings = new ArrayList<>();
private transient volatile File hostBuildHome;
private transient volatile LeafFacade runningStep;
private transient volatile String containerName;
private transient List<ImageMappingFacade> imageMappingFacades;
private static volatile String hostInstallPath;
@Editable(order=400, description="Specify login information for docker registries if necessary")
@Override
public List<RegistryLogin> getRegistryLogins() {
return registryLogins;
}
public void setRegistryLogins(List<RegistryLogin> registryLogins) {
this.registryLogins = registryLogins;
}
@Editable(order=450, placeholder = "Number of CPU Cores", description = "" +
"Specify max number of jobs/services this executor can run concurrently. " +
"Leave empty to set as CPU cores")
@Numeric
public String getConcurrency() {
return concurrency;
}
public void setConcurrency(String concurrency) {
this.concurrency = concurrency;
}
@Editable(order=510, group="More Settings", placeholder="Default", description="Optionally specify docker sock to use. "
+ "Defaults to <i>/var/run/docker.sock</i> on Linux, and <i>//./pipe/docker_engine</i> on Windows")
public String getDockerSockPath() {
return dockerSockPath;
}
public void setDockerSockPath(String dockerSockPath) {
this.dockerSockPath = dockerSockPath;
}
@Editable(order=515, group="More Settings", name="Buildx Builder", description = "Specify dockerx builder used to " +
"build docker image. OneDev will create the builder automatically if it does not exist. Check " +
"<a href='https://docs.onedev.io/tutorials/cicd/insecure-docker-registry' target='_blank'>this tutorial</a> " +
"on how to customize the builder for instance to allow publishing to insecure registries")
@NotEmpty
public String getDockerBuilder() {
return dockerBuilder;
}
public void setDockerBuilder(String dockerBuilder) {
this.dockerBuilder = dockerBuilder;
}
@Editable(order=520, group="Privilege Settings", description="Whether or not to mount docker sock into job container to "
+ "support docker operations in job commands<br>"
+ "<b class='text-danger'>WARNING</b>: Malicious jobs can take control of whole OneDev "
+ "by operating the mounted docker sock. You should configure job requirement above to make sure the " +
"executor can only be used by trusted jobs if this option is enabled")
public boolean isMountDockerSock() {
return mountDockerSock;
}
public void setMountDockerSock(boolean mountDockerSock) {
this.mountDockerSock = mountDockerSock;
}
@Editable(order=40, group="Resource Settings", placeholder = "No limit", description = "" +
"Optionally specify cpu limit of each job/service using this executor. This will be " +
"used as option <a href='https://docs.docker.com/config/containers/resource_constraints/#cpu' target='_blank'>--cpus</a> " +
"of relevant containers")
public String getCpuLimit() {
return cpuLimit;
}
public void setCpuLimit(String cpuLimit) {
this.cpuLimit = cpuLimit;
}
@Editable(order=50, group="Resource Settings", placeholder = "No limit", description = "" +
"Optionally specify memory limit of each job/service using this executor. This will be " +
"used as option <a href='https://docs.docker.com/config/containers/resource_constraints/#memory' target='_blank'>--memory</a> " +
"of relevant containers")
public String getMemoryLimit() {
return memoryLimit;
}
public void setMemoryLimit(String memoryLimit) {
this.memoryLimit = memoryLimit;
}
@Editable(order=50050, group="More Settings", description="Optionally specify docker options to run container. " +
"Multiple options should be separated by space, and single option containing spaces should be quoted")
@ReservedOptions({"-w", "(--workdir)=.*", "-d", "--detach", "-a", "--attach", "-t", "--tty",
"-i", "--interactive", "--rm", "--restart", "(--name)=.*"})
public String getRunOptions() {
return runOptions;
}
public void setRunOptions(String runOptions) {
this.runOptions = runOptions;
}
@Editable(order=50075, group="More Settings", description = "Optionally specify docker options to create network. " +
"Multiple options should be separated by space, and single option containing spaces should be quoted")
@ReservedOptions({"-d", "(--driver)=.*"})
public String getNetworkOptions() {
return networkOptions;
}
public void setNetworkOptions(String networkOptions) {
this.networkOptions = networkOptions;
}
@Editable(order=50100, group="More Settings", placeholder="Use default", description=""
+ "Optionally specify docker executable, for instance <i>/usr/local/bin/docker</i>. "
+ "Leave empty to use docker executable in PATH")
public String getDockerExecutable() {
return dockerExecutable;
}
public void setDockerExecutable(String dockerExecutable) {
this.dockerExecutable = dockerExecutable;
}
@Editable(order=50150, group="More Settings", description = "Optionally maps a docker image to a different " +
"image. The first matching entry will take effect, or image will remain unchanged if no matching " +
"entries found")
public List<ImageMapping> getImageMappings() {
return imageMappings;
}
public void setImageMappings(List<ImageMapping> imageMappings) {
this.imageMappings = imageMappings;
}
private Commandline newDocker() {
Commandline docker;
if (getDockerExecutable() != null)
docker = new Commandline(getDockerExecutable());
else if (SystemUtils.IS_OS_MAC_OSX && new File("/usr/local/bin/docker").exists())
docker = new Commandline("/usr/local/bin/docker");
else
docker = new Commandline("docker");
useDockerSock(docker, getDockerSockPath());
return docker;
}
private ClusterManager getClusterManager() {
return OneDev.getInstance(ClusterManager.class);
}
private SettingManager getSettingManager() {
return OneDev.getInstance(SettingManager.class);
}
private JobManager getJobManager() {
return OneDev.getInstance(JobManager.class);
}
private ResourceAllocator getResourceAllocator() {
return OneDev.getInstance(ResourceAllocator.class);
}
private int getConcurrencyNumber() {
if (getConcurrency() != null)
return Integer.parseInt(getConcurrency());
else
return 0;
}
@Override
public boolean execute(JobContext jobContext, TaskLogger jobLogger) {
ClusterTask<Boolean> runnable = () -> getJobManager().runJob(jobContext, new JobRunnable() {
private static final long serialVersionUID = 1L;
@Override
public boolean run(TaskLogger jobLogger) {
notifyJobRunning(jobContext.getBuildId(), null);
if (OneDev.getK8sService() != null) {
throw new ExplicitException(""
+ "OneDev running inside kubernetes cluster does not support server docker executor. "
+ "Please use kubernetes executor instead");
}
hostBuildHome = new File(Bootstrap.getTempDir(),
"onedev-build-" + jobContext.getProjectId() + "-" + jobContext.getBuildNumber());
FileUtils.createDir(hostBuildHome);
try {
String network = getName() + "-" + jobContext.getProjectId() + "-"
+ jobContext.getBuildNumber() + "-" + jobContext.getRetried();
String localServer = getClusterManager().getLocalServerAddress();
jobLogger.log(String.format("Executing job (executor: %s, server: %s, network: %s)...",
getName(), localServer, network));
createNetwork(newDocker(), network, getNetworkOptions(), jobLogger);
try {
OsInfo osInfo = OneDev.getInstance(OsInfo.class);
var serverUrl = getSettingManager().getSystemSetting().getServerUrl();
for (var jobService : jobContext.getServices()) {
var docker = newDocker();
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), jobService.getBuiltInRegistryAccessToken());
callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
startService(docker, network, jobService, osInfo, getImageMappingFacades(),
getCpuLimit(), getMemoryLimit(), jobLogger);
return null;
});
}
File hostWorkspace = new File(hostBuildHome, "workspace");
File hostUserHome = new File(hostBuildHome, "user");
FileUtils.createDir(hostWorkspace);
FileUtils.createDir(hostUserHome);
var cacheHelper = new ServerCacheHelper(hostBuildHome, jobContext, jobLogger);
try {
jobLogger.log("Copying job dependencies...");
getJobManager().copyDependencies(jobContext, hostWorkspace);
String containerBuildHome;
String containerWorkspace;
String containerTrustCerts;
if (SystemUtils.IS_OS_WINDOWS) {
containerBuildHome = "C:\\onedev-build";
containerWorkspace = "C:\\onedev-build\\workspace";
containerTrustCerts = "C:\\onedev-build\\trust-certs.pem";
} else {
containerBuildHome = "/onedev-build";
containerWorkspace = "/onedev-build/workspace";
containerTrustCerts = "/onedev-build/trust-certs.pem";
}
var ownerChanged = new AtomicBoolean(false);
getJobManager().reportJobWorkspace(jobContext, containerWorkspace);
CompositeFacade entryFacade = new CompositeFacade(jobContext.getActions());
var successful = entryFacade.execute(new LeafHandler() {
private int runStepContainer(Commandline docker, String image, @Nullable String runAs,
@Nullable String entrypoint, List<String> arguments,
Map<String, String> environments, @Nullable String workingDir,
Map<String, String> volumeMounts, List<Integer> position, boolean useTTY) {
image = mapImage(image);
containerName = network + "-step-" + stringifyStepPosition(position);
try {
var useProcessIsolation = isUseProcessIsolation(docker, image, osInfo, jobLogger);
docker.clearArgs();
docker.addArgs("run", "--pull=always", "--name=" + containerName, "--network=" + network);
if (runAs != null)
docker.addArgs("--user", runAs);
else if (!SystemUtils.IS_OS_WINDOWS)
docker.addArgs("--user", "0:0");
if (getCpuLimit() != null)
docker.addArgs("--cpus", getCpuLimit());
if (getMemoryLimit() != null)
docker.addArgs("--memory", getMemoryLimit());
if (getRunOptions() != null)
docker.addArgs(StringUtils.parseQuoteTokens(getRunOptions()));
docker.addArgs("-v", getHostPath(hostBuildHome.getAbsolutePath()) + ":" + containerBuildHome);
for (Map.Entry<String, String> entry : volumeMounts.entrySet()) {
if (entry.getKey().contains(".."))
throw new ExplicitException("Volume mount source path should not contain '..'");
String hostPath = getHostPath(new File(hostWorkspace, entry.getKey()).getAbsolutePath());
docker.addArgs("-v", hostPath + ":" + entry.getValue());
}
if (entrypoint != null)
docker.addArgs("-w", containerWorkspace);
else if (workingDir != null)
docker.addArgs("-w", workingDir);
cacheHelper.mountVolumes(docker, ServerDockerExecutor.this::getHostPath);
if (isMountDockerSock()) {
if (getDockerSockPath() != null) {
if (SystemUtils.IS_OS_WINDOWS)
docker.addArgs("-v", getDockerSockPath() + "://./pipe/docker_engine");
else
docker.addArgs("-v", getDockerSockPath() + ":/var/run/docker.sock");
} else {
if (SystemUtils.IS_OS_WINDOWS)
docker.addArgs("-v", "//./pipe/docker_engine://./pipe/docker_engine");
else
docker.addArgs("-v", "/var/run/docker.sock:/var/run/docker.sock");
}
}
for (Map.Entry<String, String> entry : environments.entrySet())
docker.addArgs("-e", entry.getKey() + "=" + entry.getValue());
docker.addArgs("-e", "ONEDEV_WORKSPACE=" + containerWorkspace);
if (useTTY)
docker.addArgs("-t");
if (entrypoint != null)
docker.addArgs("--entrypoint=" + entrypoint);
if (useProcessIsolation)
docker.addArgs("--isolation=process");
docker.addArgs(image);
docker.addArgs(arguments.toArray(new String[0]));
docker.processKiller(newDockerKiller(newDocker(), containerName, jobLogger));
var result = docker.execute(ExecutorUtils.newInfoLogger(jobLogger),
ExecutorUtils.newWarningLogger(jobLogger), null);
return result.getReturnCode();
} finally {
containerName = null;
}
}
@Override
public boolean execute(LeafFacade facade, List<Integer> position) {
return ExecutorUtils.runStep(entryFacade, position, jobLogger, () -> {
runningStep = facade;
try {
return doExecute(facade, position);
} finally {
runningStep = null;
}
});
}
private boolean doExecute(LeafFacade facade, List<Integer> position) {
if (ownerChanged.get() && !Bootstrap.isInDocker()) {
changeOwner(hostBuildHome, getOwner(), newDocker(), false);
ownerChanged.set(false);
}
if (facade instanceof CommandFacade) {
CommandFacade commandFacade = (CommandFacade) facade;
OsExecution execution = commandFacade.getExecution(osInfo);
if (execution.getImage() == null) {
throw new ExplicitException("This step can only be executed by server shell "
+ "executor or remote shell executor");
}
Commandline entrypoint = getEntrypoint(hostBuildHome, commandFacade, osInfo, position);
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), commandFacade.getBuiltInRegistryAccessToken());
var docker = newDocker();
if (changeOwner(hostBuildHome, execution.getRunAs(), docker, Bootstrap.isInDocker()))
ownerChanged.set(true);
docker.clearArgs();
int exitCode = callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
return runStepContainer(docker, execution.getImage(), execution.getRunAs(),
entrypoint.executable(), entrypoint.arguments(), new HashMap<>(), null,
new HashMap<>(), position, commandFacade.isUseTTY());
});
if (exitCode != 0) {
jobLogger.error("Command exited with code " + exitCode);
return false;
}
} else if (facade instanceof BuildImageFacade) {
var buildImageFacade = (BuildImageFacade) facade;
var docker = newDocker();
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), buildImageFacade.getBuiltInRegistryAccessToken());
callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
buildImage(docker, getDockerBuilder(), buildImageFacade, hostBuildHome, jobLogger);
return null;
});
} else if (facade instanceof RunImagetoolsFacade) {
var runImagetoolsFacade = (RunImagetoolsFacade) facade;
var docker = newDocker();
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), runImagetoolsFacade.getBuiltInRegistryAccessToken());
callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
runImagetools(docker, runImagetoolsFacade, hostBuildHome, jobLogger);
return null;
});
} else if (facade instanceof PruneBuilderCacheFacade) {
var pruneBuilderCacheFacade = (PruneBuilderCacheFacade) facade;
var docker = newDocker();
callWithDockerConfig(docker, new ArrayList<>(), null, () -> {
pruneBuilderCache(docker, getDockerBuilder(), pruneBuilderCacheFacade,
hostBuildHome, jobLogger);
return null;
});
} else if (facade instanceof RunContainerFacade) {
RunContainerFacade runContainerFacade = (RunContainerFacade) facade;
OsContainer container = runContainerFacade.getContainer(osInfo);
List<String> arguments = new ArrayList<>();
if (container.getArgs() != null)
arguments.addAll(Arrays.asList(StringUtils.parseQuoteTokens(container.getArgs())));
var builtInRegistryLogin = new BuiltInRegistryLogin(serverUrl,
jobContext.getJobToken(), runContainerFacade.getBuiltInRegistryAccessToken());
var docker = newDocker();
if (changeOwner(hostBuildHome, container.getRunAs(), docker, Bootstrap.isInDocker()))
ownerChanged.set(true);
docker.clearArgs();
int exitCode = callWithDockerConfig(docker, getRegistryLoginFacades(), builtInRegistryLogin, () -> {
return runStepContainer(docker, container.getImage(), container.getRunAs(), null,
arguments, container.getEnvMap(), container.getWorkingDir(), container.getVolumeMounts(),
position, runContainerFacade.isUseTTY());
});
if (exitCode != 0) {
jobLogger.error("Container exited with code " + exitCode);
return false;
}
} else if (facade instanceof CheckoutFacade) {
CheckoutFacade checkoutFacade = (CheckoutFacade) facade;
jobLogger.log("Checking out code...");
Commandline git = new Commandline(AppLoader.getInstance(GitLocation.class).getExecutable());
git.environments().put("HOME", hostUserHome.getAbsolutePath());
checkoutFacade.setupWorkingDir(git, hostWorkspace);
if (!Bootstrap.isInDocker()) {
checkoutFacade.setupSafeDirectory(git, containerWorkspace,
newInfoLogger(jobLogger), newErrorLogger(jobLogger));
}
File trustCertsFile = new File(hostBuildHome, "trust-certs.pem");
installGitCert(git, Bootstrap.getTrustCertsDir(),
trustCertsFile, containerTrustCerts,
ExecutorUtils.newInfoLogger(jobLogger),
ExecutorUtils.newWarningLogger(jobLogger));
CloneInfo cloneInfo = checkoutFacade.getCloneInfo();
cloneInfo.writeAuthData(hostUserHome, git, true,
ExecutorUtils.newInfoLogger(jobLogger),
ExecutorUtils.newWarningLogger(jobLogger));
if (trustCertsFile.exists())
git.addArgs("-c", "http.sslCAInfo=" + trustCertsFile.getAbsolutePath());
int cloneDepth = checkoutFacade.getCloneDepth();
cloneRepository(git, jobContext.getProjectGitDir(), cloneInfo.getCloneUrl(),
jobContext.getRefName(), jobContext.getCommitId().name(),
checkoutFacade.isWithLfs(), checkoutFacade.isWithSubmodules(),
cloneDepth, ExecutorUtils.newInfoLogger(jobLogger), ExecutorUtils.newWarningLogger(jobLogger));
} else if (facade instanceof SetupCacheFacade) {
SetupCacheFacade setupCacheFacade = (SetupCacheFacade) facade;
cacheHelper.setupCache(setupCacheFacade);
} else if (facade instanceof ServerSideFacade) {
ServerSideFacade serverSideFacade = (ServerSideFacade) facade;
return serverSideFacade.execute(hostBuildHome, new ServerSideFacade.Runner() {
@Override
public ServerStepResult run(File inputDir, Map<String, String> placeholderValues) {
return getJobManager().runServerStep(jobContext, position, inputDir,
placeholderValues, false, jobLogger);
}
});
} else {
throw new ExplicitException("Unexpected step type: " + facade.getClass());
}
return true;
}
@Override
public void skip(LeafFacade facade, List<Integer> position) {
jobLogger.notice("Step \"" + entryFacade.getPathAsString(position) + "\" is skipped");
}
}, new ArrayList<>());
cacheHelper.buildFinished();
return successful;
} finally {
// Fix https://code.onedev.io/onedev/server/~issues/597
if (SystemUtils.IS_OS_WINDOWS) {
FileUtils.deleteDir(hostWorkspace);
}
}
} finally {
deleteNetwork(newDocker(), network, jobLogger);
}
} finally {
synchronized (hostBuildHome) {
deleteDir(hostBuildHome, newDocker(), Bootstrap.isInDocker());
}
}
}
@Override
public void resume(JobContext jobContext) {
if (hostBuildHome != null) synchronized (hostBuildHome) {
if (hostBuildHome.exists())
FileUtils.touchFile(new File(hostBuildHome, "continue"));
}
}
@Override
public Shell openShell(JobContext jobContext, Terminal terminal) {
String containerNameCopy = containerName;
if (containerNameCopy != null) {
Commandline docker = newDocker();
docker.addArgs("exec", "-it", containerNameCopy);
if (runningStep instanceof CommandFacade) {
CommandFacade commandStep = (CommandFacade) runningStep;
docker.addArgs(commandStep.getShell(SystemUtils.IS_OS_WINDOWS, null));
} else if (SystemUtils.IS_OS_WINDOWS) {
docker.addArgs("cmd");
} else {
docker.addArgs("sh");
}
return new CommandlineShell(terminal, docker);
} else if (hostBuildHome != null) {
Commandline shell;
if (SystemUtils.IS_OS_WINDOWS)
shell = new Commandline("cmd");
else
shell = new Commandline("sh");
shell.workingDir(new File(hostBuildHome, "workspace"));
return new CommandlineShell(terminal, shell);
} else {
throw new ExplicitException("Shell not ready");
}
}
});
jobLogger.log("Pending resource allocation...");
return getResourceAllocator().runServerJob(getName(), getConcurrencyNumber(),
jobContext.getServices().size() + 1, runnable);
}
@Override
public boolean isValid(ConstraintValidatorContext context) {
boolean isValid = true;
Set<String> registryUrls = new HashSet<>();
for (RegistryLogin login: getRegistryLogins()) {
if (!registryUrls.add(login.getRegistryUrl())) {
isValid = false;
String message;
if (login.getRegistryUrl() != null)
message = "Duplicate login entry for registry '" + login.getRegistryUrl() + "'";
else
message = "Duplicate login entry for official registry";
context.buildConstraintViolationWithTemplate(message)
.addPropertyNode("registryLogins").addConstraintViolation();
break;
}
}
if (!isValid)
context.disableDefaultConstraintViolation();
return isValid;
}
private String getHostPath(String path) {
String installPath = Bootstrap.installDir.getAbsolutePath();
Preconditions.checkState(path.startsWith(installPath + "/")
|| path.startsWith(installPath + "\\"));
if (hostInstallPath == null) {
if (Bootstrap.isInDocker())
hostInstallPath = DockerExecutorUtils.getHostPath(newDocker(), installPath);
else
hostInstallPath = installPath;
}
return hostInstallPath + path.substring(installPath.length());
}
private List<ImageMappingFacade> getImageMappingFacades() {
if (imageMappingFacades == null)
imageMappingFacades = getImageMappings().stream().map(it->it.getFacade()).collect(toList());
return imageMappingFacades;
}
protected Collection<RegistryLoginFacade> getRegistryLoginFacades() {
var facades = new ArrayList<RegistryLoginFacade>();
for (var login: getRegistryLogins())
facades.add(login.getFacade());
return facades;
}
private String mapImage(String image) {
return ImageMappingFacade.map(getImageMappingFacades(), image);
}
@Override
public void test(TestData testData, TaskLogger jobLogger) {
var docker = newDocker();
callWithDockerConfig(docker, getRegistryLoginFacades(), null, () -> {
File workspaceDir = null;
try {
workspaceDir = FileUtils.createTempDir("workspace");
jobLogger.log("Testing specified docker image...");
docker.clearArgs();
docker.addArgs("run", "--rm");
if (getCpuLimit() != null)
docker.addArgs("--cpus", getCpuLimit());
if (getMemoryLimit() != null)
docker.addArgs("--memory", getMemoryLimit());
if (getRunOptions() != null)
docker.addArgs(StringUtils.parseQuoteTokens(getRunOptions()));
String containerWorkspacePath;
if (SystemUtils.IS_OS_WINDOWS)
containerWorkspacePath = "C:\\onedev-build\\workspace";
else
containerWorkspacePath = "/onedev-build/workspace";
docker.addArgs("-v", getHostPath(workspaceDir.getAbsolutePath()) + ":" + containerWorkspacePath);
docker.addArgs("-w", containerWorkspacePath);
docker.addArgs(testData.getDockerImage());
if (SystemUtils.IS_OS_WINDOWS)
docker.addArgs("cmd", "/c", "echo hello from container");
else
docker.addArgs("sh", "-c", "echo hello from container");
docker.execute(new LineConsumer() {
@Override
public void consume(String line) {
jobLogger.log(line);
}
}, new LineConsumer() {
@Override
public void consume(String line) {
jobLogger.log(line);
}
}).checkReturnCode();
} finally {
if (workspaceDir != null)
FileUtils.deleteDir(workspaceDir);
}
if (!SystemUtils.IS_OS_WINDOWS) {
jobLogger.log("Checking busybox availability...");
docker.clearArgs();
docker.addArgs("run", "--rm", "busybox", "sh", "-c", "echo hello from busybox");
docker.execute(new LineConsumer() {
@Override
public void consume(String line) {
jobLogger.log(line);
}
}, new LineConsumer() {
@Override
public void consume(String line) {
jobLogger.log(line);
}
}).checkReturnCode();
}
Commandline git = new Commandline(AppLoader.getInstance(GitLocation.class).getExecutable());
KubernetesHelper.testGitLfsAvailability(git, jobLogger);
return null;
});
}
@Editable(name="Specify a Docker Image to Test Against")
public static class TestData implements Serializable {
private static final long serialVersionUID = 1L;
private String dockerImage;
@Editable
@OmitName
@NotEmpty
public String getDockerImage() {
return dockerImage;
}
public void setDockerImage(String dockerImage) {
this.dockerImage = dockerImage;
}
}
}