From 71beac4bc5bcdd1b9b6c0e0071824662ca880043 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kurai=20Andr=C3=A1s?= <k.andras9642@gmail.com>
Date: Fri, 7 Jun 2024 11:34:31 +0200
Subject: [PATCH] Return -1 exit code when the document is not valid

---
 .../Handlers/ValidateCommandHandler.cs        |  4 +--
 src/Microsoft.OpenApi.Hidi/OpenApiService.cs  | 11 ++++++--
 .../Services/OpenApiServiceTests.cs           | 25 +++++++++++++++++++
 .../UtilityFiles/InvalidSampleOpenApi.yml     | 19 ++++++++++++++
 4 files changed, 55 insertions(+), 4 deletions(-)
 create mode 100644 test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/InvalidSampleOpenApi.yml

diff --git a/src/Microsoft.OpenApi.Hidi/Handlers/ValidateCommandHandler.cs b/src/Microsoft.OpenApi.Hidi/Handlers/ValidateCommandHandler.cs
index e0bfbf6b3..4c14cbef6 100644
--- a/src/Microsoft.OpenApi.Hidi/Handlers/ValidateCommandHandler.cs
+++ b/src/Microsoft.OpenApi.Hidi/Handlers/ValidateCommandHandler.cs
@@ -33,8 +33,8 @@ public async Task<int> InvokeAsync(InvocationContext context)
             try
             {
                 if (hidiOptions.OpenApi is null) throw new InvalidOperationException("OpenApi file is required");
-                await OpenApiService.ValidateOpenApiDocument(hidiOptions.OpenApi, logger, cancellationToken).ConfigureAwait(false);
-                return 0;
+                var isValid = await OpenApiService.ValidateOpenApiDocument(hidiOptions.OpenApi, logger, cancellationToken).ConfigureAwait(false);
+                return isValid is not false ? 0 : -1;
             }
 #if RELEASE
 #pragma warning disable CA1031 // Do not catch general exception types
diff --git a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
index f33fc61da..d3d3fdd8c 100644
--- a/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
+++ b/src/Microsoft.OpenApi.Hidi/OpenApiService.cs
@@ -322,7 +322,8 @@ private static MemoryStream ApplyFilterToCsdl(Stream csdlStream, string entitySe
         /// <summary>
         /// Implementation of the validate command
         /// </summary>
-        public static async Task ValidateOpenApiDocument(
+        /// <returns><see langword="true"/> when valid, <see langword="false"/> when invalid and <see langword="null"/> when cancelled</returns>
+        public static async Task<bool?> ValidateOpenApiDocument(
             string openApi,
             ILogger logger,
             CancellationToken cancellationToken = default)
@@ -332,11 +333,13 @@ public static async Task ValidateOpenApiDocument(
                 throw new ArgumentNullException(nameof(openApi));
             }
 
+            ReadResult? result = null;
+
             try
             {
                 using var stream = await GetStream(openApi, logger, cancellationToken).ConfigureAwait(false);
 
-                var result = await ParseOpenApi(openApi, false, logger, stream, cancellationToken).ConfigureAwait(false);
+                result = await ParseOpenApi(openApi, false, logger, stream, cancellationToken).ConfigureAwait(false);
 
                 using (logger.BeginScope("Calculating statistics"))
                 {
@@ -358,6 +361,10 @@ public static async Task ValidateOpenApiDocument(
             {
                 throw new InvalidOperationException($"Could not validate the document, reason: {ex.Message}", ex);
             }
+
+            if (result is null) return null;
+
+            return result.OpenApiDiagnostic.Errors.Count == 0;
         }
 
         private static async Task<ReadResult> ParseOpenApi(string openApiFile, bool inlineExternal, ILogger logger, Stream stream, CancellationToken cancellationToken = default)
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
index f7c5aab45..7314da8ab 100644
--- a/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
+++ b/test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs
@@ -203,6 +203,31 @@ public async Task ValidateCommandProcessesOpenApi()
             Assert.True(true);
         }
 
+        [Fact]
+        public async Task ValidFileReturnsTrue()
+        {
+            var isValid = await OpenApiService.ValidateOpenApiDocument(Path.Combine("UtilityFiles", "SampleOpenApi.yml"), _logger);
+
+            Assert.True(isValid);
+        }
+
+        [Fact]
+        public async Task InvalidFileReturnsFalse()
+        {
+            var isValid = await OpenApiService.ValidateOpenApiDocument(Path.Combine("UtilityFiles", "InvalidSampleOpenApi.yml"), _logger);
+
+            Assert.False(isValid);
+        }
+
+        [Fact]
+        public async Task CancellingValidationReturnsNull()
+        {
+            using var cts = new CancellationTokenSource();
+            await cts.CancelAsync();
+            var isValid = await OpenApiService.ValidateOpenApiDocument(Path.Combine("UtilityFiles", "SampleOpenApi.yml"), _logger, cts.Token);
+
+            Assert.Null(isValid);
+        }
 
         [Fact]
         public async Task TransformCommandConvertsOpenApi()
diff --git a/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/InvalidSampleOpenApi.yml b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/InvalidSampleOpenApi.yml
new file mode 100644
index 000000000..772214f5a
--- /dev/null
+++ b/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/InvalidSampleOpenApi.yml
@@ -0,0 +1,19 @@
+openapi: 3.0.0
+info:
+  title: Sample OpenApi
+  version: 1.0.0
+paths:
+  /api/editresource:
+    get:
+      operationId: api.ListEditresource
+    patch:
+      operationId: api.UpdateEditresource
+      responses:
+        '200':
+          description: OK
+  /api/viewresource:
+    get:
+      operationId: api.ListViewresource
+      responses:
+        '200':
+          description: OK
\ No newline at end of file