Remediation cmdlets + tests

Author: pilor

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

@@ -41,14 +41,15 @@
     <CodeAnalysisIgnoreBuiltInRules>true</CodeAnalysisIgnoreBuiltInRules>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="Microsoft.Azure.Management.PolicyInsights, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
+    <Reference Include="Microsoft.Azure.Management.PolicyInsights, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\..\packages\Microsoft.Azure.Management.PolicyInsights.1.0.0\lib\net452\Microsoft.Azure.Management.PolicyInsights.dll</HintPath>
+      <HintPath>..\..\..\packages\Microsoft.Azure.Management.PolicyInsights.2.0.0\lib\net452\Microsoft.Azure.Management.PolicyInsights.dll</HintPath>
       <Private>True</Private>
     </Reference>
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="ScenarioTests\RemediationTests.cs" />
     <Compile Include="ScenarioTests\QueryOptionTests.cs" />
     <Compile Include="ScenarioTests\PolicyStateTests.cs" />
     <Compile Include="ScenarioTests\PolicyStateSummaryTests.cs" />
@@ -69,6 +70,9 @@
     <None Include="ScenarioTests\Common.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="ScenarioTests\RemediationTests.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="ScenarioTests\PolicyStateSummaryTests.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
@@ -198,6 +202,9 @@
     <None Include="SessionRecords\Microsoft.Azure.Commands.PolicyInsights.Test.ScenarioTests.QueryOptionTests\QueryResultsWithTop.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="SessionRecords\Microsoft.Azure.Commands.PolicyInsights.Test.ScenarioTests.RemediationTests\*.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
   <ItemGroup>
     <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />

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

@@ -18,7 +18,7 @@ Gets test management group name
 #>
 function Get-TestManagementGroupName
 {
-	"azgovtest4"
+   "azgovtest4"
 }
 
 <#
@@ -27,7 +27,7 @@ Gets test resource group group name
 #>
 function Get-TestResourceGroupName
 {
-	"bulenttestrg"
+   "bulenttestrg"
 }
 
 <#
@@ -36,7 +36,7 @@ Gets test resource id
 #>
 function Get-TestResourceId
 {
-	"/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourcegroups/govintpolicyrp/providers/microsoft.network/trafficmanagerprofiles/gov-int-policy-rp"
+   "/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourcegroups/govintpolicyrp/providers/microsoft.network/trafficmanagerprofiles/gov-int-policy-rp"
 }
 
 <#
@@ -45,7 +45,7 @@ Gets test policy set definition name
 #>
 function Get-TestPolicySetDefinitionName
 {
-	"12b58873-e0f8-4b95-936c-86cbe7c9d697"
+   "12b58873-e0f8-4b95-936c-86cbe7c9d697"
 }
 
 <#
@@ -54,7 +54,7 @@ Gets test policy definition name
 #>
 function Get-TestPolicyDefinitionName
 {
-	"24813039-7534-408a-9842-eb99f45721b1"
+   "24813039-7534-408a-9842-eb99f45721b1"
 }
 
 <#
@@ -63,7 +63,7 @@ Gets test policy assignment name
 #>
 function Get-TestPolicyAssignmentName
 {
-	"45ab2ab7898d45ebb3087573"
+   "45ab2ab7898d45ebb3087573"
 }
 
 <#
@@ -72,7 +72,7 @@ Gets test resource group group name for resource group level policy assignment (
 #>
 function Get-TestResourceGroupNameForPolicyAssignmentEvents
 {
-	"jilimpolicytest2"
+   "jilimpolicytest2"
 }
 
 <#
@@ -81,7 +81,7 @@ Gets test policy assignment name (resource group level) (for event tests)
 #>
 function Get-TestPolicyAssignmentNameResourceGroupLevelEvents
 {
-	"e9860612d8ec4a469f59af06"
+   "e9860612d8ec4a469f59af06"
 }
 
 <#
@@ -90,7 +90,7 @@ Gets test resource group group name for resource group level policy assignment (
 #>
 function Get-TestResourceGroupNameForPolicyAssignmentStates
 {
-	"bulenttestrg"
+   "bulenttestrg"
 }
 
 <#
@@ -99,7 +99,7 @@ Gets test policy assignment name (resource group level) (for state tests)
 #>
 function Get-TestPolicyAssignmentNameResourceGroupLevelStates
 {
-	"f4d1645d-9180-4968-99df-17234d0f7019"
+   "f4d1645d-9180-4968-99df-17234d0f7019"
 }
 
 <#
@@ -108,7 +108,7 @@ Gets test query interval start
 #>
 function Get-TestQueryIntervalStart
 {
-	"2018-03-31 00:00:00Z"
+   "2018-03-31 00:00:00Z"
 }
 
 <#
@@ -117,7 +117,25 @@ Gets test query interval end
 #>
 function Get-TestQueryIntervalEnd
 {
-	"2018-05-30 00:00:00Z"
+   "2018-05-30 00:00:00Z"
+}
+
+<#
+.SYNOPSIS
+Gets the policy assignment used in remediation tests at subscription level and below
+#>
+function Get-TestRemediationSubscriptionPolicyAssignmentId
+{
+   "/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/providers/Microsoft.Authorization/policyAssignments/2deae24764b447c29af7c309"
+}
+
+<#
+.SYNOPSIS
+Gets the policy assignment used in remediation tests at management group scope
+#>
+function Get-TestRemediationMgPolicyAssignmentId
+{
+   "/providers/Microsoft.Management/managementGroups/PolicyUIMG/providers/Microsoft.Authorization/policyAssignments/326b090398a649e3858e3f23"
 }
 
 <#
@@ -126,14 +144,14 @@ Validates a list of policy events
 #>
 function Validate-PolicyEvents
 {
-	param([System.Collections.Generic.List`1[[Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent]]]$policyEvents, [int]$count)
-
-    Assert-True { $count -ge $policyEvents.Count }
-    Assert-True { $policyEvents.Count -gt 0 }
-	Foreach($policyEvent in $policyEvents)
-	{
-		Validate-PolicyEvent $policyEvent
-	}
+   param([System.Collections.Generic.List`1[[Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent]]]$policyEvents, [int]$count)
+
+   Assert-True { $count -ge $policyEvents.Count }
+   Assert-True { $policyEvents.Count -gt 0 }
+   Foreach($policyEvent in $policyEvents)
+   {
+      Validate-PolicyEvent $policyEvent
+   }
 }
 
 <#
@@ -142,19 +160,19 @@ Validates a policy event
 #>
 function Validate-PolicyEvent
 {
-	param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent]$policyEvent)
-
-	Assert-NotNull $policyEvent
-
-    Assert-NotNull $policyEvent.Timestamp
-    Assert-NotNullOrEmpty $policyEvent.ResourceId
-    Assert-NotNullOrEmpty $policyEvent.PolicyAssignmentId
-    Assert-NotNullOrEmpty $policyEvent.PolicyDefinitionId
-    Assert-NotNull $policyEvent.IsCompliant
-    Assert-NotNullOrEmpty $policyEvent.SubscriptionId
-    Assert-NotNullOrEmpty $policyEvent.PolicyDefinitionAction
-    Assert-NotNullOrEmpty $policyEvent.TenantId
-    Assert-NotNullOrEmpty $policyEvent.PrincipalOid
+   param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyEvent]$policyEvent)
+
+   Assert-NotNull $policyEvent
+
+   Assert-NotNull $policyEvent.Timestamp
+   Assert-NotNullOrEmpty $policyEvent.ResourceId
+   Assert-NotNullOrEmpty $policyEvent.PolicyAssignmentId
+   Assert-NotNullOrEmpty $policyEvent.PolicyDefinitionId
+   Assert-NotNull $policyEvent.IsCompliant
+   Assert-NotNullOrEmpty $policyEvent.SubscriptionId
+   Assert-NotNullOrEmpty $policyEvent.PolicyDefinitionAction
+   Assert-NotNullOrEmpty $policyEvent.TenantId
+   Assert-NotNullOrEmpty $policyEvent.PrincipalOid
 }
 
 <#
@@ -163,14 +181,14 @@ Validates a list of policy states
 #>
 function Validate-PolicyStates
 {
-	param([System.Collections.Generic.List`1[[Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState]]]$policyStates, [int]$count)
-
-    Assert-True { $count -ge $policyStates.Count }
-    Assert-True { $policyStates.Count -gt 0 }
-	Foreach($policyState in $policyStates)
-	{
-		Validate-PolicyState $policyState
-	}
+   param([System.Collections.Generic.List`1[[Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState]]]$policyStates, [int]$count)
+
+   Assert-True { $count -ge $policyStates.Count }
+   Assert-True { $policyStates.Count -gt 0 }
+   Foreach($policyState in $policyStates)
+   {
+      Validate-PolicyState $policyState
+   }
 }
 
 <#
@@ -179,17 +197,17 @@ Validates a policy state
 #>
 function Validate-PolicyState
 {
-	param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState]$policyState)
+   param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyState]$policyState)
 
-	Assert-NotNull $policyState
+   Assert-NotNull $policyState
 
-    Assert-NotNull $policyState.Timestamp
-    Assert-NotNullOrEmpty $policyState.ResourceId
-    Assert-NotNullOrEmpty $policyState.PolicyAssignmentId
-    Assert-NotNullOrEmpty $policyState.PolicyDefinitionId
-    Assert-NotNull $policyState.IsCompliant
-    Assert-NotNullOrEmpty $policyState.SubscriptionId
-    Assert-NotNullOrEmpty $policyState.PolicyDefinitionAction
+   Assert-NotNull $policyState.Timestamp
+   Assert-NotNullOrEmpty $policyState.ResourceId
+   Assert-NotNullOrEmpty $policyState.PolicyAssignmentId
+   Assert-NotNullOrEmpty $policyState.PolicyDefinitionId
+   Assert-NotNull $policyState.IsCompliant
+   Assert-NotNullOrEmpty $policyState.SubscriptionId
+   Assert-NotNullOrEmpty $policyState.PolicyDefinitionAction
 }
 
 <#
@@ -198,49 +216,86 @@ Validates a policy state summary
 #>
 function Validate-PolicyStateSummary
 {
-	param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyStateSummary]$policyStateSummary)
+   param([Microsoft.Azure.Commands.PolicyInsights.Models.PolicyStateSummary]$policyStateSummary)
+
+   Assert-NotNull $policyStateSummary
+
+   Assert-NotNull $policyStateSummary.Results
+   Assert-NotNull $policyStateSummary.Results.NonCompliantResources
+   Assert-NotNull $policyStateSummary.Results.NonCompliantPolicies
+
+   Assert-NotNull $policyStateSummary.PolicyAssignments
+   Assert-True { $policyStateSummary.PolicyAssignments.Count -le $policyStateSummary.Results.NonCompliantPolicies } 
+   Assert-True { $policyStateSummary.PolicyAssignments.Count -gt 0 } 
 
-	Assert-NotNull $policyStateSummary
+   Foreach($policyAssignmentSummary in $policyStateSummary.PolicyAssignments)
+   {
+      Assert-NotNull $policyAssignmentSummary
 
-    Assert-NotNull $policyStateSummary.Results
-    Assert-NotNull $policyStateSummary.Results.NonCompliantResources
-    Assert-NotNull $policyStateSummary.Results.NonCompliantPolicies
+      Assert-NotNullOrEmpty $policyAssignmentSummary.PolicyAssignmentId
 
-    Assert-NotNull $policyStateSummary.PolicyAssignments
-    Assert-True { $policyStateSummary.PolicyAssignments.Count -le $policyStateSummary.Results.NonCompliantPolicies } 
-    Assert-True { $policyStateSummary.PolicyAssignments.Count -gt 0 } 
+      Assert-NotNull $policyAssignmentSummary.Results
+      Assert-NotNull $policyAssignmentSummary.Results.NonCompliantResources
+      Assert-NotNull $policyAssignmentSummary.Results.NonCompliantPolicies
 
-	Foreach($policyAssignmentSummary in $policyStateSummary.PolicyAssignments)
-	{
-		Assert-NotNull $policyAssignmentSummary
+      Assert-NotNull $policyAssignmentSummary.PolicyDefinitions
+      Assert-True { $policyAssignmentSummary.PolicyDefinitions.Count -eq $policyAssignmentSummary.Results.NonCompliantPolicies }
+      Assert-True { $policyAssignmentSummary.PolicyDefinitions.Count -gt 0 }
 
-		Assert-NotNullOrEmpty $policyAssignmentSummary.PolicyAssignmentId
+      if ($policyAssignmentSummary.Results.NonCompliantPolicies -gt 1)
+      {
+         Assert-NotNullOrEmpty $policyAssignmentSummary.PolicySetDefinitionId
+      }
 
-        Assert-NotNull $policyAssignmentSummary.Results
-		Assert-NotNull $policyAssignmentSummary.Results.NonCompliantResources
-		Assert-NotNull $policyAssignmentSummary.Results.NonCompliantPolicies
+      Foreach($policyDefinitionSummary in $policyAssignmentSummary.PolicyDefinitions)
+      {
+         Assert-NotNull $policyDefinitionSummary
 
-        Assert-NotNull $policyAssignmentSummary.PolicyDefinitions
-        Assert-True { $policyAssignmentSummary.PolicyDefinitions.Count -eq $policyAssignmentSummary.Results.NonCompliantPolicies }
-        Assert-True { $policyAssignmentSummary.PolicyDefinitions.Count -gt 0 }
+         Assert-NotNullOrEmpty $policyDefinitionSummary.PolicyDefinitionId
+         Assert-NotNullOrEmpty $policyDefinitionSummary.Effect
 
-        if ($policyAssignmentSummary.Results.NonCompliantPolicies -gt 1)
-        {
-            Assert-NotNullOrEmpty $policyAssignmentSummary.PolicySetDefinitionId
-        }
+         Assert-NotNull $policyDefinitionSummary.Results
+         Assert-NotNull $policyDefinitionSummary.Results.NonCompliantResources
+         Assert-Null $policyDefinitionSummary.Results.NonCompliantPolicies
+      }
+   }
+}
 
-		Foreach($policyDefinitionSummary in $policyAssignmentSummary.PolicyDefinitions)
-		{
-			Assert-NotNull $policyDefinitionSummary
+<#
+.SYNOPSIS
+Validates a remediation
+#>
+function Validate-Remediation
+{
+   param([Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediation]$remediation)
+
+   Assert-NotNull $remediation
+
+   Assert-NotNull $remediation.CreatedOn
+   Assert-NotNull $remediation.LastUpdatedOn
+   Assert-True { $remediation.Id -like "*/providers/microsoft.policyinsights/remediations/*" }
+   Assert-AreEqual "Microsoft.PolicyInsights/remediations" $remediation.Type
+   Assert-NotNullOrEmpty $remediation.Name
+   Assert-NotNullOrEmpty $remediation.PolicyAssignmentId
+   Assert-NotNullOrEmpty $remediation.ProvisioningState
+   Assert-NotNull $remediation.DeploymentSummary
+}
+
+<#
+.SYNOPSIS
+Validates a remediation deployment
+#>
+function Validate-RemediationDeployment
+{
+   param([Microsoft.Azure.Commands.PolicyInsights.Models.Remediation.PSRemediationDeployment]$deployment)
 
-            Assert-NotNullOrEmpty $policyDefinitionSummary.PolicyDefinitionId
-            Assert-NotNullOrEmpty $policyDefinitionSummary.Effect
+   Assert-NotNull $deployment
 
-			Assert-NotNull $policyDefinitionSummary.Results
-			Assert-NotNull $policyDefinitionSummary.Results.NonCompliantResources
-			Assert-Null $policyDefinitionSummary.Results.NonCompliantPolicies
-		}
-	}
+   Assert-NotNull $deployment.CreatedOn
+   Assert-NotNull $deployment.LastUpdatedOn
+   Assert-True { $deployment.RemediatedResourceId -like "/subscriptions/*/providers/*" }
+   Assert-NotNullOrEmpty $deployment.Status
+   Assert-NotNullOrEmpty $deployment.ResourceLocation
 }
 
 <#
@@ -249,7 +304,7 @@ Validates a string is not null or empty
 #>
 function Assert-NotNullOrEmpty
 {
-	param([string]$value)
+   param([string]$value)
 
-	Assert-False { [string]::IsNullOrEmpty($value) }
+   Assert-False { [string]::IsNullOrEmpty($value) }
 }