Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Windows] Fix nerdctl build tar parsing error #3604

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+97 −29
Draft

[Windows] Fix nerdctl build tar parsing error #3604

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 97 additions & 29 deletions pkg/cmd/builder/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (
"os"
"os/exec"
"path/filepath"
"runtime"
"strconv"
"strings"

Expand Down Expand Up @@ -61,18 +62,22 @@ func (p platformParser) DefaultSpec() platforms.Platform {
}

func Build(ctx context.Context, client *containerd.Client, options types.BuilderBuildOptions) error {
buildctlBinary, buildctlArgs, needsLoading, metaFile, tags, cleanup, err := generateBuildctlArgs(ctx, client, options)
buildCtlArgs, err := generateBuildctlArgs(ctx, client, options)
if err != nil {
return err
}
if cleanup != nil {
defer cleanup()
if buildCtlArgs.Cleanup != nil {
defer buildCtlArgs.Cleanup()
}

buildctlBinary := buildCtlArgs.BuildctlBinary
buildctlArgs := buildCtlArgs.BuildctlArgs

log.L.Debugf("running %s %v", buildctlBinary, buildctlArgs)
buildctlCmd := exec.Command(buildctlBinary, buildctlArgs...)
buildctlCmd.Env = os.Environ()

needsLoading := buildCtlArgs.NeedsLoading
var buildctlStdout io.Reader
if needsLoading {
buildctlStdout, err = buildctlCmd.StdoutPipe()
Expand All @@ -95,6 +100,26 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder
if err != nil {
return err
}

if buildCtlArgs.DestFile == "" {
log.L.Debug("no tar file specified")
} else {
// Separate TTY (image loading) buildctl output and tarball output
// Write buildctl output to stdout
if _, err := io.Copy(os.Stdout, buildctlStdout); err != nil {
return err
}

// Open the tar file
reader, err := os.Open(buildCtlArgs.DestFile)
if err != nil {
return fmt.Errorf("failed to open tar file: %v", err)
}
defer reader.Close()
buildctlStdout = reader
}

// Load the image into the containerd image store
if err = loadImage(ctx, buildctlStdout, options.GOptions.Namespace, options.GOptions.Address, options.GOptions.Snapshotter, options.Stdout, platMC, options.Quiet); err != nil {
return err
}
Expand All @@ -105,7 +130,7 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder
}

if options.IidFile != "" {
id, err := getDigestFromMetaFile(metaFile)
id, err := getDigestFromMetaFile(buildCtlArgs.MetaFile)
if err != nil {
return err
}
Expand All @@ -114,6 +139,7 @@ func Build(ctx context.Context, client *containerd.Client, options types.Builder
}
}

tags := buildCtlArgs.Tags
if len(tags) > 1 {
log.L.Debug("Found more than 1 tag")
imageService := client.ImageService()
Expand Down Expand Up @@ -160,7 +186,11 @@ func loadImage(ctx context.Context, in io.Reader, namespace, address, snapshotte
client.Close()
}()
r := &readCounter{Reader: in}
imgs, err := client.Import(ctx, r, containerd.WithDigestRef(archive.DigestTranslator(snapshotter)), containerd.WithSkipDigestRef(func(name string) bool { return name != "" }), containerd.WithImportPlatform(platMC))
imgs, err := client.Import(ctx, r,
containerd.WithDigestRef(archive.DigestTranslator(snapshotter)),
containerd.WithSkipDigestRef(func(name string) bool { return name != "" }),
containerd.WithImportPlatform(platMC),
)
if err != nil {
if r.N == 0 {
// Avoid confusing "unrecognized image format"
Expand Down Expand Up @@ -192,23 +222,40 @@ func loadImage(ctx context.Context, in io.Reader, namespace, address, snapshotte
return nil
}

func generateBuildctlArgs(ctx context.Context, client *containerd.Client, options types.BuilderBuildOptions) (buildCtlBinary string,
buildctlArgs []string, needsLoading bool, metaFile string, tags []string, cleanup func(), err error) {
type BuildctlArgsResult struct {
BuildctlArgs []string
BuildctlBinary string
Cleanup func()
DestFile string
MetaFile string
NeedsLoading bool // Specifies whether the image needs to be loaded into the containerd image store
Tags []string
}

func generateBuildctlArgs(ctx context.Context, client *containerd.Client, options types.BuilderBuildOptions) (result BuildctlArgsResult, err error) {
buildctlBinary, err := buildkitutil.BuildctlBinary()
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
result.BuildctlBinary = buildctlBinary

// FIXME: Find a better path
// Set the default destination file
defaultDestFile, err := filepath.Abs("output.tar")
if err != nil {
return result, fmt.Errorf("failed to set the default destination file path: %v", err)
}
var defaultDest string

output := options.Output
if output == "" {
info, err := client.Server(ctx)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
sharable, err := isImageSharable(options.BuildKitHost, options.GOptions.Namespace, info.UUID, options.GOptions.Snapshotter, options.Platform)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
if sharable {
output = "type=image,unpack=true" // ensure the target stage is unlazied (needed for any snapshotters)
Expand All @@ -219,42 +266,61 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
// TODO: consider using type=oci for single-options.Platform build too
output = "type=oci"
}
needsLoading = true
}
} else {
if !strings.Contains(output, "type=") {
// should accept --output <DIR> as an alias of --output
// type=local,dest=<DIR>
output = fmt.Sprintf("type=local,dest=%s", output)
}
if strings.Contains(output, "type=docker") || strings.Contains(output, "type=oci") {
if !strings.Contains(output, "dest=") {
needsLoading = true
}

// The `buildctl build` command sends both tty logs and tar (binary data) to stdout.
// Windows terminals can't distinguish these, causing "archive/tar: invalid tar header" error.
// To prevent this, we direct tar output to a file, ensuring separate handling of tty and tar data.
// A default tar file is set (if unspecified) and then loaded into the containerd image store.
if strings.Contains(output, "type=docker") || strings.Contains(output, "type=oci") {
if !strings.Contains(output, "dest=") {
result.NeedsLoading = true

if runtime.GOOS == "windows" {
defaultDest = fmt.Sprintf(",dest=%s", defaultDestFile)
}
}
}

var tags []string
if tags = strutil.DedupeStrSlice(options.Tag); len(tags) > 0 {
ref := tags[0]
parsedReference, err := referenceutil.Parse(ref)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
output += ",name=" + parsedReference.String()

// pick the first tag and add it to output
for idx, tag := range tags {
parsedReference, err = referenceutil.Parse(tag)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
tags[idx] = parsedReference.String()
}
} else if len(tags) == 0 {
output = output + ",dangling-name-prefix=<none>"
}
result.Tags = tags

// Add default destination file to output
output += defaultDest

buildctlArgs = buildkitutil.BuildctlBaseArgs(options.BuildKitHost)
// Extract destination file from output
if strings.Contains(output, "dest=") {
_, destFilePath, _ := strings.Cut(output, "dest=")
result.DestFile = destFilePath
}

buildctlArgs := buildkitutil.BuildctlBaseArgs(options.BuildKitHost)
buildctlArgs = append(buildctlArgs, []string{
"build",
"--progress=" + options.Progress,
Expand All @@ -271,9 +337,9 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
var err error
dir, err = buildkitutil.WriteTempDockerfile(options.Stdin)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
cleanup = func() {
result.Cleanup = func() {
os.RemoveAll(dir)
}
} else {
Expand All @@ -286,12 +352,12 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
}
dir, file, err = buildkitutil.BuildKitFile(dir, file)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}

buildCtx, err := parseContextNames(options.ExtendedBuildContext)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}

for k, v := range buildCtx {
Expand All @@ -306,7 +372,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
if isOCILayout := strings.HasPrefix(v, "oci-layout://"); isOCILayout {
args, err := parseBuildContextFromOCILayout(k, v)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}

buildctlArgs = append(buildctlArgs, args...)
Expand All @@ -315,7 +381,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option

path, err := filepath.Abs(v)
if err != nil {
return "", nil, false, "", nil, nil, err
return result, err
}
buildctlArgs = append(buildctlArgs, fmt.Sprintf("--local=%s=%s", k, path))
buildctlArgs = append(buildctlArgs, fmt.Sprintf("--opt=context:%s=local:%s", k, k))
Expand Down Expand Up @@ -362,7 +428,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
}
}
} else {
return "", nil, false, "", nil, nil, fmt.Errorf("invalid build arg %q", ba)
return result, fmt.Errorf("invalid build arg %q", ba)
}
}

Expand Down Expand Up @@ -405,7 +471,7 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
optAttestType := strings.TrimPrefix(optAttestType, "type=")
buildctlArgs = append(buildctlArgs, fmt.Sprintf("--opt=attest:%s=%s", optAttestType, optAttestAttrs))
} else {
return "", nil, false, "", nil, nil, fmt.Errorf("attestation type not specified")
return result, fmt.Errorf("attestation type not specified")
}
}

Expand Down Expand Up @@ -434,11 +500,11 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
if options.IidFile != "" {
file, err := os.CreateTemp("", "buildkit-meta-*")
if err != nil {
return "", nil, false, "", nil, cleanup, err
return result, err
}
defer file.Close()
metaFile = file.Name()
buildctlArgs = append(buildctlArgs, "--metadata-file="+metaFile)
result.MetaFile = file.Name()
buildctlArgs = append(buildctlArgs, "--metadata-file="+result.MetaFile)
}

if options.NetworkMode != "" {
Expand All @@ -453,7 +519,9 @@ func generateBuildctlArgs(ctx context.Context, client *containerd.Client, option
}
}

return buildctlBinary, buildctlArgs, needsLoading, metaFile, tags, cleanup, nil
result.BuildctlArgs = buildctlArgs

return result, nil
}

func getDigestFromMetaFile(path string) (string, error) {
Expand Down