adaptation, stub: implement plugin shutdown, delay close.

Implement plugin shutdown. On error paths where this seems the right
choice, shut down plugins instead of closing them. This should give
plugins a chance to gather more context (from the shutdown reason)
than just closing the connection. On other error code paths where we
close the connection, delay it to allow any errors to propagate back
to the plugin before the connection is closed.

Signed-off-by: Krisztian Litkey <[email protected]>

Author: klihub

pkg/adaptation/adaptation.go

@@ -22,6 +22,7 @@ import (
 	"io/fs"
 	"net"
 	"os"
+	"path"
 	"path/filepath"
 	"sort"
 	"sync"
@@ -225,6 +226,18 @@ func (r *Adaptation) Stop() {
 	r.stopPlugins()
 }
 
+// Shutdown plugins matching the given pattern, passing them the given reason.
+func (r *Adaptation) ShutdownPlugins(reason, pattern string) {
+	r.Lock()
+	defer r.Unlock()
+
+	for _, p := range r.plugins {
+		if match, _ := path.Match(pattern, p.name()); match {
+			p.shutdown(reason)
+		}
+	}
+}
+
 // RunPodSandbox relays the corresponding CRI event to plugins.
 func (r *Adaptation) RunPodSandbox(ctx context.Context, req *RunPodSandboxRequest) error {
 	r.Lock()

pkg/adaptation/adaptation_suite_test.go

@@ -3188,6 +3188,62 @@ var _ = Describe("Plugin configuration request", func() {
 	})
 })
 
+var _ = Describe("Plugin shutdown request", func() {
+	var (
+		s = &Suite{}
+	)
+
+	AfterEach(func() {
+		s.Cleanup()
+	})
+
+	BeforeEach(func() {
+		s.Prepare(&mockRuntime{}, &mockPlugin{idx: "00", name: "test"})
+	})
+
+	It("should be able to shut down plugins with a reason", func() {
+		var (
+			reason  = "test-shutdown-reason"
+			timeout = 2 * time.Second
+		)
+
+		s.Startup()
+
+		s.ShutdownPlugin(s.plugins[0], reason)
+		e, err := s.plugins[0].EventQ().Wait(PluginShutdown, time.After(timeout))
+		Expect(err).To(BeNil())
+		Expect(e.Reason).To(Equal(reason))
+	})
+
+	It("plugin that times out should be shut down with a reason", func() {
+		var (
+			reason  = nri.ShutdownRequestTimeout
+			timeout = 2 * time.Second
+		)
+
+		pod := &api.PodSandbox{
+			Id:        "pod0",
+			Name:      "pod0",
+			Uid:       "uid0",
+			Namespace: "default",
+		}
+		podReq := &api.RunPodSandboxRequest{Pod: pod}
+
+		s.plugins[0].runPodSandbox = func(_ *mockPlugin, _ *api.PodSandbox) error {
+			time.Sleep(3 * time.Second)
+			return nil
+		}
+
+		s.Startup()
+		Expect(s.runtime.RunPodSandbox(context.Background(), podReq)).To(Succeed())
+
+		e, err := s.plugins[0].EventQ().Wait(PluginShutdown, time.After(timeout))
+		Expect(err).To(BeNil())
+		Expect(e.Reason).To(Equal(reason))
+	})
+
+})
+
 func protoDiff(a, b proto.Message) string {
 	return cmp.Diff(a, b, protocmp.Transform())
 }