cli_restart_test.go

package main

import (
	"strings"

	"github.com/alibaba/pouch/test/command"
	"github.com/alibaba/pouch/test/environment"

	"github.com/go-check/check"
	"github.com/gotestyourself/gotestyourself/icmd"
)

// PouchRestartSuite is the test suite for restart CLI.
type PouchRestartSuite struct{}

func init() {
	check.Suite(&PouchRestartSuite{})
}

// SetUpSuite does common setup in the beginning of each test suite.
func (suite *PouchRestartSuite) SetUpSuite(c *check.C) {
	SkipIfFalse(c, environment.IsLinux)

	environment.PruneAllContainers(apiClient)

	command.PouchRun("pull", busyboxImage).Assert(c, icmd.Success)
}

// TearDownTest does cleanup work in the end of each test.
func (suite *PouchRestartSuite) TearDownTest(c *check.C) {
}

// TestPouchRestartRunningContainer is to verify the correctness of restarting a running container.
func (suite *PouchRestartSuite) TestPouchRestartRunningContainer(c *check.C) {
	name := "TestPouchRestartRunningContainer"

	res := command.PouchRun("run", "-d", "--name", name, busyboxImage, "top")
	defer DelContainerForceMultyTime(c, name)
	res.Assert(c, icmd.Success)

	res = command.PouchRun("restart", "-t", "1", name)
	res.Assert(c, icmd.Success)

	if out := res.Combined(); !strings.Contains(out, name) {
		c.Fatalf("unexpected output: %s, expected: %s", out, name)
	}
}

// TestPouchRestartCreatedContainer is to verify the correctness of restarting a created container.
// Pouch should be compatible with moby's API. Restarting a created container is allowed.
func (suite *PouchRestartSuite) TestPouchRestartCreatedContainer(c *check.C) {
	name := "TestPouchRestartCreatedContainer"

	res := command.PouchRun("create", "--name", name, busyboxImage, "top")
	defer DelContainerForceMultyTime(c, name)

	res.Assert(c, icmd.Success)

	command.PouchRun("restart", "-t", "1", name).Assert(c, icmd.Success)
}

// TestPouchRestartExitedContainer is to verify the correctness of restarting an exited container.
// Pouch should be compatible with moby's API. Restarting an exited container is allowed.
func (suite *PouchRestartSuite) TestPouchRestartExitedContainer(c *check.C) {
	name := "TestPouchRestartExitedContainer"

	// run a container and make it exit.
	res := command.PouchRun("run", "--name", name, busyboxImage, "ls")
	defer DelContainerForceMultyTime(c, name)
	res.Assert(c, icmd.Success)

	command.PouchRun("wait", name).Assert(c, icmd.Success)

	command.PouchRun("restart", "-t", "1", name).Assert(c, icmd.Success)
}

// TestPouchRestartStoppedContainer is to verify the correctness of restarting a stopped container.
// Pouch should be compatible with moby's API. Restarting a stopped container is allowed.
func (suite *PouchRestartSuite) TestPouchRestartStoppedContainer(c *check.C) {
	name := "TestPouchRestartStoppedContainer"

	res := command.PouchRun("run", "-d", "--name", name, busyboxImage, "top")
	defer DelContainerForceMultyTime(c, name)

	res.Assert(c, icmd.Success)

	command.PouchRun("stop", "-t", "1", name).Assert(c, icmd.Success)

	command.PouchRun("restart", "-t", "1", name).Assert(c, icmd.Success)
}

// TestPouchRestartPausedContainer is to verify restart paused container
func (suite *PouchRestartSuite) TestPouchRestartPausedContainer(c *check.C) {
	name := "TestPouchRestartPausedContainer"

	res := command.PouchRun("run", "-d", "--name", name, busyboxImage, "top")
	defer DelContainerForceMultyTime(c, name)
	res.Assert(c, icmd.Success)

	command.PouchRun("pause", name).Assert(c, icmd.Success)

	command.PouchRun("restart", name).Assert(c, icmd.Success)
}

// TestPouchRestartMultiContainers is to verify the correctness of restarting more than one running container.
func (suite *PouchRestartSuite) TestPouchRestartMultiContainers(c *check.C) {
	containernames := []string{"TestPouchRestartMultiContainer-1", "TestPouchRestartMultiContainer-2"}
	for _, name := range containernames {
		res := command.PouchRun("run", "-d", "--name", name, busyboxImage, "top")
		defer DelContainerForceMultyTime(c, name)
		res.Assert(c, icmd.Success)
	}

	res := command.PouchRun("restart", "-t", "1", containernames[0], containernames[1])
	res.Assert(c, icmd.Success)

	if out := res.Combined(); !strings.Contains(out, containernames[0]) || !strings.Contains(out, containernames[1]) {
		c.Fatalf("unexpected output: %s, expected: %s\n%s", out, containernames[0], containernames[1])
	}
}

// TestPouchRestartMakeSnapshotterStillExist tests snapshotter holder functionality.
//
// NOTE: PouchContainer uses containerd lease and gc key reference to hold the
// container's writable layer. The containerd lease object will hold reference
// to container's writable layer until we remove the lease object. Basically,
// we don't remove the lease object so that the container's writable layer will
// be hold until we remove container.
//
// The container metadata in containerd side also holds the gc reference to
// container's writable snapshotter by option containerd.WithSnapshot. When
// container quits, the metadata will be removed by pouch exit hook. With lease
// the RW snapshotter is still referenced by lease and not deleted by GC. So
// we restart the container and it should be success.
func (suite *PouchRestartSuite) TestPouchRestartMakeSnapshotterStillExist(c *check.C) {
	cname := "TestPouchRestartMakeSnapshotterStillExist"
	res := command.PouchRun("run", "--name", cname, busyboxImage, "sh", "-c", "ls -al /bin")
	res.Assert(c, icmd.Success)
	defer DelContainerForceMultyTime(c, cname)

	lines := res.Stdout()
	c.Assert(len(strings.Split(lines, "\n")) > 3, check.Equals, true)

	// try to trigger containerd gc by image remove
	//
	// TODO(fuweid): slow...
	command.PouchRun("pull", busyboxImage125).Assert(c, icmd.Success)
	command.PouchRun("rmi", busyboxImage125).Assert(c, icmd.Success)

	// the container snapshotter should be hold by containerd lease named by pouchd.leases.
	res = command.PouchRun("start", "-a", cname)
	res.Assert(c, icmd.Success)

	// since no one changes bin folder, the output should be the same.
	secondLines := res.Stdout()
	c.Assert(lines, check.Equals, secondLines)
}