Add support for hook endpoint to Index model (#48)

* Add support for hook endpoint to Index model

* rename HookEnpoint -> CQCHookEndpoint

src/AVPRClient/Extensions.cs

@@ -136,7 +136,8 @@ this AVPRClient.ValidationPackage validationPackage
                 Microsoft.FSharp.Core.FSharpOption<bool>.None,
                 validationPackage.Authors.AsIndexType(),
                 validationPackage.Tags.AsIndexType(),
-                validationPackage.ReleaseNotes
+                validationPackage.ReleaseNotes,
+                Microsoft.FSharp.Core.FSharpOption<string>.None
             );
         }
     }

src/AVPRIndex/AVPRIndex.fsproj

@@ -16,7 +16,7 @@
     <RepositoryType>git</RepositoryType>
     <PackageReleaseNotes>$([System.IO.File]::ReadAllText("$(MSBuildProjectDirectory)/RELEASE_NOTES.md"))</PackageReleaseNotes>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <PackageVersion>0.1.0</PackageVersion>
+    <PackageVersion>0.1.1</PackageVersion>
   </PropertyGroup>
 
   <ItemGroup>

src/AVPRIndex/Domain.fs

@@ -106,6 +106,7 @@ module Domain =
         member val Authors: Author [] = Array.empty<Author> with get,set
         member val Tags: OntologyAnnotation [] = Array.empty<OntologyAnnotation> with get,set
         member val ReleaseNotes = "" with get,set
+        member val CQCHookEndpoint = "" with get,set
 
         override this.GetHashCode() =
             hash (
@@ -118,7 +119,8 @@ module Domain =
                 this.Publish,
                 this.Authors,
                 this.Tags,
-                this.ReleaseNotes
+                this.ReleaseNotes,
+                this.CQCHookEndpoint
             )
 
         override this.Equals(other) =
@@ -134,7 +136,8 @@ module Domain =
                     this.Publish,
                     this.Authors,
                     this.Tags,
-                    this.ReleaseNotes
+                    this.ReleaseNotes,
+                    this.CQCHookEndpoint
                 ) = (
                     vpm.Name, 
                     vpm.Summary, 
@@ -145,7 +148,8 @@ module Domain =
                     vpm.Publish,
                     vpm.Authors,
                     vpm.Tags,
-                    vpm.ReleaseNotes
+                    vpm.ReleaseNotes,
+                    vpm.CQCHookEndpoint
                 )
             | _ -> false
 
@@ -159,7 +163,8 @@ module Domain =
             ?Publish: bool,
             ?Authors: Author [],
             ?Tags: OntologyAnnotation [],
-            ?ReleaseNotes
+            ?ReleaseNotes,
+            ?CQCHookEndpoint
         ) = 
             let tmp = ValidationPackageMetadata(
                 Name = name,
@@ -174,6 +179,7 @@ module Domain =
             Authors |> Option.iter (fun x -> tmp.Authors <- x)
             Tags |> Option.iter (fun x -> tmp.Tags <- x)
             ReleaseNotes |> Option.iter (fun x -> tmp.ReleaseNotes <- x)
+            CQCHookEndpoint |> Option.iter (fun x -> tmp.CQCHookEndpoint <- x)
 
             tmp
 

src/AVPRIndex/RELEASE_NOTES.md

@@ -1,3 +1,7 @@
+## v0.1.1
+
+Add `CQCHookEndpoint` field to `ValidationPackageMetadata`
+
 ## v0.1.0
 
 Add support for in-package frontmatter bindings. Enables re-use of the frontmatter inside the package code

tests/IndexTests/DomainTests.fs

@@ -39,3 +39,47 @@ module OntologyAnnotation =
             TermAccessionNumber = "TAN"
         )
         Assert.Equivalent(OntologyAnnotation.allFields, actual)
+
+module ValidationPackageMetadata =
+
+    [<Fact>]
+    let ``create function for mandatory fields``() =
+        let actual = ValidationPackageMetadata.create(
+            name = "name",
+            summary = "summary" ,
+            description = "description" ,
+            majorVersion = 1,
+            minorVersion = 0,
+            patchVersion = 0
+        )
+        Assert.Equivalent(ValidationPackageMetadata.mandatoryFields, actual)
+
+    [<Fact>]
+    let ``create function for all fields``() =
+        let actual = ValidationPackageMetadata.create(
+            name = "name",
+            summary = "summary" ,
+            description = "description" ,
+            majorVersion = 1,
+            minorVersion = 0,
+            patchVersion = 0,
+            Publish = true,
+            Authors = [|
+                Author.create(
+                    fullName = "test", 
+                    Email = "[email protected]",
+                    Affiliation = "testaffiliation",
+                    AffiliationLink = "test.com"
+                )
+            |],
+            Tags = [|
+            OntologyAnnotation.create(
+                    name = "test",
+                    TermSourceREF = "REF",
+                    TermAccessionNumber = "TAN"
+                )
+            |],
+            ReleaseNotes = "releasenotes",
+            CQCHookEndpoint = "hookendpoint"
+        )
+        Assert.Equivalent(ValidationPackageMetadata.allFields, actual)

tests/IndexTests/ReferenceObjects.fs

@@ -28,6 +28,31 @@ module OntologyAnnotation =
         TermAccessionNumber = "TAN"
     )
 
+module ValidationPackageMetadata = 
+
+    let mandatoryFields = ValidationPackageMetadata(
+        Name = "name",
+        Summary = "summary" ,
+        Description = "description" ,
+        MajorVersion = 1,
+        MinorVersion = 0,
+        PatchVersion = 0
+    )
+
+    let allFields = ValidationPackageMetadata(
+        Name = "name",
+        Summary = "summary" ,
+        Description = "description" ,
+        MajorVersion = 1,
+        MinorVersion = 0,
+        PatchVersion = 0,
+        Publish = true,
+        Authors = [|Author.allFields|],
+        Tags = [|OntologyAnnotation.allFields|],
+        ReleaseNotes = "releasenotes",
+        CQCHookEndpoint = "hookendpoint"
+    )
+
 module Frontmatter = 
 
     module Comment =
@@ -89,6 +114,7 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 ---
 *)"""                                                                         .ReplaceLineEndings("\n")
 
@@ -121,6 +147,7 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 """                                                                         .ReplaceLineEndings("\n")
 
         let invalidStartFrontmatter = """(
@@ -232,6 +259,7 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 ---
 *)\"\"\""                                                                         .ReplaceLineEndings("\n")
 
@@ -264,6 +292,7 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 """                                                                         .ReplaceLineEndings("\n")
 
         let invalidStartFrontmatter = "let [<Literal>]PACKAGE_METADATA = \"\"\"
@@ -365,7 +394,8 @@ It does it very fast, it does it very swell.
             ReleaseNotes = """- initial release
   - does the thing
   - does it well
-""".ReplaceLineEndings("\n")
+""".ReplaceLineEndings("\n"),
+            CQCHookEndpoint = "https://hook.com"
         )
 
     let invalidMissingMandatoryFrontmatter = 

tests/IndexTests/fixtures/Frontmatter/Binding/valid@2.0.0.fsx

@@ -28,5 +28,6 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 ---
 *)"""

tests/IndexTests/fixtures/Frontmatter/Comment/valid@2.0.0.fsx

@@ -28,5 +28,6 @@ ReleaseNotes: |
   - initial release
     - does the thing
     - does it well
+CQCHookEndpoint: https://hook.com
 ---
 *)