Ci/commitlint

.github/workflows/lint.yaml

@@ -1,13 +1,16 @@
-name: commit_lint
-on: [pull_request]
+name: lint
 
-permissions:
-  contents: read
-  pull-requests: read
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
 
 jobs:
-  commitlint:
+  staticcheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: wagoid/commitlint-github-action@v5
+      - uses: actions/setup-go@v3
+      - run: go install honnef.co/go/tools/cmd/staticcheck@latest
+      - run: ~/go/bin/staticcheck -checks all

.github/workflows/validation.yaml

@@ -0,0 +1,14 @@
+name: validation
+
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: wagoid/commitlint-github-action@v5

command.go

@@ -1,3 +1,6 @@
+// Package cmd is a simple package
+// to execute shell commeand on linux,
+// windows, and osx.
 package cmd
 
 import (
@@ -245,12 +248,12 @@ func (c *Command) ExecuteContext(ctx context.Context) error {
 	select {
 	case <-ctx.Done():
 		if err := cmd.Process.Kill(); err != nil {
-			return fmt.Errorf("Timeout occurred and can not kill process with pid %v", cmd.Process.Pid)
+			return fmt.Errorf("timeout occurred and can not kill process with pid %v", cmd.Process.Pid)
 		}
 
 		err := ctx.Err()
 		if c.Timeout > 0 && !hasDeadline {
-			err = fmt.Errorf("Command timed out after %v", c.Timeout)
+			err = fmt.Errorf("command timed out after %v", c.Timeout)
 		}
 		return err
 	case err := <-done:

command_darwin_test.go

@@ -10,7 +10,6 @@ import (
 
 func TestCommand_ExecuteStderr(t *testing.T) {
 	cmd := NewCommand(">&2 echo hello")
-
 	err := cmd.Execute()
 
 	assert.Nil(t, err)
@@ -23,7 +22,7 @@ func TestCommand_WithTimeout(t *testing.T) {
 	err := cmd.Execute()
 
 	assert.NotNil(t, err)
-	assert.Equal(t, "Command timed out after 5ms", err.Error())
+	assert.Equal(t, "command timed out after 5ms", err.Error())
 }
 
 func TestCommand_WithValidTimeout(t *testing.T) {

command_linux_test.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"bytes"
 	"context"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"strings"
@@ -12,6 +11,7 @@ import (
 	"time"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestCommand_ExecuteStderr(t *testing.T) {
@@ -27,10 +27,9 @@ func TestCommand_WithTimeout(t *testing.T) {
 	cmd := NewCommand("sleep 0.1;", WithTimeout(1*time.Millisecond))
 
 	err := cmd.Execute()
-
 	assert.NotNil(t, err)
 	// Sadly a process can not be killed every time :(
-	containsMsg := strings.Contains(err.Error(), "Timeout occurred and can not kill process with pid") || strings.Contains(err.Error(), "Command timed out after 1ms")
+	containsMsg := strings.Contains(err.Error(), "timeout occurred and can not kill process with pid") || strings.Contains(err.Error(), "command timed out after 1ms")
 	assert.True(t, containsMsg)
 }
 
@@ -54,7 +53,8 @@ func TestCommand_WithWorkingDir(t *testing.T) {
 }
 
 func TestCommand_WithStandardStreams(t *testing.T) {
-	tmpFile, _ := ioutil.TempFile("/tmp", "stdout_")
+	tmpFile, err := os.CreateTemp("/tmp", "stdout_")
+	require.NoError(t, err)
 	originalStdout := os.Stdout
 	os.Stdout = tmpFile
 
@@ -66,8 +66,8 @@ func TestCommand_WithStandardStreams(t *testing.T) {
 	cmd := NewCommand("echo hey", WithStandardStreams)
 	cmd.Execute()
 
-	r, err := ioutil.ReadFile(tmpFile.Name())
-	assert.Nil(t, err)
+	r, err := os.ReadFile(tmpFile.Name())
+	require.NoError(t, err)
 	assert.Equal(t, "hey\n", string(r))
 }
 
@@ -137,7 +137,7 @@ func TestCommand_WithContext(t *testing.T) {
 	cmd := NewCommand("sleep 3;", WithTimeout(1*time.Second))
 	err := cmd.Execute()
 	assert.NotNil(t, err)
-	assert.Equal(t, "Command timed out after 1s", err.Error())
+	assert.Equal(t, "command timed out after 1s", err.Error())
 
 	// set context timeout to 2 seconds to ensure
 	// context takes precedence over timeout

command_windows_test.go

@@ -21,12 +21,11 @@ func TestCommand_ExecuteStderr(t *testing.T) {
 
 func TestCommand_WithTimeout(t *testing.T) {
 	cmd := NewCommand("timeout 0.005;", WithTimeout(5*time.Millisecond))
-
 	err := cmd.Execute()
 
 	assert.NotNil(t, err)
 	// This is needed because windows sometimes can not kill the process :(
-	containsMsg := strings.Contains(err.Error(), "Timeout occurred and can not kill process with pid") || strings.Contains(err.Error(), "Command timed out after 5ms")
+	containsMsg := strings.Contains(err.Error(), "timeout occurred and can not kill process with pid") || strings.Contains(err.Error(), "command timed out after 5ms")
 	assert.True(t, containsMsg)
 }