feat(AzureBlob): increases coverage (#163)

I achieved good coverage with most generic methods. Surely there are more situations we can test, but this is a initial harness that will enable us to more confidently make changes to this class.

Closes #166.

Author: bruno-brant

.github/workflows/ci.yml

@@ -12,13 +12,22 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - name: Checkout code
+        uses: actions/checkout@v1
+
+      - name: Start Azurite (Azure Blob Storage emulator)
+        run: docker run --name azurite -d -p 10000:10000 -p 10001:10001 mcr.microsoft.com/azure-storage/azurite
+
       - name: Setup .NET Core
         uses: actions/setup-dotnet@v1
-        with:
+        with:      
           dotnet-version: 2.2.108
-      - name: Test solution
-        run: dotnet test
+
+      - name: Restore packages
+        run: dotnet restore
+
       - name: Build solution 
-        run: dotnet build --configuration Release
-    
+        run: dotnet build
+
+      - name: Test solution
+        run: dotnet test      

Liquid.All.sln

@@ -47,7 +47,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Liquid.Base.Tests", "test\L
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Liquid.Domain.Tests", "test\Liquid.Domain.Tests\Liquid.Domain.Tests.csproj", "{90CF0830-CD3C-4DD7-8C90-584772885BE0}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Liquid.Tests", "test\Liquid.Tests\Liquid.Tests.csproj", "{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Liquid.Tests", "test\Liquid.Tests\Liquid.Tests.csproj", "{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Liquid.OnAzure.Tests", "test\Liquid.OnAzure.Tests\Liquid.OnAzure.Tests.csproj", "{9DEA4109-7542-40D5-9CCF-A673C9787E6D}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -111,6 +113,10 @@ Global
 		{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9DEA4109-7542-40D5-9CCF-A673C9787E6D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9DEA4109-7542-40D5-9CCF-A673C9787E6D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9DEA4109-7542-40D5-9CCF-A673C9787E6D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9DEA4109-7542-40D5-9CCF-A673C9787E6D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -130,6 +136,7 @@ Global
 		{5279F425-0A2C-4889-968D-FFEB25975453} = {6A0B6B3D-15FE-4C0B-97A1-7897E31C0C4E}
 		{90CF0830-CD3C-4DD7-8C90-584772885BE0} = {6A0B6B3D-15FE-4C0B-97A1-7897E31C0C4E}
 		{6BA7DC4B-0F66-415A-AE74-5DEA5D3943D5} = {6A0B6B3D-15FE-4C0B-97A1-7897E31C0C4E}
+		{9DEA4109-7542-40D5-9CCF-A673C9787E6D} = {6A0B6B3D-15FE-4C0B-97A1-7897E31C0C4E}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {1E0953B7-A30F-4440-9719-22CA017677B5}

src/Liquid.Base/Interfaces/Repository/ILightAttachment.cs

@@ -1,4 +1,5 @@
-using System.IO;
+using System;
+using System.IO;
 
 namespace Liquid.Interfaces
 {
@@ -9,6 +10,9 @@ public interface ILightAttachment
         string ContentType { get; set; }
         string MediaLink { get; set; }
         Stream MediaStream { get; set; }
+        /// <summary>
+        /// The directory where the attachment will be stored into.
+        /// </summary>
         string ResourceId { get; set; }
     }
 }

src/Liquid.Base/Interfaces/Repository/ILightMediaStorage.cs

@@ -1,18 +1,53 @@
-using Liquid.Base.Interfaces;
+// Copyright (c) Avanade Inc. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
 using System;
 using System.Threading.Tasks;
+using Liquid.Base.Interfaces;
 
 namespace Liquid.Interfaces
 {
     /// <summary>
-    /// Public interface for all Media Storage Implementations 
+    /// Defines an object capable of storing arbritary media.
     /// </summary>
     public interface ILightMediaStorage : IWorkbenchHealthCheck
-    {	
-		string Conection { get; set; }
+    {
+        /// <summary>
+        /// Gets or sets the connection string for the storage provider.
+        /// </summary>
+        [Obsolete("This property will be removed in later version. Please refrain from accessing it.")]
+        string Connection { get; set; }
+
+        /// <summary>
+        /// Gets or sets the container name used to store data in the provider.
+        /// </summary>
+        [Obsolete("This property will be removed in later version. Please refrain from accessing it.")]
         string Container { get; set; }
+
+        /// <summary>
+        /// Gets an <see cref="ILightAttachment"/> from storage.
+        /// </summary>
+        /// <param name="resourceId">The directory of the container.</param>
+        /// <param name="id">The name of the media file.</param>
+        /// <returns>
+        /// A task that represents the asynchronous operation.
+        /// The task result contains an object that encapsulates access to the data in the container entry.
+        /// </returns>
+        /// <exception cref="Exception">Throws when the resource doesn't exists.</exception>
         Task<ILightAttachment> GetAsync(string resourceId, string id);
-        Task InsertUpdateAsync(ILightAttachment attachment); 
-        Task Remove(ILightAttachment attachment); 
+
+        /// <summary>
+        /// Upserts an <see cref="ILightAttachment"/> to the storage.
+        /// </summary>
+        /// <param name="attachment">Describes the data that will be stored/updated.</param>
+        /// <returns>A task that represents the asynchronous operation.</returns>
+        Task InsertUpdateAsync(ILightAttachment attachment);
+
+        /// <summary>
+        /// Removes an item from the underlying storage.
+        /// </summary>
+        /// <param name="attachment">Describes the data that will be stored/updated.</param>
+        /// <returns>A task that represents the asynchronous operation.</returns>
+        Task Remove(ILightAttachment attachment);
     }
 }

src/Liquid.Base/StreamExtensions.cs

@@ -0,0 +1,89 @@
+// Copyright (c) Avanade Inc. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using System;
+using System.IO;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Liquid
+{
+    /// <summary>
+    /// Extensions to simplify the manipulation of streams.
+    /// </summary>
+    public static class StreamExtensions
+    {
+        /// <summary>
+        /// Read the stream to the end and converts it to an UTF8 string.
+        /// </summary>
+        /// <param name="stream">The stream that will be read to the end.</param>
+        /// <returns>The contents of the stream read as a string.</returns>
+        public static string AsString(this Stream stream) => AsString(stream, Encoding.UTF8);
+
+        /// <summary>
+        /// Read the stream to the end and converts it to a string accordingly to the desired encoding.
+        /// </summary>
+        /// <param name="stream">The stream that will be read to the end.</param>
+        /// <param name="encoding">The encoding of the string in the stream.</param>
+        /// <returns>The contents of the stream read as a string.</returns>
+        public static string AsString(this Stream stream, Encoding encoding)
+        {
+            if (stream is null)
+            {
+                throw new ArgumentNullException(nameof(stream));
+            }
+
+            if (encoding is null)
+            {
+                throw new ArgumentNullException(nameof(encoding));
+            }
+
+            using (var reader = new StreamReader(stream, encoding))
+            {
+                return reader.ReadToEnd();
+            }
+        }
+
+        /// <summary>
+        /// Read the stream to the end and converts it to an UTF8 string asynchronously.
+        /// </summary>
+        /// <param name="stream">The stream that will be read to the end.</param>
+        /// <returns>Task containg the result of the conversion from stream to string.</returns>
+        public static Task<string> AsStringAsync(this Stream stream) => AsStringAsync(stream, Encoding.UTF8);
+
+        /// <summary>
+        /// Read the stream to the end and converts it to a string accordingly to the desired encoding asynchronously.
+        /// </summary>
+        /// <param name="stream">The stream that will be read to the end.</param>
+        /// <param name="encoding">The encoding of the string in the stream.</param>
+        /// <returns>Task containg the result of the conversion from stream to string.</returns>
+        public static Task<string> AsStringAsync(this Stream stream, Encoding encoding)
+        {
+            if (stream is null)
+            {
+                throw new ArgumentNullException(nameof(stream));
+            }
+
+            if (encoding is null)
+            {
+                throw new ArgumentNullException(nameof(encoding));
+            }
+
+            return AsStringAsyncImpl(stream, encoding);
+        }
+
+        /// <summary>
+        /// Read the stream to the end and converts it to a string accordingly to the desired encoding asynchronously.
+        /// </summary>
+        /// <param name="stream">The stream that will be read to the end.</param>
+        /// <param name="encoding">The encoding of the string in the stream.</param>
+        /// <returns>Task containg the result of the conversion from stream to string.</returns>
+        private static async Task<string> AsStringAsyncImpl(this Stream stream, Encoding encoding)
+        {
+            using (var reader = new StreamReader(stream, encoding))
+            {
+                return await reader.ReadToEndAsync();
+            }
+        }
+    }
+}

src/Liquid.OnAWS/Storages/S3.cs

@@ -11,7 +11,7 @@ namespace Liquid.OnAWS
 {
     public class S3 : ILightMediaStorage
     {
-        public string Conection { get; set; }
+        public string Connection { get; set; }
         public string Container { get; set; }
 		public dynamic mediaStorageConfiguration { get; set; }