use go-errors package to display stacktrace of errors that cause panics

pkg/commands/exec_live_default.go

@@ -5,7 +5,7 @@ package commands
 import (
 	"bufio"
 	"bytes"
-	"errors"
+	"github.com/go-errors/errors"
 	"os"
 	"os/exec"
 	"strings"

pkg/commands/git.go

@@ -1,12 +1,13 @@
 package commands
 
 import (
-	"errors"
 	"fmt"
 	"os"
 	"os/exec"
 	"strings"
 
+	"github.com/go-errors/errors"
+
 	"github.com/jesseduffield/lazygit/pkg/i18n"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/sirupsen/logrus"
@@ -27,11 +28,11 @@ func navigateToRepoRootDirectory(stat func(string) (os.FileInfo, error), chdir f
 		}
 
 		if !os.IsNotExist(err) {
-			return err
+			return errors.Wrap(err, 0)
 		}
 
 		if err = chdir(".."); err != nil {
-			return err
+			return errors.Wrap(err, 0)
 		}
 	}
 }

pkg/commands/os.go

@@ -1,13 +1,14 @@
 package commands
 
 import (
-	"errors"
 	"io/ioutil"
 	"os"
 	"os/exec"
 	"regexp"
 	"strings"
 
+	"github.com/go-errors/errors"
+
 	"github.com/jesseduffield/lazygit/pkg/config"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/mgutz/str"
@@ -122,7 +123,7 @@ func sanitisedCommandOutput(output []byte, err error) (string, error) {
 		// errors like 'exit status 1' are not very useful so we'll create an error
 		// from the combined output
 		if outputString == "" {
-			return "", err
+			return "", errors.Wrap(err, 0)
 		}
 		return outputString, errors.New(outputString)
 	}
@@ -201,12 +202,12 @@ func (c *OSCommand) Unquote(message string) string {
 func (c *OSCommand) AppendLineToFile(filename, line string) error {
 	f, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
 	if err != nil {
-		return err
+		return errors.Wrap(err, 0)
 	}
 	defer f.Close()
 
 	_, err = f.WriteString("\n" + line)
-	return err
+	return errors.Wrap(err, 0)
 }
 
 // CreateTempFile writes a string to a new temp file and returns the file's name
@@ -214,16 +215,16 @@ func (c *OSCommand) CreateTempFile(filename, content string) (string, error) {
 	tmpfile, err := ioutil.TempFile("", filename)
 	if err != nil {
 		c.Log.Error(err)
-		return "", err
+		return "", errors.Wrap(err, 0)
 	}
 
 	if _, err := tmpfile.WriteString(content); err != nil {
 		c.Log.Error(err)
-		return "", err
+		return "", errors.Wrap(err, 0)
 	}
 	if err := tmpfile.Close(); err != nil {
 		c.Log.Error(err)
-		return "", err
+		return "", errors.Wrap(err, 0)
 	}
 
 	return tmpfile.Name(), nil
@@ -231,5 +232,6 @@ func (c *OSCommand) CreateTempFile(filename, content string) (string, error) {
 
 // RemoveFile removes a file at the specified path
 func (c *OSCommand) RemoveFile(filename string) error {
-	return os.Remove(filename)
+	err := os.Remove(filename)
+	return errors.Wrap(err, 0)
 }

pkg/commands/pull_request.go

@@ -1,9 +1,10 @@
 package commands
 
 import (
-	"errors"
 	"fmt"
 	"strings"
+
+	"github.com/go-errors/errors"
 )
 
 // Service is a service that repository is on (Github, Bitbucket, ...)

pkg/git/patch_modifier.go

@@ -1,11 +1,12 @@
 package git
 
 import (
-	"errors"
 	"regexp"
 	"strconv"
 	"strings"
 
+	"github.com/go-errors/errors"
+
 	"github.com/jesseduffield/lazygit/pkg/i18n"
 	"github.com/jesseduffield/lazygit/pkg/utils"
 	"github.com/sirupsen/logrus"

pkg/gui/commits_panel.go

@@ -1,9 +1,10 @@
 package gui
 
 import (
-	"errors"
 	"fmt"
 
+	"github.com/go-errors/errors"
+
 	"github.com/jesseduffield/gocui"
 	"github.com/jesseduffield/lazygit/pkg/commands"
 	"github.com/jesseduffield/lazygit/pkg/utils"

pkg/gui/gui.go

@@ -6,7 +6,6 @@ import (
 	// "io"
 	// "io/ioutil"
 
-	"errors"
 	"io/ioutil"
 	"log"
 	"os"
@@ -14,6 +13,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/go-errors/errors"
+
 	// "strings"
 
 	"github.com/fatih/color"
@@ -568,7 +569,9 @@ func (gui *Gui) RunWithSubprocesses() {
 				gui.SubProcess.Stdin = nil
 				gui.SubProcess = nil
 			} else {
-				log.Panicln(err)
+				newErr := errors.Wrap(err, 0)
+				stackTrace := newErr.ErrorStack()
+				log.Panicln(stackTrace)
 			}
 		}
 	}

pkg/gui/options_menu_panel.go

@@ -1,7 +1,7 @@
 package gui
 
 import (
-	"errors"
+	"github.com/go-errors/errors"
 
 	"github.com/jesseduffield/gocui"
 )

pkg/gui/staging_panel.go

@@ -1,7 +1,7 @@
 package gui
 
 import (
-	"errors"
+	"github.com/go-errors/errors"
 
 	"github.com/jesseduffield/gocui"
 	"github.com/jesseduffield/lazygit/pkg/git"

pkg/test/test.go

@@ -1,7 +1,7 @@
 package test
 
 import (
-	"errors"
+	"github.com/go-errors/errors"
 	"os"
 	"os/exec"
 	"path/filepath"

pkg/updates/updates.go

@@ -2,7 +2,6 @@ package updates
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -13,6 +12,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/go-errors/errors"
+
 	"github.com/kardianos/osext"
 
 	getter "github.com/jesseduffield/go-getter"

pkg/utils/utils.go

@@ -2,7 +2,6 @@ package utils
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"log"
 	"os"
@@ -11,6 +10,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/go-errors/errors"
+
 	"github.com/fatih/color"
 )
 

pkg/utils/utils_test.go

@@ -1,7 +1,6 @@
 package utils
 
 import (
-	"errors"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -233,9 +232,9 @@ func TestGetDisplayStringArrays(t *testing.T) {
 // TestRenderDisplayableList is a function.
 func TestRenderDisplayableList(t *testing.T) {
 	type scenario struct {
-		input          []Displayable
+		input                []Displayable
-		expectedString string
+		expectedString       string
-		expectedError  error
+		expectedErrorMessage string
 	}
 
 	scenarios := []scenario{
@@ -245,7 +244,7 @@ func TestRenderDisplayableList(t *testing.T) {
 				Displayable(&myDisplayable{[]string{}}),
 			},
 			"\n",
-			nil,
+			"",
 		},
 		{
 			[]Displayable{
@@ -253,7 +252,7 @@ func TestRenderDisplayableList(t *testing.T) {
 				Displayable(&myDisplayable{[]string{"c", "d"}}),
 			},
 			"aa b\nc  d",
-			nil,
+			"",
 		},
 		{
 			[]Displayable{
@@ -261,23 +260,27 @@ func TestRenderDisplayableList(t *testing.T) {
 				Displayable(&myDisplayable{[]string{"b", "c"}}),
 			},
 			"",
-			errors.New("Each item must return the same number of strings to display"),
+			"Each item must return the same number of strings to display",
 		},
 	}
 
 	for _, s := range scenarios {
 		str, err := renderDisplayableList(s.input)
 		assert.EqualValues(t, s.expectedString, str)
-		assert.EqualValues(t, s.expectedError, err)
+		if s.expectedErrorMessage != "" {
+			assert.EqualError(t, err, s.expectedErrorMessage)
+		} else {
+			assert.NoError(t, err)
+		}
 	}
 }
 
 // TestRenderList is a function.
 func TestRenderList(t *testing.T) {
 	type scenario struct {
-		input          interface{}
+		input                interface{}
-		expectedString string
+		expectedString       string
-		expectedError  error
+		expectedErrorMessage string
 	}
 
 	scenarios := []scenario{
@@ -287,7 +290,7 @@ func TestRenderList(t *testing.T) {
 				{[]string{"c", "d"}},
 			},
 			"aa b\nc  d",
-			nil,
+			"",
 		},
 		{
 			[]*myStruct{
@@ -295,19 +298,23 @@ func TestRenderList(t *testing.T) {
 				{},
 			},
 			"",
-			errors.New("item does not implement the Displayable interface"),
+			"item does not implement the Displayable interface",
 		},
 		{
 			&myStruct{},
 			"",
-			errors.New("RenderList given a non-slice type"),
+			"RenderList given a non-slice type",
 		},
 	}
 
 	for _, s := range scenarios {
 		str, err := RenderList(s.input)
 		assert.EqualValues(t, s.expectedString, str)
-		assert.EqualValues(t, s.expectedError, err)
+		if s.expectedErrorMessage != "" {
+			assert.EqualError(t, err, s.expectedErrorMessage)
+		} else {
+			assert.NoError(t, err)
+		}
 	}
 }