Feature Builder doesn't support adding Step by name

[kubernetes-sigs]

Feature Builder doesn't support adding Step by name

[vladimirvivien]

@harshanarayana Thanks for bringing that up.

Right now the api supports very specific sets of steps

• Assessment
• Setup
• Teardown
• (might be one more)

Some of the pre-baked steps above do have auto-generate names (except Assessment). This is because the internal method FeatureBuilder.WithStep requires a name. The reason WithStep is hidden is because each step type, specified by Level (i.e. Assess, Setup, Teardown, etc) are treated differently during execution.

Maybe, one thing that can be done is to extend the Feature API to allow Setup and Teardown to have names as well as shown below:

func TestHello_WithSetup(t *testing.T) {
	e := env.NewWithConfig(envconf.New())
	var name string
	feat := features.New("Hello Feature").
		WithLabel("type", "simple").
		WithSetup("SetupName", func(ctx context.Context, t *testing.T, _ *envconf.Config) context.Context {
			name = "foobar"
			return ctx
		}).
		Assess("test message", func(ctx context.Context, t *testing.T, _ *envconf.Config) context.Context {
			result := Hello(name)
			if result != "Hello foobar" {
				t.Error("unexpected message")
			}
			return ctx
		}).WithTeardown("Teardown", func(ctx context.Context, t *testing.T, _ *envconf.Config) context.Context {
                ...
		}).Feature()

	e.Test(t, feat)
}

[harshanarayana]

@vladimirvivien I see what you mean.
I do like the idea of extending the feature API to provide additional option to be able to provide step names. Makes it a bit more readable and easy to debug. Let me have a Draft PR opened on this for review.