Remove the script field from checks in favor of args

hashicorp · May 8, 2018 · b73323a · b73323a
1 parent cc214d4
commit b73323a
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 93 deletions.
diff --git a/agent/agent.go b/agent/agent.go
@@ -1823,11 +1823,6 @@ func (a *Agent) AddCheck(check *structs.HealthCheck, chkType *structs.CheckType,
 					check.CheckID, checks.MinInterval))
 				chkType.Interval = checks.MinInterval
 			}
-			if chkType.Script != "" {
-				a.logger.Printf("[WARN] agent: check %q has the 'script' field, which has been deprecated "+
-					"and replaced with the 'args' field. See https://www.consul.io/docs/agent/checks.html",
-					check.CheckID)
-			}
 
 			if a.dockerClient == nil {
 				dc, err := checks.NewDockerClient(os.Getenv("DOCKER_HOST"), checks.BufSize)
@@ -1844,7 +1839,6 @@ func (a *Agent) AddCheck(check *structs.HealthCheck, chkType *structs.CheckType,
 				CheckID:           check.CheckID,
 				DockerContainerID: chkType.DockerContainerID,
 				Shell:             chkType.Shell,
-				Script:            chkType.Script,
 				ScriptArgs:        chkType.ScriptArgs,
 				Interval:          chkType.Interval,
 				Logger:            a.logger,
@@ -1866,16 +1860,10 @@ func (a *Agent) AddCheck(check *structs.HealthCheck, chkType *structs.CheckType,
 					check.CheckID, checks.MinInterval)
 				chkType.Interval = checks.MinInterval
 			}
-			if chkType.Script != "" {
-				a.logger.Printf("[WARN] agent: check %q has the 'script' field, which has been deprecated "+
-					"and replaced with the 'args' field. See https://www.consul.io/docs/agent/checks.html",
-					check.CheckID)
-			}
 
 			monitor := &checks.CheckMonitor{
 				Notify:     a.State,
 				CheckID:    check.CheckID,
-				Script:     chkType.Script,
 				ScriptArgs: chkType.ScriptArgs,
 				Interval:   chkType.Interval,
 				Timeout:    chkType.Timeout,

diff --git a/agent/agent_endpoint_test.go b/agent/agent_endpoint_test.go
@@ -716,14 +716,6 @@ func TestAgent_RegisterCheck_Scripts(t *testing.T) {
 		name  string
 		check map[string]interface{}
 	}{
-		{
-			"< Consul 1.0.0",
-			map[string]interface{}{
-				"Name":     "test",
-				"Interval": "2s",
-				"Script":   "true",
-			},
-		},
 		{
 			"== Consul 1.0.0",
 			map[string]interface{}{

diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -651,8 +651,8 @@ func TestAgent_AddCheck(t *testing.T) {
 		Status:  api.HealthCritical,
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: 15 * time.Second,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   15 * time.Second,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err != nil {
@@ -690,8 +690,8 @@ func TestAgent_AddCheck_StartPassing(t *testing.T) {
 		Status:  api.HealthPassing,
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: 15 * time.Second,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   15 * time.Second,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err != nil {
@@ -729,8 +729,8 @@ func TestAgent_AddCheck_MinInterval(t *testing.T) {
 		Status:  api.HealthCritical,
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: time.Microsecond,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   time.Microsecond,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err != nil {
@@ -764,8 +764,8 @@ func TestAgent_AddCheck_MissingService(t *testing.T) {
 		ServiceID: "baz",
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: time.Microsecond,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   time.Microsecond,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err == nil || err.Error() != `ServiceID "baz" does not exist` {
@@ -829,8 +829,8 @@ func TestAgent_AddCheck_ExecDisable(t *testing.T) {
 		Status:  api.HealthCritical,
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: 15 * time.Second,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   15 * time.Second,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err == nil || !strings.Contains(err.Error(), "Scripts are disabled on this agent") {
@@ -904,8 +904,8 @@ func TestAgent_RemoveCheck(t *testing.T) {
 		Status:  api.HealthCritical,
 	}
 	chk := &structs.CheckType{
-		Script:   "exit 0",
-		Interval: 15 * time.Second,
+		ScriptArgs: []string{"exit", "0"},
+		Interval:   15 * time.Second,
 	}
 	err := a.AddCheck(health, chk, false, "")
 	if err != nil {
@@ -1315,8 +1315,8 @@ func TestAgent_PersistCheck(t *testing.T) {
 		Status:  api.HealthPassing,
 	}
 	chkType := &structs.CheckType{
-		Script:   "/bin/true",
-		Interval: 10 * time.Second,
+		ScriptArgs: []string{"/bin/true"},
+		Interval:   10 * time.Second,
 	}
 
 	file := filepath.Join(a.Config.DataDir, checksDir, checkIDHash(check.CheckID))
@@ -1473,7 +1473,7 @@ func TestAgent_PurgeCheckOnDuplicate(t *testing.T) {
 			id = "mem"
 			name = "memory check"
 			notes = "my cool notes"
-			script = "/bin/check-redis.py"
+			args = ["/bin/check-redis.py"]
 			interval = "30s"
 		}
 	`)

diff --git a/agent/config/builder.go b/agent/config/builder.go
@@ -967,7 +967,6 @@ func (b *Builder) checkVal(v *CheckDefinition) *structs.CheckDefinition {
 		ServiceID:         b.stringVal(v.ServiceID),
 		Token:             b.stringVal(v.Token),
 		Status:            b.stringVal(v.Status),
-		Script:            b.stringVal(v.Script),
 		ScriptArgs:        v.ScriptArgs,
 		HTTP:              b.stringVal(v.HTTP),
 		Header:            v.Header,

diff --git a/agent/config/config.go b/agent/config/config.go
@@ -331,7 +331,6 @@ type CheckDefinition struct {
 	ServiceID                      *string             `json:"service_id,omitempty" hcl:"service_id" mapstructure:"service_id"`
 	Token                          *string             `json:"token,omitempty" hcl:"token" mapstructure:"token"`
 	Status                         *string             `json:"status,omitempty" hcl:"status" mapstructure:"status"`
-	Script                         *string             `json:"script,omitempty" hcl:"script" mapstructure:"script"`
 	ScriptArgs                     []string            `json:"args,omitempty" hcl:"args" mapstructure:"args"`
 	HTTP                           *string             `json:"http,omitempty" hcl:"http" mapstructure:"http"`
 	Header                         map[string][]string `json:"header,omitempty" hcl:"header" mapstructure:"header"`