feat: Add script to cancel running instances for a Logic App (#376)

* initial commit

* add unit tests

* added integration test

* log run names, added integration test

* added documentation

* Apply suggestions from code review

Co-authored-by: Stijn Moreels <9039753+stijnmoreels@users.noreply.github.com>

* include `Set-AzLogicApp` in try-catch

---------

Co-authored-by: Pim Simons <pim.simons@codit.eu>
Co-authored-by: Stijn Moreels <9039753+stijnmoreels@users.noreply.github.com>

Author: pim-simons

docs/preview/03-Features/powershell/azure-logic-apps.md

@@ -13,9 +13,30 @@ To have access to the following features, you have to import the module:
 PS> Install-Module -Name Arcus.Scripting.LogicApps
 ```
 
+## Cancel running instances for an Azure Logic App
+
+Use this script to cancel all running instances for a specific Azure Logic App. 
+
+| Parameter           | Mandatory | Description                                        |
+| ------------------- | --------- | -------------------------------------------------- |
+| `ResourceGroupName` | yes       | The resource group containing the Azure Logic App. |
+| `LogicAppName`      | yes       | The name of the Azure Logic App to be disabled.    |
+
+**Example**
+
+Taking an example in which a specific Azure Logic App (`"rcv-shopping-order-sftp"`) needs to have all its runs cancelled.  
+
+```powershell
+PS> Cancel-AzLogicAppRuns `
+-ResourceGroupName "rg-common-dev" `
+-LogicAppName "rcv-shopping-order-sftp"
+# Successfully cancelled all running instances for the Azure Logic App 'rcv-shopping-order-sftp' in resource group 'rg-common-dev'
+```
+
+
 ## Disable an Azure Logic App
 
-Using this script to enable a specific Azure Logic App.  
+Use this script to enable a specific Azure Logic App.  
 
 | Parameter         | Mandatory | Description                                                                                                         |
 | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------- |
@@ -52,7 +73,7 @@ PS> Disable-AzLogicApp `
 
 ## Enable an Azure Logic App
 
-Using this script to enable a specific Azure Logic App.  
+Use this script to enable a specific Azure Logic App.  
 
 | Parameter         | Mandatory | Description                                                                                                         |
 | ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------- |

src/Arcus.Scripting.LogicApps/Arcus.Scripting.LogicApps.psd1

@@ -1,3 +1,28 @@
+<#
+ .Synopsis
+  Cancel all running instances of a specific Logic App.
+  
+ .Description
+  Cancel all running instances of a specific Logic App.
+  
+ .Parameter ResourceGroupName
+  The resource group containing the Azure Logic App.
+  
+ .Parameter LogicAppName
+  The name of the Azure Logic App.
+
+#>
+function Cancel-AzLogicAppRuns {
+    param(
+        [Parameter(Mandatory = $true)][string] $ResourceGroupName = $(throw "Name of the resource group is required"),
+        [Parameter(Mandatory = $true)][string] $LogicAppName = $(throw "Name of the logic app is required")
+    )
+    
+    . $PSScriptRoot\Scripts\Cancel-AzLogicAppRuns.ps1 -ResourceGroupName $ResourceGroupName -LogicAppName $LogicAppName
+}
+
+Export-ModuleMember -Function Cancel-AzLogicAppRuns
+
 <#
  .Synopsis
   Disable a specific Logic App.

src/Arcus.Scripting.LogicApps/Arcus.Scripting.LogicApps.psm1

@@ -31,6 +31,7 @@
   <ItemGroup>
     <Compile Include="Arcus.Scripting.LogicApps.psd1" />
     <Compile Include="Arcus.Scripting.LogicApps.psm1" />
+    <Compile Include="Scripts\Cancel-AzLogicAppRuns.ps1" />
     <Compile Include="Scripts\Disable-AzLogicApp.ps1" />
     <Compile Include="Scripts\Disable-AzLogicAppsFromConfig.ps1" />
     <Compile Include="Scripts\Enable-AzLogicApp.ps1" />

src/Arcus.Scripting.LogicApps/Arcus.Scripting.LogicApps.pssproj

@@ -0,0 +1,18 @@
+param(
+    [Parameter(Mandatory = $true)][string] $ResourceGroupName = $(throw "Name of the resource group is required"),
+    [Parameter(Mandatory = $true)][string] $LogicAppName = $(throw "Name of the logic app is required")
+)
+
+try{
+    $runs = Get-AzLogicAppRunHistory -ResourceGroupName $ResourceGroupName -Name $LogicAppName | 
+        Where-Object {$_.Status -eq 'Running'}
+
+    foreach ($run in $runs) {
+        Stop-AzLogicAppRun -ResourceGroupName $ResourceGroupName -Name $LogicAppName -RunName $run.Name -Force
+        Write-Verbose "Cancelled run $run.Name for the Azure Logic App '$LogicAppName' in resource group '$ResourceGroupName'"
+    }
+
+    Write-Host "Successfully cancelled all running instances for the Azure Logic App '$LogicAppName' in resource group '$ResourceGroupName'" -ForegroundColor Green
+} catch {
+    throw "Failed to cancel all running instances for the Azure Logic App '$LogicAppName' in resource group '$ResourceGroupName'. Details: $($_.Exception.Message)"
+}

src/Arcus.Scripting.LogicApps/Scripts/Cancel-AzLogicAppRuns.ps1

@@ -164,5 +164,68 @@ InModuleScope Arcus.Scripting.LogicApps {
                 }
             }
         }
+        Context "Cancel Logic Apps runs" {
+            It "Cancel all running instances for a Logic App"{
+                # Arrange
+                $resourceGroupName = $config.Arcus.ResourceGroupName
+                $logicAppName = Create-AzLogicAppName
+                $workflowDefinition = '{
+                    "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#",
+                    "actions": {
+                        "Delay": {
+                            "inputs": {
+                                "interval": {
+                                    "count": 5,
+                                    "unit": "Minute"
+                                }
+                            },
+                            "runAfter": {},
+                            "type": "wait"
+                        }
+                    },
+                    "outputs": {},
+                    "parameters": {},
+                    "triggers": {
+                        "Recurrence": {
+                            "recurrence": {
+                                "frequency": "Second",
+                                "interval": 1
+                            },
+                            "type": "recurrence"
+                        }
+                    },
+                    "contentVersion": "1.0.0.0"
+                }'
+
+                New-AzLogicApp `
+                    -ResourceGroupName $resourceGroupName `
+                    -Location westeurope `
+                    -Name $logicAppName `
+                    -Definition $workflowDefinition `
+                    -State Enabled
+
+                Start-Sleep -Seconds 5
+
+                try {
+                    Set-AzLogicApp `
+                        -ResourceGroupName $resourceGroupName `
+                        -Name $logicAppName `
+                        -State Disabled `
+                        -Force
+
+                    # Act
+                    Cancel-AzLogicAppRuns -ResourceGroupName $resourceGroupName -LogicAppName $logicAppName
+
+                    # Assert
+                    $runs = Get-AzLogicAppRunHistory -ResourceGroupName $resourceGroupName -Name $logicAppName | 
+                        Where-Object {$_.Status -eq 'Cancelled'} | measure
+
+                    $runs.Count | Should -BeGreaterThan 0
+
+                } finally {
+                    Remove-AzLogicApp -ResourceGroupName $resourceGroupName -Name $logicAppName -Force
+                }
+            }
+        }
     }
 }

src/Arcus.Scripting.Tests.Integration/Arcus.Scripting.LogicApps.tests.ps1

@@ -285,5 +285,52 @@ InModuleScope Arcus.Scripting.LogicApps {
                 Assert-MockCalled Disable-AzLogicApp -Scope It -Exactly 1 -ParameterFilter { $ResourceGroupName -eq $resourceGroup -and $LogicAppName -eq "snd-async" }
             }
         }
+        Context "Cancel Logic Apps runs" {
+             It "Cancelling all runs from Logic App history should succeed" {
+                # Arrange
+                $resourceGroupName = "codit-arcus-scripting"
+                $logicAppName = "arc-dev-we-rcv-unknown-http"
+
+                Mock Get-AzLogicAppRunHistory -MockWith {
+                    return @{
+                        Name = "test"
+                        Status = "Running"
+                    }
+                }
+
+                Mock Stop-AzLogicAppRun -MockWith {
+                   return $null
+                }
+
+                # Act
+                { Cancel-AzLogicAppRuns -ResourceGroupName $resourceGroupName -LogicAppName $logicAppName } | 
+                    Should -Not -Throw
+
+                # Assert
+                Assert-VerifiableMock
+                Assert-MockCalled Get-AzLogicAppRunHistory -Scope It -Times 1
+                Assert-MockCalled Stop-AzLogicAppRun -Scope It -Times 1
+            }
+             It "Cancelling all runs should fail when retrieving Logic App history fails" {
+                # Arrange
+                $resourceGroupName = "codit-arcus-scripting"
+                $logicAppName = "arc-dev-we-rcv-unknown-http"
+
+                Mock Get-AzLogicAppRunHistory { throw 'some error' }
+
+                Mock Stop-AzLogicAppRun -MockWith {
+                   return $null
+                }
+
+                # Act
+                { Cancel-AzLogicAppRuns -ResourceGroupName $resourceGroupName -LogicAppName $logicAppName } | 
+                    Should -Throw -ExpectedMessage "Failed to cancel all running instances for the Azure Logic App '$LogicAppName' in resource group '$ResourceGroupName'. Details: some error"
+
+                # Assert
+                Assert-VerifiableMock
+                Assert-MockCalled Get-AzLogicAppRunHistory -Scope It -Times 1
+                Assert-MockCalled Stop-AzLogicAppRun -Scope It -Times 0
+            }
+        }
     }
 }