test: add flags for augmenting commands which need to be run in the daemon-context to enable running tests from remote machines (runfinch#203)

* test: add flags for augmenting commands which need to be run in the daemon-context to enable running tests from remote machines

Signed-off-by: Justin Alvarez <[email protected]>

* fix copyright linting

Signed-off-by: Justin Alvarez <[email protected]>

---------

Signed-off-by: Justin Alvarez <[email protected]>

Author: pendo324

e2e/e2e_test.go

@@ -5,7 +5,9 @@ package e2e
 
 import (
 	"flag"
+	"log"
 	"os"
+	"strings"
 	"testing"
 
 	"github.com/onsi/ginkgo/v2"
@@ -14,15 +16,24 @@ import (
 	"github.com/runfinch/common-tests/option"
 
 	"github.com/runfinch/finch-daemon/e2e/tests"
+	"github.com/runfinch/finch-daemon/e2e/util"
 )
 
 // Subject defines which CLI the tests are run against, defaults to \"nerdctl\" in the user's PATH.
 var Subject = flag.String("subject", "nerdctl", `which CLI the tests are run against, defaults to "nerdctl" in the user's PATH.`)
+var SubjectPrefix = flag.String("daemon-context-subject-prefix", "", `A string which prefixes the command the tests are run against, defaults to "". This string will be split by spaces.`)
+var PrefixedSubjectEnv = flag.String("daemon-context-subject-env", "", `Environment to add when running a prefixed subject, in the form of a string like "EXAMPLE=foo EXAMPLE2=bar"`)
 
 func TestRun(t *testing.T) {
 	if os.Getenv("TEST_E2E") != "1" {
 		t.Skip("E2E tests skipped. Set TEST_E2E=1 to run these tests")
 	}
+
+	if err := parseTestFlags(); err != nil {
+		log.Println("failed to parse go test flags", err)
+		os.Exit(1)
+	}
+
 	opt, _ := option.New([]string{*Subject, "--namespace", "finch"})
 
 	ginkgo.SynchronizedBeforeSuite(func() []byte {
@@ -36,6 +47,15 @@ func TestRun(t *testing.T) {
 		command.RemoveAll(opt)
 	}, func() {})
 
+	var pOpt = option.New
+	if *SubjectPrefix != "" {
+		var modifiers []option.Modifier
+		if *PrefixedSubjectEnv != "" {
+			modifiers = append(modifiers, option.Env(strings.Split(*PrefixedSubjectEnv, " ")))
+		}
+		pOpt = util.WrappedOption(strings.Split(*SubjectPrefix, " "), modifiers...)
+	}
+
 	const description = "Finch Daemon Functional test"
 	ginkgo.Describe(description, func() {
 		// functional test for container APIs
@@ -60,7 +80,7 @@ func TestRun(t *testing.T) {
 		tests.VolumeRemove(opt)
 
 		// functional test for network APIs
-		tests.NetworkCreate(opt)
+		tests.NetworkCreate(opt, pOpt)
 		tests.NetworkRemove(opt)
 		tests.NetworkList(opt)
 		tests.NetworkInspect(opt)
@@ -81,3 +101,17 @@ func TestRun(t *testing.T) {
 	gomega.RegisterFailHandler(ginkgo.Fail)
 	ginkgo.RunSpecs(t, description)
 }
+
+// parseTestFlags parses go test flags because pflag package ignores flags with '-test.' prefix
+// Related issues:
+// https://github.com/spf13/pflag/issues/63
+// https://github.com/spf13/pflag/issues/238
+func parseTestFlags() error {
+	var testFlags []string
+	for _, f := range os.Args[1:] {
+		if strings.HasPrefix(f, "-test.") {
+			testFlags = append(testFlags, f)
+		}
+	}
+	return flag.CommandLine.Parse(testFlags)
+}

e2e/tests/network_create.go

@@ -17,9 +17,10 @@ import (
 
 	"github.com/runfinch/finch-daemon/api/types"
 	"github.com/runfinch/finch-daemon/e2e/client"
+	"github.com/runfinch/finch-daemon/e2e/util"
 )
 
-func NetworkCreate(opt *option.Option) {
+func NetworkCreate(opt *option.Option, pOpt util.NewOpt) {
 	Describe("create a network", func() {
 		const (
 			path        = "/networks/create"
@@ -202,7 +203,7 @@ func NetworkCreate(opt *option.Option) {
 				Expect(stdout).To(ContainSubstring(`"finch.network.bridge.enable_icc.ipv4": "false"`))
 
 				// check iptables rules exists
-				iptOpt, _ := option.New([]string{"iptables"})
+				iptOpt, _ := pOpt([]string{"iptables"})
 				command.Run(iptOpt, "-C", "FINCH-ISOLATE-CHAIN",
 					"-i", testBridge, "-o", testBridge, "-j", "DROP")
 			})
@@ -226,7 +227,7 @@ func NetworkCreate(opt *option.Option) {
 				Expect(stdout).ShouldNot(ContainSubstring(`"finch.network.bridge.enable_icc.ipv4"`))
 
 				// check iptables rules does not exist
-				iptOpt, _ := option.New([]string{"iptables"})
+				iptOpt, _ := pOpt([]string{"iptables"})
 				command.RunWithoutSuccessfulExit(iptOpt, "-C", "FINCH-ISOLATE-CHAIN",
 					"-i", testBridge, "-o", testBridge, "-j", "DROP")
 			})

e2e/util/option_wrapper.go

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Package testutil holds code that may be useful for any of the e2e subpackages (including e2e itself).
+// It is useful to avoid import loops between the various e2e test pacakges.
+package util
+
+import (
+	"github.com/runfinch/common-tests/option"
+)
+
+// NewOpt is a helper to make it easier for functions to accept wrapped option creators.
+type NewOpt func(subject []string, modifiers ...option.Modifier) (*option.Option, error)
+
+// WrappedOption allows injection of new prefixed option creator function into tests.
+// This is useful for scenarios where CLI commands must be run in an environment which is
+// not the same as the system running the tests, like inside a SSH shell.
+func WrappedOption(prefix []string, wModifiers ...option.Modifier) NewOpt {
+	return func(subject []string, modifiers ...option.Modifier) (*option.Option, error) {
+		prefix = append(prefix, subject...)
+		return option.New(prefix, append(wModifiers, modifiers...)...)
+	}
+}