BUGFIX-60: Isolate ssh-related functions in a separate module.

.github/workflows/tests.yml

@@ -34,3 +34,4 @@ jobs:
           file: ./unit.txt
           flags: unit,${{ matrix.os }},go-${{ matrix.go-version }}
           name: unit
+          token: ${{ secrets.CODECOV_TOKEN }}

.golangci.yml

@@ -31,7 +31,7 @@ run:
   #    - ".*\\.my\\.go$"
   #    - lib/bad.go
   skip-dirs:
-    - internal/mock
+    - internal/test
 
 # output configuration options
 output:

Makefile

@@ -26,6 +26,10 @@ lint:
 ## audit: tidy dependencies and format, vet and test all code
 .PHONY: audit
 audit:
+	@echo 'If something is not right, make sure these utilities are installed:'
+	@echo '  * If gofumpt is not installed, then: go install mvdan.cc/gofumpt@latest'
+	@echo '  * If goimports is not installed, then: go install golang.org/x/tools/cmd/goimports@latest'
+	@echo '  * For golangci-lint: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.57.2'
 	@echo 'Tidying and verifying module dependencies...'
 	go mod tidy
 	go mod verify
@@ -92,3 +96,10 @@ dist:
 	@cp $(DIST_PATH)/gg-mac $(DIST_PATH)/gg-lin $(DIST_PATH)/gg-win.exe $(DIST_PATH)/goto-$(BUILD_VERSION)
 	@cd $(DIST_PATH) && zip -r goto-$(BUILD_VERSION).zip goto-$(BUILD_VERSION)
 	@rm -r $(DIST_PATH)/goto-$(BUILD_VERSION)
+
+## clean: remove ./dist folder with all its contents.
+.PHONY: clean
+clean:
+	@echo 'Cleaning'
+	@-rm -r $(DIST_PATH) 2>/dev/null
+	@echo 'Done'

codecov.yml

@@ -1,3 +1,3 @@
 ignore:
   - "cmd/*"
-  - "internal/mock/*"
+  - "internal/test/*"

internal/logger/logger_test.go

@@ -10,7 +10,7 @@ import (
 	"testing"
 )
 
-func Test_LoggerConstructor(t *testing.T) {
+func TestLoggerConstructor(t *testing.T) {
 	// Create a temporary directory for testing
 	tmpDir, err := os.MkdirTemp("", "testlog")
 	if err != nil {
@@ -66,7 +66,7 @@ func Test_LoggerConstructor(t *testing.T) {
 	}
 }
 
-func Test_LoggerMethods(t *testing.T) {
+func TestLoggerMethods(t *testing.T) {
 	// Create a temporary directory for testing
 	tmpDir, err := os.MkdirTemp("", "testlog")
 	if err != nil {

internal/model/host_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func Test_NewHost(t *testing.T) {
+func TestNewHost(t *testing.T) {
 	// Create a new host using the NewHost function
 	expectedHost := Host{
 		ID:             1,
@@ -28,7 +28,7 @@ func Test_NewHost(t *testing.T) {
 	}
 }
 
-func Test_CloneHost(t *testing.T) {
+func TestCloneHost(t *testing.T) {
 	// Create a host to clone
 	originalHost := Host{
 		ID:             1,

internal/state/state.go

@@ -7,6 +7,8 @@ import (
 	"sync"
 
 	"gopkg.in/yaml.v2"
+
+	"github.com/grafviktor/goto/internal/utils/ssh"
 )
 
 type view int
@@ -16,7 +18,7 @@ const (
 	ViewHostList view = iota
 	// ViewEditItem mode is active when we edit existing or add a new host.
 	ViewEditItem
-	// ViewErrorMessage mode is active when there was an error when attenpted to connect to a remote host.
+	// ViewErrorMessage mode is active when there was an error when attempted to connect to a remote host.
 	ViewErrorMessage
 )
 
@@ -37,10 +39,11 @@ type ApplicationState struct {
 	Selected         int `yaml:"selected"`
 	appStateFilePath string
 	logger           iLogger
-	CurrentView      view  `yaml:"-"`
-	Err              error `yaml:"-"`
-	Width            int   `yaml:"-"`
-	Height           int   `yaml:"-"`
+	CurrentView      view        `yaml:"-"`
+	Err              error       `yaml:"-"`
+	Width            int         `yaml:"-"`
+	Height           int         `yaml:"-"`
+	HostSSHConfig    *ssh.Config `yaml:"-"`
 }
 
 // Get - reads application state from disk.
@@ -50,6 +53,7 @@ func Get(appHomePath string, lg iLogger) *ApplicationState {
 		appState = &ApplicationState{
 			appStateFilePath: path.Join(appHomePath, stateFile),
 			logger:           lg,
+			HostSSHConfig:    ssh.DefaultConfig(),
 		}
 
 		// If we cannot read previously created application state, that's fine - we can continue execution.

internal/state/state_test.go

@@ -9,11 +9,11 @@ import (
 	"github.com/stretchr/testify/assert"
 	"gopkg.in/yaml.v2"
 
-	"github.com/grafviktor/goto/internal/mock"
+	"github.com/grafviktor/goto/internal/test"
 )
 
 // That's a wrapper function for state.Get which is required to overcome sync.Once restrictions
-func stateGet(tempDir string, mockLogger *mock.MockLogger) *ApplicationState {
+func stateGet(tempDir string, mockLogger *test.MockLogger) *ApplicationState {
 	appState := Get(tempDir, mockLogger)
 
 	// We need this hack because state.Get function utilizes `sync.once`. That means, if all unit tests
@@ -34,7 +34,7 @@ func Test_GetApplicationState(t *testing.T) {
 	defer os.RemoveAll(tempDir)
 
 	// Create a mock logger for testing
-	mockLogger := &mock.MockLogger{}
+	mockLogger := &test.MockLogger{}
 
 	// Call the Get function with the temporary directory and mock logger
 	appState := stateGet(tempDir, mockLogger)
@@ -57,7 +57,7 @@ func Test_PersistApplicationState(t *testing.T) {
 	defer os.RemoveAll(tempDir)
 
 	// Create a mock logger for testing
-	mockLogger := &mock.MockLogger{}
+	mockLogger := &test.MockLogger{}
 
 	// Call the Get function with the temporary directory and mock logger
 	appState := stateGet(tempDir, mockLogger)

internal/mock/logger.go → internal/test/mock_logger.go

@@ -1,4 +1,4 @@
-package mock
+package test
 
 import "fmt"
 

internal/mock/storage.go → internal/test/mock_storage.go

@@ -1,4 +1,4 @@
-package mock
+package test
 
 import (
 	"errors"

internal/test/utils.go

@@ -0,0 +1,30 @@
+// Package test contains utility methods for unit tests.
+package test
+
+import (
+	"reflect"
+
+	tea "github.com/charmbracelet/bubbletea"
+)
+
+// CmdToMessage - should only be used in unit tests.
+func CmdToMessage(cmd tea.Cmd, messages *[]tea.Msg) {
+	message := cmd()
+	valueOf := reflect.ValueOf(message)
+
+	// Slice of messages is returned by tea.BatchMsg or tea.sequenceMsg
+	if valueOf.Kind() == reflect.Slice {
+		for i := 0; i < valueOf.Len(); i++ {
+			if valueOf.Index(i).Kind() == reflect.Func {
+				// If it's a function, then it's probably inner tea.Cmd
+				innerCmd := valueOf.Index(i).Interface().(tea.Cmd)
+				CmdToMessage(innerCmd, messages)
+			} else {
+				// Otherwise it's a slice of real messages
+				*messages = append(*messages, message)
+			}
+		}
+	} else {
+		*messages = append(*messages, message)
+	}
+}