Extend interfaces to support FileStorage DynamicsValue/fake-xrm-easy#157

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [2.6.0]
+
+### Added
+- 
+- Add new method to Initialize Files to support InMemory File Db - https://github.com/DynamicsValue/fake-xrm-easy/issues/157
+
 ## [2.5.0]
 
 ### Changed

src/FakeXrmEasy.Abstractions/FakeXrmEasy.Abstractions.csproj

@@ -7,7 +7,7 @@
     <TargetFrameworks Condition="'$(Configuration)'=='FAKE_XRM_EASY_2013'">net452</TargetFrameworks>
     <TargetFrameworks Condition="'$(Configuration)'=='FAKE_XRM_EASY'">net452</TargetFrameworks>
     <PackageId>FakeXrmEasy.Abstractions</PackageId>
-    <VersionPrefix>2.5.0</VersionPrefix>
+    <VersionPrefix>2.6.0</VersionPrefix>
     <Authors>Jordi Montaña</Authors>
     <Company>Dynamics Value</Company>
     <Title>FakeXrmEasy Abstractions</Title>

src/FakeXrmEasy.Abstractions/FileStorage/IFIleAttachment.cs

@@ -0,0 +1,40 @@
+using Microsoft.Xrm.Sdk;
+
+namespace FakeXrmEasy.Abstractions.FileStorage
+{
+    /// <summary>
+    /// Represents a file associated to an existing Dataverse record.
+    /// </summary>
+    public interface IFileAttachment
+    {
+        /// <summary>
+        /// The unique identifier of the file to be uploaded(i.e. the Guid of the fileattachment record)
+        /// </summary>
+        string Id { get; set; }
+
+        /// <summary>
+        /// The file name, including the file extension
+        /// </summary>
+        string FileName { get; set; }
+
+        /// <summary>
+        /// The file MIME type
+        /// </summary>
+        string MimeType { get; set; }
+
+        /// <summary>
+        /// The actual file contents as a byte array
+        /// </summary>
+        byte[] Content { get; set; }
+
+        /// <summary>
+        /// The associated record to which this file belongs
+        /// </summary>
+        EntityReference Target { get; set; }
+
+        /// <summary>
+        /// The logical name of the File or Image column / field of the Target EntityReference
+        /// </summary>
+        string AttributeName { get; set; }
+    }
+}

src/FakeXrmEasy.Abstractions/IXrmFakedContext.cs

@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using FakeXrmEasy.Abstractions.FileStorage;
 
 namespace FakeXrmEasy.Abstractions
 {
@@ -206,5 +207,11 @@ public interface IXrmFakedContext: IXrmBaseContext
         /// <param name="logicalName">The entity logical name of the entity</param>
         /// <returns>An early-bound record dif the context is already using early-bound entity records, a late bound entity otherwise</returns>
         Entity NewEntityRecord(string logicalName);
+
+        /// <summary>
+        /// Initializes the context with a given state of pre-existing file uploads
+        /// </summary>
+        /// <param name="files">The list of files used to initialised the In-Memory File Storage. InitializeMetadata and Initialize must have been called prior to calling this method.</param>
+        void InitializeFiles(IEnumerable<IFileAttachment> files);
     }
 }

tests/FakeXrmEasy.Abstractions.Tests/FakeXrmEasy.Abstractions.Tests.csproj

@@ -10,7 +10,7 @@
     <IsPackable>true</IsPackable>
 
     <PackageId>FakeXrmEasy.AbstractionsTests</PackageId>
-    <VersionPrefix>2.5.0</VersionPrefix>
+    <VersionPrefix>2.6.0</VersionPrefix>
     <Authors>Jordi Montaña</Authors>
     <Company>Dynamics Value S.L.</Company>
     <Title>FakeXrmEasy Abstractions Tests</Title>
@@ -28,6 +28,7 @@
   <ItemGroup>
     <None Include="../../LICENSE.txt" Pack="true" PackagePath="$(PackageLicenseFile)" />
     <None Include="../../FakeXrmEasyLogo_128x128.png" Pack="true" PackagePath="/" />
+    <None Remove="Plugins\**" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net462' And '$(Configuration)'=='FAKE_XRM_EASY_9'">
@@ -71,25 +72,28 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2011" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2011" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2013'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2013" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2013" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2015'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2015" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2015" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_2016'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v2016" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v2016" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_365'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v365" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v365" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup Condition="'$(PackTests)' == 'true' And '$(Configuration)'=='FAKE_XRM_EASY_9'">
-    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="2.5.0-*" />
+    <PackageReference Include="FakeXrmEasy.Abstractions.v9" Version="[2.6.0-*,3.0)" />
   </ItemGroup>
   <ItemGroup>
-    <Folder Include="Plugins\" />
+    <Compile Remove="Plugins\**" />
+  </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Remove="Plugins\**" />
   </ItemGroup>
 
 </Project>