feat: Added initial endpoints generation.

tryAGI · Jan 7, 2024 · 3ab210e · 3ab210e
1 parent 43b3c3c
commit 3ab210e
Show file tree

Hide file tree

Showing 13 changed files with 175 additions and 18 deletions.
diff --git a/src/libs/OpenApiGenerator/Extensions.cs b/src/libs/OpenApiGenerator/Extensions.cs
@@ -18,7 +18,7 @@ public static OpenApiDocument GetOpenApiDocument(
 
         openApiDocument.Components ??= new OpenApiComponents();
         openApiDocument.Components.Schemas ??= new Dictionary<string, OpenApiSchema>();
-
+  
         return openApiDocument;
     }
 
@@ -73,6 +73,16 @@ public static string AsArray(this string type)
         return $"global::System.Collections.Generic.IList<{type}>";
     }
 
+    public static string? WithPostfix(this string? type, string postfix)
+    {
+        if (type == null)
+        {
+            return null;
+        }
+
+        return type + postfix;
+    }
+
     public static string? GetDefaultValue(this OpenApiSchema schema)
     {
         return schema.Default?.GetString();

diff --git a/src/libs/OpenApiGenerator/Generators/ClientGenerator.cs b/src/libs/OpenApiGenerator/Generators/ClientGenerator.cs
@@ -0,0 +1,69 @@
+using System.Collections.Immutable;
+using H.Generators.Extensions;
+using Microsoft.CodeAnalysis;
+using OpenApiGenerator.Models;
+
+namespace OpenApiGenerator.Generators;
+
+[Generator]
+public class ClientGenerator : IIncrementalGenerator
+{
+    #region Constants
+
+    private const string Id = "OACG";
+
+    #endregion
+
+    #region Methods
+
+    public void Initialize(IncrementalGeneratorInitializationContext context)
+    {
+        var settings = context.DetectSettings();
+
+        context.AdditionalTextsProvider
+            .Where(static text => text.Path.EndsWith(".yaml", StringComparison.InvariantCultureIgnoreCase))
+            .Combine(settings)
+            .SelectAndReportExceptions(PrepareData, context, Id)
+            .SelectMany(static (x, _) => x)
+            .SelectAndReportExceptions(GetSourceCode, context, Id)
+            .AddSource(context);
+    }
+
+    private static EquatableArray<EndPoint> PrepareData(
+        (AdditionalText text, Settings settings) tuple,
+        CancellationToken cancellationToken = default)
+    {
+        var (text, settings) = tuple;
+        if (settings.UseNSwag)
+        {
+            return ImmutableArray<EndPoint>.Empty;
+        }
+
+        var openApiDocument = text.GetOpenApiDocument(cancellationToken);
+
+        var includedOperationIds = new HashSet<string>(settings.IncludeOperationIds);
+
+        return openApiDocument.Paths.SelectMany(path =>
+            path.Value.Operations
+                .Where(x =>
+                    //includedOperationIds.Count == 0 ||
+                    includedOperationIds.Contains(x.Value.OperationId) ||
+                    includedOperationIds.Contains(x.Value.OperationId.ToPropertyName()))
+                .Select(operation => new EndPoint(
+                    Id: operation.Value.OperationId,
+                    Namespace: settings.Namespace,
+                    ClassName: settings.ClassName)))
+            .ToImmutableArray();
+    }
+
+    private static FileWithName GetSourceCode(
+        EndPoint endPoint,
+        CancellationToken cancellationToken = default)
+    {
+        return new FileWithName(
+            Name: $"{endPoint.FileNameWithoutExtension}.g.cs",
+            Text: Sources.GenerateEndPoint(endPoint, cancellationToken: cancellationToken));
+    }
+
+    #endregion
+}
diff --git a/src/libs/OpenApiGenerator/Generators/ModelGenerator.cs b/src/libs/OpenApiGenerator/Generators/ModelGenerator.cs
@@ -3,7 +3,7 @@
 using Microsoft.CodeAnalysis;
 using OpenApiGenerator.Models;
 
-namespace OpenApiGenerator;
+namespace OpenApiGenerator.Generators;
 
 [Generator]
 public class ModelGenerator : IIncrementalGenerator

diff --git a/src/libs/OpenApiGenerator/Generators/NSwagGenerator.cs b/src/libs/OpenApiGenerator/Generators/NSwagGenerator.cs
@@ -3,7 +3,7 @@
 using Microsoft.CodeAnalysis;
 using OpenApiGenerator.Models;
 
-namespace OpenApiGenerator;
+namespace OpenApiGenerator.Generators;
 
 [Generator]
 public class NSwagGenerator : IIncrementalGenerator

diff --git a/src/libs/OpenApiGenerator/Models/EndPoint.cs b/src/libs/OpenApiGenerator/Models/EndPoint.cs
@@ -0,0 +1,14 @@
+using H.Generators.Extensions;
+
+namespace OpenApiGenerator.Models;
+
+internal readonly record struct EndPoint(
+    string Id,
+    string Namespace,
+    string ClassName
+)
+{
+    public string MethodName => Id.ToPropertyName();
+
+    public string FileNameWithoutExtension => $"{Namespace}.{ClassName}.EndPoints.{MethodName}";
+}
diff --git a/src/libs/OpenApiGenerator/Models/Settings.cs b/src/libs/OpenApiGenerator/Models/Settings.cs
@@ -7,9 +7,12 @@ namespace OpenApiGenerator.Models;
 internal readonly record struct Settings(
     string TargetFramework,
     string Namespace,
+    string ClassName,
     NamingConvention NamingConvention,
     bool UseNSwag,
 
+    EquatableArray<string> IncludeOperationIds,
+
     bool GenerateModels,
     ModelStyle ModelStyle,
     EquatableArray<string> IncludeModels)
@@ -22,19 +25,26 @@ public static Settings FromOptions(
             TargetFramework: options.GetGlobalOption("TargetFramework", prefix) ??
                              options.GetGlobalOption("TargetFramework") ??
                              "netstandard2.0",
-            Namespace: options.GetGlobalOption("Namespace", prefix) ??
+            Namespace: options.GetGlobalOption(nameof(Namespace), prefix) ??
                        options.GetGlobalOption("PackageId") ??
                        options.GetGlobalOption("AssemblyName") ??
                        prefix,
+            ClassName: options.GetGlobalOption(nameof(ClassName), prefix) ??
+                       options.GetGlobalOption("PackageId")?.WithPostfix("Api") ??
+                       options.GetGlobalOption("AssemblyName")?.WithPostfix("Api") ??
+                       "Api",
             NamingConvention: Enum.TryParse<NamingConvention>(
                 options.GetGlobalOption(nameof(NamingConvention), prefix) ??
                 $"{default(NamingConvention):G}",
                 ignoreCase: true,
                 out var namingConvention) ? namingConvention : default,
             UseNSwag: bool.TryParse(
-                options.GetGlobalOption("UseNSwag", prefix),
+                options.GetGlobalOption(nameof(UseNSwag), prefix),
                 out var useNSwag) && useNSwag,
 
+            IncludeOperationIds: (options.GetGlobalOption(nameof(IncludeOperationIds), prefix)?.Split(';') ??
+                                   Array.Empty<string>()).ToImmutableArray(),
+
             GenerateModels: bool.TryParse(
                 options.GetGlobalOption(nameof(GenerateModels), prefix),
                 out var generateModels) && generateModels,

diff --git a/src/libs/OpenApiGenerator/OpenApiGenerator.props b/src/libs/OpenApiGenerator/OpenApiGenerator.props
@@ -16,10 +16,15 @@
     <CompilerVisibleProperty Include="OpenApiGenerator_TargetFramework"/>
     <!-- Namespace. Default: $(PackageId) or $(AssemblyName) or "OpenApiGenerator" -->
     <CompilerVisibleProperty Include="OpenApiGenerator_Namespace"/>
+    <!-- Namespace. Default: $(PackageId)Api or $(AssemblyName)Api or "Api" -->
+    <CompilerVisibleProperty Include="OpenApiGenerator_ClassName"/>
     <!-- InnerClasses/ConcatNames. Default: InnerClasses -->
     <CompilerVisibleProperty Include="OpenApiGenerator_NamingConvention"/>
     <!-- true/false. Default: false -->
     <CompilerVisibleProperty Include="OpenApiGenerator_UseNSwag"/>
+
+    <!-- List of ids separated by ;. Default: Empty(all models) -->
+    <CompilerVisibleProperty Include="OpenApiGenerator_IncludeOperationIds"/>
 
     <!-- true/false. Default: false -->
     <CompilerVisibleProperty Include="OpenApiGenerator_GenerateModels"/>

diff --git a/src/libs/OpenApiGenerator/Sources/Sources.EndPoints.cs b/src/libs/OpenApiGenerator/Sources/Sources.EndPoints.cs
@@ -0,0 +1,25 @@
+using H.Generators.Extensions;
+using OpenApiGenerator.Models;
+
+namespace OpenApiGenerator;
+
+internal static partial class Sources
+{
+    public static string GenerateEndPoint(
+        EndPoint endPoint,
+        CancellationToken cancellationToken = default)
+    {
+        return $@"
+#nullable enable
+
+namespace {endPoint.Namespace}
+{{
+    public partial class {endPoint.ClassName}
+    {{
+        public void {endPoint.MethodName}()
+        {{
+        }}
+    }}
+}}".RemoveBlankLinesWhereOnlyWhitespaces();
+    }
+}
diff --git a/src/tests/OpenApiGenerator.SnapshotTests/CustomAdditionalText.cs b/src/tests/OpenApiGenerator.SnapshotTests/CustomAdditionalText.cs
@@ -1,7 +1,7 @@
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Text;
 
-namespace H.Generators.IntegrationTests;
+namespace OpenApiGenerator.SnapshotTests;
 
 public class CustomAdditionalText(string path, string text) : AdditionalText
 {

diff --git a/src/tests/OpenApiGenerator.SnapshotTests/ModuleInitializer.cs b/src/tests/OpenApiGenerator.SnapshotTests/ModuleInitializer.cs
@@ -1,6 +1,6 @@
 using System.Runtime.CompilerServices;
 
-namespace H.Generators.IntegrationTests;
+namespace OpenApiGenerator.SnapshotTests;
 
 public static class ModuleInitializer
 {

diff --git a/...penApiGenerator.SnapshotTests/Snapshots/OpenAi/_#G.Api.EndPoints.ListModels.g.verified.cs b/...penApiGenerator.SnapshotTests/Snapshots/OpenAi/_#G.Api.EndPoints.ListModels.g.verified.cs
@@ -0,0 +1,13 @@
+//HintName: G.Api.EndPoints.ListModels.g.cs
+
+#nullable enable
+
+namespace G
+{
+    public partial class Api
+    {
+        public void ListModels()
+        {
+        }
+    }
+}
diff --git a/src/tests/OpenApiGenerator.SnapshotTests/Tests.Helpers.cs b/src/tests/OpenApiGenerator.SnapshotTests/Tests.Helpers.cs
@@ -6,7 +6,7 @@
 using Microsoft.CodeAnalysis.Testing;
 using OpenApiGenerator;
 
-namespace H.Generators.IntegrationTests;
+namespace OpenApiGenerator.SnapshotTests;
 
 [TestClass]
 public partial class Tests : VerifyBase
@@ -15,7 +15,8 @@ private async Task CheckSourceAsync<T>(
         AdditionalText[] additionalTexts,
         Dictionary<string, string>? globalOptions = null,
         [CallerMemberName] string? callerName = null,
-        CancellationToken cancellationToken = default)
+        CancellationToken cancellationToken = default,
+        params IIncrementalGenerator[] additionalGenerators)
         where T : IIncrementalGenerator, new()
     {
         globalOptions ??= new Dictionary<string, string>();
@@ -28,8 +29,11 @@ private async Task CheckSourceAsync<T>(
             references: references,
             options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));
         var generator = new T();
-        var driver = CSharpGeneratorDriver
-            .Create(generator)
+        var driver = CSharpGeneratorDriver.Create(
+            generators: new IIncrementalGenerator[] { generator }
+                .Concat(additionalGenerators)
+                .Select(GeneratorExtensions.AsSourceGenerator)
+                .ToArray())
             .AddAdditionalTexts(ImmutableArray.Create(additionalTexts))
             .WithUpdatedAnalyzerConfigOptions(new DictionaryAnalyzerConfigOptionsProvider(globalOptions))
             .RunGeneratorsAndUpdateCompilation(compilation, out compilation, out _, cancellationToken);

diff --git a/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs b/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs
@@ -2,9 +2,9 @@
 using Microsoft.OpenApi;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
-using OpenApiGenerator;
+using OpenApiGenerator.Generators;
 
-namespace H.Generators.IntegrationTests;
+namespace OpenApiGenerator.SnapshotTests;
 
 public partial class Tests
 {
@@ -53,7 +53,7 @@ public Task YamlWithLocalFileUseNSwag()
     {
         return CheckSourceAsync<NSwagGenerator>(new AdditionalText[]
         {
-            new CustomAdditionalText("openapi.yaml", Resources.ipinfo_yaml.AsString()),
+            new CustomAdditionalText("openapi.yaml", H.Resources.ipinfo_yaml.AsString()),
         }, new Dictionary<string, string>
         {
             ["build_property.OpenApiGenerator_UseNSwag"] = "true",
@@ -65,19 +65,24 @@ public Task OpenAi()
     {
         return CheckSourceAsync<ModelGenerator>(new AdditionalText[]
         {
-            new CustomAdditionalText(Resources.openai_yaml.FileName, Resources.openai_yaml.AsString()),
+            new CustomAdditionalText(
+                path: H.Resources.openai_yaml.FileName,
+                text: H.Resources.openai_yaml.AsString()),
         }, new Dictionary<string, string>
         {
+            ["build_property.OpenApiGenerator_IncludeOperationIds"] = "ListModels",
             ["build_property.OpenApiGenerator_IncludeModels"] = "Error;ErrorResponse;ListModelsResponse;Model;DeleteModelResponse;CreateCompletionRequest",
-        });
+        }, additionalGenerators: new IIncrementalGenerator[]{ new ClientGenerator() });
     }
 
     [TestMethod]
     public Task OpenAi_CreateCompletionResponse()
     {
         return CheckSourceAsync<ModelGenerator>(new AdditionalText[]
         {
-            new CustomAdditionalText(Resources.openai_yaml.FileName, Resources.openai_yaml.AsString()),
+            new CustomAdditionalText(
+                path: H.Resources.openai_yaml.FileName,
+                text: H.Resources.openai_yaml.AsString()),
         }, new Dictionary<string, string>
         {
             ["build_property.OpenApiGenerator_IncludeModels"] = "CreateCompletionResponse",
@@ -89,7 +94,9 @@ public Task YamlWithLocalFile()
     {
         return CheckSourceAsync<ModelGenerator>(new AdditionalText[]
         {
-            new CustomAdditionalText("openapi.yaml", Resources.ipinfo_yaml.AsString()),
+            new CustomAdditionalText(
+                path: "openapi.yaml",
+                text: H.Resources.ipinfo_yaml.AsString()),
         });
     }