-
Notifications
You must be signed in to change notification settings - Fork 3
/
dagger.gen.go
8710 lines (7109 loc) · 222 KB
/
dagger.gen.go
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
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by dagger. DO NOT EDIT.
package dagger
import (
"context"
"encoding/json"
"errors"
"fmt"
"reflect"
"strings"
"github.com/vektah/gqlparser/v2/gqlerror"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/trace"
"dagger.io/dagger/querybuilder"
)
func Tracer() trace.Tracer {
return otel.Tracer("dagger.io/sdk.go")
}
// reassigned at runtime after the span is initialized
var marshalCtx = context.Background()
// assertNotNil panic if the given value is nil.
// This function is used to validate that input with pointer type are not nil.
// See https://github.com/dagger/dagger/issues/5696 for more context.
func assertNotNil(argName string, value any) {
// We use reflect because just comparing value to nil is not working since
// the value is wrapped into a type when passed as parameter.
// E.g., nil become (*dagger.File)(nil).
if reflect.ValueOf(value).IsNil() {
panic(fmt.Sprintf("unexpected nil pointer for argument %q", argName))
}
}
type DaggerObject = querybuilder.GraphQLMarshaller
// getCustomError parses a GraphQL error into a more specific error type.
func getCustomError(err error) error {
var gqlErr *gqlerror.Error
if !errors.As(err, &gqlErr) {
return nil
}
ext := gqlErr.Extensions
typ, ok := ext["_type"].(string)
if !ok {
return nil
}
if typ == "EXEC_ERROR" {
e := &ExecError{
original: err,
}
if code, ok := ext["exitCode"].(float64); ok {
e.ExitCode = int(code)
}
if args, ok := ext["cmd"].([]interface{}); ok {
cmd := make([]string, len(args))
for i, v := range args {
cmd[i] = v.(string)
}
e.Cmd = cmd
}
if stdout, ok := ext["stdout"].(string); ok {
e.Stdout = stdout
}
if stderr, ok := ext["stderr"].(string); ok {
e.Stderr = stderr
}
return e
}
return nil
}
// ExecError is an API error from an exec operation.
type ExecError struct {
original error
Cmd []string
ExitCode int
Stdout string
Stderr string
}
func (e *ExecError) Error() string {
// As a default when just printing the error, include the stdout
// and stderr for visibility
msg := e.Message()
if strings.TrimSpace(e.Stdout) != "" {
msg += "\nStdout:\n" + e.Stdout
}
if strings.TrimSpace(e.Stderr) != "" {
msg += "\nStderr:\n" + e.Stderr
}
return msg
}
func (e *ExecError) Message() string {
return e.original.Error()
}
func (e *ExecError) Unwrap() error {
return e.original
}
// The `CacheVolumeID` scalar type represents an identifier for an object of type CacheVolume.
type CacheVolumeID string
// The `ContainerID` scalar type represents an identifier for an object of type Container.
type ContainerID string
// The `CurrentModuleID` scalar type represents an identifier for an object of type CurrentModule.
type CurrentModuleID string
// The `DirectoryID` scalar type represents an identifier for an object of type Directory.
type DirectoryID string
// The `EngineCacheEntryID` scalar type represents an identifier for an object of type EngineCacheEntry.
type EngineCacheEntryID string
// The `EngineCacheEntrySetID` scalar type represents an identifier for an object of type EngineCacheEntrySet.
type EngineCacheEntrySetID string
// The `EngineCacheID` scalar type represents an identifier for an object of type EngineCache.
type EngineCacheID string
// The `EngineID` scalar type represents an identifier for an object of type Engine.
type EngineID string
// The `EnumTypeDefID` scalar type represents an identifier for an object of type EnumTypeDef.
type EnumTypeDefID string
// The `EnumValueTypeDefID` scalar type represents an identifier for an object of type EnumValueTypeDef.
type EnumValueTypeDefID string
// The `EnvVariableID` scalar type represents an identifier for an object of type EnvVariable.
type EnvVariableID string
// The `ErrorID` scalar type represents an identifier for an object of type Error.
type ErrorID string
// The `FieldTypeDefID` scalar type represents an identifier for an object of type FieldTypeDef.
type FieldTypeDefID string
// The `FileID` scalar type represents an identifier for an object of type File.
type FileID string
// The `FunctionArgID` scalar type represents an identifier for an object of type FunctionArg.
type FunctionArgID string
// The `FunctionCallArgValueID` scalar type represents an identifier for an object of type FunctionCallArgValue.
type FunctionCallArgValueID string
// The `FunctionCallID` scalar type represents an identifier for an object of type FunctionCall.
type FunctionCallID string
// The `FunctionID` scalar type represents an identifier for an object of type Function.
type FunctionID string
// The `GeneratedCodeID` scalar type represents an identifier for an object of type GeneratedCode.
type GeneratedCodeID string
// The `GitModuleSourceID` scalar type represents an identifier for an object of type GitModuleSource.
type GitModuleSourceID string
// The `GitRefID` scalar type represents an identifier for an object of type GitRef.
type GitRefID string
// The `GitRepositoryID` scalar type represents an identifier for an object of type GitRepository.
type GitRepositoryID string
// The `HostID` scalar type represents an identifier for an object of type Host.
type HostID string
// The `InputTypeDefID` scalar type represents an identifier for an object of type InputTypeDef.
type InputTypeDefID string
// The `InterfaceTypeDefID` scalar type represents an identifier for an object of type InterfaceTypeDef.
type InterfaceTypeDefID string
// An arbitrary JSON-encoded value.
type JSON string
// The `LabelID` scalar type represents an identifier for an object of type Label.
type LabelID string
// The `ListTypeDefID` scalar type represents an identifier for an object of type ListTypeDef.
type ListTypeDefID string
// The `LocalModuleSourceID` scalar type represents an identifier for an object of type LocalModuleSource.
type LocalModuleSourceID string
// The `ModuleDependencyID` scalar type represents an identifier for an object of type ModuleDependency.
type ModuleDependencyID string
// The `ModuleID` scalar type represents an identifier for an object of type Module.
type ModuleID string
// The `ModuleSourceID` scalar type represents an identifier for an object of type ModuleSource.
type ModuleSourceID string
// The `ModuleSourceViewID` scalar type represents an identifier for an object of type ModuleSourceView.
type ModuleSourceViewID string
// The `ObjectTypeDefID` scalar type represents an identifier for an object of type ObjectTypeDef.
type ObjectTypeDefID string
// The platform config OS and architecture in a Container.
//
// The format is [os]/[platform]/[version] (e.g., "darwin/arm64/v7", "windows/amd64", "linux/arm64").
type Platform string
// The `PortID` scalar type represents an identifier for an object of type Port.
type PortID string
// The `ScalarTypeDefID` scalar type represents an identifier for an object of type ScalarTypeDef.
type ScalarTypeDefID string
// The `SecretID` scalar type represents an identifier for an object of type Secret.
type SecretID string
// The `ServiceID` scalar type represents an identifier for an object of type Service.
type ServiceID string
// The `SocketID` scalar type represents an identifier for an object of type Socket.
type SocketID string
// The `SourceMapID` scalar type represents an identifier for an object of type SourceMap.
type SourceMapID string
// The `TerminalID` scalar type represents an identifier for an object of type Terminal.
type TerminalID string
// The `TypeDefID` scalar type represents an identifier for an object of type TypeDef.
type TypeDefID string
// The absence of a value.
//
// A Null Void is used as a placeholder for resolvers that do not return anything.
type Void string
// Key value object that represents a build argument.
type BuildArg struct {
// The build argument name.
Name string `json:"name"`
// The build argument value.
Value string `json:"value"`
}
// Key value object that represents a pipeline label.
type PipelineLabel struct {
// Label name.
Name string `json:"name"`
// Label value.
Value string `json:"value"`
}
// Port forwarding rules for tunneling network traffic.
type PortForward struct {
// Destination port for traffic.
Backend int `json:"backend"`
// Port to expose to clients. If unspecified, a default will be chosen.
Frontend int `json:"frontend"`
// Transport layer protocol to use for traffic.
Protocol NetworkProtocol `json:"protocol,omitempty"`
}
// A directory whose contents persist across runs.
type CacheVolume struct {
query *querybuilder.Selection
id *CacheVolumeID
}
func (r *CacheVolume) WithGraphQLQuery(q *querybuilder.Selection) *CacheVolume {
return &CacheVolume{
query: q,
}
}
// A unique identifier for this CacheVolume.
func (r *CacheVolume) ID(ctx context.Context) (CacheVolumeID, error) {
if r.id != nil {
return *r.id, nil
}
q := r.query.Select("id")
var response CacheVolumeID
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// XXX_GraphQLType is an internal function. It returns the native GraphQL type name
func (r *CacheVolume) XXX_GraphQLType() string {
return "CacheVolume"
}
// XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object
func (r *CacheVolume) XXX_GraphQLIDType() string {
return "CacheVolumeID"
}
// XXX_GraphQLID is an internal function. It returns the underlying type ID
func (r *CacheVolume) XXX_GraphQLID(ctx context.Context) (string, error) {
id, err := r.ID(ctx)
if err != nil {
return "", err
}
return string(id), nil
}
func (r *CacheVolume) MarshalJSON() ([]byte, error) {
id, err := r.ID(marshalCtx)
if err != nil {
return nil, err
}
return json.Marshal(id)
}
// An OCI-compatible container, also known as a Docker container.
type Container struct {
query *querybuilder.Selection
envVariable *string
exitCode *int
export *string
id *ContainerID
imageRef *string
label *string
platform *Platform
publish *string
stderr *string
stdout *string
sync *ContainerID
up *Void
user *string
workdir *string
}
type WithContainerFunc func(r *Container) *Container
// With calls the provided function with current Container.
//
// This is useful for reusability and readability by not breaking the calling chain.
func (r *Container) With(f WithContainerFunc) *Container {
return f(r)
}
func (r *Container) WithGraphQLQuery(q *querybuilder.Selection) *Container {
return &Container{
query: q,
}
}
// Turn the container into a Service.
//
// Be sure to set any exposed ports before this conversion.
func (r *Container) AsService() *Service {
q := r.query.Select("asService")
return &Service{
query: q,
}
}
// ContainerAsTarballOpts contains options for Container.AsTarball
type ContainerAsTarballOpts struct {
// Identifiers for other platform specific containers.
//
// Used for multi-platform images.
PlatformVariants []*Container
// Force each layer of the image to use the specified compression algorithm.
//
// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
ForcedCompression ImageLayerCompression
// Use the specified media types for the image's layers.
//
// Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
MediaTypes ImageMediaTypes
}
// Returns a File representing the container serialized to a tarball.
func (r *Container) AsTarball(opts ...ContainerAsTarballOpts) *File {
q := r.query.Select("asTarball")
for i := len(opts) - 1; i >= 0; i-- {
// `platformVariants` optional argument
if !querybuilder.IsZeroValue(opts[i].PlatformVariants) {
q = q.Arg("platformVariants", opts[i].PlatformVariants)
}
// `forcedCompression` optional argument
if !querybuilder.IsZeroValue(opts[i].ForcedCompression) {
q = q.Arg("forcedCompression", opts[i].ForcedCompression)
}
// `mediaTypes` optional argument
if !querybuilder.IsZeroValue(opts[i].MediaTypes) {
q = q.Arg("mediaTypes", opts[i].MediaTypes)
}
}
return &File{
query: q,
}
}
// ContainerBuildOpts contains options for Container.Build
type ContainerBuildOpts struct {
// Path to the Dockerfile to use.
Dockerfile string
// Target build stage to build.
Target string
// Additional build arguments.
BuildArgs []BuildArg
// Secrets to pass to the build.
//
// They will be mounted at /run/secrets/[secret-name] in the build container
//
// They can be accessed in the Dockerfile using the "secret" mount type and mount path /run/secrets/[secret-name], e.g. RUN --mount=type=secret,id=my-secret curl [http://example.com?token=$(cat /run/secrets/my-secret)](http://example.com?token=$(cat /run/secrets/my-secret))
Secrets []*Secret
}
// Initializes this container from a Dockerfile build.
func (r *Container) Build(context *Directory, opts ...ContainerBuildOpts) *Container {
assertNotNil("context", context)
q := r.query.Select("build")
for i := len(opts) - 1; i >= 0; i-- {
// `dockerfile` optional argument
if !querybuilder.IsZeroValue(opts[i].Dockerfile) {
q = q.Arg("dockerfile", opts[i].Dockerfile)
}
// `target` optional argument
if !querybuilder.IsZeroValue(opts[i].Target) {
q = q.Arg("target", opts[i].Target)
}
// `buildArgs` optional argument
if !querybuilder.IsZeroValue(opts[i].BuildArgs) {
q = q.Arg("buildArgs", opts[i].BuildArgs)
}
// `secrets` optional argument
if !querybuilder.IsZeroValue(opts[i].Secrets) {
q = q.Arg("secrets", opts[i].Secrets)
}
}
q = q.Arg("context", context)
return &Container{
query: q,
}
}
// Retrieves default arguments for future commands.
func (r *Container) DefaultArgs(ctx context.Context) ([]string, error) {
q := r.query.Select("defaultArgs")
var response []string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// ContainerDirectoryOpts contains options for Container.Directory
type ContainerDirectoryOpts struct {
// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
Expand bool
}
// Retrieves a directory at the given path.
//
// Mounts are included.
func (r *Container) Directory(path string, opts ...ContainerDirectoryOpts) *Directory {
q := r.query.Select("directory")
for i := len(opts) - 1; i >= 0; i-- {
// `expand` optional argument
if !querybuilder.IsZeroValue(opts[i].Expand) {
q = q.Arg("expand", opts[i].Expand)
}
}
q = q.Arg("path", path)
return &Directory{
query: q,
}
}
// Retrieves entrypoint to be prepended to the arguments of all commands.
func (r *Container) Entrypoint(ctx context.Context) ([]string, error) {
q := r.query.Select("entrypoint")
var response []string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Retrieves the value of the specified environment variable.
func (r *Container) EnvVariable(ctx context.Context, name string) (string, error) {
if r.envVariable != nil {
return *r.envVariable, nil
}
q := r.query.Select("envVariable")
q = q.Arg("name", name)
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Retrieves the list of environment variables passed to commands.
func (r *Container) EnvVariables(ctx context.Context) ([]EnvVariable, error) {
q := r.query.Select("envVariables")
q = q.Select("id")
type envVariables struct {
Id EnvVariableID
}
convert := func(fields []envVariables) []EnvVariable {
out := []EnvVariable{}
for i := range fields {
val := EnvVariable{id: &fields[i].Id}
val.query = q.Root().Select("loadEnvVariableFromID").Arg("id", fields[i].Id)
out = append(out, val)
}
return out
}
var response []envVariables
q = q.Bind(&response)
err := q.Execute(ctx)
if err != nil {
return nil, err
}
return convert(response), nil
}
// The exit code of the last executed command.
//
// Returns an error if no command was set.
func (r *Container) ExitCode(ctx context.Context) (int, error) {
if r.exitCode != nil {
return *r.exitCode, nil
}
q := r.query.Select("exitCode")
var response int
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// EXPERIMENTAL API! Subject to change/removal at any time.
//
// Configures all available GPUs on the host to be accessible to this container.
//
// This currently works for Nvidia devices only.
func (r *Container) ExperimentalWithAllGPUs() *Container {
q := r.query.Select("experimentalWithAllGPUs")
return &Container{
query: q,
}
}
// EXPERIMENTAL API! Subject to change/removal at any time.
//
// Configures the provided list of devices to be accessible to this container.
//
// This currently works for Nvidia devices only.
func (r *Container) ExperimentalWithGPU(devices []string) *Container {
q := r.query.Select("experimentalWithGPU")
q = q.Arg("devices", devices)
return &Container{
query: q,
}
}
// ContainerExportOpts contains options for Container.Export
type ContainerExportOpts struct {
// Identifiers for other platform specific containers.
//
// Used for multi-platform image.
PlatformVariants []*Container
// Force each layer of the exported image to use the specified compression algorithm.
//
// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
ForcedCompression ImageLayerCompression
// Use the specified media types for the exported image's layers.
//
// Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.
MediaTypes ImageMediaTypes
// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo").
Expand bool
}
// Writes the container as an OCI tarball to the destination file path on the host.
//
// It can also export platform variants.
func (r *Container) Export(ctx context.Context, path string, opts ...ContainerExportOpts) (string, error) {
if r.export != nil {
return *r.export, nil
}
q := r.query.Select("export")
for i := len(opts) - 1; i >= 0; i-- {
// `platformVariants` optional argument
if !querybuilder.IsZeroValue(opts[i].PlatformVariants) {
q = q.Arg("platformVariants", opts[i].PlatformVariants)
}
// `forcedCompression` optional argument
if !querybuilder.IsZeroValue(opts[i].ForcedCompression) {
q = q.Arg("forcedCompression", opts[i].ForcedCompression)
}
// `mediaTypes` optional argument
if !querybuilder.IsZeroValue(opts[i].MediaTypes) {
q = q.Arg("mediaTypes", opts[i].MediaTypes)
}
// `expand` optional argument
if !querybuilder.IsZeroValue(opts[i].Expand) {
q = q.Arg("expand", opts[i].Expand)
}
}
q = q.Arg("path", path)
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Retrieves the list of exposed ports.
//
// This includes ports already exposed by the image, even if not explicitly added with dagger.
func (r *Container) ExposedPorts(ctx context.Context) ([]Port, error) {
q := r.query.Select("exposedPorts")
q = q.Select("id")
type exposedPorts struct {
Id PortID
}
convert := func(fields []exposedPorts) []Port {
out := []Port{}
for i := range fields {
val := Port{id: &fields[i].Id}
val.query = q.Root().Select("loadPortFromID").Arg("id", fields[i].Id)
out = append(out, val)
}
return out
}
var response []exposedPorts
q = q.Bind(&response)
err := q.Execute(ctx)
if err != nil {
return nil, err
}
return convert(response), nil
}
// ContainerFileOpts contains options for Container.File
type ContainerFileOpts struct {
// Replace "${VAR}" or "$VAR" in the value of path according to the current environment variables defined in the container (e.g. "/$VAR/foo.txt").
Expand bool
}
// Retrieves a file at the given path.
//
// Mounts are included.
func (r *Container) File(path string, opts ...ContainerFileOpts) *File {
q := r.query.Select("file")
for i := len(opts) - 1; i >= 0; i-- {
// `expand` optional argument
if !querybuilder.IsZeroValue(opts[i].Expand) {
q = q.Arg("expand", opts[i].Expand)
}
}
q = q.Arg("path", path)
return &File{
query: q,
}
}
// Initializes this container from a pulled base image.
func (r *Container) From(address string) *Container {
q := r.query.Select("from")
q = q.Arg("address", address)
return &Container{
query: q,
}
}
// A unique identifier for this Container.
func (r *Container) ID(ctx context.Context) (ContainerID, error) {
if r.id != nil {
return *r.id, nil
}
q := r.query.Select("id")
var response ContainerID
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// XXX_GraphQLType is an internal function. It returns the native GraphQL type name
func (r *Container) XXX_GraphQLType() string {
return "Container"
}
// XXX_GraphQLIDType is an internal function. It returns the native GraphQL type name for the ID of this object
func (r *Container) XXX_GraphQLIDType() string {
return "ContainerID"
}
// XXX_GraphQLID is an internal function. It returns the underlying type ID
func (r *Container) XXX_GraphQLID(ctx context.Context) (string, error) {
id, err := r.ID(ctx)
if err != nil {
return "", err
}
return string(id), nil
}
func (r *Container) MarshalJSON() ([]byte, error) {
id, err := r.ID(marshalCtx)
if err != nil {
return nil, err
}
return json.Marshal(id)
}
// The unique image reference which can only be retrieved immediately after the 'Container.From' call.
func (r *Container) ImageRef(ctx context.Context) (string, error) {
if r.imageRef != nil {
return *r.imageRef, nil
}
q := r.query.Select("imageRef")
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// ContainerImportOpts contains options for Container.Import
type ContainerImportOpts struct {
// Identifies the tag to import from the archive, if the archive bundles multiple tags.
Tag string
}
// Reads the container from an OCI tarball.
func (r *Container) Import(source *File, opts ...ContainerImportOpts) *Container {
assertNotNil("source", source)
q := r.query.Select("import")
for i := len(opts) - 1; i >= 0; i-- {
// `tag` optional argument
if !querybuilder.IsZeroValue(opts[i].Tag) {
q = q.Arg("tag", opts[i].Tag)
}
}
q = q.Arg("source", source)
return &Container{
query: q,
}
}
// Retrieves the value of the specified label.
func (r *Container) Label(ctx context.Context, name string) (string, error) {
if r.label != nil {
return *r.label, nil
}
q := r.query.Select("label")
q = q.Arg("name", name)
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Retrieves the list of labels passed to container.
func (r *Container) Labels(ctx context.Context) ([]Label, error) {
q := r.query.Select("labels")
q = q.Select("id")
type labels struct {
Id LabelID
}
convert := func(fields []labels) []Label {
out := []Label{}
for i := range fields {
val := Label{id: &fields[i].Id}
val.query = q.Root().Select("loadLabelFromID").Arg("id", fields[i].Id)
out = append(out, val)
}
return out
}
var response []labels
q = q.Bind(&response)
err := q.Execute(ctx)
if err != nil {
return nil, err
}
return convert(response), nil
}
// Retrieves the list of paths where a directory is mounted.
func (r *Container) Mounts(ctx context.Context) ([]string, error) {
q := r.query.Select("mounts")
var response []string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// The platform this container executes and publishes as.
func (r *Container) Platform(ctx context.Context) (Platform, error) {
if r.platform != nil {
return *r.platform, nil
}
q := r.query.Select("platform")
var response Platform
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// ContainerPublishOpts contains options for Container.Publish
type ContainerPublishOpts struct {
// Identifiers for other platform specific containers.
//
// Used for multi-platform image.
PlatformVariants []*Container
// Force each layer of the published image to use the specified compression algorithm.
//
// If this is unset, then if a layer already has a compressed blob in the engine's cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine's cache, then it will be compressed using Gzip.
ForcedCompression ImageLayerCompression
// Use the specified media types for the published image's layers.
//
// Defaults to OCI, which is largely compatible with most recent registries, but Docker may be needed for older registries without OCI support.
MediaTypes ImageMediaTypes
}
// Publishes this container as a new image to the specified address.
//
// Publish returns a fully qualified ref.
//
// It can also publish platform variants.
func (r *Container) Publish(ctx context.Context, address string, opts ...ContainerPublishOpts) (string, error) {
if r.publish != nil {
return *r.publish, nil
}
q := r.query.Select("publish")
for i := len(opts) - 1; i >= 0; i-- {
// `platformVariants` optional argument
if !querybuilder.IsZeroValue(opts[i].PlatformVariants) {
q = q.Arg("platformVariants", opts[i].PlatformVariants)
}
// `forcedCompression` optional argument
if !querybuilder.IsZeroValue(opts[i].ForcedCompression) {
q = q.Arg("forcedCompression", opts[i].ForcedCompression)
}
// `mediaTypes` optional argument
if !querybuilder.IsZeroValue(opts[i].MediaTypes) {
q = q.Arg("mediaTypes", opts[i].MediaTypes)
}
}
q = q.Arg("address", address)
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Retrieves this container's root filesystem. Mounts are not included.
func (r *Container) Rootfs() *Directory {
q := r.query.Select("rootfs")
return &Directory{
query: q,
}
}
// The error stream of the last executed command.
//
// Returns an error if no command was set.
func (r *Container) Stderr(ctx context.Context) (string, error) {
if r.stderr != nil {
return *r.stderr, nil
}
q := r.query.Select("stderr")
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// The output stream of the last executed command.
//
// Returns an error if no command was set.
func (r *Container) Stdout(ctx context.Context) (string, error) {
if r.stdout != nil {
return *r.stdout, nil
}
q := r.query.Select("stdout")
var response string
q = q.Bind(&response)
return response, q.Execute(ctx)
}
// Forces evaluation of the pipeline in the engine.
//
// It doesn't run the default command if no exec has been set.
func (r *Container) Sync(ctx context.Context) (*Container, error) {
q := r.query.Select("sync")
var id ContainerID
if err := q.Bind(&id).Execute(ctx); err != nil {
return nil, err
}
return &Container{
query: q.Root().Select("loadContainerFromID").Arg("id", id),
}, nil
}
// ContainerTerminalOpts contains options for Container.Terminal
type ContainerTerminalOpts struct {
// If set, override the container's default terminal command and invoke these command arguments instead.
Cmd []string
// Provides Dagger access to the executed command.
//
// Do not use this option unless you trust the command being executed; the command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
ExperimentalPrivilegedNesting bool
// Execute the command with all root capabilities. This is similar to running a command with "sudo" or executing "docker run" with the "--privileged" flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.
InsecureRootCapabilities bool
}
// Opens an interactive terminal for this container using its configured default terminal command if not overridden by args (or sh as a fallback default).
func (r *Container) Terminal(opts ...ContainerTerminalOpts) *Container {
q := r.query.Select("terminal")
for i := len(opts) - 1; i >= 0; i-- {
// `cmd` optional argument
if !querybuilder.IsZeroValue(opts[i].Cmd) {
q = q.Arg("cmd", opts[i].Cmd)
}
// `experimentalPrivilegedNesting` optional argument
if !querybuilder.IsZeroValue(opts[i].ExperimentalPrivilegedNesting) {
q = q.Arg("experimentalPrivilegedNesting", opts[i].ExperimentalPrivilegedNesting)
}
// `insecureRootCapabilities` optional argument
if !querybuilder.IsZeroValue(opts[i].InsecureRootCapabilities) {
q = q.Arg("insecureRootCapabilities", opts[i].InsecureRootCapabilities)
}
}
return &Container{
query: q,
}
}
// ContainerUpOpts contains options for Container.Up
type ContainerUpOpts struct {
// List of frontend/backend port mappings to forward.
//