project structure refactor prep for api testing

Author: PathToLife

README.md

@@ -23,7 +23,7 @@ To Run Server (defaults to port 3000, will also download dependencies and build)
 
 To Run all tests
 
-`go test ./test`
+`go test ./tests`
 
 To Build
 

db/db.go

@@ -0,0 +1,15 @@
+package db
+
+/*
+Normally would have db connection handing function here, but for now, we just have a DeckStore inmemory storage
+*/
+
+var deckStore DeckStore
+
+func InitDb() {
+	deckStore = NewDeckStore()
+}
+
+func GetDeckStore() DeckStore {
+	return deckStore
+}

decks/deckStore.go renamed to db/deckStore.go

@@ -1,25 +1,27 @@
-package decks
+package db
+
+import "decksframework/decks"
 
 // DeckStore stores decks, placeholder struct for future functionality such as persistent storage
 type DeckStore struct {
-	decksMap map[string]*Deck
+	decksMap map[string]*decks.Deck
 }
 
-func (ds DeckStore) AddDeck(d *Deck) {
+func (ds DeckStore) AddDeck(d *decks.Deck) {
 	ds.decksMap[d.DeckId] = d
 }
 
-func (ds DeckStore) RemoveDeck(d *Deck) {
+func (ds DeckStore) RemoveDeck(d *decks.Deck) {
 	delete(ds.decksMap, d.DeckId)
 }
 
-func (ds DeckStore) GetDeck(uuid string) *Deck {
+func (ds DeckStore) GetDeck(uuid string) *decks.Deck {
 	return ds.decksMap[uuid]
 }
 
 // NewDeckStore initialize deckStore
 func NewDeckStore() DeckStore {
 	return DeckStore{
-		decksMap: map[string]*Deck{},
+		decksMap: map[string]*decks.Deck{},
 	}
 }

main.go

@@ -1,7 +1,8 @@
 package main
 
 import (
-	"decksframework/decks"
+	"decksframework/db"
+	"decksframework/server"
 	"github.com/joho/godotenv"
 	"os"
 	"strings"
@@ -20,15 +21,13 @@ func isDebug() bool {
 	return debugStr == "true"
 }
 
-var deckStore decks.DeckStore
-
 func main() {
 	// load .env files if set in directory
 	_ = godotenv.Load()
 
 	// init in memory deck storage, replace with database call in future
-	deckStore = decks.NewDeckStore()
+	db.InitDb()
 
 	// start server and listen
-	startApiServer(getServerPort(), isDebug())
+	server.StartApiServer(getServerPort(), isDebug())
 }

server.go renamed to server/server.go

@@ -1,6 +1,7 @@
-package main
+package server
 
 import (
+	"decksframework/db"
 	"decksframework/decks"
 	"fmt"
 	"github.com/gin-gonic/gin"
@@ -16,16 +17,14 @@ Notes: Please branch out server routes into separate handler files when adding n
 Single file for now
 */
 
-var router *gin.Engine
-
-func startApiServer(port string, debug bool) {
+func StartApiServer(port string, debug bool) {
 	if debug == false {
 		gin.SetMode("release")
 	}
 
-	router = gin.Default()
+	router := gin.Default()
 
-	initializeRoutes()
+	InitializeRoutes(router)
 
 	// listen and serve
 	err := router.Run(":" + port)
@@ -34,8 +33,10 @@ func startApiServer(port string, debug bool) {
 	}
 }
 
-func initializeRoutes() {
-	router.POST("/deck/create", func(c *gin.Context) {
+func InitializeRoutes(r *gin.Engine) {
+	deckStore := db.GetDeckStore()
+
+	r.POST("/deck/create", func(c *gin.Context) {
 		shouldShuffleDeck := false
 
 		// ?shouldShuffleDeck=true for deck shuffling
@@ -72,7 +73,7 @@ func initializeRoutes() {
 		c.JSON(http.StatusCreated, deck.GetClosedDeck())
 	})
 
-	router.POST("/deck/draw", func(c *gin.Context) {
+	r.POST("/deck/draw", func(c *gin.Context) {
 		uuid, ok := c.GetQuery("uuid")
 		if !ok || uuid == "" {
 			c.AbortWithStatusJSON(http.StatusBadRequest, ErrorMsg("uuid required"))
@@ -107,7 +108,7 @@ func initializeRoutes() {
 		})
 	})
 
-	router.GET("/deck/open", func(c *gin.Context) {
+	r.GET("/deck/open", func(c *gin.Context) {
 		uuid, ok := c.GetQuery("uuid")
 		if !ok || uuid == "" {
 			c.AbortWithStatusJSON(http.StatusBadRequest, ErrorMsg("uuid required"))

tests/api_test.go

@@ -0,0 +1,20 @@
+package tests
+
+import (
+	"decksframework/server"
+	"github.com/gin-gonic/gin"
+	"net/http/httptest"
+	"testing"
+)
+
+func GetRouter() *gin.Engine {
+	r := gin.Default()
+	server.InitializeRoutes(r)
+	return r
+}
+
+func TestApiDecks(t *testing.T) {
+	t.Run("create deck", func(t *testing.T) {
+		httptest.NewRequest()
+	})
+}

test/deckHelpers_test.go renamed to tests/deckHelpers_test.go

@@ -1,8 +1,10 @@
-package test
+package tests
 
-import "decksframework/decks"
+import (
+	decks2 "decksframework/decks"
+)
 
-func CardsEqual(c1 []decks.Card, c2 []decks.Card) bool {
+func CardsEqual(c1 []decks2.Card, c2 []decks2.Card) bool {
 	if len(c1) != len(c2) {
 		return false
 	}

test/deck_test.go renamed to tests/deck_test.go

@@ -1,4 +1,4 @@
-package test
+package tests
 
 import (
 	"decksframework/decks"
@@ -228,7 +228,7 @@ func TestCustomDeck(t *testing.T) {
 
 func TestGenerateCards(t *testing.T) {
 
-	t.Run("extra card test", func(t *testing.T) {
+	t.Run("extra card tests", func(t *testing.T) {
 		extraCards := []decks.Card{
 			{
 				Value: "GodFather",