Add BinaryContent module to AVPRIndex

nfdi4plants · Jun 19, 2024 · bfaa3e7 · bfaa3e7
1 parent d0183b6
commit bfaa3e7
Show file tree

Hide file tree

Showing 7 changed files with 273 additions and 115 deletions.
diff --git a/src/AVPRIndex/AVPRIndex.fsproj b/src/AVPRIndex/AVPRIndex.fsproj
@@ -16,14 +16,15 @@
     <RepositoryType>git</RepositoryType>
     <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/RELEASE_NOTES.md"))</PackageReleaseNotes>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <PackageVersion>0.1.2</PackageVersion>
+    <PackageVersion>0.1.3</PackageVersion>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="README.md" Pack="true" PackagePath="\" />
     <None Include="RELEASE_NOTES.md" />
     <Compile Include="Globals.fs" />
     <Compile Include="MD5Hash.fs" />
+    <Compile Include="BinaryContent.fs" />
     <Compile Include="Utils.fs" />
     <Compile Include="Domain.fs" />
     <Compile Include="Frontmatter.fs" />

diff --git a/src/AVPRIndex/BinaryContent.fs b/src/AVPRIndex/BinaryContent.fs
@@ -0,0 +1,20 @@
+namespace AVPRIndex
+
+open System
+open System.IO
+open System.Text
+open System.Security.Cryptography
+
+type BinaryContent = 
+
+    /// reads the content of the file at the given path and ensures that line endings are unified to `\n`
+    static member fromString (str: string) =
+        str.ReplaceLineEndings("\n")
+        |> Encoding.UTF8.GetBytes
+
+
+    /// reads the content of the file at the given path and ensures that line endings are unified to `\n`
+    static member fromFile (path: string) =
+        path 
+        |> File.ReadAllText
+        |> BinaryContent.fromString
diff --git a/src/AVPRIndex/RELEASE_NOTES.md b/src/AVPRIndex/RELEASE_NOTES.md
@@ -1,3 +1,7 @@
+## v0.1.3
+
+Add `BinaryContent` module to unify package content handling across downstream libraries
+
 ## v0.1.2
 
 Add `PackageContentHash` module to unify package hash calculation across downstream libraries

diff --git a/tests/IndexTests/BinaryContentTests.fs b/tests/IndexTests/BinaryContentTests.fs
@@ -0,0 +1,63 @@
+namespace BinaryContentTests
+
+open System
+open System.IO
+open System.Text
+open Xunit
+open AVPRIndex
+open AVPRIndex.Domain
+open ReferenceObjects
+
+module fromString =
+
+    [<Fact>]
+    let ``String with no line endings`` () =
+        let actual = BinaryContent.fromString BinaryContent.StringInput.noLineEndings
+        Assert.Equal<byte array>(BinaryContent.Content.noLineEndings, actual)
+
+    [<Fact>]
+    let ``String with CLRF`` () =
+        let actual = BinaryContent.fromString BinaryContent.StringInput.windowsLineEndings
+        Assert.Equal<byte array>(BinaryContent.Content.windowsLineEndings, actual)
+
+    [<Fact>]
+    let ``String with LF`` () =
+        let actual = BinaryContent.fromString BinaryContent.StringInput.unixLineEndings
+        Assert.Equal<byte array>(BinaryContent.Content.unixLineEndings, actual)
+
+    [<Fact>]
+    let ``String with mixed line endings`` () =
+        let actual = BinaryContent.fromString BinaryContent.StringInput.mixedLineEndings
+        Assert.Equal<byte array>(BinaryContent.Content.mixedLineEndings, actual)
+
+module fromFile =
+
+    [<Fact>]
+    let ``mandatory binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.BindingFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.BindingFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.BindingFrontmatter.invalidMissingMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``mandatory comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.CommentFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.CommentFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> BinaryContent.fromFile
+        Assert.Equal<byte array>(BinaryContent.Content.CommentFrontmatter.invalidMissingMandatoryFrontmatter, actual)
diff --git a/tests/IndexTests/HashTests.fs b/tests/IndexTests/HashTests.fs
@@ -9,120 +9,120 @@ open AVPRIndex.Domain
 open ReferenceObjects
 
 
-    module hashString =
+module hashString =
 
-        [<Fact>]
-        let ``String with no line endings`` () =
-            let actual = Hash.hashString Hash.Input.noLineEndings
-            Assert.Equal(Hash.Hashes.noLineEndings, actual)
+    [<Fact>]
+    let ``String with no line endings`` () =
+        let actual = Hash.hashString Hash.Input.noLineEndings
+        Assert.Equal(Hash.Hashes.noLineEndings, actual)
 
-        [<Fact>]
-        let ``String with CLRF`` () =
-            let actual = Hash.hashString Hash.Input.windowsLineEndings
-            Assert.Equal(Hash.Hashes.windowsLineEndings, actual)
+    [<Fact>]
+    let ``String with CLRF`` () =
+        let actual = Hash.hashString Hash.Input.windowsLineEndings
+        Assert.Equal(Hash.Hashes.windowsLineEndings, actual)
 
-        [<Fact>]
-        let ``String with LF`` () =
-            let actual = Hash.hashString Hash.Input.unixLineEndings
-            Assert.Equal(Hash.Hashes.unixLineEndings, actual)
+    [<Fact>]
+    let ``String with LF`` () =
+        let actual = Hash.hashString Hash.Input.unixLineEndings
+        Assert.Equal(Hash.Hashes.unixLineEndings, actual)
 
-        [<Fact>]
-        let ``String with mixed line endings`` () =
-            let actual = Hash.hashString Hash.Input.mixedLineEndings
-            Assert.Equal(Hash.Hashes.mixedLineEndings, actual)
+    [<Fact>]
+    let ``String with mixed line endings`` () =
+        let actual = Hash.hashString Hash.Input.mixedLineEndings
+        Assert.Equal(Hash.Hashes.mixedLineEndings, actual)
 
-    module hashContent =
+module hashContent =
 
-        [<Fact>]
-        let ``mandatory binding frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Binding/[email protected]"
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.validMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``full binding frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Binding/[email protected]" 
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.validFullFrontmatter, actual)
-
-        [<Fact>]
-        let ``invalid binding frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Binding/[email protected]"
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.invalidMissingMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``mandatory comment frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Comment/[email protected]"
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.validMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``full comment frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Comment/[email protected]"
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.validFullFrontmatter, actual)
-
-        [<Fact>]
-        let ``invalid comment frontmatter file`` () =
-            let actual = 
-                "fixtures/Frontmatter/Comment/[email protected]"
-                |> File.ReadAllText
-                |> fun s -> s.ReplaceLineEndings("\n")
-                |> Encoding.UTF8.GetBytes
-                |> Hash.hashContent
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.invalidMissingMandatoryFrontmatter, actual)
-
-    module hashFile =
+    [<Fact>]
+    let ``mandatory binding frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Binding/[email protected]"
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full binding frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Binding/[email protected]" 
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid binding frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Binding/[email protected]"
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.invalidMissingMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``mandatory comment frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Comment/[email protected]"
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full comment frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Comment/[email protected]"
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid comment frontmatter file`` () =
+        let actual = 
+            "fixtures/Frontmatter/Comment/[email protected]"
+            |> File.ReadAllText
+            |> fun s -> s.ReplaceLineEndings("\n")
+            |> Encoding.UTF8.GetBytes
+            |> Hash.hashContent
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.invalidMissingMandatoryFrontmatter, actual)
+
+module hashFile =
 
-        [<Fact>]
-        let ``mandatory binding frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.validMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``full binding frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.validFullFrontmatter, actual)
-
-        [<Fact>]
-        let ``invalid binding frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.BindingFrontmatter.invalidMissingMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``mandatory comment frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.validMandatoryFrontmatter, actual)
-
-        [<Fact>]
-        let ``full comment frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.validFullFrontmatter, actual)
-
-        [<Fact>]
-        let ``invalid comment frontmatter file`` () =
-            let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
-            Assert.Equal(Hash.Hashes.CommentFrontmatter.invalidMissingMandatoryFrontmatter, actual)
+    [<Fact>]
+    let ``mandatory binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid binding frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Binding/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.BindingFrontmatter.invalidMissingMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``mandatory comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.validMandatoryFrontmatter, actual)
+
+    [<Fact>]
+    let ``full comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.validFullFrontmatter, actual)
+
+    [<Fact>]
+    let ``invalid comment frontmatter file`` () =
+        let actual = "fixtures/Frontmatter/Comment/[email protected]" |> Hash.hashFile
+        Assert.Equal(Hash.Hashes.CommentFrontmatter.invalidMissingMandatoryFrontmatter, actual)
diff --git a/tests/IndexTests/IndexTests.fsproj b/tests/IndexTests/IndexTests.fsproj
@@ -14,6 +14,7 @@
     <Compile Include="Utils.fs" />
     <Compile Include="ReferenceObjects.fs" />
     <Compile Include="HashTests.fs" />
+    <Compile Include="BinaryContentTests.fs" />
     <Compile Include="DomainTests.fs" />
     <Compile Include="FrontmatterTests.fs" />
     <Compile Include="MetadataTests.fs" />
@@ -39,8 +40,4 @@
     <ProjectReference Include="..\..\src\AVPRIndex\AVPRIndex.fsproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="fixtures\Hashes\" />
-  </ItemGroup>
-
 </Project>