|
| 1 | +// |
| 2 | +// Copyright ical.net project maintainers and contributors. |
| 3 | +// Licensed under the MIT license. |
| 4 | +// |
| 5 | + |
| 6 | +#nullable enable |
| 7 | +using System; |
| 8 | +using System.Linq; |
| 9 | +using Ical.Net.DataTypes; |
| 10 | +using Ical.Net.TimeZone; |
| 11 | +using NodaTime; |
| 12 | +using NUnit.Framework; |
| 13 | + |
| 14 | +namespace Ical.Net.Tests; |
| 15 | + |
| 16 | +[TestFixture] |
| 17 | +public class CalTimeZoneProviderTests |
| 18 | +{ |
| 19 | + private Func<string, DateTimeZone> _tzResolverBackup = TimeZoneResolvers.TimeZoneResolver; |
| 20 | + private CalTimeZoneProvider _provider; |
| 21 | + |
| 22 | + [OneTimeSetUp] |
| 23 | + public void Setup() |
| 24 | + { |
| 25 | + _tzResolverBackup = TimeZoneResolvers.TimeZoneResolver; |
| 26 | + |
| 27 | + // Just needed to create a custom time zone provider |
| 28 | + const string dummyTimeZoneIcs = |
| 29 | + """ |
| 30 | + BEGIN:VCALENDAR |
| 31 | + PRODID:-//Dummy//NONSGML ICS//EN |
| 32 | + VERSION:2.0 |
| 33 | + BEGIN:VTIMEZONE |
| 34 | + TZID:Custom/TimeZone |
| 35 | + BEGIN:STANDARD |
| 36 | + TZNAME:STD |
| 37 | + DTSTART:20221106T020000 |
| 38 | + RRULE:FREQ=YEARLY;BYMONTH=11;BYDAY=1SU |
| 39 | + TZOFFSETFROM:-0400 |
| 40 | + TZOFFSETTO:-0500 |
| 41 | + END:STANDARD |
| 42 | + BEGIN:DAYLIGHT |
| 43 | + TZNAME:DST |
| 44 | + DTSTART:20230312T020000 |
| 45 | + RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SU |
| 46 | + TZOFFSETFROM:-0500 |
| 47 | + TZOFFSETTO:-0400 |
| 48 | + END:DAYLIGHT |
| 49 | + END:VTIMEZONE |
| 50 | + END:VCALENDAR |
| 51 | + """; |
| 52 | + var c = Calendar.Load(dummyTimeZoneIcs); |
| 53 | + _provider = new CalTimeZoneProvider(); |
| 54 | + _provider.AddRangeFrom(c.TimeZones, 2030); |
| 55 | + |
| 56 | + TimeZoneResolvers.TimeZoneResolver = tzId => |
| 57 | + TimeZoneResolvers.Default(tzId) |
| 58 | + // use custom timezones from the calendar if not found in the default resolver |
| 59 | + ?? _provider.GetZoneOrNull(tzId); |
| 60 | + } |
| 61 | + |
| 62 | + [OneTimeTearDown] |
| 63 | + public void TearDown() |
| 64 | + { |
| 65 | + TimeZoneResolvers.TimeZoneResolver = _tzResolverBackup; |
| 66 | + } |
| 67 | + |
| 68 | + [Test, Category(nameof(CalTimeZoneProvider))] |
| 69 | + public void VTimeZoneProvider_ShouldResolve_CustomVTimeZone() |
| 70 | + { |
| 71 | + var ics = IcsFiles.EventWithCustomTz; |
| 72 | + var calendar = Calendar.Load(ics); |
| 73 | + var firstTimeZone = calendar.TimeZones.First(tz => tz.TzId == "Custom/Timezone"); |
| 74 | + var timeZone = firstTimeZone.ToDateTimeZone(2000); |
| 75 | + |
| 76 | + var intervals = timeZone? |
| 77 | + .GetZoneIntervals(Instant.FromUtc(1970, 1, 1, 0, 0, 0), |
| 78 | + Instant.FromUtc(1970, 3, 8, 8, 0, 0)) |
| 79 | + .ToList(); |
| 80 | + |
| 81 | + var standardInterval = intervals?.FirstOrDefault(i => i.Name == "CST"); |
| 82 | + var daylightInterval = intervals?.FirstOrDefault(i => i.Name == "CDT"); |
| 83 | + |
| 84 | + Assert.Multiple(() => |
| 85 | + { |
| 86 | + Assert.That(timeZone, Is.Not.Null); |
| 87 | + Assert.That(timeZone?.Id, Is.EqualTo("Custom/Timezone")); |
| 88 | + |
| 89 | + Assert.That(intervals, Is.Not.Null); |
| 90 | + Assert.That(intervals, Has.Count.EqualTo(2)); |
| 91 | + |
| 92 | + Assert.That(standardInterval, Is.Not.Null); |
| 93 | + Assert.That(standardInterval?.WallOffset, Is.EqualTo(Offset.FromHours(-5))); |
| 94 | + |
| 95 | + Assert.That(daylightInterval, Is.Not.Null); |
| 96 | + Assert.That(daylightInterval?.WallOffset, Is.EqualTo(Offset.FromHours(-4))); |
| 97 | + }); |
| 98 | + } |
| 99 | + |
| 100 | + [Test, Category(nameof(CalTimeZoneProvider))] |
| 101 | + [TestCase("UTC", 0)] |
| 102 | + [TestCase("UTC+01:00", 1)] |
| 103 | + [TestCase("UTC-05:00", -5)] |
| 104 | + public void VDateTimeZone_ShouldReturnOffsetZone_UtcAndUtcOffset(string tzId, int expectedOffsetHours) |
| 105 | + { |
| 106 | + var ics = IcsFiles.EventWithCustomTz; |
| 107 | + var calendar = Calendar.Load(ics); |
| 108 | + |
| 109 | + var provider = new CalTimeZoneProvider(); |
| 110 | + provider.AddRangeFrom(calendar.TimeZones, 2030); |
| 111 | + |
| 112 | + var result = provider.GetZoneOrNull(tzId); |
| 113 | + |
| 114 | + Assert.Multiple(() => |
| 115 | + { |
| 116 | + Assert.That(result, Is.Not.Null); |
| 117 | + Assert.That(result!.MaxOffset, Is.EqualTo(Offset.FromHours(expectedOffsetHours))); |
| 118 | + Assert.That(result.Id, Is.EqualTo(provider[tzId].Id)); |
| 119 | + }); |
| 120 | + } |
| 121 | + |
| 122 | + [Test, Category(nameof(CalTimeZoneProvider))] |
| 123 | + [TestCase("UTC", 0)] |
| 124 | + [TestCase("UTC+01:00", 1)] |
| 125 | + [TestCase("UTC-02:00", -2)] |
| 126 | + public void Provider_ShouldHandle_UtcAndUtcOffset(string utcTzId, int offset) |
| 127 | + { |
| 128 | + var toConvert = new CalDateTime(2023, 6, 1, 14, 0, 0, "UTC"); |
| 129 | + |
| 130 | + // Act |
| 131 | + // The custom provider can delegate to |
| 132 | + // DateTimeZone.Utc and DateTimeZone.Offset |
| 133 | + TimeZoneResolvers.TimeZoneResolver = _provider.GetZoneOrNull; |
| 134 | + |
| 135 | + var result = toConvert.ToTimeZone(utcTzId); |
| 136 | + |
| 137 | + Assert.Multiple(() => |
| 138 | + { |
| 139 | + Assert.That(result.TzId, Is.EqualTo(utcTzId)); |
| 140 | + Assert.That(result.Value, Is.EqualTo(toConvert.Value.AddHours(offset))); |
| 141 | + }); |
| 142 | + } |
| 143 | + |
| 144 | + [Test, Category(nameof(CalTimeZoneProvider))] |
| 145 | + public void Occurrences_WithCustomTimeZone() |
| 146 | + { |
| 147 | + var ics = IcsFiles.EventWithCustomTz; |
| 148 | + var calendar = Calendar.Load(ics); |
| 149 | + var calTimeZoneProvider = new CalTimeZoneProvider(); |
| 150 | + calTimeZoneProvider.AddRangeFrom(calendar.TimeZones, 2030); |
| 151 | + |
| 152 | + TimeZoneResolvers.TimeZoneResolver = tzId => |
| 153 | + TimeZoneResolvers.Default(tzId) |
| 154 | + // use custom timezones from the calendar if not found in the default resolver |
| 155 | + ?? calTimeZoneProvider.GetZoneOrNull(tzId); |
| 156 | + |
| 157 | + var occ = calendar.GetOccurrences().ToList(); |
| 158 | + |
| 159 | + Assert.Multiple(() => |
| 160 | + { |
| 161 | + Assert.That(occ, Has.Count.EqualTo(1)); |
| 162 | + Assert.That(occ[0].Period.StartTime, Is.EqualTo(new CalDateTime(2025, 11, 1, 9, 0, 0, "Custom/Timezone"))); |
| 163 | + // Offset is -4 hours for daylight saving time from 2025-03-08 |
| 164 | + Assert.That(occ[0].Period.StartTime.AsUtc, Is.EqualTo(new DateTime(2025, 11, 1, 13, 0, 0, DateTimeKind.Utc))); |
| 165 | + }); |
| 166 | + } |
| 167 | +} |
0 commit comments