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.

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

Backport of docker: close response connection once stdin is exhausted into release/1.9.x #24243

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .changelog/24202.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
docker: Fixed a bug where alloc exec with stdin would hang
```
1 change: 1 addition & 0 deletions drivers/docker/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -1848,6 +1848,7 @@ func (d *Driver) ExecTaskStreaming(ctx context.Context, taskID string, opts *dri

go func() {
_, _ = io.Copy(resp.Conn, opts.Stdin)
_ = resp.CloseWrite()
}()

exitCode := 999
Expand Down
5 changes: 5 additions & 0 deletions e2e/allocexec/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

// Package allocexec contains tests around the alloc exec functionality.
package allocexec
94 changes: 94 additions & 0 deletions e2e/allocexec/docker_exec_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1

package allocexec

import (
"archive/tar"
"bytes"
"context"
"strings"
"testing"
"time"

nomadapi "github.com/hashicorp/nomad/api"
"github.com/hashicorp/nomad/e2e/v3/cluster3"
"github.com/hashicorp/nomad/e2e/v3/jobs3"
"github.com/shoenig/test/must"
)

func TestDockerAllocExec(t *testing.T) {
cluster3.Establish(t,
cluster3.Leader(),
cluster3.LinuxClients(1),
)

t.Run("testDockerExecStdin", testDockerExecStdin)
}

func testDockerExecStdin(t *testing.T) {
_, cleanup := jobs3.Submit(t, "./input/sleepytar.hcl")
t.Cleanup(cleanup)

client, err := nomadapi.NewClient(nomadapi.DefaultConfig())
must.NoError(t, err)

allocations, _, err := client.Allocations().List(nil)
must.NoError(t, err)
must.SliceLen(t, 1, allocations)

// Use the first allocation for the example
allocationID := allocations[0].ID
allocation, _, err := client.Allocations().Info(allocationID, nil)
must.NoError(t, err)

// Command to execute
command := []string{"tar", "--extract", "--verbose", "--file=/dev/stdin"}

// Create a buffer to hold the tar archive
var tarBuffer bytes.Buffer
tarWriter := tar.NewWriter(&tarBuffer)

// Create a tar header
fileContentLength := 8100
header := &tar.Header{
Name: "filename.txt",
Mode: 0600,
Size: int64(len(strings.Repeat("a", fileContentLength))),
}

// Write the header to the tar archive
must.NoError(t, tarWriter.WriteHeader(header))

// Write the file content to the tar archive
_, err = tarWriter.Write([]byte(strings.Repeat("a", fileContentLength)))
must.NoError(t, err)

// Close the tar writer
must.Close(t, tarWriter)

output := new(bytes.Buffer)

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

// execute the tar command inside the container
exitCode, err := client.Allocations().Exec(
ctx,
allocation,
"task",
false,
command,
&tarBuffer,
output,
output,
nil,
nil,
)
must.NoError(t, err)
must.Zero(t, exitCode)

// check the output of tar
s := output.String()
must.Eq(t, "filename.txt\n", s)
}
45 changes: 45 additions & 0 deletions e2e/allocexec/input/sleepytar.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: BUSL-1.1

# This "sleepytar" job just sleeps, but is used as a target for a nomad alloc
# exec API invocation to run a tar job that reads its data from stdin.

job "sleepytar" {
constraint {
attribute = "${attr.kernel.name}"
value = "linux"
}

group "group" {
update {
min_healthy_time = "3s"
}

reschedule {
unlimited = false
attempts = 0
}

restart {
attempts = 0
mode = "fail"
}

task "task" {
driver = "docker"

config {
image = "bash:latest"
command = "sleep"
args = ["infinity"]
network_mode = "none"
}

resources {
cores = 1
memory = 128
}
}
}
}