Allow a custom wait duration for kwok provider

[liam-mackie]

What do you want to see?

When a kwok cluster is instantiated using the default NewProvider() method, the cluster has no wait time defined. This may cause race conditions (though we only saw this happening on Windows and MacOS machines, not Linux).

Currently, to work around this and still use envfuncs.CreateClusterWithConfig(), you can create a custom cluster first:

func TestMain(m *testing.M) {
	cfg, err := envconf.NewFromFlags()
	if err != nil {
		log.Fatalf("envconf failed: %s", err)
	}
	testenv = env.NewWithConfig(cfg)
	kwokClusterName := envconf.RandomName("kwok-cluster", 16)
	namespace := envconf.RandomName("kwok-ns", 16)

	testenv.Setup(
		envfuncs.CreateClusterWithConfig(customKwokProvider(), kwokClusterName, "kwok-config.yaml"),
		envfuncs.CreateNamespace(namespace),
	)

	testenv.Finish(
		envfuncs.ExportClusterLogs(kwokClusterName, "./logs"),
		envfuncs.DeleteNamespace(namespace),
		envfuncs.DestroyCluster(kwokClusterName),
	)
	os.Exit(testenv.Run(m))
}

func customKwokProvider() support.E2EClusterProvider {
	return kwok.NewCluster("")
}

kwok.NewCluster() sets a default wait time of 1 minute, which is enough for most scenarios we've tested. That being said, it would be great to use ClusterOpts to set the duration instead. An example of how it might look in the same situation is:

func TestMain(m *testing.M) {
	cfg, err := envconf.NewFromFlags()
	if err != nil {
		log.Fatalf("envconf failed: %s", err)
	}
	testenv = env.NewWithConfig(cfg)
	kwokClusterName := envconf.RandomName("kwok-cluster", 16)
	namespace := envconf.RandomName("kwok-ns", 16)

	testenv.Setup(
		envfuncs.CreateClusterWithConfig(kwok.NewProvider().WithOpts(kwok.WithWaitDuration(1*time.Minute)), kwokClusterName, "kwok-config.yaml"),
		envfuncs.CreateNamespace(namespace),
	)

	testenv.Finish(
		envfuncs.ExportClusterLogs(kwokClusterName, "./logs"),
		envfuncs.DeleteNamespace(namespace),
		envfuncs.DestroyCluster(kwokClusterName),
	)
	os.Exit(testenv.Run(m))
}

Extra Labels

No response

[vladimirvivien]

cc @harshanarayana what do you think, this sounds sensible.

[harshanarayana]

+1 Sounds like a good thing to have considering that the default duration is pretty small.