Merge pull request #112 from josephlr/bug

testing: Make sure to always close simulator on cleanup

client/close.go

@@ -16,14 +16,14 @@ func CheckedClose(tb testing.TB, rwc io.ReadWriteCloser) {
 	} {
 		handles, err := Handles(rwc, t)
 		if err != nil {
-			tb.Fatalf("failed to fetch handles of type %v: %v", t, err)
+			tb.Errorf("failed to fetch handles of type %v: %v", t, err)
 		}
 		if len(handles) != 0 {
 			tb.Errorf("tests leaked handles: %v", handles)
 		}
 	}
 
 	if err := rwc.Close(); err != nil {
-		tb.Errorf("failed to close simulator: %v", err)
+		tb.Errorf("when closing simulator: %v", err)
 	}
 }

internal/test_tpm.go

@@ -65,6 +65,15 @@ func GetTPM(tb testing.TB) io.ReadWriteCloser {
 	if err != nil {
 		tb.Fatalf("Simulator initialization failed: %v", err)
 	}
+	// Make sure that whatever happens, we close the simulator
+	tb.Cleanup(func() {
+		if !simulator.IsClosed() {
+			tb.Error("simulator was not properly closed")
+			if err := simulator.Close(); err != nil {
+				tb.Errorf("when closing simulator: %v", err)
+			}
+		}
+	})
 	absPath, err := filepath.Abs("../server/test/ubuntu-2104-event-log")
 	if err != nil {
 		tb.Fatalf("failed to get abs path: %v", err)

simulator/simulator.go

@@ -32,7 +32,8 @@ import (
 // handles, no synchronization is provided; the same simulator handle should not
 // be used from multiple threads.
 type Simulator struct {
-	buf bytes.Buffer
+	buf    bytes.Buffer
+	closed bool
 }
 
 // The simulator is a global resource, so we use the variables below to make
@@ -51,6 +52,7 @@ func Get() (*Simulator, error) {
 		lock.Unlock()
 		return nil, err
 	}
+	simulator.closed = false
 	return simulator, nil
 }
 
@@ -104,10 +106,16 @@ func (s *Simulator) Read(responseBuffer []byte) (int, error) {
 // Close cleans up and stops the simulator, Close() should always be called when
 // the Simulator is no longer needed, freeing up other callers to use Get().
 func (s *Simulator) Close() error {
+	s.closed = true
 	defer lock.Unlock()
 	return s.off()
 }
 
+// IsClosed returns true if the simulator has been Closed()
+func (s *Simulator) IsClosed() bool {
+	return s.closed
+}
+
 func (s *Simulator) on(manufactureReset bool) error {
 	// TPM2_Startup must be the first command the TPM receives.
 	if err := tpm2.Startup(s, tpm2.StartupClear); err != nil {