add 'stop_grace_period'

gitlawr · gitlawr · commit 81e078615f60 · 2017-05-04T13:20:03.000+08:00
fix #447 This commit add support for 'stop_grace_period' The key is available in compose V2 and with docker API version 1.25+ Signed-off-by: Lawrence Li <lawrleegle@gmail.com>
diff --git a/cli/command/command.go b/cli/command/command.go
@@ -228,7 +228,6 @@ func RestartCommand(factory app.ProjectFactory) cli.Command {
 			cli.IntFlag{
 				Name:  "timeout,t",
 				Usage: "Specify a shutdown timeout in seconds.",
-				Value: 10,
 			},
 		},
 	}
@@ -244,7 +243,6 @@ func StopCommand(factory app.ProjectFactory) cli.Command {
 			cli.IntFlag{
 				Name:  "timeout,t",
 				Usage: "Specify a shutdown timeout in seconds.",
-				Value: 10,
 			},
 		},
 	}
@@ -283,7 +281,6 @@ func ScaleCommand(factory app.ProjectFactory) cli.Command {
 			cli.IntFlag{
 				Name:  "timeout,t",
 				Usage: "Specify a shutdown timeout in seconds.",
-				Value: 10,
 			},
 		},
 	}
diff --git a/config/schema.go b/config/schema.go
@@ -347,6 +347,7 @@ var servicesSchemaDataV2 = `{
         "security_opt": {"type": "array", "items": {"type": "string"}, "uniqueItems": true},
         "shm_size": {"type": ["number", "string"]},
         "stdin_open": {"type": "boolean"},
+        "stop_grace_period": {"type": "string"},
         "stop_signal": {"type": "string"},
         "tmpfs": {"$ref": "#/definitions/string_or_list"},
         "tty": {"type": "boolean"},
diff --git a/config/types.go b/config/types.go
@@ -85,63 +85,64 @@ type Log struct {
 
 // ServiceConfig holds version 2 of libcompose service configuration
 type ServiceConfig struct {
-	Build          yaml.Build           `yaml:"build,omitempty"`
-	CapAdd         []string             `yaml:"cap_add,omitempty"`
-	CapDrop        []string             `yaml:"cap_drop,omitempty"`
-	CPUSet         string               `yaml:"cpuset,omitempty"`
-	CPUShares      yaml.StringorInt     `yaml:"cpu_shares,omitempty"`
-	CPUQuota       yaml.StringorInt     `yaml:"cpu_quota,omitempty"`
-	Command        yaml.Command         `yaml:"command,flow,omitempty"`
-	CgroupParent   string               `yaml:"cgroup_parent,omitempty"`
-	ContainerName  string               `yaml:"container_name,omitempty"`
-	Devices        []string             `yaml:"devices,omitempty"`
-	DependsOn      []string             `yaml:"depends_on,omitempty"`
-	DNS            yaml.Stringorslice   `yaml:"dns,omitempty"`
-	DNSOpts        []string             `yaml:"dns_opt,omitempty"`
-	DNSSearch      yaml.Stringorslice   `yaml:"dns_search,omitempty"`
-	DomainName     string               `yaml:"domainname,omitempty"`
-	Entrypoint     yaml.Command         `yaml:"entrypoint,flow,omitempty"`
-	EnvFile        yaml.Stringorslice   `yaml:"env_file,omitempty"`
-	Environment    yaml.MaporEqualSlice `yaml:"environment,omitempty"`
-	Expose         []string             `yaml:"expose,omitempty"`
-	Extends        yaml.MaporEqualSlice `yaml:"extends,omitempty"`
-	ExternalLinks  []string             `yaml:"external_links,omitempty"`
-	ExtraHosts     []string             `yaml:"extra_hosts,omitempty"`
-	GroupAdd       []string             `yaml:"group_add,omitempty"`
-	Image          string               `yaml:"image,omitempty"`
-	Isolation      string               `yaml:"isolation,omitempty"`
-	Hostname       string               `yaml:"hostname,omitempty"`
-	Ipc            string               `yaml:"ipc,omitempty"`
-	Labels         yaml.SliceorMap      `yaml:"labels,omitempty"`
-	Links          yaml.MaporColonSlice `yaml:"links,omitempty"`
-	Logging        Log                  `yaml:"logging,omitempty"`
-	MacAddress     string               `yaml:"mac_address,omitempty"`
-	MemLimit       yaml.MemStringorInt  `yaml:"mem_limit,omitempty"`
-	MemReservation yaml.MemStringorInt  `yaml:"mem_reservation,omitempty"`
-	MemSwapLimit   yaml.MemStringorInt  `yaml:"memswap_limit,omitempty"`
-	MemSwappiness  yaml.MemStringorInt  `yaml:"mem_swappiness,omitempty"`
-	NetworkMode    string               `yaml:"network_mode,omitempty"`
-	Networks       *yaml.Networks       `yaml:"networks,omitempty"`
-	OomKillDisable bool                 `yaml:"oom_kill_disable,omitempty"`
-	OomScoreAdj    yaml.StringorInt     `yaml:"oom_score_adj,omitempty"`
-	Pid            string               `yaml:"pid,omitempty"`
-	Ports          []string             `yaml:"ports,omitempty"`
-	Privileged     bool                 `yaml:"privileged,omitempty"`
-	SecurityOpt    []string             `yaml:"security_opt,omitempty"`
-	ShmSize        yaml.MemStringorInt  `yaml:"shm_size,omitempty"`
-	StopSignal     string               `yaml:"stop_signal,omitempty"`
-	Tmpfs          yaml.Stringorslice   `yaml:"tmpfs,omitempty"`
-	VolumeDriver   string               `yaml:"volume_driver,omitempty"`
-	Volumes        *yaml.Volumes        `yaml:"volumes,omitempty"`
-	VolumesFrom    []string             `yaml:"volumes_from,omitempty"`
-	Uts            string               `yaml:"uts,omitempty"`
-	Restart        string               `yaml:"restart,omitempty"`
-	ReadOnly       bool                 `yaml:"read_only,omitempty"`
-	StdinOpen      bool                 `yaml:"stdin_open,omitempty"`
-	Tty            bool                 `yaml:"tty,omitempty"`
-	User           string               `yaml:"user,omitempty"`
-	WorkingDir     string               `yaml:"working_dir,omitempty"`
-	Ulimits        yaml.Ulimits         `yaml:"ulimits,omitempty"`
+	Build           yaml.Build           `yaml:"build,omitempty"`
+	CapAdd          []string             `yaml:"cap_add,omitempty"`
+	CapDrop         []string             `yaml:"cap_drop,omitempty"`
+	CPUSet          string               `yaml:"cpuset,omitempty"`
+	CPUShares       yaml.StringorInt     `yaml:"cpu_shares,omitempty"`
+	CPUQuota        yaml.StringorInt     `yaml:"cpu_quota,omitempty"`
+	Command         yaml.Command         `yaml:"command,flow,omitempty"`
+	CgroupParent    string               `yaml:"cgroup_parent,omitempty"`
+	ContainerName   string               `yaml:"container_name,omitempty"`
+	Devices         []string             `yaml:"devices,omitempty"`
+	DependsOn       []string             `yaml:"depends_on,omitempty"`
+	DNS             yaml.Stringorslice   `yaml:"dns,omitempty"`
+	DNSOpts         []string             `yaml:"dns_opt,omitempty"`
+	DNSSearch       yaml.Stringorslice   `yaml:"dns_search,omitempty"`
+	DomainName      string               `yaml:"domainname,omitempty"`
+	Entrypoint      yaml.Command         `yaml:"entrypoint,flow,omitempty"`
+	EnvFile         yaml.Stringorslice   `yaml:"env_file,omitempty"`
+	Environment     yaml.MaporEqualSlice `yaml:"environment,omitempty"`
+	Expose          []string             `yaml:"expose,omitempty"`
+	Extends         yaml.MaporEqualSlice `yaml:"extends,omitempty"`
+	ExternalLinks   []string             `yaml:"external_links,omitempty"`
+	ExtraHosts      []string             `yaml:"extra_hosts,omitempty"`
+	GroupAdd        []string             `yaml:"group_add,omitempty"`
+	Image           string               `yaml:"image,omitempty"`
+	Isolation       string               `yaml:"isolation,omitempty"`
+	Hostname        string               `yaml:"hostname,omitempty"`
+	Ipc             string               `yaml:"ipc,omitempty"`
+	Labels          yaml.SliceorMap      `yaml:"labels,omitempty"`
+	Links           yaml.MaporColonSlice `yaml:"links,omitempty"`
+	Logging         Log                  `yaml:"logging,omitempty"`
+	MacAddress      string               `yaml:"mac_address,omitempty"`
+	MemLimit        yaml.MemStringorInt  `yaml:"mem_limit,omitempty"`
+	MemReservation  yaml.MemStringorInt  `yaml:"mem_reservation,omitempty"`
+	MemSwapLimit    yaml.MemStringorInt  `yaml:"memswap_limit,omitempty"`
+	MemSwappiness   yaml.MemStringorInt  `yaml:"mem_swappiness,omitempty"`
+	NetworkMode     string               `yaml:"network_mode,omitempty"`
+	Networks        *yaml.Networks       `yaml:"networks,omitempty"`
+	OomKillDisable  bool                 `yaml:"oom_kill_disable,omitempty"`
+	OomScoreAdj     yaml.StringorInt     `yaml:"oom_score_adj,omitempty"`
+	Pid             string               `yaml:"pid,omitempty"`
+	Ports           []string             `yaml:"ports,omitempty"`
+	Privileged      bool                 `yaml:"privileged,omitempty"`
+	SecurityOpt     []string             `yaml:"security_opt,omitempty"`
+	ShmSize         yaml.MemStringorInt  `yaml:"shm_size,omitempty"`
+	StopGracePeriod string               `yaml:"stop_grace_period,omitempty"`
+	StopSignal      string               `yaml:"stop_signal,omitempty"`
+	Tmpfs           yaml.Stringorslice   `yaml:"tmpfs,omitempty"`
+	VolumeDriver    string               `yaml:"volume_driver,omitempty"`
+	Volumes         *yaml.Volumes        `yaml:"volumes,omitempty"`
+	VolumesFrom     []string             `yaml:"volumes_from,omitempty"`
+	Uts             string               `yaml:"uts,omitempty"`
+	Restart         string               `yaml:"restart,omitempty"`
+	ReadOnly        bool                 `yaml:"read_only,omitempty"`
+	StdinOpen       bool                 `yaml:"stdin_open,omitempty"`
+	Tty             bool                 `yaml:"tty,omitempty"`
+	User            string               `yaml:"user,omitempty"`
+	WorkingDir      string               `yaml:"working_dir,omitempty"`
+	Ulimits         yaml.Ulimits         `yaml:"ulimits,omitempty"`
 }
 
 // VolumeConfig holds v2 volume configuration
diff --git a/docker/service/convert.go b/docker/service/convert.go
@@ -166,6 +166,7 @@ func Convert(c *config.ServiceConfig, ctx project.Context, clientFactory compose
 		Volumes:      toMap(Filter(vols, isVolume)),
 		MacAddress:   c.MacAddress,
 		StopSignal:   c.StopSignal,
+		StopTimeout:  utils.DurationStrToSecondsInt(c.StopGracePeriod),
 	}
 
 	ulimits := []*units.Ulimit{}
diff --git a/docker/service/convert_test.go b/docker/service/convert_test.go
@@ -171,6 +171,17 @@ func TestOomScoreAdj(t *testing.T) {
 	assert.Equal(t, 500, hostCfg.OomScoreAdj)
 }
 
+func TestStopGracePeriod(t *testing.T) {
+	ctx := &ctx.Context{}
+	sc := &config.ServiceConfig{
+		StopGracePeriod: "5s",
+	}
+	cfg, _, err := Convert(sc, ctx.Context, nil)
+	assert.Nil(t, err)
+
+	assert.Equal(t, 5, *cfg.StopTimeout)
+}
+
 func TestStopSignal(t *testing.T) {
 	ctx := &ctx.Context{}
 	sc := &config.ServiceConfig{
diff --git a/docker/service/service.go b/docker/service/service.go
@@ -525,13 +525,15 @@ func (s *Service) eachContainer(ctx context.Context, containers []*container.Con
 
 // Stop implements Service.Stop. It stops any containers related to the service.
 func (s *Service) Stop(ctx context.Context, timeout int) error {
+	timeout = s.stopTimeout(timeout)
 	return s.collectContainersAndDo(ctx, func(c *container.Container) error {
 		return c.Stop(ctx, timeout)
 	})
 }
 
 // Restart implements Service.Restart. It restarts any containers related to the service.
 func (s *Service) Restart(ctx context.Context, timeout int) error {
+	timeout = s.stopTimeout(timeout)
 	return s.collectContainersAndDo(ctx, func(c *container.Container) error {
 		return c.Restart(ctx, timeout)
 	})
@@ -587,6 +589,7 @@ func (s *Service) Scale(ctx context.Context, scale int, timeout int) error {
 		for _, c := range containers {
 			foundCount++
 			if foundCount > scale {
+				timeout = s.stopTimeout(timeout)
 				if err := c.Stop(ctx, timeout); err != nil {
 					return err
 				}
@@ -728,3 +731,19 @@ func (s *Service) specificiesHostPort() bool {
 
 	return false
 }
+
+//take in timeout flag from cli as parameter
+//return timeout if it is set,
+//else return stop_grace_period if it is set,
+//else return default 10s
+func (s *Service) stopTimeout(timeout int) int {
+	DEFAULTTIMEOUT := 10
+	if timeout != 0 {
+		return timeout
+	}
+	configTimeout := utils.DurationStrToSecondsInt(s.Config().StopGracePeriod)
+	if configTimeout != nil {
+		return *configTimeout
+	}
+	return DEFAULTTIMEOUT
+}
diff --git a/utils/util.go b/utils/util.go
@@ -3,6 +3,7 @@ package utils
 import (
 	"encoding/json"
 	"sync"
+	"time"
 
 	"github.com/Sirupsen/logrus"
 
@@ -160,3 +161,18 @@ func ConvertKeysToStrings(item interface{}) interface{} {
 		return item
 	}
 }
+
+// DurationStrToSecondsInt converts duration string to *int in seconds
+func DurationStrToSecondsInt(s string) *int {
+	if s == "" {
+		return nil
+	}
+	duration, err := time.ParseDuration(s)
+	if err != nil {
+		logrus.Errorf("Failed to parse duration:%v", s)
+		return nil
+	}
+	r := (int)(duration.Seconds())
+	return &r
+
+}

Original file line number	Diff line number	Diff line change
`@@ -166,6 +166,7 @@ func Convert(c *config.ServiceConfig, ctx project.Context, clientFactory compose`
`166`	`166`	`Volumes: toMap(Filter(vols, isVolume)),`
`167`	`167`	`MacAddress: c.MacAddress,`
`168`	`168`	`StopSignal: c.StopSignal,`
	`169`	`+ StopTimeout: utils.DurationStrToSecondsInt(c.StopGracePeriod),`
`169`	`170`	`}`
`170`	`171`
`171`	`172`	`ulimits := []*units.Ulimit{}`