common: fix ZoomLevel constants + add more tests

Author: markus-wa

pkg/demoinfocs/common/common_test.go

@@ -188,7 +188,7 @@ func entityWithProperty(propName string, value st.PropertyValue) *stfake.Entity
 	prop.On("Value").Return(value)
 
 	entity.On("Property", propName).Return(prop)
-	entity.On("PropertyValue", propName).Return(prop, true)
+	entity.On("PropertyValue", propName).Return(value, true)
 	entity.On("PropertyValueMust", propName).Return(value)
 
 	return entity

pkg/demoinfocs/common/entity_util_test.go

@@ -0,0 +1,23 @@
+package common
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetFloat_Nil(t *testing.T) {
+	assert.Zero(t, getFloat(nil, "test"))
+}
+
+func TestGetInt_Nil(t *testing.T) {
+	assert.Zero(t, getInt(nil, "test"))
+}
+
+func TestGetString_Nil(t *testing.T) {
+	assert.Empty(t, getString(nil, "test"))
+}
+
+func TestGetBool_Nil(t *testing.T) {
+	assert.Empty(t, getBool(nil, "test"))
+}

pkg/demoinfocs/common/equipment.go

@@ -273,9 +273,9 @@ func MapEquipment(eqName string) EquipmentType {
 type ZoomLevel int
 
 const (
-	ZoomNone = 0
-	ZoomHalf = 1
-	ZoomFull = 2
+	ZoomNone ZoomLevel = 0
+	ZoomHalf ZoomLevel = 1
+	ZoomFull ZoomLevel = 2
 )
 
 // Equipment is a weapon / piece of equipment belonging to a player.
@@ -315,12 +315,17 @@ func (e Equipment) AmmoInMagazine() int {
 		return 1
 	}
 
+	if e.Entity == nil {
+		return 0
+	}
+
 	val, ok := e.Entity.PropertyValue("m_iClip1")
 	if !ok {
 		return -1
 	}
 
-	return val.IntVal
+	// need to subtract 1 as m_iClip1 is nrOfBullets + 1
+	return val.IntVal - 1
 }
 
 // AmmoType returns the weapon's ammo type, mostly (only?) relevant for grenades.
@@ -354,6 +359,10 @@ func (e Equipment) AmmoReserve() int {
 		return 0
 	}
 
+	if e.Entity == nil {
+		return 0
+	}
+
 	// if the property doesn't exist we return 0 by default
 	val, _ := e.Entity.PropertyValue("m_iPrimaryReserveAmmoCount")
 

pkg/demoinfocs/common/equipment_test.go

@@ -38,6 +38,29 @@ func TestEquipment_UniqueID(t *testing.T) {
 	assert.NotEqual(t, NewEquipment(EqAK47).UniqueID(), NewEquipment(EqAK47).UniqueID(), "UniqueIDs of different equipment instances should be different")
 }
 
+func TestEquipment_AmmoInMagazine(t *testing.T) {
+	wep := &Equipment{
+		Type:   EqAK47,
+		Entity: entityWithProperty("m_iClip1", st.PropertyValue{IntVal: 31}),
+	}
+
+	// returned value should be minus 1, m_iClip1 is always 1 more than the actual number of bullets
+	assert.Equal(t, 30, wep.AmmoInMagazine())
+}
+
+func TestEquipment_AmmoInMagazine_NotFound(t *testing.T) {
+	entity := entityWithID(1)
+	entity.On("PropertyValue", "m_iClip1").Return(st.PropertyValue{}, false)
+
+	wep := &Equipment{
+		Type:   EqAK47,
+		Entity: entity,
+	}
+
+	// returned value should be minus 1, m_iClip1 is always 1 more than the actual number of bullets
+	assert.Equal(t, -1, wep.AmmoInMagazine())
+}
+
 func TestEquipment_AmmoInMagazine_Grenade(t *testing.T) {
 	wep := &Equipment{
 		Type: EqFlash,
@@ -46,6 +69,24 @@ func TestEquipment_AmmoInMagazine_Grenade(t *testing.T) {
 	assert.Equal(t, 1, wep.AmmoInMagazine())
 }
 
+func TestEquipment_AmmoInMagazine_EntityNil(t *testing.T) {
+	wep := &Equipment{
+		Type: EqAK47,
+	}
+
+	assert.Equal(t, 0, wep.AmmoInMagazine())
+}
+
+func TestEquipment_AmmoReserve(t *testing.T) {
+	entity := entityWithProperty("m_iPrimaryReserveAmmoCount", st.PropertyValue{IntVal: 60})
+	wep := &Equipment{
+		Type:   EqAK47,
+		Entity: entity,
+	}
+
+	assert.Equal(t, 60, wep.AmmoReserve())
+}
+
 func TestEquipment_AmmoReserve_Grenade(t *testing.T) {
 	owner := new(Player)
 	owner.AmmoLeft[1] = 2
@@ -60,14 +101,39 @@ func TestEquipment_AmmoReserve_Grenade(t *testing.T) {
 	assert.Equal(t, 1, wep.AmmoReserve())
 }
 
-func TestEquipment_AmmoReserve2_Grenade_OwnerNil(t *testing.T) {
+func TestEquipment_AmmoReserve_Grenade_OwnerNil(t *testing.T) {
 	wep := &Equipment{
 		Type: EqFlash,
 	}
 
 	assert.Equal(t, 0, wep.AmmoReserve())
 }
 
+func TestEquipment_AmmoReserve_EntityNil(t *testing.T) {
+	wep := &Equipment{
+		Type: EqAK47,
+	}
+
+	assert.Equal(t, 0, wep.AmmoReserve())
+}
+
+func TestEquipment_ZoomLevel(t *testing.T) {
+	wep := &Equipment{
+		Type:   EqAK47,
+		Entity: entityWithProperty("m_zoomLevel", st.PropertyValue{IntVal: 2}),
+	}
+
+	assert.Equal(t, ZoomFull, wep.ZoomLevel())
+}
+
+func TestEquipment_ZoomLevel_EntityNil(t *testing.T) {
+	wep := &Equipment{
+		Type: EqAK47,
+	}
+
+	assert.Equal(t, ZoomLevel(0), wep.ZoomLevel())
+}
+
 func TestEquipmentAlternative(t *testing.T) {
 	assert.Equal(t, EqUSP, EquipmentAlternative(EqP2000))
 	assert.Equal(t, EqCZ, EquipmentAlternative(EqP250))