Can I show a progress bar during a deployment?

ryanrousseau · 18 September 2020 15:31

I have a long-running task that performs several actions. I’d like to show a progress bar with a percentage while the deployment is running. Can you do this in Octopus?

ryanrousseau · 18 September 2020 15:39

You can use the Update-Progress command in PowerShell (or one of its alternatives). It takes a percentage and an optional message as parameters.

$updates = @(@{ percent=0; message="Getting started..." }, @{ percent=10; message="Waking the kraken..." }, @{ percent=20; message="Hoarding treasure..." }, @{ percent=30; message="Sinking battleship..." }, @{ percent=40; message="Refilling ink..." }, @{ percent=50; message="Blending in..." }, @{ percent=60; message="Taking nap..." }, @{ percent=70; message="Recording Ask Octopus..." }, @{ percent=80; message="Auditioning for next Spider-Man movie..." }, @{ percent=90; message="Did I leave the stove on...?" }, @{ percent=100; message="Finishing up..." })

$updates | ForEach-Object {
  Update-Progress $_.percent $_.message
  Start-Sleep (Get-Random -Minimum 2 -Maximum 5)
}

The progress bar will display on the Task Log while the step is running.

stephenjsh · 21 September 2020 13:49

@ryanrousseau This is awesome and perfect timing for a Step Template I’m developing! Out of curiosity, Is there an equivalent Python command for this as well?

ryanrousseau · 21 September 2020 14:15

Yep! You can use the updateprogress function.

github.com

OctopusDeploy/Calamari/blob/5e2f6a9cfd4f941e3865ee03afd28ac96b9257aa/source/Calamari.Common/Features/Scripting/Python/Configuration.py#L53


    length = encode(length)

    path = os.path.abspath(path)
    servicepath = encode(path)

    print("##octopus[stdout-verbose]");
    print("Artifact {0} will be collected from {1} after this step completes".format(fileName, path))
    print("##octopus[stdout-default]");
    print("##octopus[createArtifact path='{0}' name='{1}' length='{2}']".format(servicepath, serviceFileName, length))

def updateprogress(progress, message=None):
    encodedProgress = encode(str(progress))
    encodedMessage = encode(message)

    print("##octopus[progress percentage='{0}' message='{1}']".format(encodedProgress, encodedMessage))

def failstep(message=None):
    if message is not None:
        encodedMessage = encode(message)
        print("##octopus[resultMessage message='{}']".format(encodedMessage))
    exit(-1)

I’ll be updating the docs soon to include info on this and all the ways to call it.