Merge pull request #339 - IDistributedCache feature

IDistributedCache feature

Author: ivaylokenov

README.md

@@ -207,7 +207,7 @@ This package will include all available assertion methods in your test project,
  - `MyTested.AspNetCore.Mvc.DataAnnotations` - Contains setup and assertion methods for data annotation validations
  - `MyTested.AspNetCore.Mvc.EntityFrameworkCore` - Contains setup and assertion methods for `DbContext`
  - `MyTested.AspNetCore.Mvc.DependencyInjection` - Contains setup methods for dependency injection services
- - `MyTested.AspNetCore.Mvc.Caching` - Contains setup and assertion methods for `IMemoryCache`
+ - `MyTested.AspNetCore.Mvc.Caching` - Contains setup and assertion methods for `IMemoryCache` and `IDistributedCache`
  - `MyTested.AspNetCore.Mvc.Session` - Contains setup and assertion methods for `ISession`
  - `MyTested.AspNetCore.Mvc.Options` - Contains setup and assertion methods for `IOptions`
  - `MyTested.AspNetCore.Mvc.Helpers` - Contains additional helper methods for easier assertions

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IAndDistributedCacheBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> builder.
+    /// </summary>
+    public interface IAndDistributedCacheBuilder : IDistributedCacheBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/>.
+        /// </summary>
+        /// <returns></returns>
+        IDistributedCacheBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IAndDistributedCacheEntryBuilder.cs

@@ -0,0 +1,16 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    using MemoryCache;
+
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entry builder.
+    /// </summary>
+    public interface IAndDistributedCacheEntryBuilder : IDistributedCacheEntryBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when building <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entries.
+        /// </summary>
+        /// <returns>The same <see cref="IMemoryCacheEntryBuilder"/>.</returns>
+        IDistributedCacheEntryBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IAndDistributedCacheEntryTestBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entry tests.
+    /// </summary>
+    public interface IAndDistributedCacheEntryTestBuilder : IDistributedCacheEntryTestBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when testing <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entries.
+        /// </summary>
+        /// <returns>The same <see cref="IDistributedCacheEntryTestBuilder"/>.</returns>
+        IDistributedCacheEntryTestBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IAndDistributedCacheTestBuilder.cs

@@ -0,0 +1,14 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    /// <summary>
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> tests.
+    /// </summary>
+    public interface IAndDistributedCacheTestBuilder : IDistributedCacheTestBuilder
+    {
+        /// <summary>
+        /// AndAlso method for better readability when testing <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/>
+        /// </summary>
+        /// <returns></returns>
+        IDistributedCacheTestBuilder AndAlso();
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IDistributedCacheBuilder.cs

@@ -0,0 +1,67 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    using System;
+    using System.Collections.Generic;
+    using Microsoft.Extensions.Caching.Distributed;
+
+    /// <summary>
+    /// Used for building mocked <see cref="IDistributedCache"/>.
+    /// </summary>
+    public interface IDistributedCacheBuilder
+    {
+        /// <summary>
+        /// Adds cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <param name="value">Value of the cache entry.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntry(string key, byte[] value);
+
+        /// <summary>
+        /// Adds cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <param name="value">String value of the cache entry.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntry(string key, string value);
+
+        /// <summary>
+        /// Adds cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <param name="value">Value of the cache entry.</param>
+        /// <param name="options"><see cref="DistributedCacheEntryOptions"/> of the cache entry.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntry(string key, byte[] value, DistributedCacheEntryOptions options);
+
+        /// <summary>
+        /// Adds cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="key">Key of the cache entry.</param>
+        /// <param name="value">String value of the cache entry.</param>
+        /// <param name="options"><see cref="DistributedCacheEntryOptions"/> of the cache entry.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntry(string key, string value, DistributedCacheEntryOptions options);
+
+        /// <summary>
+        /// Adds cache entry to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="distributedCacheEntryBuilder">Builder for creating cache entry.</param>
+        /// <returns>The same <see cref="IDistributedCacheEntryKeyBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntry(Action<IDistributedCacheEntryKeyBuilder> distributedCacheEntryBuilder);
+
+        /// <summary>
+        /// Adds cache entries to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="entries">Dictionary of cache entries.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntries(IDictionary<string, byte[]> entries);
+
+        /// <summary>
+        /// Adds cache entries to the mocked <see cref="IDistributedCache"/>.
+        /// </summary>
+        /// <param name="entries">Dictionary of cache entries.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheBuilder"/>.</returns>
+        IAndDistributedCacheBuilder WithEntries(IDictionary<string, string> entries);
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IDistributedCacheEntryBuilder.cs

@@ -0,0 +1,46 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    using System;
+    using Microsoft.Extensions.Caching.Distributed;
+
+    /// <summary>
+    /// Used for building <see cref="IDistributedCache"/> entry.
+    /// </summary>
+    public interface IDistributedCacheEntryBuilder
+    {
+        /// <summary>
+        /// Sets the value of the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="value">Cache entry value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithValue(byte[] value);
+
+        /// <summary>
+        /// Sets the value of the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="value">Cache entry string value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithValue(string value);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.AbsoluteExpiration"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="absoluteExpiration">Absolute expiration value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithAbsoluteExpiration(DateTimeOffset? absoluteExpiration);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.AbsoluteExpirationRelativeToNow"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="absoluteExpirationRelativeToNow">Absolute expiration relative to now value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithAbsoluteExpirationRelativeToNow(TimeSpan? absoluteExpirationRelativeToNow);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.SlidingExpiration"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="slidingExpiration">Sliding expiration value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithSlidingExpiration(TimeSpan? slidingExpiration);
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IDistributedCacheEntryKeyBuilder.cs

@@ -0,0 +1,15 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    /// <summary>
+    /// Used for setting <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> key.
+    /// </summary>
+    public interface IDistributedCacheEntryKeyBuilder
+    {
+        /// <summary>
+        /// Sets the key of the built <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="key">Cache entry key to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryBuilder"/>.</returns>
+        IAndDistributedCacheEntryBuilder WithKey(string key);
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IDistributedCacheEntryKeyTestBuilder.cs

@@ -0,0 +1,15 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    /// <summary>
+    /// Used for setting <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> key.
+    /// </summary>
+    public interface IDistributedCacheEntryKeyTestBuilder
+    {
+        /// <summary>
+        /// Sets the key of the built <see cref="Microsoft.Extensions.Caching.Distributed.IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="key">Cache entry key to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithKey(string key);
+    }
+}

src/MyTested.AspNetCore.Mvc.Caching/Builders/Contracts/Data/DistributedCache/IDistributedCacheEntryTestBuilder.cs

@@ -0,0 +1,46 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Data.DistributedCache
+{
+    using System;
+    using Microsoft.Extensions.Caching.Distributed;
+
+    /// <summary>
+    /// Used for testing <see cref="IDistributedCache"/> entry.
+    /// </summary>
+    public interface IDistributedCacheEntryTestBuilder
+    {
+        /// <summary>
+        /// Sets the value of the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="value">Cache entry value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithValue(byte[] value);
+
+        /// <summary>
+        /// Sets the value of the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="value">Cache entry string value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithValue(string value);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.AbsoluteExpiration"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="absoluteExpiration">Absolute expiration value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithAbsoluteExpiration(DateTimeOffset? absoluteExpiration);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.AbsoluteExpirationRelativeToNow"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="absoluteExpirationRelativeToNow">Absolute expiration relative to now value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithAbsoluteExpirationRelativeToNow(TimeSpan? absoluteExpirationRelativeToNow);
+
+        /// <summary>
+        /// Sets the <see cref="DistributedCacheEntryOptions.SlidingExpiration"/> value to the built <see cref="IDistributedCache"/> entry.
+        /// </summary>
+        /// <param name="slidingExpiration">Sliding expiration value to set.</param>
+        /// <returns>The same <see cref="IAndDistributedCacheEntryTestBuilder"/>.</returns>
+        IAndDistributedCacheEntryTestBuilder WithSlidingExpiration(TimeSpan? slidingExpiration);
+    }
+}