feat(validation): validate concerto objects from dotnet using node (#29)

* feat(validate): add validation project Signed-off-by: Jamie Shorten <[email protected]> * feat(validation): call node to validate Signed-off-by: Jamie Shorten <[email protected]> * fix(ci): run webpack during build Signed-off-by: Jamie Shorten <[email protected]> * fix(tests): Add unit test for invalid model Signed-off-by: Jamie Shorten <[email protected]> * fix(build): use dotnet 6.0 Signed-off-by: Jamie Shorten <[email protected]> * fix(build): run npm ci Signed-off-by: Jamie Shorten <[email protected]> * fix(ci): fix github actions Signed-off-by: Jamie Shorten <[email protected]> * fix(ci): fix npm package resolution Signed-off-by: Jamie Shorten <[email protected]> * fix(ci): use c# 10.0 Signed-off-by: Jamie Shorten <[email protected]> * chore(ci): add node to publish action Signed-off-by: Jamie Shorten <[email protected]> * fix(tests): ensure sequential test runs Signed-off-by: Jamie Shorten <[email protected]> * chore(git): update gitignore Signed-off-by: Jamie Shorten <[email protected]> * chore: remove dist files Signed-off-by: Jamie Shorten <[email protected]> * chore(tests): serialise test execution Signed-off-by: Jamie Shorten <[email protected]> --------- Signed-off-by: Jamie Shorten <[email protected]>
accordproject · Jan 9, 2024 · d134f9b · d134f9b
1 parent aefea57
commit d134f9b
Show file tree

Hide file tree

Showing 30 changed files with 2,342 additions and 7 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,6 +12,7 @@ jobs:
 
     strategy:
       matrix:
+        node-version: [18.x, 20.x]
         dotnet-version: ['6.0.x' ]
         os:
           - ubuntu-latest
@@ -23,6 +24,11 @@ jobs:
     steps:
       - name: git checkout
         uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
 
       - name: Setup .NET Core SDK ${{ matrix.dotnet-version }}
         uses: actions/setup-dotnet@v2
@@ -32,6 +38,7 @@ jobs:
         run: |
           dotnet restore AccordProject.Concerto.sln
           dotnet restore ConcertoJsonConverter.sln
+          cd AccordProject.Concerto.Validate/concerto-validate && npm ci
       - name: Build
         run: |
           dotnet build AccordProject.Concerto.sln --configuration Release --no-restore

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -11,6 +11,7 @@ jobs:
 
     strategy:
       matrix:
+        node-version: [20.x]
         dotnet-version: ['6.0.x' ]
         os:
           - ubuntu-latest
@@ -31,6 +32,7 @@ jobs:
         run: |
           dotnet restore AccordProject.Concerto.sln
           dotnet restore ConcertoJsonConverter.sln
+          cd AccordProject.Concerto.Validate/concerto-validate && npm ci
       - name: Build
         run: |
           dotnet build AccordProject.Concerto.sln --configuration Release --no-restore

diff --git a/.gitignore b/.gitignore
@@ -288,6 +288,9 @@ FakesAssemblies/
 # Node.js Tools for Visual Studio
 .ntvs_analysis.dat
 node_modules/
+*/node_modules/
+*/dist/
+dist/
 
 # Visual Studio 6 build log
 *.plg

diff --git a/AccordProject.Concerto.Tests/AccordProject.Concerto.Tests.csproj b/AccordProject.Concerto.Tests/AccordProject.Concerto.Tests.csproj
@@ -10,14 +10,14 @@
 
   <ItemGroup>
     <PackageReference Include="ExpectedObjects" Version="3.5.4" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-    <PackageReference Include="xunit" Version="2.4.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    <PackageReference Include="xunit" Version="2.6.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.4">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="3.1.2">
+    <PackageReference Include="coverlet.collector" Version="6.0.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

diff --git a/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftDeserializeTests.cs b/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftDeserializeTests.cs
@@ -19,6 +19,7 @@ namespace AccordProject.Concerto.Tests;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
+[Collection("Sequential")]
 public class ConcertoConverterNewtonsoftDeserializeTests
 {
     [Fact]

diff --git a/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftMetamodel.cs b/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftMetamodel.cs
@@ -19,6 +19,7 @@ namespace AccordProject.Concerto.Tests;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
+[Collection("Sequential")]
 public class ConcertoConverterNewtonsoftMetamodelTests
 {
     [Fact]

diff --git a/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftSerializeTests.cs b/AccordProject.Concerto.Tests/ConcertoConverterNewtonsoftSerializeTests.cs
@@ -19,6 +19,7 @@ namespace AccordProject.Concerto.Tests;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
+[Collection("Sequential")]
 public class ConcertoConverterNewtonsoftSerializeTests
 {
     [Fact]

diff --git a/AccordProject.Concerto.Tests/ConcertoTypeDictionaryTests.cs b/AccordProject.Concerto.Tests/ConcertoTypeDictionaryTests.cs
@@ -18,6 +18,7 @@ namespace AccordProject.Concerto.Tests;
 using AccordProject.Concerto;
 using AccordProject.Concerto.Metamodel;
 
+[Collection("Sequential")]
 public class ConcertoTypeDictionaryTests
 {
     [Fact]

diff --git a/AccordProject.Concerto.Tests/ConcertoUtilsTests.cs b/AccordProject.Concerto.Tests/ConcertoUtilsTests.cs
@@ -17,6 +17,7 @@ namespace AccordProject.Concerto.Tests;
 using System;
 using AccordProject.Concerto;
 
+[Collection("Sequential")]
 public class ConcertoUtilsTests
 {
     [Fact]

diff --git a/AccordProject.Concerto.Validate.Tests/AccordProject.Concerto.Validate.Tests.csproj b/AccordProject.Concerto.Validate.Tests/AccordProject.Concerto.Validate.Tests.csproj
@@ -0,0 +1,57 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+
+    <IsPackable>false</IsPackable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
+    <PackageReference Include="xunit" Version="2.4.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="3.2.0">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.ClearScript.Complete" Version="7.4.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\AccordProject.Concerto.Validate\AccordProject.Concerto.Validate.csproj" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Remove="Fixtures\" />
+  </ItemGroup>
+  <ItemGroup>
+    <None Update="Fixtures\testModelAST.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Fixtures\testInstanceInvalid.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="Fixtures\testInstanceValid.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <Folder Include="Fixtures\" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Condition=" '$(EnableDefaultCompileItems)' == 'true' " Update="GlobalUsings.cs">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Compile>
+    <Compile Condition=" '$(EnableDefaultCompileItems)' == 'true' " Update="UnitTest1.cs">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Compile>
+    <Compile Condition=" '$(EnableDefaultCompileItems)' == 'true' " Update="ValidationTests.cs">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Compile>
+  </ItemGroup>
+</Project>
diff --git a/AccordProject.Concerto.Validate.Tests/Fixtures/testInstanceInvalid.json b/AccordProject.Concerto.Validate.Tests/Fixtures/testInstanceInvalid.json
@@ -0,0 +1,4 @@
+{
+  "$class": "[email protected]",
+  "value": 1
+}
diff --git a/AccordProject.Concerto.Validate.Tests/Fixtures/testInstanceValid.json b/AccordProject.Concerto.Validate.Tests/Fixtures/testInstanceValid.json
@@ -0,0 +1,4 @@
+{
+  "$class": "[email protected]",
+  "value": "Hello, World!"
+}
diff --git a/AccordProject.Concerto.Validate.Tests/Fixtures/testModelAST.json b/AccordProject.Concerto.Validate.Tests/Fixtures/testModelAST.json
@@ -0,0 +1,58 @@
+{
+  "$class": "[email protected]",
+  "decorators": [],
+  "namespace": "[email protected]",
+  "imports": [],
+  "declarations": [
+    {
+      "$class": "[email protected]",
+      "name": "Basic",
+      "isAbstract": false,
+      "properties": [
+        {
+          "$class": "[email protected]",
+          "name": "value",
+          "isArray": false,
+          "isOptional": false
+        }
+      ]
+    },
+    {
+      "$class": "[email protected]",
+      "name": "Thing",
+      "isAbstract": false,
+      "properties": [
+        {
+          "$class": "[email protected]",
+          "name": "id",
+          "isArray": false,
+          "isOptional": false
+        },
+        {
+          "$class": "[email protected]",
+          "name": "value",
+          "isArray": false,
+          "isOptional": false
+        }
+      ],
+      "identified": {
+        "$class": "[email protected]",
+        "name": "id"
+      }
+    },
+    {
+      "$class": "[email protected]",
+      "name": "Defaults",
+      "isAbstract": false,
+      "properties": [
+        {
+          "$class": "[email protected]",
+          "name": "value",
+          "isArray": false,
+          "isOptional": false,
+          "defaultValue": "Hello, World!"
+        }
+      ]
+    }
+  ]
+}
diff --git a/AccordProject.Concerto.Validate.Tests/GlobalUsings.cs b/AccordProject.Concerto.Validate.Tests/GlobalUsings.cs
@@ -0,0 +1 @@
+global using Xunit;
diff --git a/AccordProject.Concerto.Validate.Tests/ValidationTests.cs b/AccordProject.Concerto.Validate.Tests/ValidationTests.cs
@@ -0,0 +1,47 @@
+using Microsoft.ClearScript.V8;
+using AccordProject.Concerto.Validate;
+using Jering.Javascript.NodeJS;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace AccordProject.Concerto.Validate.Tests;
+
+public class ValidationTests
+{
+
+    [Fact]
+    public async void GivenValidModelWhenValidateCalledThenIsValidShouldBeTrue()
+    {
+
+        var model = File.ReadAllText("Fixtures/testModelAST.json");
+        var instance = File.ReadAllText("Fixtures/testInstanceValid.json");
+        var services = new ServiceCollection();
+        services.AddNodeJS();
+        ServiceProvider serviceProvider = services.BuildServiceProvider();
+        INodeJSService nodeJSService = serviceProvider.GetRequiredService<INodeJSService>();
+
+
+        var validator = new Validator(nodeJSService);
+        String[] models = { model };
+        var result =await validator.Validate(models, instance);
+        Assert.True(result.IsValid);
+    }
+
+    [Fact]
+    public async void GivenInvalidModelWhenValidateCalledThenIsValidShouldBeFalseAndMessageShouldBePresent()
+    {
+
+        var model = File.ReadAllText("Fixtures/testModelAST.json");
+        var instance = File.ReadAllText("Fixtures/testInstanceInvalid.json");
+        var services = new ServiceCollection();
+        services.AddNodeJS();
+        ServiceProvider serviceProvider = services.BuildServiceProvider();
+        INodeJSService nodeJSService = serviceProvider.GetRequiredService<INodeJSService>();
+
+
+        var validator = new Validator(nodeJSService);
+        String[] models = { model };
+        var result = await validator.Validate(models, instance);
+        Assert.False(result.IsValid);
+        Assert.NotEmpty(result.ErrorMessage);
+    }
+}
diff --git a/AccordProject.Concerto.Validate/AccordProject.Concerto.Validate.csproj b/AccordProject.Concerto.Validate/AccordProject.Concerto.Validate.csproj
@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <LangVersion>10.0</LangVersion>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <LangVersion>10.0</LangVersion>
+  </PropertyGroup>
+    <Target Name="WebPack" BeforeTargets="CoreCompile" DependsOnTargets="PrepareForBuild">
+        <Exec Command="npm run build" WorkingDirectory="./concerto-validate" />
+  </Target>
+  <ItemGroup>
+    <None Update="concerto-core.js">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="concerto-validate\dist\validate.js">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Jering.Javascript.NodeJS" Version="7.0.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+  </ItemGroup>
+</Project>
diff --git a/AccordProject.Concerto.Validate/Validator.cs b/AccordProject.Concerto.Validate/Validator.cs
@@ -0,0 +1,27 @@
+using System;
+using System.Threading.Tasks;
+using Jering.Javascript.NodeJS;
+using System.IO;
+using Newtonsoft.Json;
+
+namespace AccordProject.Concerto.Validate
+{
+    public class Validator
+    {
+        private INodeJSService nodeJSService { get; set; }
+        private string script { get; set;  } 
+        public Validator(INodeJSService nodeJSService) {
+            this.nodeJSService = nodeJSService;
+            this.script = File.ReadAllText("concerto-validate/dist/validate.js");
+        }
+
+        public async Task<ValidationResult> Validate(string[] modelJson, string instanceJson)
+        {
+            var models = "[" + string.Join(",\n", modelJson) + "]";
+            var args = new[] { models, instanceJson };
+            var cacheIdentifier = "validate";
+            return await nodeJSService.InvokeFromStringAsync<ValidationResult>(script, cacheIdentifier, "validateInstance", args);
+	    }
+    }
+}
+
diff --git a/AccordProject.Concerto.Validate/concerto-validate/.npmrc b/AccordProject.Concerto.Validate/concerto-validate/.npmrc
@@ -0,0 +1 @@
+registry = "https://registry.npmjs.com/"
diff --git a/AccordProject.Concerto.Validate/concerto-validate/ValidationResult.cs b/AccordProject.Concerto.Validate/concerto-validate/ValidationResult.cs
@@ -0,0 +1,12 @@
+using System;
+namespace AccordProject.Concerto.Validate
+{
+	public class ValidationResult
+	{
+		public string Instance { get; set; }
+		public string Id { get; set; }
+        public Boolean IsValid { get; set; }
+        public string ErrorMessage{ get; set; }
+	}
+}
+