daemon.go 22 KB

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