Add support for generating proper output type for the Swagger operations with x-ms-pageable extension (#342)

* Added support for generating proper output type for the Swaagger operations with x-ms-pageable extension.

Author: bmanikm

PSSwagger/Paths.psm1

@@ -561,7 +561,7 @@ function New-SwaggerPath
  $Cmdlet = ''
  $CmdletParameter = ''
  $CmdletArgs = ''
- $pageType = 'Array'
+ $pageType = ''
  $resultBlockStr = $resultBlockNoPaging
  if ($x_ms_pageableObject) {
  if ($x_ms_pageableObject.ReturnType -ne 'NONE') {
@@ -988,7 +988,13 @@ function New-SwaggerPath
  $bodyObject = $pathGenerationPhaseResult.BodyObject
 
  $body = $bodyObject.Body
- $outputTypeBlock = $bodyObject.OutputTypeBlock
+ if($pageType){
+ $fullPathDataType = $pageType
+ $outputTypeBlock = $executionContext.InvokeCommand.ExpandString($outputTypeStr)
+ }
+ else {
+ $outputTypeBlock = $bodyObject.OutputTypeBlock 
+ }
 
  if ($UseAzureCsharpGenerator) {
  $dependencyInitFunction = "Initialize-PSSwaggerDependencies -Azure"
@@ -1150,6 +1156,10 @@ function Set-ExtendedCodeMetadata {
  $returnType = $returnType.GenericTypeArguments[0]
  }
 
+ if (($returnType.Name -eq 'IPage`1') -and $returnType.GenericTypeArguments) {
+ $returnType = $returnType.GenericTypeArguments[0]
+ }
+ # Note: ReturnType is currently used for Swagger operations which supports x-ms-pageable.
  $returnTypeString = Convert-GenericTypeToString -Type $returnType
  $parameterSetDetail['ReturnType'] = $returnTypeString
 
@@ -1272,7 +1282,7 @@ function Convert-GenericTypeToString {
  )
 
  if (-not $Type.IsGenericType) {
- return $Type.FullName
+ return $Type.FullName.Trim('[]')
  }
 
  $genericTypeStr = ''

Tests/PSSwagger.Unit.Tests.ps1

@@ -269,17 +269,32 @@ Describe "PSSwagger Unit Tests" -Tag @('BVT', 'DRT', 'UnitTest', 'P0') {
  }
 
  Context "Get-CSharpModelName Unit Tests" {
- It "Get-CSharpModelNamee should remove special characters" {
+ It "Get-CSharpModelName should remove special characters" {
  Get-CSharpModelName -Name @"
  SomeTypeWithSpecialCharacters ~!@#$%^&*()_+|}{:"<>?,./;'][\=-``
 "@ | Should BeExactly 'SomeTypeWithSpecialCharacters'
  }
- It "Get-CSharpModelNamee should replace [] with Sequence" {
+ It "Get-CSharpModelName should replace [] with Sequence" {
  Get-CSharpModelName -Name 'foo[]' | Should BeExactly 'FooSequence'
  }
- It "Get-CSharpModelNamee should append 'Model' for C# reserved words" {
+ It "Get-CSharpModelName should append 'Model' for C# reserved words" {
  Get-CSharpModelName -Name 'break' | Should BeExactly 'BreakModel'
  }
  }
+
+ Context "Convert-GenericTypeToString Unit Tests" {
+ It "Convert-GenericTypeToString with 'System.Int32' type" {
+ Convert-GenericTypeToString -Type ('System.Int32' -as [type]) | Should BeExactly 'System.Int32'
+ }
+ It "Convert-GenericTypeToString with 'System.String[]' type" {
+ Convert-GenericTypeToString -Type ('System.String[]' -as [type]) | Should BeExactly 'System.String'
+ }
+ It "Convert-GenericTypeToString with 'System.Collections.Generic.List[string]' type" {
+ Convert-GenericTypeToString -Type ('System.Collections.Generic.List[string]' -as [type]) | Should BeExactly 'System.Collections.Generic.List[System.String]'
+ }
+ It "Convert-GenericTypeToString with 'System.Collections.Generic.Dictionary[string, string]' type" {
+ Convert-GenericTypeToString -Type ('System.Collections.Generic.Dictionary[string, string]' -as [type]) | Should BeExactly 'System.Collections.Generic.Dictionary[System.String,System.String]'
+ }
+ }
  }
 }

Tests/PSSwaggerScenario.Tests.ps1

@@ -245,16 +245,17 @@ Describe "Optional parameter tests" -Tag ScenarioTest {
 
 Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  BeforeAll {
+ $ModuleName = 'Generated.ParamTypes.Module' 
  Import-Module (Join-Path -Path $PSScriptRoot -ChildPath ".." | Join-Path -ChildPath "PSSwagger" | Join-Path -ChildPath "PSSwaggerUtility" | `
  Join-Path -ChildPath "PSSwaggerUtility.psd1") -Force
- Initialize-Test -GeneratedModuleName "Generated.ParamTypes.Module" -GeneratedModuleVersion "0.0.2" -TestApiName "ParameterTypes" `
+ Initialize-Test -GeneratedModuleName $ModuleName -GeneratedModuleVersion "0.0.2" -TestApiName "ParameterTypes" `
  -TestSpecFileName "ParameterTypesSpec.json" -TestDataFileName "ParameterTypesData.json" `
  -PsSwaggerPath (Join-Path -Path $PSScriptRoot -ChildPath ".." | Join-Path -ChildPath "PSSwagger") -TestRootPath $PSScriptRoot
 
  # Import generated module
  Write-Verbose "Importing modules"
  Import-Module (Join-Path -Path $PSScriptRoot -ChildPath "Generated" | `
- Join-Path -ChildPath "Generated.ParamTypes.Module")
+ Join-Path -ChildPath $ModuleName)
 
  $processes = Start-JsonServer -TestRootPath $PSScriptRoot -TestApiName "ParameterTypes"
  if ($global:PSSwaggerTest_EnableTracing -and $script:EnableTracer) {
@@ -325,7 +326,6 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 
  It "Test dummy definition references" {
- $ModuleName = 'Generated.ParamTypes.Module'
  $ev = $null
  $CommandList = Get-Command -Module $ModuleName -ErrorVariable ev
  $ev | Should BeNullOrEmpty
@@ -345,7 +345,6 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 
  It "Test CSharp reserved keywords as definition or type names" {
- $ModuleName = 'Generated.ParamTypes.Module'
  $ev = $null
  $CommandList = Get-Command -Module $ModuleName -ErrorVariable ev
  $ev | Should BeNullOrEmpty
@@ -375,7 +374,6 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 
  It "Test Definition commands 'New-<NestedDefinition>Object' for nested definitions" {
- $ModuleName = 'Generated.ParamTypes.Module'
  $ev = $null
  $CommandList = Get-Command -Module $ModuleName -ErrorVariable ev
  $ev | Should BeNullOrEmpty
@@ -400,7 +398,6 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 
  It 'Test parameter types with array of items in AdditionalProperties json schema' {
- $ModuleName = 'Generated.ParamTypes.Module'
  $ev = $null
  $null = Get-Command -Module $ModuleName -Syntax -ErrorVariable ev
  $ev | Should BeNullOrEmpty
@@ -413,8 +410,6 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 
  It 'Test parameter types with references to enum definition type' {
- $ModuleName = 'Generated.ParamTypes.Module'
-
  # Swagger operation command with parameter type reference to enum definition type
  $OperationCommandInfo = Get-Command -Name Get-PathWithEnumDefinitionType -Module $ModuleName
 
@@ -453,7 +448,7 @@ Describe "ParameterTypes tests" -Tag @('ParameterTypes','ScenarioTest') {
  }
 }
 
-Describe "AzureExtensions" {
+Describe "AzureExtensions" -Tag @('AzureExtension','ScenarioTest') {
  BeforeAll {
  Import-Module (Join-Path -Path $PSScriptRoot -ChildPath ".." | Join-Path -ChildPath "PSSwagger" | Join-Path -ChildPath "PSSwaggerUtility" | `
  Join-Path -ChildPath "PSSwaggerUtility.psd1") -Force
@@ -1118,3 +1113,32 @@ Describe "Pre-compiled SDK Assmebly scenario tests" -Tag @('SDKAssembly','Scenar
  (Remove-TestErrorId -FullyQualifiedErrorId $ev.FullyQualifiedErrorId) | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
  }
 }
+
+Describe "Output type scenario tests" -Tag @('OutputType','ScenarioTest') {
+ BeforeAll {
+ $ModuleName = 'Generated.AzExt.OutputType.Module'
+ $SwaggerSpecPath = Join-Path -Path $PSScriptRoot -ChildPath 'Data' | Join-Path -ChildPath 'AzureExtensions' | Join-Path -ChildPath 'AzureExtensionsSpec.json'
+ $GeneratedPath = Join-Path -Path $PSScriptRoot -ChildPath 'Generated'
+ $GeneratedModuleBase = Join-Path -Path $GeneratedPath -ChildPath $ModuleName
+ if (Test-Path -Path $GeneratedModuleBase -PathType Container) {
+ Remove-Item -Path $GeneratedModuleBase -Recurse -Force
+ }
+
+ $params = @{
+ SpecificationPath = $SwaggerSpecPath
+ Name = $ModuleName
+ UseAzureCsharpGenerator = $true
+ Path = $GeneratedPath
+ ConfirmBootstrap = $true
+ Verbose = $true
+ }
+ Invoke-NewPSSwaggerModuleCommand -NewPSSwaggerModuleParameters $params
+
+ Import-Module $GeneratedModuleBase -Force
+ }
+
+ It 'Test output type of swagger operation which supports x-ms-pageable' {
+ $CommandInfo = Get-Command -Name Get-IotHubResourceEventHubConsumerGroup -Module $ModuleName
+ $CommandInfo.OutputType.Type.ToString() | Should BeExactly 'System.String'
+ }
+}

Tests/data/AzureExtensions/AzureExtensionsSpec.json

@@ -449,6 +449,69 @@
  }
  }
  }
+ },
+ "/PathWithPagingResult": {
+ "get": {
+ "tags": [
+ "GET"
+ ],
+ "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.",
+ "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.",
+ "operationId": "IotHubResource_ListEventHubConsumerGroups",
+ "parameters": [
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/SubscriptionIdParameter"
+ },
+ {
+ "name": "resourceGroupName",
+ "description": "The name of the resource group that contains the IoT hub.",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resourceName",
+ "in": "path",
+ "description": "The name of the IoT hub.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "eventHubEndpointName",
+ "in": "path",
+ "description": "The name of the Event Hub-compatible endpoint.",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub",
+ "schema": {
+ "$ref": "#/definitions/EventHubConsumerGroupsListResult"
+ }
+ },
+ "default": {
+ "description": "DefaultErrorResponse",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ },
+ "deprecated": false,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ },
+ "produces": [
+ "application/json"
+ ],
+ "consumes": [
+ "application/json"
+ ]
+ }
  }
  },
  "x-ms-paths": {
@@ -672,6 +735,24 @@
  "description": "Message"
  }
  }
+ },
+ "EventHubConsumerGroupsListResult": {
+ "description": "The JSON-serialized array of Event Hub-compatible consumer group names with a next link.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The array of Event Hub-compatible consumer group names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "nextLink": {
+ "description": "The next link.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
  }
  },
  "parameters": {