[teststep] Use a Load function for plugin registration

pmazzini · pmazzini · commit 620e54fd4721 · 2020-02-04T16:23:02.000Z
diff --git a/cmds/contest/main.go b/cmds/contest/main.go
@@ -8,12 +8,10 @@ package main
 import (
 	"errors"
 	"flag"
-	"fmt"
 	"os"
 	"os/signal"
 	"syscall"
 
-	"github.com/facebookincubator/contest/pkg/event"
 	"github.com/facebookincubator/contest/pkg/job"
 	"github.com/facebookincubator/contest/pkg/jobmanager"
 	"github.com/facebookincubator/contest/pkg/logging"
@@ -54,24 +52,14 @@ var testFetchers = map[string]test.TestFetcherFactory{
 	literal.Name: literal.New,
 }
 
-var testSteps = map[string]test.TestStepFactory{
-	echo.Name:           echo.New,
-	slowecho.Name:       slowecho.New,
-	example.Name:        example.New,
-	cmd.Name:            cmd.New,
-	sshcmd.Name:         sshcmd.New,
-	randecho.Name:       randecho.New,
-	terminalexpect.Name: terminalexpect.New,
-}
-
-var testStepsEvents = map[string][]event.Name{
-	echo.Name:           echo.Events,
-	slowecho.Name:       slowecho.Events,
-	example.Name:        example.Events,
-	cmd.Name:            cmd.Events,
-	sshcmd.Name:         sshcmd.Events,
-	randecho.Name:       randecho.Events,
-	terminalexpect.Name: terminalexpect.Events,
+var testSteps = []test.TestStepLoader{
+	echo.Load,
+	slowecho.Load,
+	example.Load,
+	cmd.Load,
+	sshcmd.Load,
+	randecho.Load,
+	terminalexpect.Load,
 }
 
 var reporters = map[string]job.ReporterFactory{
@@ -112,12 +100,8 @@ func main() {
 	}
 
 	// Register TestStep plugins
-	for name, tsfactory := range testSteps {
-		if _, ok := testStepsEvents[name]; !ok {
-			err := fmt.Errorf("TestStep %s not associated to any list of events", name)
-			log.Fatal(err)
-		}
-		if err := pluginRegistry.RegisterTestStep(name, tsfactory, testStepsEvents[name]); err != nil {
+	for _, tsloader := range testSteps {
+		if err := pluginRegistry.RegisterTestStep(tsloader()); err != nil {
 			log.Fatal(err)
 
 		}
diff --git a/pkg/test/step.go b/pkg/test/step.go
@@ -63,6 +63,10 @@ type TestStepStatus string
 // TestStep factories are registered in the plugin registry.
 type TestStepFactory func() TestStep
 
+// TestStepLoader is a type representing a function which returns all the
+// needed things to be able to load a TestStep.
+type TestStepLoader func() (string, TestStepFactory, []event.Name)
+
 // TestStepDescriptor is the definition of a test step matching a test step
 // configuration.
 type TestStepDescriptor struct {
diff --git a/plugins/teststeps/cmd/cmd.go b/plugins/teststeps/cmd/cmd.go
@@ -121,3 +121,8 @@ func (ts *Cmd) CanResume() bool {
 func New() test.TestStep {
 	return &Cmd{}
 }
+
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
diff --git a/plugins/teststeps/echo/echo.go b/plugins/teststeps/echo/echo.go
@@ -33,6 +33,11 @@ func New() test.TestStep {
 	return &Step{}
 }
 
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
+
 // ValidateParameters validates the parameters that will be passed to the Run
 // and Resume methods of the test step.
 func (e Step) ValidateParameters(params test.TestStepParameters) error {
diff --git a/plugins/teststeps/example/example.go b/plugins/teststeps/example/example.go
@@ -113,3 +113,8 @@ func (ts *Step) CanResume() bool {
 func New() test.TestStep {
 	return &Step{}
 }
+
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
diff --git a/plugins/teststeps/randecho/randecho.go b/plugins/teststeps/randecho/randecho.go
@@ -35,6 +35,11 @@ func New() test.TestStep {
 	return &Step{}
 }
 
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
+
 // ValidateParameters validates the parameters that will be passed to the Run
 // and Resume methods of the test step.
 func (e Step) ValidateParameters(params test.TestStepParameters) error {
diff --git a/plugins/teststeps/slowecho/slowecho.go b/plugins/teststeps/slowecho/slowecho.go
@@ -39,6 +39,11 @@ func New() test.TestStep {
 	return &Step{}
 }
 
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
+
 // Name returns the name of the Step
 func (e *Step) Name() string {
 	return Name
diff --git a/plugins/teststeps/sshcmd/sshcmd.go b/plugins/teststeps/sshcmd/sshcmd.go
@@ -259,3 +259,8 @@ func (ts *SSHCmd) CanResume() bool {
 func New() test.TestStep {
 	return &SSHCmd{}
 }
+
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}
diff --git a/plugins/teststeps/terminalexpect/terminalexpect.go b/plugins/teststeps/terminalexpect/terminalexpect.go
@@ -135,3 +135,8 @@ func (ts *TerminalExpect) CanResume() bool {
 func New() test.TestStep {
 	return &TerminalExpect{}
 }
+
+// Load returns the name, factory and events which are needed to register the step.
+func Load() (string, test.TestStepFactory, []event.Name) {
+	return Name, New, Events
+}

Original file line number	Diff line number	Diff line change
`@@ -121,3 +121,8 @@ func (ts *Cmd) CanResume() bool {`
`121`	`121`	`func New() test.TestStep {`
`122`	`122`	`return &Cmd{}`
`123`	`123`	`}`
	`124`	`+`
	`125`	`+// Load returns the name, factory and events which are needed to register the step.`
	`126`	`+func Load() (string, test.TestStepFactory, []event.Name) {`
	`127`	`+ return Name, New, Events`
	`128`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -113,3 +113,8 @@ func (ts *Step) CanResume() bool {`
`113`	`113`	`func New() test.TestStep {`
`114`	`114`	`return &Step{}`
`115`	`115`	`}`
	`116`	`+`
	`117`	`+// Load returns the name, factory and events which are needed to register the step.`
	`118`	`+func Load() (string, test.TestStepFactory, []event.Name) {`
	`119`	`+ return Name, New, Events`
	`120`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -259,3 +259,8 @@ func (ts *SSHCmd) CanResume() bool {`
`259`	`259`	`func New() test.TestStep {`
`260`	`260`	`return &SSHCmd{}`
`261`	`261`	`}`
	`262`	`+`
	`263`	`+// Load returns the name, factory and events which are needed to register the step.`
	`264`	`+func Load() (string, test.TestStepFactory, []event.Name) {`
	`265`	`+ return Name, New, Events`
	`266`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -135,3 +135,8 @@ func (ts *TerminalExpect) CanResume() bool {`
`135`	`135`	`func New() test.TestStep {`
`136`	`136`	`return &TerminalExpect{}`
`137`	`137`	`}`
	`138`	`+`
	`139`	`+// Load returns the name, factory and events which are needed to register the step.`
	`140`	`+func Load() (string, test.TestStepFactory, []event.Name) {`
	`141`	`+ return Name, New, Events`
	`142`	`+}`