miniflux_v2/internal/timezone/timezone_test.go

// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package timezone // import "miniflux.app/v2/internal/timezone"

import (
	"slices"
	"testing"
	"time"

	// Make sure these tests pass when the timezone database is not installed on the host system.
	_ "time/tzdata"
)

func TestNow(t *testing.T) {
	tz := "Europe/Paris"
	now := Now(tz)

	if now.Location().String() != tz {
		t.Fatalf(`Unexpected timezone, got %q instead of %q`, now.Location(), tz)
	}
}

func TestNowWithInvalidTimezone(t *testing.T) {
	tz := "Invalid Timezone"
	expected := time.Local
	now := Now(tz)

	if now.Location().String() != expected.String() {
		t.Fatalf(`Unexpected timezone, got %q instead of %q`, now.Location(), expected)
	}
}

func TestConvertTimeWithNoTimezoneInformation(t *testing.T) {
	tz := "Canada/Pacific"
	input := time.Date(2018, 3, 1, 14, 2, 3, 0, time.FixedZone("", 0))
	output := Convert(tz, input)

	if output.Location().String() != tz {
		t.Fatalf(`Unexpected timezone, got %q instead of %s`, output.Location(), tz)
	}

	hours, minutes, secs := output.Clock()
	if hours != 14 || minutes != 2 || secs != 3 {
		t.Fatalf(`Unexpected time, got hours=%d, minutes=%d, secs=%d`, hours, minutes, secs)
	}
}

func TestConvertTimeWithDifferentTimezone(t *testing.T) {
	tz := "Canada/Central"
	input := time.Date(2018, 3, 1, 14, 2, 3, 0, time.UTC)
	output := Convert(tz, input)

	if output.Location().String() != tz {
		t.Fatalf(`Unexpected timezone, got %q instead of %s`, output.Location(), tz)
	}

	hours, minutes, secs := output.Clock()
	if hours != 8 || minutes != 2 || secs != 3 {
		t.Fatalf(`Unexpected time, got hours=%d, minutes=%d, secs=%d`, hours, minutes, secs)
	}
}

func TestConvertTimeWithIdenticalTimezone(t *testing.T) {
	tz := "Canada/Central"
	loc, _ := time.LoadLocation(tz)
	input := time.Date(2018, 3, 1, 14, 2, 3, 0, loc)
	output := Convert(tz, input)

	if output.Location().String() != tz {
		t.Fatalf(`Unexpected timezone, got %q instead of %s`, output.Location(), tz)
	}

	hours, minutes, secs := output.Clock()
	if hours != 14 || minutes != 2 || secs != 3 {
		t.Fatalf(`Unexpected time, got hours=%d, minutes=%d, secs=%d`, hours, minutes, secs)
	}
}

func TestConvertTimeWithEquivalentTimezone(t *testing.T) {
	tz := "UTC"
	// FixedZone creates a distinct pointer that has the same name as the cached location.
	// The old pointer comparison would treat these as different, calling t.In() unnecessarily.
	loc := time.FixedZone("UTC", 0)
	input := time.Date(2024, 6, 15, 12, 0, 0, 0, loc)
	output := Convert(tz, input)

	if output.Location() != loc {
		t.Fatal("Convert replaced the location even though timezone names match")
	}
}

func TestConvertPostgresDateTimeWithNegativeTimezoneOffset(t *testing.T) {
	tz := "US/Eastern"
	input := time.Date(0, 1, 1, 0, 0, 0, 0, time.FixedZone("", -5))
	output := Convert(tz, input)

	if output.Location().String() != tz {
		t.Fatalf(`Unexpected timezone, got %q instead of %s`, output.Location(), tz)
	}

	if year := output.Year(); year != 0 {
		t.Fatalf(`Unexpected year, got %d instead of 0`, year)
	}
}

func TestIsValid(t *testing.T) {
	validTZ := []string{
		"Antarctica/Davis",
		"GMT",
		"UTC",
	}

	for _, tz := range validTZ {
		if !IsValid(tz) {
			t.Fatalf(`Timezone %q should be valid and it's not`, tz)
		}
	}

	invalidTZ := []string{
		"MAP",
		"Europe/Fronce",
	}

	for _, tz := range invalidTZ {
		if IsValid(tz) {
			t.Fatalf(`Timezone %q should be invalid and it's not`, tz)
		}
	}
}

func TestAvailableTimezones(t *testing.T) {
	var got []string

	for tz := range AvailableTimezones() {
		got = append(got, tz)
	}

	if !slices.Equal(got, timezones) {
		t.Fatalf("available timezones differ from source slice: expected %d entries, got %d", len(timezones), len(got))
	}
}