Browse code

api/types: move BuildResult to api/types/build.Result

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2025/05/16 23:38:23
Showing 8 changed files
... ...
@@ -60,30 +60,30 @@ func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string
60 60
 		return "", err
61 61
 	}
62 62
 
63
-	var build *builder.Result
63
+	var buildResult *builder.Result
64 64
 	if useBuildKit {
65
-		build, err = b.buildkit.Build(ctx, config)
65
+		buildResult, err = b.buildkit.Build(ctx, config)
66 66
 		if err != nil {
67 67
 			return "", err
68 68
 		}
69 69
 	} else {
70
-		build, err = b.builder.Build(ctx, config)
70
+		buildResult, err = b.builder.Build(ctx, config)
71 71
 		if err != nil {
72 72
 			return "", err
73 73
 		}
74 74
 	}
75 75
 
76
-	if build == nil {
76
+	if buildResult == nil {
77 77
 		return "", nil
78 78
 	}
79 79
 
80
-	imageID := build.ImageID
80
+	imageID := buildResult.ImageID
81 81
 	if options.Squash {
82
-		if imageID, err = squashBuild(build, b.imageComponent); err != nil {
82
+		if imageID, err = squashBuild(buildResult, b.imageComponent); err != nil {
83 83
 			return "", err
84 84
 		}
85 85
 		if config.ProgressWriter.AuxFormatter != nil {
86
-			if err = config.ProgressWriter.AuxFormatter.Emit("moby.image.id", types.BuildResult{ID: imageID}); err != nil {
86
+			if err = config.ProgressWriter.AuxFormatter.Emit("moby.image.id", build.Result{ID: imageID}); err != nil {
87 87
 				return "", err
88 88
 			}
89 89
 		}
90 90
new file mode 100644
... ...
@@ -0,0 +1,6 @@
0
+package build
1
+
2
+// Result contains the image id of a successful build.
3
+type Result struct {
4
+	ID string
5
+}
... ...
@@ -126,8 +126,3 @@ type PushResult struct {
126 126
 	Digest string
127 127
 	Size   int
128 128
 }
129
-
130
-// BuildResult contains the image id of a successful build
131
-type BuildResult struct {
132
-	ID string
133
-}
... ...
@@ -130,3 +130,8 @@ type BuildCachePruneOptions = build.CachePruneOptions
130 130
 //
131 131
 // Deprecated: use [build.CachePruneReport].
132 132
 type BuildCachePruneReport = build.CachePruneReport
133
+
134
+// BuildResult contains the image id of a successful build/
135
+//
136
+// Deprecated: use [build.Result].
137
+type BuildResult = build.Result
... ...
@@ -12,7 +12,6 @@ import (
12 12
 
13 13
 	"github.com/containerd/containerd/v2/core/remotes/docker"
14 14
 	"github.com/containerd/platforms"
15
-	"github.com/docker/docker/api/types"
16 15
 	"github.com/docker/docker/api/types/backend"
17 16
 	"github.com/docker/docker/api/types/build"
18 17
 	"github.com/docker/docker/api/types/container"
... ...
@@ -438,7 +437,7 @@ func (b *Builder) Build(ctx context.Context, opt backend.BuildConfig) (*builder.
438 438
 			return errors.Errorf("missing image id")
439 439
 		}
440 440
 		out.ImageID = imgID
441
-		return aux.Emit("moby.image.id", types.BuildResult{ID: imgID})
441
+		return aux.Emit("moby.image.id", build.Result{ID: imgID})
442 442
 	})
443 443
 
444 444
 	ch := make(chan *controlapi.StatusResponse)
... ...
@@ -12,6 +12,7 @@ import (
12 12
 	"github.com/containerd/platforms"
13 13
 	"github.com/docker/docker/api/types"
14 14
 	"github.com/docker/docker/api/types/backend"
15
+	"github.com/docker/docker/api/types/build"
15 16
 	"github.com/docker/docker/api/types/container"
16 17
 	"github.com/docker/docker/builder"
17 18
 	"github.com/docker/docker/builder/remotecontext"
... ...
@@ -222,7 +223,7 @@ func emitImageID(aux *streamformatter.AuxFormatter, state *dispatchState) error
222 222
 	if aux == nil || state.imageID == "" {
223 223
 		return nil
224 224
 	}
225
-	return aux.Emit("", types.BuildResult{ID: state.imageID})
225
+	return aux.Emit("", build.Result{ID: state.imageID})
226 226
 }
227 227
 
228 228
 func processMetaArg(meta instructions.ArgCommand, shlex *shell.Lex, args *BuildArgs) error {
... ...
@@ -12,6 +12,7 @@ import (
12 12
 	"testing"
13 13
 
14 14
 	"github.com/docker/docker/api/types"
15
+	"github.com/docker/docker/api/types/build"
15 16
 	containertypes "github.com/docker/docker/api/types/container"
16 17
 	"github.com/docker/docker/errdefs"
17 18
 	"github.com/docker/docker/integration/internal/container"
... ...
@@ -200,7 +201,7 @@ func makeTestImage(ctx context.Context, t *testing.T) (imageID string) {
200 200
 	defer resp.Body.Close()
201 201
 
202 202
 	err = jsonmessage.DisplayJSONMessagesStream(resp.Body, io.Discard, 0, false, func(msg jsonmessage.JSONMessage) {
203
-		var r types.BuildResult
203
+		var r build.Result
204 204
 		assert.NilError(t, json.Unmarshal(*msg.Aux, &r))
205 205
 		imageID = r.ID
206 206
 	})
... ...
@@ -275,7 +276,7 @@ func TestCopyFromContainer(t *testing.T) {
275 275
 
276 276
 	var imageID string
277 277
 	err = jsonmessage.DisplayJSONMessagesStream(resp.Body, io.Discard, 0, false, func(msg jsonmessage.JSONMessage) {
278
-		var r types.BuildResult
278
+		var r build.Result
279 279
 		assert.NilError(t, json.Unmarshal(*msg.Aux, &r))
280 280
 		imageID = r.ID
281 281
 	})
... ...
@@ -7,6 +7,7 @@ import (
7 7
 	"testing"
8 8
 
9 9
 	"github.com/docker/docker/api/types"
10
+	"github.com/docker/docker/api/types/build"
10 11
 	"github.com/docker/docker/api/types/image"
11 12
 	"github.com/docker/docker/client"
12 13
 	"github.com/docker/docker/pkg/jsonmessage"
... ...
@@ -32,7 +33,7 @@ func Do(ctx context.Context, t *testing.T, client client.APIClient, buildCtx *fa
32 32
 func GetImageIDFromBody(t *testing.T, body io.Reader) string {
33 33
 	var (
34 34
 		jm  jsonmessage.JSONMessage
35
-		br  types.BuildResult
35
+		br  build.Result
36 36
 		dec = json.NewDecoder(body)
37 37
 	)
38 38
 	for {