Add integration tests for list resources extension

Add integration tests to list and watch resources under a tree. Add
test utilities to enable killing a watch command gracefully/

Author: cmurphy

pkg/testutils/testutils.go

@@ -1,6 +1,7 @@
 package testutils
 
 import (
+	"context"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -129,6 +130,20 @@ func runShouldContainMultiple(offset int, substrs []string, seconds float64, cmd
 	}, seconds).Should(beQuiet(), "Command: %s", cmdln)
 }
 
+func RunShouldContainMultipleWithTimeout(substrs []string, seconds, timeout float64, cmdln ...string) {
+	runShouldContainMultipleWithTimeout(1, substrs, seconds, timeout, cmdln...)
+}
+
+func runShouldContainMultipleWithTimeout(offset int, substrs []string, seconds, timeout float64, cmdln ...string) {
+	EventuallyWithOffset(offset+1, func() string {
+		missing, err := tryRunShouldContainMultipleWithTimeout(substrs, timeout, cmdln...)
+		if err != nil {
+			return "failed: " + err.Error()
+		}
+		return missing
+	}, seconds).Should(beQuiet(), "Command: %s", cmdln)
+}
+
 func RunErrorShouldContain(substr string, seconds float64, cmdln ...string) {
 	runErrorShouldContainMultiple(1, []string{substr}, seconds, cmdln...)
 }
@@ -153,6 +168,38 @@ func tryRunShouldContainMultiple(substrs []string, cmdln ...string) (string, err
 	return missAny(substrs, stdout), err
 }
 
+func tryRunShouldContainMultipleWithTimeout(substrs []string, timeout float64, cmdln ...string) (string, error) {
+	stdout, err := runCommandWithTimeout(timeout, cmdln...)
+	GinkgoT().Log("Output: ", stdout)
+	return missAny(substrs, stdout), err
+}
+
+// runCommandWithTimeout is like RunCommand, but uses a timeout context to kill the command after `timeout` seconds.
+// This is useful if the command is not expected to exit on its own, like for a watch command.
+func runCommandWithTimeout(timeout float64, cmdln ...string) (string, error) {
+	var args []string
+	for _, subcmdln := range cmdln {
+		// Any arg that starts and ends in a double quote shouldn't be split further
+		if len(subcmdln) > 2 && subcmdln[0] == '"' && subcmdln[len(subcmdln)-1] == '"' {
+			args = append(args, subcmdln[1:len(subcmdln)-1])
+		} else {
+			args = append(args, strings.Split(subcmdln, " ")...)
+		}
+	}
+	prefix := fmt.Sprintf("[%d] Running: ", time.Now().Unix())
+	GinkgoT().Log(prefix, args)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(timeout)*time.Second)
+	defer cancel()
+	cmd := exec.CommandContext(ctx, args[0], args[1:]...)
+	// Work around https://github.com/kubernetes/kubectl/issues/1098#issuecomment-929743957:
+	cmd.Env = append(os.Environ(), "KUBECTL_COMMAND_HEADERS=false")
+	stdout, err := cmd.CombinedOutput()
+	if err != nil && strings.Contains(err.Error(), "signal: killed") {
+		return string(stdout), nil
+	}
+	return string(stdout), err
+}
+
 // If any of the substrs are missing from teststring, returns a string of the form:
 //   did not output the expected substring(s): <string1>, <string2>, ...
 //   and instead output: teststring

test/e2e/list_resources_test.go

@@ -0,0 +1,82 @@
+package e2e
+
+import (
+	"time"
+
+	. "github.com/onsi/ginkgo/v2"
+
+	. "sigs.k8s.io/hierarchical-namespaces/pkg/testutils"
+)
+
+var _ = Describe("List Resources", func() {
+	const (
+		parent1       = namspacePrefix + "parent1"
+		parent2       = namspacePrefix + "parent2"
+		child1a       = namspacePrefix + "child1a"
+		child1b       = namspacePrefix + "child1b"
+		child2a       = namspacePrefix + "child2a"
+		grandchild1ai = namspacePrefix + "grandchild1ai"
+	)
+
+	BeforeEach(func() {
+		CleanupTestNamespaces()
+		CreateNamespace(parent1)
+		CreateNamespace(parent2)
+		CreateSubnamespace(child1a, parent1)
+		CreateSubnamespace(child1b, parent1)
+		CreateSubnamespace(child2a, parent2)
+		CreateSubnamespace(grandchild1ai, child1a)
+		// wait for all the descendents to be in the tree
+		RunShouldContain(grandchild1ai, 5, "kubectl hns tree", parent1)
+	})
+
+	AfterEach(func() {
+		CleanupTestNamespaces()
+	})
+
+	It("should list resources", func() {
+		createEmptySecret(parent1, "s-parent1")
+		createEmptySecret(child1a, "s-child1a")
+		createEmptySecret(child1b, "s-child1b")
+		createEmptySecret(grandchild1ai, "s-grandchild1ai")
+		createEmptySecret(child2a, "s-child2a")
+
+		// verify
+		// list resources under one tree
+		RunShouldContainMultiple([]string{"s-parent1", "s-child1a", "s-child1b", "s-grandchild1ai"}, 5, "kubectl hns --namespace", parent1, "get secret")
+		RunShouldNotContain("s-child2a", 5, "kubectl hns --namespace", parent1, "get secret")
+
+		// list resources under another tree
+		RunShouldContain("s-child2a", 5, "kubectl hns --namespace", parent2, "get secret")
+		RunShouldNotContainMultiple([]string{"s-parent1", "s-child1a", "s-child1b", "s-grandchild1ai"}, 5, "kubectl hns --namespace", parent2, "get secret")
+
+		// list all resources
+		RunShouldContainMultiple([]string{"s-parent1", "s-child1a", "s-child1b", "s-grandchild1ai", "s-child2a"}, 5, "kubectl hns get secret --all-namespaces")
+	})
+
+	It("should watch resources", func() {
+		go func() {
+			defer GinkgoRecover()
+			interval := 1 * time.Second
+			time.Sleep(interval)
+			createEmptySecret(parent1, "s-parent1")
+			time.Sleep(interval)
+			createEmptySecret(child1a, "s-child1a")
+			time.Sleep(interval)
+			createEmptySecret(child1b, "s-child1b")
+			time.Sleep(interval)
+			createEmptySecret(grandchild1ai, "s-grandchild1ai")
+			time.Sleep(interval)
+			createEmptySecret(child2a, "s-child2a")
+		}()
+
+		// verify
+		cmd := []string{"kubectl hns --namespace", parent1, "get secret --watch"}
+		wantStrings := []string{"s-parent1", "s-child1a", "s-child1b", "s-grandchild1ai"}
+		RunShouldContainMultipleWithTimeout(wantStrings, 15, 15, cmd...)
+	})
+})
+
+func createEmptySecret(namespace, name string) {
+	MustRun("kubectl --namespace", namespace, "create secret generic", name)
+}