Parameterized the 'ActivatePlugins' during 'Solution Import'. Replace… (#339)

RajeevPentyala · mikefactorial · web-flow · commit 80affc545ca0 · 2024-03-04T18:47:30.000+05:30
* Parameterized the 'ActivatePlugins' during 'Solution Import'. Replaced legacy 'PublishWorkflows' with 'ActivatePlugins' parameter.

* Added 'StageAndUpgrade' to the import tasks.

* Updating PR Loop Test

* Logic to disable flows before solution import.

---------

Co-authored-by: Mike! &lt;mike@mikefactorial.onmicrosoft.com&gt;
diff --git a/Pipelines/Templates/deploy-Solution.yml b/Pipelines/Templates/deploy-Solution.yml
@@ -124,17 +124,30 @@ steps:
   condition: and(succeeded(), eq(variables['IsUnmanaged'], 'true'))
 
 # If called from import-unmanaged-to-dev-environment.yml, this task will run to deploy an unmanaged solution
+- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
+  displayName: 'Import Unmanaged Solution and no activate-plugins'
+  inputs:
+    authenticationType: PowerPlatformSPN
+    PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
+    SolutionInputFile: '$(UnmanagedSolutionPath)'
+    ActivatePlugins: false
+    UseDeploymentSettingsFile: $(UseDeploymentSettings)
+    DeploymentSettingsFile: $(DeploymentSettingsPath)
+    MaxAsyncWaitTime: 120
+  condition: and(succeeded(),eq(variables['ActivateFlowsOnTheSolutionImport'],'false'), ne(variables['SkipSolutionImport'],'true'), eq(variables['IsUnmanaged'], 'true'))
+
+  # If called from import-unmanaged-to-dev-environment.yml, this task will run to deploy an unmanaged solution
 - task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
   displayName: 'Import Unmanaged Solution'
   inputs:
     authenticationType: PowerPlatformSPN
     PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
     SolutionInputFile: '$(UnmanagedSolutionPath)'
-    PublishWorkflows: true
+    ActivatePlugins: true
     UseDeploymentSettingsFile: $(UseDeploymentSettings)
     DeploymentSettingsFile: $(DeploymentSettingsPath)
     MaxAsyncWaitTime: 120
-  condition: and(succeeded(), ne(variables['SkipSolutionImport'],'true'), eq(variables['IsUnmanaged'], 'true'))
+  condition: and(succeeded(), ne(variables['ActivateFlowsOnTheSolutionImport'],'false'), ne(variables['SkipSolutionImport'],'true'), eq(variables['IsUnmanaged'], 'true'))
 
 - pwsh: |
    . "$env:POWERSHELLPATH/build-deploy-solution-functions.ps1"
@@ -147,47 +160,69 @@ steps:
   displayName: 'Get managed solution zip path'
   condition: and(succeeded(),ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'))
 
+- template: disable-flows.yml
+  parameters:
+    solutionName: '${{parameters.solutionName}}'
+
+# If the TriggerSolutionUpgrade variable is false, then import the solution as an Update
+- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
+  displayName: 'Import Managed Solution as Update and no activate-plugins'
+  inputs:
+    authenticationType: PowerPlatformSPN
+    PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
+    SolutionInputFile: $(ManagedSolutionPath)
+    ActivatePlugins: false    
+    OverwriteUnmanagedCustomizations: ${{parameters.overwriteUnmanagedCustomizations}}
+    UseDeploymentSettingsFile: $(UseDeploymentSettings)
+    DeploymentSettingsFile: $(DeploymentSettingsPath)
+    MaxAsyncWaitTime: 120
+  condition: and(succeeded(),eq(variables['ActivateFlowsOnTheSolutionImport'],'false'),ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), or(eq(variables['TriggerSolutionUpgrade'], 'false'), eq(variables['SolutionExists'], 'false')))
+
 # If the TriggerSolutionUpgrade variable is false, then import the solution as an Update
 - task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
   displayName: 'Import Managed Solution as Update'
   inputs:
     authenticationType: PowerPlatformSPN
     PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
     SolutionInputFile: $(ManagedSolutionPath)
-    PublishWorkflows: true
+    ActivatePlugins: true    
     OverwriteUnmanagedCustomizations: ${{parameters.overwriteUnmanagedCustomizations}}
     UseDeploymentSettingsFile: $(UseDeploymentSettings)
     DeploymentSettingsFile: $(DeploymentSettingsPath)
     MaxAsyncWaitTime: 120
-  condition: and(succeeded(),ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), or(eq(variables['TriggerSolutionUpgrade'], 'false'), eq(variables['SolutionExists'], 'false')))
+  condition: and(succeeded(), ne(variables['ActivateFlowsOnTheSolutionImport'],'false'), ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), or(eq(variables['TriggerSolutionUpgrade'], 'false'), eq(variables['SolutionExists'], 'false')))
 
-# If the TriggerSolutionUpgrade variable is true, then import the solution as an Upgrade, staging it as a holding solution, so we can apply a solution Upgrade.
+# If the TriggerSolutionUpgrade variable is true, then import the solution as an Upgrade, along with 'StageAndUpgrade' upgrade happens immediately after the import.
 # Doing this will ensure that items removed from the solution in development are also removed from the solution in the target environment after the Upgrade is applied.
 - task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
-  displayName: 'Import Managed Solution as Upgrade'
+  displayName: 'Import Managed Solution as Upgrade and no activate-plugins'
   inputs:
     authenticationType: PowerPlatformSPN
     PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
     SolutionInputFile: $(ManagedSolutionPath)
-    HoldingSolution: true
     OverwriteUnmanagedCustomizations: ${{parameters.overwriteUnmanagedCustomizations}}
     UseDeploymentSettingsFile: $(UseDeploymentSettings)
     DeploymentSettingsFile: $(DeploymentSettingsPath)
+    ActivatePlugins: false
     MaxAsyncWaitTime: 120
-  condition: and(succeeded(),ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), eq(variables['TriggerSolutionUpgrade'], 'true'), eq(variables['SolutionExists'], 'true'))
+    StageAndUpgrade: true
+  condition: and(succeeded(), eq(variables['ActivateFlowsOnTheSolutionImport'],'false'), ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), eq(variables['TriggerSolutionUpgrade'], 'true'), eq(variables['SolutionExists'], 'true'))
 
-# NOTE: Sometimes you need to perform intermediary steps between staging the upgrade and applying it.  
-# An example would be moving data from one entity to another before deleting the entity.
-# You would add steps to your pipeline here to accomplish this. 
-
-# If the TriggerSolutionUpgrade variable is true,then apply the solution Upgrade.
-- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.apply-solution-upgrade.PowerPlatformApplySolutionUpgrade@2
+# If the TriggerSolutionUpgrade variable is true, then import the solution as an Upgrade, along with 'StageAndUpgrade' upgrade happens immediately after the import.
+# Doing this will ensure that items removed from the solution in development are also removed from the solution in the target environment after the Upgrade is applied.
+- task: microsoft-IsvExpTools.PowerPlatform-BuildTools.import-solution.PowerPlatformImportSolution@2
+  displayName: 'Import Managed Solution as Upgrade'
   inputs:
-    authenticationType: 'PowerPlatformSPN'
+    authenticationType: PowerPlatformSPN
     PowerPlatformSPN: '${{parameters.serviceConnectionName}}'
-    SolutionName: ${{parameters.solutionName}}
-    AsyncOperation: true
-  condition: and(succeeded(),ne(variables['SkipSolutionImport'],'true'), eq(variables['TriggerSolutionUpgrade'], 'true'), eq(variables['SolutionExists'], 'true'))
+    SolutionInputFile: $(ManagedSolutionPath)    
+    OverwriteUnmanagedCustomizations: ${{parameters.overwriteUnmanagedCustomizations}}
+    UseDeploymentSettingsFile: $(UseDeploymentSettings)
+    DeploymentSettingsFile: $(DeploymentSettingsPath)
+    ActivatePlugins: true
+    MaxAsyncWaitTime: 120
+    StageAndUpgrade: true
+  condition: and(succeeded(),ne(variables['ActivateFlowsOnTheSolutionImport'],'false'),ne(variables['SkipSolutionImport'],'true'), ne(variables['IsUnmanaged'], 'true'), eq(variables['TriggerSolutionUpgrade'], 'true'), eq(variables['SolutionExists'], 'true'))
 
 - task: microsoft-IsvExpTools.PowerPlatform-BuildTools.publish-customizations.PowerPlatformPublishCustomizations@2
   displayName: 'Power Platform Publish Customizations '
diff --git a/Pipelines/Templates/disable-flows.yml b/Pipelines/Templates/disable-flows.yml
@@ -0,0 +1,26 @@
+parameters:
+- name: solutionName
+  type: string
+#- name: activateFlowsOnTheSolutionImport
+#  type: string
+#- name: skipSolutionImport
+#  type: string
+#- name: isUnmanaged
+#  type: string
+#- name: solutionExists
+#  type: string
+
+steps:
+- powershell: |    
+   . "$env:POWERSHELLPATH/activate-flows.ps1"
+
+    $microsoftPowerAppsAdministrationPowerShellModule = '$(CoETools_Microsoft_PowerApps_Administration_PowerShell)'
+    Import-Module $microsoftPowerAppsAdministrationPowerShellModule -Force -RequiredVersion $(PowerAppsAdminModuleVersion) -ArgumentList @{ NonInteractive = $true }
+    Add-PowerAppsAccount -TenantID $(connectionVariables.BuildTools.TenantId) -ApplicationId $(connectionVariables.BuildTools.ApplicationId) -ClientSecret $(connectionVariables.BuildTools.ClientSecret)
+    $microsoftXrmDataPowerShellModule = '$(CoETools_Microsoft_Xrm_Data_PowerShell)'
+    Import-Module $microsoftXrmDataPowerShellModule -Force -RequiredVersion $(XrmDataPowerShellVersion) -ArgumentList @{ NonInteractive = $true }
+    $conn = Get-CrmConnection -ConnectionString "$(connectionVariables.BuildTools.DataverseConnectionString)"
+
+    Deactivate-FlowsFromSolution $conn "${{parameters.solutionName}}"
+  displayName: 'Disable flows'
+  condition: and(succeeded(),eq(variables['ActivateFlowsOnTheSolutionImport'],'false'),ne(variables['SkipSolutionImport'],'true'),ne(variables['IsUnmanaged'], 'true'),eq(variables['SolutionExists'], 'true'))
diff --git a/PowerShell/activate-flows.ps1 b/PowerShell/activate-flows.ps1
@@ -50,7 +50,7 @@ function Invoke-ActivateFlows {
     
     Write-Flows "Printing total active flows" $flowsToActivate
 
-    Write-Host "Activating flows..."
+    Write-Host "Activating/Deactivating flows..."
     #Activate any flows added to the collection based on sort order
     $flowsToActivate = $flowsToActivate | Sort-Object -Property sortOrder
     $flowsActivatedDeactivatedThisPass = $false
@@ -435,4 +435,40 @@ function Get-User-By-Email-or-DomainName{
     }
 
     return $matchedUser
+}
+
+<#
+This function reads the settings from customDeploymentSettings.json file  and updates the connection references.
+#>
+function Deactivate-FlowsFromSolution {
+    param (
+        [Parameter(Mandatory)] [Microsoft.Xrm.Tooling.Connector.CrmServiceClient]$conn,
+        [Parameter(Mandatory)] [String] [AllowEmptyString()]$solutionName
+    )
+	# Fetch the 'solution' using 'solutionComponentUniqueName' tag
+    $solutions = Get-CrmRecords -conn ([Microsoft.Xrm.Tooling.Connector.CrmServiceClient]$conn) -EntityLogicalName solution -FilterAttribute "uniquename" -FilterOperator "eq" -FilterValue "$solutionName" -Fields solutionid
+    if ($solutions.Count -gt 0) {
+        $solutionId = $solutions.CrmRecords[0].solutionid
+        # Get the solution components
+        $result = Get-CrmRecords -conn $conn -EntityLogicalName solutioncomponent -FilterAttribute "solutionid" -FilterOperator "eq" -FilterValue $solutionId -Fields objectid, componenttype
+        $solutionComponents = $result.CrmRecords
+
+        foreach ($solutionComponent in $solutionComponents) {
+            if ($solutionComponent.componenttype -eq "Workflow") {
+                $workflow = Get-CrmRecord -conn $conn -EntityLogicalName workflow -Id $solutionComponent.objectid -Fields clientdata, category, statecode, statuscode, name
+                Write-Host "Workflow - $workflow"
+                if($workflow -ne $null){
+                    # If workflow not already deactivated go ahead and deactivate
+                    if($workflow.statecode -ne 0 -and $workflow.StatusCode -ne 1 ){
+                        Write-Host "Deactivating Flow: " $workflow.name
+                        Set-CrmRecordState -conn $conn -EntityLogicalName workflow -Id $solutionComponent.objectid -StateCode 0 -StatusCode 1
+                    }else{
+                        Write-Host "Flow already deactivated at the target: " $solutionComponent.name
+                    }
+                }else{
+                    Write-Host "workflow is null"
+                }
+            }
+        }
+    }
 }
