Merge pull request #6 from gtalarico/improve-tests

Improve test coverage

.gitignore

@@ -1,4 +1,4 @@
 dist/
-
+coverage.out
 ### GoLand ###
-.idea/*
+.idea/*

internal/config/config_test.go

@@ -0,0 +1,26 @@
+package config
+
+import (
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestUserHomePath(t *testing.T) {
+	homePath := UserHomePath()
+	if homePath != os.Getenv("HOME") {
+		t.Error("Could not get HOME path")
+	}
+}
+
+func TestConfigFilePath(t *testing.T) {
+	path := configFilepath()
+	endsWithConfigFile := strings.Contains(path, ConfigFilename)
+	if !endsWithConfigFile {
+		t.Error("Config filepath does not end with config filename: {}", path)
+	}
+}
+
+// func WriteConfig(config Config) (err error) {
+// func CreateConfig(path string) (cfg Config, err error) {
+// func ReadConfig() (cfg Config, err error) {

internal/config/search.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 )
 
+// Searches projects in config, matches by strings.Contains, returns list of all matching project
 func SearchProjects(query string, config Config) []*Project {
 	var projects []*Project
 	for _, project := range config.Projects {
@@ -16,6 +17,7 @@ func SearchProjects(query string, config Config) []*Project {
 	return projects
 }
 
+// Searches projects in config, returns first exact match or nil
 func MatchProjects(query string, config Config) (project *Project) {
 	for _, p := range config.Projects {
 		if p.Name == query {
@@ -25,6 +27,7 @@ func MatchProjects(query string, config Config) (project *Project) {
 	return
 }
 
+// Gets on exact project using SearchProjects, if none or multiples error is raised
 func GetOneProject(query string, config Config) (project *Project, err error) {
 	projects := SearchProjects(query, config)
 	numProjects := len(projects)
@@ -37,7 +40,7 @@ func GetOneProject(query string, config Config) (project *Project, err error) {
 	}
 	if numProjects > 1 {
 		exactMatch := MatchProjects(query, config)
-		if exactMatch.Name == query {
+		if exactMatch != nil {
 			project = exactMatch
 		} else {
 			for _, project := range projects {

internal/config/search_test.go

@@ -2,7 +2,13 @@ package config
 
 import "testing"
 
-func TestSearchProjects(t *testing.T) {
+type Fixtures struct {
+	projects []*Project
+	cfg      *Config
+}
+
+func fixtures() Fixtures {
+
 	projects := []*Project{
 		{
 			Name: "project",
@@ -13,8 +19,19 @@ func TestSearchProjects(t *testing.T) {
 			Path: "~",
 		},
 	}
+
 	cfg := Config{projects}
 
+	return Fixtures{
+		projects,
+		&cfg,
+	}
+
+}
+
+func TestSearchProjects(t *testing.T) {
+	cfg := fixtures().cfg
+
 	var tests = []struct {
 		input    string
 		expected int
@@ -25,11 +42,59 @@ func TestSearchProjects(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		projects := SearchProjects(test.input, cfg)
+		projects := SearchProjects(test.input, *cfg)
 		if len(projects) != test.expected {
 			t.Error("Test Failed: {} inputted, {} expected, recieved: {}",
 				test.input, test.expected, projects)
 		}
 	}
 
 }
+
+func TestMatchProjectsMatch(t *testing.T) {
+	cfg := fixtures().cfg
+
+	project := MatchProjects("project", *cfg)
+	if project.Name != "project" {
+		t.Error("Test Failed: {} inputed, {} expected, recieved: {}",
+			"project", "project", project.Name)
+	}
+}
+
+func TestMatchProjectsNoMatch(t *testing.T) {
+	cfg := fixtures().cfg
+
+	project := MatchProjects("xxx", *cfg)
+	if project != nil {
+		t.Error("Test Failed: {} inputed, {} expected, recieved: {}",
+			"xxx", "no match", project)
+	}
+}
+
+func TestGetProjects(t *testing.T) {
+	cfg := fixtures().cfg
+
+	var tests = []struct {
+		input  string
+		hasErr bool
+	}{
+		{"xxx", true},
+		{"project", false},
+		{"o", true},
+	}
+
+	for _, test := range tests {
+		project, err := GetOneProject(test.input, *cfg)
+		hasErr := err != nil
+		if test.hasErr != hasErr {
+			t.Error("Test Failed: {} inputed, {} expected, received: {}",
+				test.input, test.hasErr, hasErr)
+		}
+		if err != nil {
+			if project != nil {
+				t.Error("Test Failed: input: {}, expected: {}, received: {}",
+					test.input, "project is null", project)
+			}
+		}
+	}
+}