data_test.go

package localtimezone

import (
	"encoding/csv"
	"os"
	"strconv"
	"testing"
)

// city and lat/lon data is from Pareto Software LLC, SimpleMaps.com
// https://simplemaps.com/data/world-cities
type TimezoneTestCase struct {
	City         string
	Lat          float64
	Lon          float64
	ExpectedZone string
}

func generateTestCases() ([]TimezoneTestCase, error) {
	f, err := os.Open("test/testdata.csv")
	if err != nil {
		return nil, err
	}

	reader := csv.NewReader(f)
	rawData, err := reader.ReadAll()
	if err != nil {
		return nil, err
	}
	err = f.Close()
	if err != nil {
		return nil, err
	}

	var data []TimezoneTestCase
	for _, line := range rawData {
		lat, err := strconv.ParseFloat(line[1], 64)
		if err != nil {
			return nil, err
		}
		lon, err := strconv.ParseFloat(line[2], 64)
		if err != nil {
			return nil, err
		}
		tc := TimezoneTestCase{
			City:         line[0],
			Lat:          lat,
			Lon:          lon,
			ExpectedZone: line[3],
		}
		data = append(data, tc)
	}
	return data, nil
}

func TestData(t *testing.T) {
	t.Parallel()
	z, err := NewLocalTimeZone()
	if err != nil {
		t.Errorf("cannot initialize timezone client: %v", err)
	}
	data, err := generateTestCases()
	if err != nil {
		t.Errorf("cannot get test data: %v", err)
	}
	for _, tc := range data {
		tc := tc // Remove race condition over test fields
		t.Run(tc.City, func(t *testing.T) {
			t.Parallel()
			point := Point{
				Lon: tc.Lon,
				Lat: tc.Lat,
			}
			tzids, err := z.GetZone(point)
			if err != nil {
				t.Errorf("unexpected err %v", err)
			}
			if len(tzids) < 1 {
				t.Error("cannot find a timezone")
			}
			if tc.ExpectedZone != tzids[0] {
				t.Errorf("expected zone %s; got %s", tc.ExpectedZone, tzids[0])
			}
			tzid, err := z.GetOneZone(point)
			if err != nil {
				t.Errorf("unexpected err %v", err)
			}
			if tc.ExpectedZone != tzid {
				t.Errorf("expected zone %s; got %s", tc.ExpectedZone, tzid)
			}
		})
	}
}

func TestTzidPresent(t *testing.T) {
	client, err := NewLocalTimeZone()
	if err != nil {
		t.Errorf("cannot initialize timezone client: %v", err)
	}
	z, ok := client.(*localTimeZone)
	if !ok {
		t.Error("error when initializing client")
	}
	z.mu.RLock()
	defer z.mu.RUnlock()
	_, ok = z.tzData["id"]
	if ok {
		t.Error("unexpected feature with empty tzid")
	}
}

func TestPolygons(t *testing.T) {
	client, err := NewLocalTimeZone()
	if err != nil {
		t.Errorf("cannot initialize timezone client: %v", err)
	}
	z, ok := client.(*localTimeZone)
	if !ok {
		t.Error("error when initializing client")
	}
	z.mu.RLock()
	defer z.mu.RUnlock()
	for tzid, d := range z.tzData {
		if d.polygon != nil {
			for _, ring := range *d.polygon {
				if len(ring) < 4 {
					t.Errorf("expected polygon %s ring to have >= 4 coordinates, instead has %d", tzid, len(ring))
				}
			}
		}
	}
}

func BenchmarkGetZone(b *testing.B) {
	client, err := NewLocalTimeZone()
	if err != nil {
		b.Errorf("cannot initialize timezone client: %v", err)
	}
	data, err := generateTestCases()
	if err != nil {
		b.Errorf("cannot initialize test cases: %v", err)
	}

	// Ensure client has finished loading data
	_, err = client.GetZone(Point{0, 0})
	if err != nil {
		b.Errorf("cannot initialize timezone client: %v", err)
	}

	b.Run("GetZone on large cities", func(b *testing.B) {
		n := 0
		for b.Loop() {
			tc := data[n%len(data)]
			point := Point{
				Lon: tc.Lon,
				Lat: tc.Lat,
			}
			_, err = client.GetZone(point)
			if err != nil {
				b.Errorf("point %v did not return a zone", point)
			}
			n += 1
		}
	})
	b.Run("GetOneZone on large cities", func(b *testing.B) {
		n := 0
		for b.Loop() {
			tc := data[n%len(data)]
			point := Point{
				Lon: tc.Lon,
				Lat: tc.Lat,
			}
			_, err = client.GetOneZone(point)
			if err != nil {
				b.Errorf("point %v did not return a zone", point)
			}
			n++
		}
	})
}