Address design review feedback

Author: pilor

src/ResourceManager/PolicyInsights/Commands.PolicyInsights.Test/Commands.PolicyInsights.Test.Netcore.csproj

@@ -24,7 +24,7 @@
   </PropertyGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' != 'net472'">
-    <PackageReference Include="Microsoft.Azure.Management.PolicyInsights" Version="1.0.0" />
+    <PackageReference Include="Microsoft.Azure.Management.PolicyInsights" Version="2.0.0" />
   </ItemGroup>
 
   <ItemGroup>

src/ResourceManager/PolicyInsights/Commands.PolicyInsights.Test/ScenarioTests/RemediationTests.cs

@@ -57,5 +57,12 @@ public void ManagementGroupScopeCrud()
         {
             TestController.NewInstance.RunPowerShellTest(_logger, "Remediation-ManagementGroupScope-Crud");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void BackgroundJobs()
+        {
+            TestController.NewInstance.RunPowerShellTest(_logger, "Remediation-BackgroundJobs");
+        }
     }
 }

src/ResourceManager/PolicyInsights/Commands.PolicyInsights.Test/ScenarioTests/RemediationTests.ps1

@@ -22,7 +22,7 @@ function Remediation-SubscriptionScope-Crud
    $remediationName = "PSTestRemediation"
 
    # Create a new remediation
-   $remediation = New-AzureRmPolicyRemediation -PolicyAssignmentId $assignmentId -Name $remediationName -LocationFilter "westus2","west central us"
+   $remediation = Start-AzureRmPolicyRemediation -PolicyAssignmentId $assignmentId -Name $remediationName -LocationFilter "westus2","west central us"
    Validate-Remediation $remediation
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
    Assert-Null $remediation.PolicyDefinitionReferenceId
@@ -31,40 +31,40 @@ function Remediation-SubscriptionScope-Crud
    Assert-AreEqualArray $remediation.Filters.Locations @("westus2", "westcentralus")
    Assert-AreEqual 3 $remediation.DeploymentSummary.TotalDeployments
 
-   # Cancel the remediation
-   $remediation | Stop-AzureRmPolicyRemediation
+   # Cancel the remediation as a job so that we wait for cancellation to complete
+   $job = ($remediation | Stop-AzureRmPolicyRemediation -AsJob)
+   $job | Wait-Job
 
    # Get the remediation that was just cancelled
    $remediation = Get-AzureRmPolicyRemediation -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $remediationName $remediation.Name
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
-   Assert-True { $remediation.ProvisioningState -like "Cancel*" }
+   Assert-AreEqual "Canceled" $remediation.ProvisioningState
    Assert-AreEqual 2 $remediation.Filters.Locations.Count
    Assert-AreEqualArray $remediation.Filters.Locations @("westus2", "westcentralus")
    Assert-AreEqual 3 $remediation.DeploymentSummary.TotalDeployments
    Assert-AreEqual 0 $remediation.DeploymentSummary.FailedDeployments
 
-   # Get the deployments for the remediation via piping
-   $deployments = $remediation | Get-AzureRmPolicyRemediationDeployment
-   Assert-AreEqual 3 $deployments.Count
-   $acceptedStates = "Canceled", "NotStarted"
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation
+   $remediation = Get-AzureRmPolicyRemediation -Name $remediationName -IncludeDetail
+   Assert-AreEqual 3 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
-   # Get the deployments for the remediation without piping (+ top filter)
-   $deployments = Get-AzureRmPolicyRemediationDeployment -Name $remediationName -Top 2
-   Assert-AreEqual 2 $deployments.Count
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation with a Top filter
+   $remediation = Get-AzureRmPolicyRemediation -Name $remediationName -IncludeDetail -Top 2
+   Assert-AreEqual 2 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
    # Get all remediations in the subscription
    $remediations = Get-AzureRmPolicyRemediation
-   Assert-AreEqual 71 $remediations.Count
+   Assert-AreEqual 72 $remediations.Count
    Validate-Remediation $remediations[10]
 
    # Get a limited number of remediations
@@ -81,8 +81,8 @@ function Remediation-SubscriptionScope-Crud
    }
 
    # Delete the remediation that was created initially
-   $result = { $remediation | Remove-AzureRmPolicyRemediation -PassThru }
-   Assert-True $result
+   $result = ($remediation | Remove-AzureRmPolicyRemediation -PassThru)
+   Assert-AreEqual $true $result
 }
 
 <#
@@ -96,7 +96,7 @@ function Remediation-ResourceGroupScope-Crud
    $resourceGroupName = "elpere"
 
    # Create a new remediation
-   $remediation = New-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -PolicyAssignmentId $assignmentId -Name $remediationName
+   $remediation = Start-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -PolicyAssignmentId $assignmentId -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
    Assert-Null $remediation.PolicyDefinitionReferenceId
@@ -105,33 +105,32 @@ function Remediation-ResourceGroupScope-Crud
    Assert-AreEqual 5 $remediation.DeploymentSummary.TotalDeployments
 
    # Cancel the remediation
-   Stop-AzureRmPolicyRemediation -ResourceId $remediation.Id
+  Stop-AzureRmPolicyRemediation -ResourceId $remediation.Id
 
    # Get the remediation that was just cancelled
    $remediation = Get-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $remediationName $remediation.Name
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
-   Assert-True { $remediation.ProvisioningState -like "Cancel*" }
+   Assert-AreEqual "Canceled" $remediation.ProvisioningState
    Assert-Null $remediation.Filters
    Assert-AreEqual 5 $remediation.DeploymentSummary.TotalDeployments
    Assert-AreEqual 0 $remediation.DeploymentSummary.FailedDeployments
 
-   # Get the deployments for the remediation via piping
-   $deployments = $remediation | Get-AzureRmPolicyRemediationDeployment
-   Assert-AreEqual 5 $deployments.Count
-   $acceptedStates = "Canceled", "NotStarted"
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation
+   $remediation = Get-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -Name $remediationName -IncludeDetail
+   Assert-AreEqual 5 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
-   # Get the deployments for the remediation without piping (+ top filter)
-   $deployments = Get-AzureRmPolicyRemediationDeployment -ResourceGroupName $resourceGroupName -Name $remediationName -Top 2
-   Assert-AreEqual 2 $deployments.Count
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation (+ top filter)
+   $remediation = Get-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -Name $remediationName -IncludeDetail -Top 2
+   Assert-AreEqual 2 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
    # Get all remediations in the resource group
@@ -153,8 +152,8 @@ function Remediation-ResourceGroupScope-Crud
    }
 
    # Delete the remediation that was created initially
-   $result = { Remove-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -Name $remediationName -PassThru }
-   Assert-True $result
+   $result = (Remove-AzureRmPolicyRemediation -ResourceGroupName $resourceGroupName -Name $remediationName -PassThru)
+   Assert-AreEqual $true $result
 }
 
 <#
@@ -168,42 +167,42 @@ function Remediation-ResourceScope-Crud
    $scope = "/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/elpere/providers/Microsoft.KeyVault/vaults/elpereKv"
 
    # Create a new remediation
-   $remediation = New-AzureRmPolicyRemediation -Scope $scope -PolicyAssignmentId $assignmentId -Name $remediationName
+   $remediation = Start-AzureRmPolicyRemediation -Scope $scope -PolicyAssignmentId $assignmentId -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
    Assert-Null $remediation.PolicyDefinitionReferenceId
    Assert-AreEqual "Accepted" $remediation.ProvisioningState
    Assert-Null $remediation.Filters
    Assert-AreEqual 1 $remediation.DeploymentSummary.TotalDeployments
 
-   # Cancel the remediation
-   Stop-AzureRmPolicyRemediation -Scope $scope -Name $remediationName
+   # Cancel the remediation as a job so that we wait for cancellation to complete
+   $job = Stop-AzureRmPolicyRemediation -Scope $scope -Name $remediationName -AsJob
+   $job | Wait-Job
 
    # Get the remediation that was just cancelled
    $remediation = Get-AzureRmPolicyRemediation -Scope $scope -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $remediationName $remediation.Name
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
-   Assert-True { $remediation.ProvisioningState -like "Cancel*" }
+   Assert-AreEqual "Canceled" $remediation.ProvisioningState
    Assert-Null $remediation.Filters
    Assert-AreEqual 1 $remediation.DeploymentSummary.TotalDeployments
    Assert-AreEqual 0 $remediation.DeploymentSummary.FailedDeployments
 
-   # Get the deployments for the remediation via piping
-   $deployments = $remediation | Get-AzureRmPolicyRemediationDeployment
-   Assert-AreEqual 1 $deployments.Count
-   $acceptedStates = "Canceled", "NotStarted"
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation
+   $remediation = Get-AzureRmPolicyRemediation -Scope $scope -Name $remediationName -IncludeDetail
+   Assert-AreEqual 1 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
-   # Get the deployments for the remediation without piping (+ top filter)
-   $deployments = Get-AzureRmPolicyRemediationDeployment -Scope $scope -Name $remediationName -Top 2
-   Assert-AreEqual 1 $deployments.Count
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation (+ top filter)
+   $remediation = Get-AzureRmPolicyRemediation -Scope $scope -Name $remediationName -IncludeDetail -Top 2
+   Assert-AreEqual 1 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
    # Get all remediations underneath the resource
@@ -220,8 +219,8 @@ function Remediation-ResourceScope-Crud
    }
 
    # Delete the remediation that was created initially
-   $result = { Remove-AzureRmPolicyRemediation -Scope $scope -Name $remediationName -PassThru }
-   Assert-True $result
+   $result = (Remove-AzureRmPolicyRemediation -Scope $scope -Name $remediationName -PassThru)
+   Assert-AreEqual $true $result
 }
 
 <#
@@ -235,7 +234,7 @@ function Remediation-ManagementGroupScope-Crud
    $managementGroupId = "PolicyUIMG"
 
    # Create a new remediation
-   $remediation = New-AzureRmPolicyRemediation -ManagementGroupName $managementGroupId -PolicyAssignmentId $assignmentId -Name $remediationName
+   $remediation = Start-AzureRmPolicyRemediation -ManagementGroupName $managementGroupId -PolicyAssignmentId $assignmentId -Name $remediationName
    Validate-Remediation $remediation
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
    Assert-Null $remediation.PolicyDefinitionReferenceId
@@ -251,26 +250,25 @@ function Remediation-ManagementGroupScope-Crud
    Validate-Remediation $remediation
    Assert-AreEqual $remediationName $remediation.Name
    Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
-   Assert-True { $remediation.ProvisioningState -like "Cancel*" }
+   Assert-AreEqual "Canceled" $remediation.ProvisioningState
    Assert-Null $remediation.Filters
    Assert-AreEqual 1 $remediation.DeploymentSummary.TotalDeployments
    Assert-AreEqual 0 $remediation.DeploymentSummary.FailedDeployments
 
-   # Get the deployments for the remediation via piping
-   $deployments = $remediation | Get-AzureRmPolicyRemediationDeployment
-   Assert-AreEqual 1 $deployments.Count
-   $acceptedStates = "Canceled", "NotStarted"
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation
+   $remediation = Get-AzureRmPolicyRemediation -ManagementGroupName $managementGroupId -Name $remediationName -IncludeDetail
+   Assert-AreEqual 1 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
-   # Get the deployments for the remediation without piping (+ top filter)
-   $deployments = Get-AzureRmPolicyRemediationDeployment -ManagementGroupName $managementGroupId -Name $remediationName -Top 2
-   Assert-AreEqual 1 $deployments.Count
-   $deployments | ForEach-Object {
+   # Get the deployments for the remediation (+ top filter)
+   $remediation = Get-AzureRmPolicyRemediation -ManagementGroupName $managementGroupId -Name $remediationName -IncludeDetail -Top 2
+   Assert-AreEqual 1 $remediation.Deployments.Count
+   $remediation.Deployments | ForEach-Object {
       Validate-RemediationDeployment $_
-      Assert-True { $acceptedStates -contains $_.Status }
+      Assert-AreEqual "Canceled" $_.Status
    }
 
    # Get all remediations in the management group
@@ -292,6 +290,41 @@ function Remediation-ManagementGroupScope-Crud
    }
 
    # Delete the remediation that was created initially
-   $result = { Remove-AzureRmPolicyRemediation -ResourceId $remediation.Id -PassThru }
-   Assert-True $result
+   $result = (Remove-AzureRmPolicyRemediation -ResourceId $remediation.Id -PassThru)
+   Assert-AreEqual $true $result
+}
+
+<#
+.SYNOPSIS
+Perform remediation CRUD operations using background jobs
+#>
+function Remediation-BackgroundJobs {
+   $assignmentId = Get-TestRemediationSubscriptionPolicyAssignmentId
+   $remediationName = "PSTestRemediation"
+
+   # Create a new remediation as a job which will wait for it to complete
+   $job = Start-AzureRmPolicyRemediation -PolicyAssignmentId $assignmentId -Name $remediationName -LocationFilter "eastus2" -AsJob
+   $job | Wait-Job
+   Assert-AreEqual "Completed" $job.State
+   $remediation = $job | Receive-Job
+
+   Validate-Remediation $remediation
+   Assert-AreEqual $assignmentId $remediation.PolicyAssignmentId
+   Assert-Null $remediation.PolicyDefinitionReferenceId
+   Assert-AreEqual "Succeeded" $remediation.ProvisioningState
+   Assert-AreEqual 1 $remediation.Filters.Locations.Count
+   Assert-AreEqualArray $remediation.Filters.Locations @("eastus2")
+   Assert-AreEqual 1 $remediation.DeploymentSummary.TotalDeployments
+   Assert-AreEqual 1 $remediation.DeploymentSummary.SuccessfulDeployments
+   Assert-AreEqual 0 $remediation.DeploymentSummary.FailedDeployments
+
+   # Create the remediation again so we can remove/stop it in a job
+   $remediation = Start-AzureRmPolicyRemediation -PolicyAssignmentId $assignmentId -Name $remediationName -LocationFilter "eastus2"
+
+   # Remove and stop the remediation in one action as a background job
+   $job = ($remediation | Remove-AzureRmPolicyRemediation -AllowStop -PassThru -AsJob)
+   $job | Wait-Job
+   Assert-AreEqual "Completed" $job.State
+   $result = $job | Receive-Job
+   Assert-AreEqual $true $result
 }