Skip to content
This repository was archived by the owner on Sep 27, 2019. It is now read-only.

Write exceptions in generated commands #324

Merged
merged 8 commits into from
Sep 13, 2017
Merged

Write exceptions in generated commands #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
582e48b
Write exceptions in generated commands, some fixes for core CLR test
brywang-msft Sep 9, 2017
894feb9
Fix spacing
brywang-msft Sep 9, 2017
259d159
Fixes for PSCore test run (only expected failures remain)
brywang-msft Sep 12, 2017
98af424
PR comments
brywang-msft Sep 12, 2017
63b765f
Assume path of full powershell.exe
brywang-msft Sep 12, 2017
817681e
PR comments
brywang-msft Sep 12, 2017
d21cb3a
Fix paths
brywang-msft Sep 12, 2017
c958ca5
Fix paths
brywang-msft Sep 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions PSSwagger/PSSwagger.Constants.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ else {
`$ClrPath = Join-Path -Path `$PSScriptRoot -ChildPath 'ref' | Join-Path -ChildPath `$clr
$DynamicAssemblyGenerationCode
`$allDllsPath = Join-Path -Path `$ClrPath -ChildPath '*.dll'
Get-ChildItem -Path `$allDllsPath -File | ForEach-Object { Add-Type -Path `$_.FullName -ErrorAction SilentlyContinue }
if (Test-Path -Path `$ClrPath -PathType Container) {
Get-ChildItem -Path `$allDllsPath -File | ForEach-Object { Add-Type -Path `$_.FullName -ErrorAction SilentlyContinue }
}

. (Join-Path -Path `$PSScriptRoot -ChildPath 'New-ServiceClient.ps1')
. (Join-Path -Path `$PSScriptRoot -ChildPath 'GeneratedHelpers.ps1')
Expand Down Expand Up @@ -247,7 +249,21 @@ $getTaskResultBlock = @'
if(`$taskResult.IsFaulted)
{
Write-Verbose -Message 'Operation failed.'
Throw "`$(`$taskResult.Exception.InnerExceptions | Out-String)"
if (`$taskResult.Exception)
{
if ((Get-Member -InputObject `$taskResult.Exception -Name 'InnerExceptions') -and `$taskResult.Exception.InnerExceptions)
{
foreach (`$ex in `$taskResult.Exception.InnerExceptions)
{
Write-Error -Exception `$ex
}
} elseif ((Get-Member -InputObject `$taskResult.Exception -Name 'InnerException') -and `$taskResult.Exception.InnerException)
{
Write-Error -Exception `$taskResult.Exception.InnerException
} else {
Write-Error -Exception `$taskResult.Exception
}
}
}
elseif (`$taskResult.IsCanceled)
{
Expand Down
5 changes: 4 additions & 1 deletion PSSwagger/PSSwagger.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,6 +779,7 @@ function ConvertTo-CsharpCode
$tempCodeGenSettingsPath = ''
# Latest AutoRest inconsistently appends 'Client' to the specified infoName to generated the client name.
# We need to override the client name to ensure that generated PowerShell cmdlets work fine.
# Note: -ClientName doesn't seem to work for legacy invocation
$ClientName = $info['ClientTypeName']
try {
if ($info.ContainsKey('CodeGenFileRequired') -and $info.CodeGenFileRequired) {
Expand Down Expand Up @@ -833,7 +834,6 @@ function ConvertTo-CsharpCode

Write-Verbose -Message $LocalizedData.InvokingAutoRestWithParams
Write-Verbose -Message $($autoRestParams | Out-String)

$autorestMessages = & AutoRest $autoRestParams
if ($autorestMessages) {
Write-Verbose -Message $($autorestMessages | Out-String)
Expand Down Expand Up @@ -925,7 +925,9 @@ function ConvertTo-CsharpCode
$dependencies = Get-PSSwaggerExternalDependencies -Azure:$codeCreatedByAzureGenerator -Framework 'netstandard1'
$microsoftRestClientRuntimeAzureRequiredVersion = if ($dependencies.ContainsKey('Microsoft.Rest.ClientRuntime.Azure')) { $dependencies['Microsoft.Rest.ClientRuntime.Azure'].RequiredVersion } else { '' }

# In some cases, PSCore doesn't inherit this process's PSModulePath
$command = @"
`$env:PSModulePath = `"$env:PSModulePath`";
`$AddPSSwaggerClientType_params = @{
OutputAssemblyName = '$outAssembly'
ClrPath = '$clrPath'
Expand All @@ -936,6 +938,7 @@ function ConvertTo-CsharpCode
CodeCreatedByAzureGenerator = `$$codeCreatedByAzureGenerator
BootstrapConsent = `$$UserConsent
}
`$env:PSModulePath += ';$env:PSModulePath'
PSSwaggerUtility\Add-PSSwaggerClientType @AddPSSwaggerClientType_params
"@
$success = & "$PowerShellCorePath" -command "& {$command}"
Expand Down
19 changes: 12 additions & 7 deletions Tests/PSSwaggerScenario.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ Describe "Composite Swagger Tests" -Tag @('Composite','ScenarioTest') {

Import-Module $PsSwaggerPath -Force
if((Get-Variable -Name PSEdition -ErrorAction Ignore) -and ('Core' -eq $PSEdition)) {
& "powershell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
& "$env:SystemRoot\System32\WindowsPowerShell\v1.0\powershell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
Import-Module (Join-Path `"$PsSwaggerPath`" `"PSSwagger.psd1`") -Force -ArgumentList `$true;
New-PSSwaggerModule -SpecificationPath $SwaggerSpecPath -Name $ModuleName -UseAzureCsharpGenerator -Path $Path -NoAssembly -Verbose -ConfirmBootstrap;
}"
Expand All @@ -521,6 +521,11 @@ Describe "Composite Swagger Tests" -Tag @('Composite','ScenarioTest') {
}

$ModulePath = Join-Path -Path $Path -ChildPath $ModuleName
# Destroy the full and core CLR requirements so that AzureRM modules aren't required
# For now, composite swagger specs don't work without the -UseAzureCsharpGenerator flag because of AutoRest naming inconsistency
"" | Out-File -FilePath (Join-Path -Path $ModulePath -ChildPath "0.0.1" | Join-Path -ChildPath "Test-CoreRequirements.ps1")
"" | Out-File -FilePath (Join-Path -Path $ModulePath -ChildPath "0.0.1" | Join-Path -ChildPath "Test-FullRequirements.ps1")

Get-Module -ListAvailable -Name $ModulePath | Should BeOfType 'System.Management.Automation.PSModuleInfo'

# Import generated module
Expand Down Expand Up @@ -807,7 +812,7 @@ Describe "Header scenario tests" -Tag @('Header','ScenarioTest') {
$GeneratedModuleVersionPath = Join-Path -Path $GeneratedModuleBase -ChildPath $ModuleVersion
$Header = '__Custom_HEADER_Content__'
if((Get-Variable -Name PSEdition -ErrorAction Ignore) -and ('Core' -eq $PSEdition)) {
& "powershell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
& "$env:SystemRoot\System32\WindowsPowerShell\v1.0\PowerShell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
Import-Module '$PsSwaggerPath' -Force -ArgumentList `$true;
New-PSSwaggerModule -SpecificationPath '$SwaggerSpecPath' -Name $ModuleName -Version '$ModuleVersion' -UseAzureCsharpGenerator -Path '$GeneratedPath' -NoAssembly -Verbose -ConfirmBootstrap -Header '$Header';
}"
Expand All @@ -828,7 +833,7 @@ Describe "Header scenario tests" -Tag @('Header','ScenarioTest') {
$ModuleVersion = '2.2.2.2'
$GeneratedModuleVersionPath = Join-Path -Path $GeneratedModuleBase -ChildPath $ModuleVersion
if((Get-Variable -Name PSEdition -ErrorAction Ignore) -and ('Core' -eq $PSEdition)) {
& "powershell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
& "$env:SystemRoot\System32\WindowsPowerShell\v1.0\PowerShell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
Import-Module '$PsSwaggerPath' -Force -ArgumentList `$true;
New-PSSwaggerModule -SpecificationPath '$SwaggerSpecPath' -Name $ModuleName -Version '$ModuleVersion' -UseAzureCsharpGenerator -Path '$GeneratedPath' -NoAssembly -Verbose -ConfirmBootstrap;
}"
Expand Down Expand Up @@ -973,7 +978,7 @@ Describe "Pre-compiled SDK Assmebly scenario tests" -Tag @('SDKAssembly','Scenar
Verbose = $true
}
Invoke-NewPSSwaggerModuleCommand -NewPSSwaggerModuleParameters $NewPSSwaggerModule_params -ErrorVariable 'ev' -ErrorAction 'SilentlyContinue'
$ev.FullyQualifiedErrorId | Should Be 'AssemblyNotFound,New-PSSwaggerModule'
(Remove-TestErrorId -FullyQualifiedErrorId $ev.FullyQualifiedErrorId) | Should Be 'AssemblyNotFound,New-PSSwaggerModule'
}

It 'Should fail when client type name is not found in pre-compiled SDK assembly scenario' {
Expand All @@ -999,7 +1004,7 @@ Describe "Pre-compiled SDK Assmebly scenario tests" -Tag @('SDKAssembly','Scenar
Verbose = $true
}
Invoke-NewPSSwaggerModuleCommand -NewPSSwaggerModuleParameters $NewPSSwaggerModule_params -ErrorVariable 'ev' -ErrorAction 'SilentlyContinue'
$ev.FullyQualifiedErrorId | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
(Remove-TestErrorId -FullyQualifiedErrorId $ev.FullyQualifiedErrorId) | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
}

It 'Should fail when incorrect namespace in client type name is specified in pre-compiled SDK assembly scenario' {
Expand All @@ -1025,7 +1030,7 @@ Describe "Pre-compiled SDK Assmebly scenario tests" -Tag @('SDKAssembly','Scenar
Verbose = $true
}
Invoke-NewPSSwaggerModuleCommand -NewPSSwaggerModuleParameters $NewPSSwaggerModule_params -ErrorVariable 'ev' -ErrorAction 'SilentlyContinue'
$ev.FullyQualifiedErrorId | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
(Remove-TestErrorId -FullyQualifiedErrorId $ev.FullyQualifiedErrorId) | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
}

It 'Should fail when incorrect client type name is specified in pre-compiled SDK assembly scenario' {
Expand All @@ -1051,6 +1056,6 @@ Describe "Pre-compiled SDK Assmebly scenario tests" -Tag @('SDKAssembly','Scenar
Verbose = $true
}
Invoke-NewPSSwaggerModuleCommand -NewPSSwaggerModuleParameters $NewPSSwaggerModule_params -ErrorVariable 'ev' -ErrorAction 'SilentlyContinue'
$ev.FullyQualifiedErrorId | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
(Remove-TestErrorId -FullyQualifiedErrorId $ev.FullyQualifiedErrorId) | Should Be 'UnableToExtractDetailsFromSdkAssembly,Update-PathFunctionDetails'
}
}
69 changes: 64 additions & 5 deletions Tests/TestUtilities.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,76 @@ function Invoke-NewPSSwaggerModuleCommand {
elseif ($_.Value -ne $false) {
$ParametersString += " -$($_.Name) '$($_.Value)'"
}
}
& "powershell.exe" -command "& {
}
# For now this hides Exception and ErrorObject
$command = "& {
`$env:PSModulePath=`$env:PSModulePath_Backup;
New-PSSwaggerModule $ParametersString
New-PSSwaggerModule $ParametersString -ErrorVariable evtemp
foreach (`$ev in `$evtemp) {
`$returnEv = `$false
`$evEncoded = 'ErrorVariable: '
if (`$ev.FullyQualifiedErrorId) {
`$evEncoded += 'ErrorId='
`$evEncoded += `$ev.FullyQualifiedErrorId
`$evEncoded += ';'
`$returnEv = `$true
}

if (`$ev.CategoryInfo) {
`$evEncoded += 'ErrorCategory='
`$evEncoded += `$ev.CategoryInfo.Category
`$evEncoded += ';'
`$returnEv = `$true
}

if (`$returnEv) {
`$evEncoded
}
}
}"
$result = & "$env:SystemRoot\System32\WindowsPowerShell\v1.0\PowerShell.exe" -command $command
if ($PSBoundParameters.ContainsKey("ErrorVariable")) {
foreach ($resultLine in $result) {
if ($resultLine.StartsWith("ErrorVariable: ")) {
$errorVariableInfoTokenPairs = $resultLine.Substring(15).Split(';')
$errorId = ''
$errorCategory = ''
for ($i = 0; $i -lt $errorVariableInfoTokenPairs.Length; $i++) {
$errorVariableInfoTokens = $errorVariableInfoTokenPairs[$i].Split('=')
if ($errorVariableInfoTokens[0] -eq 'ErrorId') {
$errorId = $errorVariableInfoTokens[1]
} elseif ($errorVariableInfoTokens[0] -eq 'ErrorCategory') {
$errorCategory = $errorVariableInfoTokens[1]
}
}

Write-Error -Message 'New-PSSwaggerModule remote error' -ErrorId $errorId -Category $errorCategory
}
}
}
$result
Copy link
Contributor

@bmanikm bmanikm Sep 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this.
I was unable to validate for PSCore during my PR.

}
else {
New-PSSwaggerModule @NewPSSwaggerModuleParameters
}
}

function Remove-TestErrorId {
[CmdletBinding()]
param(
[string]$FullyQualifiedErrorId
)

$errorIds = $FullyQualifiedErrorId.Split(',')
$NewFullyQualifiedErrorId = ''
for ($i = 0; $i -lt $errorIds.Length; $i++) {
if ($errorIds[$i] -ne 'Invoke-NewPSSwaggerModuleCommand') {
$NewFullyQualifiedErrorId += "$($errorIds[$i]),"
}
}

return $NewFullyQualifiedErrorId.Substring(0, $NewFullyQualifiedErrorId.Length - 1)
}
function Initialize-Test {
[CmdletBinding()]
param(
Expand Down Expand Up @@ -132,9 +192,8 @@ function Initialize-Test {
# Module generation part needs to happen in full powershell
Write-Verbose "Generating module"
if((Get-Variable -Name PSEdition -ErrorAction Ignore) -and ('Core' -eq $PSEdition)) {
& "powershell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
& "$env:SystemRoot\System32\WindowsPowerShell\v1.0\PowerShell.exe" -command "& {`$env:PSModulePath=`$env:PSModulePath_Backup;
Import-Module (Join-Path `"$PsSwaggerPath`" `"PSSwagger.psd1`") -Force;
Import-Module (Join-Path `"$PsSwaggerPath`" `"PSSwaggerUtility`") -Force;
Initialize-PSSwaggerDependencies -AllFrameworks -AcceptBootstrap -Azure:`$$UseAzureCSharpGenerator;
New-PSSwaggerModule -SpecificationPath (Join-Path -Path `"$testCaseDataLocation`" -ChildPath $TestSpecFileName) -Path "$generatedModulesPath" -Name $GeneratedModuleName -Verbose -NoAssembly -UseAzureCSharpGenerator:`$$UseAzureCSharpGenerator -ConfirmBootstrap;
}"
Expand Down
8 changes: 6 additions & 2 deletions Tests/run-tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ if (-not $azureRmProfile) {
}

$powershellFolder = $null
$srcPath = Join-Path -Path $PSScriptRoot -ChildPath .. | Join-Path -ChildPath PSSwagger
$srcPath += [System.IO.Path]::DirectorySeparatorChar
$modulePath = Join-Path -Path $PSScriptRoot -ChildPath ..
$modulePath += [System.IO.Path]::DirectorySeparatorChar
if ("netstandard1.7" -eq $TestFramework) {
# beta > alpha
$powershellCore = Get-Package -Name PowerShell* -ProviderName msi | Sort-Object -Property Name -Descending | Select-Object -First 1 -ErrorAction Ignore
Expand All @@ -143,7 +147,7 @@ if ("netstandard1.7" -eq $TestFramework) {
}
$psVersion = $powershellCore.Name.Substring(11)
$powershellFolder = "$Env:ProgramFiles\PowerShell\$($psVersion)"
$executeTestsCommand += ";`$env:PSModulePath_Backup=`"$env:PSModulePath`""
$executeTestsCommand += ";`$env:PSModulePath_Backup=`"$srcPath;$modulePath;$env:PSModulePath`""
}

if ($EnableTracing) {
Expand All @@ -154,7 +158,7 @@ $srcPath = Join-Path -Path $PSScriptRoot -ChildPath .. | Join-Path -ChildPath PS
$srcPath += [System.IO.Path]::DirectorySeparatorChar
$executeTestsCommand += @"
;`$verbosepreference=`'continue`';
`$env:PSModulePath=`"$srcPath;`$env:PSModulePath`";
`$env:PSModulePath=`"$srcPath;$modulePath;`$env:PSModulePath`";
Invoke-Pester -Script `'$PSScriptRoot`' -ExcludeTag KnownIssue -OutputFormat NUnitXml -OutputFile ScenarioTestResults.xml -Verbose;
"@
# Set up Pester params
Expand Down