Add machine.Shutdown method

machine.Shutdown wraps the SendCtrlAltDel firecracker API, allowing the caller
to request a clean shutdown of the guest by sending CtrlAltDel on the virtual
keyboard.

Signed-off-by: Noah Meyerhans <[email protected]>

Author: Noah Meyerhans

machine.go

@@ -260,6 +260,12 @@ func (m *Machine) Start(ctx context.Context) error {
 	return m.startInstance(ctx)
 }
 
+// Shutdown requests a clean shutdown of the VM by sending CtrlAltDelete on the virtual keyboard
+func (m *Machine) Shutdown(ctx context.Context) error {
+	m.logger.Debug("Called machine.Shutdown()")
+	return m.sendCtrlAltDel(ctx)
+}
+
 // Wait will wait until the firecracker process has finished.  Wait is safe to
 // call concurrently, and will deliver the same error to all callers, subject to
 // each caller's context cancellation.
@@ -571,6 +577,20 @@ func (m *Machine) startInstance(ctx context.Context) error {
 	return err
 }
 
+func (m *Machine) sendCtrlAltDel(ctx context.Context) error {
+	info := models.InstanceActionInfo{
+		ActionType: models.InstanceActionInfoActionTypeSendCtrlAltDel,
+	}
+
+	resp, err := m.client.CreateSyncAction(ctx, &info)
+	if err == nil {
+		m.logger.Printf("Sent instance shutdown request: %s", resp.Error())
+	} else {
+		m.logger.Errorf("Unable to send CtrlAltDel: %s", err)
+	}
+	return err
+}
+
 // EnableMetadata will append or replace the metadata handler.
 func (m *Machine) EnableMetadata(metadata interface{}) {
 	m.Handlers.FcInit = m.Handlers.FcInit.Swappend(NewSetMetadataHandler(metadata))

machine_test.go

@@ -330,7 +330,7 @@ func TestMicroVMExecution(t *testing.T) {
 	timer := time.NewTimer(5 * time.Second)
 	select {
 	case <-timer.C:
-		t.Run("TestStopVMM", func(t *testing.T) { testStopVMM(ctx, t, m) })
+		t.Run("TestShutdown", func(t *testing.T) { testShutdown(vmmCtx, t, m) })
 	case <-exitchannel:
 		// if we've already exited, there's no use waiting for the timer
 	}
@@ -370,7 +370,6 @@ func TestStartVMM(t *testing.T) {
 			t.Errorf("startVMM returned %s", m.Wait(ctx))
 		}
 	}
-
 }
 
 func TestStartVMMOnce(t *testing.T) {
@@ -410,6 +409,7 @@ func TestStartVMMOnce(t *testing.T) {
 	case <-timeout.Done():
 		if timeout.Err() == context.DeadlineExceeded {
 			t.Log("firecracker ran for 250ms")
+			t.Run("TestStopVMM", func(t *testing.T) { testStopVMM(ctx, t, m) })
 		} else {
 			t.Errorf("startVMM returned %s", m.Wait(ctx))
 		}
@@ -565,6 +565,13 @@ func testStopVMM(ctx context.Context, t *testing.T, m *Machine) {
 	}
 }
 
+func testShutdown(ctx context.Context, t *testing.T, m *Machine) {
+	err := m.Shutdown(ctx)
+	if err != nil {
+		t.Errorf("machine.Shutdown() failed: %s", err)
+	}
+}
+
 func TestWaitForSocket(t *testing.T) {
 	okClient := fctesting.MockClient{}
 	errClient := fctesting.MockClient{