add more UTs

Author: zhiyuanliang-ms

src/Microsoft.FeatureManagement/FeatureFilters/Recurrence/RecurrenceEvaluator.cs

@@ -49,10 +49,17 @@ static class RecurrenceEvaluator
         const string Numbered = "Numbered";
         const string NoEnd = "NoEnd";
 
-        const int WeeklyUnitIntervalDuration = 7; // in days
-        const int MonthlyUnitIntervalDuration = 28; // in days
-        const int YearlyUnitIntervalDuration = 365; // in days
-
+        const int WeekDayNumber = 7;
+        const int MinMonthDayNumber = 28;
+        const int MinYearDayNumber = 365;
+
+        /// <summary>
+        /// Checks if a provided timestamp is within any recurring time window specified by the Recurrence section in the time window filter settings.
+        /// If the time window filter has an invalid recurrence setting, an exception will be thrown.
+        /// <param name="time">A time stamp.</param>
+        /// <param name="settings">The settings of time window filter.</param>
+        /// <returns>True if the time stamp is within any recurring time window, false otherwise.</returns>
+        /// </summary>
         public static bool MatchRecurrence(DateTimeOffset time, TimeWindowFilterSettings settings)
         {
             if (settings == null)
@@ -88,6 +95,13 @@ public static bool MatchRecurrence(DateTimeOffset time, TimeWindowFilterSettings
             return false;
         }
 
+        /// <summary>
+        /// Try to find the closest previous recurrence occurrence before the provided time stamp according to the recurrence pattern.
+        /// <param name="time">A time stamp.</param>
+        /// <param name="settings">The settings of time window filter.</param>
+        /// <param name="previousOccurrence">The closest orevious occurrence.</param>
+        /// /// <returns>True if the closest previous occurrence is within the recurrence range, false otherwise.</returns>
+        /// </summary>
         private static bool TryGetPreviousOccurrence(DateTimeOffset time, TimeWindowFilterSettings settings, out DateTimeOffset previousOccurrence) 
         {
             previousOccurrence = DateTimeOffset.MaxValue;
@@ -619,13 +633,13 @@ private static bool TryValidateWeeklyRecurrencePattern(TimeWindowFilterSettings
 
             RecurrencePattern pattern = settings.Recurrence.Pattern;
 
-            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * WeeklyUnitIntervalDuration);
+            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * WeekDayNumber);
 
             TimeSpan timeWindowDuration = settings.End.Value - settings.Start.Value;
 
             //
             // Time window duration must be shorter than how frequently it occurs
-            if (settings.End.Value - settings.Start.Value > intervalDuration)
+            if (timeWindowDuration > intervalDuration)
             {
                 paramName = $"{nameof(settings.End)}";
 
@@ -684,7 +698,7 @@ private static bool TryValidateAbsoluteMonthlyRecurrencePattern(TimeWindowFilter
 
             RecurrencePattern pattern = settings.Recurrence.Pattern;
 
-            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MonthlyUnitIntervalDuration);
+            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MinMonthDayNumber);
 
             //
             // Time window duration must be shorter than how frequently it occurs
@@ -730,7 +744,7 @@ private static bool TryValidateRelativeMonthlyRecurrencePattern(TimeWindowFilter
 
             RecurrencePattern pattern = settings.Recurrence.Pattern;
 
-            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MonthlyUnitIntervalDuration);
+            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MinMonthDayNumber);
 
             //
             // Time window duration must be shorter than how frequently it occurs
@@ -782,7 +796,7 @@ private static bool TryValidateAbsoluteYearlyRecurrencePattern(TimeWindowFilterS
 
             RecurrencePattern pattern = settings.Recurrence.Pattern;
 
-            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * YearlyUnitIntervalDuration);
+            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MinYearDayNumber);
 
             //
             // Time window duration must be shorter than how frequently it occurs
@@ -833,7 +847,7 @@ private static bool TryValidateRelativeYearlyRecurrencePattern(TimeWindowFilterS
 
             RecurrencePattern pattern = settings.Recurrence.Pattern;
 
-            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * YearlyUnitIntervalDuration);
+            TimeSpan intervalDuration = TimeSpan.FromDays(pattern.Interval * MinYearDayNumber);
 
             //
             // Time window duration must be shorter than how frequently it occurs
@@ -1211,9 +1225,17 @@ private static TimeSpan GetRecurrenceTimeZone(TimeWindowFilterSettings settings)
             return timeZoneOffset;
         }
 
+        /// <summary>
+        /// Check whether the duration is shorter than the minimum gap between recurrence of days of week.
+        /// </summary>
+        /// <param name="duration">The time span of the duration.</param>
+        /// <param name="interval">The recurrence interval.</param>
+        /// <param name="daysOfWeek">The days of the week when the recurrence will occur.</param>
+        /// <param name="firstDayOfWeek">The first day of the week.</param>
+        /// <returns>True if the duration is compliant with days of week, false otherwise.</returns>
         private static bool IsDurationCompliantWithDaysOfWeek(TimeSpan duration, int interval, IEnumerable<string> daysOfWeek, string firstDayOfWeek)
         {
-            if (daysOfWeek == null || daysOfWeek.Count() < 1)
+            if (daysOfWeek == null || !daysOfWeek.Any())
             {
                 throw new ArgumentException(nameof(daysOfWeek));
             }

tests/Tests.FeatureManagement/FeatureManagement.cs

@@ -256,6 +256,8 @@ public async Task TimeWindow()
             string feature2 = "feature2";
             string feature3 = "feature3";
             string feature4 = "feature4";
+            string feature5 = "feature5";
+            string feature6 = "feature6";
 
             Environment.SetEnvironmentVariable($"FeatureManagement:{feature1}:EnabledFor:0:Name", "TimeWindow");
             Environment.SetEnvironmentVariable($"FeatureManagement:{feature1}:EnabledFor:0:Parameters:End", DateTimeOffset.UtcNow.AddDays(1).ToString("r"));
@@ -269,6 +271,19 @@ public async Task TimeWindow()
             Environment.SetEnvironmentVariable($"FeatureManagement:{feature4}:EnabledFor:0:Name", "TimeWindow");
             Environment.SetEnvironmentVariable($"FeatureManagement:{feature4}:EnabledFor:0:Parameters:Start", DateTimeOffset.UtcNow.AddDays(1).ToString("r"));
 
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature5}:EnabledFor:0:Name", "TimeWindow");
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature5}:EnabledFor:0:Parameters:Start", DateTimeOffset.UtcNow.AddDays(-2).ToString("r"));
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature5}:EnabledFor:0:Parameters:End", DateTimeOffset.UtcNow.AddDays(-1).ToString("r"));
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature5}:EnabledFor:0:Parameters:Recurrence:Pattern:Type", "Daily");
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature5}:EnabledFor:0:Parameters:Recurrence:Range:Type", "NoEnd");
+
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Name", "TimeWindow");
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Parameters:Start", DateTimeOffset.UtcNow.AddDays(-2).ToString("r"));
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Parameters:End", DateTimeOffset.UtcNow.AddDays(-1).ToString("r"));
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Parameters:Recurrence:Pattern:Type", "Daily");
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Parameters:Recurrence:Pattern:Interval", "3");
+            Environment.SetEnvironmentVariable($"FeatureManagement:{feature6}:EnabledFor:0:Parameters:Recurrence:Range:Type", "NoEnd");
+
             IConfiguration config = new ConfigurationBuilder().AddEnvironmentVariables().Build();
 
             var serviceCollection = new ServiceCollection();
@@ -285,6 +300,8 @@ public async Task TimeWindow()
             Assert.False(await featureManager.IsEnabledAsync(feature2));
             Assert.True(await featureManager.IsEnabledAsync(feature3));
             Assert.False(await featureManager.IsEnabledAsync(feature4));
+            Assert.True(await featureManager.IsEnabledAsync(feature5));
+            Assert.False(await featureManager.IsEnabledAsync(feature6));
         }
 
         [Fact]