gitea/modules/timeutil/since_test.go

// Copyright 2019 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package timeutil

import (
	"context"
	"fmt"
	"os"
	"testing"
	"time"

	"code.gitea.io/gitea/modules/setting"
	"code.gitea.io/gitea/modules/translation"

	"github.com/stretchr/testify/assert"
)

var BaseDate time.Time

// time durations
const (
	DayDur   = 24 * time.Hour
	WeekDur  = 7 * DayDur
	MonthDur = 30 * DayDur
	YearDur  = 12 * MonthDur
)

func TestMain(m *testing.M) {
	setting.StaticRootPath = "../../"
	setting.Names = []string{"english"}
	setting.Langs = []string{"en-US"}
	// setup
	translation.InitLocales(context.Background())
	BaseDate = time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC)

	// run the tests
	retVal := m.Run()

	os.Exit(retVal)
}

func TestTimeSince(t *testing.T) {
	assert.Equal(t, "now", timeSince(BaseDate, BaseDate, translation.NewLocale("en-US")))

	// test that each diff in `diffs` yields the expected string
	test := func(expected string, diffs ...time.Duration) {
		t.Run(expected, func(t *testing.T) {
			for _, diff := range diffs {
				actual := timeSince(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
				assert.Equal(t, translation.NewLocale("en-US").Tr("tool.ago", expected), actual)
				actual = timeSince(BaseDate.Add(diff), BaseDate, translation.NewLocale("en-US"))
				assert.Equal(t, translation.NewLocale("en-US").Tr("tool.from_now", expected), actual)
			}
		})
	}
	test("1 second", time.Second, time.Second+50*time.Millisecond)
	test("2 seconds", 2*time.Second, 2*time.Second+50*time.Millisecond)
	test("1 minute", time.Minute, time.Minute+29*time.Second)
	test("2 minutes", 2*time.Minute, time.Minute+30*time.Second)
	test("2 minutes", 2*time.Minute, 2*time.Minute+29*time.Second)
	test("1 hour", time.Hour, time.Hour+29*time.Minute)
	test("2 hours", 2*time.Hour, time.Hour+30*time.Minute)
	test("2 hours", 2*time.Hour, 2*time.Hour+29*time.Minute)
	test("3 hours", 3*time.Hour, 2*time.Hour+30*time.Minute)
	test("1 day", DayDur, DayDur+11*time.Hour)
	test("2 days", 2*DayDur, DayDur+12*time.Hour)
	test("2 days", 2*DayDur, 2*DayDur+11*time.Hour)
	test("3 days", 3*DayDur, 2*DayDur+12*time.Hour)
	test("1 week", WeekDur, WeekDur+3*DayDur)
	test("2 weeks", 2*WeekDur, WeekDur+4*DayDur)
	test("2 weeks", 2*WeekDur, 2*WeekDur+3*DayDur)
	test("3 weeks", 3*WeekDur, 2*WeekDur+4*DayDur)
	test("1 month", MonthDur, MonthDur+14*DayDur)
	test("2 months", 2*MonthDur, MonthDur+15*DayDur)
	test("2 months", 2*MonthDur, 2*MonthDur+14*DayDur)
	test("1 year", YearDur, YearDur+5*MonthDur)
	test("2 years", 2*YearDur, YearDur+6*MonthDur)
	test("2 years", 2*YearDur, 2*YearDur+5*MonthDur)
	test("3 years", 3*YearDur, 2*YearDur+6*MonthDur)
}

func TestTimeSincePro(t *testing.T) {
	assert.Equal(t, "now", timeSincePro(BaseDate, BaseDate, translation.NewLocale("en-US")))

	// test that a difference of `diff` yields the expected string
	test := func(expected string, diff time.Duration) {
		actual := timeSincePro(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
		assert.Equal(t, expected, actual)
		assert.Equal(t, "future", timeSincePro(BaseDate.Add(diff), BaseDate, translation.NewLocale("en-US")))
	}
	test("1 second", time.Second)
	test("2 seconds", 2*time.Second)
	test("1 minute", time.Minute)
	test("1 minute, 1 second", time.Minute+time.Second)
	test("1 minute, 59 seconds", time.Minute+59*time.Second)
	test("2 minutes", 2*time.Minute)
	test("1 hour", time.Hour)
	test("1 hour, 1 second", time.Hour+time.Second)
	test("1 hour, 59 minutes, 59 seconds", time.Hour+59*time.Minute+59*time.Second)
	test("2 hours", 2*time.Hour)
	test("1 day", DayDur)
	test("1 day, 23 hours, 59 minutes, 59 seconds",
		DayDur+23*time.Hour+59*time.Minute+59*time.Second)
	test("2 days", 2*DayDur)
	test("1 week", WeekDur)
	test("2 weeks", 2*WeekDur)
	test("1 month", MonthDur)
	test("3 months", 3*MonthDur)
	test("1 year", YearDur)
	test("2 years, 3 months, 1 week, 2 days, 4 hours, 12 minutes, 17 seconds",
		2*YearDur+3*MonthDur+WeekDur+2*DayDur+4*time.Hour+
			12*time.Minute+17*time.Second)
}

func TestHtmlTimeSince(t *testing.T) {
	setting.TimeFormat = time.UnixDate
	setting.DefaultUILocation = time.UTC
	// test that `diff` yields a result containing `expected`
	test := func(expected string, diff time.Duration) {
		actual := htmlTimeSince(BaseDate, BaseDate.Add(diff), translation.NewLocale("en-US"))
		assert.Contains(t, actual, `data-tooltip-content="Sat Jan  1 00:00:00 UTC 2000"`)
		assert.Contains(t, actual, expected)
	}
	test("1 second", time.Second)
	test("3 minutes", 3*time.Minute+5*time.Second)
	test("1 day", DayDur+11*time.Hour)
	test("1 week", WeekDur+3*DayDur)
	test("3 months", 3*MonthDur+2*WeekDur)
	test("2 years", 2*YearDur)
	test("3 years", 2*YearDur+11*MonthDur+4*WeekDur)
}

func TestComputeTimeDiff(t *testing.T) {
	// test that for each offset in offsets,
	// computeTimeDiff(base + offset) == (offset, str)
	test := func(base int64, str string, offsets ...int64) {
		for _, offset := range offsets {
			t.Run(fmt.Sprintf("%s:%d", str, offset), func(t *testing.T) {
				diff, diffStr := computeTimeDiff(base+offset, translation.NewLocale("en-US"))
				assert.Equal(t, offset, diff)
				assert.Equal(t, str, diffStr)
			})
		}
	}
	test(0, "now", 0)
	test(1, "1 second", 0)
	test(2, "2 seconds", 0)
	test(Minute, "1 minute", 0, 1, 29)
	test(Minute, "2 minutes", 30, Minute-1)
	test(2*Minute, "2 minutes", 0, 29)
	test(2*Minute, "3 minutes", 30, Minute-1)
	test(Hour, "1 hour", 0, 1, 29*Minute)
	test(Hour, "2 hours", 30*Minute, Hour-1)
	test(5*Hour, "5 hours", 0, 29*Minute)
	test(Day, "1 day", 0, 1, 11*Hour)
	test(Day, "2 days", 12*Hour, Day-1)
	test(5*Day, "5 days", 0, 11*Hour)
	test(Week, "1 week", 0, 1, 3*Day)
	test(Week, "2 weeks", 4*Day, Week-1)
	test(3*Week, "3 weeks", 0, 3*Day)
	test(Month, "1 month", 0, 1)
	test(Month, "2 months", 16*Day, Month-1)
	test(10*Month, "10 months", 0, 13*Day)
	test(Year, "1 year", 0, 179*Day)
	test(Year, "2 years", 180*Day, Year-1)
	test(3*Year, "3 years", 0, 179*Day)
}

func TestMinutesToFriendly(t *testing.T) {
	// test that a number of minutes yields the expected string
	test := func(expected string, minutes int) {
		actual := MinutesToFriendly(minutes, translation.NewLocale("en-US"))
		assert.Equal(t, expected, actual)
	}
	test("1 minute", 1)
	test("2 minutes", 2)
	test("1 hour", 60)
	test("1 hour, 1 minute", 61)
	test("1 hour, 2 minutes", 62)
	test("2 hours", 120)
}