Optimizely DXP Deployment API PowerShell Scripts for CI/CD in Azure Devops – Part 2

• Start-EpiDatabaseExport
• Get-EpiDatabaseExport

1. 1. Invoke script with 5 mandatory Parameters
      1. Client Key for intended environment
      2. Client Secret for intended environment
      3. Project ID (global for subscription)
      4. Target Environment (Integration, Preproduction, Production)
      5. DatabaseName (epicms, epicommerce)

param
  (
    [Parameter(Position=0, Mandatory)]
    [ValidateNotNullOrEmpty()]
    [string]$ClientKey,
    [Parameter(Position=1, Mandatory)]
    [ValidateNotNullOrEmpty()]
    [string]$ClientSecret,
    [Parameter(Position=2, Mandatory)]
    [ValidateNotNullOrEmpty()]
    [string]$ProjectID,
    [Parameter(Position=3, Mandatory)]
    [ValidateNotNullOrEmpty()]
    [ValidateSet("Integration", "Preproduction", "Production")]
    [string]$TargetEnvironment,
    [Parameter(Position=4, Mandatory)]
    [ValidateSet('epicms','epicommerce')]
    [String] $DatabaseName
    
  )

1. 1. Validate the parameters
      1. Not Empty/Null
      2. Not Whitespace
      3. Source Environment has a valid environment name
      4. Database Name has a valid selection

if([string]::IsNullOrWhiteSpace($ClientKey)){
    throw "A Client Key is needed. Please supply one."
}
if([string]::IsNullOrWhiteSpace($ClientSecret)){
    throw "A Client Secret Key is needed. Please supply one."
}
if([string]::IsNullOrWhiteSpace($ProjectID)){
    throw "A Project ID GUID is needed. Please supply one."
}

1. 1. Check to see that the EpiCloud powershell module is installed
      1. If not, install it (make sure to include the -force, as this came a new EpiCloud version)

if (-not (Get-Module -Name EpiCloud -ListAvailable)) {
    Write-Host "Installing EpiServer Cloud Powershell Module"
    Install-Module EpiCloud -Scope CurrentUser -Force
}

1. 2. Set up and Start the export
      1. When setting up the object, the Wait param can be set to true or false, but within my scenario, I would like to be able to keep messages flowing to the front-end, so I set it to false. If it is set to true, the command will not return any value until it is done.
      2. The reason we set this to a variable is because we want the ID from the object, which will allow us to efficiently get the Epi Export status in the next bit of code.

$startEpiExportmentSplat = @{
    ProjectId = "$ProjectID"
    Wait = $false
    Environment = "$TargetEnvironment"
    DatabaseName = "$DatabaseName"
    ClientSecret = "$ClientSecret"
    ClientKey = "$ClientKey"
}

Write-Host "Starting the Export. Environment: $TargetEnvironment | DB Name: $DatabaseName"

$export = Start-EpiDatabaseExport @startEpiExportmentSplat

1. 1. Set up the object and Get the current export job

$exportId = $export | Select -ExpandProperty "id"

$getEpiExportSplat = @{
    ProjectId = "$ProjectID"
    ClientSecret = "$ClientSecret"
    ClientKey = "$ClientKey"
    Id = "$exportId"
    Environment = "$TargetEnvironment"
    DatabaseName = "$DatabaseName"
}

$timesRun = 0
$currExport = Get-EpiDatabaseExport @getEpiExportSplat | Select-Object -First 1
$status = $currExport | Select -ExpandProperty "status"
$exit = 0

1. 1. Set up a loop to query the export status and print to the screen the current elapsed time
      1. This method does not have progress, so in order to let the user know it is still running, I have it writing elapsed time to the screen each minute

while($exit -ne 1){

$currExport = Get-EpiDatabaseExport @getEpiExportSplat | Select-Object -First 1

$status = $currExport | Select -ExpandProperty "status"

Write-Host "Exporting In Progress. Elapsed time - "$timesRun":00"

if($status -ne 'InProgress'){
    $exit = 1
}
$timesRun = $timesRun + 1;

start-sleep -Milliseconds 60000

}

1. 1. If the export fails, throw an error
      1. This will also fail the Azure DevOps Release Task if this process fails
   2. If the export succeeds, output the download link and set an Azure DevOps Output Variable
      1. This download link has a max life of 24 hours

if($status -eq "Failed"){
    throw "Export Failed."
}

$downloadLink = $currExport | Select -ExpandProperty "downloadLink"

Write-Host "Export Finished. Download URL is: $downloadLinknn"

#Set the Output variable for the Export URL, if needed
Write-Host "##vso[task.setvariable variable=ExportDownload;]'$downloadLink'"
Write-Host "Output Variable Created. Name: ExportDownload | Value: $downloadLink"

Invoking the script looks something like the following:

 
.Perficient_ExportDatabase.ps1 -ClientKey "****"
                                -ClientSecret "****"
                                -ProjectID "****"
                                -TargetEnvironment "Integration"
                                -DatabaseName "epicms"