v1.2.0 with ITimePeriodProvider support

mikanyg · web-flow · commit aa26e4592cdc · 2018-08-15T22:02:40.000+02:00
Providers implement ITimePeriodProvider interface
diff --git a/src/FeatureToggle.Azure.DocumentDB/FeatureToggle.Azure.DocumentDB.csproj b/src/FeatureToggle.Azure.DocumentDB/FeatureToggle.Azure.DocumentDB.csproj
@@ -9,13 +9,15 @@
     <Copyright>Copyright © 2018</Copyright>
     <RepositoryType>Git</RepositoryType>
     <RepositoryUrl>https://github.com/mikanyg/FeatureToggle.Azure.git</RepositoryUrl>
-    <PackageReleaseNotes>1.1.0
+    <PackageReleaseNotes>1.2.0
+- Provider implements ITimePeriodProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledBetweenDatesFeatureToggle.
+1.1.0
 - Provider implements IDateTimeToggleValueProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledOnOrAfterDateFeatureToggle or FeatureToggle.EnabledOnOrBeforeDateFeatureToggle.
 1.0.0
 - Initial release</PackageReleaseNotes>
     <PackageTags>FeatureToggle Toggle Azure DocumentDB DocDB CosmosDB NetStandard</PackageTags>
     <Description>FeatureToggle provider for storing feature toggles in Azure DocumentDB.</Description>
-    <Version>1.1.0</Version>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/FeatureToggle.Azure.DocumentDB/Providers/DocumentDbProvider.cs b/src/FeatureToggle.Azure.DocumentDB/Providers/DocumentDbProvider.cs
@@ -7,7 +7,7 @@
 
 namespace FeatureToggle.Azure.Providers
 {
-    public class DocumentDbProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider
+    public class DocumentDbProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider, ITimePeriodProvider
     {
         private static bool _collectionVerified;
 
@@ -43,6 +43,13 @@ public DateTime EvaluateDateTimeToggleValue(IFeatureToggle toggle)
             return EvaluateToggleValue(toggle, document => document.ToggleTimestamp, toggleName => new DateTimeFeatureToggleDocument(toggleName));
         }
 
+        public Tuple<DateTime, DateTime> EvaluateTimePeriod(IFeatureToggle toggle)
+        {
+            return EvaluateToggleValue(toggle, 
+                document => new Tuple<DateTime, DateTime>(document.Start, document.End), 
+                toggleName => new TimePeriodFeatureToggleDocument(toggleName));
+        }
+
         private TValue EvaluateToggleValue<TDocument, TValue>(IFeatureToggle toggle, Func<TDocument, TValue> valueSelector, Func<string, TDocument> documentCreator) where TDocument : FeatureToggleDocument
         {
             var client = GetDocumentClient();
diff --git a/src/FeatureToggle.Azure.DocumentDB/Providers/TimePeriodFeatureToggleDocument.cs b/src/FeatureToggle.Azure.DocumentDB/Providers/TimePeriodFeatureToggleDocument.cs
@@ -0,0 +1,18 @@
+﻿using System;
+
+namespace FeatureToggle.Azure.Providers
+{
+    public class TimePeriodFeatureToggleDocument : FeatureToggleDocument
+    {
+        public TimePeriodFeatureToggleDocument() : base() { }
+
+        public TimePeriodFeatureToggleDocument(string toggleName) : base(toggleName)
+        {
+            Start = default(DateTime);
+            End = default(DateTime);
+        }
+
+        public DateTime Start { get; set; }
+        public DateTime End { get; set; }
+    }
+}
diff --git a/src/FeatureToggle.Azure.ServiceFabric/FeatureToggle.Azure.ServiceFabric.csproj b/src/FeatureToggle.Azure.ServiceFabric/FeatureToggle.Azure.ServiceFabric.csproj
@@ -9,13 +9,15 @@
     <Copyright>Copyright © 2018</Copyright>
     <RepositoryType>Git</RepositoryType>
     <RepositoryUrl>https://github.com/mikanyg/FeatureToggle.Azure.git</RepositoryUrl>
-    <PackageReleaseNotes>1.1.0
+    <PackageReleaseNotes>1.2.0
+- Provider implements ITimePeriodProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledBetweenDatesFeatureToggle.
+1.1.0
 - Provider implements IDateTimeToggleValueProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledOnOrAfterDateFeatureToggle or FeatureToggle.EnabledOnOrBeforeDateFeatureToggle.
 1.0.0
 - Initial release</PackageReleaseNotes>
     <PackageTags>FeatureToggle Toggle Azure ServiceFabric Fabric NetStandard</PackageTags>
     <Description>FeatureToggle provider for storing feature toggles in Service Fabric configuration packages.</Description>
-    <Version>1.1.0</Version>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/FeatureToggle.Azure.ServiceFabric/Providers/ServiceFabricConfigProvider.cs b/src/FeatureToggle.Azure.ServiceFabric/Providers/ServiceFabricConfigProvider.cs
@@ -4,7 +4,7 @@
 
 namespace FeatureToggle.Azure.Providers
 {
-    public class ServiceFabricConfigProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider
+    public class ServiceFabricConfigProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider, ITimePeriodProvider
     {
         private const string KeyNotFoundInSettingsMessage = "The key '{0}' was not found in settings.xml";
 
@@ -60,6 +60,26 @@ public DateTime EvaluateDateTimeToggleValue(IFeatureToggle toggle)
             return parser.ParseDateTimeConfigString(configValue, key);
         }
 
+        public Tuple<DateTime, DateTime> EvaluateTimePeriod(IFeatureToggle toggle)
+        {
+            var key = ExpectedAppSettingsKeyFor(toggle);
+
+            ValidateKeyExists(key);
+
+            var configValues = GetConfigValue(key).Split('|');
+
+            var parser = new ConfigurationDateParser();
+
+            var startDate = parser.ParseDateTimeConfigString(configValues[0].Trim(), key);
+            var endDate = parser.ParseDateTimeConfigString(configValues[1].Trim(), key);
+
+            var v = new ConfigurationValidator();
+
+            v.ValidateStartAndEndDates(startDate, endDate, key);
+
+            return new Tuple<DateTime, DateTime>(startDate, endDate);
+        }
+
         private string ExpectedAppSettingsKeyFor(IFeatureToggle toggle)
         {
             var prefix = Configuration.UsePrefix ? ToggleConfigurationSettings.Prefix : string.Empty;
@@ -107,6 +127,6 @@ private string[] GetConfigKeysInSection()
             
             var section = settings.Sections[Configuration.ConfigSectionName];
             return section.Parameters.Select(p => p.Name).ToArray();
-        }
+        }        
     }
 }
diff --git a/src/FeatureToggle.Azure.TableStorage/FeatureToggle.Azure.TableStorage.csproj b/src/FeatureToggle.Azure.TableStorage/FeatureToggle.Azure.TableStorage.csproj
@@ -9,13 +9,15 @@
     <Copyright>Copyright © 2018</Copyright>
     <RepositoryType>Git</RepositoryType>
     <RepositoryUrl>https://github.com/mikanyg/FeatureToggle.Azure.git</RepositoryUrl>
-    <PackageReleaseNotes>1.1.0
+    <PackageReleaseNotes>1.2.0
+- Provider implements ITimePeriodProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledBetweenDatesFeatureToggle.
+1.1.0
 - Provider implements IDateTimeToggleValueProvider. Can be used as provider for feature toggles inheriting from FeatureToggle.EnabledOnOrAfterDateFeatureToggle or FeatureToggle.EnabledOnOrBeforeDateFeatureToggle.
 1.0.0
 - Initial release</PackageReleaseNotes>
     <PackageTags>FeatureToggle Toggle Azure TableStorage Table Storage NetStandard</PackageTags>
     <Description>FeatureToggle provider for storing feature toggles in Azure Table storage.</Description>
-    <Version>1.1.0</Version>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/FeatureToggle.Azure.TableStorage/Providers/TableStorageProvider.cs b/src/FeatureToggle.Azure.TableStorage/Providers/TableStorageProvider.cs
@@ -5,7 +5,7 @@
 
 namespace FeatureToggle.Azure.Providers
 {
-    public class TableStorageProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider
+    public class TableStorageProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider, ITimePeriodProvider
     {
         private static bool _tableVerified;
 
@@ -36,6 +36,13 @@ public DateTime EvaluateDateTimeToggleValue(IFeatureToggle toggle)
             return EvaluateToggleValue(toggle, entity => entity.ToggleTimestamp, (componentName, toggleName) => new DateTimeFeatureToggleEntity(componentName, toggleName));
         }
 
+        public Tuple<DateTime, DateTime> EvaluateTimePeriod(IFeatureToggle toggle)
+        {
+            return EvaluateToggleValue(toggle, 
+                entity => new Tuple<DateTime, DateTime>(entity.Start, entity.End), 
+                (componentName, toggleName) => new TimePeriodFeatureToggleEntity(componentName, toggleName));
+        }
+
         private TValue EvaluateToggleValue<TEntity, TValue>(IFeatureToggle toggle, Func<TEntity, TValue> valueSelector, Func<string, string, TEntity> entityCreator) where TEntity : FeatureToggleEntity
         {
             var table = GetCloudTable();
diff --git a/src/FeatureToggle.Azure.TableStorage/Providers/TimePeriodFeatureToggleEntity.cs b/src/FeatureToggle.Azure.TableStorage/Providers/TimePeriodFeatureToggleEntity.cs
@@ -0,0 +1,19 @@
+﻿using System;
+
+namespace FeatureToggle.Azure.Providers
+{
+    public class TimePeriodFeatureToggleEntity : FeatureToggleEntity
+    {
+        public TimePeriodFeatureToggleEntity() : base() { }
+
+        public TimePeriodFeatureToggleEntity(string componentName, string toggleName) : base(componentName, toggleName)
+        {
+            // Table Storage does not support DateTime.Min
+            Start = new DateTime(1900, 1, 1); 
+            End = new DateTime(1900, 1, 1); 
+        }
+
+        public DateTime Start { get; set; }
+        public DateTime End { get; set; }
+    }
+}
diff --git a/test/FeatureToggle.Azure.DocumentDB.Test/TimePeriodToggleTest.cs b/test/FeatureToggle.Azure.DocumentDB.Test/TimePeriodToggleTest.cs
@@ -0,0 +1,55 @@
+﻿using FeatureToggle.Azure.DocumentDB.Test.Toggles;
+using FeatureToggle.Azure.Providers;
+using NUnit.Framework;
+using Shouldly;
+using System;
+using System.Threading.Tasks;
+
+namespace FeatureToggle.Azure.DocumentDB.Test
+{
+    [TestFixture]
+    public class TimePeriodToggleTest : DocumentDbTestFixture
+    {
+        [Test]
+        public async Task FeatureEnabled_LimitedTimeOfferFeatureToggleSetToEnabledTomorrow_ToggleValueIsFalse()
+        {
+            // Arrange
+            AutoCreateToggle<LimitedTimeOfferFeatureToggle>();
+            await UpdateToggleDocument(new TimePeriodFeatureToggleDocument(nameof(LimitedTimeOfferFeatureToggle)) { Start = DateTime.Now.AddDays(1), End = DateTime.Now.AddDays(2) });
+
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeFalse();
+        }
+
+        [Test]
+        public async Task FeatureEnabled_LimitedTimeOfferFeatureToggleSetToExpiredYesterday_ToggleValueIsFalse()
+        {
+            // Arrange
+            AutoCreateToggle<LimitedTimeOfferFeatureToggle>();
+            await UpdateToggleDocument(new TimePeriodFeatureToggleDocument(nameof(LimitedTimeOfferFeatureToggle)) { Start = DateTime.Now.AddDays(-2), End = DateTime.Now.AddDays(-1) });
+
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeFalse();
+        }
+
+        [Test]
+        public async Task FeatureEnabled_LimitedTimeOfferFeatureToggleSetToEnabledYesterday_ToggleValueIsTrue()
+        {
+            // Arrange
+            AutoCreateToggle<LimitedTimeOfferFeatureToggle>();
+            await UpdateToggleDocument(new TimePeriodFeatureToggleDocument(nameof(LimitedTimeOfferFeatureToggle)) { Start = DateTime.Now.AddDays(-1), End = DateTime.Now.AddDays(1) });
+
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeTrue();
+        }
+    }
+}
diff --git a/test/FeatureToggle.Azure.DocumentDB.Test/Toggles/LimitedTimeOfferFeatureToggle.cs b/test/FeatureToggle.Azure.DocumentDB.Test/Toggles/LimitedTimeOfferFeatureToggle.cs
@@ -0,0 +1,15 @@
+﻿using FeatureToggle.Azure.Providers;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace FeatureToggle.Azure.DocumentDB.Test.Toggles
+{
+    public class LimitedTimeOfferFeatureToggle : EnabledBetweenDatesFeatureToggle
+    {
+        public LimitedTimeOfferFeatureToggle()
+        {
+            this.ToggleValueProvider = new DocumentDbProvider();
+        }
+    }
+}
diff --git a/test/FeatureToggle.Azure.ServiceFabric.Test/TimePeriodToggleTest.cs b/test/FeatureToggle.Azure.ServiceFabric.Test/TimePeriodToggleTest.cs
@@ -0,0 +1,91 @@
+﻿using FeatureToggle.Azure.Providers;
+using FeatureToggle.Azure.ServiceFabric.Test.Toggles;
+using NUnit.Framework;
+using Shouldly;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace FeatureToggle.Azure.ServiceFabric.Test
+{
+
+    [TestFixture]
+    public class TimePeriodToggleTest : ServiceFabricTestFixture
+    {
+        private const string ExpectedDateFormat = @"dd-MMM-yyyy HH:mm:ss";
+
+        [SetUp]
+        public void Setup()
+        {
+            ServiceFabricConfigProvider.Configure(usePrefix: false);
+        }
+
+        [Test]        
+        public void FeatureEnabled_LimitedTimeOfferFeatureToggleSetToEnabledTomorrow_ToggleValueIsFalse()
+        {
+            // Arrange
+            DateTime start = DateTime.Today.AddDays(1);
+            DateTime end = DateTime.Today.AddDays(2);
+            string configValue = $"{start:dd-MMM-yyyy HH:mm:ss} | {end:dd-MMM-yyyy HH:mm:ss}";
+            SetToggleInConfig(nameof(LimitedTimeOfferFeatureToggle), configValue);
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeFalse();
+        }
+
+        [Test]
+        public void FeatureEnabled_LimitedTimeOfferFeatureToggleSetToExpiredYesterday_ToggleValueIsFalse()
+        {
+            // Arrange
+            DateTime start = DateTime.Today.AddDays(-2);
+            DateTime end = DateTime.Today.AddDays(-1);
+            string configValue = $"{start:dd-MMM-yyyy HH:mm:ss} | {end:dd-MMM-yyyy HH:mm:ss}";
+            SetToggleInConfig(nameof(LimitedTimeOfferFeatureToggle), configValue);
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeFalse();
+        }
+
+        [Test]
+        public void FeatureEnabled_LimitedTimeOfferFeatureToggleSetToEnabledYesterday_ToggleValueIsTrue()
+        {
+            // Arrange            
+            DateTime start = DateTime.Today.AddDays(-1);
+            DateTime end = DateTime.Today.AddDays(1);
+            string configValue = $"{start:dd-MMM-yyyy HH:mm:ss} | {end:dd-MMM-yyyy HH:mm:ss}";
+            SetToggleInConfig(nameof(LimitedTimeOfferFeatureToggle), configValue);
+            var toggle = new LimitedTimeOfferFeatureToggle();
+            // Act
+            var toggleValue = toggle.FeatureEnabled;
+            // Assert
+            toggleValue.ShouldBeTrue();
+        }        
+
+        [TestCase("02-Jan-2050 04:05:10 | 02-Jan-2050 04:05:09", "the start date must be less then the end date")]
+        [TestCase("02-Jan-2050 04:05:09 | 02-Jan-2050 04:05:09", "the start date must be less then the end date")]
+        [TestCase("01-Jan-2050 04:05:09 | 02/01/2050 04:05:44", "cannot be converted to a DateTime")]
+        [TestCase("qwerty | 07-Aug-2099 06:05:04", "cannot be converted to a DateTime")]
+        [TestCase("02-Jan-2050 04:05:08 ; 07-Aug-2099 06:05:04", "cannot be converted to a DateTime")]
+        [TestCase("02-Jan-2050 04:05:08 | qwerty", "cannot be converted to a DateTime")]
+        public void FeatureEnabled_ComingSoonFeatureToggleSetToInvalidDate_ThrowToggleConfigError(string configValue, string errorMsg)
+        {
+            // Arrange
+            SetToggleInConfig(nameof(LimitedTimeOfferFeatureToggle), configValue);
+            var toggle = new LimitedTimeOfferFeatureToggle();
+
+            var error = Should.Throw<ToggleConfigurationError>(() =>
+            {
+                // Act
+                var toggleValue = toggle.FeatureEnabled;
+            });
+
+            // Assert
+            error.Message.ShouldContain(errorMsg);
+        }
+    }
+}
diff --git a/test/FeatureToggle.Azure.ServiceFabric.Test/Toggles/LimitedTimeOfferFeatureToggle.cs b/test/FeatureToggle.Azure.ServiceFabric.Test/Toggles/LimitedTimeOfferFeatureToggle.cs
@@ -0,0 +1,15 @@
+﻿using FeatureToggle.Azure.Providers;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace FeatureToggle.Azure.ServiceFabric.Test.Toggles
+{
+    public class LimitedTimeOfferFeatureToggle : EnabledBetweenDatesFeatureToggle
+    {
+        public LimitedTimeOfferFeatureToggle()
+        {
+            this.ToggleValueProvider = new ServiceFabricConfigProvider();
+        }
+    }
+}
diff --git a/test/FeatureToggle.Azure.TableStorage.Test/TimePeriodToggleTest.cs b/test/FeatureToggle.Azure.TableStorage.Test/TimePeriodToggleTest.cs
diff --git a/test/FeatureToggle.Azure.TableStorage.Test/Toggles/LimitedTimeOfferFeatureToggle.cs b/test/FeatureToggle.Azure.TableStorage.Test/Toggles/LimitedTimeOfferFeatureToggle.cs

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`
`8`	`8`	`namespace FeatureToggle.Azure.Providers`
`9`	`9`	`{`
`10`		`- public class DocumentDbProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider`
	`10`	`+ public class DocumentDbProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider, ITimePeriodProvider`
`11`	`11`	`{`
`12`	`12`	`private static bool _collectionVerified;`
`13`	`13`
`@@ -43,6 +43,13 @@ public DateTime EvaluateDateTimeToggleValue(IFeatureToggle toggle)`
`43`	`43`	`return EvaluateToggleValue(toggle, document => document.ToggleTimestamp, toggleName => new DateTimeFeatureToggleDocument(toggleName));`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ public Tuple<DateTime, DateTime> EvaluateTimePeriod(IFeatureToggle toggle)`
	`47`	`+ {`
	`48`	`+ return EvaluateToggleValue(toggle,`
	`49`	`+ document => new Tuple<DateTime, DateTime>(document.Start, document.End),`
	`50`	`+ toggleName => new TimePeriodFeatureToggleDocument(toggleName));`
	`51`	`+ }`
	`52`	`+`
`46`	`53`	`private TValue EvaluateToggleValue<TDocument, TValue>(IFeatureToggle toggle, Func<TDocument, TValue> valueSelector, Func<string, TDocument> documentCreator) where TDocument : FeatureToggleDocument`
`47`	`54`	`{`
`48`	`55`	`var client = GetDocumentClient();`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace FeatureToggle.Azure.Providers`
`7`	`7`	`{`
`8`		`- public class TableStorageProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider`
	`8`	`+ public class TableStorageProvider : IBooleanToggleValueProvider, IDateTimeToggleValueProvider, ITimePeriodProvider`
`9`	`9`	`{`
`10`	`10`	`private static bool _tableVerified;`
`11`	`11`
`@@ -36,6 +36,13 @@ public DateTime EvaluateDateTimeToggleValue(IFeatureToggle toggle)`
`36`	`36`	`return EvaluateToggleValue(toggle, entity => entity.ToggleTimestamp, (componentName, toggleName) => new DateTimeFeatureToggleEntity(componentName, toggleName));`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ public Tuple<DateTime, DateTime> EvaluateTimePeriod(IFeatureToggle toggle)`
	`40`	`+ {`
	`41`	`+ return EvaluateToggleValue(toggle,`
	`42`	`+ entity => new Tuple<DateTime, DateTime>(entity.Start, entity.End),`
	`43`	`+ (componentName, toggleName) => new TimePeriodFeatureToggleEntity(componentName, toggleName));`
	`44`	`+ }`
	`45`	`+`
`39`	`46`	`private TValue EvaluateToggleValue<TEntity, TValue>(IFeatureToggle toggle, Func<TEntity, TValue> valueSelector, Func<string, string, TEntity> entityCreator) where TEntity : FeatureToggleEntity`
`40`	`47`	`{`
`41`	`48`	`var table = GetCloudTable();`