github.com/pwn-term/docker@v0.0.0-20210616085119-6e977cce2565/moby/testutil/daemon/daemon.go (about)

     1  package daemon // import "github.com/docker/docker/testutil/daemon"
     2  
     3  import (
     4  	"context"
     5  	"encoding/json"
     6  	"fmt"
     7  	"io/ioutil"
     8  	"net/http"
     9  	"os"
    10  	"os/exec"
    11  	"os/user"
    12  	"path/filepath"
    13  	"strconv"
    14  	"strings"
    15  	"testing"
    16  	"time"
    17  
    18  	"github.com/docker/docker/api/types"
    19  	"github.com/docker/docker/api/types/events"
    20  	"github.com/docker/docker/client"
    21  	"github.com/docker/docker/opts"
    22  	"github.com/docker/docker/pkg/ioutils"
    23  	"github.com/docker/docker/pkg/stringid"
    24  	"github.com/docker/docker/testutil/request"
    25  	"github.com/docker/go-connections/sockets"
    26  	"github.com/docker/go-connections/tlsconfig"
    27  	"github.com/pkg/errors"
    28  	"gotest.tools/v3/assert"
    29  )
    30  
    31  // LogT is the subset of the testing.TB interface used by the daemon.
    32  type LogT interface {
    33  	Logf(string, ...interface{})
    34  }
    35  
    36  // nopLog is a no-op implementation of LogT that is used in daemons created by
    37  // NewDaemon (where no testing.TB is available).
    38  type nopLog struct{}
    39  
    40  func (nopLog) Logf(string, ...interface{}) {}
    41  
    42  const (
    43  	defaultDockerdBinary         = "dockerd"
    44  	defaultContainerdSocket      = "/var/run/docker/containerd/containerd.sock"
    45  	defaultDockerdRootlessBinary = "dockerd-rootless.sh"
    46  )
    47  
    48  var errDaemonNotStarted = errors.New("daemon not started")
    49  
    50  // SockRoot holds the path of the default docker integration daemon socket
    51  var SockRoot = filepath.Join(os.TempDir(), "docker-integration")
    52  
    53  type clientConfig struct {
    54  	transport *http.Transport
    55  	scheme    string
    56  	addr      string
    57  }
    58  
    59  // Daemon represents a Docker daemon for the testing framework
    60  type Daemon struct {
    61  	Root              string
    62  	Folder            string
    63  	Wait              chan error
    64  	UseDefaultHost    bool
    65  	UseDefaultTLSHost bool
    66  
    67  	id                         string
    68  	logFile                    *os.File
    69  	cmd                        *exec.Cmd
    70  	storageDriver              string
    71  	userlandProxy              bool
    72  	defaultCgroupNamespaceMode string
    73  	execRoot                   string
    74  	experimental               bool
    75  	init                       bool
    76  	dockerdBinary              string
    77  	log                        LogT
    78  	pidFile                    string
    79  	args                       []string
    80  	containerdSocket           string
    81  	rootlessUser               *user.User
    82  	rootlessXDGRuntimeDir      string
    83  
    84  	// swarm related field
    85  	swarmListenAddr string
    86  	SwarmPort       int // FIXME(vdemeester) should probably not be exported
    87  	DefaultAddrPool []string
    88  	SubnetSize      uint32
    89  	DataPathPort    uint32
    90  	OOMScoreAdjust  int
    91  	// cached information
    92  	CachedInfo types.Info
    93  }
    94  
    95  // NewDaemon returns a Daemon instance to be used for testing.
    96  // The daemon will not automatically start.
    97  // The daemon will modify and create files under workingDir.
    98  func NewDaemon(workingDir string, ops ...Option) (*Daemon, error) {
    99  	storageDriver := os.Getenv("DOCKER_GRAPHDRIVER")
   100  
   101  	if err := os.MkdirAll(SockRoot, 0700); err != nil {
   102  		return nil, errors.Wrapf(err, "failed to create daemon socket root %q", SockRoot)
   103  	}
   104  
   105  	id := fmt.Sprintf("d%s", stringid.TruncateID(stringid.GenerateRandomID()))
   106  	dir := filepath.Join(workingDir, id)
   107  	daemonFolder, err := filepath.Abs(dir)
   108  	if err != nil {
   109  		return nil, err
   110  	}
   111  	daemonRoot := filepath.Join(daemonFolder, "root")
   112  	if err := os.MkdirAll(daemonRoot, 0755); err != nil {
   113  		return nil, errors.Wrapf(err, "failed to create daemon root %q", daemonRoot)
   114  	}
   115  
   116  	userlandProxy := true
   117  	if env := os.Getenv("DOCKER_USERLANDPROXY"); env != "" {
   118  		if val, err := strconv.ParseBool(env); err != nil {
   119  			userlandProxy = val
   120  		}
   121  	}
   122  	d := &Daemon{
   123  		id:            id,
   124  		Folder:        daemonFolder,
   125  		Root:          daemonRoot,
   126  		storageDriver: storageDriver,
   127  		userlandProxy: userlandProxy,
   128  		// dxr stands for docker-execroot (shortened for avoiding unix(7) path length limitation)
   129  		execRoot:         filepath.Join(os.TempDir(), "dxr", id),
   130  		dockerdBinary:    defaultDockerdBinary,
   131  		swarmListenAddr:  defaultSwarmListenAddr,
   132  		SwarmPort:        DefaultSwarmPort,
   133  		log:              nopLog{},
   134  		containerdSocket: defaultContainerdSocket,
   135  	}
   136  
   137  	for _, op := range ops {
   138  		op(d)
   139  	}
   140  
   141  	if d.rootlessUser != nil {
   142  		if err := os.Chmod(SockRoot, 0777); err != nil {
   143  			return nil, err
   144  		}
   145  		uid, err := strconv.Atoi(d.rootlessUser.Uid)
   146  		if err != nil {
   147  			return nil, err
   148  		}
   149  		gid, err := strconv.Atoi(d.rootlessUser.Gid)
   150  		if err != nil {
   151  			return nil, err
   152  		}
   153  		if err := os.Chown(d.Folder, uid, gid); err != nil {
   154  			return nil, err
   155  		}
   156  		if err := os.Chown(d.Root, uid, gid); err != nil {
   157  			return nil, err
   158  		}
   159  		if err := os.MkdirAll(filepath.Dir(d.execRoot), 0700); err != nil {
   160  			return nil, err
   161  		}
   162  		if err := os.Chown(filepath.Dir(d.execRoot), uid, gid); err != nil {
   163  			return nil, err
   164  		}
   165  		if err := os.MkdirAll(d.execRoot, 0700); err != nil {
   166  			return nil, err
   167  		}
   168  		if err := os.Chown(d.execRoot, uid, gid); err != nil {
   169  			return nil, err
   170  		}
   171  		d.rootlessXDGRuntimeDir = filepath.Join(d.Folder, "xdgrun")
   172  		if err := os.MkdirAll(d.rootlessXDGRuntimeDir, 0700); err != nil {
   173  			return nil, err
   174  		}
   175  		if err := os.Chown(d.rootlessXDGRuntimeDir, uid, gid); err != nil {
   176  			return nil, err
   177  		}
   178  		d.containerdSocket = ""
   179  	}
   180  
   181  	return d, nil
   182  }
   183  
   184  // New returns a Daemon instance to be used for testing.
   185  // This will create a directory such as d123456789 in the folder specified by
   186  // $DOCKER_INTEGRATION_DAEMON_DEST or $DEST.
   187  // The daemon will not automatically start.
   188  func New(t testing.TB, ops ...Option) *Daemon {
   189  	t.Helper()
   190  	dest := os.Getenv("DOCKER_INTEGRATION_DAEMON_DEST")
   191  	if dest == "" {
   192  		dest = os.Getenv("DEST")
   193  	}
   194  	dest = filepath.Join(dest, t.Name())
   195  
   196  	assert.Check(t, dest != "", "Please set the DOCKER_INTEGRATION_DAEMON_DEST or the DEST environment variable")
   197  
   198  	if os.Getenv("DOCKER_ROOTLESS") != "" {
   199  		if os.Getenv("DOCKER_REMAP_ROOT") != "" {
   200  			t.Skip("DOCKER_ROOTLESS doesn't support DOCKER_REMAP_ROOT currently")
   201  		}
   202  		if env := os.Getenv("DOCKER_USERLANDPROXY"); env != "" {
   203  			if val, err := strconv.ParseBool(env); err == nil && !val {
   204  				t.Skip("DOCKER_ROOTLESS doesn't support DOCKER_USERLANDPROXY=false")
   205  			}
   206  		}
   207  		ops = append(ops, WithRootlessUser("unprivilegeduser"))
   208  	}
   209  	ops = append(ops, WithOOMScoreAdjust(-500))
   210  
   211  	d, err := NewDaemon(dest, ops...)
   212  	assert.NilError(t, err, "could not create daemon at %q", dest)
   213  	if d.rootlessUser != nil && d.dockerdBinary != defaultDockerdBinary {
   214  		t.Skipf("DOCKER_ROOTLESS doesn't support specifying non-default dockerd binary path %q", d.dockerdBinary)
   215  	}
   216  
   217  	return d
   218  }
   219  
   220  // ContainersNamespace returns the containerd namespace used for containers.
   221  func (d *Daemon) ContainersNamespace() string {
   222  	return d.id
   223  }
   224  
   225  // RootDir returns the root directory of the daemon.
   226  func (d *Daemon) RootDir() string {
   227  	return d.Root
   228  }
   229  
   230  // ID returns the generated id of the daemon
   231  func (d *Daemon) ID() string {
   232  	return d.id
   233  }
   234  
   235  // StorageDriver returns the configured storage driver of the daemon
   236  func (d *Daemon) StorageDriver() string {
   237  	return d.storageDriver
   238  }
   239  
   240  // Sock returns the socket path of the daemon
   241  func (d *Daemon) Sock() string {
   242  	return fmt.Sprintf("unix://" + d.sockPath())
   243  }
   244  
   245  func (d *Daemon) sockPath() string {
   246  	return filepath.Join(SockRoot, d.id+".sock")
   247  }
   248  
   249  // LogFileName returns the path the daemon's log file
   250  func (d *Daemon) LogFileName() string {
   251  	return d.logFile.Name()
   252  }
   253  
   254  // ReadLogFile returns the content of the daemon log file
   255  func (d *Daemon) ReadLogFile() ([]byte, error) {
   256  	return ioutil.ReadFile(d.logFile.Name())
   257  }
   258  
   259  // NewClientT creates new client based on daemon's socket path
   260  func (d *Daemon) NewClientT(t testing.TB, extraOpts ...client.Opt) *client.Client {
   261  	t.Helper()
   262  
   263  	c, err := d.NewClient(extraOpts...)
   264  	assert.NilError(t, err, "[%s] could not create daemon client", d.id)
   265  	return c
   266  }
   267  
   268  // NewClient creates new client based on daemon's socket path
   269  func (d *Daemon) NewClient(extraOpts ...client.Opt) (*client.Client, error) {
   270  	clientOpts := []client.Opt{
   271  		client.FromEnv,
   272  		client.WithHost(d.Sock()),
   273  	}
   274  	clientOpts = append(clientOpts, extraOpts...)
   275  
   276  	return client.NewClientWithOpts(clientOpts...)
   277  }
   278  
   279  // Cleanup cleans the daemon files : exec root (network namespaces, ...), swarmkit files
   280  func (d *Daemon) Cleanup(t testing.TB) {
   281  	t.Helper()
   282  	cleanupMount(t, d)
   283  	cleanupRaftDir(t, d)
   284  	cleanupNetworkNamespace(t, d)
   285  }
   286  
   287  // Start starts the daemon and return once it is ready to receive requests.
   288  func (d *Daemon) Start(t testing.TB, args ...string) {
   289  	t.Helper()
   290  	if err := d.StartWithError(args...); err != nil {
   291  		d.DumpStackAndQuit() // in case the daemon is stuck
   292  		t.Fatalf("[%s] failed to start daemon with arguments %v : %v", d.id, d.args, err)
   293  	}
   294  }
   295  
   296  // StartWithError starts the daemon and return once it is ready to receive requests.
   297  // It returns an error in case it couldn't start.
   298  func (d *Daemon) StartWithError(args ...string) error {
   299  	logFile, err := os.OpenFile(filepath.Join(d.Folder, "docker.log"), os.O_RDWR|os.O_CREATE|os.O_APPEND, 0600)
   300  	if err != nil {
   301  		return errors.Wrapf(err, "[%s] failed to create logfile", d.id)
   302  	}
   303  
   304  	return d.StartWithLogFile(logFile, args...)
   305  }
   306  
   307  // StartWithLogFile will start the daemon and attach its streams to a given file.
   308  func (d *Daemon) StartWithLogFile(out *os.File, providedArgs ...string) error {
   309  	d.handleUserns()
   310  	dockerdBinary, err := exec.LookPath(d.dockerdBinary)
   311  	if err != nil {
   312  		return errors.Wrapf(err, "[%s] could not find docker binary in $PATH", d.id)
   313  	}
   314  
   315  	if d.pidFile == "" {
   316  		d.pidFile = filepath.Join(d.Folder, "docker.pid")
   317  	}
   318  
   319  	d.args = []string{}
   320  	if d.rootlessUser != nil {
   321  		if d.dockerdBinary != defaultDockerdBinary {
   322  			return errors.Errorf("[%s] DOCKER_ROOTLESS doesn't support non-default dockerd binary path %q", d.id, d.dockerdBinary)
   323  		}
   324  		dockerdBinary = "sudo"
   325  		d.args = append(d.args,
   326  			"-u", d.rootlessUser.Username,
   327  			"-E", "XDG_RUNTIME_DIR="+d.rootlessXDGRuntimeDir,
   328  			"-E", "HOME="+d.rootlessUser.HomeDir,
   329  			"-E", "PATH="+os.Getenv("PATH"),
   330  			"--",
   331  			defaultDockerdRootlessBinary,
   332  		)
   333  	}
   334  
   335  	d.args = append(d.args,
   336  		"--data-root", d.Root,
   337  		"--exec-root", d.execRoot,
   338  		"--pidfile", d.pidFile,
   339  		fmt.Sprintf("--userland-proxy=%t", d.userlandProxy),
   340  		"--containerd-namespace", d.id,
   341  		"--containerd-plugins-namespace", d.id+"p",
   342  	)
   343  	if d.containerdSocket != "" {
   344  		d.args = append(d.args, "--containerd", d.containerdSocket)
   345  	}
   346  
   347  	if d.defaultCgroupNamespaceMode != "" {
   348  		d.args = append(d.args, "--default-cgroupns-mode", d.defaultCgroupNamespaceMode)
   349  	}
   350  	if d.experimental {
   351  		d.args = append(d.args, "--experimental")
   352  	}
   353  	if d.init {
   354  		d.args = append(d.args, "--init")
   355  	}
   356  	if !(d.UseDefaultHost || d.UseDefaultTLSHost) {
   357  		d.args = append(d.args, "--host", d.Sock())
   358  	}
   359  	if root := os.Getenv("DOCKER_REMAP_ROOT"); root != "" {
   360  		d.args = append(d.args, "--userns-remap", root)
   361  	}
   362  
   363  	// If we don't explicitly set the log-level or debug flag(-D) then
   364  	// turn on debug mode
   365  	foundLog := false
   366  	foundSd := false
   367  	for _, a := range providedArgs {
   368  		if strings.Contains(a, "--log-level") || strings.Contains(a, "-D") || strings.Contains(a, "--debug") {
   369  			foundLog = true
   370  		}
   371  		if strings.Contains(a, "--storage-driver") {
   372  			foundSd = true
   373  		}
   374  	}
   375  	if !foundLog {
   376  		d.args = append(d.args, "--debug")
   377  	}
   378  	if d.storageDriver != "" && !foundSd {
   379  		d.args = append(d.args, "--storage-driver", d.storageDriver)
   380  	}
   381  
   382  	d.args = append(d.args, providedArgs...)
   383  	d.cmd = exec.Command(dockerdBinary, d.args...)
   384  	d.cmd.Env = append(os.Environ(), "DOCKER_SERVICE_PREFER_OFFLINE_IMAGE=1")
   385  	d.cmd.Stdout = out
   386  	d.cmd.Stderr = out
   387  	d.logFile = out
   388  	if d.rootlessUser != nil {
   389  		// sudo requires this for propagating signals
   390  		setsid(d.cmd)
   391  	}
   392  
   393  	if err := d.cmd.Start(); err != nil {
   394  		return errors.Wrapf(err, "[%s] could not start daemon container", d.id)
   395  	}
   396  
   397  	wait := make(chan error, 1)
   398  
   399  	go func() {
   400  		ret := d.cmd.Wait()
   401  		d.log.Logf("[%s] exiting daemon", d.id)
   402  		// If we send before logging, we might accidentally log _after_ the test is done.
   403  		// As of Go 1.12, this incurs a panic instead of silently being dropped.
   404  		wait <- ret
   405  		close(wait)
   406  	}()
   407  
   408  	d.Wait = wait
   409  
   410  	clientConfig, err := d.getClientConfig()
   411  	if err != nil {
   412  		return err
   413  	}
   414  	client := &http.Client{
   415  		Transport: clientConfig.transport,
   416  	}
   417  
   418  	req, err := http.NewRequest(http.MethodGet, "/_ping", nil)
   419  	if err != nil {
   420  		return errors.Wrapf(err, "[%s] could not create new request", d.id)
   421  	}
   422  	req.URL.Host = clientConfig.addr
   423  	req.URL.Scheme = clientConfig.scheme
   424  
   425  	ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
   426  	defer cancel()
   427  
   428  	// make sure daemon is ready to receive requests
   429  	for i := 0; ; i++ {
   430  		d.log.Logf("[%s] waiting for daemon to start", d.id)
   431  
   432  		select {
   433  		case <-ctx.Done():
   434  			return errors.Wrapf(ctx.Err(), "[%s] daemon exited and never started", d.id)
   435  		case err := <-d.Wait:
   436  			return errors.Wrapf(err, "[%s] daemon exited during startup", d.id)
   437  		default:
   438  			rctx, rcancel := context.WithTimeout(context.TODO(), 2*time.Second)
   439  			defer rcancel()
   440  
   441  			resp, err := client.Do(req.WithContext(rctx))
   442  			if err != nil {
   443  				if i > 2 { // don't log the first couple, this ends up just being noise
   444  					d.log.Logf("[%s] error pinging daemon on start: %v", d.id, err)
   445  				}
   446  
   447  				select {
   448  				case <-ctx.Done():
   449  				case <-time.After(500 * time.Millisecond):
   450  				}
   451  				continue
   452  			}
   453  
   454  			resp.Body.Close()
   455  			if resp.StatusCode != http.StatusOK {
   456  				d.log.Logf("[%s] received status != 200 OK: %s\n", d.id, resp.Status)
   457  			}
   458  			d.log.Logf("[%s] daemon started\n", d.id)
   459  			d.Root, err = d.queryRootDir()
   460  			if err != nil {
   461  				return errors.Wrapf(err, "[%s] error querying daemon for root directory", d.id)
   462  			}
   463  			return nil
   464  		}
   465  	}
   466  }
   467  
   468  // StartWithBusybox will first start the daemon with Daemon.Start()
   469  // then save the busybox image from the main daemon and load it into this Daemon instance.
   470  func (d *Daemon) StartWithBusybox(t testing.TB, arg ...string) {
   471  	t.Helper()
   472  	d.Start(t, arg...)
   473  	d.LoadBusybox(t)
   474  }
   475  
   476  // Kill will send a SIGKILL to the daemon
   477  func (d *Daemon) Kill() error {
   478  	if d.cmd == nil || d.Wait == nil {
   479  		return errDaemonNotStarted
   480  	}
   481  
   482  	defer func() {
   483  		d.logFile.Close()
   484  		d.cmd = nil
   485  	}()
   486  
   487  	if err := d.cmd.Process.Kill(); err != nil {
   488  		return err
   489  	}
   490  
   491  	if d.pidFile != "" {
   492  		_ = os.Remove(d.pidFile)
   493  	}
   494  	return nil
   495  }
   496  
   497  // Pid returns the pid of the daemon
   498  func (d *Daemon) Pid() int {
   499  	return d.cmd.Process.Pid
   500  }
   501  
   502  // Interrupt stops the daemon by sending it an Interrupt signal
   503  func (d *Daemon) Interrupt() error {
   504  	return d.Signal(os.Interrupt)
   505  }
   506  
   507  // Signal sends the specified signal to the daemon if running
   508  func (d *Daemon) Signal(signal os.Signal) error {
   509  	if d.cmd == nil || d.Wait == nil {
   510  		return errDaemonNotStarted
   511  	}
   512  	return d.cmd.Process.Signal(signal)
   513  }
   514  
   515  // DumpStackAndQuit sends SIGQUIT to the daemon, which triggers it to dump its
   516  // stack to its log file and exit
   517  // This is used primarily for gathering debug information on test timeout
   518  func (d *Daemon) DumpStackAndQuit() {
   519  	if d.cmd == nil || d.cmd.Process == nil {
   520  		return
   521  	}
   522  	SignalDaemonDump(d.cmd.Process.Pid)
   523  }
   524  
   525  // Stop will send a SIGINT every second and wait for the daemon to stop.
   526  // If it times out, a SIGKILL is sent.
   527  // Stop will not delete the daemon directory. If a purged daemon is needed,
   528  // instantiate a new one with NewDaemon.
   529  // If an error occurs while starting the daemon, the test will fail.
   530  func (d *Daemon) Stop(t testing.TB) {
   531  	t.Helper()
   532  	err := d.StopWithError()
   533  	if err != nil {
   534  		if err != errDaemonNotStarted {
   535  			t.Fatalf("[%s] error while stopping the daemon: %v", d.id, err)
   536  		} else {
   537  			t.Logf("[%s] daemon is not started", d.id)
   538  		}
   539  	}
   540  }
   541  
   542  // StopWithError will send a SIGINT every second and wait for the daemon to stop.
   543  // If it timeouts, a SIGKILL is sent.
   544  // Stop will not delete the daemon directory. If a purged daemon is needed,
   545  // instantiate a new one with NewDaemon.
   546  func (d *Daemon) StopWithError() (err error) {
   547  	if d.cmd == nil || d.Wait == nil {
   548  		return errDaemonNotStarted
   549  	}
   550  	defer func() {
   551  		if err != nil {
   552  			d.log.Logf("[%s] error while stopping daemon: %v", d.id, err)
   553  		} else {
   554  			d.log.Logf("[%s] daemon stopped", d.id)
   555  			if d.pidFile != "" {
   556  				_ = os.Remove(d.pidFile)
   557  			}
   558  		}
   559  		if err := d.logFile.Close(); err != nil {
   560  			d.log.Logf("[%s] failed to close daemon logfile: %v", d.id, err)
   561  		}
   562  		d.cmd = nil
   563  	}()
   564  
   565  	i := 1
   566  	ticker := time.NewTicker(time.Second)
   567  	defer ticker.Stop()
   568  	tick := ticker.C
   569  
   570  	d.log.Logf("[%s] stopping daemon", d.id)
   571  
   572  	if err := d.cmd.Process.Signal(os.Interrupt); err != nil {
   573  		if strings.Contains(err.Error(), "os: process already finished") {
   574  			return errDaemonNotStarted
   575  		}
   576  		return errors.Wrapf(err, "[%s] could not send signal", d.id)
   577  	}
   578  
   579  out1:
   580  	for {
   581  		select {
   582  		case err := <-d.Wait:
   583  			return err
   584  		case <-time.After(20 * time.Second):
   585  			// time for stopping jobs and run onShutdown hooks
   586  			d.log.Logf("[%s] daemon stop timed out after 20 seconds", d.id)
   587  			break out1
   588  		}
   589  	}
   590  
   591  out2:
   592  	for {
   593  		select {
   594  		case err := <-d.Wait:
   595  			return err
   596  		case <-tick:
   597  			i++
   598  			if i > 5 {
   599  				d.log.Logf("[%s] tried to interrupt daemon for %d times, now try to kill it", d.id, i)
   600  				break out2
   601  			}
   602  			d.log.Logf("[%d] attempt #%d/5: daemon is still running with pid %d", i, d.cmd.Process.Pid)
   603  			if err := d.cmd.Process.Signal(os.Interrupt); err != nil {
   604  				return errors.Wrapf(err, "[%s] attempt #%d/5 could not send signal", d.id, i)
   605  			}
   606  		}
   607  	}
   608  
   609  	if err := d.cmd.Process.Kill(); err != nil {
   610  		d.log.Logf("[%s] failed to kill daemon: %v", d.id, err)
   611  		return err
   612  	}
   613  
   614  	return nil
   615  }
   616  
   617  // Restart will restart the daemon by first stopping it and the starting it.
   618  // If an error occurs while starting the daemon, the test will fail.
   619  func (d *Daemon) Restart(t testing.TB, args ...string) {
   620  	t.Helper()
   621  	d.Stop(t)
   622  	d.Start(t, args...)
   623  }
   624  
   625  // RestartWithError will restart the daemon by first stopping it and then starting it.
   626  func (d *Daemon) RestartWithError(arg ...string) error {
   627  	if err := d.StopWithError(); err != nil {
   628  		return err
   629  	}
   630  	return d.StartWithError(arg...)
   631  }
   632  
   633  func (d *Daemon) handleUserns() {
   634  	// in the case of tests running a user namespace-enabled daemon, we have resolved
   635  	// d.Root to be the actual final path of the graph dir after the "uid.gid" of
   636  	// remapped root is added--we need to subtract it from the path before calling
   637  	// start or else we will continue making subdirectories rather than truly restarting
   638  	// with the same location/root:
   639  	if root := os.Getenv("DOCKER_REMAP_ROOT"); root != "" {
   640  		d.Root = filepath.Dir(d.Root)
   641  	}
   642  }
   643  
   644  // ReloadConfig asks the daemon to reload its configuration
   645  func (d *Daemon) ReloadConfig() error {
   646  	if d.cmd == nil || d.cmd.Process == nil {
   647  		return errors.New("daemon is not running")
   648  	}
   649  
   650  	errCh := make(chan error, 1)
   651  	started := make(chan struct{})
   652  	go func() {
   653  		_, body, err := request.Get("/events", request.Host(d.Sock()))
   654  		close(started)
   655  		if err != nil {
   656  			errCh <- err
   657  			return
   658  		}
   659  		defer body.Close()
   660  		dec := json.NewDecoder(body)
   661  		for {
   662  			var e events.Message
   663  			if err := dec.Decode(&e); err != nil {
   664  				errCh <- err
   665  				return
   666  			}
   667  			if e.Type != events.DaemonEventType {
   668  				continue
   669  			}
   670  			if e.Action != "reload" {
   671  				continue
   672  			}
   673  			close(errCh) // notify that we are done
   674  			return
   675  		}
   676  	}()
   677  
   678  	<-started
   679  	if err := signalDaemonReload(d.cmd.Process.Pid); err != nil {
   680  		return errors.Wrapf(err, "[%s] error signaling daemon reload", d.id)
   681  	}
   682  	select {
   683  	case err := <-errCh:
   684  		if err != nil {
   685  			return errors.Wrapf(err, "[%s] error waiting for daemon reload event", d.id)
   686  		}
   687  	case <-time.After(30 * time.Second):
   688  		return errors.Errorf("[%s] daemon reload event timed out after 30 seconds", d.id)
   689  	}
   690  	return nil
   691  }
   692  
   693  // LoadBusybox image into the daemon
   694  func (d *Daemon) LoadBusybox(t testing.TB) {
   695  	t.Helper()
   696  	clientHost, err := client.NewClientWithOpts(client.FromEnv)
   697  	assert.NilError(t, err, "[%s] failed to create client", d.id)
   698  	defer clientHost.Close()
   699  
   700  	ctx := context.Background()
   701  	reader, err := clientHost.ImageSave(ctx, []string{"busybox:latest"})
   702  	assert.NilError(t, err, "[%s] failed to download busybox", d.id)
   703  	defer reader.Close()
   704  
   705  	c := d.NewClientT(t)
   706  	defer c.Close()
   707  
   708  	resp, err := c.ImageLoad(ctx, reader, true)
   709  	assert.NilError(t, err, "[%s] failed to load busybox", d.id)
   710  	defer resp.Body.Close()
   711  }
   712  
   713  func (d *Daemon) getClientConfig() (*clientConfig, error) {
   714  	var (
   715  		transport *http.Transport
   716  		scheme    string
   717  		addr      string
   718  		proto     string
   719  	)
   720  	if d.UseDefaultTLSHost {
   721  		option := &tlsconfig.Options{
   722  			CAFile:   "fixtures/https/ca.pem",
   723  			CertFile: "fixtures/https/client-cert.pem",
   724  			KeyFile:  "fixtures/https/client-key.pem",
   725  		}
   726  		tlsConfig, err := tlsconfig.Client(*option)
   727  		if err != nil {
   728  			return nil, err
   729  		}
   730  		transport = &http.Transport{
   731  			TLSClientConfig: tlsConfig,
   732  		}
   733  		addr = fmt.Sprintf("%s:%d", opts.DefaultHTTPHost, opts.DefaultTLSHTTPPort)
   734  		scheme = "https"
   735  		proto = "tcp"
   736  	} else if d.UseDefaultHost {
   737  		addr = opts.DefaultUnixSocket
   738  		proto = "unix"
   739  		scheme = "http"
   740  		transport = &http.Transport{}
   741  	} else {
   742  		addr = d.sockPath()
   743  		proto = "unix"
   744  		scheme = "http"
   745  		transport = &http.Transport{}
   746  	}
   747  
   748  	if err := sockets.ConfigureTransport(transport, proto, addr); err != nil {
   749  		return nil, err
   750  	}
   751  	transport.DisableKeepAlives = true
   752  	if proto == "unix" {
   753  		addr = filepath.Base(addr)
   754  	}
   755  	return &clientConfig{
   756  		transport: transport,
   757  		scheme:    scheme,
   758  		addr:      addr,
   759  	}, nil
   760  }
   761  
   762  func (d *Daemon) queryRootDir() (string, error) {
   763  	// update daemon root by asking /info endpoint (to support user
   764  	// namespaced daemon with root remapped uid.gid directory)
   765  	clientConfig, err := d.getClientConfig()
   766  	if err != nil {
   767  		return "", err
   768  	}
   769  
   770  	c := &http.Client{
   771  		Transport: clientConfig.transport,
   772  	}
   773  
   774  	req, err := http.NewRequest(http.MethodGet, "/info", nil)
   775  	if err != nil {
   776  		return "", err
   777  	}
   778  	req.Header.Set("Content-Type", "application/json")
   779  	req.URL.Host = clientConfig.addr
   780  	req.URL.Scheme = clientConfig.scheme
   781  
   782  	resp, err := c.Do(req)
   783  	if err != nil {
   784  		return "", err
   785  	}
   786  	body := ioutils.NewReadCloserWrapper(resp.Body, func() error {
   787  		return resp.Body.Close()
   788  	})
   789  
   790  	type Info struct {
   791  		DockerRootDir string
   792  	}
   793  	var b []byte
   794  	var i Info
   795  	b, err = request.ReadBody(body)
   796  	if err == nil && resp.StatusCode == http.StatusOK {
   797  		// read the docker root dir
   798  		if err = json.Unmarshal(b, &i); err == nil {
   799  			return i.DockerRootDir, nil
   800  		}
   801  	}
   802  	return "", err
   803  }
   804  
   805  // Info returns the info struct for this daemon
   806  func (d *Daemon) Info(t testing.TB) types.Info {
   807  	t.Helper()
   808  	c := d.NewClientT(t)
   809  	info, err := c.Info(context.Background())
   810  	assert.NilError(t, err)
   811  	assert.NilError(t, c.Close())
   812  	return info
   813  }
   814  
   815  // cleanupRaftDir removes swarmkit wal files if present
   816  func cleanupRaftDir(t testing.TB, d *Daemon) {
   817  	t.Helper()
   818  	for _, p := range []string{"wal", "wal-v3-encrypted", "snap-v3-encrypted"} {
   819  		dir := filepath.Join(d.Root, "swarm/raft", p)
   820  		if err := os.RemoveAll(dir); err != nil {
   821  			t.Logf("[%s] error removing %v: %v", d.id, dir, err)
   822  		}
   823  	}
   824  }