Add PowerShellFormatter tests.

Author: peombwa

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs

@@ -347,7 +347,7 @@ private static void ValidateFilters(IDictionary<string, List<string>> requestUrl
                         Debug.WriteLine($"The url {url.Key} could not be found in the OpenApi description");
                         continue;
                     }
-                    operationTypes = GetOperationTypes(openApiOperations, url.Value, path);
+                    operationTypes.AddRange(GetOperationTypes(openApiOperations, url.Value, path));
                 }
             }
 
@@ -362,16 +362,10 @@ private static void ValidateFilters(IDictionary<string, List<string>> requestUrl
 
         private static List<string> GetOperationTypes(IDictionary<OperationType, OpenApiOperation> openApiOperations, List<string> url, string path)
         {
-            var operationTypes = new List<string>();
             // Add the available ops if they are in the postman collection. See path.Value
-            foreach (var ops in openApiOperations)
-            {
-                if (url.Contains(ops.Key.ToString().ToUpper()))
-                {
-                    operationTypes.Add(ops.Key + path);
-                }
-            }
-            return operationTypes;
+            return openApiOperations.Where(ops => url.Contains(ops.Key.ToString().ToUpper()))
+                            .Select(ops => ops.Key + path)
+                            .ToList();
         }
     }
 }

test/Microsoft.OpenApi.Hidi.Tests/Formatters/PowerShellFormatterTests.cs

@@ -0,0 +1,110 @@
+using Microsoft.OpenApi.Hidi.Formatters;
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Services;
+using Xunit;
+
+namespace Microsoft.OpenApi.Hidi.Tests.Formatters
+{
+    public class PowerShellFormatterTests
+    {
+        [Theory]
+        [InlineData("drives.drive.ListDrive", "drive_ListDrive", OperationType.Get)]
+        [InlineData("print.taskDefinitions.tasks.GetTrigger", "print.taskDefinition.task_GetTrigger", OperationType.Get)]
+        [InlineData("groups.sites.termStore.groups.GetSets", "group.site.termStore.group_GetSet", OperationType.Get)]
+        [InlineData("external.industryData.ListDataConnectors", "external.industryData_ListDataConnector", OperationType.Get)]
+        [InlineData("applications.application.UpdateLogo", "application_SetLogo", OperationType.Put)]
+        [InlineData("identityGovernance.lifecycleWorkflows.workflows.workflow.activate", "identityGovernance.lifecycleWorkflow.workflow_activate", OperationType.Post)]
+        [InlineData("directory.GetDeletedItems.AsApplication", "directory_GetDeletedItemAsApplication", OperationType.Get)]
+        [InlineData("education.users.GetCount-6be9", "education.user_GetCount", OperationType.Get)]
+        public void FormatOperationIdsInOpenAPIDocument(string operationId, string expectedOperationId, OperationType operationType, string path = "/foo")
+        {
+            // Arrange
+            var openApiDocument = new OpenApiDocument()
+            {
+                Info = new() { Title = "Test", Version = "1.0" },
+                Servers = new List<OpenApiServer>() { new() { Url = "https://localhost/" } },
+                Paths = new()
+                {
+                    { path, new() {
+                        Operations = new Dictionary<OperationType, OpenApiOperation>() {
+                            { operationType, new() { OperationId = operationId } }
+                          }
+                        }
+                    }
+                }
+            };
+
+            // Act
+            var powerShellFormatter = new PowerShellFormatter();
+            var walker = new OpenApiWalker(powerShellFormatter);
+            walker.Walk(openApiDocument);
+
+            // Assert
+            Assert.Equal(expectedOperationId, openApiDocument.Paths[path].Operations[operationType].OperationId);
+        }
+
+        public void RemoveAnyOfAndOneOfFromSchema()
+        {
+            // Arrange
+            var openApiDocument = new OpenApiDocument()
+            {
+                Info = new() { Title = "Test", Version = "1.0" },
+                Servers = new List<OpenApiServer>() { new() { Url = "https://localhost/" } },
+                Paths = new() { },
+                Components = new()
+                {
+                    Schemas = new Dictionary<string, OpenApiSchema>
+                    {
+                        { "TestSchema",  new OpenApiSchema
+                            {
+                                Type = "object",
+                                Properties = new Dictionary<string, OpenApiSchema>
+                                {
+                                    {
+                                        "averageAudioDegradation", new OpenApiSchema
+                                        {
+                                            AnyOf = new List<OpenApiSchema>
+                                            {
+                                                new OpenApiSchema { Type = "number" },
+                                                new OpenApiSchema { Type = "string" }
+                                            },
+                                            Format = "float",
+                                            Nullable = true
+                                        }
+                                    },
+                                    {
+                                        "defaultPrice", new OpenApiSchema
+                                        {
+                                            OneOf = new List<OpenApiSchema>
+                                            {
+                                                new OpenApiSchema { Type = "number", Format = "double" },
+                                                new OpenApiSchema { Type = "string" }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            };
+
+            // Act
+            var powerShellFormatter = new PowerShellFormatter();
+            var walker = new OpenApiWalker(powerShellFormatter);
+            walker.Walk(openApiDocument);
+
+            var averageAudioDegradationProperty = openApiDocument.Components.Schemas["TestSchema"].Properties["averageAudioDegradation"];
+            var defaultPriceProperty = openApiDocument.Components.Schemas["TestSchema"].Properties["defaultPrice"];
+
+            // Assert
+            Assert.Null(averageAudioDegradationProperty.AnyOf);
+            Assert.Equal("number", averageAudioDegradationProperty.Type);
+            Assert.Equal("float", averageAudioDegradationProperty.Format);
+            Assert.True(averageAudioDegradationProperty.Nullable);
+            Assert.Null(defaultPriceProperty.OneOf);
+            Assert.Equal("number", defaultPriceProperty.Type);
+            Assert.Equal("double", defaultPriceProperty.Format);
+        }
+    }
+}

test/Microsoft.OpenApi.Hidi.Tests/Microsoft.OpenApi.Hidi.Tests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
@@ -59,6 +59,9 @@
     <None Update="UtilityFiles\Todo.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+     <None Update="UtilityFiles\examplepowershellsettings.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
 </Project>

test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs

@@ -3,6 +3,7 @@
 
 using System.CommandLine;
 using System.CommandLine.Invocation;
+using System.CommandLine.Parsing;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Hidi.Options;
@@ -295,6 +296,28 @@ await Assert.ThrowsAsync<ArgumentException>(async () =>
 
         }
 
+        [Fact]
+        public async Task TransformToPowerShellCompliantOpenApi()
+        {
+            var settingsPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "UtilityFiles\\examplepowershellsettings.json");
+            HidiOptions options = new HidiOptions
+            {
+                OpenApi = "UtilityFiles\\SampleOpenApi.yml",
+                CleanOutput = true,
+                Version = "3.0",
+                OpenApiFormat = OpenApiFormat.Yaml,
+                TerseOutput = false,
+                InlineLocal = false,
+                InlineExternal = false,
+                SettingsConfig = SettingsUtilities.GetConfiguration(settingsPath)
+            };
+            // create a dummy ILogger instance for testing
+            await OpenApiService.TransformOpenApiDocument(options, _logger, new CancellationToken());
+
+            var output = File.ReadAllText("output.yml");
+            Assert.NotEmpty(output);
+        }
+
         [Fact]
         public void InvokeTransformCommand()
         {

test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/SampleOpenApi.yml

@@ -5,15 +5,18 @@ info:
 paths:
   /api/editresource:
     get:
+      operationId: api.ListEditresource
       responses:
         '200':
           description: OK
     patch:
+      operationId: api.UpdateEditresource
       responses:
         '200':
           description: OK
   /api/viewresource:
     get:
+      operationId: api.ListViewresource
       responses:
         '200':
           description: OK

test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/examplepowershellsettings.json

@@ -0,0 +1,22 @@
+{
+    "OpenApiConvertSettings": {
+      "AddSingleQuotesForStringParameters": true,
+      "AddEnumDescriptionExtension": true,
+      "EnableKeyAsSegment": true,
+      "EnableOperationId": true,
+      "PrefixEntityTypeNameBeforeKey": true,
+      "TagDepth": 2,
+      "EnablePagination": true,
+      "EnableDiscriminatorValue": false,
+      "EnableDerivedTypesReferencesForRequestBody": false,
+      "EnableDerivedTypesReferencesForResponses": false,
+      "ShowRootPath": false,
+      "ExpandDerivedTypesNavigationProperties": false,
+      "ShowLinks": false,
+      "DeclarePathParametersOnPathItem": false,
+      "EnableODataAnnotationReferencesForResponses": false,
+      "EnableODataTypeCast": true,
+      "UseSuccessStatusCodeRange": true
+    },
+    "LanguageFormat": "PowerShell"
+  }