Merge pull request #65 from SimonBaeumer/add-godoc

Add godoc badge

Author: SimonBaeumer

README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/SimonBaeumer/commander.svg?branch=master)](https://travis-ci.org/SimonBaeumer/commander)
+[![GoDoc](https://godoc.org/github.com/SimonBaeumer/commander?status.svg)](https://godoc.org/github.com/SimonBaeumer/commander)
 [![Go Report Card](https://goreportcard.com/badge/github.com/SimonBaeumer/commander)](https://goreportcard.com/report/github.com/SimonBaeumer/commander)
 [![Maintainability](https://api.codeclimate.com/v1/badges/cc848165784e0f809a51/maintainability)](https://codeclimate.com/github/SimonBaeumer/commander/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/cc848165784e0f809a51/test_coverage)](https://codeclimate.com/github/SimonBaeumer/commander/test_coverage)

pkg/app/add_command.go

@@ -7,6 +7,9 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
+// AddCommand executes the add command
+// command is the command which should be added to the test suite
+// existed holds the existing yaml content
 func AddCommand(command string, existed []byte) ([]byte, error) {
 	conf := suite.YAMLConfig{
 		Tests:  make(map[string]suite.YAMLTest),

pkg/app/app.go

@@ -3,9 +3,9 @@ package app
 import "github.com/urfave/cli"
 
 const (
-	//Defines the app name
+	//AppName defines the app name
 	AppName = "Commander"
-	//Default config file which is loaded
+	//CommanderFile holds the default config file which is loaded
 	CommanderFile = "commander.yaml"
 )
 

pkg/app/test_command.go

@@ -10,6 +10,10 @@ import (
 	"os"
 )
 
+// TestCommand executes the test argument
+// file is the path to the configuration file
+// title ist the title of test which should be executed, if empty it will execute all tests
+// ctx holds the command flags
 func TestCommand(file string, title string, ctx AddCommandContext) error {
 	if ctx.Verbose == true {
 		log.SetOutput(os.Stdout)

pkg/cmd/command.go

@@ -30,6 +30,7 @@ func NewCommand(cmd string) *Command {
 	}
 }
 
+// AddEnv adds an environment variable to the command
 func (c *Command) AddEnv(key string, value string) {
 	c.Env = append(c.Env, fmt.Sprintf("%s=%s", key, value))
 }
@@ -84,7 +85,8 @@ func (c *Command) isExecuted(property string) {
 	}
 }
 
-//Execute executes the commande
+// Execute executes the command and writes the results into it's own instance
+// The results can be received with the Stdout(), Stderr() and ExitCode() methods
 func (c *Command) Execute() error {
 	cmd := createBaseCommand(c)
 	cmd.Env = c.Env

pkg/runtime/runtime.go

@@ -88,7 +88,8 @@ type TestResult struct {
 	Tries            int
 }
 
-// Start starts the given test suite
+// Start starts the given test suite and executes all tests
+// maxConcurrent configures the amount of go routines which will be started
 func Start(tests []TestCase, maxConcurrent int) <-chan TestResult {
 	in := make(chan TestCase)
 	out := make(chan TestResult)
@@ -133,6 +134,7 @@ func Start(tests []TestCase, maxConcurrent int) <-chan TestResult {
 	return out
 }
 
+// runTest executes the current test case
 func runTest(test TestCase) TestResult {
 	// cut = command under test
 	cut := cmd.NewCommand(test.Command.Cmd)
@@ -169,6 +171,7 @@ func runTest(test TestCase) TestResult {
 	return Validate(test)
 }
 
+// GetRetries returns the retries of the command
 func (c *CommandUnderTest) GetRetries() int {
 	if c.Retries == 0 {
 		return 1

pkg/runtime/validator.go

@@ -20,6 +20,7 @@ func newValidationResult(m matcher.MatcherResult) ValidationResult {
 }
 
 // Validate validates the test results with the expected values
+// The test should hold the result and expected to validate the result
 func Validate(test TestCase) TestResult {
 	equalMatcher := matcher.NewMatcher(matcher.Equal)
 

pkg/suite/yaml_suite.go

@@ -52,7 +52,7 @@ func (s YAMLSuite) GetTestByTitle(title string) (runtime.TestCase, error) {
 	return runtime.TestCase{}, fmt.Errorf("Could not find test " + title)
 }
 
-//GetGlobalConfig returns the global suite configuraiton
+//GetGlobalConfig returns the global suite configuration
 func (s YAMLSuite) GetGlobalConfig() runtime.TestConfig {
 	return s.Config
 }