Add src documentation

Author: SimonBaeumer

pkg/runtime/executor.go

@@ -1,5 +1,6 @@
 package runtime
 
+// Executor interface which will be implemented by all available executors, like ssh or local
 type Executor interface {
 	Execute(test TestCase) TestResult
 }

pkg/runtime/local_executor.go

@@ -6,9 +6,16 @@ import (
 	"strings"
 )
 
+// LocalExecutor will be used to execute tests on the local host
 type LocalExecutor struct {
 }
 
+// NewLocalExecutor creates a new local executor
+func NewLocalExecutor() Executor {
+	return LocalExecutor{}
+}
+
+// Execute will execute the given test on the current node
 func (e LocalExecutor) Execute(test TestCase) TestResult {
 	timeoutOpt, err := createTimeoutOption(test.Command.Timeout)
 	if err != nil {

pkg/runtime/runtime.go

@@ -28,6 +28,7 @@ const (
 	Skipped
 )
 
+// NewRuntime creates a new runtime and inits default nodes
 func NewRuntime(nodes ...Node) Runtime {
 	local := Node{
 		Name: "local",
@@ -41,6 +42,7 @@ func NewRuntime(nodes ...Node) Runtime {
 	}
 }
 
+// Runtime represents the current runtime, please use NewRuntime() instead of createing an instance directly
 type Runtime struct {
 	Nodes []Node
 }
@@ -54,6 +56,9 @@ type TestCase struct {
 	Nodes    []string
 }
 
+// Node represents a configured node with everything needed  to connect to the given host
+// which is defined in the type property
+// If the type is not available the test will fail and stop its execution
 type Node struct {
 	Name         string
 	Type         string
@@ -147,7 +152,7 @@ func (r *Runtime) Start(tests []TestCase) <-chan TestResult {
 		defer wg.Done()
 
 		for t := range tests {
-			// If no node was set use local mode
+			// If no node was set use local mode as default
 			if len(t.Nodes) == 0 {
 				t.Nodes = []string{"local"}
 			}
@@ -183,23 +188,18 @@ func (r *Runtime) Start(tests []TestCase) <-chan TestResult {
 
 func (r *Runtime) getExecutor(node string) Executor {
 	if len(r.Nodes) == 0 {
-		return LocalExecutor{}
+		return NewLocalExecutor()
 	}
 
 	for _, n := range r.Nodes {
 		if n.Name == node {
 			switch n.Type {
 			case "ssh":
-				return SSHExecutor{
-					Password:     n.Pass,
-					IdentityFile: n.IdentityFile,
-					User:         n.User,
-					Host:         n.Addr,
-				}
+				return NewSSHExecutor(n.Addr, n.User, WithIdentityFile(n.IdentityFile), WithPassword(n.Pass))
 			case "local":
-				return LocalExecutor{}
+				return NewLocalExecutor()
 			case "":
-				return LocalExecutor{}
+				return NewLocalExecutor()
 			default:
 				log.Fatal(fmt.Sprintf("Node type %s not found for node %s", n.Type, n.Name))
 			}

pkg/runtime/ssh_executor.go

@@ -18,6 +18,34 @@ type SSHExecutor struct {
 	IdentityFile string
 }
 
+// WithIdentityFile sets the identity file option for the ssh executor
+func WithIdentityFile(identityFile string) func(e *SSHExecutor) {
+	return func(e *SSHExecutor) {
+		e.IdentityFile = identityFile
+	}
+}
+
+// WithPassword sets the identity file option for the ssh executor
+func WithPassword(pass string) func(e *SSHExecutor) {
+	return func(e *SSHExecutor) {
+		e.Password = pass
+	}
+}
+
+// NewSSHExecutor creates a new executor
+func NewSSHExecutor(host string, user string, opts ...func(e *SSHExecutor)) Executor {
+	e := SSHExecutor{
+		Host: host,
+		User: user,
+	}
+
+	for _, o := range opts {
+		o(&e)
+	}
+
+	return e
+}
+
 // Execute executes a command on a remote host viá SSH
 func (e SSHExecutor) Execute(test TestCase) TestResult {
 	if test.Command.InheritEnv {

pkg/suite/suite.go

@@ -5,17 +5,21 @@ import (
 	"github.com/SimonBaeumer/commander/pkg/runtime"
 )
 
-// Suite represents the current tests and configs
+// Suite represents the current tests, nodes and configs.
+// It is used by the runtime to execute all tests and is an abstraction for the given source.
+// In example it could be possible to add more formats like XML or a custom DSL implementation.
 type Suite struct {
 	TestCases []runtime.TestCase
 	Config    runtime.TestConfig
 	Nodes     []runtime.Node
 }
 
+// GetNodes returns all nodes defined in the suite
 func (s Suite) GetNodes() []runtime.Node {
 	return s.Nodes
 }
 
+// GetNodeByName returns a node by the given name
 func (s Suite) GetNodeByName(name string) (runtime.Node, error) {
 	for _, n := range s.Nodes {
 		if n.Name == name {
@@ -25,6 +29,8 @@ func (s Suite) GetNodeByName(name string) (runtime.Node, error) {
 	return runtime.Node{}, fmt.Errorf("could not find node with name %s", name)
 }
 
+// AddTest pushes a new test to the suite
+// if the test was already added it will panic
 func (s Suite) AddTest(t runtime.TestCase) {
 	if _, err := s.GetTestByTitle(t.Title); err == nil {
 		panic(fmt.Sprintf("Tests %s was already added to the suite", t.Title))
@@ -37,6 +43,7 @@ func (s Suite) GetTests() []runtime.TestCase {
 	return s.TestCases
 }
 
+// GetTestByTitle returns a test by title, if the test was not found an error is returned
 func (s Suite) GetTestByTitle(title string) (runtime.TestCase, error) {
 	for _, t := range s.GetTests() {
 		if t.Title == title {
@@ -46,6 +53,7 @@ func (s Suite) GetTestByTitle(title string) (runtime.TestCase, error) {
 	return runtime.TestCase{}, fmt.Errorf("could not find test %s", title)
 }
 
+// GetGlobalConfig returns the global configuration which applies to the complete suite
 func (s Suite) GetGlobalConfig() runtime.TestConfig {
 	return s.Config
 }