Deploying to FTP with Octopus Deploy

 Recently I had overhauled build and deployment procedure for one of my pet projects. Project is a web app built with ASP.NET MVC and Web API, and it's hosted on one of the shared hosting platforms. Those unfortunate enough to still use shared hosting know, that there's little alternative to deploy there besides using FTP file-share.

New delivery pipeline employs Azure Pipelines as CI and Octopus Deploy for managing environments and releases as well as running deployments. Setting up a pipeline that builds web app and then pushes packages into Octopus was quite easy - I just needed to install Octopus Deploy extension into my Azure DevOps org and add correct steps into project's azure-pipelines.yml file.

Hard things to do came about when I was trying to figure out how to deploy my new shiny packages to an FTP folder provided by shared hosting. Since Octopus doesn't have dedicated FTP deployment target, I needed to find a work-around. One (and I think the only) possible way was to deploy a package on a jump-box machine and then use community "Upload files by FTP" step - much like it's described in this forum thread. Sounds doable - doesn't it? However, after initial step setup and a test run, I've got an error message that "SSH host key fingerprint "" does not match pattern" and an awfully long regular expression in it. My initial thought was "why this thing needs a host key fingerprint?" - because the FTP I was deploying to isn't secure one, I believed that all I need to provide as step parameters are host, folder name, user name and password. Trying different combinations of step parameters didn't help, so I started to look for a documentation for a step. All I found was this page on Octopus's website.

That page didn't have an explanation for my error, but it did have an entire PowerShell script for a step (you just need to click on big "Show script" button at the bottom of the page). Script itself isn't very big, so after some tinkering I was able to create my reduced version of a script, that only works with non-secure FTP servers - not that I needed more from it.

Anyway - instead of "Upload files by FTP" step, I've added a custom script as a new step into my Octopus deployment process and copied my version of a script into it. Long story short - this helped and now I'm officially deploying to FTP with Octopus Deploy!

Below is my version of an FTP uploading script.

	$PathToWinScp = "C:\Program Files (x86)\WinSCP"
	$FtpHost = "<your ftp host>"
	$FtpUsername = "<username>"
	$FtpPassword = "<password>"
	$PackageStepName = "<previous step name>"
	$FtpRemoteDirectory = "wwwroot" ## could be anything else
	$FtpDeleteUnrecognizedFiles = $true
	function Find-InstallLocation($stepName) {
	$result = $OctopusParameters.Keys | where {
	$_.Equals("Octopus.Action[$stepName].Output.Package.InstallationDirectoryPath", [System.StringComparison]::OrdinalIgnoreCase)
	} | select -first 1
	if ($result) {
	return $OctopusParameters[$result]
	}
	throw "No install location found for step: $stepName"
	}
	function FileTransferred
	{
	param($e)
	if ($e.Error -eq $Null)
	{
	Write-Host ("Upload of {0} succeeded" -f $e.FileName)
	}
	else
	{
	Write-Error ("Upload of {0} failed: {1}" -f $e.FileName, $e.Error)
	}
	if ($e.Chmod -ne $Null)
	{
	if ($e.Chmod.Error -eq $Null)
	{
	Write-Host "##octopus[stdout-verbose]"
	Write-Host ("Permisions of {0} set to {1}" -f $e.Chmod.FileName, $e.Chmod.FilePermissions)
	Write-Host "##octopus[stdout-default]"
	}
	else
	{
	Write-Error ("Setting permissions of {0} failed: {1}" -f $e.Chmod.FileName, $e.Chmod.Error)
	}
	}
	else
	{
	Write-Host "##octopus[stdout-verbose]"
	Write-Host ("Permissions of {0} kept with their defaults" -f $e.Destination)
	Write-Host "##octopus[stdout-default]"
	}
	if ($e.Touch -ne $Null)
	{
	if ($e.Touch.Error -eq $Null)
	{
	Write-Host "##octopus[stdout-verbose]"
	Write-Host ("Timestamp of {0} set to {1}" -f $e.Touch.FileName, $e.Touch.LastWriteTime)
	Write-Host "##octopus[stdout-default]"
	}
	else
	{
	Write-Error ("Setting timestamp of {0} failed: {1}" -f $e.Touch.FileName, $e.Touch.Error)
	}
	}
	else
	{
	# This should never happen during "local to remote" synchronization
	Write-Host "##octopus[stdout-verbose]"
	Write-Host ("Timestamp of {0} kept with its default (current time)" -f $e.Destination)
	Write-Host "##octopus[stdout-default]"
	}
	}
	function UploadPackage($stepName) {
	$stepPath = ""
	Write-Host "Finding path to package step: $stepName"
	$stepPath = Find-InstallLocation $stepName
	Write-Host "Package was installed to: $stepPath"
	$sessionOptions = New-Object WinSCP.SessionOptions
	$sessionOptions.Protocol = [WinSCP.Protocol]::Ftp
	$sessionOptions.HostName = $FtpHost
	$sessionOptions.UserName = $FtpUsername
	$sessionOptions.Password = $FtpPassword
	$session = New-Object WinSCP.Session
	try
	{
	# Will continuously report progress of synchronization
	$session.add_FileTransferred( { FileTransferred($_) } )
	# Connect
	$session.Open($sessionOptions)
	Write-Host "Beginning synchronization between $stepPath and $FtpRemoteDirectory on $FtpHost"
	if (-not $session.FileExists($FtpRemoteDirectory))
	{
	Write-Host "Remote directory not found, creating $FtpRemoteDirectory"
	$session.CreateDirectory($FtpRemoteDirectory);
	}
	# Synchronize files
	$synchronizationResult = $session.SynchronizeDirectories(
	[WinSCP.SynchronizationMode]::Remote, $stepPath, $FtpRemoteDirectory, $FtpDeleteUnrecognizedFiles)
	# Throw on any error
	$synchronizationResult.Check()
	}
	finally
	{
	# Disconnect, clean up
	$session.Dispose()
	}
	}
	# Load WinSCP .NET assembly
	$fullPathToWinScp = "$PathToWinScp\WinSCPnet.dll"
	if(-not (Test-Path $fullPathToWinScp))
	{
	throw "$PathToWinScp does not contain the WinSCP .NET Assembly"
	}
	Add-Type -Path $fullPathToWinScp
	try {
	UploadPackage $PackageStepName
	exit 0
	}
	catch [Exception]
	{
	throw $_.Exception.Message
	}

view raw octo-upload-ftp.ps1 hosted with ❤ by GitHub