engine: resources, graph: Change the Close method to Cleanup

This also changes a few similarly named methods. Clearer what it's doing
in terms of cleanup vs. causing some action.

engine/resources/augeas.go

@@ -118,8 +118,8 @@ func (obj *AugeasRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *AugeasRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *AugeasRes) Cleanup() error {
 	return nil
 }
 

engine/resources/aws_ec2.go

@@ -388,10 +388,11 @@ func (obj *AwsEc2Res) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close cleans up when we're done. This is needed to delete some of the AWS
+// Cleanup cleans up when we're done. This is needed to delete some of the AWS
 // objects created for the SNS endpoint.
-func (obj *AwsEc2Res) Close() error {
+func (obj *AwsEc2Res) Cleanup() error {
 	var errList error
+	// XXX: do these in a defer of Watch instead.
 	// clean up sns objects created by Init/snsWatch
 	if obj.snsClient != nil {
 		// delete the topic and associated subscriptions

engine/resources/config_etcd.go

@@ -86,8 +86,8 @@ func (obj *ConfigEtcdRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *ConfigEtcdRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *ConfigEtcdRes) Cleanup() error {
 	return nil
 }
 

engine/resources/consul_kv.go

@@ -108,8 +108,8 @@ func (obj *ConsulKVRes) Init(init *engine.Init) error {
 	return errwrap.Wrapf(err, "could not create Consul client")
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *ConsulKVRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *ConsulKVRes) Cleanup() error {
 	if obj.config != nil && obj.config.Transport != nil {
 		obj.config.Transport.CloseIdleConnections()
 	}

engine/resources/cron.go

@@ -212,10 +212,10 @@ func (obj *CronRes) Init(init *engine.Init) error {
 	return obj.file.Init(init)
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *CronRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *CronRes) Cleanup() error {
 	if obj.file != nil {
-		return obj.file.Close()
+		return obj.file.Cleanup()
 	}
 	return nil
 }

engine/resources/dhcp.go

@@ -377,8 +377,8 @@ func (obj *DHCPServerRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *DHCPServerRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *DHCPServerRes) Cleanup() error {
 	// NOTE: if this ever panics, it might mean the engine is running Close
 	// before Watch finishes exiting, which is an engine bug in that code...
 	//obj.mutex.RUnlock()
@@ -1045,8 +1045,8 @@ func (obj *DHCPHostRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *DHCPHostRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *DHCPHostRes) Cleanup() error {
 	return nil
 }
 

engine/resources/docker_container.go

@@ -164,8 +164,8 @@ func (obj *DockerContainerRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *DockerContainerRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *DockerContainerRes) Cleanup() error {
 	return obj.client.Close() // close the docker client
 }
 

engine/resources/docker_image.go

@@ -125,8 +125,8 @@ func (obj *DockerImageRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *DockerImageRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *DockerImageRes) Cleanup() error {
 	return obj.client.Close() // close the docker client
 }
 

engine/resources/exec.go

@@ -161,8 +161,8 @@ func (obj *ExecRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *ExecRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *ExecRes) Cleanup() error {
 	return nil
 }
 

engine/resources/exec_test.go

@@ -62,8 +62,8 @@ func TestExecSendRecv1(t *testing.T) {
 		t.Errorf("validate failed with: %v", err)
 	}
 	defer func() {
-		if err := r1.Close(); err != nil {
-			t.Errorf("close failed with: %v", err)
+		if err := r1.Cleanup(); err != nil {
+			t.Errorf("cleanup failed with: %v", err)
 		}
 	}()
 	init, execSends := fakeExecInit(t)
@@ -107,8 +107,8 @@ func TestExecSendRecv2(t *testing.T) {
 		t.Errorf("validate failed with: %v", err)
 	}
 	defer func() {
-		if err := r1.Close(); err != nil {
-			t.Errorf("close failed with: %v", err)
+		if err := r1.Cleanup(); err != nil {
+			t.Errorf("cleanup failed with: %v", err)
 		}
 	}()
 	init, execSends := fakeExecInit(t)
@@ -152,8 +152,8 @@ func TestExecSendRecv3(t *testing.T) {
 		t.Errorf("validate failed with: %v", err)
 	}
 	defer func() {
-		if err := r1.Close(); err != nil {
-			t.Errorf("close failed with: %v", err)
+		if err := r1.Cleanup(); err != nil {
+			t.Errorf("cleanup failed with: %v", err)
 		}
 	}()
 	init, execSends := fakeExecInit(t)

engine/resources/file.go

@@ -350,8 +350,8 @@ func (obj *FileRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *FileRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *FileRes) Cleanup() error {
 	return nil
 }
 

engine/resources/group.go

@@ -71,8 +71,8 @@ func (obj *GroupRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *GroupRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *GroupRes) Cleanup() error {
 	return nil
 }
 

engine/resources/hetzner_vm.go

@@ -361,8 +361,9 @@ func (obj *HetznerVMRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close deletes the authentication info before closing the resource.
-func (obj *HetznerVMRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done. It
+// deletes the authentication info before closing the resource.
+func (obj *HetznerVMRes) Cleanup() error {
 	obj.APIToken = ""
 	obj.client = nil
 	return nil

engine/resources/hostname.go

@@ -101,8 +101,8 @@ func (obj *HostnameRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *HostnameRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *HostnameRes) Cleanup() error {
 	return nil
 }
 

engine/resources/http.go

@@ -224,8 +224,8 @@ func (obj *HTTPServerRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *HTTPServerRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *HTTPServerRes) Cleanup() error {
 	return nil
 }
 
@@ -713,8 +713,8 @@ func (obj *HTTPFileRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *HTTPFileRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *HTTPFileRes) Cleanup() error {
 	return nil
 }
 

engine/resources/kv.go

@@ -123,8 +123,8 @@ func (obj *KVRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *KVRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *KVRes) Cleanup() error {
 	return nil
 }
 

engine/resources/mount.go

@@ -185,8 +185,8 @@ func (obj *MountRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *MountRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *MountRes) Cleanup() error {
 	return nil
 }
 

engine/resources/msg.go

@@ -88,8 +88,8 @@ func (obj *MsgRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *MsgRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *MsgRes) Cleanup() error {
 	return nil
 }
 

engine/resources/net.go

@@ -186,8 +186,8 @@ func (obj *NetRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close cleans up when we're done.
-func (obj *NetRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *NetRes) Cleanup() error {
 	if obj.socketFile == "/" {
 		return fmt.Errorf("socket file should not be the root path")
 	}

engine/resources/noop.go

@@ -57,8 +57,8 @@ func (obj *NoopRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *NoopRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *NoopRes) Cleanup() error {
 	return nil
 }
 

engine/resources/nspawn.go

@@ -132,10 +132,10 @@ func (obj *NspawnRes) Init(init *engine.Init) error {
 	return obj.svc.Init(init)
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *NspawnRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *NspawnRes) Cleanup() error {
 	if obj.svc != nil {
-		return obj.svc.Close()
+		return obj.svc.Cleanup()
 	}
 	return nil
 }

engine/resources/password.go

@@ -89,8 +89,8 @@ func (obj *PasswordRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *PasswordRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *PasswordRes) Cleanup() error {
 	return nil
 }
 

engine/resources/pippet.go

@@ -87,8 +87,8 @@ func (obj *PippetRes) Init(init *engine.Init) error {
 	return obj.runner.Register()
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *PippetRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *PippetRes) Cleanup() error {
 	return obj.runner.Unregister()
 }
 

engine/resources/pkg.go

@@ -96,8 +96,8 @@ func (obj *PkgRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *PkgRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *PkgRes) Cleanup() error {
 	return nil
 }
 

engine/resources/print.go

@@ -64,8 +64,8 @@ func (obj *PrintRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *PrintRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *PrintRes) Cleanup() error {
 	return nil
 }
 

engine/resources/resources_test.go

@@ -543,9 +543,9 @@ func TestResources1(t *testing.T) {
 				}
 			}()
 			closeFn := func() {
-				// run close (we don't ever expect an error on close!)
-				t.Logf("test #%d: running Close", index)
-				if err := res.Close(); err != nil {
+				// run cleanup (we don't ever expect an error on cleanup!)
+				t.Logf("test #%d: running Cleanup", index)
+				if err := res.Cleanup(); err != nil {
 					t.Errorf("test #%d: FAIL", index)
 					t.Errorf("test #%d: could not close Res: %+v", index, err)
 					//return
@@ -793,11 +793,11 @@ func TestResources2(t *testing.T) {
 		}
 		return resCheckApplyError(res, expCheckOK, errOK)
 	}
-	// resClose runs Close on the res.
-	resClose := func(res engine.Res) func() error {
-		// run Close
+	// resCleanup runs CLeanup on the res.
+	resCleanup := func(res engine.Res) func() error {
+		// run CLeanup
 		return func() error {
-			return res.Close()
+			return res.Cleanup()
 		}
 	}
 	// resReversal runs Reverse on the resource and stores the result in the
@@ -928,7 +928,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileExpect(p, content),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			fileExpect(p, content), // ensure it exists
 		}
 
@@ -960,7 +960,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileExpect(p, content),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			fileExpect(p, content), // ensure it exists
 		}
 
@@ -992,7 +992,7 @@ func TestResources2(t *testing.T) {
 			resInit(r1),
 			resCheckApplyError(r1, false, ErrIsNotExistOK), // should error
 			resCheckApplyError(r1, false, ErrIsNotExistOK), // double check
-			resClose(r1),
+			resCleanup(r1),
 			fileAbsent(p), // ensure it's absent
 		}
 
@@ -1021,7 +1021,7 @@ func TestResources2(t *testing.T) {
 			resInit(r1),
 			resCheckApply(r1, true),
 			resCheckApply(r1, true),
-			resClose(r1),
+			resCleanup(r1),
 			fileAbsent(p), // ensure it's absent
 		}
 
@@ -1050,7 +1050,7 @@ func TestResources2(t *testing.T) {
 			resInit(r1),
 			resCheckApply(r1, false),
 			resCheckApply(r1, true),
-			resClose(r1),
+			resCleanup(r1),
 			fileAbsent(p), // ensure it's absent
 		}
 
@@ -1094,7 +1094,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileExpect(p, content),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			//resValidate(r2), // no!!!
 			func() error {
 				// wrap it b/c it is currently nil
@@ -1110,7 +1110,7 @@ func TestResources2(t *testing.T) {
 				return resCheckApply(r2, true)()
 			},
 			func() error {
-				return resClose(r2)()
+				return resCleanup(r2)()
 			},
 			fileAbsent(p), // ensure it's absent
 		}
@@ -1156,7 +1156,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileExpect(p, content),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			//resValidate(r2),
 			func() error {
 				// wrap it b/c it is currently nil
@@ -1172,7 +1172,7 @@ func TestResources2(t *testing.T) {
 				return resCheckApply(r2, true)()
 			},
 			func() error {
-				return resClose(r2)()
+				return resCleanup(r2)()
 			},
 			fileExpect(p, original), // we restored the contents!
 			fileRemove(p),           // cleanup
@@ -1220,7 +1220,7 @@ func TestResources2(t *testing.T) {
 			resCheckApplyError(r1, false, ErrIsNotExistOK), // changed
 			//fileExpect(p, content),
 			//resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			//func() error {
 			//	// wrap it b/c it is currently nil
 			//	return r2.Validate()
@@ -1232,7 +1232,7 @@ func TestResources2(t *testing.T) {
 			//	return resCheckApply(r2, true)()
 			//},
 			//func() error {
-			//	return resClose(r2)()
+			//	return resCleanup(r2)()
 			//},
 			//fileExpect(p, content), // we never changed it back...
 			//fileRemove(p),          // cleanup
@@ -1275,7 +1275,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileAbsent(p),            // ensure it got removed
 			resCheckApply(r1, true),  // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			//resValidate(r2), // no!!!
 			func() error {
 				// wrap it b/c it is currently nil
@@ -1291,7 +1291,7 @@ func TestResources2(t *testing.T) {
 				return resCheckApply(r2, true)()
 			},
 			func() error {
-				return resClose(r2)()
+				return resCleanup(r2)()
 			},
 			fileExpect(p, original), // ensure it's back to original
 		}
@@ -1357,7 +1357,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, false), // changed
 			fileExpect(p, content),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 			fileExpect(p, content), // ensure it exists
 		}
 
@@ -1394,7 +1394,7 @@ func TestResources2(t *testing.T) {
 			resCheckApply(r1, true),  // it's already good
 			fileExpect(p, content),   // should already be like this
 			fileExpect(p2, content),  // should not change either
-			resClose(r1),
+			resCleanup(r1),
 		}
 
 		testCases = append(testCases, test{
@@ -1423,7 +1423,7 @@ func TestResources2(t *testing.T) {
 			fileExists(p, true),      // ensure it's a dir
 			resCheckApply(r1, true),  // it's already good
 			fileExists(p, true),      // ensure it's a dir
-			resClose(r1),
+			resCleanup(r1),
 		}
 
 		testCases = append(testCases, test{
@@ -1494,7 +1494,7 @@ func TestResources2(t *testing.T) {
 			fileExists(d2f2, false),
 			fileExists(d2f3, false),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 		}
 
 		testCases = append(testCases, test{
@@ -1560,7 +1560,7 @@ func TestResources2(t *testing.T) {
 			fileAbsent(d2f2),
 			fileAbsent(d2f3),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 		}
 
 		testCases = append(testCases, test{
@@ -1646,17 +1646,17 @@ func TestResources2(t *testing.T) {
 			resValidate(r2),
 			resInit(r2),
 			//resCheckApply(r2, false), // not really needed in test
-			resClose(r2),
+			resCleanup(r2),
 
 			resValidate(r3),
 			resInit(r3),
 			//resCheckApply(r3, false), // not really needed in test
-			resClose(r3),
+			resCleanup(r3),
 
 			resValidate(r4),
 			resInit(r4),
 			//resCheckApply(r4, false), // not really needed in test
-			resClose(r4),
+			resCleanup(r4),
 
 			resValidate(r1),
 			resInit(r1, addGraph(graph), addLogf(nil)), // show the full graph
@@ -1675,7 +1675,7 @@ func TestResources2(t *testing.T) {
 			fileExists(p3, true),  // ensure it's a dir
 			fileExists(p4, false),
 			resCheckApply(r1, true), // it's already good
-			resClose(r1),
+			resCleanup(r1),
 		}
 
 		testCases = append(testCases, test{

engine/resources/svc.go

@@ -76,8 +76,8 @@ func (obj *SvcRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *SvcRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *SvcRes) Cleanup() error {
 	return nil
 }
 

engine/resources/test.go

@@ -119,8 +119,8 @@ func (obj *TestRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *TestRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *TestRes) Cleanup() error {
 	return nil
 }
 

engine/resources/tftp.go

@@ -134,8 +134,8 @@ func (obj *TFTPServerRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *TFTPServerRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *TFTPServerRes) Cleanup() error {
 	return nil
 }
 
@@ -540,8 +540,8 @@ func (obj *TFTPFileRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *TFTPFileRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *TFTPFileRes) Cleanup() error {
 	return nil
 }
 

engine/resources/timer.go

@@ -60,8 +60,8 @@ func (obj *TimerRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *TimerRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *TimerRes) Cleanup() error {
 	return nil
 }
 

engine/resources/user.go

@@ -105,8 +105,8 @@ func (obj *UserRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close is run by the engine to clean up after the resource is done.
-func (obj *UserRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *UserRes) Cleanup() error {
 	return nil
 }
 

engine/resources/virt.go

@@ -239,8 +239,8 @@ func (obj *VirtRes) Init(init *engine.Init) error {
 	return nil
 }
 
-// Close runs some cleanup code for this resource.
-func (obj *VirtRes) Close() error {
+// Cleanup is run by the engine to clean up after the resource is done.
+func (obj *VirtRes) Cleanup() error {
 	// By the time that this Close method is called, the engine promises
 	// that the Watch loop has previously shutdown! (Assuming no bugs!)
 	// TODO: As a result, this is an extra check which shouldn't be needed,