Merge pull request #1 from SimonBaeumer/add-travis-build

Add travis build and badges

Author: SimonBaeumer

.travis.yml

@@ -0,0 +1,45 @@
+language: go
+
+env:
+  global:
+    - GO111MODULE=on
+    - CC_TEST_REPORTER_ID=1fee6b47ad638c3cb28b932d28413d643a06c90b277bc5839e306f40e932422e
+
+stages:
+  - test
+
+go:
+  - 1.13.x
+
+sudo: required
+dist: trusty
+
+before_install:
+  - go get -u golang.org/x/lint/golint
+  - make deps
+  - curl -L https://github.com/SimonBaeumer/commander/releases/download/v0.3.0/commander-linux-amd64 -o ~/bin/commander
+  - chmod +x ~/bin/commander
+
+jobs:
+  include:
+    - name: macOS Unit
+      os: osx
+      script:
+        - make test
+
+    - name: windows Unit
+      os: windows
+      before_install:
+        - choco install make
+      script:
+        - make test-windows
+
+    - name: Unit tests
+      before_script:
+        - curl https://s3.amazonaws.com/codeclimate/test-reporter/test-reporter-0.6.3-linux-amd64 --output test-reporter
+        - chmod +x test-reporter
+        - ./test-reporter before-build
+      script:
+        - make test-coverage
+      after_script:
+        - ./test-reporter after-build -t gocov --exit-code $TRAVIS_TEST_RESULT

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Svett Ralchev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -24,8 +24,12 @@ lint:
 
 test:
 	$(info INFO: Starting build $@)
-	go test ./...
+	go test `go list ./... | grep -v examples`
+
+test-windows:
+	$(info INFO: Starting build $@)
+	go test .
 
 test-coverage:
 	$(info INFO: Starting build $@)
-	go test -coverprofile c.out ./...
+	go test -coverprofile c.out `go list ./... | grep -v examples`

README.md

@@ -1,6 +1,16 @@
+[![Build Status](https://travis-ci.org/SimonBaeumer/cmd.svg?branch=master)](https://travis-ci.org/SimonBaeumer/cmd)
+[![GoDoc](https://godoc.org/github.com/SimonBaeumer/cmd?status.svg)](https://godoc.org/github.com/SimonBaeumer/cmd)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/af3487439a313d580619/test_coverage)](https://codeclimate.com/github/SimonBaeumer/cmd/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/af3487439a313d580619/maintainability)](https://codeclimate.com/github/SimonBaeumer/cmd/maintainability)
+[![Go Report Card](https://goreportcard.com/badge/github.com/SimonBaeumer/cmd)](https://goreportcard.com/report/github.com/SimonBaeumer/cmd)
+
 # cmd package
 
-A simple package to execute shell commands on windows, darwin and windows.
+A simple package to execute shell commands on linux, darwin and windows.
+
+## Installation
+
+`$ go get -u github.com/SimonBaeumer/[email protected]`
 
 ## Usage
 
@@ -19,7 +29,7 @@ fmt.Println(cmd.Stderr())
 ### Stream output to stderr and stdout
 
 ```go
-cmd := NewCommand("echo hello", WithStandardStreams)
+cmd := NewCommand("echo hello", cmd.WithStandardStreams)
 cmd.Execute()
 ```
 
@@ -48,10 +58,4 @@ make test
 
 ### ToDo
 
- - Reports
-    - Coverage reports
-    - Go report
-    - Codeclimate
- - Travis-Pipeline
- - Documentation
  - os.Stdout and os.Stderr output access after execution

command.go

@@ -22,18 +22,32 @@ type Command struct {
 	StdoutWriter io.Writer
 	WorkingDir   string
 	executed     bool
-	stderr       bytes.Buffer
-	stdout       bytes.Buffer
 	exitCode     int
+	// stderr and stdout retrieve the output after the command was executed
+	stderr bytes.Buffer
+	stdout bytes.Buffer
 }
 
-//NewCommand creates a new command
+// NewCommand creates a new command
+// You can add option with variadic option argument
+//
+// Example:
+//      c := cmd.NewCommand("echo hello", function (c *Command) {
+//		    c.WorkingDir = "/tmp"
+//      })
+//      c.Execute()
+//
+// or you can use existing options functions
+//
+//      c := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
+//      c.Execute()
+//
 func NewCommand(cmd string, options ...func(*Command)) *Command {
 	c := &Command{
-		Command:      cmd,
-		Timeout:      1 * time.Minute,
-		executed:     false,
-		Env:          []string{},
+		Command:  cmd,
+		Timeout:  1 * time.Minute,
+		executed: false,
+		Env:      []string{},
 	}
 
 	c.StdoutWriter = &c.stdout

command_darwin.go

@@ -6,7 +6,7 @@ import (
 )
 
 func createBaseCommand(c *Command) *exec.Cmd {
-	cmd := exec.Command("/bin/sh", "-Command", c.Command)
+	cmd := exec.Command("/bin/sh", "-c", c.Command)
 	return cmd
 }
 

command_darwin_test.go

@@ -11,7 +11,7 @@ func TestCommand_ExecuteStderr(t *testing.T) {
 	err := cmd.Execute()
 
 	assert.Nil(t, err)
-	assert.Equal(t, "hello", cmd.Stderr())
+	assert.Equal(t, "hello\n", cmd.Stderr())
 }
 
 func TestCommand_WithTimeout(t *testing.T) {

command_linux_test.go

@@ -2,6 +2,8 @@ package cmd
 
 import (
 	"github.com/stretchr/testify/assert"
+	"io/ioutil"
+	"os"
 	"strings"
 	"testing"
 )
@@ -37,7 +39,7 @@ func TestCommand_WithValidTimeout(t *testing.T) {
 }
 
 func TestCommand_WithWorkingDir(t *testing.T) {
-	setWorkingDir := func (c *Command) {
+	setWorkingDir := func(c *Command) {
 		c.WorkingDir = "/tmp"
 	}
 
@@ -48,8 +50,19 @@ func TestCommand_WithWorkingDir(t *testing.T) {
 }
 
 func TestCommand_WithStandardStreams(t *testing.T) {
+	tmpFile, _ := ioutil.TempFile("/tmp", "stdout_")
+	originalStdout := os.Stdout
+	os.Stdout = tmpFile
+
+	// Reset os.Stdout to its original value
+	defer func() {
+		os.Stdout = originalStdout
+	}()
+
 	cmd := NewCommand("echo hey", WithStandardStreams)
 	cmd.Execute()
 
-	assert.Equal(t, "/tmp\n", cmd.Stdout())
-}
+	r, err := ioutil.ReadFile(tmpFile.Name())
+	assert.Nil(t, err)
+	assert.Equal(t, "hey\n", string(r))
+}

command_test.go

@@ -22,7 +22,7 @@ func TestCommand_Execute(t *testing.T) {
 
 	assert.Nil(t, err)
 	assert.True(t, cmd.Executed())
-	assert.Equal(t, cmd.Stdout(), "hello\n")
+	assertEqualWithLineBreak(t, "hello", cmd.Stdout())
 }
 
 func TestCommand_ExitCode(t *testing.T) {
@@ -44,7 +44,7 @@ func TestCommand_WithEnvVariables(t *testing.T) {
 
 	_ = cmd.Execute()
 
-	assert.Equal(t, cmd.Stdout(), "hey\n")
+	assertEqualWithLineBreak(t, "hey", cmd.Stdout())
 }
 
 func TestCommand_Executed(t *testing.T) {
@@ -77,7 +77,7 @@ func TestCommand_AddEnvWithShellVariable(t *testing.T) {
 	err := c.Execute()
 
 	assert.Nil(t, err)
-	assert.Equal(t, "test from shell\n", c.Stdout())
+	assertEqualWithLineBreak(t, "test from shell", c.Stdout())
 }
 
 func TestCommand_AddMultipleEnvWithShellVariable(t *testing.T) {
@@ -97,7 +97,7 @@ func TestCommand_AddMultipleEnvWithShellVariable(t *testing.T) {
 	err := c.Execute()
 
 	assert.Nil(t, err)
-	assert.Equal(t, "Hello world, I am Simon\n", c.Stdout())
+	assertEqualWithLineBreak(t, "Hello world, I am Simon", c.Stdout())
 }
 
 func getCommand() string {
@@ -149,5 +149,15 @@ func TestCommand_SetOptions(t *testing.T) {
 
 	assert.Nil(t, err)
 	assert.Equal(t, time.Duration(1000000000), c.Timeout)
-	assert.Equal(t, "test\n", writer.String())
-}
+	assertEqualWithLineBreak(t, "test", writer.String())
+}
+
+func assertEqualWithLineBreak(t *testing.T, expected string, actual string) {
+	if runtime.GOOS == "windows" {
+		expected = expected + "\r\n"
+	} else {
+		expected = expected + "\n"
+	}
+
+	assert.Equal(t, expected, actual)
+}

command_windows.go

@@ -6,7 +6,7 @@ import (
 )
 
 func createBaseCommand(c *Command) *exec.Cmd {
-	cmd := exec.Command(`Command:\windows\system32\cmd.exe`, "/C", c.Command)
+	cmd := exec.Command(`C:\windows\system32\cmd.exe`, "/C", c.Command)
 	return cmd
 }