Added tests for Plus/Core, fixed ptr bug which resulted in bool fields being filled out incorrectly

Author: phillip-stephens

ipinfo.go

@@ -50,6 +50,7 @@ type IPInfoMMDBOutput struct {
 	Longitude         string `maxminddb:"longitude"`
 	Timezone          string `maxminddb:"timezone"`
 	PostalCode        string `maxminddb:"postal_code"`
+	DMACode           string `maxminddb:"dma_code"`
 	GeonameID         string `maxminddb:"geoname_id"`  // GeoNames database identifier (if available).
 	Radius            string `maxminddb:"radius"`      // Accuracy radius in kilometers (if available).
 	GeoChanged        string `maxminddb:"geo_changed"` // Timestamp or flag indicating when the geolocation last changed (if available).
@@ -86,6 +87,7 @@ type IPInfoModuleOutput struct {
 	Longitude         float64 `json:"longitude,omitempty"`
 	Timezone          string  `json:"timezone,omitempty"`
 	PostalCode        string  `json:"postal_code,omitempty"`
+	DMACode           string  `json:"dma_code,omitempty"`    // Nielsen Designated Market Area code (if available).
 	GeonameID         uint64  `json:"geoname_id,omitempty"`  // GeoNames database identifier (if available).
 	Radius            uint64  `json:"radius,omitempty"`      // Accuracy radius in kilometers (if available).
 	GeoChanged        string  `json:"geo_changed,omitempty"` // Timestamp or flag indicating when the geolocation last changed (if available).
@@ -147,31 +149,40 @@ func (in *IPInfoMMDBOutput) ToModuleOutput() *IPInfoModuleOutput {
 	}
 	var temp bool
 	if temp, err = strconv.ParseBool(in.IsProxy); err == nil {
-		out.IsProxy = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsProxy = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsRelay); err == nil {
-		out.IsRelay = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsRelay = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsTOR); err == nil {
-		out.IsTOR = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsTOR = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsVPN); err == nil {
-		out.IsVPN = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsVPN = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsAnonymous); err == nil {
-		out.IsAnonymous = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsAnonymous = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsAnycast); err == nil {
-		out.IsAnycast = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsAnycast = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsHosting); err == nil {
-		out.IsHosting = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsHosting = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsMobile); err == nil {
-		out.IsMobile = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsMobile = &t
 	}
 	if temp, err = strconv.ParseBool(in.IsSatellite); err == nil {
-		out.IsSatellite = &temp
+		t := temp // avoid taking address of a short-lived variable
+		out.IsSatellite = &t
 	}
 	return out
 }

ipinfo_test.go

@@ -22,16 +22,16 @@ import (
 
 // TestIPInfoAnnotator tests the IPInfoAnnotator with known IP addresses against a constant MMDB file in ./data-snapshots
 // Unfortunately, I only have a free account for IPInfo, so can only test parsing for the Lite api with a real DB file.
-func TestIPInfoAnnotator(t *testing.T) {
+func TestIPInfoAnnotatorLite(t *testing.T) {
 	tests := []struct {
 		testName       string
 		ipAddr         net.IP
-		expectedResult *IPInfoOutput
+		expectedResult *IPInfoModuleOutput
 	}{
 		{
 			testName: "Positive Test Case, IPv4",
 			ipAddr:   net.ParseIP("1.1.1.1"),
-			expectedResult: &IPInfoOutput{
+			expectedResult: &IPInfoModuleOutput{
 				ASN:           "AS13335",
 				ASName:        "Cloudflare, Inc.",
 				ASDomain:      "cloudflare.com",
@@ -43,7 +43,7 @@ func TestIPInfoAnnotator(t *testing.T) {
 		}, {
 			testName: "Positive Test Case, IPv6",
 			ipAddr:   net.ParseIP("2606:4700:4700::1111"),
-			expectedResult: &IPInfoOutput{
+			expectedResult: &IPInfoModuleOutput{
 				ASN:           "AS13335",
 				ASName:        "Cloudflare, Inc.",
 				ASDomain:      "cloudflare.com",
@@ -86,3 +86,101 @@ func TestIPInfoAnnotator(t *testing.T) {
 		})
 	}
 }
+
+func TestIPInfoAnnotatorCore(t *testing.T) {
+	expectedResult := &IPInfoModuleOutput{
+		City:          "Brisbane",
+		Region:        "Queensland",
+		RegionCode:    "QLD",
+		Country:       "Australia",
+		CountryCode:   "AU",
+		Continent:     "Oceania",
+		ContinentCode: "OC",
+		Latitude:      -27.48159,
+		Longitude:     153.0175,
+		Timezone:      "Australia/Brisbane",
+		PostalCode:    "4101",
+		ASN:           "AS13335",
+		ASName:        "Cloudflare, Inc.",
+		ASDomain:      "cloudflare.com",
+		ASType:        "hosting",
+		IsAnonymous:   &[]bool{true}[0],
+		IsAnycast:     &[]bool{true}[0],
+		IsHosting:     &[]bool{true}[0],
+		IsMobile:      &[]bool{false}[0],
+		IsSatellite:   &[]bool{false}[0],
+	}
+	inputIP := net.ParseIP("1.0.0.1")
+	factory := &IPInfoAnnotatorFactory{
+		DatabaseFilePath: "./data-snapshots/ipinfo_core_sample.mmdb",
+	}
+	err := factory.Initialize(nil)
+	if err != nil {
+		t.Fatalf("Failed to initialize IPInfoAnnotatorFactory: %v", err)
+	}
+	annotator := factory.MakeAnnotator(0).(*IPInfoAnnotator)
+	err = annotator.Initialize()
+	if err != nil {
+		t.Fatalf("Failed to initialize IPInfoAnnotator: %v", err)
+	}
+	result := annotator.Annotate(inputIP)
+	if expectedResult == nil && result == nil {
+		return // pass
+	}
+	if !reflect.DeepEqual(result, expectedResult) {
+		t.Errorf("Annotating IP %s gave = \n%v\nexpected: \n%v", inputIP, result, expectedResult)
+	}
+}
+
+func TestIPInfoAnnotatorPlus(t *testing.T) {
+	expectedResult := &IPInfoModuleOutput{
+		City:          "Brisbane",
+		Region:        "Queensland",
+		RegionCode:    "QLD",
+		Country:       "Australia",
+		CountryCode:   "AU",
+		Continent:     "Oceania",
+		ContinentCode: "OC",
+		Latitude:      -27.48159,
+		Longitude:     153.0175,
+		Timezone:      "Australia/Brisbane",
+		PostalCode:    "4101",
+		GeonameID:     2174003,
+		Radius:        200,
+		ASN:           "AS13335",
+		ASName:        "Cloudflare, Inc.",
+		ASDomain:      "cloudflare.com",
+		ASType:        "hosting",
+		ASChanged:     "2025-09-28",
+		GeoChanged:    "2024-02-18",
+		IsAnonymous:   &[]bool{true}[0],
+		IsAnycast:     &[]bool{true}[0],
+		IsHosting:     &[]bool{true}[0],
+		IsMobile:      &[]bool{false}[0],
+		IsSatellite:   &[]bool{false}[0],
+		IsProxy:       &[]bool{false}[0],
+		IsRelay:       &[]bool{false}[0],
+		IsTOR:         &[]bool{false}[0],
+		IsVPN:         &[]bool{true}[0],
+	}
+	inputIP := net.ParseIP("1.0.0.1")
+	factory := &IPInfoAnnotatorFactory{
+		DatabaseFilePath: "./data-snapshots/ipinfo_plus_sample.mmdb",
+	}
+	err := factory.Initialize(nil)
+	if err != nil {
+		t.Fatalf("Failed to initialize IPInfoAnnotatorFactory: %v", err)
+	}
+	annotator := factory.MakeAnnotator(0).(*IPInfoAnnotator)
+	err = annotator.Initialize()
+	if err != nil {
+		t.Fatalf("Failed to initialize IPInfoAnnotator: %v", err)
+	}
+	result := annotator.Annotate(inputIP)
+	if expectedResult == nil && result == nil {
+		return // pass
+	}
+	if !reflect.DeepEqual(result, expectedResult) {
+		t.Errorf("Annotating IP %s gave = \n%v\nexpected: \n%v", inputIP, result, expectedResult)
+	}
+}