build: set record status warnings in response

Signed-off-by: CrazyMax <[email protected]>
docker · Jun 13, 2024 · 064c8cb · 064c8cb
1 parent 3b25e3f
commit 064c8cb
Show file tree

Hide file tree

Showing 12 changed files with 379 additions and 196 deletions.
diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -84,6 +84,8 @@ jobs:
             endpoint: tcp://localhost:1234
           - driver: docker-container
             metadata-provenance: max
+          - driver: docker-container
+            metadata-status: max
         exclude:
           - driver: docker
             multi-node: mnode-true
@@ -134,6 +136,9 @@ jobs:
           if [ -n "${{ matrix.metadata-provenance }}" ]; then
             echo "BUILDX_METADATA_PROVENANCE=${{ matrix.metadata-provenance }}" >> $GITHUB_ENV
           fi
+          if [ -n "${{ matrix.metadata-status }}" ]; then
+            echo "BUILDX_METADATA_STATUS=${{ matrix.metadata-status }}" >> $GITHUB_ENV
+          fi
       -
         name: Install k3s
         if: matrix.driver == 'kubernetes'

diff --git a/build/build.go b/build/build.go
@@ -79,12 +79,12 @@ type Options struct {
 	Target        string
 	Ulimits       *opts.UlimitOpt
 
-	Session                []session.Attachable
-	Linked                 bool // Linked marks this target as exclusively linked (not requested by the user).
-	PrintFunc              *PrintFunc
-	WithProvenanceResponse bool
-	SourcePolicy           *spb.Policy
-	GroupRef               string
+	Session              []session.Attachable
+	Linked               bool // Linked marks this target as exclusively linked (not requested by the user).
+	PrintFunc            *PrintFunc
+	WithDetailedResponse bool
+	SourcePolicy         *spb.Policy
+	GroupRef             string
 }
 
 type PrintFunc struct {
@@ -473,8 +473,8 @@ func BuildWithResultHandler(ctx context.Context, nodes []builder.Node, opt map[s
 						rr.ExporterResponse[k] = string(v)
 					}
 					rr.ExporterResponse["buildx.build.ref"] = buildRef
-					if opt.WithProvenanceResponse && node.Driver.HistoryAPISupported(ctx) {
-						if err := setRecordProvenance(ctx, c, rr, so.Ref, pw); err != nil {
+					if opt.WithDetailedResponse && node.Driver.HistoryAPISupported(ctx) {
+						if err := setRecordMetadata(ctx, c, rr, so.Ref, pw); err != nil {
 							return err
 						}
 					}

diff --git a/build/provenance.go → build/record.go b/build/provenance.go → build/record.go
@@ -20,6 +20,26 @@ import (
 	"golang.org/x/sync/errgroup"
 )
 
+func setRecordMetadata(ctx context.Context, c *client.Client, sr *client.SolveResponse, ref string, pw progress.Writer) error {
+	var mu sync.Mutex
+
+	cb := func(key string, value string) {
+		mu.Lock()
+		defer mu.Unlock()
+		sr.ExporterResponse[key] = value
+	}
+
+	eg, ctx := errgroup.WithContext(ctx)
+	eg.Go(func() error {
+		return setRecordProvenance(ctx, c, ref, cb, pw)
+	})
+	eg.Go(func() error {
+		return setRecordStatus(ctx, c, ref, cb, pw)
+	})
+
+	return eg.Wait()
+}
+
 type provenancePredicate struct {
 	Builder *provenanceBuilder `json:"builder,omitempty"`
 	provenancetypes.ProvenancePredicate
@@ -29,7 +49,7 @@ type provenanceBuilder struct {
 	ID string `json:"id,omitempty"`
 }
 
-func setRecordProvenance(ctx context.Context, c *client.Client, sr *client.SolveResponse, ref string, pw progress.Writer) error {
+func setRecordProvenance(ctx context.Context, c *client.Client, ref string, updateExporterResponse func(key string, value string), pw progress.Writer) error {
 	mode := confutil.MetadataProvenance()
 	if mode == confutil.MetadataProvenanceModeDisabled {
 		return nil
@@ -41,7 +61,7 @@ func setRecordProvenance(ctx context.Context, c *client.Client, sr *client.Solve
 			return err
 		}
 		for k, v := range res {
-			sr.ExporterResponse[k] = v
+			updateExporterResponse(k, v)
 		}
 		return nil
 	})
@@ -155,3 +175,51 @@ func encodeProvenance(dt []byte, mode confutil.MetadataProvenanceMode) (string,
 	}
 	return base64.StdEncoding.EncodeToString(dtprv), nil
 }
+
+func setRecordStatus(ctx context.Context, c *client.Client, ref string, updateExporterResponse func(key string, value string), pw progress.Writer) error {
+	mode := confutil.MetadataStatus()
+	if mode == confutil.MetadataStatusModeDisabled {
+		return nil
+	}
+	pw = progress.ResetTime(pw)
+	return progress.Wrap("resolving status for metadata file", pw.Write, func(l progress.SubLogger) error {
+		status, err := fetchStatus(ctx, c, ref)
+		if err != nil {
+			return err
+		} else if status == nil {
+			return nil
+		}
+
+		if mode == confutil.MetadataStatusModeWarnings {
+			// we just want warnings
+			status.Vertexes = nil
+			status.Statuses = nil
+			status.Logs = nil
+		}
+
+		dt, err := json.Marshal(status)
+		if err != nil {
+			return errors.Wrapf(err, "failed to marshal status")
+		}
+
+		updateExporterResponse("buildx.build.status", base64.StdEncoding.EncodeToString(dt))
+		return nil
+	})
+}
+
+func fetchStatus(ctx context.Context, c *client.Client, ref string) (*client.SolveStatus, error) {
+	cl, err := c.ControlClient().Status(ctx, &controlapi.StatusRequest{
+		Ref: ref,
+	})
+	if err != nil {
+		return nil, err
+	}
+	resp, err := cl.Recv()
+	if err != nil {
+		if err == io.EOF {
+			return nil, nil
+		}
+		return nil, errors.Wrap(err, "failed to receive status")
+	}
+	return client.NewSolveStatus(resp), nil
+}
diff --git a/commands/bake.go b/commands/bake.go
@@ -207,7 +207,7 @@ func runBake(ctx context.Context, dockerCli command.Cli, targets []string, in ba
 	for k, b := range bo {
 		b.Ref = identity.NewID()
 		b.GroupRef = groupRef
-		b.WithProvenanceResponse = len(in.metadataFile) > 0
+		b.WithDetailedResponse = len(in.metadataFile) > 0
 		refs = append(refs, b.Ref)
 		bo[k] = b
 	}

diff --git a/commands/build.go b/commands/build.go
@@ -206,7 +206,7 @@ func (o *buildOptions) toControllerOptions() (*controllerapi.BuildOptions, error
 		return nil, err
 	}
 
-	opts.WithProvenanceResponse = opts.PrintFunc == nil && len(o.metadataFile) > 0
+	opts.WithDetailedResponse = opts.PrintFunc == nil && len(o.metadataFile) > 0
 
 	return &opts, nil
 }

diff --git a/controller/build/build.go b/controller/build/build.go
@@ -53,21 +53,21 @@ func RunBuild(ctx context.Context, dockerCli command.Cli, in controllerapi.Build
 			InStream:       inStream,
 			NamedContexts:  contexts,
 		},
-		Ref:                    in.Ref,
-		BuildArgs:              in.BuildArgs,
-		CgroupParent:           in.CgroupParent,
-		ExtraHosts:             in.ExtraHosts,
-		Labels:                 in.Labels,
-		NetworkMode:            in.NetworkMode,
-		NoCache:                in.NoCache,
-		NoCacheFilter:          in.NoCacheFilter,
-		Pull:                   in.Pull,
-		ShmSize:                dockeropts.MemBytes(in.ShmSize),
-		Tags:                   in.Tags,
-		Target:                 in.Target,
-		Ulimits:                controllerUlimitOpt2DockerUlimit(in.Ulimits),
-		GroupRef:               in.GroupRef,
-		WithProvenanceResponse: in.WithProvenanceResponse,
+		Ref:                  in.Ref,
+		BuildArgs:            in.BuildArgs,
+		CgroupParent:         in.CgroupParent,
+		ExtraHosts:           in.ExtraHosts,
+		Labels:               in.Labels,
+		NetworkMode:          in.NetworkMode,
+		NoCache:              in.NoCache,
+		NoCacheFilter:        in.NoCacheFilter,
+		Pull:                 in.Pull,
+		ShmSize:              dockeropts.MemBytes(in.ShmSize),
+		Tags:                 in.Tags,
+		Target:               in.Target,
+		Ulimits:              controllerUlimitOpt2DockerUlimit(in.Ulimits),
+		GroupRef:             in.GroupRef,
+		WithDetailedResponse: in.WithDetailedResponse,
 	}
 
 	platforms, err := platformutil.Parse(in.Platforms)