Fix Start-AzAutomationDscCompilationJob (Issue #8347)

[lwajswaj]

This PR is a re-open of PR 8606. Regarding the last open question, I'm not sure if test cases can be written to cover both scenarios but I'm not good at writing them, maybe the core team can help me on that (@vladimir-shcherbakov).

CC: @MiYanni

Description

This PR fixed issue #8347; the root cause of this issue is a synchronous call to 'create' method which, when job gets suspended, it never releases control as the job hasn't completed. Not sure if this is by-design on the SDK or it's a bug. Using 'CreateAsync' fixes it but you cannot do a regular Wait() or GetWaiter() as the same behavior is repeated. Base on the documentation Compiling a DSC Configuration with Windows PowerShell, the original idea of this cmdlet seemed to be just starting the job but not waiting till it completed as it was the previous behavior. This PR changes Start-AzAutomationDscCompilationJob to just submit the compilation job but not waiting for its completion to return control, after this change this is how the usage looks like:

PS C:\Program Files\WindowsPowershellCore> Import-Module C:\Users\Leandro\Source\Repos\GitHub\lwajswaj\azure-powershell\artifacts\Debug\Az.Automation\Az.Automation.psd1
PS C:\Program Files\WindowsPowershellCore> Start-AzAutomationDscCompilationJob -ConfigurationName GoodConfig -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName>


ResourceGroupName      : <ResourceGroupName>
AutomationAccountName  : <AutomationAccountName>
Id                     : f6e2a35b-b076-4c98-b211-5975d5fa177e
CreationTime           : 22/02/2019 21:41:24 -03:00
Status                 : New
StatusDetails          : None
StartTime              :
EndTime                :
Exception              :
LastModifiedTime       : 22/02/2019 21:41:24 -03:00
LastStatusModifiedTime : 23/02/2019 00:41:24 +00:00
JobParameters          : {}
ConfigurationName      : GoodConfig



PS C:\Program Files\WindowsPowershellCore> Start-AzAutomationDscCompilationJob -ConfigurationName BadConfig -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName>


ResourceGroupName      : <ResourceGroupName>
AutomationAccountName  : <AutomationAccountName>
Id                     : f16827d2-3eab-4e1c-bbfc-673c6e4bf14c
CreationTime           : 22/02/2019 21:41:34 -03:00
Status                 : New
StatusDetails          : None
StartTime              :
EndTime                :
Exception              :
LastModifiedTime       : 22/02/2019 21:41:34 -03:00
LastStatusModifiedTime : 23/02/2019 00:41:34 +00:00
JobParameters          : {}
ConfigurationName      : BadConfig



PS C:\Program Files\WindowsPowershellCore> Get-AzAutomationDscCompilationJob -Id f16827d2-3eab-4e1c-bbfc-673c6e4bf14c -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName>


ResourceGroupName      : <ResourceGroupName>
AutomationAccountName  : <AutomationAccountName>
Id                     : f16827d2-3eab-4e1c-bbfc-673c6e4bf14c
CreationTime           : 22/02/2019 21:41:34 -03:00
Status                 : Suspended
StatusDetails          : None
StartTime              : 22/02/2019 21:42:11 -03:00
EndTime                :
Exception              : Exception calling "NewScriptBlock" with "1" argument(s): "At line:7 char:5
                         +     Import-DscResource -ModuleName 'PSDscResources12345'
                         +     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                         Could not find the module 'PSDscResources12345'." (At line:7 char:5
                         +     Import-DscResource -ModuleName 'PSDscResources12345'
                         +     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                         Could not find the module 'PSDscResources12345'.)
LastModifiedTime       : 22/02/2019 21:42:14 -03:00
LastStatusModifiedTime : 23/02/2019 00:42:14 +00:00
JobParameters          : {}
ConfigurationName      : BadConfig



PS C:\Program Files\WindowsPowershellCore> Get-AzAutomationDscCompilationJob -Id f6e2a35b-b076-4c98-b211-5975d5fa177e -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName>


ResourceGroupName      : <ResourceGroupName>
AutomationAccountName  : <AutomationAccountName>
Id                     : f6e2a35b-b076-4c98-b211-5975d5fa177e
CreationTime           : 22/02/2019 21:41:24 -03:00
Status                 : Completed
StatusDetails          : None
StartTime              : 22/02/2019 21:42:06 -03:00
EndTime                : 22/02/2019 21:42:15 -03:00
Exception              :
LastModifiedTime       : 22/02/2019 21:42:15 -03:00
LastStatusModifiedTime : 23/02/2019 00:42:15 +00:00
JobParameters          : {}
ConfigurationName      : GoodConfig

This PR introduces a behavior change in the cmdlet for which a breaking change warning has been included.

Checklist

• I have read the Submitting Changes section of CONTRIBUTING.md
• The title of the PR is clear and informative
• The appropriate change log has been updated
• The PR does not introduce breaking changes
• If applicable, the changes made in the PR have proper test coverage
• For public API changes to cmdlets:
  • the changes have gone through a cmdlet design review (Microsoft internal partners only)
  • the cmdlet markdown files were generated using the platyPS module

[markcowl]

Also, would really like a test for this, but we cna file an issue on the service team to do thsi if they can just sign off on this fix.

[markcowl]

@jemex @vrdmr can one of you sign off on this fix (once the requested change is made)

[markcowl]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[NarayanThiru]

Assigning to @avkaur as this fix is in DSC.

[avkaur]

approved from dsc service side

[markcowl]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[lwajswaj]

Not sure why, a few of my commits went away as I see the commits in my repo but not in the PR.... strange...

[lwajswaj]

That's the reason of my last "touch" commit; just made silly modification to the files so they get tracked again

[MiYanni]

@lwajswaj I believe the changes you are looking for were merged already as part of #9031.

[MiYanni]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[MiYanni]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

Review comments addressed and PR signed off by Automation.