Cleaned up MSBuild targets and (re)added model persistence

C0nquistadore · C0nquistadore · commit 42f6fb4e9c46 · 2022-04-07T09:14:02.000+02:00
diff --git a/src/Dibix.Sdk.Cli/CodeGenerationTaskRunner.cs b/src/Dibix.Sdk.Cli/CodeGenerationTaskRunner.cs
@@ -15,14 +15,13 @@ protected override void Execute(InputConfiguration configuration)
               , projectDirectory: configuration.GetSingleValue<string>("ProjectDirectory")
               , productName: configuration.GetSingleValue<string>("ProductName")
               , areaName: configuration.GetSingleValue<string>("AreaName")
-              , outputName: configuration.GetSingleValue<string>("OutputName")
               , title: configuration.GetSingleValue<string>("Title")
               , version: configuration.GetSingleValue<string>("Version")
               , description: configuration.GetSingleValue<string>("Description")
               , baseUrl: configuration.GetSingleValue<string>("BaseUrl")
-              , defaultOutputFilePath: configuration.GetSingleValue<string>("DefaultOutputFilePath")
-              , endpointOutputFilePath: configuration.GetSingleValue<string>("EndpointOutputFilePath")
-              , clientOutputFilePath: configuration.GetSingleValue<string>("ClientOutputFilePath")
+              , outputDirectory: configuration.GetSingleValue<string>("OutputDirectory")
+              , defaultOutputName: configuration.GetSingleValue<string>("DefaultOutputName")
+              , clientOutputName: configuration.GetSingleValue<string>("ClientOutputName")
               , externalAssemblyReferenceDirectory: configuration.GetSingleValue<string>("ExternalAssemblyReferenceDir")
               , source: configuration.GetItems("Source")
               , contracts: configuration.GetItems("Contracts")
diff --git a/src/Dibix.Sdk.Cli/SqlCoreTaskRunner.cs b/src/Dibix.Sdk.Cli/SqlCoreTaskRunner.cs
@@ -16,13 +16,12 @@ protected override void Execute(InputConfiguration configuration)
               , resultsFile: configuration.GetSingleValue<string>("ResultsFile")
               , productName: configuration.GetSingleValue<string>("ProductName")
               , areaName: configuration.GetSingleValue<string>("AreaName")
-              , outputName: configuration.GetSingleValue<string>("OutputName")
               , title: configuration.GetSingleValue<string>("Title")
               , version: configuration.GetSingleValue<string>("Version")
               , description: configuration.GetSingleValue<string>("Description")
-              , defaultOutputFilePath: configuration.GetSingleValue<string>("DefaultOutputFilePath")
-              , endpointOutputFilePath: configuration.GetSingleValue<string>("EndpointOutputFilePath")
-              , clientOutputFilePath: configuration.GetSingleValue<string>("ClientOutputFilePath")
+              , outputDirectory: configuration.GetSingleValue<string>("OutputDirectory")
+              , defaultOutputName: configuration.GetSingleValue<string>("DefaultOutputName")
+              , clientOutputName: configuration.GetSingleValue<string>("ClientOutputName")
               , externalAssemblyReferenceDirectory: configuration.GetSingleValue<string>("ExternalAssemblyReferenceDir")
               , source: configuration.GetItems("Source")
               , scriptSource: configuration.GetItems("ScriptSource")
diff --git a/src/Dibix.Sdk/CodeGeneration/Model/CodeGenerationModel.cs b/src/Dibix.Sdk/CodeGeneration/Model/CodeGenerationModel.cs
@@ -12,9 +12,9 @@ public class CodeGenerationModel
         public string Title { get; set; }
         public string Version { get; set; }
         public string Description { get; set; }
-        public string DefaultOutputFilePath { get; set; }
-        public string EndpointOutputFilePath { get; set; }
-        public string ClientOutputFilePath { get; set; }
+        public string OutputDirectory { get; set; }
+        public string DefaultOutputName { get; set; }
+        public string ClientOutputName { get; set; }
         public EndpointConfiguration EndpointConfiguration { get; set; }
         public CommandTextFormatting CommandTextFormatting { get; set; }
         public ICollection<ContractDefinition> Contracts { get; }
diff --git a/src/Dibix.Sdk/CodeGeneration/Model/CodeGenerationModelLoader.cs b/src/Dibix.Sdk/CodeGeneration/Model/CodeGenerationModelLoader.cs
@@ -14,14 +14,13 @@ string projectName
           , string projectDirectory
           , string productName
           , string areaName
-          , string outputName
           , string title
           , string version
           , string description
           , EndpointConfiguration endpointConfiguration
-          , string defaultOutputFilePath
-          , string endpointOutputFilePath
-          , string clientOutputFilePath
+          , string outputDirectory
+          , string defaultOutputName
+          , string clientOutputName
           , string externalAssemblyReferenceDirectory
           , ICollection<TaskItem> source
           , IEnumerable<TaskItem> contracts
@@ -43,7 +42,7 @@ string projectName
         )
         {
             string rootNamespace = NamespaceUtility.BuildRootNamespace(productName, areaName);
-            string className = outputName.Replace(".", String.Empty);
+            string className = defaultOutputName.Replace(".", String.Empty);
 
             ICollection<string> normalizedSources = source.Select(x => x.GetFullPath()).ToArray();
             IEnumerable<string> normalizedContracts = contracts.Select(x => x.GetFullPath());
@@ -61,9 +60,9 @@ string projectName
                 EndpointConfiguration = endpointConfiguration,
                 RootNamespace = rootNamespace,
                 DefaultClassName = className,
-                DefaultOutputFilePath = defaultOutputFilePath,
-                EndpointOutputFilePath = endpointOutputFilePath,
-                ClientOutputFilePath = clientOutputFilePath,
+                OutputDirectory = outputDirectory,
+                DefaultOutputName = defaultOutputName,
+                ClientOutputName = clientOutputName,
                 EnableExperimentalFeatures = enableExperimentalFeatures
             };
 
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/ClientCodeArtifactGenerationUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/ClientCodeArtifactGenerationUnit.cs
@@ -4,8 +4,8 @@ namespace Dibix.Sdk.CodeGeneration
 {
     internal sealed class ClientCodeArtifactGenerationUnit : CodeArtifactGenerationUnit<ClientCodeGenerator>
     {
-        public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.ClientOutputFilePath);
-        protected override string GetOutputFilePath(CodeGenerationModel model) => model.ClientOutputFilePath;
+        public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.ClientOutputName);
+        protected override string GetOutputName(CodeGenerationModel model) => model.ClientOutputName;
         protected override ClientCodeGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger) => new ClientCodeGenerator(model, logger, schemaRegistry);
     }
 }
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/CodeArtifactGenerationUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/CodeArtifactGenerationUnit.cs
@@ -18,7 +18,7 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR
 
             if (!logger.HasLoggedErrors)
             {
-                string outputFilePath = this.GetOutputFilePath(model);
+                string outputFilePath = Path.Combine(model.OutputDirectory, $"{this.GetOutputName(model)}.cs");
                 File.WriteAllText(outputFilePath, generated);
                 return true;
             }
@@ -28,6 +28,6 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR
 
         protected abstract TGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger);
 
-        protected abstract string GetOutputFilePath(CodeGenerationModel model);
+        protected abstract string GetOutputName(CodeGenerationModel model);
     }
 }
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/CodeArtifactsGenerator.cs b/src/Dibix.Sdk/CodeGeneration/Output/CodeArtifactsGenerator.cs
@@ -10,6 +10,7 @@ internal sealed class CodeArtifactsGenerator : ICodeArtifactsGenerator
           , typeof(EndpointCodeArtifactGenerationUnit)
           , typeof(ClientCodeArtifactGenerationUnit)
           , typeof(OpenApiArtifactsGenerationUnit)
+          , typeof(PersistArtifactModelUnit)
         };
 
         public bool Generate(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger)
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/CodeGenerationTask.cs b/src/Dibix.Sdk/CodeGeneration/Output/CodeGenerationTask.cs
@@ -12,14 +12,13 @@ string projectName
           , string projectDirectory
           , string productName
           , string areaName
-          , string outputName
           , string title
           , string version
           , string description
           , string baseUrl
-          , string defaultOutputFilePath
-          , string endpointOutputFilePath
-          , string clientOutputFilePath
+          , string outputDirectory
+          , string defaultOutputName
+          , string clientOutputName
           , string externalAssemblyReferenceDirectory
           , ICollection<TaskItem> source
           , IEnumerable<TaskItem> contracts
@@ -46,14 +45,13 @@ string projectName
                   , projectDirectory
                   , productName
                   , areaName
-                  , outputName
                   , title
                   , version
                   , description
                   , new EndpointConfiguration(baseUrl)
-                  , defaultOutputFilePath
-                  , endpointOutputFilePath
-                  , clientOutputFilePath
+                  , outputDirectory
+                  , defaultOutputName
+                  , clientOutputName
                   , externalAssemblyReferenceDirectory
                   , source
                   , contracts
@@ -81,14 +79,13 @@ string projectName
           , string projectDirectory
           , string productName
           , string areaName
-          , string outputName
           , string title
           , string version
           , string description
           , EndpointConfiguration endpointConfiguration
-          , string defaultOutputFilePath
-          , string endpointOutputFilePath
-          , string clientOutputFilePath
+          , string outputDirectory
+          , string defaultOutputName
+          , string clientOutputName
           , string externalAssemblyReferenceDirectory
           , ICollection<TaskItem> source
           , IEnumerable<TaskItem> contracts
@@ -116,14 +113,13 @@ string projectName
               , projectDirectory
               , productName
               , areaName
-              , outputName
               , title
               , version
               , description
               , endpointConfiguration
-              , defaultOutputFilePath
-              , endpointOutputFilePath
-              , clientOutputFilePath
+              , outputDirectory
+              , defaultOutputName
+              , clientOutputName
               , externalAssemblyReferenceDirectory
               , source
               , contracts
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/EndpointCodeArtifactGenerationUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/EndpointCodeArtifactGenerationUnit.cs
@@ -1,11 +1,11 @@
-﻿using System;
+﻿using System.Linq;
 
 namespace Dibix.Sdk.CodeGeneration
 {
     internal sealed class EndpointCodeArtifactGenerationUnit : CodeArtifactGenerationUnit<EndpointCodeGenerator>
     {
-        public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.EndpointOutputFilePath);
-        protected override string GetOutputFilePath(CodeGenerationModel model) => model.EndpointOutputFilePath;
+        public override bool ShouldGenerate(CodeGenerationModel model) => model.Controllers.Any();
+        protected override string GetOutputName(CodeGenerationModel model) => model.AreaName;
         protected override EndpointCodeGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger) => new EndpointCodeGenerator(model, logger, schemaRegistry);
     }
 }
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/OpenApiArtifactsGenerationUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/OpenApiArtifactsGenerationUnit.cs
@@ -22,15 +22,13 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR
 
             OpenApiDocument document = OpenApiGenerator.Generate(model, schemaRegistry, logger);
 
-            string targetDirectory = Path.GetDirectoryName(model.DefaultOutputFilePath);
-
-            string jsonFilePath = BuildOutputPath(targetDirectory, model.AreaName, "json");
+            string jsonFilePath = BuildOutputPath(model.OutputDirectory, model.AreaName, "json");
             using (Stream stream = File.Open(jsonFilePath, FileMode.Create))
             {
                 document.SerializeAsJson(stream, OpenApiSpecVersion.OpenApi3_0);
             }
 
-            string yamlFilePath = BuildOutputPath(targetDirectory, model.AreaName, "yml");
+            string yamlFilePath = BuildOutputPath(model.OutputDirectory, model.AreaName, "yml");
             using (Stream stream = File.Open(yamlFilePath, FileMode.Create))
             {
                 document.SerializeAsYaml(stream, OpenApiSpecVersion.OpenApi3_0);
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/PersistArtifactModelUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/PersistArtifactModelUnit.cs
@@ -0,0 +1,24 @@
+﻿using System.IO;
+using System.Linq;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
+
+namespace Dibix.Sdk.CodeGeneration
+{
+    internal sealed class PersistArtifactModelUnit : CodeArtifactGenerationUnit
+    {
+        public override bool ShouldGenerate(CodeGenerationModel model) => !model.Controllers.Any(); // Only for non-leaf projects
+
+        public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger)
+        {
+            string jsonFilePath = Path.GetFullPath(Path.Combine(model.OutputDirectory, $"{model.DefaultOutputName}.Accessor.model.json"));
+            string serializedModelJson = JsonConvert.SerializeObject(model, new JsonSerializerSettings
+            {
+                Formatting = Formatting.Indented,
+                Converters = { new StringEnumConverter() }
+            });
+            File.WriteAllText(jsonFilePath, serializedModelJson);
+            return true;
+        }
+    }
+}
diff --git a/src/Dibix.Sdk/CodeGeneration/Output/ServerCodeArtifactGenerationUnit.cs b/src/Dibix.Sdk/CodeGeneration/Output/ServerCodeArtifactGenerationUnit.cs
@@ -1,11 +1,9 @@
-﻿using System;
-
-namespace Dibix.Sdk.CodeGeneration
+﻿namespace Dibix.Sdk.CodeGeneration
 {
     internal sealed class ServerCodeArtifactGenerationUnit : CodeArtifactGenerationUnit<ServerCodeGenerator>
     {
-        public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.DefaultOutputFilePath);
-        protected override string GetOutputFilePath(CodeGenerationModel model) => model.DefaultOutputFilePath;
+        public override bool ShouldGenerate(CodeGenerationModel model) => true;
+        protected override string GetOutputName(CodeGenerationModel model) => $"{model.DefaultOutputName}.Accessor";
         protected override ServerCodeGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger) => new ServerCodeGenerator(model, logger, schemaRegistry);
     }
 }
diff --git a/src/Dibix.Sdk/Tasks/SqlCoreTask.cs b/src/Dibix.Sdk/Tasks/SqlCoreTask.cs
@@ -17,13 +17,12 @@ string projectName
           , string resultsFile
           , string productName
           , string areaName
-          , string outputName
           , string title
           , string version
           , string description
-          , string defaultOutputFilePath
-          , string endpointOutputFilePath
-          , string clientOutputFilePath
+          , string outputDirectory
+          , string defaultOutputName
+          , string clientOutputName
           , string externalAssemblyReferenceDirectory
           , ICollection<TaskItem> source
           , IEnumerable<TaskItem> scriptSource
@@ -80,14 +79,13 @@ string projectName
                   , projectDirectory
                   , productName
                   , areaName
-                  , outputName
                   , title
                   , version
                   , description
                   , configuration.Endpoints
-                  , defaultOutputFilePath
-                  , endpointOutputFilePath
-                  , clientOutputFilePath
+                  , outputDirectory
+                  , defaultOutputName
+                  , clientOutputName
                   , externalAssemblyReferenceDirectory
                   , source
                   , contracts
diff --git a/src/Dibix.Sdk/targets/Dibix.Sdk.props b/src/Dibix.Sdk/targets/Dibix.Sdk.props
@@ -6,6 +6,7 @@
     <DibixSdkPath>$(DibixToolsDirectory)Dibix.Sdk.dll</DibixSdkPath>
     <DibixRuntimeDirectory>$(DibixToolsDirectory)</DibixRuntimeDirectory>
     <DibixConfigurationDirectory Condition="'$(DibixConfigurationDirectory)' == ''">$(MSBuildProjectDirectory)</DibixConfigurationDirectory>
+    <DibixTargetFramework Condition="'$(DibixTargetFramework)' == ''">net461</DibixTargetFramework>
     <DibixSdkVersion>$([System.IO.Path]::GetFileName($([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)..))))</DibixSdkVersion>
 
     <IsEmbedded>$(MSBuildProjectName.EndsWith('.DML'))</IsEmbedded>
diff --git a/src/Dibix.Sdk/targets/Dibix.Sdk.targets b/src/Dibix.Sdk/targets/Dibix.Sdk.targets
diff --git a/tests/Dibix.Sdk.Tests/CodeGeneration/CodeGenerationTaskTests.Base.cs b/tests/Dibix.Sdk.Tests/CodeGeneration/CodeGenerationTaskTests.Base.cs

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@ namespace Dibix.Sdk.CodeGeneration`
`4`	`4`	`{`
`5`	`5`	`internal sealed class ClientCodeArtifactGenerationUnit : CodeArtifactGenerationUnit<ClientCodeGenerator>`
`6`	`6`	`{`
`7`		`- public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.ClientOutputFilePath);`
`8`		`- protected override string GetOutputFilePath(CodeGenerationModel model) => model.ClientOutputFilePath;`
	`7`	`+ public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.ClientOutputName);`
	`8`	`+ protected override string GetOutputName(CodeGenerationModel model) => model.ClientOutputName;`
`9`	`9`	`protected override ClientCodeGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger) => new ClientCodeGenerator(model, logger, schemaRegistry);`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR`
`18`	`18`
`19`	`19`	`if (!logger.HasLoggedErrors)`
`20`	`20`	`{`
`21`		`- string outputFilePath = this.GetOutputFilePath(model);`
	`21`	`+ string outputFilePath = Path.Combine(model.OutputDirectory, $"{this.GetOutputName(model)}.cs");`
`22`	`22`	`File.WriteAllText(outputFilePath, generated);`
`23`	`23`	`return true;`
`24`	`24`	`}`
`@@ -28,6 +28,6 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR`
`28`	`28`
`29`	`29`	`protected abstract TGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger);`
`30`	`30`
`31`		`- protected abstract string GetOutputFilePath(CodeGenerationModel model);`
	`31`	`+ protected abstract string GetOutputName(CodeGenerationModel model);`
`32`	`32`	`}`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`		`-using System;`
	`1`	`+using System.Linq;`
`2`	`2`
`3`	`3`	`namespace Dibix.Sdk.CodeGeneration`
`4`	`4`	`{`
`5`	`5`	`internal sealed class EndpointCodeArtifactGenerationUnit : CodeArtifactGenerationUnit<EndpointCodeGenerator>`
`6`	`6`	`{`
`7`		`- public override bool ShouldGenerate(CodeGenerationModel model) => !String.IsNullOrEmpty(model.EndpointOutputFilePath);`
`8`		`- protected override string GetOutputFilePath(CodeGenerationModel model) => model.EndpointOutputFilePath;`
	`7`	`+ public override bool ShouldGenerate(CodeGenerationModel model) => model.Controllers.Any();`
	`8`	`+ protected override string GetOutputName(CodeGenerationModel model) => model.AreaName;`
`9`	`9`	`protected override EndpointCodeGenerator CreateGenerator(CodeGenerationModel model, ISchemaRegistry schemaRegistry, ILogger logger) => new EndpointCodeGenerator(model, logger, schemaRegistry);`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,13 @@ public override bool Generate(CodeGenerationModel model, ISchemaRegistry schemaR`
`22`	`22`
`23`	`23`	`OpenApiDocument document = OpenApiGenerator.Generate(model, schemaRegistry, logger);`
`24`	`24`
`25`		`- string targetDirectory = Path.GetDirectoryName(model.DefaultOutputFilePath);`
`26`		`-`
`27`		`- string jsonFilePath = BuildOutputPath(targetDirectory, model.AreaName, "json");`
	`25`	`+ string jsonFilePath = BuildOutputPath(model.OutputDirectory, model.AreaName, "json");`
`28`	`26`	`using (Stream stream = File.Open(jsonFilePath, FileMode.Create))`
`29`	`27`	`{`
`30`	`28`	`document.SerializeAsJson(stream, OpenApiSpecVersion.OpenApi3_0);`
`31`	`29`	`}`
`32`	`30`
`33`		`- string yamlFilePath = BuildOutputPath(targetDirectory, model.AreaName, "yml");`
	`31`	`+ string yamlFilePath = BuildOutputPath(model.OutputDirectory, model.AreaName, "yml");`
`34`	`32`	`using (Stream stream = File.Open(yamlFilePath, FileMode.Create))`
`35`	`33`	`{`
`36`	`34`	`document.SerializeAsYaml(stream, OpenApiSpecVersion.OpenApi3_0);`