Merge pull request #1599 from hoffoo/initial_check_state

Add support for initial check status

command/agent/consul/syncer.go

@@ -720,6 +720,7 @@ func (c *Syncer) createCheckReg(check *structs.ServiceCheck, serviceReg *consul.
 	default:
 		return nil, fmt.Errorf("check type %+q not valid", check.Type)
 	}
+	chkReg.Status = check.InitialStatus
 	return &chkReg, nil
 }
 

command/agent/consul/syncer_test.go

@@ -21,10 +21,11 @@ const (
 var (
 	logger = log.New(os.Stdout, "", log.LstdFlags)
 	check1 = structs.ServiceCheck{
-		Name:     "check-foo-1",
-		Type:     structs.ServiceCheckTCP,
-		Interval: 30 * time.Second,
-		Timeout:  5 * time.Second,
+		Name:          "check-foo-1",
+		Type:          structs.ServiceCheckTCP,
+		Interval:      30 * time.Second,
+		Timeout:       5 * time.Second,
+		InitialStatus: "passing",
 	}
 	check2 = structs.ServiceCheck{
 		Name:      "check1",
@@ -86,6 +87,10 @@ func TestCheckRegistration(t *testing.T) {
 		t.Fatalf("expected: %v, actual: %v", expected, check3Reg.HTTP)
 	}
 
+	expected = "passing"
+	if check1Reg.Status != expected {
+		t.Fatalf("expected: %v, actual: %v", expected, check1Reg.Status)
+	}
 }
 
 func TestConsulServiceRegisterServices(t *testing.T) {

jobspec/parse.go

@@ -770,6 +770,7 @@ func parseChecks(service *structs.Service, checkObjs *ast.ObjectList) error {
 			"port",
 			"command",
 			"args",
+			"initial_status",
 		}
 		if err := checkHCLKeys(co.Val, valid); err != nil {
 			return multierror.Prefix(err, "check ->")

jobspec/parse_test.go

@@ -384,6 +384,45 @@ func TestParse(t *testing.T) {
 			},
 			false,
 		},
+		{
+			"service-check-initial-status.hcl",
+			&structs.Job{
+				ID:       "check_initial_status",
+				Name:     "check_initial_status",
+				Type:     "service",
+				Priority: 50,
+				Region:   "global",
+				TaskGroups: []*structs.TaskGroup{
+					&structs.TaskGroup{
+						Name:  "group",
+						Count: 1,
+						Tasks: []*structs.Task{
+							&structs.Task{
+								Name: "task",
+								Services: []*structs.Service{
+									{
+										Name:      "check_initial_status-group-task",
+										Tags:      []string{"foo", "bar"},
+										PortLabel: "http",
+										Checks: []*structs.ServiceCheck{
+											{
+												Name:          "check-name",
+												Type:          "http",
+												Interval:      10 * time.Second,
+												Timeout:       2 * time.Second,
+												InitialStatus: "passing",
+											},
+										},
+									},
+								},
+								LogConfig: structs.DefaultLogConfig(),
+							},
+						},
+					},
+				},
+			},
+			false,
+		},
 	}
 
 	for _, tc := range cases {

jobspec/test-fixtures/service-check-initial-status.hcl

@@ -0,0 +1,23 @@
+job "check_initial_status" {
+
+    type = "service"
+    group "group" {
+        count = 1
+
+        task "task" {
+          service {
+            tags = ["foo", "bar"]
+            port = "http"
+
+            check {
+              name     = "check-name"
+              type     = "http"
+              interval = "10s"
+              timeout  = "2s"
+              initial_status = "passing"
+            }
+          }
+        }
+    }
+}
+

nomad/structs/structs.go

@@ -18,6 +18,7 @@ import (
 	"time"
 
 	"github.com/gorhill/cronexpr"
+	"github.com/hashicorp/consul/api"
 	"github.com/hashicorp/go-multierror"
 	"github.com/hashicorp/go-version"
 	"github.com/hashicorp/nomad/helper/args"
@@ -1591,15 +1592,16 @@ const (
 // The ServiceCheck data model represents the consul health check that
 // Nomad registers for a Task
 type ServiceCheck struct {
-	Name      string        // Name of the check, defaults to id
-	Type      string        // Type of the check - tcp, http, docker and script
-	Command   string        // Command is the command to run for script checks
-	Args      []string      // Args is a list of argumes for script checks
-	Path      string        // path of the health check url for http type check
-	Protocol  string        // Protocol to use if check is http, defaults to http
-	PortLabel string        `mapstructure:"port"` // The port to use for tcp/http checks
-	Interval  time.Duration // Interval of the check
-	Timeout   time.Duration // Timeout of the response from the check before consul fails the check
+	Name          string        // Name of the check, defaults to id
+	Type          string        // Type of the check - tcp, http, docker and script
+	Command       string        // Command is the command to run for script checks
+	Args          []string      // Args is a list of argumes for script checks
+	Path          string        // path of the health check url for http type check
+	Protocol      string        // Protocol to use if check is http, defaults to http
+	PortLabel     string        `mapstructure:"port"` // The port to use for tcp/http checks
+	Interval      time.Duration // Interval of the check
+	Timeout       time.Duration // Timeout of the response from the check before consul fails the check
+	InitialStatus string        `mapstructure:"initial_status"` // Initial status of the check
 }
 
 func (sc *ServiceCheck) Copy() *ServiceCheck {
@@ -1653,6 +1655,17 @@ func (sc *ServiceCheck) validate() error {
 		return fmt.Errorf("interval (%v) can not be lower than %v", sc.Interval, minCheckInterval)
 	}
 
+	switch sc.InitialStatus {
+	case "":
+	case api.HealthUnknown:
+	case api.HealthPassing:
+	case api.HealthWarning:
+	case api.HealthCritical:
+	default:
+		return fmt.Errorf(`invalid initial check state (%s), must be one of %q, %q, %q, %q or empty`, sc.InitialStatus, api.HealthUnknown, api.HealthPassing, api.HealthWarning, api.HealthCritical)
+
+	}
+
 	return nil
 }
 

nomad/structs/structs_test.go

@@ -6,6 +6,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hashicorp/consul/api"
 	"github.com/hashicorp/go-multierror"
 )
 
@@ -364,6 +365,49 @@ func TestTask_Validate_Services(t *testing.T) {
 	}
 }
 
+func TestTask_Validate_Service_Check(t *testing.T) {
+
+	check1 := ServiceCheck{
+		Name:     "check-name",
+		Type:     ServiceCheckTCP,
+		Interval: 10 * time.Second,
+		Timeout:  2 * time.Second,
+	}
+
+	err := check1.validate()
+	if err != nil {
+		t.Fatal("err: %v", err)
+	}
+
+	check1.InitialStatus = "foo"
+	err = check1.validate()
+	if err == nil {
+		t.Fatal("Expected an error")
+	}
+
+	if !strings.Contains(err.Error(), "invalid initial check state (foo)") {
+		t.Fatalf("err: %v", err)
+	}
+
+	check1.InitialStatus = api.HealthCritical
+	err = check1.validate()
+	if err != nil {
+		t.Fatalf("err: %v", err)
+	}
+
+	check1.InitialStatus = api.HealthPassing
+	err = check1.validate()
+	if err != nil {
+		t.Fatalf("err: %v", err)
+	}
+
+	check1.InitialStatus = ""
+	err = check1.validate()
+	if err != nil {
+		t.Fatalf("err: %v", err)
+	}
+}
+
 func TestTask_Validate_LogConfig(t *testing.T) {
 	task := &Task{
 		LogConfig: DefaultLogConfig(),