Add unit tests for Highscores API (#61)

Author: kamilon

src/TibiaHighscoresV3.go

@@ -10,6 +10,33 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
+// Child of Highscores
+type Highscore struct {
+	Rank     int    `json:"rank"`            // Rank column
+	Name     string `json:"name"`            // Name column
+	Vocation string `json:"vocation"`        // Vocation column
+	World    string `json:"world"`           // World column
+	Level    int    `json:"level"`           // Level column
+	Value    int    `json:"value"`           // Points/SkillLevel column
+	Title    string `json:"title,omitempty"` // Title column (when category: loyalty)
+}
+
+// Child of JSONData
+type Highscores struct {
+	World         string      `json:"world"`
+	Category      string      `json:"category"`
+	Vocation      string      `json:"vocation"`
+	HighscoreAge  int         `json:"highscore_age"`
+	HighscoreList []Highscore `json:"highscore_list"`
+}
+
+//
+// The base includes two levels: Highscores and Information
+type HighscoresResponse struct {
+	Highscores  Highscores  `json:"highscores"`
+	Information Information `json:"information"`
+}
+
 var (
 	HighscoresAgeRegex = regexp.MustCompile(`.*<div class="Text">Highscores.*Last Update: ([0-9]+) minutes ago.*`)
 	SevenColumnRegex   = regexp.MustCompile(`<td>.*<\/td><td.*">(.*)<\/a><\/td><td.*>(.*)<\/td><td.*>(.*)<\/td><td>(.*)<\/td><td.*>(.*)<\/td><td.*>(.*)<\/td>`)
@@ -18,7 +45,6 @@ var (
 
 // TibiaHighscoresV3 func
 func TibiaHighscoresV3(c *gin.Context) {
-
 	// getting params from URL
 	world := c.Param("world")
 	category := c.Param("category")
@@ -27,33 +53,6 @@ func TibiaHighscoresV3(c *gin.Context) {
 	// do some validation of category and vocation
 	// maybe return error on faulty value?!
 
-	// Child of Highscores
-	type Highscore struct {
-		Rank     int    `json:"rank"`            // Rank column
-		Name     string `json:"name"`            // Name column
-		Vocation string `json:"vocation"`        // Vocation column
-		World    string `json:"world"`           // World column
-		Level    int    `json:"level"`           // Level column
-		Value    int    `json:"value"`           // Points/SkillLevel column
-		Title    string `json:"title,omitempty"` // Title column (when category: loyalty)
-	}
-
-	// Child of JSONData
-	type Highscores struct {
-		World         string      `json:"world"`
-		Category      string      `json:"category"`
-		Vocation      string      `json:"vocation"`
-		HighscoreAge  int         `json:"highscore_age"`
-		HighscoreList []Highscore `json:"highscore_list"`
-	}
-
-	//
-	// The base includes two levels: Highscores and Information
-	type JSONData struct {
-		Highscores  Highscores  `json:"highscores"`
-		Information Information `json:"information"`
-	}
-
 	// Adding fix for First letter to be upper and rest lower
 	if strings.EqualFold(world, "all") {
 		world = ""
@@ -125,6 +124,13 @@ func TibiaHighscoresV3(c *gin.Context) {
 		return
 	}
 
+	jsonData := TibiaHighscoresV3Impl(world, category, vocationName, BoxContentHTML)
+
+	// return jsonData
+	TibiaDataAPIHandleSuccessResponse(c, "TibiaHighscoresV3", jsonData)
+}
+
+func TibiaHighscoresV3Impl(world string, category string, vocationName string, BoxContentHTML string) HighscoresResponse {
 	// Loading HTML data into ReaderHTML for goquery with NewReader
 	ReaderHTML, err := goquery.NewDocumentFromReader(strings.NewReader(BoxContentHTML))
 	if err != nil {
@@ -226,7 +232,7 @@ func TibiaHighscoresV3(c *gin.Context) {
 
 	//
 	// Build the data-blob
-	jsonData := JSONData{
+	return HighscoresResponse{
 		Highscores{
 			World:         strings.Title(strings.ToLower(world)),
 			Category:      category,
@@ -239,7 +245,4 @@ func TibiaHighscoresV3(c *gin.Context) {
 			Timestamp:  TibiadataDatetimeV3(""),
 		},
 	}
-
-	// return jsonData
-	TibiaDataAPIHandleSuccessResponse(c, "TibiaHighscoresV3", jsonData)
 }

src/TibiaHighscoresV3_test.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"io/ioutil"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHighscoresAll(t *testing.T) {
+	data, err := ioutil.ReadFile("../testdata/highscores/all.html")
+	if err != nil {
+		t.Errorf("File reading error: %s", err)
+		return
+	}
+
+	highscoresJson := TibiaHighscoresV3Impl("", "experience", "all", string(data))
+	assert := assert.New(t)
+
+	assert.Equal("", highscoresJson.Highscores.World)
+	assert.Equal("experience", highscoresJson.Highscores.Category)
+	assert.Equal("all", highscoresJson.Highscores.Vocation)
+	assert.Equal(30, highscoresJson.Highscores.HighscoreAge)
+
+	assert.Equal(50, len(highscoresJson.Highscores.HighscoreList))
+
+	firstHighscore := highscoresJson.Highscores.HighscoreList[0]
+	assert.Equal(1, firstHighscore.Rank)
+	assert.Equal("Bobeek", firstHighscore.Name)
+	assert.Equal("Elder Druid", firstHighscore.Vocation)
+	assert.Equal("Bona", firstHighscore.World)
+	assert.Equal(2015, firstHighscore.Level)
+	assert.Equal(136026206904, firstHighscore.Value)
+	assert.Equal("", firstHighscore.Title)
+
+	lastHighscore := highscoresJson.Highscores.HighscoreList[49]
+	assert.Equal(50, lastHighscore.Rank)
+	assert.Equal("Kewhyx Mythus", lastHighscore.Name)
+	assert.Equal("Royal Paladin", lastHighscore.Vocation)
+	assert.Equal("Celebra", lastHighscore.World)
+	assert.Equal(1575, lastHighscore.Level)
+	assert.Equal(64869293274, lastHighscore.Value)
+	assert.Equal("", lastHighscore.Title)
+}