Merge pull request #63 from Ivan-Marquez/feature/console-tests

feature/console-tests

console/console.go

@@ -2,10 +2,11 @@ package console
 
 import (
 	"fmt"
-	ui "github.com/gizak/termui/v3"
 	"log"
 	"os"
 	"time"
+
+	ui "github.com/gizak/termui/v3"
 )
 
 const (
@@ -38,10 +39,13 @@ func Init() {
 	}
 }
 
+// Close function calls Close from termui package,
+// which closes termbox-go
 func Close() {
 	ui.Close()
 }
 
+// Exit function exits the program successfully
 func Exit(message string) {
 	if len(message) > 0 {
 		println(message)

console/palette.go

@@ -2,8 +2,9 @@ package console
 
 import (
 	"fmt"
-	ui "github.com/gizak/termui/v3"
 	"runtime"
+
+	ui "github.com/gizak/termui/v3"
 )
 
 type Theme string
@@ -46,6 +47,7 @@ type Palette struct {
 	ReverseColor   ui.Color
 }
 
+// GetPalette returns a color palette based on specified theme
 func GetPalette(theme Theme) Palette {
 	switch theme {
 	case ThemeDark:
@@ -69,6 +71,8 @@ func GetPalette(theme Theme) Palette {
 	}
 }
 
+// GetMenuColor returns a color based on the
+// operating system target
 func GetMenuColor() ui.Color {
 	switch runtime.GOOS {
 	case "windows":
@@ -78,6 +82,8 @@ func GetMenuColor() ui.Color {
 	}
 }
 
+// GetMenuColorReverse returns a color based on the
+// operating system target
 func GetMenuColorReverse() ui.Color {
 	switch runtime.GOOS {
 	case "windows":

console/palette_test.go

@@ -0,0 +1,99 @@
+package console
+
+import (
+	"testing"
+
+	ui "github.com/gizak/termui/v3"
+)
+
+func TestGetPalette(t *testing.T) {
+	var (
+		darkPalette = Palette{
+			BaseColor:    ColorWhite,
+			ReverseColor: ColorBlack,
+		}
+		lightPalette = Palette{
+			BaseColor:    ColorBlack,
+			ReverseColor: ColorWhite,
+		}
+	)
+
+	tests := []struct {
+		name  string
+		input Theme
+		Palette
+	}{
+		{"should return dark theme with base color white", ThemeDark, darkPalette},
+		{"should return light theme with base color black", ThemeLight, lightPalette},
+	}
+
+	for _, test := range tests {
+		palette := GetPalette(test.input)
+		if got := palette.BaseColor; got != test.BaseColor {
+			t.Errorf("GetPalette(%q) = %d, want %d", test.input, got, test.BaseColor)
+		}
+	}
+}
+
+func TestGetPaletteInvalidTheme(t *testing.T) {
+	const invalid Theme = "invalid"
+
+	defer func() {
+		if r := recover(); r == nil {
+			t.Errorf("GetPalette(%q) should have panicked", invalid)
+		}
+	}()
+
+	GetPalette(invalid)
+}
+
+func TestGetGradientColor(t *testing.T) {
+	type args struct {
+		gradient []ui.Color
+		cur      int
+		max      int
+	}
+
+	var (
+		lightThemeGradientInput = args{
+			gradient: []ui.Color{
+				250, 248, 246, 244, 242, 240, 238, 236, 234, 232, 16,
+			},
+			cur: 200,
+			max: 250,
+		}
+
+		darkThemeGradientInput = args{
+			gradient: []ui.Color{
+				39, 33, 62, 93, 164, 161,
+			},
+			cur: 40,
+			max: 180,
+		}
+
+		grey ui.Color = 234
+
+		blue ui.Color = 33
+	)
+
+	tests := []struct {
+		name string
+		args
+		want ui.Color
+	}{
+		{"should return color grey", lightThemeGradientInput, grey},
+		{"should return color blue", darkThemeGradientInput, blue},
+	}
+
+	for _, test := range tests {
+		gradientColor := GetGradientColor(
+			test.gradient,
+			test.cur,
+			test.max,
+		)
+
+		if got := gradientColor; got != test.want {
+			t.Errorf("GetGradientColor(%v) = %d, want %d", test.args, got, test.want)
+		}
+	}
+}