Skip to content

Commit 635641c

Browse files
kamilonKennedy Bushnelltobiasehlert
authored
Adding World unit tests (#54)
* World unit tests * Rename structs so they don't clash * Resolve PR comments * using true/false assert instead * weird formatting thing on months * adding some more worldsoverview test Co-authored-by: Kennedy Bushnell <kennedyb@microsoft.com> Co-authored-by: Tobias Lindberg <tobias.ehlert@gmail.com>
1 parent 015db2d commit 635641c

File tree

7 files changed

+936
-72
lines changed

7 files changed

+936
-72
lines changed

‎src/TibiaDataUtils.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ func TibiadataDateV3(date string) string {
112112
tmpDate, _ = time.Parse("Jan 02 2006", date)
113113
case dateLength > 11:
114114
// dates that contain month fully written
115-
tmpDate, _ = time.Parse("January 02 2006", date)
115+
tmpDate, _ = time.Parse("January 2 2006", date)
116116
default:
117117
log.Printf("Weird format detected: %s", date)
118118
}

‎src/TibiaWorldsOverviewV3.go‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import (
1111
)
1212

1313
// Child of Worlds
14-
type World struct {
14+
type OverviewWorld struct {
1515
Name string `json:"name"`
1616
Status string `json:"status"` // Online:
1717
PlayersOnline int `json:"players_online"` // Online:
@@ -26,19 +26,19 @@ type World struct {
2626
}
2727

2828
// Child of JSONData
29-
type Worlds struct {
30-
PlayersOnline int `json:"players_online"` // Calculated value
31-
RecordPlayers int `json:"record_players"` // Overall Maximum:
32-
RecordDate string `json:"record_date"` // Overall Maximum:
33-
RegularWorlds []World `json:"regular_worlds"`
34-
TournamentWorlds []World `json:"tournament_worlds"`
29+
type OverviewWorlds struct {
30+
PlayersOnline int `json:"players_online"` // Calculated value
31+
RecordPlayers int `json:"record_players"` // Overall Maximum:
32+
RecordDate string `json:"record_date"` // Overall Maximum:
33+
RegularWorlds []OverviewWorld `json:"regular_worlds"`
34+
TournamentWorlds []OverviewWorld `json:"tournament_worlds"`
3535
}
3636

3737
//
3838
// The base includes two levels: Worlds and Information
3939
type WorldsOverviewResponse struct {
40-
Worlds Worlds `json:"worlds"`
41-
Information Information `json:"information"`
40+
Worlds OverviewWorlds `json:"worlds"`
41+
Information Information `json:"information"`
4242
}
4343

4444
var (
@@ -73,7 +73,7 @@ func TibiaWorldsOverviewV3Impl(BoxContentHTML string) WorldsOverviewResponse {
7373

7474
// Creating empty vars
7575
var (
76-
RegularWorldsData, TournamentWorldsData []World
76+
RegularWorldsData, TournamentWorldsData []OverviewWorld
7777
WorldsRecordDate, WorldsWorldCategory, WorldsBattleyeDate, WorldsTransferType, WorldsTournamentWorldType, WorldsGameWorldType, WorldsStatus string
7878
WorldsRecordPlayers, WorldsAllOnlinePlayers int
7979
WorldsPremiumOnly, WorldsBattleyeProtected bool
@@ -179,7 +179,7 @@ func TibiaWorldsOverviewV3Impl(BoxContentHTML string) WorldsOverviewResponse {
179179
}
180180

181181
// Creating data block to return
182-
OneWorld := World{
182+
OneWorld := OverviewWorld{
183183
Name: subma2[0][1],
184184
Status: WorldsStatus,
185185
PlayersOnline: WorldsPlayersOnline,
@@ -206,7 +206,7 @@ func TibiaWorldsOverviewV3Impl(BoxContentHTML string) WorldsOverviewResponse {
206206
//
207207
// Build the data-blob
208208
return WorldsOverviewResponse{
209-
Worlds{
209+
OverviewWorlds{
210210
PlayersOnline: WorldsAllOnlinePlayers,
211211
RecordPlayers: WorldsRecordPlayers,
212212
RecordDate: WorldsRecordDate,

‎src/TibiaWorldsOverviewV3_test.go‎

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func TestWorlds(t *testing.T) {
1717
worldsJson := TibiaWorldsOverviewV3Impl(string(data))
1818
assert := assert.New(t)
1919

20-
assert.Equal(8756, worldsJson.Worlds.PlayersOnline)
20+
assert.Equal(8720, worldsJson.Worlds.PlayersOnline)
2121
assert.Equal(64028, worldsJson.Worlds.RecordPlayers)
2222
assert.Equal("2007-11-28T18:26:00Z", worldsJson.Worlds.RecordDate)
2323
assert.Equal(76, len(worldsJson.Worlds.RegularWorlds))
@@ -29,35 +29,61 @@ func TestWorlds(t *testing.T) {
2929
assert.Equal(18, adra.PlayersOnline)
3030
assert.Equal("Europe", adra.Location)
3131
assert.Equal("Open PvP", adra.PvpType)
32-
assert.Equal(false, adra.PremiumOnly)
32+
assert.False(adra.PremiumOnly)
3333
assert.Equal("blocked", adra.TransferType)
34-
assert.Equal(true, adra.BattleyeProtected)
34+
assert.True(adra.BattleyeProtected)
3535
assert.Equal("release", adra.BattleyeDate)
3636
assert.Equal("regular", adra.GameWorldType)
37-
assert.Equal("", adra.TournamentWorldType)
37+
assert.Empty(adra.TournamentWorldType)
3838

3939
astera := worldsJson.Worlds.RegularWorlds[4]
4040
assert.Equal("Astera", astera.Name)
4141
assert.Equal("online", astera.Status)
4242
assert.Equal(222, astera.PlayersOnline)
4343
assert.Equal("North America", astera.Location)
4444
assert.Equal("Optional PvP", astera.PvpType)
45-
assert.Equal(false, astera.PremiumOnly)
45+
assert.False(astera.PremiumOnly)
4646
assert.Equal("regular", astera.TransferType)
47-
assert.Equal(true, astera.BattleyeProtected)
47+
assert.True(astera.BattleyeProtected)
4848
assert.Equal("2017-09-12", astera.BattleyeDate)
4949
assert.Equal("regular", astera.GameWorldType)
50-
assert.Equal("", astera.TournamentWorldType)
50+
assert.Empty(astera.TournamentWorldType)
51+
52+
premia := worldsJson.Worlds.RegularWorlds[50]
53+
assert.Equal("Premia", premia.Name)
54+
assert.Equal("offline", premia.Status)
55+
assert.Equal(0, premia.PlayersOnline)
56+
assert.Equal("Europe", premia.Location)
57+
assert.Equal("Open PvP", premia.PvpType)
58+
assert.True(premia.PremiumOnly)
59+
assert.Equal("regular", premia.TransferType)
60+
assert.True(premia.BattleyeProtected)
61+
assert.Equal("2017-09-05", premia.BattleyeDate)
62+
assert.Equal("regular", premia.GameWorldType)
63+
assert.Empty(premia.TournamentWorldType)
64+
65+
zuna := worldsJson.Worlds.RegularWorlds[74]
66+
assert.Equal("Zuna", zuna.Name)
67+
assert.Equal("online", zuna.Status)
68+
assert.Equal(5, zuna.PlayersOnline)
69+
assert.Equal("Europe", zuna.Location)
70+
assert.Equal("Hardcore PvP", zuna.PvpType)
71+
assert.False(zuna.PremiumOnly)
72+
assert.Equal("locked", zuna.TransferType)
73+
assert.False(zuna.BattleyeProtected)
74+
assert.Empty("", zuna.BattleyeDate)
75+
assert.Equal("experimental", zuna.GameWorldType)
76+
assert.Empty(zuna.TournamentWorldType)
5177

5278
endera := worldsJson.Worlds.TournamentWorlds[1]
5379
assert.Equal("Endera", endera.Name)
5480
assert.Equal("unknown", endera.Status)
5581
assert.Equal(0, endera.PlayersOnline)
5682
assert.Equal("North America", endera.Location)
5783
assert.Equal("Optional PvP", endera.PvpType)
58-
assert.Equal(true, endera.PremiumOnly)
84+
assert.True(endera.PremiumOnly)
5985
assert.Equal("blocked", endera.TransferType)
60-
assert.Equal(true, endera.BattleyeProtected)
86+
assert.True(endera.BattleyeProtected)
6187
assert.Equal("release", endera.BattleyeDate)
6288
assert.Equal("tournament", endera.GameWorldType)
6389
assert.Equal("restricted", endera.TournamentWorldType)

‎src/TibiaWorldsWorldV3.go‎

Lines changed: 54 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -10,58 +10,56 @@ import (
1010
"github.com/gin-gonic/gin"
1111
)
1212

13+
// Child of World
14+
type OnlinePlayers struct {
15+
Name string `json:"name"`
16+
Level int `json:"level"`
17+
Vocation string `json:"vocation"`
18+
}
19+
20+
// Child of Worlds
21+
type World struct {
22+
Name string `json:"name"`
23+
Status string `json:"status"` // Status:
24+
PlayersOnline int `json:"players_online"` // Players Online:
25+
RecordPlayers int `json:"record_players"` // Online Record:
26+
RecordDate string `json:"record_date"` // Online Record:
27+
CreationDate string `json:"creation_date"` // Creation Date: -> convert to YYYY-MM
28+
Location string `json:"location"` // Location:
29+
PvpType string `json:"pvp_type"` // PvP Type:
30+
PremiumOnly bool `json:"premium_only"` // Premium Type: premium = true / else: false
31+
TransferType string `json:"transfer_type"` // Transfer Type: regular (if not present) / locked / blocked
32+
WorldsQuestTitles []string `json:"world_quest_titles"` // World Quest Titles:
33+
BattleyeProtected bool `json:"battleye_protected"` // BattlEye Status: true if protected / false if "Not protected by BattlEye."
34+
BattleyeDate string `json:"battleye_date"` // BattlEye Status: null if since release / else show date?
35+
GameWorldType string `json:"game_world_type"` // Game World Type: regular / experimental / tournament (if Tournament World Type exists)
36+
TournamentWorldType string `json:"tournament_world_type"` // Tournament World Type: "" (default?) / regular / restricted
37+
OnlinePlayers []OnlinePlayers `json:"online_players"`
38+
}
39+
40+
// Child of JSONData
41+
type Worlds struct {
42+
World World `json:"world"`
43+
}
44+
45+
//
46+
// The base includes two levels: World and Information
47+
type WorldResponse struct {
48+
Worlds Worlds `json:"worlds"`
49+
Information Information `json:"information"`
50+
}
51+
1352
var (
1453
WorldDataRowRegex = regexp.MustCompile(`<td class=.*>(.*):<\/td><td>(.*)<\/td>`)
1554
WorldRecordInformationRegex = regexp.MustCompile(`(.*) players \(on (.*)\)`)
1655
BattlEyeProtectedSinceRegex = regexp.MustCompile(`Protected by BattlEye since (.*)\.`)
1756
OnlinePlayerRegex = regexp.MustCompile(`<td style=.*name=.*">(.*)<\/a>.*">(.*)<\/td>.*">(.*)<\/td>`)
1857
)
1958

20-
// TibiaWorldsWorldV3 func
2159
func TibiaWorldsWorldV3(c *gin.Context) {
22-
2360
// getting params from URL
2461
world := c.Param("world")
2562

26-
// Child of World
27-
type OnlinePlayers struct {
28-
Name string `json:"name"`
29-
Level int `json:"level"`
30-
Vocation string `json:"vocation"`
31-
}
32-
33-
// Child of Worlds
34-
type World struct {
35-
Name string `json:"name"`
36-
Status string `json:"status"` // Status:
37-
PlayersOnline int `json:"players_online"` // Players Online:
38-
RecordPlayers int `json:"record_players"` // Online Record:
39-
RecordDate string `json:"record_date"` // Online Record:
40-
CreationDate string `json:"creation_date"` // Creation Date: -> convert to YYYY-MM
41-
Location string `json:"location"` // Location:
42-
PvpType string `json:"pvp_type"` // PvP Type:
43-
PremiumOnly bool `json:"premium_only"` // Premium Type: premium = true / else: false
44-
TransferType string `json:"transfer_type"` // Transfer Type: regular (if not present) / locked / blocked
45-
WorldsQuestTitles []string `json:"world_quest_titles"` // World Quest Titles:
46-
BattleyeProtected bool `json:"battleye_protected"` // BattlEye Status: true if protected / false if "Not protected by BattlEye."
47-
BattleyeDate string `json:"battleye_date"` // BattlEye Status: null if since release / else show date?
48-
GameWorldType string `json:"game_world_type"` // Game World Type: regular / experimental / tournament (if Tournament World Type exists)
49-
TournamentWorldType string `json:"tournament_world_type"` // Tournament World Type: "" (default?) / regular / restricted
50-
OnlinePlayers []OnlinePlayers `json:"online_players"`
51-
}
52-
53-
// Child of JSONData
54-
type Worlds struct {
55-
World World `json:"world"`
56-
}
57-
58-
//
59-
// The base includes two levels: World and Information
60-
type JSONData struct {
61-
Worlds Worlds `json:"worlds"`
62-
Information Information `json:"information"`
63-
}
64-
6563
// Adding fix for First letter to be upper and rest lower
6664
world = TibiadataStringWorldFormatToTitleV3(world)
6765

@@ -75,6 +73,16 @@ func TibiaWorldsWorldV3(c *gin.Context) {
7573
return
7674
}
7775

76+
worldJson := TibiaWorldsWorldV3Impl(world, BoxContentHTML)
77+
78+
// return jsonData
79+
TibiaDataAPIHandleSuccessResponse(c, "TibiaWorldsWorldV3", worldJson)
80+
}
81+
82+
// TibiaWorldsWorldV3 func
83+
func TibiaWorldsWorldV3Impl(world string, BoxContentHTML string) WorldResponse {
84+
//TODO: We need to read the world name from the response rather than pass it into this func
85+
7886
// Loading HTML data into ReaderHTML for goquery with NewReader
7987
ReaderHTML, err := goquery.NewDocumentFromReader(strings.NewReader(BoxContentHTML))
8088
if err != nil {
@@ -131,7 +139,7 @@ func TibiaWorldsWorldV3(c *gin.Context) {
131139
}
132140
}
133141
if WorldsInformationLeftColumn == "Creation Date" {
134-
WorldsCreationDate = WorldsInformationRightColumn
142+
WorldsCreationDate = TibiadataDateV3(WorldsInformationRightColumn)
135143
}
136144
if WorldsInformationLeftColumn == "Location" {
137145
WorldsLocation = WorldsInformationRightColumn
@@ -165,7 +173,7 @@ func TibiaWorldsWorldV3(c *gin.Context) {
165173
WorldsBattleyeDate = "release"
166174
} else {
167175
subma21 := BattlEyeProtectedSinceRegex.FindAllStringSubmatch(WorldsInformationRightColumn, -1)
168-
WorldsBattleyeDate = subma21[0][1]
176+
WorldsBattleyeDate = TibiadataDateV3(subma21[0][1])
169177
}
170178
}
171179
}
@@ -198,16 +206,16 @@ func TibiaWorldsWorldV3(c *gin.Context) {
198206
if len(subma1) > 0 {
199207

200208
WorldsOnlinePlayers = append(WorldsOnlinePlayers, OnlinePlayers{
201-
Name: subma1[0][1],
209+
Name: TibiaDataSanitizeNbspSpaceString(subma1[0][1]),
202210
Level: TibiadataStringToIntegerV3(subma1[0][2]),
203-
Vocation: subma1[0][3],
211+
Vocation: TibiaDataSanitizeNbspSpaceString(subma1[0][3]),
204212
})
205213
}
206214
})
207215

208216
//
209217
// Build the data-blob
210-
jsonData := JSONData{
218+
return WorldResponse{
211219
Worlds: Worlds{
212220
World{
213221
Name: world,
@@ -233,7 +241,4 @@ func TibiaWorldsWorldV3(c *gin.Context) {
233241
Timestamp: TibiadataDatetimeV3(""),
234242
},
235243
}
236-
237-
// return jsonData
238-
TibiaDataAPIHandleSuccessResponse(c, "TibiaWorldsWorldV3", jsonData)
239244
}

‎src/TibiaWorldsWorldV3_test.go‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
package main
2+
3+
import (
4+
"io/ioutil"
5+
"testing"
6+
7+
"github.com/stretchr/testify/assert"
8+
)
9+
10+
func TestWintera(t *testing.T) {
11+
data, err := ioutil.ReadFile("../testdata/worlds/world/Wintera.html")
12+
if err != nil {
13+
t.Errorf("File reading error: %s", err)
14+
return
15+
}
16+
17+
worldJson := TibiaWorldsWorldV3Impl("Wintera", string(data))
18+
assert := assert.New(t)
19+
20+
world := worldJson.Worlds.World
21+
22+
assert.Equal("Wintera", world.Name)
23+
assert.Equal("online", world.Status)
24+
assert.Equal(281, world.PlayersOnline)
25+
assert.Equal(1023, world.RecordPlayers)
26+
assert.Equal("2020-05-04T01:25:30Z", world.RecordDate)
27+
assert.Equal("2018-04", world.CreationDate)
28+
assert.Equal("North America", world.Location)
29+
assert.Equal("Open PvP", world.PvpType)
30+
assert.False(world.PremiumOnly)
31+
assert.Empty(world.TransferType)
32+
assert.Equal(4, len(world.WorldsQuestTitles))
33+
assert.Equal("A Piece of Cake", world.WorldsQuestTitles[0])
34+
assert.Equal("Rise of Devovorga", world.WorldsQuestTitles[1])
35+
assert.Equal("Bewitched", world.WorldsQuestTitles[2])
36+
assert.Equal("The Colours of Magic", world.WorldsQuestTitles[3])
37+
assert.True(world.BattleyeProtected)
38+
assert.Equal("2018-04-19", world.BattleyeDate)
39+
assert.Equal("regular", world.GameWorldType)
40+
assert.Empty(world.TournamentWorldType)
41+
assert.Equal(281, len(world.OnlinePlayers))
42+
43+
firstPlayer := world.OnlinePlayers[0]
44+
assert.Equal("Akiles Boy", firstPlayer.Name)
45+
assert.Equal(281, firstPlayer.Level)
46+
assert.Equal("Royal Paladin", firstPlayer.Vocation)
47+
}

0 commit comments

Comments
 (0)